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