[api] Add PropertyDescriptor and DefineProperty().

include/v8.h

 // Copyright 2012 the V8 project authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /** \mainpage V8 API Reference Guide
  *
  * V8 is Google's open source JavaScript engine.
  *
  * This set of documents provides reference material generated from the
  * V8 header file, include/v8.h.
@@ skipping 78 matching lines @@
 class Maybe;
 class Name;
 class Number;
 class NumberObject;
 class Object;
 class ObjectOperationDescriptor;
 class ObjectTemplate;
 class Platform;
 class Primitive;
 class Promise;
+class PropertyDescriptor;
 class Proxy;
 class RawOperationDescriptor;
 class Script;
 class SharedArrayBuffer;
 class Signature;
 class StartupData;
 class StackFrame;
 class StackTrace;
 class String;
 class StringObject;
@@ skipping 2675 matching lines @@
   // Implements DefineOwnProperty.
   //
   // In general, CreateDataProperty will be faster, however, does not allow
   // for specifying attributes.
   //
   // Returns true on success.
   V8_WARN_UNUSED_RESULT Maybe<bool> DefineOwnProperty(
       Local<Context> context, Local<Name> key, Local<Value> value,
       PropertyAttribute attributes = None);
 
+  // Implements Object.DefineProperty(O, P, Attributes), see Ecma-262 19.1.2.4.
+  //
+  // The defineProperty function is used to add an own property or
+  // update the attributes of an existing own property of an object.
+  //
+  // Both data and accessor descriptors can be used.
+  //
+  // In general, CreateDataProperty is faster, however, does not allow
+  // for specifying attributes or an accessor descriptor.
+  //
+  // Returns true on success.
+  V8_WARN_UNUSED_RESULT Maybe<bool> DefineProperty(
+      Local<Context> context, Local<Name> key,
+      const PropertyDescriptor& descriptor);
+
   // Sets an own property on this object bypassing interceptors and
   // overriding accessors or read-only properties.
   //
   // Note that if the object has an interceptor the property will be set
   // locally, but since the interceptor takes precedence the local property
   // will only be returned if the interceptor doesn't return a value.
   //
   // Note also that this only works for named properties.
   V8_DEPRECATED("Use CreateDataProperty / DefineOwnProperty",
                 bool ForceSet(Local<Value> key, Local<Value> value,
@@ skipping 797 matching lines @@
    */
   bool HasHandler();
 
   V8_INLINE static Promise* Cast(Value* obj);
 
  private:
   Promise();
   static void CheckCast(Value* obj);
 };
 
+/**
+ * An instance of a Property Descriptor, see Ecma-262 6.2.4.
+ *
+ * This property descriptor is immutable except for its properties enumerable
+ * and configurable. An invalid descriptor that is both
+ * a data and accessor descriptor can not be generated. To determine if
+ * a descriptor is an accessor, data, or generic descriptor, use the
+ * `has_x()` functions for appropriate x.
+ *
+ * Accessors `get` or `set` must be callable, unless they are undefined. Use
+ * empty handles to indicate that `value`, `get`, or `set` are not set.
+ *
+ * \code
+ * PropertyDescriptor(Local<Function>())) // var desc = {}
+ * PropertyDescriptor(v8::Undefined(isolate)) // var desc = {get: undefined}
+ * \endcode
+ */
+class V8_EXPORT PropertyDescriptor {
+ public:
+  enum State { kTrue = 0, kFalse = 1, kNotSet = 2 };
+
+  // GenericDescriptor
+  PropertyDescriptor();
+
+  // DataDescriptor
+  PropertyDescriptor(Local<Value> value, State writable);
+
+  // AccessorDescriptor
+  PropertyDescriptor(Local<Value> get, Local<Value> set);
+
+  ~PropertyDescriptor();
+
+  Local<Value> value() const;
+  bool has_value() const;
+
+  Local<Value> get() const;
+  bool has_get() const;
+  Local<Value> set() const;
+  bool has_set() const;
+
+  void set_enumerable(bool enumerable);
+  State enumerable() const;

[Jakob Kummerow, 2016/08/29 12:32:23]

I'd be fine with a "bool enumerable() / bool has_enumerable()" pair (more
verbose but also more consistent with e.g. value/has_value), but this is okay
too.

[Franzi, 2016/08/31 09:44:13]

As discussed, I'm using bool instead of the enum State. I added another
constructor so we can distinguish between present and absent for writable.

+
+  void set_configurable(bool configurable);
+  State configurable() const;
+
+  State writable() const;
+
+  PropertyDescriptor(const PropertyDescriptor&) = delete;
+  void operator=(const PropertyDescriptor&) = delete;
+
+ private:
+  struct PrivateData;
+  PrivateData* private_;
+};
 
 /**
  * An instance of the built-in Proxy constructor (ECMA-262, 6th Edition,
  * 26.2.1).
  */
 class V8_EXPORT Proxy : public Object {
  public:
   Local<Object> GetTarget();
   Local<Value> GetHandler();
   bool IsRevoked();
@@ skipping 5612 matching lines @@
  */
 
 
 }  // namespace v8
 
 
 #undef TYPE_CHECK
 
 
 #endif  // INCLUDE_V8_H_