+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
/*
* Config_Common.h
*
* Author: sbh
*/
-#include <libxml/parser.h>
-#include <libxml/tree.h>
+#ifndef CONFIG_COMMON_H_
+#define CONFIG_COMMON_H_
+
+#include "Config_def.h"
+
+#include <string>
+#include <list>
+#include <stdarg.h>
//>> Forward declaration of xmlNodePtr.
typedef struct _xmlNode xmlNode;
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.
* ", 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 bool 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<std::string>& 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 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
