src/Config/Config_FeatureReader.h

   1 // Copyright (C) 2014-2021  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
  18 //
  19
  20 #ifndef CONFIG_FEATUREREADER_H_
  21 #define CONFIG_FEATUREREADER_H_
  22
  23 #include <Config_def.h>
  24 #include <Config_XMLReader.h>
  25 #include <memory>
  26
  27 #include <string>
  28 #include <list>
  29
  30 class Config_FeatureMessage;
  31
  32 /*!
  33  * \class Config_FeatureReader
  34  * \ingroup Config
  35  * \brief Class to process feature's xml definition.
  36  */
  37 class Config_FeatureReader : public Config_XMLReader
  38 {
  39  public:
  40   /// Constructor
  41   Config_FeatureReader(const std::string& theXmlFile,
  42                        const std::string& theLibraryName,
  43                        const std::string& theDocSection = std::string(),
  44                        const char* theEventGenerated = 0);
  45   virtual ~Config_FeatureReader();
  46   /// Returns list of all features defined in reader's file
  47   std::list<std::string> features() const;
  48
  49  protected:
  50   /// Overloaded method. Defines how to process each node
  51   virtual void processNode(xmlNodePtr aNode);
  52
  53   /// Overloaded method. Clears attribute cache on exit from attribute's node
  54   virtual void cleanup(xmlNodePtr aNode);
  55
  56   /// Overloaded method. Defines if the given node should be parsed recursively
  57   virtual bool processChildren(xmlNodePtr aNode);
  58
  59   /// Fills feature message
  60   void fillFeature(xmlNodePtr theRoot,
  61                    const std::shared_ptr<Config_FeatureMessage>& outFeatureMessage);
  62
  63  private:
  64   std::string myLibraryName;
  65   std::string myLibraryDocSection;
  66
  67   std::list<std::string> myFeatures;
  68   /// event generated on feature data sending, by default it is Config_FeatureMessage::GUI_EVENT()
  69   const char* myEventGenerated;
  70   bool myIsProcessWidgets;
  71 };
  72
  73 #endif /* CONFIG_FEATUREREADER_H_ */