Store object definition ID in each js_class.

fpdfsdk/include/javascript/JS_Define.h

 // Copyright 2014 PDFium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
 
 #ifndef FPDFSDK_INCLUDE_JAVASCRIPT_JS_DEFINE_H_
 #define FPDFSDK_INCLUDE_JAVASCRIPT_JS_DEFINE_H_
 
 #include "../jsapi/fxjs_v8.h"
@@ skipping 165 matching lines @@
                                                    info);                     \
   }
 
 #define JS_SPECIAL_STATIC_METHOD(method_name, class_alternate, class_name) \
   static void method_name##_static(                                        \
       const v8::FunctionCallbackInfo<v8::Value>& info) {                   \
     JSMethod<class_alternate, &class_alternate::method_name>(              \
         #method_name, #class_name, info);                                  \
   }
 
-/* ===================================== JS CLASS
- * =============================================== */
+/* ========================================= JS_CLASS

[Lei Zhang, 2015/10/06 01:15:21]

Would you mind fixing these since you are already touching it? They were meant
to be an one line ruler, but clang-format has broken it in two.

[Tom Sepez, 2015/10/06 15:33:20]

Done. Throughout. I don't think these added much value.

[Lei Zhang, 2015/10/06 18:16:17]

Removing is fine too.

+ * =========================================== */
 
-#define DECLARE_JS_CLASS(js_class_name)                                     \
-  static void JSConstructor(IFXJS_Context* cc, v8::Local<v8::Object> obj,   \
-                            v8::Local<v8::Object> global);                  \
-  static void JSDestructor(v8::Local<v8::Object> obj);                      \
-  static void DefineJSObjects(v8::Isolate* pIsolate, FXJSOBJTYPE eObjType); \
-  static JSConstSpec JS_Class_Consts[];                                     \
-  static JSPropertySpec JS_Class_Properties[];                              \
-  static JSMethodSpec JS_Class_Methods[];                                   \
-  static const wchar_t* m_pClassName
+// All JS classes have a name, an object defintion ID, and the ability to
+// register themselves with FXJS_V8. We never make a BASE class on its own
+// because it can't really do anything.
+#define DECLARE_JS_CLASS_BASE_PART()  \
+  static const wchar_t* g_pClassName; \
+  static int g_nObjDefnID;            \
+  static void DefineJSObjects(v8::Isolate* pIsolate, FXJSOBJTYPE eObjType);
 
-#define IMPLEMENT_JS_CLASS_RICH(js_class_name, class_alternate, class_name)  \
-  const wchar_t* js_class_name::m_pClassName = JS_WIDESTRING(class_name);    \
-  void js_class_name::JSConstructor(IFXJS_Context* cc,                       \
-                                    v8::Local<v8::Object> obj,               \
-                                    v8::Local<v8::Object> global) {          \
-    CJS_Object* pObj = new js_class_name(obj);                               \
-    pObj->SetEmbedObject(new class_alternate(pObj));                         \
-    FXJS_SetPrivate(NULL, obj, (void*)pObj);                                 \
-    pObj->InitInstance(cc);                                                  \
-  }                                                                          \
-                                                                             \
-  void js_class_name::JSDestructor(v8::Local<v8::Object> obj) {              \
-    js_class_name* pObj = (js_class_name*)FXJS_GetPrivate(NULL, obj);        \
-    pObj->ExitInstance();                                                    \
-    delete pObj;                                                             \
-  }                                                                          \
-                                                                             \
-  void js_class_name::DefineJSObjects(v8::Isolate* pIsolate,                 \
-                                      FXJSOBJTYPE eObjType) {                \
-    int nObjDefnID = FXJS_DefineObj(pIsolate, js_class_name::m_pClassName,   \
-                                    eObjType, JSConstructor, JSDestructor);  \
-    for (int i = 0; i < FX_ArraySize(JS_Class_Properties) - 1; ++i) {        \
-      FXJS_DefineObjProperty(                                                \
-          pIsolate, nObjDefnID, JS_Class_Properties[i].pName,                \
-          JS_Class_Properties[i].pPropGet, JS_Class_Properties[i].pPropPut); \
-    }                                                                        \
-    for (int i = 0; i < FX_ArraySize(JS_Class_Methods) - 1; ++i) {           \
-      FXJS_DefineObjMethod(pIsolate, nObjDefnID, JS_Class_Methods[i].pName,  \
-                           JS_Class_Methods[i].pMethodCall);                 \
-    }                                                                        \
+#define IMPLEMENT_JS_CLASS_BASE_PART(js_class_name, class_name)           \
+  const wchar_t* js_class_name::g_pClassName = JS_WIDESTRING(class_name); \
+  int js_class_name::g_nObjDefnID = -1;
+
+// CONST classes provide constants, but not constructors, methods, or props.
+#define DECLARE_JS_CLASS_CONST() \
+  DECLARE_JS_CLASS_BASE_PART()   \
+  DECLARE_JS_CLASS_CONST_PART()
+
+#define DECLARE_JS_CLASS_CONST_PART()   \

[Lei Zhang, 2015/10/06 01:15:21]

Can you pust DECLARE_FOO and IMPLEMENT_FOO together in that order? Right now you
have:

DECLARE_JS_CLASS_BASE_PART
IMPLEMENT_JS_CLASS_BASE_PART
DECLARE_JS_CLASS_CONST
DECLARE_JS_CLASS_CONST_PART
IMPLEMENT_JS_CLASS_CONST  <-- move up 1
IMPLEMENT_JS_CLASS_CONST_PART

[Tom Sepez, 2015/10/06 15:33:20]

Done. For all of these.

+  static JSConstSpec JS_Class_Consts[]; \
+  static void DefineConsts(v8::Isolate* pIsolate);
+
+#define IMPLEMENT_JS_CLASS_CONST(js_class_name, class_name)              \
+  IMPLEMENT_JS_CLASS_BASE_PART(js_class_name, class_name)                \
+  IMPLEMENT_JS_CLASS_CONST_PART(js_class_name, class_name)               \
+  void js_class_name::DefineJSObjects(v8::Isolate* pIsolate,             \
+                                      FXJSOBJTYPE eObjType) {            \
+    g_nObjDefnID = FXJS_DefineObj(pIsolate, js_class_name::g_pClassName, \
+                                  eObjType, NULL, NULL);                 \

[Lei Zhang, 2015/10/06 01:15:21]

nullptr, since we are here

[Tom Sepez, 2015/10/06 15:33:19]

Done.

+    DefineConsts(pIsolate);                                              \
   }
 
+#define IMPLEMENT_JS_CLASS_CONST_PART(js_class_name, class_name)      \
+  void js_class_name::DefineConsts(v8::Isolate* pIsolate) {           \
+    for (int i = 0; i < FX_ArraySize(JS_Class_Consts) - 1; ++i) {     \

[Lei Zhang, 2015/10/06 01:15:21]

Can we get rid of the {0, 0, 0, 0} entry in END_JS_STATIC_CONST() and remove the
subtract 1 here? Ditto with END_JS_STATIC_PROP() and END_JS_STATIC_METHOD().

[Tom Sepez, 2015/10/06 15:33:19]

Sadly, no because there is the possibility of classes which don't declare any of
these, and you wind up with a zero-sized array, and that then fails to compile.

[Lei Zhang, 2015/10/06 18:16:17]

Too bad.

+      FXJS_DefineObjConst(                                            \
+          pIsolate, g_nObjDefnID, JS_Class_Consts[i].pName,           \
+          JS_Class_Consts[i].t == 0                                   \
+              ? FXJS_NewNumber(pIsolate, JS_Class_Consts[i].number)   \
+              : FXJS_NewString(pIsolate, JS_Class_Consts[i].string)); \
+    }                                                                 \
+  }
+
+// Convenience macros for declaring classes without an alternate.
+#define DECLARE_JS_CLASS() DECLARE_JS_CLASS_RICH()
 #define IMPLEMENT_JS_CLASS(js_class_name, class_name) \
   IMPLEMENT_JS_CLASS_RICH(js_class_name, class_name, class_name)
 
-/* ======================================== CONST CLASS
- * ============================================ */
+// Rich JS classes provide constsants, methods, properties, and the ability

[Lei Zhang, 2015/10/06 01:15:21]

typo

[Tom Sepez, 2015/10/06 15:33:20]

Done.

+// to construct native object state.
+#define DECLARE_JS_CLASS_RICH() \
+  DECLARE_JS_CLASS_BASE_PART()  \
+  DECLARE_JS_CLASS_CONST_PART() \
+  DECLARE_JS_CLASS_RICH_PART()
 
-#define DECLARE_JS_CLASS_CONST()                                            \
-  static void DefineJSObjects(v8::Isolate* pIsolate, FXJSOBJTYPE eObjType); \
-  static JSConstSpec JS_Class_Consts[];                                     \
-  static const wchar_t* m_pClassName
+#define DECLARE_JS_CLASS_RICH_PART()                                      \
+  static void JSConstructor(IFXJS_Context* cc, v8::Local<v8::Object> obj, \
+                            v8::Local<v8::Object> global);                \
+  static void JSDestructor(v8::Local<v8::Object> obj);                    \
+  static void DefineProps(v8::Isolate* pIsoalte);                         \
+  static void DefineMethods(v8::Isolate* pIsoalte);                       \
+  static JSPropertySpec JS_Class_Properties[];                            \
+  static JSMethodSpec JS_Class_Methods[];
 
-#define IMPLEMENT_JS_CLASS_CONST(js_class_name, class_name)                \
-  const wchar_t* js_class_name::m_pClassName = JS_WIDESTRING(class_name);  \
-  void js_class_name::DefineJSObjects(v8::Isolate* pIsolate,               \
-                                      FXJSOBJTYPE eObjType) {              \
-    int nObjDefnID = FXJS_DefineObj(pIsolate, js_class_name::m_pClassName, \
-                                    eObjType, NULL, NULL);                 \
-    for (int i = 0; i < FX_ArraySize(JS_Class_Consts) - 1; ++i) {          \
-      FXJS_DefineObjConst(                                                 \
-          pIsolate, nObjDefnID, JS_Class_Consts[i].pName,                  \
-          JS_Class_Consts[i].t == 0                                        \
-              ? FXJS_NewNumber(pIsolate, JS_Class_Consts[i].number)        \
-              : FXJS_NewString(pIsolate, JS_Class_Consts[i].string));      \
-    }                                                                      \
+#define IMPLEMENT_JS_CLASS_RICH(js_class_name, class_alternate, class_name) \
+  IMPLEMENT_JS_CLASS_BASE_PART(js_class_name, class_name)                   \
+  IMPLEMENT_JS_CLASS_CONST_PART(js_class_name, class_name)                  \
+  IMPLEMENT_JS_CLASS_RICH_PART(js_class_name, class_alternate, class_name)  \
+  void js_class_name::DefineJSObjects(v8::Isolate* pIsolate,                \
+                                      FXJSOBJTYPE eObjType) {               \
+    g_nObjDefnID = FXJS_DefineObj(pIsolate, js_class_name::g_pClassName,    \
+                                  eObjType, JSConstructor, JSDestructor);   \
+    DefineConsts(pIsolate);                                                 \
+    DefineProps(pIsolate);                                                  \
+    DefineMethods(pIsolate);                                                \
   }
 
-/* ===================================== SPECIAL JS CLASS
- * =============================================== */
+#define IMPLEMENT_JS_CLASS_RICH_PART(js_class_name, class_alternate,          \
+                                     class_name)                              \
+  void js_class_name::JSConstructor(IFXJS_Context* cc,                        \
+                                    v8::Local<v8::Object> obj,                \
+                                    v8::Local<v8::Object> global) {           \
+    CJS_Object* pObj = new js_class_name(obj);                                \
+    pObj->SetEmbedObject(new class_alternate(pObj));                          \
+    FXJS_SetPrivate(NULL, obj, (void*)pObj);                                  \
+    pObj->InitInstance(cc);                                                   \
+  }                                                                           \
+  void js_class_name::JSDestructor(v8::Local<v8::Object> obj) {               \
+    js_class_name* pObj = (js_class_name*)FXJS_GetPrivate(NULL, obj);         \
+    pObj->ExitInstance();                                                     \
+    delete pObj;                                                              \
+  }                                                                           \
+  void js_class_name::DefineProps(v8::Isolate* pIsolate) {                    \
+    for (int i = 0; i < FX_ArraySize(JS_Class_Properties) - 1; ++i) {         \
+      FXJS_DefineObjProperty(                                                 \
+          pIsolate, g_nObjDefnID, JS_Class_Properties[i].pName,               \
+          JS_Class_Properties[i].pPropGet, JS_Class_Properties[i].pPropPut);  \
+    }                                                                         \
+  }                                                                           \
+  void js_class_name::DefineMethods(v8::Isolate* pIsolate) {                  \
+    for (int i = 0; i < FX_ArraySize(JS_Class_Methods) - 1; ++i) {            \
+      FXJS_DefineObjMethod(pIsolate, g_nObjDefnID, JS_Class_Methods[i].pName, \
+                           JS_Class_Methods[i].pMethodCall);                  \
+    }                                                                         \
+  }
+
+// Special JS classes implement methods, props, and queries, but not consts.
+#define DECLARE_SPECIAL_JS_CLASS() \
+  DECLARE_JS_CLASS_BASE_PART()     \
+  DECLARE_JS_CLASS_CONST_PART()    \
+  DECLARE_JS_CLASS_RICH_PART()     \
+  DECLARE_SPECIAL_JS_CLASS_PART()
+
+#define DECLARE_SPECIAL_JS_CLASS_PART()                                        \
+  static void queryprop_static(                                                \
+      v8::Local<v8::String> property,                                          \
+      const v8::PropertyCallbackInfo<v8::Integer>& info);                      \
+  static void getprop_static(v8::Local<v8::String> property,                   \
+                             const v8::PropertyCallbackInfo<v8::Value>& info); \
+  static void putprop_static(v8::Local<v8::String> property,                   \
+                             v8::Local<v8::Value> value,                       \
+                             const v8::PropertyCallbackInfo<v8::Value>& info); \
+  static void delprop_static(                                                  \
+      v8::Local<v8::String> property,                                          \
+      const v8::PropertyCallbackInfo<v8::Boolean>& info);                      \
+  static void DefineAllProperties(v8::Isolate* pIsolate);
+
+#define IMPLEMENT_SPECIAL_JS_CLASS(js_class_name, class_alternate, class_name) \
+  IMPLEMENT_JS_CLASS_BASE_PART(js_class_name, class_name)                      \
+  IMPLEMENT_JS_CLASS_CONST_PART(js_class_name, class_name)                     \
+  IMPLEMENT_JS_CLASS_RICH_PART(js_class_name, class_alternate, class_name)     \
+  IMPLEMENT_SPECIAL_JS_CLASS_PART(js_class_name, class_alternate, class_name)  \
+  void js_class_name::DefineJSObjects(v8::Isolate* pIsolate,                   \
+                                      FXJSOBJTYPE eObjType) {                  \
+    g_nObjDefnID = FXJS_DefineObj(pIsolate, js_class_name::g_pClassName,       \
+                                  eObjType, JSConstructor, JSDestructor);      \
+    DefineConsts(pIsolate);                                                    \
+    DefineProps(pIsolate);                                                     \
+    DefineMethods(pIsolate);                                                   \
+    DefineAllProperties(pIsolate);                                             \
+  }
+
+#define IMPLEMENT_SPECIAL_JS_CLASS_PART(js_class_name, class_alternate,    \
+                                        class_name)                        \
+  void js_class_name::queryprop_static(                                    \
+      v8::Local<v8::String> property,                                      \
+      const v8::PropertyCallbackInfo<v8::Integer>& info) {                 \
+    JSSpecialPropQuery<class_alternate>(#class_name, property, info);      \
+  }                                                                        \
+  void js_class_name::getprop_static(                                      \
+      v8::Local<v8::String> property,                                      \
+      const v8::PropertyCallbackInfo<v8::Value>& info) {                   \
+    JSSpecialPropGet<class_alternate>(#class_name, property, info);        \
+  }                                                                        \
+  void js_class_name::putprop_static(                                      \
+      v8::Local<v8::String> property, v8::Local<v8::Value> value,          \
+      const v8::PropertyCallbackInfo<v8::Value>& info) {                   \
+    JSSpecialPropPut<class_alternate>(#class_name, property, value, info); \
+  }                                                                        \
+  void js_class_name::delprop_static(                                      \
+      v8::Local<v8::String> property,                                      \
+      const v8::PropertyCallbackInfo<v8::Boolean>& info) {                 \
+    JSSpecialPropDel<class_alternate>(#class_name, property, info);        \
+  }                                                                        \
+  void js_class_name::DefineAllProperties(v8::Isolate* pIsolate) {         \
+    FXJS_DefineObjAllProperties(                                           \
+        pIsolate, g_nObjDefnID, js_class_name::queryprop_static,           \
+        js_class_name::getprop_static, js_class_name::putprop_static,      \
+        js_class_name::delprop_static);                                    \
+  }
 
 template <class Alt>
 void JSSpecialPropQuery(const char*,
                         v8::Local<v8::String> property,
                         const v8::PropertyCallbackInfo<v8::Integer>& info) {
   v8::Isolate* isolate = info.GetIsolate();
   v8::String::Utf8Value utf8_value(property);
   CFX_WideString propname =
       CFX_WideString::FromUTF8(*utf8_value, utf8_value.length());
   CJS_Object* pJSObj =
@@ skipping 68 matching lines @@
   CFX_WideString propname =
       CFX_WideString::FromUTF8(*utf8_value, utf8_value.length());
   CFX_WideString sError;
   if (!pObj->DelProperty(pRuntimeContext, propname.c_str(), sError)) {
     CFX_ByteString cbName;
     cbName.Format("%s.%s", class_name, "DelProperty");
     // Probably a missing call to JSFX_Error().
   }
 }
 
-#define DECLARE_SPECIAL_JS_CLASS(js_class_name)                             \
-  static void JSConstructor(IFXJS_Context* cc, v8::Local<v8::Object> obj,   \
-                            v8::Local<v8::Object> global);                  \
-  static void JSDestructor(v8::Local<v8::Object> obj);                      \
-  static JSConstSpec JS_Class_Consts[];                                     \
-  static JSPropertySpec JS_Class_Properties[];                              \
-  static JSMethodSpec JS_Class_Methods[];                                   \
-  static void DefineJSObjects(v8::Isolate* pIsolate, FXJSOBJTYPE eObjType); \
-  static const wchar_t* m_pClassName;                                       \
-  static void queryprop_##js_class_name##_static(                           \
-      v8::Local<v8::String> property,                                       \
-      const v8::PropertyCallbackInfo<v8::Integer>& info);                   \
-  static void getprop_##js_class_name##_static(                             \
-      v8::Local<v8::String> property,                                       \
-      const v8::PropertyCallbackInfo<v8::Value>& info);                     \
-  static void putprop_##js_class_name##_static(                             \
-      v8::Local<v8::String> property, v8::Local<v8::Value> value,           \
-      const v8::PropertyCallbackInfo<v8::Value>& info);                     \
-  static void delprop_##js_class_name##_static(                             \
-      v8::Local<v8::String> property,                                       \
-      const v8::PropertyCallbackInfo<v8::Boolean>& info)
-
-#define IMPLEMENT_SPECIAL_JS_CLASS(js_class_name, class_alternate, class_name) \
-  const wchar_t* js_class_name::m_pClassName = JS_WIDESTRING(class_name);      \
-  void js_class_name::queryprop_##js_class_name##_static(                      \
-      v8::Local<v8::String> property,                                          \
-      const v8::PropertyCallbackInfo<v8::Integer>& info) {                     \
-    JSSpecialPropQuery<class_alternate>(#class_name, property, info);          \
-  }                                                                            \
-  void js_class_name::getprop_##js_class_name##_static(                        \
-      v8::Local<v8::String> property,                                          \
-      const v8::PropertyCallbackInfo<v8::Value>& info) {                       \
-    JSSpecialPropGet<class_alternate>(#class_name, property, info);            \
-  }                                                                            \
-  void js_class_name::putprop_##js_class_name##_static(                        \
-      v8::Local<v8::String> property, v8::Local<v8::Value> value,              \
-      const v8::PropertyCallbackInfo<v8::Value>& info) {                       \
-    JSSpecialPropPut<class_alternate>(#class_name, property, value, info);     \
-  }                                                                            \
-  void js_class_name::delprop_##js_class_name##_static(                        \
-      v8::Local<v8::String> property,                                          \
-      const v8::PropertyCallbackInfo<v8::Boolean>& info) {                     \
-    JSSpecialPropDel<class_alternate>(#class_name, property, info);            \
-  }                                                                            \
-  void js_class_name::JSConstructor(IFXJS_Context* cc,                         \
-                                    v8::Local<v8::Object> obj,                 \
-                                    v8::Local<v8::Object> global) {            \
-    CJS_Object* pObj = new js_class_name(obj);                                 \
-    pObj->SetEmbedObject(new class_alternate(pObj));                           \
-    FXJS_SetPrivate(NULL, obj, (void*)pObj);                                   \
-    pObj->InitInstance(cc);                                                    \
-  }                                                                            \
-                                                                               \
-  void js_class_name::JSDestructor(v8::Local<v8::Object> obj) {                \
-    js_class_name* pObj = (js_class_name*)FXJS_GetPrivate(NULL, obj);          \
-    ASSERT(pObj != NULL);                                                      \
-    pObj->ExitInstance();                                                      \
-    delete pObj;                                                               \
-  }                                                                            \
-                                                                               \
-  void js_class_name::DefineJSObjects(v8::Isolate* pIsolate,                   \
-                                      FXJSOBJTYPE eObjType) {                  \
-    int nObjDefnID = FXJS_DefineObj(pIsolate, js_class_name::m_pClassName,     \
-                                    eObjType, JSConstructor, JSDestructor);    \
-    for (int i = 0; i < FX_ArraySize(JS_Class_Properties) - 1; ++i) {          \
-      FXJS_DefineObjProperty(                                                  \
-          pIsolate, nObjDefnID, JS_Class_Properties[i].pName,                  \
-          JS_Class_Properties[i].pPropGet, JS_Class_Properties[i].pPropPut);   \
-    }                                                                          \
-                                                                               \
-    for (int i = 0; i < FX_ArraySize(JS_Class_Methods) - 1; ++i) {             \
-      FXJS_DefineObjMethod(pIsolate, nObjDefnID, JS_Class_Methods[i].pName,    \
-                           JS_Class_Methods[i].pMethodCall);                   \
-    }                                                                          \
-    FXJS_DefineObjAllProperties(                                               \
-        pIsolate, nObjDefnID,                                                  \
-        js_class_name::queryprop_##js_class_name##_static,                     \
-        js_class_name::getprop_##js_class_name##_static,                       \
-        js_class_name::putprop_##js_class_name##_static,                       \
-        js_class_name::delprop_##js_class_name##_static);                      \
-  }
-
 /* ======================================== GLOBAL METHODS
  * ============================================ */
 
 template <FX_BOOL (*F)(IFXJS_Context* cc,
                        const CJS_Parameters& params,
                        CJS_Value& vRet,
                        CFX_WideString& sError)>
 void JSGlobalFunc(const char* func_name_string,
                   const v8::FunctionCallbackInfo<v8::Value>& info) {
   v8::Isolate* isolate = info.GetIsolate();
@@ skipping 36 matching lines @@
     for (int i = 0; i < FX_ArraySize(global_methods) - 1; ++i) {             \
       FXJS_DefineGlobalMethod(pIsolate,                                      \
                               js_class_name::global_methods[i].pName,        \
                               js_class_name::global_methods[i].pMethodCall); \
     }                                                                        \
   }
 
 CJS_Value::Type GET_VALUE_TYPE(v8::Local<v8::Value> p);
 
 #endif  // FPDFSDK_INCLUDE_JAVASCRIPT_JS_DEFINE_H_