API/JSObjectRef.cpp

   1 /*
   2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
   3  * Copyright (C) 2008 Kelvin W Sherlock (ksherlock@gmail.com)
   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 COMPUTER, 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 COMPUTER, 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 #include "config.h"
  28 #include "JSObjectRef.h"
  29 #include "JSObjectRefPrivate.h"
  30
  31 #include "APICast.h"
  32 #include "CodeBlock.h"
  33 #include "DateConstructor.h"
  34 #include "ErrorConstructor.h"
  35 #include "FunctionConstructor.h"
  36 #include "Identifier.h"
  37 #include "InitializeThreading.h"
  38 #include "JSArray.h"
  39 #include "JSCallbackConstructor.h"
  40 #include "JSCallbackFunction.h"
  41 #include "JSCallbackObject.h"
  42 #include "JSClassRef.h"
  43 #include "JSFunction.h"
  44 #include "JSGlobalObject.h"
  45 #include "JSObject.h"
  46 #include "JSRetainPtr.h"
  47 #include "JSString.h"
  48 #include "JSValueRef.h"
  49 #include "ObjectPrototype.h"
  50 #include "PropertyNameArray.h"
  51 #include "RegExpConstructor.h"
  52
  53 using namespace JSC;
  54
  55 JSClassRef JSClassCreate(const JSClassDefinition* definition)
  56 {
  57     initializeThreading();
  58     RefPtr<OpaqueJSClass> jsClass = (definition->attributes & kJSClassAttributeNoAutomaticPrototype)
  59         ? OpaqueJSClass::createNoAutomaticPrototype(definition)
  60         : OpaqueJSClass::create(definition);
  61
  62     return jsClass.release().releaseRef();
  63 }
  64
  65 JSClassRef JSClassRetain(JSClassRef jsClass)
  66 {
  67     jsClass->ref();
  68     return jsClass;
  69 }
  70
  71 void JSClassRelease(JSClassRef jsClass)
  72 {
  73     jsClass->deref();
  74 }
  75
  76 JSObjectRef JSObjectMake(JSContextRef ctx, JSClassRef jsClass, void* data)
  77 {
  78     ExecState* exec = toJS(ctx);
  79     APIEntryShim entryShim(exec);
  80
  81     if (!jsClass)
  82         return toRef(new (exec) JSObject(exec->lexicalGlobalObject()->emptyObjectStructure())); // slightly more efficient
  83
  84     JSCallbackObject<JSObject>* object = new (exec) JSCallbackObject<JSObject>(exec, exec->lexicalGlobalObject()->callbackObjectStructure(), jsClass, data);
  85     if (JSObject* prototype = jsClass->prototype(exec))
  86         object->setPrototype(prototype);
  87
  88     return toRef(object);
  89 }
  90
  91 JSObjectRef JSObjectMakeFunctionWithCallback(JSContextRef ctx, JSStringRef name, JSObjectCallAsFunctionCallback callAsFunction)
  92 {
  93     ExecState* exec = toJS(ctx);
  94     APIEntryShim entryShim(exec);
  95
  96     Identifier nameID = name ? name->identifier(&exec->globalData()) : Identifier(exec, "anonymous");
  97
  98     return toRef(new (exec) JSCallbackFunction(exec, callAsFunction, nameID));
  99 }
 100
 101 JSObjectRef JSObjectMakeConstructor(JSContextRef ctx, JSClassRef jsClass, JSObjectCallAsConstructorCallback callAsConstructor)
 102 {
 103     ExecState* exec = toJS(ctx);
 104     APIEntryShim entryShim(exec);
 105
 106     JSValue jsPrototype = jsClass ? jsClass->prototype(exec) : 0;
 107     if (!jsPrototype)
 108         jsPrototype = exec->lexicalGlobalObject()->objectPrototype();
 109
 110     JSCallbackConstructor* constructor = new (exec) JSCallbackConstructor(exec->lexicalGlobalObject()->callbackConstructorStructure(), jsClass, callAsConstructor);
 111     constructor->putDirect(exec->propertyNames().prototype, jsPrototype, DontEnum | DontDelete | ReadOnly);
 112     return toRef(constructor);
 113 }
 114
 115 JSObjectRef JSObjectMakeFunction(JSContextRef ctx, JSStringRef name, unsigned parameterCount, const JSStringRef parameterNames[], JSStringRef body, JSStringRef sourceURL, int startingLineNumber, JSValueRef* exception)
 116 {
 117     ExecState* exec = toJS(ctx);
 118     APIEntryShim entryShim(exec);
 119
 120     Identifier nameID = name ? name->identifier(&exec->globalData()) : Identifier(exec, "anonymous");
 121
 122     MarkedArgumentBuffer args;
 123     for (unsigned i = 0; i < parameterCount; i++)
 124         args.append(jsString(exec, parameterNames[i]->ustring()));
 125     args.append(jsString(exec, body->ustring()));
 126
 127     JSObject* result = constructFunction(exec, args, nameID, sourceURL->ustring(), startingLineNumber);
 128     if (exec->hadException()) {
 129         if (exception)
 130             *exception = toRef(exec, exec->exception());
 131         exec->clearException();
 132         result = 0;
 133     }
 134     return toRef(result);
 135 }
 136
 137 JSObjectRef JSObjectMakeArray(JSContextRef ctx, size_t argumentCount, const JSValueRef arguments[],  JSValueRef* exception)
 138 {
 139     ExecState* exec = toJS(ctx);
 140     APIEntryShim entryShim(exec);
 141
 142     JSObject* result;
 143     if (argumentCount) {
 144         MarkedArgumentBuffer argList;
 145         for (size_t i = 0; i < argumentCount; ++i)
 146             argList.append(toJS(exec, arguments[i]));
 147
 148         result = constructArray(exec, argList);
 149     } else
 150         result = constructEmptyArray(exec);
 151
 152     if (exec->hadException()) {
 153         if (exception)
 154             *exception = toRef(exec, exec->exception());
 155         exec->clearException();
 156         result = 0;
 157     }
 158
 159     return toRef(result);
 160 }
 161
 162 JSObjectRef JSObjectMakeDate(JSContextRef ctx, size_t argumentCount, const JSValueRef arguments[],  JSValueRef* exception)
 163 {
 164     ExecState* exec = toJS(ctx);
 165     APIEntryShim entryShim(exec);
 166
 167     MarkedArgumentBuffer argList;
 168     for (size_t i = 0; i < argumentCount; ++i)
 169         argList.append(toJS(exec, arguments[i]));
 170
 171     JSObject* result = constructDate(exec, argList);
 172     if (exec->hadException()) {
 173         if (exception)
 174             *exception = toRef(exec, exec->exception());
 175         exec->clearException();
 176         result = 0;
 177     }
 178
 179     return toRef(result);
 180 }
 181
 182 JSObjectRef JSObjectMakeError(JSContextRef ctx, size_t argumentCount, const JSValueRef arguments[],  JSValueRef* exception)
 183 {
 184     ExecState* exec = toJS(ctx);
 185     APIEntryShim entryShim(exec);
 186
 187     MarkedArgumentBuffer argList;
 188     for (size_t i = 0; i < argumentCount; ++i)
 189         argList.append(toJS(exec, arguments[i]));
 190
 191     JSObject* result = constructError(exec, argList);
 192     if (exec->hadException()) {
 193         if (exception)
 194             *exception = toRef(exec, exec->exception());
 195         exec->clearException();
 196         result = 0;
 197     }
 198
 199     return toRef(result);
 200 }
 201
 202 JSObjectRef JSObjectMakeRegExp(JSContextRef ctx, size_t argumentCount, const JSValueRef arguments[],  JSValueRef* exception)
 203 {
 204     ExecState* exec = toJS(ctx);
 205     APIEntryShim entryShim(exec);
 206
 207     MarkedArgumentBuffer argList;
 208     for (size_t i = 0; i < argumentCount; ++i)
 209         argList.append(toJS(exec, arguments[i]));
 210
 211     JSObject* result = constructRegExp(exec, argList);
 212     if (exec->hadException()) {
 213         if (exception)
 214             *exception = toRef(exec, exec->exception());
 215         exec->clearException();
 216         result = 0;
 217     }
 218
 219     return toRef(result);
 220 }
 221
 222 JSValueRef JSObjectGetPrototype(JSContextRef ctx, JSObjectRef object)
 223 {
 224     ExecState* exec = toJS(ctx);
 225     APIEntryShim entryShim(exec);
 226
 227     JSObject* jsObject = toJS(object);
 228     return toRef(exec, jsObject->prototype());
 229 }
 230
 231 void JSObjectSetPrototype(JSContextRef ctx, JSObjectRef object, JSValueRef value)
 232 {
 233     ExecState* exec = toJS(ctx);
 234     APIEntryShim entryShim(exec);
 235
 236     JSObject* jsObject = toJS(object);
 237     JSValue jsValue = toJS(exec, value);
 238
 239     jsObject->setPrototype(jsValue.isObject() ? jsValue : jsNull());
 240 }
 241
 242 bool JSObjectHasProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName)
 243 {
 244     ExecState* exec = toJS(ctx);
 245     APIEntryShim entryShim(exec);
 246
 247     JSObject* jsObject = toJS(object);
 248
 249     return jsObject->hasProperty(exec, propertyName->identifier(&exec->globalData()));
 250 }
 251
 252 JSValueRef JSObjectGetProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName, JSValueRef* exception)
 253 {
 254     ExecState* exec = toJS(ctx);
 255     APIEntryShim entryShim(exec);
 256
 257     JSObject* jsObject = toJS(object);
 258
 259     JSValue jsValue = jsObject->get(exec, propertyName->identifier(&exec->globalData()));
 260     if (exec->hadException()) {
 261         if (exception)
 262             *exception = toRef(exec, exec->exception());
 263         exec->clearException();
 264     }
 265     return toRef(exec, jsValue);
 266 }
 267
 268 void JSObjectSetProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName, JSValueRef value, JSPropertyAttributes attributes, JSValueRef* exception)
 269 {
 270     ExecState* exec = toJS(ctx);
 271     APIEntryShim entryShim(exec);
 272
 273     JSObject* jsObject = toJS(object);
 274     Identifier name(propertyName->identifier(&exec->globalData()));
 275     JSValue jsValue = toJS(exec, value);
 276
 277     if (attributes && !jsObject->hasProperty(exec, name))
 278         jsObject->putWithAttributes(exec, name, jsValue, attributes);
 279     else {
 280         PutPropertySlot slot;
 281         jsObject->put(exec, name, jsValue, slot);
 282     }
 283
 284     if (exec->hadException()) {
 285         if (exception)
 286             *exception = toRef(exec, exec->exception());
 287         exec->clearException();
 288     }
 289 }
 290
 291 JSValueRef JSObjectGetPropertyAtIndex(JSContextRef ctx, JSObjectRef object, unsigned propertyIndex, JSValueRef* exception)
 292 {
 293     ExecState* exec = toJS(ctx);
 294     APIEntryShim entryShim(exec);
 295
 296     JSObject* jsObject = toJS(object);
 297
 298     JSValue jsValue = jsObject->get(exec, propertyIndex);
 299     if (exec->hadException()) {
 300         if (exception)
 301             *exception = toRef(exec, exec->exception());
 302         exec->clearException();
 303     }
 304     return toRef(exec, jsValue);
 305 }
 306
 307
 308 void JSObjectSetPropertyAtIndex(JSContextRef ctx, JSObjectRef object, unsigned propertyIndex, JSValueRef value, JSValueRef* exception)
 309 {
 310     ExecState* exec = toJS(ctx);
 311     APIEntryShim entryShim(exec);
 312
 313     JSObject* jsObject = toJS(object);
 314     JSValue jsValue = toJS(exec, value);
 315
 316     jsObject->put(exec, propertyIndex, jsValue);
 317     if (exec->hadException()) {
 318         if (exception)
 319             *exception = toRef(exec, exec->exception());
 320         exec->clearException();
 321     }
 322 }
 323
 324 bool JSObjectDeleteProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName, JSValueRef* exception)
 325 {
 326     ExecState* exec = toJS(ctx);
 327     APIEntryShim entryShim(exec);
 328
 329     JSObject* jsObject = toJS(object);
 330
 331     bool result = jsObject->deleteProperty(exec, propertyName->identifier(&exec->globalData()));
 332     if (exec->hadException()) {
 333         if (exception)
 334             *exception = toRef(exec, exec->exception());
 335         exec->clearException();
 336     }
 337     return result;
 338 }
 339
 340 void* JSObjectGetPrivate(JSObjectRef object)
 341 {
 342     JSObject* jsObject = toJS(object);
 343
 344     if (jsObject->inherits(&JSCallbackObject<JSGlobalObject>::info))
 345         return static_cast<JSCallbackObject<JSGlobalObject>*>(jsObject)->getPrivate();
 346     else if (jsObject->inherits(&JSCallbackObject<JSObject>::info))
 347         return static_cast<JSCallbackObject<JSObject>*>(jsObject)->getPrivate();
 348
 349     return 0;
 350 }
 351
 352 bool JSObjectSetPrivate(JSObjectRef object, void* data)
 353 {
 354     JSObject* jsObject = toJS(object);
 355
 356     if (jsObject->inherits(&JSCallbackObject<JSGlobalObject>::info)) {
 357         static_cast<JSCallbackObject<JSGlobalObject>*>(jsObject)->setPrivate(data);
 358         return true;
 359     } else if (jsObject->inherits(&JSCallbackObject<JSObject>::info)) {
 360         static_cast<JSCallbackObject<JSObject>*>(jsObject)->setPrivate(data);
 361         return true;
 362     }
 363
 364     return false;
 365 }
 366
 367 JSValueRef JSObjectGetPrivateProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName)
 368 {
 369     ExecState* exec = toJS(ctx);
 370     APIEntryShim entryShim(exec);
 371     JSObject* jsObject = toJS(object);
 372     JSValue result;
 373     Identifier name(propertyName->identifier(&exec->globalData()));
 374     if (jsObject->inherits(&JSCallbackObject<JSGlobalObject>::info))
 375         result = static_cast<JSCallbackObject<JSGlobalObject>*>(jsObject)->getPrivateProperty(name);
 376     else if (jsObject->inherits(&JSCallbackObject<JSObject>::info))
 377         result = static_cast<JSCallbackObject<JSObject>*>(jsObject)->getPrivateProperty(name);
 378     return toRef(exec, result);
 379 }
 380
 381 bool JSObjectSetPrivateProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName, JSValueRef value)
 382 {
 383     ExecState* exec = toJS(ctx);
 384     APIEntryShim entryShim(exec);
 385     JSObject* jsObject = toJS(object);
 386     JSValue jsValue = toJS(exec, value);
 387     Identifier name(propertyName->identifier(&exec->globalData()));
 388     if (jsObject->inherits(&JSCallbackObject<JSGlobalObject>::info)) {
 389         static_cast<JSCallbackObject<JSGlobalObject>*>(jsObject)->setPrivateProperty(name, jsValue);
 390         return true;
 391     }
 392     if (jsObject->inherits(&JSCallbackObject<JSObject>::info)) {
 393         static_cast<JSCallbackObject<JSObject>*>(jsObject)->setPrivateProperty(name, jsValue);
 394         return true;
 395     }
 396     return false;
 397 }
 398
 399 bool JSObjectDeletePrivateProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName)
 400 {
 401     ExecState* exec = toJS(ctx);
 402     APIEntryShim entryShim(exec);
 403     JSObject* jsObject = toJS(object);
 404     Identifier name(propertyName->identifier(&exec->globalData()));
 405     if (jsObject->inherits(&JSCallbackObject<JSGlobalObject>::info)) {
 406         static_cast<JSCallbackObject<JSGlobalObject>*>(jsObject)->deletePrivateProperty(name);
 407         return true;
 408     }
 409     if (jsObject->inherits(&JSCallbackObject<JSObject>::info)) {
 410         static_cast<JSCallbackObject<JSObject>*>(jsObject)->deletePrivateProperty(name);
 411         return true;
 412     }
 413     return false;
 414 }
 415
 416 bool JSObjectIsFunction(JSContextRef, JSObjectRef object)
 417 {
 418     CallData callData;
 419     return toJS(object)->getCallData(callData) != CallTypeNone;
 420 }
 421
 422 JSValueRef JSObjectCallAsFunction(JSContextRef ctx, JSObjectRef object, JSObjectRef thisObject, size_t argumentCount, const JSValueRef arguments[], JSValueRef* exception)
 423 {
 424     ExecState* exec = toJS(ctx);
 425     APIEntryShim entryShim(exec);
 426
 427     JSObject* jsObject = toJS(object);
 428     JSObject* jsThisObject = toJS(thisObject);
 429
 430     if (!jsThisObject)
 431         jsThisObject = exec->globalThisValue();
 432
 433     MarkedArgumentBuffer argList;
 434     for (size_t i = 0; i < argumentCount; i++)
 435         argList.append(toJS(exec, arguments[i]));
 436
 437     CallData callData;
 438     CallType callType = jsObject->getCallData(callData);
 439     if (callType == CallTypeNone)
 440         return 0;
 441
 442     JSValueRef result = toRef(exec, call(exec, jsObject, callType, callData, jsThisObject, argList));
 443     if (exec->hadException()) {
 444         if (exception)
 445             *exception = toRef(exec, exec->exception());
 446         exec->clearException();
 447         result = 0;
 448     }
 449     return result;
 450 }
 451
 452 bool JSObjectIsConstructor(JSContextRef, JSObjectRef object)
 453 {
 454     JSObject* jsObject = toJS(object);
 455     ConstructData constructData;
 456     return jsObject->getConstructData(constructData) != ConstructTypeNone;
 457 }
 458
 459 JSObjectRef JSObjectCallAsConstructor(JSContextRef ctx, JSObjectRef object, size_t argumentCount, const JSValueRef arguments[], JSValueRef* exception)
 460 {
 461     ExecState* exec = toJS(ctx);
 462     APIEntryShim entryShim(exec);
 463
 464     JSObject* jsObject = toJS(object);
 465
 466     ConstructData constructData;
 467     ConstructType constructType = jsObject->getConstructData(constructData);
 468     if (constructType == ConstructTypeNone)
 469         return 0;
 470
 471     MarkedArgumentBuffer argList;
 472     for (size_t i = 0; i < argumentCount; i++)
 473         argList.append(toJS(exec, arguments[i]));
 474     JSObjectRef result = toRef(construct(exec, jsObject, constructType, constructData, argList));
 475     if (exec->hadException()) {
 476         if (exception)
 477             *exception = toRef(exec, exec->exception());
 478         exec->clearException();
 479         result = 0;
 480     }
 481     return result;
 482 }
 483
 484 struct OpaqueJSPropertyNameArray : FastAllocBase {
 485     OpaqueJSPropertyNameArray(JSGlobalData* globalData)
 486         : refCount(0)
 487         , globalData(globalData)
 488     {
 489     }
 490
 491     unsigned refCount;
 492     JSGlobalData* globalData;
 493     Vector<JSRetainPtr<JSStringRef> > array;
 494 };
 495
 496 JSPropertyNameArrayRef JSObjectCopyPropertyNames(JSContextRef ctx, JSObjectRef object)
 497 {
 498     JSObject* jsObject = toJS(object);
 499     ExecState* exec = toJS(ctx);
 500     APIEntryShim entryShim(exec);
 501
 502     JSGlobalData* globalData = &exec->globalData();
 503
 504     JSPropertyNameArrayRef propertyNames = new OpaqueJSPropertyNameArray(globalData);
 505     PropertyNameArray array(globalData);
 506     jsObject->getPropertyNames(exec, array);
 507
 508     size_t size = array.size();
 509     propertyNames->array.reserveInitialCapacity(size);
 510     for (size_t i = 0; i < size; ++i)
 511         propertyNames->array.append(JSRetainPtr<JSStringRef>(Adopt, OpaqueJSString::create(array[i].ustring()).releaseRef()));
 512
 513     return JSPropertyNameArrayRetain(propertyNames);
 514 }
 515
 516 JSPropertyNameArrayRef JSPropertyNameArrayRetain(JSPropertyNameArrayRef array)
 517 {
 518     ++array->refCount;
 519     return array;
 520 }
 521
 522 void JSPropertyNameArrayRelease(JSPropertyNameArrayRef array)
 523 {
 524     if (--array->refCount == 0) {
 525         APIEntryShim entryShim(array->globalData, false);
 526         delete array;
 527     }
 528 }
 529
 530 size_t JSPropertyNameArrayGetCount(JSPropertyNameArrayRef array)
 531 {
 532     return array->array.size();
 533 }
 534
 535 JSStringRef JSPropertyNameArrayGetNameAtIndex(JSPropertyNameArrayRef array, size_t index)
 536 {
 537     return array->array[static_cast<unsigned>(index)].get();
 538 }
 539
 540 void JSPropertyNameAccumulatorAddName(JSPropertyNameAccumulatorRef array, JSStringRef propertyName)
 541 {
 542     PropertyNameArray* propertyNames = toJS(array);
 543     APIEntryShim entryShim(propertyNames->globalData());
 544     propertyNames->add(propertyName->identifier(propertyNames->globalData()));
 545 }