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_create (string pathName, string componentName, string componentVersion, string componentDate, dyn_string requiredComponents, bool isSubComponent, dyn_string initScripts, dyn_string deleteScripts, dyn_string postInstallScripts, dyn_string postDeleteScripts, dyn_string configFiles, dyn_string asciiFiles, dyn_string panelFiles, dyn_string scriptFiles, dyn_string libraryFiles, dyn_string otherFiles, string dontRestartProject, dyn_string &xmlDesc) |
int | fwInstallationXml_load (string fileName, dyn_dyn_mixed &componentInfo) |
int | fwInstallationXml_decode (string strComponentFile, string &componentName, string &componentVersion, string &date, dyn_string &dynRequiredComponents, bool &isSubComponent, dyn_string &dynInitFiles, dyn_string &dynDeleteFiles, dyn_string &dynPostInstallFiles, dyn_string &dynPostDeleteFiles, dyn_string &dynConfigFiles_general, dyn_string &dynConfigFiles_windows, dyn_string &dynConfigFiles_linux, dyn_string &dynDplistFiles, dyn_string &dynPanelFiles, dyn_string &dynScriptFiles, dyn_string &dynLibFiles, dyn_string &dynComponentFiles, dyn_string &dynSubComponents, dyn_string &dynScriptsToBeAdded, dyn_string &dynFileNames, string &dontRestartProject) |
int | fwInstallationXml_parseFile (string sourceDir, string descFile, string subPath, string destinationDir, dyn_dyn_mixed &parsedComponentInfo) |
Variables | |
const string | csFwInstallationXmlLibVersion = "5.0.0" |
const string | fwInstallation_Xml_CHILDNODESTYPE = "fwXml_ChildNodesType" |
const string | fwInstallation_Xml_CHILDSUBTREEID = "fwXml_ChildSubTreeId" |
fwInstallation.ctl: Definition of constants | |
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 |
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_create | ( | string | pathName, | |
string | componentName, | |||
string | componentVersion, | |||
string | componentDate, | |||
dyn_string | requiredComponents, | |||
bool | isSubComponent, | |||
dyn_string | initScripts, | |||
dyn_string | deleteScripts, | |||
dyn_string | postInstallScripts, | |||
dyn_string | postDeleteScripts, | |||
dyn_string | configFiles, | |||
dyn_string | asciiFiles, | |||
dyn_string | panelFiles, | |||
dyn_string | scriptFiles, | |||
dyn_string | libraryFiles, | |||
dyn_string | otherFiles, | |||
string | dontRestartProject, | |||
dyn_string & | xmlDesc | |||
) |
This function creates a component description file (xml).
pathName | (in) path for the output file {if empty, only create xmlDesc} | |
componentName | (in) name of the component {required} | |
componentVersion | (in) version number of the component {required} | |
componentDate | (in) date of the component {will set current date if empty} | |
requiredComponents | (in) list of required components (componentName=minimalVersionNumber) | |
isSubComponent | (in) TRUE if subcomponent | |
initScripts | (in) scripts to be run during installation | |
deleteScripts | (in) scripts to be run during deletion | |
postInstallScripts | (in) scripts to be run after installation and subsequent restart { | |
postDeleteScripts | (in) scripts to be run after deletion and subsequent restart | |
configFiles | (in) config files for the project {need to be in ./config/, do not specify path} | |
asciiFiles | (in) dplist files for the project {need to be in ./dplist/, do not specify path} | |
panelFiles | (in) panel files for the project {need to be in ./panels/, do only specify sub-path} | |
scriptFiles | (in) script files for the project {need to be in ./scripts/, do only specify sub-path} | |
libraryFiles | (in) library files for the project {need to be in ./scripts/libs/, do only specify sub-path} | |
otherFiles | (in) miscellaneous files for the project {do only specify sub-path from PROJ_PATH} | |
dontRestartProject | (in) flag indicating if the restart of the project can be omitted after the installation of the component | |
xmlDesc | (out) complete xml description |
int fwInstallationXml_decode | ( | string | strComponentFile, | |
string & | componentName, | |||
string & | componentVersion, | |||
string & | date, | |||
dyn_string & | dynRequiredComponents, | |||
bool & | isSubComponent, | |||
dyn_string & | dynInitFiles, | |||
dyn_string & | dynDeleteFiles, | |||
dyn_string & | dynPostInstallFiles, | |||
dyn_string & | dynPostDeleteFiles, | |||
dyn_string & | dynConfigFiles_general, | |||
dyn_string & | dynConfigFiles_windows, | |||
dyn_string & | dynConfigFiles_linux, | |||
dyn_string & | dynDplistFiles, | |||
dyn_string & | dynPanelFiles, | |||
dyn_string & | dynScriptFiles, | |||
dyn_string & | dynLibFiles, | |||
dyn_string & | dynComponentFiles, | |||
dyn_string & | dynSubComponents, | |||
dyn_string & | dynScriptsToBeAdded, | |||
dyn_string & | dynFileNames, | |||
string & | dontRestartProject | |||
) |
This function decodes an XML file (obsolete, legacy)
strComponentFile | (in) XML file loaded into a string | |
componentName | (out) name of the component | |
componentVersion | (out) version of the component | |
date | (out) date when the component was packaged | |
dynRequiredComponents | (out) list of required components | |
isSubComponent | (out) flag indicating if the component is a subcomponent | |
dynInitFiles | (out) list of init scripts | |
dynDeleteFiles | (out) list of delete scripts | |
dynPostInstallFiles | (out) list of post-install scripts | |
dynPostDeleteFiles | (out) list of post-delete scripts | |
dynConfigFiles_general | (out) list of config files for both Windows and Linux | |
dynConfigFiles_windows | (out) list of config files specific for Windows | |
dynConfigFiles_linux | (out) list of config files specific for Linux | |
dynDplistFiles | (out) list of dpl files | |
dynPanelFiles | (out) list of panels | |
dynScriptFiles | (out) list of scripts | |
dynLibFiles | (out) list of libraries | |
dynComponentFiles | (out) full list of component files | |
dynSubComponents | (out) list of subcomponents | |
dynScriptsToBeAdded | (out) list of scripts (legacy, obsolete) | |
dynFileNames | full (out) list of files (legacy, obsolete) | |
dontRestartProject | (out) flag indicating if the restart of the project can be omitted after the installation of the component |
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_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_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 |
const string csFwInstallationXmlLibVersion = "5.0.0" |
Version of this library. Used to determine the coherency of all libraries of the installtion tool
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