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 // FIXME: Basically any use of this is bad. toString() returns a JSString* so we don't need to
  88 // pass around the originalValue; we could just pass around the JSString*. Then you don't need
  89 // this function. You just use the JSString* that toString() returned.
  90 static inline JSString* jsStringWithReuse(ExecState* exec, JSValue originalValue, const String& string)
  91 {
  92     if (originalValue.isString()) {
  93         ASSERT(asString(originalValue)->value(exec) == string);
  94         return asString(originalValue);
  95     }
  96     return jsString(exec, string);
  97 }
  98
  99 // Helper that tries to use the JSString substring sharing mechanism if 'originalValue' is a JSString.
 100 // FIXME: Basically any use of this is bad. toString() returns a JSString* so we don't need to
 101 // pass around the originalValue; we could just pass around the JSString*. And since we've
 102 // resolved it, we know that we can just allocate the substring cell directly.
 103 // https://bugs.webkit.org/show_bug.cgi?id=158140
 104 static inline JSString* jsSubstring(ExecState* exec, JSValue originalValue, const String& string, unsigned offset, unsigned length)
 105 {
 106     if (originalValue.isString()) {
 107         ASSERT(asString(originalValue)->value(exec) == string);
 108         return jsSubstring(exec, asString(originalValue), offset, length);
 109     }
 110     return jsSubstring(exec, string, offset, length);
 111 }
 112
 113
 114 } // namespace JSC
 115
 116 #endif // StringObject_h