37e517eaf7c7177f3c18a8435b13a5f54cc911c5
[WebKit-https.git] / Source / JavaScriptCore / runtime / StringObject.h
1 /*
2  *  Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2007-2008, 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 #ifndef StringObject_h
22 #define StringObject_h
23
24 #include "JSWrapperObject.h"
25 #include "JSString.h"
26
27 namespace JSC {
28
29 class StringObject : public JSWrapperObject {
30 public:
31     typedef JSWrapperObject Base;
32     static const unsigned StructureFlags = Base::StructureFlags | OverridesGetOwnPropertySlot | InterceptsGetOwnPropertySlotByIndexEvenWhenLengthIsNotZero | OverridesGetPropertyNames;
33
34     static StringObject* create(VM& vm, Structure* structure)
35     {
36         JSString* string = jsEmptyString(&vm);
37         StringObject* object = new (NotNull, allocateCell<StringObject>(vm.heap)) StringObject(vm, structure);
38         object->finishCreation(vm, string);
39         return object;
40     }
41     static StringObject* create(VM& vm, Structure* structure, JSString* string)
42     {
43         StringObject* object = new (NotNull, allocateCell<StringObject>(vm.heap)) StringObject(vm, structure);
44         object->finishCreation(vm, string);
45         return object;
46     }
47     static StringObject* create(VM&, JSGlobalObject*, JSString*);
48
49     JS_EXPORT_PRIVATE static bool getOwnPropertySlot(JSObject*, ExecState*, PropertyName, PropertySlot&);
50     JS_EXPORT_PRIVATE static bool getOwnPropertySlotByIndex(JSObject*, ExecState*, unsigned propertyName, PropertySlot&);
51
52     JS_EXPORT_PRIVATE static bool put(JSCell*, ExecState*, PropertyName, JSValue, PutPropertySlot&);
53     JS_EXPORT_PRIVATE static bool putByIndex(JSCell*, ExecState*, unsigned propertyName, JSValue, bool shouldThrow);
54
55     JS_EXPORT_PRIVATE static bool deleteProperty(JSCell*, ExecState*, PropertyName);
56     JS_EXPORT_PRIVATE static bool deletePropertyByIndex(JSCell*, ExecState*, unsigned propertyName);
57     JS_EXPORT_PRIVATE static void getOwnPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
58     JS_EXPORT_PRIVATE static bool defineOwnProperty(JSObject*, ExecState*, PropertyName, const PropertyDescriptor&, bool shouldThrow);
59
60     DECLARE_EXPORT_INFO;
61
62     JSString* internalValue() const { return asString(JSWrapperObject::internalValue());}
63
64     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
65     {
66         return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
67     }
68
69 protected:
70     JS_EXPORT_PRIVATE void finishCreation(VM&, JSString*);
71     JS_EXPORT_PRIVATE StringObject(VM&, Structure*);
72 };
73
74 StringObject* asStringObject(JSValue);
75
76 inline StringObject* asStringObject(JSValue value)
77 {
78     ASSERT(asObject(value)->inherits(StringObject::info()));
79     return static_cast<StringObject*>(asObject(value));
80 }
81
82 JS_EXPORT_PRIVATE StringObject* constructString(VM&, JSGlobalObject*, JSValue);
83
84 // Helper for producing a JSString for 'string', where 'string' was been produced by
85 // calling ToString on 'originalValue'. In cases where 'originalValue' already was a
86 // string primitive we can just use this, otherwise we need to allocate a new JSString.
87 static inline JSString* jsStringWithReuse(ExecState* exec, JSValue originalValue, const String& string)
88 {
89     if (originalValue.isString()) {
90         ASSERT(asString(originalValue)->value(exec) == string);
91         return asString(originalValue);
92     }
93     return jsString(exec, string);
94 }
95
96 // Helper that tries to use the JSString substring sharing mechanism if 'originalValue' is a JSString.
97 // FIXME: It would be even better if toString returned a JSString*, or if anyone who called
98 // toString with the intent of later calling this functon first created a jsString from the String
99 // that toString returned. That way, we'd get the substring optimization even when the input was
100 // not a JSString.
101 // https://bugs.webkit.org/show_bug.cgi?id=158140
102 static inline JSString* jsSubstring(ExecState* exec, JSValue originalValue, const String& string, unsigned offset, unsigned length)
103 {
104     if (originalValue.isString()) {
105         ASSERT(asString(originalValue)->value(exec) == string);
106         return jsSubstring(exec, asString(originalValue), offset, length);
107     }
108     return jsSubstring(exec, string, offset, length);
109 }
110
111
112 } // namespace JSC
113
114 #endif // StringObject_h