1 // Copyright 2017 The PDFium Authors 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com 6 7 #ifndef FXJS_XFA_CJX_OBJECT_H_ 8 #define FXJS_XFA_CJX_OBJECT_H_ 9 10 #include <map> 11 #include <memory> 12 #include <vector> 13 14 #include "core/fxcrt/widestring.h" 15 #include "fxjs/gc/heap.h" 16 #include "fxjs/xfa/fxjse.h" 17 #include "fxjs/xfa/jse_define.h" 18 #include "third_party/abseil-cpp/absl/types/optional.h" 19 #include "third_party/base/containers/span.h" 20 #include "v8/include/cppgc/garbage-collected.h" 21 #include "v8/include/cppgc/member.h" 22 #include "v8/include/v8-forward.h" 23 #include "xfa/fxfa/fxfa_basic.h" 24 25 class CFXJSE_Engine; 26 class CFXJSE_MapModule; 27 class CFX_XMLElement; 28 class CJX_Object; 29 class CXFA_Document; 30 class CXFA_LayoutItem; 31 class CXFA_Measurement; 32 class CXFA_Node; 33 class CXFA_Object; 34 35 using CJX_MethodCall = 36 CJS_Result (*)(CJX_Object* obj, 37 CFXJSE_Engine* runtime, 38 const std::vector<v8::Local<v8::Value>>& params); 39 40 struct CJX_MethodSpec { 41 const char* pName; 42 CJX_MethodCall pMethodCall; 43 }; 44 45 class CJX_Object : public cppgc::GarbageCollected<CJX_Object>, 46 public CFXJSE_HostObject { 47 public: 48 // Corresponds 1:1 with CJX_ subclasses. 49 enum class TypeTag { 50 Boolean, 51 Container, 52 DataWindow, 53 Delta, 54 Desc, 55 Draw, 56 Encrypt, 57 EventPseudoModel, 58 ExclGroup, 59 Extras, 60 Field, 61 Form, 62 Handler, 63 HostPseudoModel, 64 InstanceManager, 65 LayoutPseudoModel, 66 List, 67 LogPseudoModel, 68 Manifest, 69 Model, 70 Node, 71 Object, 72 Occur, 73 Packet, 74 Script, 75 SignaturePesudoModel, 76 Source, 77 Subform, 78 SubformSet, 79 Template, 80 TextNode, 81 Tree, 82 TreeList, 83 WsdlConnection, 84 Xfa, 85 }; 86 87 class CalcData : public cppgc::GarbageCollected<CalcData> { 88 public: 89 CONSTRUCT_VIA_MAKE_GARBAGE_COLLECTED; 90 ~CalcData(); 91 92 void Trace(cppgc::Visitor* visitor) const; 93 94 std::vector<cppgc::Member<CXFA_Node>> m_Globals; 95 96 private: 97 CalcData(); 98 }; 99 100 CONSTRUCT_VIA_MAKE_GARBAGE_COLLECTED; 101 ~CJX_Object() override; 102 103 // CFXJSE_HostObject: 104 CJX_Object* AsCJXObject() override; 105 106 virtual void Trace(cppgc::Visitor* visitor) const; 107 virtual bool DynamicTypeIs(TypeTag eType) const; 108 109 JSE_PROP(className); 110 111 CXFA_Document* GetDocument() const; 112 CXFA_Node* GetXFANode() const; GetXFAObject()113 CXFA_Object* GetXFAObject() const { return object_; } 114 SetCalcRecursionCount(size_t count)115 void SetCalcRecursionCount(size_t count) { calc_recursion_count_ = count; } GetCalcRecursionCount()116 size_t GetCalcRecursionCount() const { return calc_recursion_count_; } 117 SetLayoutItem(CXFA_LayoutItem * item)118 void SetLayoutItem(CXFA_LayoutItem* item) { layout_item_ = item; } GetLayoutItem()119 CXFA_LayoutItem* GetLayoutItem() const { return layout_item_; } 120 121 bool HasMethod(const WideString& func) const; 122 CJS_Result RunMethod(CFXJSE_Engine* pScriptContext, 123 const WideString& func, 124 const std::vector<v8::Local<v8::Value>>& params); 125 126 bool HasAttribute(XFA_Attribute eAttr) const; 127 WideString GetAttributeByString(WideStringView attr) const; 128 WideString GetAttributeByEnum(XFA_Attribute attr) const; 129 absl::optional<WideString> TryAttribute(XFA_Attribute eAttr, 130 bool bUseDefault) const; 131 void SetAttributeByEnum(XFA_Attribute eAttr, 132 const WideString& wsValue, 133 bool bNotify); 134 void SetAttributeByString(WideStringView wsAttr, const WideString& wsValue); 135 void RemoveAttribute(WideStringView wsAttr); 136 137 WideString GetContent(bool bScriptModify) const; 138 absl::optional<WideString> TryContent(bool bScriptModify, bool bProto) const; 139 void SetContent(const WideString& wsContent, 140 const WideString& wsXMLValue, 141 bool bNotify, 142 bool bScriptModify, 143 bool bSyncData); 144 145 template <typename T> GetProperty(int32_t index,XFA_Element eType)146 T* GetProperty(int32_t index, XFA_Element eType) const { 147 return static_cast<T*>(GetPropertyInternal(index, eType)); 148 } 149 template <typename T> GetOrCreateProperty(int32_t index,XFA_Element eType)150 T* GetOrCreateProperty(int32_t index, XFA_Element eType) { 151 return static_cast<T*>(GetOrCreatePropertyInternal(index, eType)); 152 } 153 154 void SetAttributeValue(const WideString& wsValue, 155 const WideString& wsXMLValue); 156 157 // Not actual properties, but invoked as property handlers to cover 158 // a broad range of underlying properties. 159 JSE_PROP(ScriptAttributeString); 160 JSE_PROP(ScriptAttributeBool); 161 JSE_PROP(ScriptAttributeInteger); 162 JSE_PROP(ScriptSomFontColor); 163 JSE_PROP(ScriptSomFillColor); 164 JSE_PROP(ScriptSomBorderColor); 165 JSE_PROP(ScriptSomBorderWidth); 166 JSE_PROP(ScriptSomValidationMessage); 167 JSE_PROP(ScriptSomMandatoryMessage); 168 JSE_PROP(ScriptSomDefaultValue); 169 JSE_PROP(ScriptSomDefaultValue_Read); 170 JSE_PROP(ScriptSomDataNode); 171 JSE_PROP(ScriptSomMandatory); 172 JSE_PROP(ScriptSomInstanceIndex); 173 JSE_PROP(ScriptSubmitFormatMode); 174 175 absl::optional<WideString> TryNamespace() const; 176 177 int32_t GetInteger(XFA_Attribute eAttr) const; 178 absl::optional<int32_t> TryInteger(XFA_Attribute eAttr, 179 bool bUseDefault) const; 180 void SetInteger(XFA_Attribute eAttr, int32_t iValue, bool bNotify); 181 182 WideString GetCData(XFA_Attribute eAttr) const; 183 absl::optional<WideString> TryCData(XFA_Attribute eAttr, 184 bool bUseDefault) const; 185 void SetCData(XFA_Attribute eAttr, const WideString& wsValue); 186 187 XFA_AttributeValue GetEnum(XFA_Attribute eAttr) const; 188 absl::optional<XFA_AttributeValue> TryEnum(XFA_Attribute eAttr, 189 bool bUseDefault) const; 190 void SetEnum(XFA_Attribute eAttr, XFA_AttributeValue eValue, bool bNotify); 191 192 bool GetBoolean(XFA_Attribute eAttr) const; 193 absl::optional<bool> TryBoolean(XFA_Attribute eAttr, bool bUseDefault) const; 194 void SetBoolean(XFA_Attribute eAttr, bool bValue, bool bNotify); 195 196 CXFA_Measurement GetMeasure(XFA_Attribute eAttr) const; 197 float GetMeasureInUnit(XFA_Attribute eAttr, XFA_Unit unit) const; 198 absl::optional<CXFA_Measurement> TryMeasure(XFA_Attribute eAttr, 199 bool bUseDefault) const; 200 absl::optional<float> TryMeasureAsFloat(XFA_Attribute attr) const; 201 void SetMeasure(XFA_Attribute eAttr, 202 const CXFA_Measurement& mValue, 203 bool bNotify); 204 205 void MergeAllData(CXFA_Object* pDstObj); 206 GetCalcData()207 CalcData* GetCalcData() const { return calc_data_; } 208 CalcData* GetOrCreateCalcData(cppgc::Heap* heap); 209 void TakeCalcDataFrom(CJX_Object* that); 210 211 void ThrowInvalidPropertyException(v8::Isolate* pIsolate) const; 212 void ThrowArgumentMismatchException(v8::Isolate* pIsolate) const; 213 void ThrowIndexOutOfBoundsException(v8::Isolate* pIsolate) const; 214 void ThrowParamCountMismatchException(v8::Isolate* pIsolate, 215 const WideString& method) const; 216 void ThrowTooManyOccurrencesException(v8::Isolate* pIsolate, 217 const WideString& obj) const; 218 219 protected: 220 enum class SOMMessageType { 221 kValidationMessage, 222 kFormatMessage, 223 kMandatoryMessage 224 }; 225 226 explicit CJX_Object(CXFA_Object* obj); 227 228 void ScriptSomMessage(v8::Isolate* pIsolate, 229 v8::Local<v8::Value>* pValue, 230 bool bSetting, 231 SOMMessageType iMessageType); 232 void SetAttributeValueImpl(const WideString& wsValue, 233 const WideString& wsXMLValue, 234 bool bNotify, 235 bool bScriptModify); 236 void SetCDataImpl(XFA_Attribute eAttr, 237 const WideString& wsValue, 238 bool bNotify, 239 bool bScriptModify); 240 void DefineMethods(pdfium::span<const CJX_MethodSpec> methods); 241 void MoveBufferMapData(CXFA_Object* pSrcObj, CXFA_Object* pDstObj); 242 void ThrowException(v8::Isolate* pIsolate, const WideString& str) const; 243 244 private: 245 using Type__ = CJX_Object; 246 static const TypeTag static_type__ = TypeTag::Object; 247 248 CXFA_Node* GetPropertyInternal(int32_t index, XFA_Element eType) const; 249 CXFA_Node* GetOrCreatePropertyInternal(int32_t index, XFA_Element eType); 250 251 void OnChanging(XFA_Attribute eAttr); 252 void OnChanged(XFA_Attribute eAttr, bool bScriptModify); 253 254 // Returns a pointer to the XML node that needs to be updated with the new 255 // attribute value. |nullptr| if no update is needed. 256 CFX_XMLElement* SetValue(XFA_Attribute eAttr, int32_t value, bool bNotify); 257 int32_t Subform_and_SubformSet_InstanceIndex(); 258 259 CFXJSE_MapModule* CreateMapModule(); 260 CFXJSE_MapModule* GetMapModule() const; 261 void SetMapModuleValue(uint32_t key, int32_t value); 262 void SetMapModuleString(uint32_t key, const WideString& wsValue); 263 void SetMapModuleMeasurement(uint32_t key, const CXFA_Measurement& value); 264 absl::optional<int32_t> GetMapModuleValue(uint32_t key) const; 265 absl::optional<WideString> GetMapModuleString(uint32_t key) const; 266 absl::optional<CXFA_Measurement> GetMapModuleMeasurement(uint32_t key) const; 267 absl::optional<int32_t> GetMapModuleValueFollowingChain(uint32_t key) const; 268 absl::optional<WideString> GetMapModuleStringFollowingChain( 269 uint32_t key) const; 270 absl::optional<CXFA_Measurement> GetMapModuleMeasurementFollowingChain( 271 uint32_t key) const; 272 bool HasMapModuleKey(uint32_t key) const; 273 void RemoveMapModuleKey(uint32_t key); 274 void MoveBufferMapData(CXFA_Object* pDstObj); 275 276 cppgc::Member<CXFA_Object> object_; 277 cppgc::Member<CXFA_LayoutItem> layout_item_; 278 cppgc::Member<CalcData> calc_data_; 279 std::unique_ptr<CFXJSE_MapModule> map_module_; 280 std::map<ByteString, CJX_MethodCall> method_specs_; 281 size_t calc_recursion_count_ = 0; 282 }; 283 284 #endif // FXJS_XFA_CJX_OBJECT_H_ 285