psyclone.f2pygen.BaseGen Class Reference

Inheritance diagram for psyclone.f2pygen.BaseGen:

Public Member Functions
def	__init__ (self, parent, root)
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

 The base class for all classes that are responsible for generating
distinct code elements (modules, subroutines, do loops etc.) 

Definition at line 173 of file f2pygen.py.

Member Function Documentation

add()

def psyclone.f2pygen.BaseGen.add	(		self,
			new_object,
			position = None
	)

Adds a new object to the tree. The actual position is determined by
the position argument. Note, there are two trees, the first is
the f2pygen object tree, the other is the f2py generated code
tree. These are similar but different. At the moment we
specify where to add things in terms of the f2pygen tree
(which is a higher level api) but we also insert into the f2py
tree at exactly the same location which needs to be sorted out
at some point.

Reimplemented in psyclone.f2pygen.IfThenGen.

Definition at line 196 of file f2pygen.py.

    def add(self, new_object, position=None):
        '''Adds a new object to the tree. The actual position is determined by
        the position argument. Note, there are two trees, the first is
        the f2pygen object tree, the other is the f2py generated code
        tree. These are similar but different. At the moment we
        specify where to add things in terms of the f2pygen tree
        (which is a higher level api) but we also insert into the f2py
        tree at exactly the same location which needs to be sorted out
        at some point.
 
        '''
 
        # By default the position is 'append'. 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 = ["append"]
 
        if position[0] == "auto":
            raise Exception("Error: BaseGen:add: auto option must be "
                            "implemented by the sub class!")
        options = ["append", "first", "after", "before", "insert",
                   "before_index", "after_index"]
        if position[0] not in options:
            raise Exception(f"Error: BaseGen:add: supported positions are "
                            f"{options} but found {position[0]}")
        if position[0] == "append":
            self.root.content.append(new_object.root)
        elif position[0] == "first":
            self.root.content.insert(0, new_object.root)
        elif position[0] == "insert":
            index = position[1]
            self.root.content.insert(index, new_object.root)
        elif position[0] == "after":
            idx = index_of_object(self.root.content, position[1])
            self.root.content.insert(idx+1, new_object.root)
        elif position[0] == "after_index":
            self.root.content.insert(position[1]+1, new_object.root)
        elif position[0] == "before_index":
            self.root.content.insert(position[1], new_object.root)
        elif position[0] == "before":
            try:
                idx = index_of_object(self.root.content, position[1])
            except Exception as err:
                print(str(err))
                raise RuntimeError(
                    "Failed to find supplied object in existing content - "
                    "is it a child of the parent?")
            self.root.content.insert(idx, new_object.root)
        else:
            raise Exception("Error: BaseGen:add: internal error, should "
                            "not get to here")
        self.children.append(new_object)
 

References psyclone.f2pygen.BaseGen.children(), psyclone.psyGen.InlinedKern.children, psyclone.psyir.nodes.node.Node.children(), 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:

children()

def psyclone.f2pygen.BaseGen.children

(

self

)

 Returns the list of children of this object 

Definition at line 187 of file f2pygen.py.

    def children(self):
        ''' Returns the list of children of this object '''
        return self._children
 

References psyclone.f2pygen.BaseGen._children, psyclone.psyir.nodes.node.Node._children, and psyclone.psyir.nodes.omp_directives.OMPParallelDirective._children.

Here is the caller graph for this function:

last_declaration()

def psyclone.f2pygen.BaseGen.last_declaration

(

self

)

Returns the *last* occurrence of a Declaration in the list of
    siblings of this node

Definition at line 261 of file f2pygen.py.

    def last_declaration(self):
        '''Returns the *last* occurrence of a Declaration in the list of
            siblings of this node
 
        '''
        from fparser.one.typedecl_statements import TypeDeclarationStatement
        for sibling in reversed(self.root.content):
            if isinstance(sibling, TypeDeclarationStatement):
                return sibling
 
        raise RuntimeError("Error, no variable declarations found")
 

References psyclone.f2pygen.BaseGen.root(), psyclone.f2pygen.BaseDeclGen.root(), and psyclone.psyir.nodes.node.Node.root().

