src/Config/Config_ValidatorReader.h

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