src/ModuleGenerator/README

   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 https://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 ______________________________________________________________________
  22
  23
  24 Outil de generation du catalogue de module
  25 a partir des fichiers idl corba.
  26 version 0.1 (12/4/2002)
  27
  28 Marc Tajchman (CEA)
  29
  30 ______________________________________________________________________
  31 Etat :
  32
  33        Version initiale
  34
  35 ______________________________________________________________________
  36 A faire :
  37
  38        Tests supplementaires pour l'ajout et le remplacement
  39        de composants
  40
  41        Implementation du retrait de composant
  42
  43        Gestion des champs du catalogue de modules non presents
  44        dans les fichiers idl
  45
  46        Autres generations (wrappers divers ...)
  47
  48 ______________________________________________________________________
  49 Utilisation :
  50
  51        Une seule commande dans tous les cas de figure :
  52
  53           runIDLparser -Wbcatalog=my_catalog.xml <fichier.idl>
  54
  55        (appel de runIDLparser pour interpreter <fichier.idl> et
  56         mettre a jour le catalogue de module my_catalog.xml)
  57
  58 ______________________________________________________________________
  59 Tests d'utilisation :
  60
  61 Pour lancer les tests, utiliser le script 'testIDLparser' depuis
  62 le repertoire <SALOME_BUILD>/SALOME/src/ModuleGenerator :
  63
  64    sh testIDLparser <n>
  65
  66 ou <n> vaut 1, 1b, 2, 3, 4, 5
  67
  68               _________________________________________
  69 1.  Creation d'un nouveau catalogue de composants my_catalog.xml
  70     a partir d'un fichier idl <fichier.idl>
  71     Le fichier idl contient un seul composant Salome.
  72
  73               _________________________________________
  74 1b. Creation d'un nouveau catalogue de composants my_catalog.xml
  75     a partir d'un fichier idl <fichier.idl>
  76     Le fichier idl contient un composant et une interface CORBA
  77     qui n'est pas un composant Salome (i.e. ne derive pas de
  78     Engines::EngineComponent).
  79
  80               _________________________________________
  81 2.  Un meme fichier idl est lu deux fois
  82
  83               _________________________________________
  84 3.  Deux fichiers idl differents sont lus, puis le premier est relu
  85
  86               _________________________________________
  87 4.  Deux fichiers idl contenant deux versions differentes du meme
  88     composant sont lus. Teste aussi la 'persistance' des champs
  89     'commentaires'
  90
  91               _________________________________________
  92 5.  Test global sur les idl de Salome
  93
  94
  95 Les scripts de test se trouvent dans le repertoire
  96         <KERNEL_SRC>/src/ModuleGenerator/tests
  97
  98 Les fichiers idl servant aux tests se trouvent dans les repertoires
  99         <KERNEL_SRC>/idl
 100         <KERNEL_SRC>/src/ModuleGenerator/tests