blob: b2a7ca9cf84cbf0a1618b46d05d7c76daef6dae2 [file] [log] [blame]
// Copyright 2017 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 FXJS_XFA_CJX_OBJECT_H_
#define FXJS_XFA_CJX_OBJECT_H_
#include <map>
#include <memory>
#include <utility>
#include <vector>
#include "core/fxcrt/widestring.h"
#include "fxjs/gc/heap.h"
#include "fxjs/xfa/fxjse.h"
#include "fxjs/xfa/jse_define.h"
#include "third_party/base/optional.h"
#include "third_party/base/span.h"
#include "v8/include/cppgc/garbage-collected.h"
#include "v8/include/cppgc/member.h"
#include "xfa/fxfa/fxfa_basic.h"
class CFXJSE_MapModule;
class CFXJSE_Value;
class CFX_V8;
class CFX_XMLElement;
class CJX_Object;
class CXFA_Document;
class CXFA_LayoutItem;
class CXFA_Measurement;
class CXFA_Node;
class CXFA_Object;
typedef CJS_Result (*CJX_MethodCall)(
CJX_Object* obj,
CFX_V8* runtime,
const std::vector<v8::Local<v8::Value>>& params);
struct CJX_MethodSpec {
const char* pName;
CJX_MethodCall pMethodCall;
};
enum XFA_SOM_MESSAGETYPE {
XFA_SOM_ValidationMessage,
XFA_SOM_FormatMessage,
XFA_SOM_MandatoryMessage
};
class CJX_Object : public cppgc::GarbageCollected<CJX_Object>,
public CFXJSE_HostObject {
public:
// Corresponds 1:1 with CJX_ subclasses.
enum class TypeTag {
Boolean,
Container,
DataWindow,
Delta,
Desc,
Draw,
Encrypt,
EventPseudoModel,
ExclGroup,
Extras,
Field,
Form,
Handler,
HostPseudoModel,
InstanceManager,
LayoutPseudoModel,
List,
LogPseudoModel,
Manifest,
Model,
Node,
Object,
Occur,
Packet,
Script,
SignaturePesudoModel,
Source,
Subform,
SubformSet,
Template,
TextNode,
Tree,
TreeList,
WsdlConnection,
Xfa,
};
class CalcData : public cppgc::GarbageCollected<CalcData> {
public:
CONSTRUCT_VIA_MAKE_GARBAGE_COLLECTED;
~CalcData();
void Trace(cppgc::Visitor* visitor) const;
std::vector<cppgc::Member<CXFA_Node>> m_Globals;
private:
CalcData();
};
CONSTRUCT_VIA_MAKE_GARBAGE_COLLECTED;
~CJX_Object() override;
// CFXJSE_HostObject:
CJX_Object* AsCJXObject() override;
virtual void Trace(cppgc::Visitor* visitor) const;
virtual bool DynamicTypeIs(TypeTag eType) const;
JSE_PROP(className);
CXFA_Document* GetDocument() const;
CXFA_Node* GetXFANode() const;
CXFA_Object* GetXFAObject() const { return object_.Get(); }
void SetCalcRecursionCount(size_t count) { calc_recursion_count_ = count; }
size_t GetCalcRecursionCount() const { return calc_recursion_count_; }
void SetLayoutItem(CXFA_LayoutItem* item) { layout_item_ = item; }
CXFA_LayoutItem* GetLayoutItem() const { return layout_item_; }
bool HasMethod(const WideString& func) const;
CJS_Result RunMethod(const WideString& func,
const std::vector<v8::Local<v8::Value>>& params);
bool HasAttribute(XFA_Attribute eAttr);
void SetAttributeByEnum(XFA_Attribute eAttr,
const WideString& wsValue,
bool bNotify);
void SetAttributeByString(WideStringView wsAttr, const WideString& wsValue);
void RemoveAttribute(WideStringView wsAttr);
WideString GetAttributeByString(WideStringView attr);
WideString GetAttributeByEnum(XFA_Attribute attr);
Optional<WideString> TryAttribute(XFA_Attribute eAttr, bool bUseDefault);
Optional<WideString> TryContent(bool bScriptModify, bool bProto);
void SetContent(const WideString& wsContent,
const WideString& wsXMLValue,
bool bNotify,
bool bScriptModify,
bool bSyncData);
WideString GetContent(bool bScriptModify);
template <typename T>
T* GetProperty(int32_t index, XFA_Element eType) const {
CXFA_Node* node;
int32_t count;
std::tie(node, count) = GetPropertyInternal(index, eType);
return static_cast<T*>(node);
}
template <typename T>
T* GetOrCreateProperty(int32_t index, XFA_Element eType) {
return static_cast<T*>(GetOrCreatePropertyInternal(index, eType));
}
void SetAttributeValue(const WideString& wsValue,
const WideString& wsXMLValue);
// Not actual properties, but invoked as property handlers to cover
// a broad range of underlying properties.
JSE_PROP(ScriptAttributeString);
JSE_PROP(ScriptAttributeBool);
JSE_PROP(ScriptAttributeInteger);
JSE_PROP(ScriptSomFontColor);
JSE_PROP(ScriptSomFillColor);
JSE_PROP(ScriptSomBorderColor);
JSE_PROP(ScriptSomBorderWidth);
JSE_PROP(ScriptSomValidationMessage);
JSE_PROP(ScriptSomMandatoryMessage);
JSE_PROP(ScriptSomDefaultValue);
JSE_PROP(ScriptSomDefaultValue_Read);
JSE_PROP(ScriptSomDataNode);
JSE_PROP(ScriptSomMandatory);
JSE_PROP(ScriptSomInstanceIndex);
JSE_PROP(ScriptSubmitFormatMode);
void ScriptSomMessage(v8::Isolate* pIsolate,
v8::Local<v8::Value>* pValue,
bool bSetting,
XFA_SOM_MESSAGETYPE iMessageType);
Optional<WideString> TryNamespace();
Optional<int32_t> TryInteger(XFA_Attribute eAttr, bool bUseDefault) const;
void SetInteger(XFA_Attribute eAttr, int32_t iValue, bool bNotify);
int32_t GetInteger(XFA_Attribute eAttr) const;
Optional<WideString> TryCData(XFA_Attribute eAttr, bool bUseDefault) const;
void SetCData(XFA_Attribute eAttr, const WideString& wsValue);
WideString GetCData(XFA_Attribute eAttr) const;
Optional<XFA_AttributeValue> TryEnum(XFA_Attribute eAttr,
bool bUseDefault) const;
void SetEnum(XFA_Attribute eAttr, XFA_AttributeValue eValue, bool bNotify);
XFA_AttributeValue GetEnum(XFA_Attribute eAttr) const;
Optional<bool> TryBoolean(XFA_Attribute eAttr, bool bUseDefault);
void SetBoolean(XFA_Attribute eAttr, bool bValue, bool bNotify);
bool GetBoolean(XFA_Attribute eAttr);
Optional<CXFA_Measurement> TryMeasure(XFA_Attribute eAttr,
bool bUseDefault) const;
Optional<float> TryMeasureAsFloat(XFA_Attribute attr) const;
void SetMeasure(XFA_Attribute eAttr,
const CXFA_Measurement& mValue,
bool bNotify);
CXFA_Measurement GetMeasure(XFA_Attribute eAttr) const;
float GetMeasureInUnit(XFA_Attribute eAttr, XFA_Unit unit) const;
void MergeAllData(CXFA_Object* pDstObj);
CalcData* GetCalcData() const { return calc_data_; }
CalcData* GetOrCreateCalcData(cppgc::Heap* heap);
void TakeCalcDataFrom(CJX_Object* that);
void ThrowInvalidPropertyException() const;
void ThrowArgumentMismatchException() const;
void ThrowIndexOutOfBoundsException() const;
void ThrowParamCountMismatchException(const WideString& method) const;
void ThrowTooManyOccurancesException(const WideString& obj) const;
protected:
explicit CJX_Object(CXFA_Object* obj);
void SetAttributeValueImpl(const WideString& wsValue,
const WideString& wsXMLValue,
bool bNotify,
bool bScriptModify);
void SetCDataImpl(XFA_Attribute eAttr,
const WideString& wsValue,
bool bNotify,
bool bScriptModify);
void DefineMethods(pdfium::span<const CJX_MethodSpec> methods);
void MoveBufferMapData(CXFA_Object* pSrcObj, CXFA_Object* pDstObj);
void ThrowException(const WideString& str) const;
private:
using Type__ = CJX_Object;
static const TypeTag static_type__ = TypeTag::Object;
std::pair<CXFA_Node*, int32_t> GetPropertyInternal(int32_t index,
XFA_Element eType) const;
CXFA_Node* GetOrCreatePropertyInternal(int32_t index, XFA_Element eType);
void OnChanging(XFA_Attribute eAttr);
void OnChanged(XFA_Attribute eAttr, bool bScriptModify);
// Returns a pointer to the XML node that needs to be updated with the new
// attribute value. |nullptr| if no update is needed.
CFX_XMLElement* SetValue(XFA_Attribute eAttr, int32_t value, bool bNotify);
int32_t Subform_and_SubformSet_InstanceIndex();
CFXJSE_MapModule* CreateMapModule();
CFXJSE_MapModule* GetMapModule() const;
void SetMapModuleValue(uint32_t key, int32_t value);
void SetMapModuleString(uint32_t key, const WideString& wsValue);
void SetMapModuleMeasurement(uint32_t key, const CXFA_Measurement& value);
Optional<int32_t> GetMapModuleValue(uint32_t key) const;
Optional<WideString> GetMapModuleString(uint32_t key) const;
Optional<CXFA_Measurement> GetMapModuleMeasurement(uint32_t key) const;
Optional<int32_t> GetMapModuleValueFollowingChain(uint32_t key) const;
Optional<WideString> GetMapModuleStringFollowingChain(uint32_t key) const;
Optional<CXFA_Measurement> GetMapModuleMeasurementFollowingChain(
uint32_t key) const;
bool HasMapModuleKey(uint32_t key);
void RemoveMapModuleKey(uint32_t key);
void MoveBufferMapData(CXFA_Object* pDstObj);
cppgc::Member<CXFA_Object> object_;
cppgc::Member<CXFA_LayoutItem> layout_item_;
cppgc::Member<CalcData> calc_data_;
std::unique_ptr<CFXJSE_MapModule> map_module_;
std::map<ByteString, CJX_MethodCall> method_specs_;
size_t calc_recursion_count_ = 0;
};
#endif // FXJS_XFA_CJX_OBJECT_H_