Return error information from pdfium to JS.

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 _JS_DEFINE_H_
 #define _JS_DEFINE_H_
 
+#include "../jsapi/fxjs_v8.h"
+
 typedef v8::Value                       JSValue;
 typedef v8::Handle<v8::Object>  JSObject;
 typedef v8::Handle<v8::Object>  JSFXObject;
 typedef unsigned                JSBool;
 
 #include "JS_Object.h"
 #include "JS_Value.h"
 
 struct JSConstSpec
 {
@@ skipping 10 matching lines @@
         v8::AccessorSetterCallback pPropPut;
 };
 
 struct JSMethodSpec
 {
         const wchar_t* pName;
         v8::FunctionCallback pMethodCall;
         unsigned nParamNum;
 };
 
-typedef CFX_WideString  JS_ErrorString;
-
 #define JS_TRUE                 (unsigned)1
 #define JS_FALSE                (unsigned)0
 
 typedef CFX_ArrayTemplate<float> CJS_PointsArray;
 typedef CFX_ArrayTemplate<int> CJS_IntArray;
 
+typedef CFX_WideString JS_ErrorString;
+
+namespace {

[Lei Zhang, 2015/02/28 02:50:49]

I don't think this stops anyone that includes JS_Define.h from calling
FormatErrorString().

[Tom Sepez, 2015/03/02 19:03:44]

Argh, yeah, I'm in a header.  I'll put this into the newly-added resource.cpp
file.

+
+CFX_WideString FormatErrorString(const char* class_name,
+                                 const char* property_name,
+                                 const CFX_WideString& details) {
+    CFX_WideString result = CFX_WideString::FromLocal(class_name);
+    if (property_name) {
+        result += L".";
+        result += CFX_WideString::FromLocal(property_name);
+    }
+    result += L": ";
+    result += details;
+    return result;
+}
+
+} // namespace
+
 /* ====================================== PUBLIC DEFINE SPEC ============================================== */
 #define JS_WIDESTRING(widestring) L###widestring
 
 #define BEGIN_JS_STATIC_CONST(js_class_name) JSConstSpec js_class_name::JS_Class_Consts[] = {
 #define JS_STATIC_CONST_ENTRY_NUMBER(const_name, pValue) {JS_WIDESTRING(const_name), pValue, L"", 0},
 #define JS_STATIC_CONST_ENTRY_STRING(const_name, pValue) {JS_WIDESTRING(const_name), 0, JS_WIDESTRING(pValue), 1},
 #define END_JS_STATIC_CONST() {0, 0, 0, 0}};
 
 #define BEGIN_JS_STATIC_PROP(js_class_name) JSPropertySpec js_class_name::JS_Class_Properties[] = {
 #define JS_STATIC_PROP_ENTRY(prop_name) {JS_WIDESTRING(prop_name), get_##prop_name##_static, set_##prop_name##_static},
 #define END_JS_STATIC_PROP() {0, 0, 0}};
 
 #define BEGIN_JS_STATIC_METHOD(js_class_name) JSMethodSpec js_class_name::JS_Class_Methods[] = {
 #define JS_STATIC_METHOD_ENTRY(method_name, nargs) {JS_WIDESTRING(method_name), method_name##_static, nargs},
 #define END_JS_STATIC_METHOD() {0, 0, 0}};
 
 /* ======================================== PROP CALLBACK ============================================ */
 
-template <class C, FX_BOOL (C::*M)(IFXJS_Context* cc, CJS_PropValue& vp, JS_ErrorString& sError)>
+template <class C, FX_BOOL (C::*M)(IFXJS_Context* cc, CJS_PropValue& vp, CFX_WideString& sError)>
 void JSPropGetter(const char* prop_name_string,
                   const char* class_name_string,
                   v8::Local<v8::String> property,
                   const v8::PropertyCallbackInfo<v8::Value>& info) {
   v8::Isolate* isolate = info.GetIsolate();
   v8::Local<v8::Context> context = isolate->GetCurrentContext();
   v8::Local<v8::Value> v = context->GetEmbedderData(1);
   v8::Handle<v8::External> field = v8::Handle<v8::External>::Cast(v);
   IFXJS_Runtime* pRuntime = (IFXJS_Runtime*)field->Value();
   IFXJS_Context* pContext = pRuntime->GetCurrentContext();
   CJS_Object* pJSObj = (CJS_Object*)JS_GetPrivate(isolate,info.Holder());
   C* pObj = reinterpret_cast<C*>(pJSObj->GetEmbedObject());
-  JS_ErrorString sError;
+  CFX_WideString sError;
   CJS_PropValue value(isolate);
   value.StartGetting();
   if (!(pObj->*M)(pContext, value, sError)) {
-    CFX_ByteString cbName;
-    cbName.Format("%s.%s", class_name_string, prop_name_string);
-    JS_Error(NULL, CFX_WideString::FromLocal(cbName), sError);
+    JS_Error(isolate, FormatErrorString(class_name_string, prop_name_string, sError));
     return;
   }
   info.GetReturnValue().Set((v8::Handle<v8::Value>)value);
 }
 
