Inheritance diagram for psyclone.f2pygen.ProgUnitGen:

[legend]

Collaboration diagram for psyclone.f2pygen.ProgUnitGen:

Public Member Functions
def	__init__ (self, parent, sub)

def	add (self, content, position=None, bubble_up=False)

Public Member Functions inherited from psyclone.f2pygen.BaseGen
def	parent (self)

def	children (self)

def	root (self)

def	add (self, new_object, position=None)

def	previous_loop (self)

def	last_declaration (self)

def	start_parent_loop (self, debug=False)

Detailed Description

 Functionality relevant to program units (currently modules,
subroutines)

Definition at line 335 of file f2pygen.py.

Member Function Documentation

◆ add()

def psyclone.f2pygen.ProgUnitGen.add	(	self,
		content,
		position = `None`,
		bubble_up = `False`
	)

Specialise the add method to provide module- and subroutine-
-specific intelligent adding of use statements, implicit
none statements and declarations if the position argument
is set to auto (which is the default).

:param content: the Node (or sub-tree of Nodes) to add in to \
                the AST.
:type content: :py:class:`psyclone.f2pygen.BaseGen`
:param list position: where to insert the node. One of "append", \
                      "first", "insert", "after", "after_index", \
                      "before_index", "before" or "auto". For the \
                      *_index options, the second element of the \
                      list holds the integer index.
:param bool bubble_up: whether or not object (content) is in the \
                       process of being bubbled-up.

