Salome HOME
Modif V6_4_°
[tools/eficas.git] / Noyau / N_MACRO.py
1 #@ MODIF N_MACRO Noyau  DATE 30/08/2011   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 - 2011  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 N_OPS
35 import nommage
36
37 class MACRO(N_ENTITE.ENTITE):
38    """
39     Classe pour definir une macro-commande
40
41     Cette classe a trois attributs de classe
42
43     - class_instance qui indique la classe qui devra etre utilisée
44             pour créer l'objet qui servira à controler la conformité d'un
45             macro-commande avec sa définition
46
47     - label qui indique la nature de l'objet de définition (ici, MACRO)
48
49     - nommage qui est un module Python qui fournit la fonctionnalité de nommage
50
51     et les attributs d'instance suivants :
52
53     - nom   : son nom
54
55     - op   : le numéro d'opérateur
56
57     - sd_prod : le type de concept produit. C'est une classe ou une fonction qui retourne
58                       une classe
59
60     - reentrant : vaut 'n' ou 'o'. Indique si l'opérateur est réentrant ou pas. Un opérateur
61                         réentrant peut modifier un concept d'entrée et le produire comme concept de sortie
62
63     - repetable : vaut 'n' ou 'o'. Indique si l'opérateur est répetable ou pas. Un opérateur
64                         non répétable ne doit apparaitre qu'une fois dans une exécution. C'est du ressort
65                         de l'objet gérant le contexte d'exécution de vérifier cette contrainte.
66
67     - fr   : commentaire associé en francais
68
69     - ang : commentaire associé en anglais
70
71     - docu : clé de documentation associée
72
73     - regles : liste des règles associées
74
75     - op_init : cet attribut vaut None ou une fonction. Si cet attribut ne vaut pas None, cette
76                       fonction est exécutée lors des phases d'initialisation de l'étape associée.
77
78     - niveau : indique le niveau dans lequel est rangé l'opérateur. Les opérateurs peuvent etre
79                      rangés par niveau. Ils apparaissent alors exclusivement dans leur niveau de rangement.
80                      Si niveau vaut None, l'opérateur est rangé au niveau global.
81
82     - entites : dictionnaire dans lequel sont stockés les sous entités de l'opérateur. Il s'agit
83                       des entités de définition pour les mots-clés : FACT, BLOC, SIMP. Cet attribut
84                       est initialisé avec args, c'est à dire les arguments d'appel restants.
85
86
87    """
88    class_instance = N_MACRO_ETAPE.MACRO_ETAPE
89    label = 'MACRO'
90    nommage = nommage
91
92    def __init__(self,nom,op,sd_prod=None,reentrant='n',repetable='o',fr="",ang="",
93                 docu="",regles=(),op_init=None,niveau = None,fichier_ini=0,UIinfo=None,**args):
94       """
95          Méthode d'initialisation de l'objet MACRO. Les arguments sont utilisés pour initialiser
96          les attributs de meme nom
97       """
98       # XXX fichier_ini n'est pas utilisé pour l'instant
99       self.nom=nom
100       # op est obligatoire et permet de spécifier la procédure de construction de la macro
101       # - Si op est un entier la construction de la macro est réalisée par une subroutine fortran opsxxx ou
102       # xxx est donné par la valeur absolue de op. L'execution est egalement effectuée via cette subroutine.
103       # - Si op est une fonction Python, la construction de la macro est effectuée par l'appel à cette fonction
104       # Suivant le cas on garde l info dans self.op ou dans self.proc
105       if type(op) == types.IntType:
106         self.proc=None
107         self.op=op
108       else:
109         self.op=None
110         self.proc=op
111
112       self.sd_prod=sd_prod
113       self.reentrant=reentrant
114       self.fr=fr
115       self.ang=ang
116       self.repetable = repetable
117       self.docu=docu
118       if type(regles)== types.TupleType:
119           self.regles=regles
120       else:
121           self.regles=(regles,)
122       self.fichier_ini = fichier_ini
123       # Attribut op_init : Fonction a appeler a la construction de l operateur sauf si == None
124       self.op_init=op_init
125       self.entites = args
126       current_cata=CONTEXT.get_current_cata()
127       if niveau == None:
128          self.niveau=None
129          current_cata.enregistre(self)
130       else:
131          self.niveau=current_cata.get_niveau(niveau)
132          self.niveau.enregistre(self)
133       self.UIinfo=UIinfo
134       self.affecter_parente()
135       self.check_definition(self.nom)
136
137    def __call__(self,reuse=None,**args):
138       """
139           Construit l'objet MACRO_ETAPE a partir de sa definition (self),
140           puis demande la construction de ses sous-objets et du concept produit.
141       """
142       # Glut MC (2007-05) / Sensibilité
143       # Précaution nécessaire pour la sensibilité (on fait 'exec' du texte d'une commande)
144       # car on n'a pas de "ligne" à décoder pour trouver le nom du résultat (à gauche
145       # du signe égal). Cà tombe bien, dans ce cas, sd_prod=None : pas de résultat !
146       if self.sd_prod != None:
147          nomsd=self.nommage.GetNomConceptResultat(self.nom)
148       else:
149          nomsd = None
150       etape= self.class_instance(oper=self,reuse=reuse,args=args)
151       etape.McBuild()
152       return etape.Build_sd(nomsd)
153
154    def make_objet(self,mc_list='oui'):
155       """
156            Cette méthode crée l'objet MACRO_ETAPE dont la définition est self sans
157            créer sa sdprod.
158            Normalement l'étape est enregistrée auprès de son parent.
159            Si l'argument mc_list vaut 'oui', elle déclenche en plus la construction
160            des objets MCxxx.
161       """
162       etape= self.class_instance(oper=self,reuse=None,args={})
163       if mc_list == 'oui':etape.McBuild()
164       return etape
165
166    def verif_cata(self):
167       """
168           Méthode de vérification des attributs de définition
169       """
170       if self.op is not None and (type(self.op) != types.IntType or self.op > 0) :
171         self.cr.fatal("L'attribut 'op' doit etre un entier signé : %s" %`self.op`)
172       if self.proc is not None and not isinstance(self.proc, N_OPS.OPS):
173         self.cr.fatal("L'attribut op doit etre une instance d'OPS : %s" % `self.proc`)
174       if type(self.regles) != types.TupleType :
175         self.cr.fatal("L'attribut 'regles' doit etre un tuple : %s" %`self.regles`)
176       if type(self.fr) != types.StringType :
177         self.cr.fatal("L'attribut 'fr' doit etre une chaine de caractères : %s" %`self.fr`)
178       if type(self.docu) != types.StringType :
179         self.cr.fatal("L'attribut 'docu' doit etre une chaine de caractères : %s" %`self.docu` )
180       if type(self.nom) != types.StringType :
181         self.cr.fatal("L'attribut 'nom' doit etre une chaine de caractères : %s" %`self.nom`)
182       if self.reentrant not in ('o','n','f'):
183         self.cr.fatal("L'attribut 'reentrant' doit valoir 'o','n' ou 'f' : %s" %`self.reentrant`)
184       self.verif_cata_regles()
185
186    def supprime(self):
187       """
188           Méthode pour supprimer les références arrières susceptibles de provoquer
189           des cycles de références
190       """
191       self.niveau=None
192