API/OpaqueJSString.h

   1 /*
   2  * Copyright (C) 2008 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef OpaqueJSString_h
  27 #define OpaqueJSString_h
  28
  29 #include <wtf/ThreadSafeRefCounted.h>
  30 #include <wtf/text/WTFString.h>
  31
  32 namespace JSC {
  33     class Identifier;
  34     class VM;
  35 }
  36
  37 struct OpaqueJSString : public ThreadSafeRefCounted<OpaqueJSString> {
  38
  39     static PassRefPtr<OpaqueJSString> create() // null
  40     {
  41         return adoptRef(new OpaqueJSString);
  42     }
  43
  44     static PassRefPtr<OpaqueJSString> create(const LChar* characters, unsigned length)
  45     {
  46         return adoptRef(new OpaqueJSString(characters, length));
  47     }
  48
  49     static PassRefPtr<OpaqueJSString> create(const UChar* characters, unsigned length)
  50     {
  51         return adoptRef(new OpaqueJSString(characters, length));
  52     }
  53
  54     JS_EXPORT_PRIVATE static PassRefPtr<OpaqueJSString> create(const String&);
  55
  56     const UChar* characters() { return !!this ? m_string.characters() : 0; }
  57     unsigned length() { return !!this ? m_string.length() : 0; }
  58
  59     JS_EXPORT_PRIVATE String string() const;
  60     JSC::Identifier identifier(JSC::VM*) const;
  61 #if PLATFORM(QT)
  62     QString qString() const { return m_string; }
  63 #endif
  64
  65 private:
  66     friend class WTF::ThreadSafeRefCounted<OpaqueJSString>;
  67
  68     OpaqueJSString()
  69     {
  70     }
  71
  72     OpaqueJSString(const String& string)
  73         : m_string(string.isolatedCopy())
  74     {
  75     }
  76
  77     OpaqueJSString(const LChar* characters, unsigned length)
  78     {
  79         m_string = String(characters, length);
  80     }
  81
  82     OpaqueJSString(const UChar* characters, unsigned length)
  83     {
  84         m_string = String(characters, length);
  85     }
  86
  87     String m_string;
  88 };
  89
  90 #endif