fwInstallation
8.4.1
|
Functions | |
int | fwInstallationXml_childNodesContent (unsigned doc, int node, dyn_string &node_names, dyn_anytype &attributes, dyn_string &nodevalues, dyn_string &exceptionInfo) |
int | fwInstallationXml_get (string docPath, dyn_string &tags, dyn_string &values, dyn_anytype &attribs) |
int | fwInstallationXml_getTag (string docPath, string tag, dyn_string &FilteredValues, dyn_anytype &FilteredAttribs) |
int | fwInstallationXml_createComponentFile (string pathName, dyn_dyn_mixed componentInfo) |
int | fwInstallationXml_load (string fileName, dyn_dyn_mixed &componentInfo) |
int | _fwInstallationXml_FindWildcardFiles (string tagValue, string fileName, dyn_string &tmpFiles) |
int | fwInstallationXml_parseFile (string sourceDir, string descFile, string subPath, string destinationDir, dyn_dyn_mixed &parsedComponentInfo) |
int | fwInstallationXml_getTagFromString (string &tagName, string &tagValue, string &strComponentFile) |
Variables | |
const string | csFwInstallationXmlLibVersion = "8.4.1" |
const string | fwInstallation_Xml_CHILDNODESTYPE = "fwXml_ChildNodesType" |
const string | fwInstallation_Xml_CHILDSUBTREEID = "fwXml_ChildSubTreeId" |
fwInstallation.ctl: Definition of constants | |
The following constants define the indeces of the different elements in the component XML file when passed as a dyn_dyn_mixed matrix | |
const int | FW_INSTALLATION_XML_COMPONENT_NAME = 1 |
const int | FW_INSTALLATION_XML_COMPONENT_VERSION = 2 |
const int | FW_INSTALLATION_XML_COMPONENT_IS_SUBCOMPONENT = 3 |
const int | FW_INSTALLATION_XML_COMPONENT_DATE = 4 |
const int | FW_INSTALLATION_XML_COMPONENT_HELP_FILE = 5 |
const int | FW_INSTALLATION_XML_COMPONENT_REQUIRED_COMPONENTS = 6 |
const int | FW_INSTALLATION_XML_COMPONENT_DPLIST_FILES = 7 |
const int | FW_INSTALLATION_XML_COMPONENT_SUBCOMPONENTS = 8 |
const int | FW_INSTALLATION_XML_COMPONENT_COMMENTS = 9 |
const int | FW_INSTALLATION_XML_COMPONENT_INIT_SCRIPTS = 10 |
const int | FW_INSTALLATION_XML_COMPONENT_DELETE_SCRIPTS = 11 |
const int | FW_INSTALLATION_XML_COMPONENT_POST_INSTALL_SCRIPTS = 12 |
const int | FW_INSTALLATION_XML_COMPONENT_POST_DELETE_SCRIPTS = 13 |
const int | FW_INSTALLATION_XML_COMPONENT_CONFIG_FILES = 14 |
const int | FW_INSTALLATION_XML_COMPONENT_PANEL_FILES = 15 |
const int | FW_INSTALLATION_XML_COMPONENT_LIBRARY_FILES = 16 |
const int | FW_INSTALLATION_XML_COMPONENT_SCRIPT_FILES = 17 |
const int | FW_INSTALLATION_XML_COMPONENT_OTHER_FILES = 18 |
const int | FW_INSTALLATION_XML_DESC_FILE = 19 |
const int | FW_INSTALLATION_XML_COMPONENT_DONT_RESTART = 20 |
const int | FW_INSTALLATION_XML_COMPONENT_CONFIG_FILES_WINDOWS = 21 |
const int | FW_INSTALLATION_XML_COMPONENT_CONFIG_FILES_LINUX = 22 |
const int | FW_INSTALLATION_XML_COMPONENT_REQUIRED_PVSS_VERSION = 23 |
const int | FW_INSTALLATION_XML_COMPONENT_STRICT_PVSS_VERSION = 24 |
const int | FW_INSTALLATION_XML_COMPONENT_REQUIRED_PVSS_PATCH = 25 |
const int | FW_INSTALLATION_XML_COMPONENT_PREINIT_SCRIPTS = 26 |
const int | FW_INSTALLATION_XML_COMPONENT_UPDATE_TYPES = 27 |
const int | FW_INSTALLATION_XML_COMPONENT_FILES = 28 |
const int | FW_INSTALLATION_XML_COMPONENT_POST_INSTALL_SCRIPTS_CURRENT = 29 |
const int | FW_INSTALLATION_XML_COMPONENT_POST_DELETE_SCRIPTS_CURRENT = 30 |
const int | FW_INSTALLATION_XML_COMPONENT_REQUIRED_INSTALLER_VERSION = 31 |
const int | FW_INSTALLATION_XML_COMPONENT_STRICT_INSTALLER_VERSION = 32 |
const int | FW_INSTALLATION_XML_COMPONENT_DESCRIPTION = 33 |
const int | FW_INSTALLATION_XML_COMPONENT_IS_HIDDEN_COMPONENT = 34 |
const int | FW_INSTALLATION_XML_COMPONENT_BIN_FILES = 35 |
const int | FW_INSTALLATION_XML_COMPONENT_QT_HELP_FILES = 36 |
const string | FW_INSTALLATION_XML_TAG_ROOT_COMPONENT = "component" |
This package contains functions to manipulate the component XML description files
int fwInstallationXml_childNodesContent | ( | unsigned | doc, |
int | node, | ||
dyn_string & | node_names, | ||
dyn_anytype & | attributes, | ||
dyn_string & | nodevalues, | ||
dyn_string & | exceptionInfo | ||
) |
'fwInstallation_xmlChildNodesContent()' this function is a copy of
'fwXml_childNodesContent' and it should be eventually replace once the fwXml.ctl is widely distributed. It returns tags, attributes and contained data of all children
doc | input, the document identifier |
node | input, the node identifier of the parent element-node container |
node_names | output, the node-names or tag-names for element-nodes |
attributes | output, the attributes of element-nodes and added infomation |
nodevalues | output, the node-values or values of the unique child's text-node |
exceptionInfo | inout, returns details of any exceptions |
int fwInstallationXml_get | ( | string | docPath, |
dyn_string & | tags, | ||
dyn_string & | values, | ||
dyn_anytype & | attribs | ||
) |
This function retrieves the contents of an XML file
docPath | (in) XML file to be parsed |
tags | (out) XML tags in the file as an dyn_string array |
values | (out) values of the XML tags |
attribs | (out) tag attributes |
int fwInstallationXml_getTag | ( | string | docPath, |
string | tag, | ||
dyn_string & | FilteredValues, | ||
dyn_anytype & | FilteredAttribs | ||
) |
This function the value and attributes of all entries in a XML file for a particular tag
docPath | (in) XML file to be parsed |
tag | (in) XML tag to look for |
FilteredValues | (out) values of the XML tags |
FilteredAttribs | (out) tag attributes |
int fwInstallationXml_createComponentFile | ( | string | pathName, |
dyn_dyn_mixed | componentInfo | ||
) |
This function creates a component description file (xml).
pathName | (in) path for the output file {if empty, only create xmlDesc} |
componentInfo | (in) dyn_dyn_mixed containing the contents of the XML file to be created |
int fwInstallationXml_load | ( | string | fileName, |
dyn_dyn_mixed & | componentInfo | ||
) |
This function loads the contents of a component XML file into a dyn_dyn_mixed matrix
fileName | (in) fileName name of the component xml file |
componentInfo | (out) XML file contents as a dyn_dyn_mixed matrix |
int _fwInstallationXml_FindWildcardFiles | ( | string | tagValue, |
string | fileName, | ||
dyn_string & | tmpFiles | ||
) |
This function finds all files that matches to the given pattern with wildcard (*)
tagValue | (in) XML tag |
fileName | (in) fileName name of the component xml file |
tmpFiles | (out) list of matched files |
int fwInstallationXml_parseFile | ( | string | sourceDir, |
string | descFile, | ||
string | subPath, | ||
string | destinationDir, | ||
dyn_dyn_mixed & | parsedComponentInfo | ||
) |
This funcion parses a XML file. Contrarily to fwInstallationXML_load, this function prepends the relative destination path to the files
sourceDir | (in) source directory |
descFile | (in) XML description file |
subPath | (in) path to the appended to the source directory |
destinationDir | (in) destination directory where the component will be installed |
parsedComponentInfo | (out) resulting component info |
int fwInstallationXml_getTagFromString | ( | string & | tagName, |
string & | tagValue, | ||
string & | strComponentFile | ||
) |
This funcion parses a string representing xml element
tagName | (out) name of the tag |
tagValue | (out) value of the tag |
strComponentFile | (in) XML file parsed as a string |
const string csFwInstallationXmlLibVersion = "8.4.1" |
Version of this library. Used to determine the coherency of all libraries of the installation tool Please do not edit it manually
const string fwInstallation_Xml_CHILDNODESTYPE = "fwXml_ChildNodesType" |
Constant used in the mapping that identifies the node-type of the node in question
const string fwInstallation_Xml_CHILDSUBTREEID = "fwXml_ChildSubTreeId" |
Constant used in the mapping that identifies the node-identifier of the node in question