Update Config after merging with master

[modules/shaper.git] / src / Config / Config_Common.h

diff --git a/src/Config/Config_Common.h b/src/Config/Config_Common.h
index 40051dc2ac209f5d0389d4fe5f712cc5eb8017de..1850f8a7bd642373ed74ebdc4d262b443403410a 100644 (file)
--- 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,12 +7,13 @@
  *      Author: sbh
  */
 
-#ifndef Config_Common_H_
-#define Config_Common_H_
+#ifndef CONFIG_COMMON_H_
+#define CONFIG_COMMON_H_
 
-#include "Config.h"
+#include "Config_def.h"
 
 #include <string>
+#include <list>
 #include <stdarg.h>
 
 //>> Forward declaration of xmlNodePtr.
@@ -25,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.
@@ -40,7 +43,25 @@ CONFIG_EXPORT bool isElementNode(xmlNodePtr theNode);
  */
 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.
  *
@@ -49,6 +70,23 @@ CONFIG_EXPORT bool isNode(xmlNodePtr theNode, const char* theNodeName, ...);
  */
 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, ...);
+
+/*!
+ * 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.
 
@@ -62,4 +100,37 @@ CONFIG_EXPORT bool hasChild(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