-template <class C, FX_BOOL (C::*M)(IFXJS_Context* cc, CJS_PropValue& vp, JS_ErrorString& sError)>
+template <class C, FX_BOOL (C::*M)(IFXJS_Context* cc, CJS_PropValue& vp, CFX_WideString& sError)>
 void JSPropSetter(const char* prop_name_string,
                   const char* class_name_string,
                   v8::Local<v8::String> property,
                   v8::Local<v8::Value> value,
                   const v8::PropertyCallbackInfo<void>& info) {
   v8::Isolate* isolate = info.GetIsolate();
   v8::Local<v8::Context> context = isolate->GetCurrentContext();
   v8::Local<v8::Value> v = context->GetEmbedderData(1);
   v8::Handle<v8::External> field = v8::Handle<v8::External>::Cast(v);
   IFXJS_Runtime* pRuntime = (IFXJS_Runtime*)field->Value();
   IFXJS_Context* pContext = pRuntime->GetCurrentContext();
   CJS_Object* pJSObj = (CJS_Object*)JS_GetPrivate(isolate,info.Holder());
   C* pObj = reinterpret_cast<C*>(pJSObj->GetEmbedObject());
-  JS_ErrorString sError;
+  CFX_WideString sError;
   CJS_PropValue propValue(CJS_Value(isolate, value, VT_unknown));
   propValue.StartSetting();
   if (!(pObj->*M)(pContext, propValue, sError)) {
-    CFX_ByteString cbName;
-    cbName.Format("%s.%s", class_name_string, prop_name_string);
-    JS_Error(NULL, CFX_WideString::FromLocal(cbName), sError);
+      JS_Error(isolate, FormatErrorString(class_name_string, prop_name_string, sError));
   }
 }
 
 #define JS_STATIC_PROP(prop_name, class_name) \
   static void get_##prop_name##_static( \
       v8::Local<v8::String> property, \
       const v8::PropertyCallbackInfo<v8::Value>& info) { \
     JSPropGetter<class_name, &class_name::prop_name>( \
         #prop_name, #class_name, property, info); \
   } \
   static void set_##prop_name##_static( \
       v8::Local<v8::String> property, \
       v8::Local<v8::Value> value, \
       const v8::PropertyCallbackInfo<void>& info) { \
     JSPropSetter<class_name, &class_name::prop_name>( \
         #prop_name, #class_name, property, value, info); \
   }
 
 /* ========================================= METHOD CALLBACK =========================================== */
 
-template <class C, FX_BOOL (C::*M)(IFXJS_Context* cc, const CJS_Parameters& params, CJS_Value& vRet, JS_ErrorString& sError)>
+template <class C, FX_BOOL (C::*M)(IFXJS_Context* cc, const CJS_Parameters& params, CJS_Value& vRet, CFX_WideString& sError)>
 void JSMethod(const char* method_name_string,
               const char* class_name_string,
               const v8::FunctionCallbackInfo<v8::Value>& info) {
   v8::Isolate* isolate = info.GetIsolate();
   v8::Local<v8::Context> context = isolate->GetCurrentContext();
   v8::Local<v8::Value> v = context->GetEmbedderData(1);
   v8::Handle<v8::External> field = v8::Handle<v8::External>::Cast(v);
   IFXJS_Runtime* pRuntime = (IFXJS_Runtime*)field->Value();
   IFXJS_Context* cc = pRuntime->GetCurrentContext();
   CJS_Parameters parameters;
   for (unsigned int i = 0; i<(unsigned int)info.Length(); i++) {
     parameters.push_back(CJS_Value(isolate, info[i], VT_unknown));
   }
   CJS_Value valueRes(isolate);
   CJS_Object* pJSObj = (CJS_Object *)JS_GetPrivate(isolate,info.Holder());
   C* pObj = reinterpret_cast<C*>(pJSObj->GetEmbedObject());
-  JS_ErrorString sError;
+  CFX_WideString sError;
   if (!(pObj->*M)(cc, parameters, valueRes, sError)) {
-    CFX_ByteString cbName;
-    cbName.Format("%s.%s", class_name_string, method_name_string);
-    JS_Error(NULL, CFX_WideString::FromLocal(cbName), sError);
+      JS_Error(isolate, FormatErrorString(class_name_string, method_name_string, sError));
     return;
   }
   info.GetReturnValue().Set(valueRes.ToJSValue());
 }
 
 #define JS_STATIC_METHOD(method_name, class_name) \
   static void method_name##_static( \
       const v8::FunctionCallbackInfo<v8::Value>& info) {    \
     JSMethod<class_name, &class_name::method_name>( \
-        #class_name, #method_name, info); \
+        #method_name, #class_name, 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>( \
-        #class_name, #method_name, info); \
+        #method_name, #class_name, info); \
   }
 
 /* ===================================== JS CLASS =============================================== */
 
 #define DECLARE_JS_CLASS(js_class_name) \
         static JSBool JSConstructor(IFXJS_Context* cc, JSFXObject obj,JSFXObject global);\
         static JSBool JSDestructor(JSFXObject obj);\
         static int Init(IJS_Runtime* pRuntime, FXJSOBJTYPE eObjType);\
         static JSConstSpec JS_Class_Consts[];\
         static JSPropertySpec JS_Class_Properties[];\
@@ skipping 90 matching lines @@
   v8::Isolate* isolate = info.GetIsolate();
   v8::Local<v8::Context> context = isolate->GetCurrentContext();
   v8::Local<v8::Value> v = context->GetEmbedderData(1);
   v8::Handle<v8::External> field = v8::Handle<v8::External>::Cast(v);
   IFXJS_Runtime* pRuntime = (IFXJS_Runtime*)field->Value();
   IFXJS_Context* pRuntimeContext = pRuntime->GetCurrentContext();
   CJS_Object* pJSObj = reinterpret_cast<CJS_Object*>(JS_GetPrivate(isolate, info.Holder()));
   Alt* pObj = reinterpret_cast<Alt*>(pJSObj->GetEmbedObject());
   v8::String::Utf8Value utf8_value(property);
   CFX_WideString propname = CFX_WideString::FromUTF8(*utf8_value, utf8_value.length());
-  JS_ErrorString sError;
+  CFX_WideString sError;
   CJS_PropValue value(isolate);
   value.StartGetting();
   if (!pObj->DoProperty(pRuntimeContext, propname.c_str(), value, sError)) {
-    CFX_ByteString cbName;
-    cbName.Format("%s.%s", class_name, L"GetProperty");
-    JS_Error(NULL,CFX_WideString::FromLocal(cbName), sError);
-    return;
+      JS_Error(isolate, FormatErrorString(class_name, "GetProperty", sError));
+      return;
   }
   info.GetReturnValue().Set((v8::Handle<v8::Value>)value);
 }
 
 template <class Alt>
 void JSSpecialPropPut(const char* class_name,
                       v8::Local<v8::String> property,
                       v8::Local<v8::Value> value,
                       const v8::PropertyCallbackInfo<v8::Value>& info) {
   v8::Isolate* isolate = info.GetIsolate();
   v8::Local<v8::Context> context = isolate->GetCurrentContext();
   v8::Local<v8::Value> v = context->GetEmbedderData(1);
   v8::Handle<v8::External> field = v8::Handle<v8::External>::Cast(v);
   IFXJS_Runtime* pRuntime = (IFXJS_Runtime*)field->Value();
   IFXJS_Context* pRuntimeContext = pRuntime->GetCurrentContext();
   CJS_Object* pJSObj = reinterpret_cast<CJS_Object*>(JS_GetPrivate(isolate, info.Holder()));
   Alt* pObj = reinterpret_cast<Alt*>(pJSObj->GetEmbedObject());
   v8::String::Utf8Value utf8_value(property);
   CFX_WideString propname = CFX_WideString::FromUTF8(*utf8_value, utf8_value.length());
-  JS_ErrorString sError;
+  CFX_WideString sError;
   CJS_PropValue PropValue(CJS_Value(isolate,value,VT_unknown));
   PropValue.StartSetting();
   if (!pObj->DoProperty(pRuntimeContext, propname.c_str(), PropValue, sError)) {
-    CFX_ByteString cbName;
-    cbName.Format("%s.%s", class_name, "PutProperty");
-    JS_Error(NULL,CFX_WideString::FromLocal(cbName), sError);
+      JS_Error(isolate, FormatErrorString(class_name, "PutProperty", sError));
   }
 }
 
 template <class Alt>
 void JSSpecialPropDel(const char* class_name,
                       v8::Local<v8::String> property,
                       const v8::PropertyCallbackInfo<v8::Boolean>& info) {
   v8::Isolate* isolate = info.GetIsolate();
   v8::Local<v8::Context> context = isolate->GetCurrentContext();
   v8::Local<v8::Value> v = context->GetEmbedderData(1);
   v8::Handle<v8::External> field = v8::Handle<v8::External>::Cast(v);
   IFXJS_Runtime* pRuntime = (IFXJS_Runtime*)field->Value();
   IFXJS_Context* pRuntimeContext = pRuntime->GetCurrentContext();
   CJS_Object* pJSObj = reinterpret_cast<CJS_Object*>(JS_GetPrivate(isolate, info.Holder()));
   Alt* pObj = reinterpret_cast<Alt*>(pJSObj->GetEmbedObject());
   v8::String::Utf8Value utf8_value(property);
   CFX_WideString propname = CFX_WideString::FromUTF8(*utf8_value, utf8_value.length());
-  JS_ErrorString sError;
+  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 JS_Error().
   }
 }
 
 #define DECLARE_SPECIAL_JS_CLASS(js_class_name) \
         static JSBool JSConstructor(IFXJS_Context* cc, JSFXObject obj, JSFXObject global);\
         static JSBool JSDestructor(JSFXObject obj);\
