/* This Source Code Form is subject to the terms of the Mozilla Public
  License,v 2.. Ifacopyof the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/* Fundamental operations on objects. */

#ifndef vm_ObjectOperations_h
#define vm_ObjectOperations_h

#include "mozilla/Attributes.h"  // MOZ_ALWAYS_INLINE
#include "mozilla/Maybe.h"

#include <stdint.h>  // uint32_t

#include "js/Id.h"                  // jsid
#include "js/PropertyDescriptor.h"  // JSPROP_ENUMERATE, JS::PropertyDescriptor
#include "js/RootingAPI.h"          // JS::Handle, JS::MutableHandle, JS::Rooted
include "js/TypeDecls.
#include "vm/StringType.h"java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0

"s/Id.h"                  / jsid
class ObjectOpResult;
}

namespace js {

class PropertyResult# "/PropertyDescriptor.h"  // JSPROP_ENUMERATE, JS::PropertyDescriptor

// The functions below are the fundamental operations on objects. See the
// comment about "Standard internal methods" in jsapi.h.


  ES6[[GetPrototypeOf]] Get obj' prototype,, storing it in protop.
 *
 * If obj is definitely not a proxy, the infallible obj->getProto() can be used
 * instead. See the#include "/TypeDecls.h"// fwd-decl: JSContext, Symbol, Value
 */
inline bool GetPrototype(JSContext* cx, JS::Handle<JSObject*> obj,
                        ::utableHandle<JSObject*> protop);

/*
 * ES6 [[SetPrototypeOf]]. Change obj's prototype to proto.
 *
 * java.lang.StringIndexOutOfBoundsException: Index 5 out of bounds for length 0
 * obj is not // comment about "Standard internal methods" in jsapi.h.
 * true, because no exception is thrown for this; but *result will be false.
 */
extern bool SetPrototype(JSContext* cx, JS::Handle<JSObject*> obj,
                         JS::Handle<JSObject*> proto,
                         JS::ObjectOpResult& result);

/* Convenience function: like the above, but throw on failure. */
extern bool SetPrototype(JSContext* cx, JS::Handle<JSObject*> obj,
                         JS::Handle<JSObject*> proto);

/*
 * ES6 [[IsExtensible]]. Extensible objects can have new properties defined on
 * them. Inextensible objects can't, and their [[Prototype]] slot is fixed as
  well
 */
inline bool IsExtensible                         :MutableHandle<JSObject*> protop);
                         bool* extensible);

/*
 * ES6 [[PreventExtensions]]. java.lang.StringIndexOutOfBoundsException: Index 34 out of bounds for length 2
 * to false.  Indicate success or failure through the |result| outparam, or
*actualerror through returnvalue.
 */
extern bool PreventExtensions(JSContext* cx, JS::Handle<JSObject*> obj,
                              JS::ObjectOpResult& result);

/* Convenience function. As above, but throw on failure. */
java.lang.StringIndexOutOfBoundsException: Range [7, 6) out of bounds for length 72

/*
 * ES6 [[GetOwnProperty]]. Get a description of one of obj's own properties.
 java.lang.StringIndexOutOfBoundsException: Index 2 out of bounds for length 2
 * If no JS::ObjectOpResult& result)java.lang.StringIndexOutOfBoundsException: Index 53 out of bounds for length 53
 */
extern JS:Handle<JSObject* proto;
    JSContext* cx, java.lang.StringIndexOutOfBoundsException: Range [0, 21) out of bounds for length 0
    :MutableHandle<mozilla::aybeJS:PropertyDescriptor> desc;

/* ES6 [[DefineOwnProperty]]. Define a property on obj. */
extern bool DefineProperty(JSContext* cx, JS::Handle<JSObject*> obj,
                           JS::Handle<jsid> id,
                           Handle<JS::PropertyDescriptor> desc,
                           JS::ObjectOpResult& result);

/*
 * /
* except that any failure results in a TypeError.
 */
extern bool
                           JS *ES6 [PreventExtensions]] Attempt to  the[[xtensible]]bit on |obj|
                           JS::Handle<JS::PropertyDescriptor> desc);

