767f16245db9f0d0a1c5be9284df4eb9a7dc949a
[WebKit-https.git] / Source / WebKit2 / Shared / APIString.h
1 /*
2  * Copyright (C) 2010 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef APIString_h
27 #define APIString_h
28
29 #include "APIObject.h"
30 #include <JavaScriptCore/InitializeThreading.h>
31 #include <JavaScriptCore/JSStringRef.h>
32 #include <JavaScriptCore/OpaqueJSString.h>
33 #include <wtf/PassRefPtr.h>
34 #include <wtf/text/WTFString.h>
35 #include <wtf/unicode/UTF8.h>
36
37 namespace API {
38
39 class String final : public ObjectImpl<Object::Type::String> {
40 public:
41     static PassRefPtr<String> createNull()
42     {
43         return adoptRef(new String);
44     }
45
46     static PassRefPtr<String> create(const WTF::String& string)
47     {
48         return adoptRef(new String(string));
49     }
50
51     static PassRefPtr<String> create(JSStringRef jsStringRef)
52     {
53         return adoptRef(new String(jsStringRef->string()));
54     }
55
56     static PassRefPtr<String> createFromUTF8String(const char* string)
57     {
58         return adoptRef(new String(WTF::String::fromUTF8(string)));
59     }
60
61     virtual ~String()
62     {
63     }
64
65     bool isNull() const { return m_string.isNull(); }
66     bool isEmpty() const { return m_string.isEmpty(); }
67     
68     size_t length() const { return m_string.length(); }
69     size_t getCharacters(UChar* buffer, size_t bufferLength) const
70     {
71         if (!bufferLength)
72             return 0;
73         bufferLength = std::min(bufferLength, static_cast<size_t>(m_string.length()));
74         memcpy(buffer, m_string.deprecatedCharacters(), bufferLength * sizeof(UChar));
75         return bufferLength;
76     }
77
78     size_t maximumUTF8CStringSize() const { return m_string.length() * 3 + 1; }
79     size_t getUTF8CString(char* buffer, size_t bufferSize)
80     {
81         if (!bufferSize)
82             return 0;
83         char* p = buffer;
84         const UChar* d = m_string.deprecatedCharacters();
85         WTF::Unicode::ConversionResult result = WTF::Unicode::convertUTF16ToUTF8(&d, d + m_string.length(), &p, p + bufferSize - 1, /* strict */ true);
86         *p++ = '\0';
87         if (result != WTF::Unicode::conversionOK && result != WTF::Unicode::targetExhausted)
88             return 0;
89         return p - buffer;
90     }
91
92     bool equal(String* other) { return m_string == other->m_string; }
93     bool equalToUTF8String(const char* other) { return m_string == WTF::String::fromUTF8(other); }
94     bool equalToUTF8StringIgnoringCase(const char* other) { return equalIgnoringCase(m_string, other); }
95
96     const WTF::String& string() const { return m_string; }
97
98     JSStringRef createJSString() const
99     {
100         JSC::initializeThreading();
101         return OpaqueJSString::create(m_string).leakRef();
102     }
103
104 private:
105     String()
106         : m_string()
107     {
108     }
109
110     String(const WTF::String& string)
111         : m_string(!string.impl() ? WTF::String(StringImpl::empty()) : string)
112     {
113     }
114
115     WTF::String m_string;
116 };
117
118 } // namespace WebKit
119
120 #endif // APIString_h