Definition at line 341 of file f2pygen.py.

     def add(self, content, position=None, bubble_up=False):
         '''
         Specialise the add method to provide module- and subroutine-
         -specific intelligent adding of use statements, implicit
         none statements and declarations if the position argument
         is set to auto (which is the default).
  
         :param content: the Node (or sub-tree of Nodes) to add in to \
                         the AST.
         :type content: :py:class:`psyclone.f2pygen.BaseGen`
         :param list position: where to insert the node. One of "append", \
                               "first", "insert", "after", "after_index", \
                               "before_index", "before" or "auto". For the \
                               *_index options, the second element of the \
                               list holds the integer index.
         :param bool bubble_up: whether or not object (content) is in the \
                                process of being bubbled-up.
         '''
         # By default the position is 'auto'. We set it up this way for
         # safety because in python, default arguments are instantiated
         # as objects at the time of definition. If this object is
         # subsequently modified then the value of the default argument
         # is modified for subsequent calls of this routine.
         if position is None:
             position = ["auto"]
  
         # For an object to be added to another we require that they
         # share a common ancestor. This means that the added object must
         # have the current object or one of its ancestors as an ancestor.
         # Loop over the ancestors of this object (starting with itself)
         self_ancestor = self.root
         while self_ancestor:
             # Loop over the ancestors of the object being added
             obj_parent = content.root.parent
             while (obj_parent != self_ancestor and
                    getattr(obj_parent, 'parent', None)):
                 obj_parent = obj_parent.parent
             if obj_parent == self_ancestor:
                 break
             # Object being added is not an ancestor of the current
             # self_ancestor so move one level back up the tree and
             # try again
             if getattr(self_ancestor, 'parent', None):
                 self_ancestor = self_ancestor.parent
             else:
                 break
  
         if obj_parent != self_ancestor:
             raise RuntimeError(
                 f"Cannot add '{content}' to '{self}' because it is not a "
                 f"descendant of it or of any of its ancestors.")
  
         if bubble_up:
             # If content has been passed on (is being bubbled up) then change
             # its parent to be this object
             content.root.parent = self.root
  
         if position[0] != "auto":
             # position[0] is not 'auto' so the baseclass can deal with it
             BaseGen.add(self, content, position)
         else:
             # position[0] == "auto" so insert in a context sensitive way
             if isinstance(content, BaseDeclGen):
  
                 if isinstance(content, (DeclGen, CharDeclGen)):
                     # have I already been declared?
                     for child in self._children:
                         if isinstance(child, (DeclGen, CharDeclGen)):
                             # is this declaration the same type as me?
                             if child.root.name == content.root.name:
                                 # we are modifying the list so we need
                                 # to iterate over a copy
                                 for var_name in content.root.entity_decls[:]:
                                     for child_name in child.root.entity_decls:
                                         if var_name.lower() == \
                                            child_name.lower():
                                             content.root.entity_decls.\
                                                 remove(var_name)
                                             if not content.root.entity_decls:
                                                 # return as all variables in
                                                 # this declaration already
                                                 # exist
                                                 return
                 if isinstance(content, TypeDeclGen):
                     # have I already been declared?
                     for child in self._children:
                         if isinstance(child, TypeDeclGen):
                             # is this declaration the same type as me?
                             if child.root.selector[1] == \
                                content.root.selector[1]:
                                 # we are modifying the list so we need
                                 # to iterate over a copy
                                 for var_name in content.root.entity_decls[:]:
                                     for child_name in child.root.entity_decls:
                                         if var_name.lower() == \
                                            child_name.lower():
                                             content.root.entity_decls.\
                                                 remove(var_name)
                                             if not content.root.entity_decls:
                                                 # return as all variables in
                                                 # this declaration already
                                                 # exist
                                                 return
  
                 index = 0
                 # skip over any use statements
                 index = self._skip_use_and_comments(index)
                 # skip over implicit none if it exists
                 index = self._skip_imp_none_and_comments(index)
                 # skip over any declarations which have an intent
                 try:
                     intent = True
                     while intent:
                         intent = False
                         for attr in self.root.content[index].attrspec:
                             if attr.find("intent") == 0:
                                 intent = True
                                 index += 1
                                 break
                 except AttributeError:
                     pass
             elif isinstance(content.root, fparser1.statements.Use):
                 # have I already been declared?
                 for child in self._children:
                     if isinstance(child, UseGen):
                         if child.root.name == content.root.name:
                             # found an existing use with the same name
                             if not child.root.isonly and not \
                                content.root.isonly:
                                 # both are generic use statements so
                                 # skip this declaration
                                 return
                             if child.root.isonly and not content.root.isonly:
                                 # new use is generic and existing use
                                 # is specific so we can safely add
                                 pass
                             if not child.root.isonly and content.root.isonly:
                                 # existing use is generic and new use
                                 # is specific so we can skip this
                                 # declaration
                                 return
                             if child.root.isonly and content.root.isonly:
                                 # we are modifying the list so we need
                                 # to iterate over a copy
                                 for new_name in content.root.items[:]:
                                     for existing_name in child.root.items:
                                         if existing_name.lower() == \
                                            new_name.lower():
                                             content.root.items.remove(new_name)
                                             if not content.root.items:
                                                 return
                 index = 0
             elif isinstance(content, ImplicitNoneGen):
                 # does implicit none already exist?
                 for child in self._children:
                     if isinstance(child, ImplicitNoneGen):
                         return
                 # skip over any use statements
                 index = 0
                 index = self._skip_use_and_comments(index)
             else:
                 index = len(self.root.content) - 1
             self.root.content.insert(index, content.root)
             self._children.append(content)
  

References psyclone.f2pygen.BaseGen._children, psyclone.psyir.nodes.node.Node._children, psyclone.psyir.nodes.omp_directives.OMPParallelDirective._children, psyclone.f2pygen.ProgUnitGen._skip_imp_none_and_comments(), psyclone.f2pygen.ProgUnitGen._skip_use_and_comments(), psyclone.f2pygen.BaseGen.root(), psyclone.f2pygen.BaseDeclGen.root(), and psyclone.psyir.nodes.node.Node.root().

Here is the call graph for this function:

Here is the caller graph for this function:

The documentation for this class was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/f2pygen.py

Public Member Functions

Detailed Description

Member Function Documentation

◆ add()