src/ModuleCatalog/SALOME_ModuleCatalog_Parser.hxx

   1 //  SALOME ModuleCatalog : implementation of ModuleCatalog server which parsers xml description of modules
   2 //
   3 //  Copyright (C) 2003  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.
  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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : SALOME_ModuleCatalog_Parser.hxx
  25 //  Author : Estelle Deville
  26 //  Module : SALOME
  27 //  $Header$
  28 //
  29 #ifndef SALOME_CATALOG_PARSER_H
  30 #define SALOME_CATALOG_PARSER_H
  31
  32 #include <string>
  33 #include <vector>
  34
  35 // Type Definitions
  36 struct ParserPathPrefix
  37 {
  38   std::string         path;
  39   std::vector<std::string> listOfComputer ;
  40 };
  41
  42 typedef std::vector<ParserPathPrefix> ParserPathPrefixes ;
  43
  44 enum ParserComponentType {GEOM, MESH, Med, SOLVER, DATA, VISU, SUPERV, OTHER} ;
  45
  46 struct ParserParameter
  47 {
  48   std::string type;
  49   std::string name;
  50 } ;
  51
  52
  53 struct ParserDataStreamParameter
  54 {
  55   std::string type;
  56   std::string name;
  57   std::string dependency;
  58 } ;
  59
  60 typedef std::vector<ParserParameter> ParserParameters;
  61 typedef std::vector<ParserDataStreamParameter> ParserDataStreamParameters;
  62
  63 struct ParserService
  64 {
  65   ParserService() {
  66     typeOfNode = 1;
  67     byDefault = 1;
  68   }
  69   std::string                name;
  70   ParserParameters           inParameters;
  71   ParserParameters           outParameters;
  72   ParserDataStreamParameters inDataStreamParameters;
  73   ParserDataStreamParameters outDataStreamParameters;
  74   bool                       byDefault;
  75   bool                       typeOfNode;
  76 } ;
  77
  78 typedef std::vector<ParserService> ParserServices ;
  79
  80 struct ParserInterface
  81 {
  82   std::string    name ;
  83   ParserServices services ;
  84 } ;
  85
  86 typedef std::vector<ParserInterface> ParserInterfaces;
  87
  88 struct ParserComponent
  89 {
  90   std::string         name;
  91   std::string         username;
  92   ParserComponentType type;
  93   bool                multistudy;
  94   std::string         icon;
  95   std::string         constraint;
  96   ParserInterfaces    interfaces;
  97   ParserPathPrefixes  prefixes;
  98   bool                implementationType;
  99   std::string         version;
 100   std::string         comment;
 101 };
 102
 103 typedef std::vector<ParserComponent> ParserComponents ;
 104
 105 #ifdef WRITE_CATA_COMPONENT
 106 // contains all the paths and the computers defined in the catalog
 107        ParserPathPrefixes  _pathList;
 108
 109 // contains all the modules defined in the catalog
 110        ParserComponents    _moduleList;
 111 #else
 112 extern ParserPathPrefixes _pathList;
 113 extern ParserComponents   _moduleList;
 114 #endif
 115
 116
 117 #endif // SALOME_CATALOG_PARSER_H