Web Inspector: add external resources size to the native memory diagram
[WebKit-https.git] / Source / WTF / wtf / text / StringBuilder.h
1 /*
2  * Copyright (C) 2009, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2012 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef StringBuilder_h
28 #define StringBuilder_h
29
30 #include <wtf/text/AtomicString.h>
31 #include <wtf/text/WTFString.h>
32
33 namespace WTF {
34
35 class StringBuilder {
36     // Disallow copying since it's expensive and we don't want code to do it by accident.
37     WTF_MAKE_NONCOPYABLE(StringBuilder);
38
39 public:
40     StringBuilder()
41         : m_length(0)
42         , m_is8Bit(true)
43         , m_valid16BitShadowLength(0)
44         , m_bufferCharacters8(0)
45     {
46     }
47
48     WTF_EXPORT_PRIVATE void append(const UChar*, unsigned);
49     WTF_EXPORT_PRIVATE void append(const LChar*, unsigned);
50
51     ALWAYS_INLINE void append(const char* characters, unsigned length) { append(reinterpret_cast<const LChar*>(characters), length); }
52
53     void append(const String& string)
54     {
55         if (!string.length())
56             return;
57
58         // If we're appending to an empty string, and there is not a buffer (reserveCapacity has not been called)
59         // then just retain the string.
60         if (!m_length && !m_buffer) {
61             m_string = string;
62             m_length = string.length();
63             m_is8Bit = m_string.is8Bit();
64             return;
65         }
66
67         if (string.is8Bit())
68             append(string.characters8(), string.length());
69         else
70             append(string.characters16(), string.length());
71     }
72
73     void append(const StringBuilder& other)
74     {
75         if (!other.m_length)
76             return;
77
78         // If we're appending to an empty string, and there is not a buffer (reserveCapacity has not been called)
79         // then just retain the string.
80         if (!m_length && !m_buffer && !other.m_string.isNull()) {
81             m_string = other.m_string;
82             m_length = other.m_length;
83             return;
84         }
85
86         append(other.characters(), other.m_length);
87     }
88
89     void append(const String& string, unsigned offset, unsigned length)
90     {
91         if (!string.length())
92             return;
93
94         if ((offset + length) > string.length())
95             return;
96
97         if (string.is8Bit())
98             append(string.characters8() + offset, length);
99         else
100             append(string.characters16() + offset, length);
101     }
102
103     void append(const char* characters)
104     {
105         if (characters)
106             append(characters, strlen(characters));
107     }
108
109     void append(UChar c)
110     {
111         if (m_buffer && !m_is8Bit && m_length < m_buffer->length() && m_string.isNull())
112             m_bufferCharacters16[m_length++] = c;
113         else
114             append(&c, 1);
115     }
116
117     void append(LChar c)
118     {
119         if (m_buffer && m_length < m_buffer->length() && m_string.isNull()) {
120             if (m_is8Bit)
121                 m_bufferCharacters8[m_length++] = c;
122             else
123                 m_bufferCharacters16[m_length++] = c;
124         } else
125             append(&c, 1);
126     }
127     
128     void append(char c)
129     {
130         append(static_cast<LChar>(c));
131     }
132
133     String toString()
134     {
135         shrinkToFit();
136         if (m_string.isNull())
137             reifyString();
138         return m_string;
139     }
140
141     const String& toStringPreserveCapacity() const
142     {
143         if (m_string.isNull())
144             reifyString();
145         return m_string;
146     }
147
148     AtomicString toAtomicString() const
149     {
150         if (!m_length)
151             return AtomicString();
152
153         // If the buffer is sufficiently over-allocated, make a new AtomicString from a copy so its buffer is not so large.
154         if (canShrink())
155             return AtomicString(characters(), length());
156
157         if (!m_string.isNull())
158             return AtomicString(m_string);
159
160         ASSERT(m_buffer);
161         return AtomicString(m_buffer.get(), 0, m_length);
162     }
163
164     unsigned length() const
165     {
166         return m_length;
167     }
168
169     bool isEmpty() const { return !m_length; }
170
171     WTF_EXPORT_PRIVATE void reserveCapacity(unsigned newCapacity);
172
173     unsigned capacity() const
174     {
175         return m_buffer ? m_buffer->length() : m_length;
176     }
177
178     WTF_EXPORT_PRIVATE void resize(unsigned newSize);
179
180     WTF_EXPORT_PRIVATE bool canShrink() const;
181
182     WTF_EXPORT_PRIVATE void shrinkToFit();
183
184     UChar operator[](unsigned i) const
185     {
186         ASSERT(i < m_length);
187         if (m_is8Bit)
188             return characters8()[i];
189         return characters16()[i];
190     }
191
192     const LChar* characters8() const
193     {
194         ASSERT(m_is8Bit);
195         if (!m_length)
196             return 0;
197         if (!m_string.isNull())
198             return m_string.characters8();
199         ASSERT(m_buffer);
200         return m_buffer->characters8();
201     }
202
203     const UChar* characters16() const
204     {
205         ASSERT(!m_is8Bit);
206         if (!m_length)
207             return 0;
208         if (!m_string.isNull())
209             return m_string.characters16();
210         ASSERT(m_buffer);
211         return m_buffer->characters16();
212     }
213     
214     const UChar* characters() const
215     {
216         if (!m_length)
217             return 0;
218         if (!m_string.isNull())
219             return m_string.characters();
220         ASSERT(m_buffer);
221         if (m_buffer->has16BitShadow() && m_valid16BitShadowLength < m_length)
222             m_buffer->upconvertCharacters(m_valid16BitShadowLength, m_length);
223
224         m_valid16BitShadowLength = m_length;
225
226         return m_buffer->characters();
227     }
228     
229     bool is8Bit() const { return m_is8Bit; }
230
231     void clear()
232     {
233         m_length = 0;
234         m_string = String();
235         m_buffer = 0;
236         m_bufferCharacters8 = 0;
237         m_is8Bit = true;
238         m_valid16BitShadowLength = 0;
239     }
240
241     void swap(StringBuilder& stringBuilder)
242     {
243         std::swap(m_length, stringBuilder.m_length);
244         m_string.swap(stringBuilder.m_string);
245         m_buffer.swap(stringBuilder.m_buffer);
246         std::swap(m_is8Bit, stringBuilder.m_is8Bit);
247         std::swap(m_valid16BitShadowLength, stringBuilder.m_valid16BitShadowLength);
248         std::swap(m_bufferCharacters8, stringBuilder.m_bufferCharacters8);
249     }
250
251 private:
252     void allocateBuffer(const LChar* currentCharacters, unsigned requiredLength);
253     void allocateBuffer(const UChar* currentCharacters, unsigned requiredLength);
254     void allocateBufferUpConvert(const LChar* currentCharacters, unsigned requiredLength);
255     template <typename CharType>
256     void reallocateBuffer(unsigned requiredLength);
257     template <typename CharType>
258     ALWAYS_INLINE CharType* appendUninitialized(unsigned length);
259     template <typename CharType>
260     CharType* appendUninitializedSlow(unsigned length);
261     template <typename CharType>
262     ALWAYS_INLINE CharType * getBufferCharacters();
263     WTF_EXPORT_PRIVATE void reifyString() const;
264
265     unsigned m_length;
266     mutable String m_string;
267     RefPtr<StringImpl> m_buffer;
268     bool m_is8Bit;
269     mutable unsigned m_valid16BitShadowLength;
270     union {
271         LChar* m_bufferCharacters8;
272         UChar* m_bufferCharacters16;
273     };
274 };
275
276 template <>
277 ALWAYS_INLINE LChar* StringBuilder::getBufferCharacters<LChar>()
278 {
279     ASSERT(m_is8Bit);
280     return m_bufferCharacters8;
281 }
282
283 template <>
284 ALWAYS_INLINE UChar* StringBuilder::getBufferCharacters<UChar>()
285 {
286     ASSERT(!m_is8Bit);
287     return m_bufferCharacters16;
288 }    
289
290 template <typename CharType>
291 bool equal(const StringBuilder& s, const CharType* buffer, unsigned length)
292 {
293     if (s.length() != length)
294         return false;
295
296     if (s.is8Bit())
297         return equal(s.characters8(), buffer, length);
298
299     return equal(s.characters16(), buffer, length);
300 }
301
302 template <typename StringType>
303 bool equal(const StringBuilder& a, const StringType& b)
304 {
305     if (a.length() != b.length())
306         return false;
307
308     if (!a.length())
309         return true;
310
311     if (a.is8Bit()) {
312         if (b.is8Bit())
313             return equal(a.characters8(), b.characters8(), a.length());
314         return equal(a.characters8(), b.characters16(), a.length());
315     }
316
317     if (b.is8Bit())
318         return equal(a.characters16(), b.characters8(), a.length());
319     return equal(a.characters16(), b.characters16(), a.length());
320 }
321
322 inline bool operator==(const StringBuilder& a, const StringBuilder& b) { return equal(a, b); }
323 inline bool operator!=(const StringBuilder& a, const StringBuilder& b) { return !equal(a, b); }
324 inline bool operator==(const StringBuilder& a, const String& b) { return equal(a, b); }
325 inline bool operator!=(const StringBuilder& a, const String& b) { return !equal(a, b); }
326 inline bool operator==(const String& a, const StringBuilder& b) { return equal(b, a); }
327 inline bool operator!=(const String& a, const StringBuilder& b) { return !equal(b, a); }
328
329 } // namespace WTF
330
331 using WTF::StringBuilder;
332
333 #endif // StringBuilder_h