src/Config/Config_WidgetReader.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  18 //
  19
  20 /*
  21  * Config_WidgetReader.h
  22  *
  23  *  Created on: Apr 2, 2014
  24  *      Author: sbh
  25  */
  26
  27 #ifndef CONFIG_WIDGETREADER_H_
  28 #define CONFIG_WIDGETREADER_H_
  29
  30 #include <Config_def.h>
  31 #include <Config_XMLReader.h>
  32
  33 #include <map>
  34 #include <string>
  35
  36 /*!
  37  * \class Config_WidgetReader
  38  * \ingroup Config
  39  * \brief Class that dumps xml definitions of widgets for
  40  * further processing in the WidgetFactory
  41  */
  42 class Config_WidgetReader : public Config_XMLReader
  43 {
  44  public:
  45   /*!
  46    * Constructor
  47    * \param theXmlFile - full path to the xml file which will be processed by the reader
  48    */
  49   CONFIG_EXPORT Config_WidgetReader(const std::string& theXmlFile);
  50   CONFIG_EXPORT virtual ~Config_WidgetReader();
  51
  52   /// Extract feature's widget configuration from local cache, stored on node processing
  53   CONFIG_EXPORT std::string featureWidgetCfg(const std::string& theFeatureName);
  54   /// Extract feature's description from local cache, stored on node processing
  55   CONFIG_EXPORT std::string featureDescription(const std::string& theFeatureName);
  56
  57  protected:
  58   /// Overloaded method. Defines how to process each node
  59   void processNode(xmlNodePtr theNode);
  60   /// Overloaded method. Defines if the given node should be parsed recursively
  61   bool processChildren(xmlNodePtr theNode);
  62   /// Extracts xml definition of the given node and it's children
  63   std::string dumpNode(xmlNodePtr theNode);
  64   /// Replace all "source" nodes with their content (used before dumping nodes)
  65   void resolveSourceNodes(xmlNodePtr theNode);
  66
  67  private:
  68   std::map<std::string, std::string> myWidgetCache;
  69   std::map<std::string, std::string> myDescriptionCache;
  70
  71 };
  72
  73 #endif /* CONFIG_WIDGETREADER_H_ */