src/Launcher/Launcher_XML_Persistence.hxx

   1 // Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef __LAUNCHER_XML_PERSISTENCE_HXX__
  24 #define __LAUNCHER_XML_PERSISTENCE_HXX__
  25
  26 #include <list>
  27
  28 #include "Launcher_Utils.hxx"
  29 #include "Launcher_Job.hxx"
  30
  31 namespace Launcher
  32 {
  33   typedef struct _xmlNode xmlNode;
  34   typedef xmlNode *xmlNodePtr;
  35   typedef unsigned char xmlChar;
  36
  37   class LAUNCHER_EXPORT XML_Persistence
  38   {
  39   public:
  40     virtual ~XML_Persistence() {}
  41
  42     /*! Load the jobs from the XML file "jobs_file".
  43      *  Return a list with the jobs that were successfully loaded.
  44      *  The ownership of the created jobs is transferred to the caller.
  45      */
  46     static std::list<Job *> loadJobs(const char* jobs_file);
  47
  48     //! Save the jobs in the list "jobs_list" to the XML file "jobs_file".
  49     static void saveJobs(const char* jobs_file, const std::list<const Job *> & jobs_list);
  50
  51     static Job* createJobFromString(const std::string& jobDump);
  52     static std::string dumpJob(const Job& job);
  53
  54   private:
  55     // This class is static only, not instanciable
  56     XML_Persistence() {}
  57
  58     static void addJobToXmlDocument(xmlNodePtr root_node, const Job & job);
  59     static Job * createJobFromXmlNode(xmlNodePtr job_node);
  60     static void parseUserNode(Job * new_job, xmlNodePtr user_node);
  61     static void parseRunNode(Job * new_job, xmlNodePtr run_node);
  62     static void parseResourceNode(Job * new_job, xmlNodePtr res_node);
  63
  64
  65     // Useful wrappers around libxml2 functions
  66
  67     // Return the value of the attribute, or an empty string if it is not defined
  68     static std::string getAttrValue(xmlNodePtr node, const std::string & attrName);
  69     static inline std::string xmlStrToString(const xmlChar * xmlStr);
  70     static std::string getNodeContent(xmlNodePtr node);
  71     template<typename T> static T getNumericalNodeContent(xmlNodePtr node);
  72     static xmlNodePtr addNode(xmlNodePtr father, const std::string & name,
  73                               const std::string & content);
  74     template<typename T> static xmlNodePtr addNumericalNode(xmlNodePtr father,
  75                                                             const std::string & name,
  76                                                             T content);
  77     static void addAttr(xmlNodePtr node, const std::string & name, const std::string & value);
  78   };
  79
  80 }
  81
  82 #endif