Salome HOME
6d5b70fc2eeffb8b8c20fbfa27c8dcaed8e14897
[tools/eficas.git] / Noyau / N_MACRO.py
1 #@ MODIF N_MACRO Noyau  DATE 07/09/2009   AUTEUR COURTOIS M.COURTOIS 
2 # -*- coding: iso-8859-1 -*-
3 # RESPONSABLE COURTOIS M.COURTOIS
4 #            CONFIGURATION MANAGEMENT OF EDF VERSION
5 # ======================================================================
6 # COPYRIGHT (C) 1991 - 2002  EDF R&D                  WWW.CODE-ASTER.ORG
7 # THIS PROGRAM IS FREE SOFTWARE; YOU CAN REDISTRIBUTE IT AND/OR MODIFY
8 # IT UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENSE AS PUBLISHED BY
9 # THE FREE SOFTWARE FOUNDATION; EITHER VERSION 2 OF THE LICENSE, OR   
10 # (AT YOUR OPTION) ANY LATER VERSION.                                 
11 #
12 # THIS PROGRAM IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL, BUT 
13 # WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY OF          
14 # MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. SEE THE GNU    
15 # GENERAL PUBLIC LICENSE FOR MORE DETAILS.                            
16 #
17 # YOU SHOULD HAVE RECEIVED A COPY OF THE GNU GENERAL PUBLIC LICENSE   
18 # ALONG WITH THIS PROGRAM; IF NOT, WRITE TO EDF R&D CODE_ASTER,       
19 #    1 AVENUE DU GENERAL DE GAULLE, 92141 CLAMART CEDEX, FRANCE.      
20 #                                                                       
21 #                                                                       
22 # ======================================================================
23
24
25 """ 
26     Ce module contient la classe de definition MACRO
27     qui permet de spécifier les caractéristiques d'une macro-commande
28 """
29
30 import types,string,traceback
31
32 import N_ENTITE
33 import N_MACRO_ETAPE
34 import nommage
35
36 class MACRO(N_ENTITE.ENTITE):
37    """
38     Classe pour definir une macro-commande
39
40     Cette classe a trois attributs de classe 
41
42     - class_instance qui indique la classe qui devra etre utilisée 
43             pour créer l'objet qui servira à controler la conformité d'un 
44             macro-commande avec sa définition
45
46     - label qui indique la nature de l'objet de définition (ici, MACRO)
47
48     - nommage qui est un module Python qui fournit la fonctionnalité de nommage
49
50     et les attributs d'instance suivants :
51
52     - nom   : son nom
53
54     - op   : le numéro d'opérateur
55
56     - sd_prod : le type de concept produit. C'est une classe ou une fonction qui retourne
57                       une classe
58
59     - reentrant : vaut 'n' ou 'o'. Indique si l'opérateur est réentrant ou pas. Un opérateur
60                         réentrant peut modifier un concept d'entrée et le produire comme concept de sortie
61
62     - repetable : vaut 'n' ou 'o'. Indique si l'opérateur est répetable ou pas. Un opérateur
63                         non répétable ne doit apparaitre qu'une fois dans une exécution. C'est du ressort
64                         de l'objet gérant le contexte d'exécution de vérifier cette contrainte.
65
66     - fr   : commentaire associé en francais
67
68     - ang : commentaire associé en anglais
69
70     - docu : clé de documentation associée
71
72     - regles : liste des règles associées
73
74     - op_init : cet attribut vaut None ou une fonction. Si cet attribut ne vaut pas None, cette
75                       fonction est exécutée lors des phases d'initialisation de l'étape associée.
76
77     - niveau : indique le niveau dans lequel est rangé l'opérateur. Les opérateurs peuvent etre
78                      rangés par niveau. Ils apparaissent alors exclusivement dans leur niveau de rangement.
79                      Si niveau vaut None, l'opérateur est rangé au niveau global.
80
81     - entites : dictionnaire dans lequel sont stockés les sous entités de l'opérateur. Il s'agit
82                       des entités de définition pour les mots-clés : FACT, BLOC, SIMP. Cet attribut
83                       est initialisé avec args, c'est à dire les arguments d'appel restants.
84
85
86    """
87    class_instance = N_MACRO_ETAPE.MACRO_ETAPE
88    label = 'MACRO'
89    nommage = nommage
90
91    def __init__(self,nom,op,sd_prod=None,reentrant='n',repetable='o',fr="",ang="",
92                 docu="",regles=(),op_init=None,niveau = None,fichier_ini=0,UIinfo=None,**args):
93       """
94          Méthode d'initialisation de l'objet MACRO. Les arguments sont utilisés pour initialiser
95          les attributs de meme nom
96       """
97       # XXX fichier_ini n'est pas utilisé pour l'instant
98       self.nom=nom
99       # op est obligatoire et permet de spécifier la procédure de construction de la macro
100       # - Si op est un entier la construction de la macro est réalisée par une subroutine fortran opsxxx ou
101       # xxx est donné par la valeur absolue de op. L'execution est egalement effectuée via cette subroutine.
102       # - Si op est une fonction Python, la construction de la macro est effectuée par l'appel à cette fonction
103       # Suivant le cas on garde l info dans self.op ou dans self.proc
104       if type(op) == types.IntType:
105         self.proc=None
106         self.op=op
107       else:
108         self.op=None
109         self.proc=op
110
111       self.sd_prod=sd_prod
112       self.reentrant=reentrant
113       self.fr=fr
114       self.ang=ang
115       self.repetable = repetable
116       self.docu=docu
117       if type(regles)== types.TupleType:
118           self.regles=regles
119       else:
120           self.regles=(regles,)
121       self.fichier_ini = fichier_ini
122       # Attribut op_init : Fonction a appeler a la construction de l operateur sauf si == None
123       self.op_init=op_init
124       self.entites=args
125       current_cata=CONTEXT.get_current_cata()
126       if niveau == None:
127          self.niveau=None
128          current_cata.enregistre(self)
129       else:
130          self.niveau=current_cata.get_niveau(niveau)
131          self.niveau.enregistre(self)
132       self.UIinfo=UIinfo
133       self.affecter_parente()
134
135    def __call__(self,reuse=None,**args):
136       """
137           Construit l'objet MACRO_ETAPE a partir de sa definition (self),
138           puis demande la construction de ses sous-objets et du concept produit.
139       """
140       # Glut MC (2007-05) / Sensibilité
141       # Précaution nécessaire pour la sensibilité (on fait 'exec' du texte d'une commande)
142       # car on n'a pas de "ligne" à décoder pour trouver le nom du résultat (à gauche
143       # du signe égal). Cà tombe bien, dans ce cas, sd_prod=None : pas de résultat !
144       if self.sd_prod != None:
145          nomsd=self.nommage.GetNomConceptResultat(self.nom)
146       else:
147          nomsd = None
148       etape= self.class_instance(oper=self,reuse=reuse,args=args)
149       etape.McBuild()
150       return etape.Build_sd(nomsd)
151
152    def make_objet(self,mc_list='oui'):
153       """
154            Cette méthode crée l'objet MACRO_ETAPE dont la définition est self sans
155            créer sa sdprod.
156            Normalement l'étape est enregistrée auprès de son parent.
157            Si l'argument mc_list vaut 'oui', elle déclenche en plus la construction
158            des objets MCxxx.
159       """
160       etape= self.class_instance(oper=self,reuse=None,args={})
161       if mc_list == 'oui':etape.McBuild()
162       return etape
163
164    def verif_cata(self):
165       """
166           Méthode de vérification des attributs de définition
167       """
168       if self.op is not None and (type(self.op) != types.IntType or self.op > 0) :
169         self.cr.fatal("L'attribut 'op' doit etre un entier signé : %s" %`self.op`)
170       if self.proc is not None and type(self.proc) != types.FunctionType:
171         self.cr.fatal("L'attribut op doit etre une fonction Python : %s" % `self.proc`)
172       if type(self.regles) != types.TupleType :
173         self.cr.fatal("L'attribut 'regles' doit etre un tuple : %s" %`self.regles`)
174       if type(self.fr) != types.StringType :
175         self.cr.fatal("L'attribut 'fr' doit etre une chaine de caractères : %s" %`self.fr`)
176       if type(self.docu) != types.StringType :
177         self.cr.fatal("L'attribut 'docu' doit etre une chaine de caractères : %s" %`self.docu` )
178       if type(self.nom) != types.StringType :
179         self.cr.fatal("L'attribut 'nom' doit etre une chaine de caractères : %s" %`self.nom`)
180       if self.reentrant not in ('o','n','f'):
181         self.cr.fatal("L'attribut 'reentrant' doit valoir 'o','n' ou 'f' : %s" %`self.reentrant`)
182       self.verif_cata_regles()
183
184    def supprime(self):
185       """
186           Méthode pour supprimer les références arrières susceptibles de provoquer
187           des cycles de références
188       """
189       self.niveau=None
190
191