Here is the call graph for this function:

parent()

def psyclone.f2pygen.BaseGen.parent

(

self

)

 Returns the parent of this object 

Definition at line 182 of file f2pygen.py.

    def parent(self):
        ''' Returns the parent of this object '''
        return self._parent
 

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._parent, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._parent, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg._parent, psyclone.domain.lfric.lfric_kern.LFRicKern._parent, psyclone.f2pygen.BaseGen._parent, and psyclone.psyir.nodes.node.Node._parent.

Here is the caller graph for this function:

previous_loop()

def psyclone.f2pygen.BaseGen.previous_loop

(

self

)

 Returns the *last* occurrence of a loop in the list of
siblings of this node 

Definition at line 252 of file f2pygen.py.

    def previous_loop(self):
        ''' Returns the *last* occurrence of a loop in the list of
        siblings of this node '''
        from fparser.one.block_statements import Do
        for sibling in reversed(self.root.content):
            if isinstance(sibling, Do):
                return sibling
        raise RuntimeError("Error, no loop found - there is no previous loop")
 

References psyclone.f2pygen.BaseGen.root(), psyclone.f2pygen.BaseDeclGen.root(), and psyclone.psyir.nodes.node.Node.root().

Here is the call graph for this function:

root()

def psyclone.f2pygen.BaseGen.root

(

self

)

 Returns the root of the tree containing this object 

Reimplemented in psyclone.f2pygen.BaseDeclGen.

Definition at line 192 of file f2pygen.py.

    def root(self):
        ''' Returns the root of the tree containing this object '''
        return self._root
 

References psyclone.f2pygen.BaseGen._root.

Here is the caller graph for this function:

start_parent_loop()

def psyclone.f2pygen.BaseGen.start_parent_loop	(		self,
			debug = False
	)

 Searches for the outer-most loop containing this object. Returns
the index of that line in the content of the parent. 

Definition at line 273 of file f2pygen.py.

    def start_parent_loop(self, debug=False):
        ''' Searches for the outer-most loop containing this object. Returns
        the index of that line in the content of the parent. '''
        from fparser.one.block_statements import Do
        if debug:
            print("Entered before_parent_loop")
            print(f"The type of the current node is {type(self.root)}")
            print(("If the current node is a Do loop then move up to the "
                   "top of the do loop nest"))
 
        # First off, check that we do actually have an enclosing Do loop
        current = self.root
        while not isinstance(current, Do) and getattr(current, 'parent', None):
            current = current.parent
        if not isinstance(current, Do):
            raise RuntimeError("This node has no enclosing Do loop")
 
        current = self.root
        local_current = self
        while isinstance(current.parent, Do):
            if debug:
                print("Parent is a do loop so moving to the parent")
            current = current.parent
            local_current = local_current.parent
        if debug:
            print("The type of the current node is now " + str(type(current)))
            print("The type of parent is " + str(type(current.parent)))
            print("Finding the loops position in its parent ...")
        index = current.parent.content.index(current)
        if debug:
            print("The loop's index is ", index)
        parent = current.parent
        local_current = local_current.parent
        if debug:
            print("The type of the object at the index is " +
                  str(type(parent.content[index])))
            print("If preceding node is a directive then move back one")
        if index == 0:
            if debug:
                print("current index is 0 so finish")
        elif isinstance(parent.content[index-1], Directive):
            if debug:
                print(
                    f"preceding node is a directive so find out what type ..."
                    f"\n type is {parent.content[index-1].position}"
                    f"\n diretive is {parent.content[index-1]}")
            if parent.content[index-1].position == "begin":
                if debug:
                    print("type of directive is begin so move back one")
                index -= 1
            else:
                if debug:
                    print("directive type is not begin so finish")
        else:
            if debug:
                print("preceding node is not a directive so finish")
        if debug:
            print("type of final location ", type(parent.content[index]))
            print("code for final location ", str(parent.content[index]))
        return local_current, parent.content[index]
 
 

References psyclone.f2pygen.BaseGen.root(), psyclone.f2pygen.BaseDeclGen.root(), and psyclone.psyir.nodes.node.Node.root().

Here is the call 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