// 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 XFA_FXFA_PARSER_CXFA_NODE_H_ #define XFA_FXFA_PARSER_CXFA_NODE_H_ #include #include #include "core/fxcrt/fx_string.h" #include "fxjs/cjx_node.h" #include "xfa/fxfa/parser/cxfa_object.h" class CFX_XMLNode; class CFXJSE_Argument; class CXFA_WidgetData; #define XFA_NODEFILTER_Children 0x01 #define XFA_NODEFILTER_Properties 0x02 #define XFA_NODEFILTER_OneOfProperty 0x04 enum XFA_NodeFlag { XFA_NodeFlag_None = 0, XFA_NodeFlag_Initialized = 1 << 0, XFA_NodeFlag_HasRemovedChildren = 1 << 1, XFA_NodeFlag_NeedsInitApp = 1 << 2, XFA_NodeFlag_BindFormItems = 1 << 3, XFA_NodeFlag_UserInteractive = 1 << 4, XFA_NodeFlag_SkipDataBinding = 1 << 5, XFA_NodeFlag_OwnXMLNode = 1 << 6, XFA_NodeFlag_UnusedNode = 1 << 7, XFA_NodeFlag_LayoutGeneratedNode = 1 << 8 }; enum XFA_NODEITEM { XFA_NODEITEM_Parent, XFA_NODEITEM_FirstChild, XFA_NODEITEM_NextSibling, XFA_NODEITEM_PrevSibling, }; const XFA_ATTRIBUTEENUMINFO* GetAttributeEnumByID(XFA_ATTRIBUTEENUM eName); class CXFA_Node : public CXFA_Object { public: ~CXFA_Node() override; uint32_t GetPacketID() const { return m_ePacket; } void SetFlag(uint32_t dwFlag, bool bNotify); void ClearFlag(uint32_t dwFlag); CJX_Node* JSNode() { return static_cast(JSObject()); } const CJX_Node* JSNode() const { return static_cast(JSObject()); } CXFA_Node* GetParent() { return m_pParent; } CXFA_Node* GetChildNode() { return m_pChild; } CXFA_Node* CreateInstance(CXFA_Node* pInstMgrNode, bool bDataMerge); int32_t GetCount(CXFA_Node* pInstMgrNode); CXFA_Node* GetItem(CXFA_Node* pInstMgrNode, int32_t iIndex); void RemoveItem(CXFA_Node* pInstMgrNode, CXFA_Node* pRemoveInstance, bool bRemoveDataBinding = true); void InsertItem(CXFA_Node* pInstMgrNode, CXFA_Node* pNewInstance, int32_t iPos, int32_t iCount = -1, bool bMoveDataBindingNodes = true); bool IsInitialized() const { return HasFlag(XFA_NodeFlag_Initialized); } bool IsOwnXMLNode() const { return HasFlag(XFA_NodeFlag_OwnXMLNode); } bool IsUserInteractive() const { return HasFlag(XFA_NodeFlag_UserInteractive); } bool IsUnusedNode() const { return HasFlag(XFA_NodeFlag_UnusedNode); } bool IsLayoutGeneratedNode() const { return HasFlag(XFA_NodeFlag_LayoutGeneratedNode); } bool BindsFormItems() const { return HasFlag(XFA_NodeFlag_BindFormItems); } bool HasRemovedChildren() const { return HasFlag(XFA_NodeFlag_HasRemovedChildren); } bool NeedsInitApp() const { return HasFlag(XFA_NodeFlag_NeedsInitApp); } bool IsAttributeInXML(); bool IsFormContainer() const { return m_ePacket == XFA_XDPPACKET_Form && IsContainerNode(); } void SetXMLMappingNode(CFX_XMLNode* pXMLNode) { m_pXMLNode = pXMLNode; } CFX_XMLNode* GetXMLMappingNode() const { return m_pXMLNode; } CFX_XMLNode* CreateXMLMappingNode(); bool IsNeedSavingXMLNode(); uint32_t GetNameHash() const { return m_dwNameHash; } bool IsUnnamed() const { return m_dwNameHash == 0; } CXFA_Node* GetModelNode(); void UpdateNameHash(); int32_t CountChildren(XFA_Element eType, bool bOnlyChild = false); CXFA_Node* GetChild(int32_t index, XFA_Element eType, bool bOnlyChild = false); int32_t InsertChild(int32_t index, CXFA_Node* pNode); bool InsertChild(CXFA_Node* pNode, CXFA_Node* pBeforeNode = nullptr); bool RemoveChild(CXFA_Node* pNode, bool bNotify = true); CXFA_Node* Clone(bool bRecursive); CXFA_Node* GetNodeItem(XFA_NODEITEM eItem) const; CXFA_Node* GetNodeItem(XFA_NODEITEM eItem, XFA_ObjectType eType) const; std::vector GetNodeList( uint32_t dwTypeFilter = XFA_NODEFILTER_Children | XFA_NODEFILTER_Properties, XFA_Element eTypeFilter = XFA_Element::Unknown); CXFA_Node* CreateSamePacketNode(XFA_Element eType, uint32_t dwFlags = XFA_NodeFlag_Initialized); CXFA_Node* CloneTemplateToForm(bool bRecursive); CXFA_Node* GetTemplateNode() const; void SetTemplateNode(CXFA_Node* pTemplateNode); CXFA_Node* GetDataDescriptionNode(); void SetDataDescriptionNode(CXFA_Node* pDataDescriptionNode); CXFA_Node* GetBindData(); std::vector GetBindItems(); int32_t AddBindItem(CXFA_Node* pFormNode); int32_t RemoveBindItem(CXFA_Node* pFormNode); bool HasBindItem(); CXFA_WidgetData* GetWidgetData(); CXFA_WidgetData* GetContainerWidgetData(); bool GetLocaleName(WideString& wsLocaleName); XFA_ATTRIBUTEENUM GetIntact(); CXFA_Node* GetFirstChildByName(const WideStringView& wsNodeName) const; CXFA_Node* GetFirstChildByName(uint32_t dwNodeNameHash) const; CXFA_Node* GetFirstChildByClass(XFA_Element eType) const; CXFA_Node* GetNextSameNameSibling(uint32_t dwNodeNameHash) const; CXFA_Node* GetNextSameNameSibling(const WideStringView& wsNodeName) const; CXFA_Node* GetNextSameClassSibling(XFA_Element eType) const; int32_t GetNodeSameNameIndex() const; int32_t GetNodeSameClassIndex() const; void GetSOMExpression(WideString& wsSOMExpression); CXFA_Node* GetInstanceMgrOfSubform(); CXFA_Node* GetOccurNode(); void OnChanged(XFA_ATTRIBUTE eAttr, bool bNotify, bool bScriptModify); void OnChanging(XFA_ATTRIBUTE eAttr, bool bNotify); void Script_TreeClass_ResolveNode(CFXJSE_Arguments* pArguments); void Script_TreeClass_ResolveNodes(CFXJSE_Arguments* pArguments); void Script_Som_ResolveNodeList(CFXJSE_Value* pValue, WideString wsExpression, uint32_t dwFlag, CXFA_Node* refNode = nullptr); void Script_TreeClass_All(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_TreeClass_Nodes(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_TreeClass_ClassAll(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_TreeClass_Parent(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_TreeClass_Index(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_TreeClass_ClassIndex(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_TreeClass_SomExpression(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_NodeClass_ApplyXSL(CFXJSE_Arguments* pArguments); void Script_NodeClass_AssignNode(CFXJSE_Arguments* pArguments); void Script_NodeClass_Clone(CFXJSE_Arguments* pArguments); void Script_NodeClass_GetAttribute(CFXJSE_Arguments* pArguments); void Script_NodeClass_GetElement(CFXJSE_Arguments* pArguments); void Script_NodeClass_IsPropertySpecified(CFXJSE_Arguments* pArguments); void Script_NodeClass_LoadXML(CFXJSE_Arguments* pArguments); void Script_NodeClass_SaveFilteredXML(CFXJSE_Arguments* pArguments); void Script_NodeClass_SaveXML(CFXJSE_Arguments* pArguments); void Script_NodeClass_SetAttribute(CFXJSE_Arguments* pArguments); void Script_NodeClass_SetElement(CFXJSE_Arguments* pArguments); void Script_NodeClass_Ns(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_NodeClass_Model(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_NodeClass_IsContainer(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_NodeClass_IsNull(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_NodeClass_OneOfChild(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_ContainerClass_GetDelta(CFXJSE_Arguments* pArguments); void Script_ContainerClass_GetDeltas(CFXJSE_Arguments* pArguments); void Script_ModelClass_ClearErrorList(CFXJSE_Arguments* pArguments); void Script_ModelClass_CreateNode(CFXJSE_Arguments* pArguments); void Script_ModelClass_IsCompatibleNS(CFXJSE_Arguments* pArguments); void Script_ModelClass_Context(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_ModelClass_AliasNode(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_WsdlConnection_Execute(CFXJSE_Arguments* pArguments); void Script_Delta_Restore(CFXJSE_Arguments* pArguments); void Script_Delta_CurrentValue(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Delta_SavedValue(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Delta_Target(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Attribute_SendAttributeChangeMessage(XFA_ATTRIBUTE eAttribute, bool bScriptModify); void Script_Attribute_Integer(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Attribute_IntegerRead(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Attribute_BOOL(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Attribute_BOOLRead(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Attribute_String(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Attribute_StringRead(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_ValidationMessage(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Field_Length(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_DefaultValue(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_DefaultValue_Read(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Boolean_Value(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_Message(CFXJSE_Value* pValue, bool bSetting, XFA_SOM_MESSAGETYPE iMessageType); void Script_Som_BorderColor(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_BorderWidth(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_FillColor(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_DataNode(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_FontColor(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_Mandatory(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_MandatoryMessage(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Som_InstanceIndex(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Draw_DefaultValue(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Field_DefaultValue(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Field_EditValue(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Field_FormatMessage(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Field_FormattedValue(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Field_ParentSubform(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Field_SelectedIndex(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Field_ClearItems(CFXJSE_Arguments* pArguments); void Script_Field_ExecEvent(CFXJSE_Arguments* pArguments); void Script_Field_ExecInitialize(CFXJSE_Arguments* pArguments); void Script_Field_DeleteItem(CFXJSE_Arguments* pArguments); void Script_Field_GetSaveItem(CFXJSE_Arguments* pArguments); void Script_Field_BoundItem(CFXJSE_Arguments* pArguments); void Script_Field_GetItemState(CFXJSE_Arguments* pArguments); void Script_Field_ExecCalculate(CFXJSE_Arguments* pArguments); void Script_Field_SetItems(CFXJSE_Arguments* pArguments); void Script_Field_GetDisplayItem(CFXJSE_Arguments* pArguments); void Script_Field_SetItemState(CFXJSE_Arguments* pArguments); void Script_Field_AddItem(CFXJSE_Arguments* pArguments); void Script_Field_ExecValidate(CFXJSE_Arguments* pArguments); void Script_ExclGroup_DefaultAndRawValue(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_ExclGroup_ErrorText(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_ExclGroup_Transient(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_ExclGroup_ExecEvent(CFXJSE_Arguments* pArguments); void Script_ExclGroup_SelectedMember(CFXJSE_Arguments* pArguments); void Script_ExclGroup_ExecInitialize(CFXJSE_Arguments* pArguments); void Script_ExclGroup_ExecCalculate(CFXJSE_Arguments* pArguments); void Script_ExclGroup_ExecValidate(CFXJSE_Arguments* pArguments); void Script_Subform_InstanceManager(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Subform_Locale(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Subform_ExecEvent(CFXJSE_Arguments* pArguments); void Script_Subform_ExecInitialize(CFXJSE_Arguments* pArguments); void Script_Subform_ExecCalculate(CFXJSE_Arguments* pArguments); void Script_Subform_ExecValidate(CFXJSE_Arguments* pArguments); void Script_Subform_GetInvalidObjects(CFXJSE_Arguments* pArguments); void Script_Template_FormNodes(CFXJSE_Arguments* pArguments); void Script_Template_Remerge(CFXJSE_Arguments* pArguments); void Script_Template_ExecInitialize(CFXJSE_Arguments* pArguments); void Script_Template_CreateNode(CFXJSE_Arguments* pArguments); void Script_Template_Recalculate(CFXJSE_Arguments* pArguments); void Script_Template_ExecCalculate(CFXJSE_Arguments* pArguments); void Script_Template_ExecValidate(CFXJSE_Arguments* pArguments); void Script_Manifest_Evaluate(CFXJSE_Arguments* pArguments); void Script_InstanceManager_Count(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_InstanceManager_Max(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_InstanceManager_Min(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_InstanceManager_MoveInstance(CFXJSE_Arguments* pArguments); void Script_InstanceManager_RemoveInstance(CFXJSE_Arguments* pArguments); void Script_InstanceManager_SetInstances(CFXJSE_Arguments* pArguments); void Script_InstanceManager_AddInstance(CFXJSE_Arguments* pArguments); void Script_InstanceManager_InsertInstance(CFXJSE_Arguments* pArguments); void Script_Occur_Max(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Occur_Min(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Desc_Metadata(CFXJSE_Arguments* pArguments); void Script_Form_FormNodes(CFXJSE_Arguments* pArguments); void Script_Form_Remerge(CFXJSE_Arguments* pArguments); void Script_Form_ExecInitialize(CFXJSE_Arguments* pArguments); void Script_Form_Recalculate(CFXJSE_Arguments* pArguments); void Script_Form_ExecCalculate(CFXJSE_Arguments* pArguments); void Script_Form_ExecValidate(CFXJSE_Arguments* pArguments); void Script_Form_Checksum(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Packet_GetAttribute(CFXJSE_Arguments* pArguments); void Script_Packet_SetAttribute(CFXJSE_Arguments* pArguments); void Script_Packet_RemoveAttribute(CFXJSE_Arguments* pArguments); void Script_Packet_Content(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Source_Next(CFXJSE_Arguments* pArguments); void Script_Source_CancelBatch(CFXJSE_Arguments* pArguments); void Script_Source_First(CFXJSE_Arguments* pArguments); void Script_Source_UpdateBatch(CFXJSE_Arguments* pArguments); void Script_Source_Previous(CFXJSE_Arguments* pArguments); void Script_Source_IsBOF(CFXJSE_Arguments* pArguments); void Script_Source_IsEOF(CFXJSE_Arguments* pArguments); void Script_Source_Cancel(CFXJSE_Arguments* pArguments); void Script_Source_Update(CFXJSE_Arguments* pArguments); void Script_Source_Open(CFXJSE_Arguments* pArguments); void Script_Source_Delete(CFXJSE_Arguments* pArguments); void Script_Source_AddNew(CFXJSE_Arguments* pArguments); void Script_Source_Requery(CFXJSE_Arguments* pArguments); void Script_Source_Resync(CFXJSE_Arguments* pArguments); void Script_Source_Close(CFXJSE_Arguments* pArguments); void Script_Source_Last(CFXJSE_Arguments* pArguments); void Script_Source_HasDataChanged(CFXJSE_Arguments* pArguments); void Script_Source_Db(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Xfa_This(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Handler_Version(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_SubmitFormat_Mode(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Extras_Type(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Encrypt_Format(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); void Script_Script_Stateless(CFXJSE_Value* pValue, bool bSetting, XFA_ATTRIBUTE eAttribute); private: friend class CXFA_Document; CXFA_Node(CXFA_Document* pDoc, uint16_t ePacket, XFA_ObjectType oType, XFA_Element eType, const WideStringView& elementName); bool HasFlag(XFA_NodeFlag dwFlag) const; CXFA_Node* Deprecated_GetPrevSibling(); void OnRemoved(bool bNotify); CXFA_Node* m_pNext; CXFA_Node* m_pChild; CXFA_Node* m_pLastChild; CXFA_Node* m_pParent; CFX_XMLNode* m_pXMLNode; uint16_t m_ePacket; uint16_t m_uNodeFlags; uint32_t m_dwNameHash; CXFA_Node* m_pAuxNode; }; #endif // XFA_FXFA_PARSER_CXFA_NODE_H_