0ceb5b83538651478462a24c445f61c9d8b2df71
[WebKit-https.git] / Source / JavaScriptCore / runtime / RegExpObject.cpp
1 /*
2  *  Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2003, 2007-2008, 2012, 2016 Apple Inc. All Rights Reserved.
4  *
5  *  This library is free software; you can redistribute it and/or
6  *  modify it under the terms of the GNU Lesser General Public
7  *  License as published by the Free Software Foundation; either
8  *  version 2 of the License, or (at your option) any later version.
9  *
10  *  This library is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  *  Lesser General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Lesser General Public
16  *  License along with this library; if not, write to the Free Software
17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18  *
19  */
20
21 #include "config.h"
22 #include "RegExpObject.h"
23
24 #include "Error.h"
25 #include "ExceptionHelpers.h"
26 #include "JSArray.h"
27 #include "JSGlobalObject.h"
28 #include "JSString.h"
29 #include "Lookup.h"
30 #include "JSCInlines.h"
31 #include "RegExpConstructor.h"
32 #include "RegExpObjectInlines.h"
33
34 namespace JSC {
35
36 STATIC_ASSERT_IS_TRIVIALLY_DESTRUCTIBLE(RegExpObject);
37
38 const ClassInfo RegExpObject::s_info = { "RegExp", &Base::s_info, nullptr, CREATE_METHOD_TABLE(RegExpObject) };
39
40 RegExpObject::RegExpObject(VM& vm, Structure* structure, RegExp* regExp)
41     : JSNonFinalObject(vm, structure)
42     , m_regExp(vm, this, regExp)
43     , m_lastIndexIsWritable(true)
44 {
45     m_lastIndex.setWithoutWriteBarrier(jsNumber(0));
46 }
47
48 void RegExpObject::finishCreation(VM& vm)
49 {
50     Base::finishCreation(vm);
51     ASSERT(inherits(info()));
52 }
53
54 void RegExpObject::visitChildren(JSCell* cell, SlotVisitor& visitor)
55 {
56     RegExpObject* thisObject = jsCast<RegExpObject*>(cell);
57     ASSERT_GC_OBJECT_INHERITS(thisObject, info());
58     Base::visitChildren(thisObject, visitor);
59     visitor.append(&thisObject->m_regExp);
60     visitor.append(&thisObject->m_lastIndex);
61 }
62
63 bool RegExpObject::getOwnPropertySlot(JSObject* object, ExecState* exec, PropertyName propertyName, PropertySlot& slot)
64 {
65     if (propertyName == exec->propertyNames().lastIndex) {
66         RegExpObject* regExp = asRegExpObject(object);
67         unsigned attributes = regExp->m_lastIndexIsWritable ? DontDelete | DontEnum : DontDelete | DontEnum | ReadOnly;
68         slot.setValue(regExp, attributes, regExp->getLastIndex());
69         return true;
70     }
71     return Base::getOwnPropertySlot(object, exec, propertyName, slot);
72 }
73
74 bool RegExpObject::deleteProperty(JSCell* cell, ExecState* exec, PropertyName propertyName)
75 {
76     if (propertyName == exec->propertyNames().lastIndex)
77         return false;
78     return Base::deleteProperty(cell, exec, propertyName);
79 }
80
81 void RegExpObject::getOwnNonIndexPropertyNames(JSObject* object, ExecState* exec, PropertyNameArray& propertyNames, EnumerationMode mode)
82 {
83     if (mode.includeDontEnumProperties())
84         propertyNames.add(exec->propertyNames().lastIndex);
85     Base::getOwnNonIndexPropertyNames(object, exec, propertyNames, mode);
86 }
87
88 void RegExpObject::getPropertyNames(JSObject* object, ExecState* exec, PropertyNameArray& propertyNames, EnumerationMode mode)
89 {
90     if (mode.includeDontEnumProperties())
91         propertyNames.add(exec->propertyNames().lastIndex);
92     Base::getPropertyNames(object, exec, propertyNames, mode);
93 }
94
95 void RegExpObject::getGenericPropertyNames(JSObject* object, ExecState* exec, PropertyNameArray& propertyNames, EnumerationMode mode)
96 {
97     if (mode.includeDontEnumProperties())
98         propertyNames.add(exec->propertyNames().lastIndex);
99     Base::getGenericPropertyNames(object, exec, propertyNames, mode);
100 }
101
102 bool RegExpObject::defineOwnProperty(JSObject* object, ExecState* exec, PropertyName propertyName, const PropertyDescriptor& descriptor, bool shouldThrow)
103 {
104     VM& vm = exec->vm();
105     auto scope = DECLARE_THROW_SCOPE(vm);
106
107     if (propertyName == vm.propertyNames->lastIndex) {
108         RegExpObject* regExp = asRegExpObject(object);
109         if (descriptor.configurablePresent() && descriptor.configurable())
110             return typeError(exec, scope, shouldThrow, ASCIILiteral(UnconfigurablePropertyChangeConfigurabilityError));
111         if (descriptor.enumerablePresent() && descriptor.enumerable())
112             return typeError(exec, scope, shouldThrow, ASCIILiteral(UnconfigurablePropertyChangeEnumerabilityError));
113         if (descriptor.isAccessorDescriptor())
114             return typeError(exec, scope, shouldThrow, ASCIILiteral(UnconfigurablePropertyChangeAccessMechanismError));
115         if (!regExp->m_lastIndexIsWritable) {
116             if (descriptor.writablePresent() && descriptor.writable())
117                 return typeError(exec, scope, shouldThrow, ASCIILiteral(UnconfigurablePropertyChangeWritabilityError));
118             if (!sameValue(exec, regExp->getLastIndex(), descriptor.value()))
119                 return typeError(exec, scope, shouldThrow, ASCIILiteral(ReadonlyPropertyChangeError));
120             return true;
121         }
122         if (descriptor.value()) {
123             regExp->setLastIndex(exec, descriptor.value(), false);
124             RETURN_IF_EXCEPTION(scope, false);
125         }
126         if (descriptor.writablePresent() && !descriptor.writable())
127             regExp->m_lastIndexIsWritable = false;
128         return true;
129     }
130
131     scope.release();
132     return Base::defineOwnProperty(object, exec, propertyName, descriptor, shouldThrow);
133 }
134
135 static bool regExpObjectSetLastIndexStrict(ExecState* exec, EncodedJSValue thisValue, EncodedJSValue value)
136 {
137     return asRegExpObject(JSValue::decode(thisValue))->setLastIndex(exec, JSValue::decode(value), true);
138 }
139
140 static bool regExpObjectSetLastIndexNonStrict(ExecState* exec, EncodedJSValue thisValue, EncodedJSValue value)
141 {
142     return asRegExpObject(JSValue::decode(thisValue))->setLastIndex(exec, JSValue::decode(value), false);
143 }
144
145 bool RegExpObject::put(JSCell* cell, ExecState* exec, PropertyName propertyName, JSValue value, PutPropertySlot& slot)
146 {
147     RegExpObject* thisObject = jsCast<RegExpObject*>(cell);
148
149     if (UNLIKELY(isThisValueAltered(slot, thisObject)))
150         return ordinarySetSlow(exec, thisObject, propertyName, value, slot.thisValue(), slot.isStrictMode());
151
152     if (propertyName == exec->propertyNames().lastIndex) {
153         bool result = asRegExpObject(cell)->setLastIndex(exec, value, slot.isStrictMode());
154         slot.setCustomValue(asRegExpObject(cell), slot.isStrictMode()
155             ? regExpObjectSetLastIndexStrict
156             : regExpObjectSetLastIndexNonStrict);
157         return result;
158     }
159     return Base::put(cell, exec, propertyName, value, slot);
160 }
161
162 JSValue RegExpObject::exec(ExecState* exec, JSGlobalObject* globalObject, JSString* string)
163 {
164     return execInline(exec, globalObject, string);
165 }
166
167 // Shared implementation used by test and exec.
168 MatchResult RegExpObject::match(ExecState* exec, JSGlobalObject* globalObject, JSString* string)
169 {
170     return matchInline(exec, globalObject, string);
171 }
172
173 template<typename FixEndFunc>
174 JSValue collectMatches(VM& vm, ExecState* exec, JSString* string, const String& s, RegExpConstructor* constructor, RegExp* regExp, const FixEndFunc& fixEnd)
175 {
176     auto scope = DECLARE_THROW_SCOPE(vm);
177
178     MatchResult result = constructor->performMatch(vm, regExp, string, s, 0);
179     if (!result)
180         return jsNull();
181     
182     static unsigned maxSizeForDirectPath = 100000;
183     
184     JSArray* array = constructEmptyArray(exec, nullptr);
185     RETURN_IF_EXCEPTION(scope, { });
186
187     bool hasException = false;
188     auto iterate = [&] () {
189         size_t end = result.end;
190         size_t length = end - result.start;
191         array->push(exec, JSRopeString::createSubstringOfResolved(vm, string, result.start, length));
192         if (UNLIKELY(scope.exception())) {
193             hasException = true;
194             return;
195         }
196         if (!length)
197             end = fixEnd(end);
198         result = constructor->performMatch(vm, regExp, string, s, end);
199     };
200     
201     do {
202         if (array->length() >= maxSizeForDirectPath) {
203             // First do a throw-away match to see how many matches we'll get.
204             unsigned matchCount = 0;
205             MatchResult savedResult = result;
206             do {
207                 if (array->length() + matchCount >= MAX_STORAGE_VECTOR_LENGTH) {
208                     throwOutOfMemoryError(exec, scope);
209                     return jsUndefined();
210                 }
211                 
212                 size_t end = result.end;
213                 matchCount++;
214                 if (result.empty())
215                     end = fixEnd(end);
216                 
217                 // Using RegExpConstructor::performMatch() instead of calling RegExp::match()
218                 // directly is a surprising but profitable choice: it means that when we do OOM, we
219                 // will leave the cached result in the state it ought to have had just before the
220                 // OOM! On the other hand, if this loop concludes that the result is small enough,
221                 // then the iterate() loop below will overwrite the cached result anyway.
222                 result = constructor->performMatch(vm, regExp, string, s, end);
223             } while (result);
224             
225             // OK, we have a sensible number of matches. Now we can create them for reals.
226             result = savedResult;
227             do {
228                 iterate();
229                 ASSERT(!!scope.exception() == hasException);
230                 if (UNLIKELY(hasException))
231                     return { };
232             } while (result);
233             
234             return array;
235         }
236         
237         iterate();
238     } while (result);
239     
240     return array;
241 }
242
243 JSValue RegExpObject::matchGlobal(ExecState* exec, JSGlobalObject* globalObject, JSString* string)
244 {
245     VM& vm = globalObject->vm();
246     auto scope = DECLARE_THROW_SCOPE(vm);
247     RegExp* regExp = this->regExp();
248
249     ASSERT(regExp->global());
250
251     setLastIndex(exec, 0);
252     RETURN_IF_EXCEPTION(scope, { });
253
254     String s = string->value(exec);
255     RegExpConstructor* regExpConstructor = globalObject->regExpConstructor();
256     
257     if (regExp->unicode()) {
258         unsigned stringLength = s.length();
259         scope.release();
260         return collectMatches(
261             vm, exec, string, s, regExpConstructor, regExp,
262             [&] (size_t end) -> size_t {
263                 return advanceStringUnicode(s, stringLength, end);
264             });
265     }
266
267     scope.release();
268     return collectMatches(
269         vm, exec, string, s, regExpConstructor, regExp,
270         [&] (size_t end) -> size_t {
271             return end + 1;
272         });
273 }
274
275 } // namespace JSC