X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FConfig%2FConfig_Common.h;h=c53586eb50cef0e721ad49aceabe5a703cd6f936;hb=d77e6639d89abdcbf327cc73d13bf955064b8524;hp=4a204f59b3a88cb12de1145639911f4ce84ad8ce;hpb=72ccabc2a906e229fe487dfeae61d38f921927d0;p=modules%2Fshaper.git diff --git a/src/Config/Config_Common.h b/src/Config/Config_Common.h index 4a204f59b..c53586eb5 100644 --- a/src/Config/Config_Common.h +++ b/src/Config/Config_Common.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + /* * Config_Common.h * @@ -5,8 +7,8 @@ * Author: sbh */ -#ifndef Config_Common_H_ -#define Config_Common_H_ +#ifndef CONFIG_COMMON_H_ +#define CONFIG_COMMON_H_ #include "Config_def.h" @@ -26,12 +28,12 @@ typedef xmlDoc *xmlDocPtr; struct _xmlDoc; //<< -/* +/*! * Returns true if theNode is XML ELEMENT node (not a "text" node ie). */ CONFIG_EXPORT bool isElementNode(xmlNodePtr theNode); -/* +/*! * Returns true if theNode is XML node with a given name. * Please note that this function should be called with NULL last argument. @@ -41,7 +43,12 @@ CONFIG_EXPORT bool isElementNode(xmlNodePtr theNode); */ CONFIG_EXPORT bool isNode(xmlNodePtr theNode, const char* theNodeName, ...); -/* +/*! + * Checks is the given node is attribute (widget) node. + */ +CONFIG_EXPORT bool isWidgetNode(xmlNodePtr theNode); + +/*! * Every xml node has child. Even if there is no explicit * child nodes libxml gives the "Text node" as child. * @@ -50,12 +57,11 @@ CONFIG_EXPORT bool isNode(xmlNodePtr theNode, const char* theNodeName, ...); */ CONFIG_EXPORT bool hasChild(xmlNodePtr theNode); -/* - * +/*! + * Returns named property for an id node as std::string and the parameters of the node. */ -CONFIG_EXPORT bool getValidatorInfo(xmlNodePtr theNode, - std::string& outValidatorId, - std::list& outValidatorParameters); +CONFIG_EXPORT bool getParametersInfo(xmlNodePtr theNode, std::string& outPropertyId, + std::list& outValidatorParameters); /*! \brief Convert the given parameter to the platform-specific library name. @@ -70,4 +76,37 @@ CONFIG_EXPORT bool getValidatorInfo(xmlNodePtr theNode, */ CONFIG_EXPORT std::string library(const std::string& theLibName); +/*! + * Returns named property for a given node as std::string. + */ +CONFIG_EXPORT std::string getProperty(xmlNodePtr theNode, const char* thePropName); + +/*! + * Returns normalized (lower case) named property for a given node as std::string. + */ +std::string getNormalizedProperty(xmlNodePtr theNode, const char* thePropName); + +/*! + * Checks if the given XML node has the given attribute, + * if yes - returns it's bool value, if no, or if the value can not + * be converted to bool - returns theDefault value. + * \param theAttributeName attribute to check + * \param theDefault default value on bad data + * \return the boolean result + */ +CONFIG_EXPORT bool getBooleanAttribute(xmlNodePtr theNode, + const char* theAttributeName, + bool theDefault); + +/*! + * Returns normalized (lower case) version of string. + * Should be used for case insensitive string matching. + */ +CONFIG_EXPORT std::string normalize(const char* theString); +/*! + * Returns normalized (lower case) version of string. + * Should be used for case insensitive string matching. + */ +CONFIG_EXPORT std::string normalize(const std::string& theString); + #endif