src/Config/Config_ValidatorReader.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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef CONFIG_VALIDATORREADER_H_
  22 #define CONFIG_VALIDATORREADER_H_
  23
  24 #include <Config_def.h>
  25 #include <Config_XMLReader.h>
  26
  27 #include <cstdarg>
  28 #include <string>
  29
  30 /*!
  31  * \class Config_ValidatorReader
  32  * \ingroup Config
  33  * \brief Base class for all libxml readers. Provides high-level API
  34  * for all xml operations.
  35 */
  36 class Config_ValidatorReader : public Config_XMLReader
  37 {
  38  public:
  39   /*!
  40    * Constructor
  41    * \param theXmlFile - full path to the xml file which will be processed by the reader
  42    */
  43   CONFIG_EXPORT Config_ValidatorReader(const std::string& theXmlFile);
  44   CONFIG_EXPORT virtual ~Config_ValidatorReader();
  45
  46  protected:
  47   /*!
  48    * \brief Allows to customize reader's behavior for a node. Virtual.
  49    * The default implementation process "source" and "validator" nodes.
  50    */
  51   virtual void processNode(xmlNodePtr aNode);
  52   /*!
  53    * \brief Defines which nodes should be processed recursively. Virtual.
  54    * The default impl is to read all nodes.
  55    */
  56   virtual bool processChildren(xmlNodePtr aNode);
  57
  58   /*!
  59    * Cleans the cached information about parent feature or attribute (widget)
  60    */
  61   virtual void cleanup(xmlNodePtr theNode);
  62
  63   /*!
  64    * \brief Retrieves all the necessary info from the validator node.
  65    * Sends ValidatorLoaded event
  66    */
  67   void processValidator(xmlNodePtr theNode);
  68
  69  private:
  70   std::string myCurrentWidget;
  71 };
  72
  73 #endif /* CONFIG_VALIDATORREADER_H_ */