@@ skipping 58 matching lines @@
                 if (JS_DefineObjAllProperties(pRuntime, 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)<0) return -1;\
 \
                 return nObjDefnID;\
         }\
 \
         return -1;\
 }
 
 /* ======================================== GLOBAL METHODS ============================================ */
 
-template <FX_BOOL (*F)(IFXJS_Context* cc, const CJS_Parameters& params, CJS_Value& vRet, JS_ErrorString& sError)>
+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) {
+                  const v8::FunctionCallbackInfo<v8::Value>& info) {
   v8::Isolate* isolate = info.GetIsolate();
   v8::Local<v8::Context> context = isolate->GetCurrentContext();
   v8::Local<v8::Value> v = context->GetEmbedderData(1);
   v8::Handle<v8::External> field = v8::Handle<v8::External>::Cast(v);
   IFXJS_Runtime* pRuntime = (IFXJS_Runtime*)field->Value();
   IFXJS_Context* cc = pRuntime->GetCurrentContext();
   CJS_Parameters parameters;
   for (unsigned int i = 0; i<(unsigned int)info.Length(); i++) {
     parameters.push_back(CJS_Value(isolate, info[i], VT_unknown));
   }
   CJS_Value valueRes(isolate);
-  JS_ErrorString sError;
+  CFX_WideString sError;
   if (!(*F)(cc, parameters, valueRes, sError))
   {
-    JS_Error(NULL, JS_WIDESTRING(fun_name), sError);
+      JS_Error(isolate, FormatErrorString(func_name_string, nullptr, sError));
     return;
   }
   info.GetReturnValue().Set(valueRes.ToJSValue());
 }
 
 #define JS_STATIC_GLOBAL_FUN(fun_name) \
   static void fun_name##_static(const v8::FunctionCallbackInfo<v8::Value>& info) { \
     JSGlobalFunc<fun_name>(#fun_name, info); \
   }
 
@@ skipping 47 matching lines @@
 #define VALUE_NAME_BOOLEAN              L"boolean"
 #define VALUE_NAME_DATE                 L"date"
 #define VALUE_NAME_OBJECT               L"object"
 #define VALUE_NAME_FXOBJ                L"fxobj"
 #define VALUE_NAME_NULL                 L"null"
 #define VALUE_NAME_UNDEFINED    L"undefined"
 
 FXJSVALUETYPE GET_VALUE_TYPE(v8::Handle<v8::Value> p);
 
 #endif //_JS_DEFINE_H_