Tidy up JS_Value.h

fpdfsdk/javascript/JS_Value.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_JAVASCRIPT_JS_VALUE_H_
 #define FPDFSDK_JAVASCRIPT_JS_VALUE_H_
 
 #include <vector>
@@ skipping 54 matching lines @@
   // Replace the current |m_pValue| with a v8::Number if possible
   // to make one from the current |m_pValue|.
   void MaybeCoerceToNumber();
 
   void operator=(int iValue);
   void operator=(bool bValue);
   void operator=(double val);
   void operator=(float val);
   void operator=(CJS_Object* val);
   void operator=(v8::Local<v8::Object> val);
-  void operator=(CJS_Array& val);
-  void operator=(CJS_Date& val);
+  void operator=(const CJS_Array& val);
+  void operator=(const CJS_Date& val);
+  void operator=(const CJS_Value& value);
+  void operator=(const FX_CHAR* pStr);
   void operator=(const FX_WCHAR* pWstr);
-  void operator=(const FX_CHAR* pStr);
-  void operator=(CJS_Value value);
 
   FX_BOOL IsArrayObject() const;
   FX_BOOL IsDateObject() const;
   FX_BOOL ConvertToArray(CJS_Array&) const;
   FX_BOOL ConvertToDate(CJS_Date&) const;
 
   CJS_Runtime* GetJSRuntime() const { return m_pJSRuntime; }
 
  protected:
   v8::Local<v8::Value> m_pValue;
-  CJS_Runtime* m_pJSRuntime;
+  CJS_Runtime* const m_pJSRuntime;
 };
 
 class CJS_PropValue : public CJS_Value {
  public:
+  explicit CJS_PropValue(CJS_Runtime* pRuntime);
   CJS_PropValue(const CJS_Value&);
-  CJS_PropValue(CJS_Runtime* pRuntime);
   ~CJS_PropValue();
 
-  FX_BOOL IsSetting() const { return m_bIsSetting; }
-  FX_BOOL IsGetting() const { return !m_bIsSetting; }
+  void StartSetting() { m_bIsSetting = true; }
+  void StartGetting() { m_bIsSetting = false; }
+  bool IsSetting() const { return m_bIsSetting; }
+  bool IsGetting() const { return !m_bIsSetting; }
 
   void operator<<(int val);
   void operator>>(int&) const;
   void operator<<(bool val);
   void operator>>(bool&) const;
   void operator<<(double val);
   void operator>>(double&) const;
   void operator<<(CJS_Object* pObj);
   void operator>>(CJS_Object*& ppObj) const;
   void operator<<(CJS_Document* pJsDoc);
   void operator>>(CJS_Document*& ppJsDoc) const;
   void operator<<(CFX_ByteString);
   void operator>>(CFX_ByteString&) const;
   void operator<<(CFX_WideString);
   void operator>>(CFX_WideString&) const;
   void operator<<(const FX_WCHAR* c_string);
   void operator<<(v8::Local<v8::Object>);
   void operator>>(v8::Local<v8::Object>&) const;
   void operator>>(CJS_Array& array) const;
   void operator<<(CJS_Array& array);
   void operator<<(CJS_Date& date);
   void operator>>(CJS_Date& date) const;
-  operator v8::Local<v8::Value>() const;
-  void StartSetting();
-  void StartGetting();
 
  private:
-  FX_BOOL m_bIsSetting;
+  bool m_bIsSetting;
 };
 
 class CJS_Array {
  public:
-  CJS_Array(CJS_Runtime* pRuntime);
+  explicit CJS_Array(CJS_Runtime* pRuntime);
+  CJS_Array(const CJS_Array& other);
   virtual ~CJS_Array();
-  CJS_Array(const CJS_Array& other);
 
   void Attach(v8::Local<v8::Array> pArray);
-  void GetElement(unsigned index, CJS_Value& value);
+  void GetElement(unsigned index, CJS_Value& value) const;
   void SetElement(unsigned index, CJS_Value value);
-  int GetLength();
-  FX_BOOL IsAttached();
-  operator v8::Local<v8::Array>();
+  int GetLength() const;
 
+  v8::Local<v8::Array> ToV8Array() const;
   CJS_Runtime* GetJSRuntime() const { return m_pJSRuntime; }
 
  private:
-  v8::Local<v8::Array> m_pArray;
-  CJS_Runtime* m_pJSRuntime;
+  mutable v8::Local<v8::Array> m_pArray;

[Tom Sepez, 2016/07/25 17:24:46]

Note: mutable because some const get operations may initialize this under the
covers.

+  CJS_Runtime* const m_pJSRuntime;
 };
 
 class CJS_Date {
-  friend class CJS_Value;
-
  public:
-  CJS_Date(CJS_Runtime* pRuntime);
+  explicit CJS_Date(CJS_Runtime* pRuntime);
   CJS_Date(CJS_Runtime* pRuntime, double dMsec_time);
   CJS_Date(CJS_Runtime* pRuntime,
            int year,
            int mon,
            int day,
            int hour,
            int min,
            int sec);
   virtual ~CJS_Date();
+
   void Attach(v8::Local<v8::Value> pDate);
+  bool IsValidDate() const;
 
-  int GetYear();
+  int GetYear() const;
   void SetYear(int iYear);
 
-  int GetMonth();
+  int GetMonth() const;
   void SetMonth(int iMonth);
 
-  int GetDay();
+  int GetDay() const;
   void SetDay(int iDay);
 
-  int GetHours();
+  int GetHours() const;
   void SetHours(int iHours);
 
-  int GetMinutes();
+  int GetMinutes() const;
   void SetMinutes(int minutes);
 
-  int GetSeconds();
+  int GetSeconds() const;
   void SetSeconds(int seconds);
 
-  operator v8::Local<v8::Value>();
-  operator double() const;
-
+  CJS_Runtime* GetJSRuntime() const { return m_pJSRuntime; }
+  v8::Local<v8::Value> ToV8Value() const { return m_pDate; }
+  double ToDouble() const;
   CFX_WideString ToString() const;
 
-  static double
-  MakeDate(int year, int mon, int mday, int hour, int min, int sec, int ms);
-
-  FX_BOOL IsValidDate();
-
  protected:
   v8::Local<v8::Value> m_pDate;
-  CJS_Runtime* m_pJSRuntime;
+  CJS_Runtime* const m_pJSRuntime;
 };
 
 double JS_GetDateTime();
 int JS_GetYearFromTime(double dt);
 int JS_GetMonthFromTime(double dt);
 int JS_GetDayFromTime(double dt);
 int JS_GetHourFromTime(double dt);
 int JS_GetMinFromTime(double dt);
 int JS_GetSecFromTime(double dt);
 double JS_DateParse(const CFX_WideString& str);
 double JS_MakeDay(int nYear, int nMonth, int nDay);
 double JS_MakeTime(int nHour, int nMin, int nSec, int nMs);
 double JS_MakeDate(double day, double time);
 bool JS_PortIsNan(double d);
 double JS_LocalTime(double d);
 
 // Some JS methods have the bizarre convention that they may also be called
 // with a single argument which is an object containing the actual arguments
 // as its properties. The varying arguments to this method are the property
 // names as wchar_t string literals corresponding to each positional argument.
 // The result will always contain |nKeywords| value, with unspecified ones
 // being set to type VT_unknown.
 std::vector<CJS_Value> JS_ExpandKeywordParams(
     CJS_Runtime* pRuntime,
     const std::vector<CJS_Value>& originals,
     size_t nKeywords,
     ...);
 
 #endif  // FPDFSDK_JAVASCRIPT_JS_VALUE_H_