Noyau/N_MACRO_ETAPE.py

   1 #@ MODIF N_MACRO_ETAPE Noyau  DATE 06/01/2003   AUTEUR ASSIRE A.ASSIRE
   2 #            CONFIGURATION MANAGEMENT OF EDF VERSION
   3 # ======================================================================
   4 # COPYRIGHT (C) 1991 - 2002  EDF R&D                  WWW.CODE-ASTER.ORG
   5 # THIS PROGRAM IS FREE SOFTWARE; YOU CAN REDISTRIBUTE IT AND/OR MODIFY
   6 # IT UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENSE AS PUBLISHED BY
   7 # THE FREE SOFTWARE FOUNDATION; EITHER VERSION 2 OF THE LICENSE, OR
   8 # (AT YOUR OPTION) ANY LATER VERSION.
   9 #
  10 # THIS PROGRAM IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL, BUT
  11 # WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY OF
  12 # MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. SEE THE GNU
  13 # GENERAL PUBLIC LICENSE FOR MORE DETAILS.
  14 #
  15 # YOU SHOULD HAVE RECEIVED A COPY OF THE GNU GENERAL PUBLIC LICENSE
  16 # ALONG WITH THIS PROGRAM; IF NOT, WRITE TO EDF R&D CODE_ASTER,
  17 #    1 AVENUE DU GENERAL DE GAULLE, 92141 CLAMART CEDEX, FRANCE.
  18 #
  19 #
  20 # ======================================================================
  21 """
  22     Ce module contient la classe MACRO_ETAPE qui sert à vérifier et à exécuter
  23     une commande
  24 """
  25
  26 # Modules Python
  27 import types,sys,string
  28 import traceback
  29
  30 # Modules EFICAS
  31 import N_MCCOMPO
  32 import N_ETAPE
  33 from N_Exception import AsException
  34 import N_utils
  35 from N_utils import AsType
  36
  37 class MACRO_ETAPE(N_ETAPE.ETAPE):
  38    """
  39
  40    """
  41    nature = "COMMANDE"
  42    def __init__(self,oper=None,reuse=None,args={}):
  43       """
  44          Attributs :
  45
  46           - definition : objet portant les attributs de définition d'une étape
  47                          de type macro-commande. Il est initialisé par
  48                          l'argument oper.
  49
  50           - reuse : indique le concept d'entrée réutilisé. Il se trouvera donc
  51                     en sortie si les conditions d'exécution de l'opérateur
  52                     l'autorise
  53
  54           - valeur : arguments d'entrée de type mot-clé=valeur. Initialisé
  55                      avec l'argument args.
  56
  57       """
  58       self.definition=oper
  59       self.reuse=reuse
  60       self.valeur=args
  61       self.nettoiargs()
  62       self.parent=CONTEXT.get_current_step()
  63       self.etape = self
  64       self.nom=oper.nom
  65       self.idracine=oper.label
  66       self.appel=N_utils.callee_where()
  67       self.mc_globaux={}
  68       self.g_context={}
  69       # Contexte courant
  70       self.current_context={}
  71       self.index_etape_courante=0
  72       self.etapes=[]
  73       self.sds=[]
  74       #  Dans le cas d'une macro écrite en Python, l'attribut Outputs est un
  75       #  dictionnaire qui contient les concepts produits de sortie
  76       #  (nom : ASSD) déclarés dans la fonction sd_prod
  77       self.Outputs={}
  78       self.sd=None
  79       self.actif=1
  80       self.sdprods=[]
  81       self.make_register()
  82
  83    def make_register(self):
  84       """
  85          Initialise les attributs jdc, id, niveau et réalise les enregistrements
  86          nécessaires
  87       """
  88       if self.parent :
  89          self.jdc = self.parent.get_jdc_root()
  90          self.id=self.parent.register(self)
  91          self.niveau=None
  92       else:
  93          self.jdc = self.parent =None
  94          self.id=None
  95          self.niveau=None
  96
  97    def Build_sd(self,nom):
  98       """
  99          Construit le concept produit de l'opérateur. Deux cas
 100          peuvent se présenter :
 101
 102               - le parent n'est pas défini. Dans ce cas, l'étape prend en charge
 103                 la création et le nommage du concept.
 104
 105               - le parent est défini. Dans ce cas, l'étape demande au parent la
 106                 création et le nommage du concept.
 107
 108       """
 109       if not self.isactif():return
 110       self.sdnom=nom
 111       try:
 112          # On positionne la macro self en tant que current_step pour que les
 113          # étapes créées lors de l'appel à sd_prod et à op_init aient la macro
 114          #  comme parent
 115          self.set_current_step()
 116          if self.parent:
 117             sd= self.parent.create_sdprod(self,nom)
 118             if type(self.definition.op_init) == types.FunctionType:
 119                apply(self.definition.op_init,(self,self.parent.g_context))
 120          else:
 121             sd=self.get_sd_prod()
 122             if sd != None and self.reuse == None:
 123                # On ne nomme le concept que dans le cas de non reutilisation
 124                # d un concept
 125                sd.nom=nom
 126          self.reset_current_step()
 127       except AsException,e:
 128          self.reset_current_step()
 129          raise AsException("Etape ",self.nom,'ligne : ',self.appel[0],
 130                               'fichier : ',self.appel[1],e)
 131       except (EOFError,self.jdc.UserError):
 132          # Le retablissement du step courant n'est pas strictement necessaire. On le fait pour des raisons de coherence
 133          self.reset_current_step()
 134          raise
 135       except :
 136          self.reset_current_step()
 137          l=traceback.format_exception(sys.exc_info()[0],sys.exc_info()[1],sys.exc_info()[2])
 138          raise AsException("Etape ",self.nom,'ligne : ',self.appel[0],
 139                            'fichier : ',self.appel[1]+'\n',
 140                             string.join(l))
 141
 142       self.Execute()
 143       return sd
 144
 145    def get_sd_prod(self):
 146       """
 147         Retourne le concept résultat d'une macro étape
 148         La difference avec une etape ou une proc-etape tient a ce que
 149         le concept produit peut exister ou pas
 150         Si sd_prod == None le concept produit n existe pas on retourne None
 151         Deux cas :
 152                - sd_prod  n'est pas une fonction
 153                  il s'agit d'une sous classe de ASSD
 154                  on construit le sd à partir de cette classe
 155                  et on le retourne
 156                - sd_prod est une fonction
 157                  on l'évalue avec les mots-clés de l'étape (mc_liste)
 158                  on construit le sd à partir de la classe obtenue
 159                  et on le retourne
 160       """
 161       sd_prod=self.definition.sd_prod
 162       self.typret=None
 163       if type(self.definition.sd_prod) == types.FunctionType:
 164         d=self.cree_dict_valeurs(self.mc_liste)
 165         try:
 166           # la sd_prod d'une macro a l'objet macro_etape lui meme en premier argument
 167           # Comme sd_prod peut invoquer la méthode type_sdprod qui ajoute
 168           # les concepts produits dans self.sdprods, il faut le mettre à zéro avant de l'appeler
 169           self.sdprods=[]
 170           sd_prod= apply(sd_prod,(self,),d)
 171         except (EOFError,self.jdc.UserError):
 172           raise
 173         except:
 174           if CONTEXT.debug: traceback.print_exc()
 175           l=traceback.format_exception(sys.exc_info()[0],sys.exc_info()[1],sys.exc_info()[2])
 176           raise AsException("impossible d affecter un type au resultat\n",string.join(l[2:]))
 177
 178       # on teste maintenant si la SD est réutilisée ou s'il faut la créer
 179       if self.definition.reentrant != 'n' and self.reuse:
 180         # Le concept produit est specifie reutilise (reuse=xxx). C'est une erreur mais non fatale.
 181         # Elle sera traitee ulterieurement.
 182         self.sd=self.reuse
 183       else:
 184         if sd_prod == None:
 185           self.sd=None
 186         else:
 187           self.sd= sd_prod(etape=self)
 188           self.typret=sd_prod
 189           # Si la commande est obligatoirement reentrante et reuse n'a pas ete specifie, c'est une erreur.
 190           # On ne fait rien ici. L'erreur sera traitee par la suite.
 191       return self.sd
 192
 193    def get_type_produit(self,force=0):
 194       """
 195            Retourne le type du concept résultat de l'étape et eventuellement type
 196            les concepts produits "à droite" du signe égal (en entrée)
 197            Deux cas :
 198                   - sd_prod de oper n'est pas une fonction
 199                     il s'agit d'une sous classe de ASSD
 200                     on retourne le nom de la classe
 201                   - il s'agit d'une fonction
 202                     on l'évalue avec les mots-clés de l'étape (mc_liste)
 203                     et on retourne son résultat
 204       """
 205       if not force and hasattr(self,'typret'): return self.typret
 206       if type(self.definition.sd_prod) == types.FunctionType:
 207         d=self.cree_dict_valeurs(self.mc_liste)
 208         try:
 209           # Comme sd_prod peut invoquer la méthode type_sdprod qui ajoute
 210           # les concepts produits dans self.sdprods, il faut le mettre à zéro
 211           self.sdprods=[]
 212           sd_prod= apply(self.definition.sd_prod,(self,),d)
 213         except:
 214           #traceback.print_exc()
 215           return None
 216       else:
 217         sd_prod=self.definition.sd_prod
 218       return sd_prod
 219
 220    def get_contexte_avant(self,etape):
 221       """
 222           Retourne le dictionnaire des concepts connus avant etape
 223           pour les commandes internes a la macro
 224           On tient compte des commandes qui modifient le contexte
 225           comme DETRUIRE ou les macros
 226       """
 227       # L'étape courante pour laquelle le contexte a été calculé est
 228       # mémorisée dans self.index_etape_courante
 229       # Si on insère des commandes (par ex, dans EFICAS), il faut
 230       # préalablement remettre ce pointeur à 0
 231       if etape:
 232          index_etape=self.etapes.index(etape)
 233       else:
 234          index_etape=len(self.etapes)
 235
 236       if index_etape >= self.index_etape_courante:
 237          # On calcule le contexte en partant du contexte existant
 238          d=self.current_context
 239          liste_etapes=self.etapes[self.index_etape_courante:index_etape]
 240       else:
 241          d=self.current_context={}
 242          liste_etapes=self.etapes
 243
 244       for e in liste_etapes:
 245         if e is etape:
 246            break
 247         if e.isactif():
 248            e.update_context(d)
 249       self.index_etape_courante=index_etape
 250       return d
 251
 252    def supprime(self):
 253       """
 254          Méthode qui supprime toutes les références arrières afin que
 255          l'objet puisse etre correctement détruit par le garbage collector
 256       """
 257       N_MCCOMPO.MCCOMPO.supprime(self)
 258       self.jdc=None
 259       self.appel=None
 260       if self.sd : self.sd.supprime()
 261       for concept in self.sdprods:
 262          concept.supprime()
 263       for etape in self.etapes:
 264          etape.supprime()
 265
 266    def type_sdprod(self,co,t):
 267       """
 268            Cette methode a pour fonction de typer le concept co avec le type t
 269            dans les conditions suivantes
 270             1. co est un concept produit de self
 271             2. co est un concept libre : on le type et on l attribue à self
 272
 273            Elle enregistre egalement les concepts produits (on fait l hypothese
 274            que la liste sdprods a été correctement initialisee, vide probablement)
 275       """
 276       if not hasattr(co,'etape'):
 277          # Le concept vaut None probablement. On ignore l'appel
 278          return
 279
 280       if co.etape == None:
 281          # le concept est libre
 282          co.etape=self
 283          co.__class__ = t
 284          self.sdprods.append(co)
 285       elif co.etape== self:
 286          # le concept est produit par self
 287          co.__class__ = t
 288          self.sdprods.append(co)
 289       elif co.etape== self.parent:
 290          # le concept est produit par la macro superieure
 291          # on transfere la propriete
 292          # On verifie que le type du concept existant co.__class__ est un sur type de celui attendu
 293          # Cette règle est normalement cohérente avec les règles de vérification des mots-clés
 294          if not issubclass(t,co.__class__):
 295             raise AsException("Le type du concept produit %s devrait etre une sur classe de %s" %(co.__class__,t))
 296          co.etape=self
 297          co.__class__ = t
 298          self.sdprods.append(co)
 299       elif self.issubstep(co.etape):
 300          # Le concept est propriété d'une sous etape de self. Il doit etre considere
 301          # comme produit par la macro => ajout dans self.sdprods
 302          self.sdprods.append(co)
 303       else:
 304          # le concept est produit par une autre étape
 305          return
 306
 307    def issubstep(self,etape):
 308       """
 309           Cette methode retourne un entier indiquant si etape est une
 310           sous etape de la macro self ou non
 311           1 = oui
 312           0 = non
 313       """
 314       if etape in self.etapes:return 1
 315       for etap in self.etapes:
 316         if etap.issubstep(etape):return 1
 317       return 0
 318
 319    def register(self,etape):
 320       """
 321           Enregistrement de etape dans le contexte de la macro : liste etapes
 322           et demande d enregistrement global aupres du JDC
 323       """
 324       self.etapes.append(etape)
 325       idetape=self.jdc.g_register(etape)
 326       return idetape
 327
 328    def reg_sd(self,sd):
 329       """
 330            Methode appelee dans l __init__ d un ASSD a sa creation pour
 331            s enregistrer (reserve aux ASSD créés au sein d'une MACRO)
 332       """
 333       self.sds.append(sd)
 334       return self.jdc.o_register(sd)
 335
 336    def create_sdprod(self,etape,nomsd):
 337       """
 338                   Intention : Cette methode doit fabriquer le concept produit retourne
 339                   par l'etape etape et le nommer.
 340                   Elle est appelée à l'initiative de l'etape
 341                   pendant le processus de construction de cette etape : methode __call__
 342                   de la classe CMD (OPER ou MACRO)
 343                   Ce travail est réalisé par le contexte supérieur (etape.parent)
 344                   car dans certains cas, le concept ne doit pas etre fabriqué mais
 345                   l'etape doit simplement utiliser un concept préexistant.
 346                       - Cas 1 : etape.reuse != None : le concept est réutilisé
 347                       - Cas 2 : l'étape appartient à une macro qui a déclaré un concept
 348                         de sortie qui doit etre produit par cette etape.
 349       """
 350       if self.Outputs.has_key(nomsd):
 351          # Il s'agit d'un concept de sortie de la macro. Il ne faut pas le créer
 352          # Il faut quand meme appeler la fonction sd_prod si elle existe.
 353          # get_type_produit le fait et donne le type attendu par la commande pour verification ultérieure.
 354          sdprod=etape.get_type_produit()
 355          sd=self.Outputs[nomsd]
 356          # On verifie que le type du concept existant sd.__class__ est un sur type de celui attendu
 357          # Cette règle est normalement cohérente avec les règles de vérification des mots-clés
 358          if not issubclass(sdprod,sd.__class__):
 359             raise AsException("Le type du concept produit %s devrait etre une sur classe de %s" %(sd.__class__,sdprod))
 360          # La propriete du concept est transferee a l'etape avec le type attendu par l'étape
 361          etape.sd=sd
 362          sd.etape=etape
 363          # On donne au concept le type produit par la sous commande.
 364          # Le principe est le suivant : apres avoir verifie que le type deduit par la sous commande
 365          # est bien coherent avec celui initialement affecte par la macro (voir ci dessus)
 366          # on affecte au concept ce type car il peut etre plus precis (derive, en general)
 367          sd.__class__=sdprod
 368          # On force également le nom stocké dans l'attribut sdnom : on lui donne le nom
 369          # du concept associé à nomsd
 370          etape.sdnom=sd.nom
 371       elif etape.definition.reentrant != 'n' and etape.reuse != None:
 372          # On est dans le cas d'une commande avec reutilisation d'un concept existant
 373          # get_sd_prod fait le necessaire : verifications, associations, etc. mais ne cree
 374          # pas un nouveau concept. Il retourne le concept reutilise
 375          sd= etape.get_sd_prod()
 376          # Dans le cas d'un concept nomme automatiquement : _xxx, __xxx,
 377          # On force le nom stocke dans l'attribut sdnom  de l'objet etape : on lui donne le nom
 378          # du concept  reutilise (sd ou etape.reuse c'est pareil)
 379          # Ceci est indispensable pour eviter des erreurs lors des verifications des macros
 380          # En effet une commande avec reutilisation d'un concept verifie que le nom de
 381          # la variable a gauche du signe = est le meme que celui du concept reutilise.
 382          # Lorsqu'une telle commande apparait dans une macro, on supprime cette verification.
 383          if (etape.sdnom == '' or etape.sdnom[0] == '_'):
 384             etape.sdnom=sd.nom
 385       else:
 386          # On est dans le cas de la creation d'un nouveau concept
 387          sd= etape.get_sd_prod()
 388          if sd != None :
 389             self.NommerSdprod(sd,nomsd)
 390       return sd
 391
 392    def NommerSdprod(self,sd,sdnom,restrict='non'):
 393       """
 394           Cette methode est appelee par les etapes internes de la macro
 395           La macro appelle le JDC pour valider le nommage
 396           On considere que l espace de nom est unique et géré par le JDC
 397           Si le nom est deja utilise, l appel leve une exception
 398           Si restrict=='non', on insere le concept dans le contexte de la macro
 399           Si restrict=='oui', on n'insere pas le concept dans le contexte de la macro
 400       """
 401       # Normalement, lorsqu'on appelle cette methode, on ne veut nommer que des concepts nouvellement crees.
 402       # Le filtrage sur les concepts a creer ou a ne pas creer est fait dans la methode
 403       # create_sdprod. La seule chose a verifier apres conversion eventuelle du nom
 404       # est de verifier que le nom n'est pas deja attribue. Ceci est fait en delegant
 405       # au JDC par l'intermediaire du parent.
 406
 407       #XXX attention inconsistence : prefix et gcncon ne sont pas
 408       # définis dans le package Noyau. La methode NommerSdprod pour
 409       # les macros devrait peut etre etre déplacée dans Build ???
 410
 411       if CONTEXT.debug : print "MACRO.NommerSdprod: ",sd,sdnom
 412
 413       if hasattr(self,'prefix'):
 414         # Dans le cas de l'include_materiau on ajoute un prefixe au nom du concept
 415         if sdnom != self.prefix:sdnom=self.prefix+sdnom
 416
 417       if self.Outputs.has_key(sdnom):
 418         # Il s'agit d'un concept de sortie de la macro produit par une sous commande
 419         sdnom=self.Outputs[sdnom].nom
 420       elif sdnom != '' and sdnom[0] == '_':
 421         # Si le nom du concept commence par le caractere _ on lui attribue
 422         # un identificateur JEVEUX construit par gcncon et respectant
 423         # la regle gcncon legerement adaptee ici
 424         # nom commencant par __ : il s'agit de concepts qui seront detruits
 425         # nom commencant par _ : il s'agit de concepts intermediaires qui seront gardes
 426         # ATTENTION : il faut traiter différemment les concepts dont le nom
 427         # commence par _ mais qui sont des concepts nommés automatiquement par
 428         # une éventuelle sous macro.
 429         # Le test suivant n'est pas tres rigoureux mais permet de fonctionner pour le moment (a améliorer)
 430         if sdnom[1] in string.digits:
 431           # Ce concept provient probablement d'une macro appelee par self
 432           pass
 433         elif sdnom[1] == '_':
 434           sdnom=self.gcncon('.')
 435         else:
 436           sdnom=self.gcncon('_')
 437       else:
 438         # On est dans le cas d'un nom de concept global.
 439         pass
 440
 441       if restrict == 'non':
 442          # On demande le nommage au parent mais sans ajout du concept dans le contexte du parent
 443          # car on va l'ajouter dans le contexte de la macro
 444          self.parent.NommerSdprod(sd,sdnom,restrict='oui')
 445          # On ajoute dans le contexte de la macro les concepts nommes
 446          # Ceci est indispensable pour les CO (macro) dans un INCLUDE
 447          self.g_context[sdnom]=sd
 448       else:
 449          # La demande de nommage vient probablement d'une macro qui a mis
 450          # le concept dans son contexte. On ne traite plus que le nommage (restrict="oui")
 451          self.parent.NommerSdprod(sd,sdnom,restrict='oui')
 452
 453    def delete_concept_after_etape(self,etape,sd):
 454       """
 455           Met à jour les étapes de la MACRO  qui sont après etape suite à
 456           la disparition du concept sd
 457       """
 458       # Cette methode est définie dans le noyau mais ne sert que pendant la phase de creation
 459       # des etapes et des concepts. Il n'y a aucun traitement particulier à réaliser
 460       # Dans d'autres conditions, il faudrait surcharger cette méthode.
 461       return
 462
 463    def accept(self,visitor):
 464       """
 465          Cette methode permet de parcourir l'arborescence des objets
 466          en utilisant le pattern VISITEUR
 467       """
 468       visitor.visitMACRO_ETAPE(self)
 469
 470    def update_context(self,d):
 471       """
 472          Met à jour le contexte contenu dans le dictionnaire d
 473          Une MACRO_ETAPE peut ajouter plusieurs concepts dans le contexte
 474          Une fonction enregistree dans op_init peut egalement modifier le contexte
 475       """
 476       if type(self.definition.op_init) == types.FunctionType:
 477         apply(self.definition.op_init,(self,d))
 478       if self.sd != None:d[self.sd.nom]=self.sd
 479       for co in self.sdprods:
 480         d[co.nom]=co
 481
 482    def make_include(self,unite=None):
 483       """
 484           Inclut un fichier dont l'unite logique est unite
 485       """
 486       if not unite : return
 487       f,text=self.get_file(unite=unite,fic_origine=self.parent.nom)
 488       self.fichier_init = f
 489       if f == None:return
 490       self.make_contexte(f,text)
 491
 492    def make_poursuite(self):
 493       """
 494           Inclut un fichier poursuite
 495       """
 496       try:
 497          f,text=self.get_file(fic_origine=self.parent.nom)
 498       except:
 499          raise AsException("Impossible d'ouvrir la base pour une poursuite")
 500       self.fichier_init=f
 501       if f == None:return
 502       self.make_contexte(f,text)
 503
 504    def make_contexte(self,f,text):
 505       """
 506           Interprete le texte fourni (text) issu du fichier f
 507           dans le contexte du parent.
 508           Cette methode est utile pour le fonctionnement des
 509           INCLUDE
 510       """
 511       # on execute le texte fourni dans le contexte forme par
 512       # le contexte de l etape pere (global au sens Python)
 513       # et le contexte de l etape (local au sens Python)
 514       code=compile(text,f,'exec')
 515       d={}
 516       self.g_context = d
 517       self.contexte_fichier_init = d
 518       globs=self.parent.get_global_contexte()
 519       exec code in globs,d
 520
 521    def get_global_contexte(self):
 522       """
 523           Cette methode retourne le contexte global fourni
 524           par le parent(self) a une etape fille (l'appelant) pour
 525           realiser des evaluations de texte Python (INCLUDE,...)
 526       """
 527       # Le contexte global est forme par concatenation du contexte
 528       # du parent de self et de celui de l'etape elle meme (self)
 529       d=self.parent.get_global_contexte()
 530       d.update(self.g_context)
 531       return d
 532
 533
 534
 535
 536
 537
 538