X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FConfig%2FConfig_Common.h;h=0d30e234a3cd8ae324aaa2e34529685b887915ad;hb=e8094b2c51a1c0033489554f8015ac0d456a2d79;hp=b4e2e5f5abfe91bb3df78609f06f864917174c8b;hpb=4d6a5c7e00c6d8e68c01ce5947432d9cdfbcb7a5;p=modules%2Fshaper.git diff --git a/src/Config/Config_Common.h b/src/Config/Config_Common.h index b4e2e5f5a..0d30e234a 100644 --- a/src/Config/Config_Common.h +++ b/src/Config/Config_Common.h @@ -1,12 +1,31 @@ -/* - * Config_Common.h - * - * Created on: Apr 17, 2014 - * Author: sbh - */ +// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or +// email : webmaster.salome@opencascade.com +// + +#ifndef CONFIG_COMMON_H_ +#define CONFIG_COMMON_H_ -#include -#include +#include "Config_def.h" + +#include +#include +#include //>> Forward declaration of xmlNodePtr. typedef struct _xmlNode xmlNode; @@ -20,15 +39,12 @@ typedef xmlDoc *xmlDocPtr; struct _xmlDoc; //<< -/* +/*! * Returns true if theNode is XML ELEMENT node (not a "text" node ie). */ -static bool isElementNode(xmlNodePtr theNode) -{ - return theNode->type == XML_ELEMENT_NODE; -} +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. @@ -36,46 +52,107 @@ static bool isElementNode(xmlNodePtr theNode) * ", NULL" is required to use unlimited number of arguments. * TODO(sbh): find a way to simplify calling this method. */ -static bool isNode(xmlNodePtr theNode, const char* theNodeName, ...) -{ - bool result = false; - const xmlChar* aName = theNode->name; - if (!aName || !isElementNode(theNode)) { - return false; - } - if (!xmlStrcmp(aName, (const xmlChar *) theNodeName)) { - return true; - } - va_list args; // define argument list variable - va_start(args, theNodeName); // init list; point to last defined argument - while(true) { - char *anArg = va_arg (args, char*); // get next argument - if (anArg == NULL) - break; - if (!xmlStrcmp(aName, (const xmlChar *) anArg)) { - va_end(args); // cleanup the system stack - return true; - } - } - va_end(args); // cleanup the system stack - return false; -} - - -/* +CONFIG_EXPORT bool isNode(xmlNodePtr theNode, const char* theNodeName, ...); + +//#define isNode(p) _isNode(p, NULL) + +/*! + * Checks if the given node is attribute node. + * Attribute node represents a widget, that is able to store/restore + * values from the model. Actually it's every widget, displayed + * in the XGUI_PropertyPanel, except paged containers (toolbox, switch/case). + */ +CONFIG_EXPORT bool isAttributeNode(xmlNodePtr theNode); + +/*! + * Checks if the given node is widget node. + * Widget nodes are attribute node + paged containers nodes. + */ +CONFIG_EXPORT bool isWidgetNode(xmlNodePtr theNode); + +CONFIG_EXPORT bool isCaseNode(xmlNodePtr theNode); + +/*! * Every xml node has child. Even if there is no explicit * child nodes libxml gives the "Text node" as child. * * This method checks if real child nodes exist in the * given node. */ -static bool hasChild(xmlNodePtr theNode) -{ - xmlNodePtr aNode = theNode->children; - for(; aNode; aNode = aNode->next) { - if (isElementNode(theNode)) { - return true; - } - } - return false; -} +CONFIG_EXPORT bool hasChild(xmlNodePtr theNode); + + +/*! + * Checks if the given node has a valid parent. + */ +CONFIG_EXPORT bool hasParent(xmlNodePtr theNode); + +/*! + * Checks if the given node has a valid parent with any of the given node names. + */ +CONFIG_EXPORT bool hasParent(xmlNodePtr theNode, const char* theNodeName, ...); + +/*! + * Checks if the given node has any valid parent in hierarchy with any of the given node names. + */ +CONFIG_EXPORT xmlNodePtr hasParentRecursive(xmlNodePtr theNode, const char* theNodeName, ...); + + +/*! + * Returns named property for an id node as std::string and the parameters of the node. + */ +CONFIG_EXPORT bool getParametersInfo(xmlNodePtr theNode, std::string& outPropertyId, + std::list& outValidatorParameters); + +/*! + \brief Convert the given parameter to the platform-specific library name. + + The function appends platform-specific prefix (lib) and suffix (.dll/.so) + to the library file name. + For example, if \a str = "mylib", "libmylib.so" is returned for Linux and + mylib.dll for Windows. + + \param str short library name + \return full library name + */ +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 content of the node as std::string if it is exists. + */ +CONFIG_EXPORT std::string getContent(xmlNodePtr theNode); + +/*! + * 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