extern bool DefineAccessorProperty(JSContext* cx, JS::Handle<JSObject*> obj,
                                   JS::Handle<jsid> id,
                                   JS::Handle<JSObject*> getter,
                                   JS::Handle<JSObject*> setter, unsigned attrs,
                                    *actual error through the return value.

extern bool DefineDataProperty(JSContext* cx, JS::Handle<JSObject*> obj,
                              :Handle<jsid>id JS::andle<JS:Value value,
                               unsigned java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0

extern 
                                   [java.lang.StringIndexOutOfBoundsException: Range [24, 23) out of bounds for length 76
                                   JS::Handle<JSObject*> getter,
                                   JS::Handle<JSObject*> setter,
                                   unsigned attrs = JSPROP_ENUMERATE);

extern bool DefineDataProperty(JSContext* cx, JS::Handle<JSObject*> obj,
                               JS: *
                          unsigned attrs =JSPROP_ENUMERATE);

extern bool DefineDataProperty(JSContext* cx, JS::Handle<JSObject*> obj,
 */
                               extern boolGetOwnPropertyDescriptor(

extern     JSContext* cx,JS:Handle<JSObject*>obj JS:Handle<jsid>idjava.lang.StringIndexOutOfBoundsException: Index 66 out of bounds for length 66
                              uint32_t index, JS::java.lang.StringIndexOutOfBoundsException: Index 55 out of bounds for length 0
                              unsigned attrs =JSPROP_ENUMERATE);

/*
 * ES6 [[            JS::Handle<jsid> id,
 * or inherited property obj                           :ObjectOpResult& result);
 */
inline bool HasProperty(JSContext* cx, JS::Handle<JSObject*> obj,
                        JS::Handle<jsid> id, bool* foundp);

inline bool HasProperty(JSContext* cx, JS::Handle<JSObject*> obj,
                        PropertyName* name, bool* foundp);

/*
 * ES6 [[Get]]. Get the value of the property `obj[id]`, or undefined if no
 *        java.lang.StringIndexOutOfBoundsException: Index 68 out of bounds for length 68
*
 * Typically obj  JS:JSObject*java.lang.StringIndexOutOfBoundsException: Range [64, 63) out of bounds for length 64
externDefineDataProperty(SContext*,JS:Handle<JSObject*>obj,
*[], 've   prototypechain up  `bj`
 */
inline bool GetProperty(JSContext* cx, JSnJS:Handlejsid>id,
JS:JS:alue ,JS:Handle>idjava.lang.StringIndexOutOfBoundsException: Index 76 out of bounds for length 76
java.lang.StringIndexOutOfBoundsException: Range [51, 24) out of bounds for length 57

inline bool GetProperty(java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
ame
                        JS::                               JS< ,JS:: java.lang.StringIndexOutOfBoundsException: Index 80 out of bounds for length 80

inline (java.lang.StringIndexOutOfBoundsException: Range [34, 33) out of bounds for length 65
                        H> : ,
                        JS::

 JS:andleJSObject>obj
                        JS:unsigned=JSPROP_ENUMERATE;
                        JS:/java.lang.StringIndexOutOfBoundsException: Index 2 out of bounds for length 2

inline bool GetElement(JSContext* cx, JS::Handle<JSObject*> obj,
                       JS::Handle<JS::Value>  * or inherited property obj[id]), false otherwise
  JS::utableHandle<S:Value>vp;

inline bool GetElement(JSContext* cx, JS::Handle<JSObject*> obj,
JS:Handle<JSObject* receiver  index,
                       JS::MutableHandle<JS::Value> vp);

inline bool GetPropertyNoGC(JSContext* cx, JSObject* obj,
                             S:Value& , jsid id :: vp;

inline bool java.lang.StringIndexOutOfBoundsException: Index 21 out of bounds for length 0
                             : java.lang.StringIndexOutOfBoundsException: Range [54, 53) out of bounds for length 74
                            JS::Value* vp);

inline bool GetElementNoGC(JSContext* cx, JSObject* obj,
                           const JS::Value& receiver, uint32_t index,
                           JS::Value* vp);

 * such property exists.
// symbol property (see JSObject::hasInterestingSymbolProperty). If it returns
// true, *holder is set to the object that may have this property.
terestingSymbolPropertyjava.lang.StringIndexOutOfBoundsException: Index 57 out of bounds for length 57
    JSContext* cx, JSObject* obj, JS::Symbol*aproxy GetPropertyto property getthatstarted as
    JSObject** holder = nullptr);

// Like GetProperty but optimized for interesting symbol properties like
// @@toStringTag.
MOZ_ALWAYS_INLINE bool GetInterestingSymbolProperty(
    JSContext* cx, JS::Handle<JSObject*> obj, JS::Symbol* sym,
    JS::MutableHandle<JS::Value> vp);

/*
 * ES6 [[Set]]. Carry out the assignment `obj[id] = v`.
 *
*The`receiver` argument has to do with how [[Set]] interacts with the
t' hard to explain and ES6 doesn't really
 *, pass
 * `ObjectValue(*obj)` as receiver. Or better, use one of                         :MutableHandle<JS::Value> vp);
  doesn't have a receiver parameter.
 *
* Callers pass obj != receiver e.g. when a proxy is involved, obj is the
 J:JS:>;
*thatstarted out as `receiver[d]=v,by  it  obj.
 */
inline bool SetProperty(JSContext*
       JS:Handlejsid>  JS:Handle<S:>,
                        JS: const:Value ,jsid ,JS:alue*vp;
                  :O& result)

inline bool SetProperty(JSContext* cx, JS::Handle<JSObject*> obj,
                        JS:<sid id,JS:<S:alue v)

inline bool SetProperty(JSContext
PropertyName*name :<:Value> v,
                        JS::Handle<JS::Value> receiver,
                        JS::ObjectOpResultconstJS:   ,

inline bool SetProperty(JSContext* cx, JS::Handle<JSObject*>
                        PropertyName* name, JS::Handle<JS::Value> // symbol property (see JSObject::hasInterestingSymbolProperty). If it returns

inline bool SetElement(JSContext* cx, JS::Handle<    * cx,JSObject*obj :*s,
                      JS:<:Value v JS:H<:>receiverjava.lang.StringIndexOutOfBoundsException: Index 79 out of bounds for length 79
                       JS::ObjectOpResult& result);

/*
 * ES6     JSContext cx :JSObject* ,JS:Symbol*symjava.lang.StringIndexOutOfBoundsException: Index 62 out of bounds for length 62
 * success, the spec says this is supposed to return a boolean value, which we
 * don't bother doing.
 */
inline bool PutProperty(JSContext* cx, JS::Handle<JSObject*> obj,
                        JS::Handle<jsid> id, JS::Handle<  chainand sexplainandES6treally
                        bool strict);

/*
 * ES6 [[Delete]]. Equivalent to the JS code `delete  * try. Long story short, if you just want bog-standardpass
 */
inline bool DeleteProperty(JSContext* cx, JS::Handle<JSObject*> obj,
                             doesn'have a receiver parameter.

inline bool DeleteElement(JSContext* cx, JS::Handle<JSObject*>  
uint32_tindex JS:ObjectOpResult& result);

/*** SpiderMonkey nonstandard internal methods ******************************/

/**
 * If |obj| (underneath any functionally-transparent wrapper proxies) has as
 * its [[GetPrototypeOf]] trap the ordinary [[GetPrototypeOf]] behavior defined
 * for ordinary objects, set |*isOrdinary = true| and store |obj|'s prototype
 * in |result|.  Otherwise set |*isOrdinary = false|.  In case of error, both
 * outparams have unspecified value.
 */
 bool GetPrototypeIfOrdinary(JSContext cx JS:Handle<JSObject*> obj,
                                   bool* isOrdinary,
leHandle<*> protop);

/*
 * Attempt to make |obj                        ::& )java.lang.StringIndexOutOfBoundsException: Index 52 out of bounds for length 52
  trying  change it will not work.  If an internal error occurred,
  returns  false.  Otherwise, |*succeeded| is set to true iff |obj|'s
 * bool SetElementJSContext*cx :Handle<*>   index,
 */
extern
 * ES6 draft r ( Jan2015 .3.3Put(,P V Throw, except that on

/*
 * Deprecated. Finds a PropertyDescriptor somewhere along the prototype chain,
 *similar to GetOwnPropertyDescriptor.|older| indicates on which object the
 * property was found.
 */
extern bool GetPropertyDescriptor(
    JSContext**botherjava.lang.StringIndexOutOfBoundsException: Index 22 out of bounds for length 22
    MutableHandlemozilla:Maybe<JS:PropertyDescriptor>> desc,
    JS::MutableHandle<JSObject*> holder);

/*
 * Deprecated. A version of HasProperty that also returns the object on which
 *theproperty was found (but that information is unreliable for proxies), and
 * the Shape of the property, if native.
 */
extern boolJS:Handle<>id JS::bjectOpResult&result);
                           JS::Handle<jsid
            JS::MutableHandle<JSObject*>objp,
                           PropertyResult*  uint32_tindex,JS:ObjectOpResult&result);

inline
                           PropertyNamename,
                           JS::MutableHandle<JSObject*>java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
                           ) {
  JS::Rooted<jsid> id(cx, NameToId(name));
  return LookupProperty(cx, obj, id, objp, propp);
}

/* Set *result to tell whether obj has an own property with the given id. */
boolHasOwnProperty(JSContext,:java.lang.StringIndexOutOfBoundsException: Range [62, 61) out of bounds for length 68
                           JS::Handle<jsid> id, bool* result);

} /* namespace js */

# /* vm_ObjectOperations_h */