JavaScriptCore fails to build with newer versions of clang.
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSString.cpp
1 /*
2  *  Copyright (C) 1999-2002 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2004, 2007, 2008 Apple Inc. All rights reserved.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Library General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Library General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Library General Public License
17  *  along with this library; see the file COPYING.LIB.  If not, write to
18  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  *  Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #include "config.h"
24 #include "JSString.h"
25
26 #include "JSGlobalObject.h"
27 #include "JSGlobalObjectFunctions.h"
28 #include "JSObject.h"
29 #include "Operations.h"
30 #include "StringObject.h"
31 #include "StringPrototype.h"
32
33 namespace JSC {
34     
35 const ClassInfo JSString::s_info = { "string", 0, 0, 0, CREATE_METHOD_TABLE(JSString) };
36
37 void JSRopeString::RopeBuilder::expand()
38 {
39     ASSERT(m_index == JSRopeString::s_maxInternalRopeLength);
40     JSString* jsString = m_jsString;
41     m_jsString = jsStringBuilder(&m_vm);
42     m_index = 0;
43     append(jsString);
44 }
45
46 void JSString::destroy(JSCell* cell)
47 {
48     JSString* thisObject = static_cast<JSString*>(cell);
49     thisObject->JSString::~JSString();
50 }
51
52 void JSString::visitChildren(JSCell* cell, SlotVisitor& visitor)
53 {
54     JSString* thisObject = jsCast<JSString*>(cell);
55     Base::visitChildren(thisObject, visitor);
56     
57     MARK_LOG_MESSAGE1("[%u]: ", thisObject->length());
58
59 #if ENABLE(OBJECT_MARK_LOGGING)
60     if (!thisObject->isRope()) {
61         WTF::StringImpl* ourImpl = thisObject->m_value.impl();
62         if (ourImpl->is8Bit())
63             MARK_LOG_MESSAGE1("[8 %p]", ourImpl->characters8());
64         else
65             MARK_LOG_MESSAGE1("[16 %p]", ourImpl->characters16());
66     } else
67         MARK_LOG_MESSAGE0("[rope]: ");
68 #endif
69
70     if (thisObject->isRope())
71         static_cast<JSRopeString*>(thisObject)->visitFibers(visitor);
72     else {
73         StringImpl* impl = thisObject->m_value.impl();
74         ASSERT(impl);
75         visitor.reportExtraMemoryUsage(impl->costDuringGC());
76     }
77 }
78
79 void JSRopeString::visitFibers(SlotVisitor& visitor)
80 {
81     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i)
82         visitor.append(&m_fibers[i]);
83 }
84
85 void JSRopeString::resolveRope(ExecState* exec) const
86 {
87     ASSERT(isRope());
88
89     if (is8Bit()) {
90         LChar* buffer;
91         if (RefPtr<StringImpl> newImpl = StringImpl::tryCreateUninitialized(m_length, buffer)) {
92             Heap::heap(this)->reportExtraMemoryCost(newImpl->cost());
93             m_value = newImpl.release();
94         } else {
95             outOfMemory(exec);
96             return;
97         }
98
99         for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i) {
100             if (m_fibers[i]->isRope())
101                 return resolveRopeSlowCase8(buffer);
102         }
103
104         LChar* position = buffer;
105         for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i) {
106             StringImpl* string = m_fibers[i]->m_value.impl();
107             unsigned length = string->length();
108             StringImpl::copyChars(position, string->characters8(), length);
109             position += length;
110             m_fibers[i].clear();
111         }
112         ASSERT((buffer + m_length) == position);
113         ASSERT(!isRope());
114
115         return;
116     }
117
118     UChar* buffer;
119     if (RefPtr<StringImpl> newImpl = StringImpl::tryCreateUninitialized(m_length, buffer)) {
120         Heap::heap(this)->reportExtraMemoryCost(newImpl->cost());
121         m_value = newImpl.release();
122     } else {
123         outOfMemory(exec);
124         return;
125     }
126
127     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i) {
128         if (m_fibers[i]->isRope())
129             return resolveRopeSlowCase(buffer);
130     }
131
132     UChar* position = buffer;
133     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i) {
134         StringImpl* string = m_fibers[i]->m_value.impl();
135         unsigned length = string->length();
136         if (string->is8Bit())
137             StringImpl::copyChars(position, string->characters8(), length);
138         else
139             StringImpl::copyChars(position, string->characters16(), length);
140         position += length;
141         m_fibers[i].clear();
142     }
143     ASSERT((buffer + m_length) == position);
144     ASSERT(!isRope());
145 }
146
147 // Overview: These functions convert a JSString from holding a string in rope form
148 // down to a simple String representation. It does so by building up the string
149 // backwards, since we want to avoid recursion, we expect that the tree structure
150 // representing the rope is likely imbalanced with more nodes down the left side
151 // (since appending to the string is likely more common) - and as such resolving
152 // in this fashion should minimize work queue size.  (If we built the queue forwards
153 // we would likely have to place all of the constituent StringImpls into the
154 // Vector before performing any concatenation, but by working backwards we likely
155 // only fill the queue with the number of substrings at any given level in a
156 // rope-of-ropes.)    
157 void JSRopeString::resolveRopeSlowCase8(LChar* buffer) const
158 {
159     LChar* position = buffer + m_length; // We will be working backwards over the rope.
160     Vector<JSString*, 32, UnsafeVectorOverflow> workQueue; // Putting strings into a Vector is only OK because there are no GC points in this method.
161     
162     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i) {
163         workQueue.append(m_fibers[i].get());
164         // Clearing here works only because there are no GC points in this method.
165         m_fibers[i].clear();
166     }
167
168     while (!workQueue.isEmpty()) {
169         JSString* currentFiber = workQueue.last();
170         workQueue.removeLast();
171
172         if (currentFiber->isRope()) {
173             JSRopeString* currentFiberAsRope = static_cast<JSRopeString*>(currentFiber);
174             for (size_t i = 0; i < s_maxInternalRopeLength && currentFiberAsRope->m_fibers[i]; ++i)
175                 workQueue.append(currentFiberAsRope->m_fibers[i].get());
176             continue;
177         }
178
179         StringImpl* string = static_cast<StringImpl*>(currentFiber->m_value.impl());
180         unsigned length = string->length();
181         position -= length;
182         StringImpl::copyChars(position, string->characters8(), length);
183     }
184
185     ASSERT(buffer == position);
186     ASSERT(!isRope());
187 }
188
189 void JSRopeString::resolveRopeSlowCase(UChar* buffer) const
190 {
191     UChar* position = buffer + m_length; // We will be working backwards over the rope.
192     Vector<JSString*, 32, UnsafeVectorOverflow> workQueue; // These strings are kept alive by the parent rope, so using a Vector is OK.
193
194     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i)
195         workQueue.append(m_fibers[i].get());
196
197     while (!workQueue.isEmpty()) {
198         JSString* currentFiber = workQueue.last();
199         workQueue.removeLast();
200
201         if (currentFiber->isRope()) {
202             JSRopeString* currentFiberAsRope = static_cast<JSRopeString*>(currentFiber);
203             for (size_t i = 0; i < s_maxInternalRopeLength && currentFiberAsRope->m_fibers[i]; ++i)
204                 workQueue.append(currentFiberAsRope->m_fibers[i].get());
205             continue;
206         }
207
208         StringImpl* string = static_cast<StringImpl*>(currentFiber->m_value.impl());
209         unsigned length = string->length();
210         position -= length;
211         if (string->is8Bit())
212             StringImpl::copyChars(position, string->characters8(), length);
213         else
214             StringImpl::copyChars(position, string->characters16(), length);
215     }
216
217     ASSERT(buffer == position);
218     ASSERT(!isRope());
219 }
220
221 void JSRopeString::outOfMemory(ExecState* exec) const
222 {
223     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i)
224         m_fibers[i].clear();
225     ASSERT(isRope());
226     ASSERT(m_value.isNull());
227     if (exec)
228         throwOutOfMemoryError(exec);
229 }
230
231 JSString* JSRopeString::getIndexSlowCase(ExecState* exec, unsigned i)
232 {
233     ASSERT(isRope());
234     resolveRope(exec);
235     // Return a safe no-value result, this should never be used, since the excetion will be thrown.
236     if (exec->exception())
237         return jsEmptyString(exec);
238     ASSERT(!isRope());
239     RELEASE_ASSERT(i < m_value.length());
240     return jsSingleCharacterSubstring(exec, m_value, i);
241 }
242
243 JSValue JSString::toPrimitive(ExecState*, PreferredPrimitiveType) const
244 {
245     return const_cast<JSString*>(this);
246 }
247
248 bool JSString::getPrimitiveNumber(ExecState* exec, double& number, JSValue& result) const
249 {
250     result = this;
251     number = jsToNumber(value(exec));
252     return false;
253 }
254
255 bool JSString::toBoolean() const
256 {
257     return m_length;
258 }
259
260 double JSString::toNumber(ExecState* exec) const
261 {
262     return jsToNumber(value(exec));
263 }
264
265 inline StringObject* StringObject::create(ExecState* exec, JSGlobalObject* globalObject, JSString* string)
266 {
267     StringObject* object = new (NotNull, allocateCell<StringObject>(*exec->heap())) StringObject(exec->vm(), globalObject->stringObjectStructure());
268     object->finishCreation(exec->vm(), string);
269     return object;
270 }
271
272 JSObject* JSString::toObject(ExecState* exec, JSGlobalObject* globalObject) const
273 {
274     return StringObject::create(exec, globalObject, const_cast<JSString*>(this));
275 }
276
277 JSValue JSString::toThis(JSCell* cell, ExecState* exec, ECMAMode ecmaMode)
278 {
279     if (ecmaMode == StrictMode)
280         return cell;
281     return StringObject::create(exec, exec->lexicalGlobalObject(), jsCast<JSString*>(cell));
282 }
283
284 bool JSString::getStringPropertyDescriptor(ExecState* exec, PropertyName propertyName, PropertyDescriptor& descriptor)
285 {
286     if (propertyName == exec->propertyNames().length) {
287         descriptor.setDescriptor(jsNumber(m_length), DontEnum | DontDelete | ReadOnly);
288         return true;
289     }
290     
291     unsigned i = propertyName.asIndex();
292     if (i < m_length) {
293         ASSERT(i != PropertyName::NotAnIndex); // No need for an explicit check, the above test would always fail!
294         descriptor.setDescriptor(getIndex(exec, i), DontDelete | ReadOnly);
295         return true;
296     }
297     
298     return false;
299 }
300
301 } // namespace JSC