psyclone.psyir.symbols.datatypes.UnsupportedFortranType Class Reference

Inheritance diagram for psyclone.psyir.symbols.datatypes.UnsupportedFortranType:

Collaboration diagram for psyclone.psyir.symbols.datatypes.UnsupportedFortranType:

Public Member Functions
def	__init__ (self, declaration_txt, partial_datatype=None)
def	__str__ (self)
def	partial_datatype (self)
def	type_text (self)
def	__eq__ (self, other)
Public Member Functions inherited from psyclone.psyir.symbols.datatypes.UnsupportedType
def	__init__ (self, declaration_txt)
def	declaration (self)

Detailed Description

Indicates that a Fortran declaration is not supported by the PSyIR.

:param str declaration_txt: string containing the original variable
    declaration.
:param partial_datatype: a PSyIR datatype representing the subset
    of type attributes that are supported.
:type partial_datatype: Optional[
    :py:class:`psyclone.psyir.symbols.DataType` or
    :py:class:`psyclone.psyir.symbols.DataTypeSymbol`]

Definition at line 126 of file datatypes.py.

Member Function Documentation

__eq__()

def psyclone.psyir.symbols.datatypes.UnsupportedFortranType.__eq__	(		self,
			other
	)

:param Any other: the object to check equality to.

:returns: whether this type is equal to the 'other' type.
:rtype: bool

Reimplemented from psyclone.psyir.symbols.datatypes.DataType.

Definition at line 225 of file datatypes.py.

    def __eq__(self, other):
        '''
        :param Any other: the object to check equality to.
 
        :returns: whether this type is equal to the 'other' type.
        :rtype: bool
        '''
        if not super().__eq__(other):
            return False
 
        return other.type_text == self.type_text
 
 

References psyclone.psyir.symbols.datatypes.UnsupportedFortranType.type_text().

Here is the call graph for this function:

__str__()

def psyclone.psyir.symbols.datatypes.UnsupportedFortranType.__str__

(

self

)

 Abstract method that must be implemented in subclass. 

Reimplemented from psyclone.psyir.symbols.datatypes.UnsupportedType.

Definition at line 153 of file datatypes.py.

    def __str__(self):
        return f"UnsupportedFortranType('{self._declaration}')"
 

partial_datatype()

def psyclone.psyir.symbols.datatypes.UnsupportedFortranType.partial_datatype

(

self

)

:returns: partial datatype information if it can be determined,
    else None.
:rtype: Optional[:py:class:`psyclone.symbols.DataType`]

Definition at line 157 of file datatypes.py.

    def partial_datatype(self):
        '''
        :returns: partial datatype information if it can be determined,
            else None.
        :rtype: Optional[:py:class:`psyclone.symbols.DataType`]
        '''
        return self._partial_datatype
 

References psyclone.psyir.symbols.datatypes.UnsupportedFortranType._partial_datatype.

type_text()

def psyclone.psyir.symbols.datatypes.UnsupportedFortranType.type_text

(

self

)

Parses the original Fortran declaration and uses the resulting
parse tree to extract the type information. This is returned in
text form and also cached.

TODO #2137 - alter Unsupported(Fortran)Type so that it is only the
type information that is stored as a string. i.e. remove the name
of the variable being declared. Once that is done this method
won't be required.

Note that UnsupportedFortranType is also used to hold things like
'SAVE :: /my_common/' and thus it is not always possible/appropriate
to extract a type expression.

:returns: the Fortran code specifying the type.
:rtype: str

:raises NotImplementedError: if declaration text cannot be
    extracted from the original Fortran declaration.

Definition at line 166 of file datatypes.py.

    def type_text(self):
        '''
        Parses the original Fortran declaration and uses the resulting
        parse tree to extract the type information. This is returned in
        text form and also cached.
 
        TODO #2137 - alter Unsupported(Fortran)Type so that it is only the
        type information that is stored as a string. i.e. remove the name
        of the variable being declared. Once that is done this method
        won't be required.
 
        Note that UnsupportedFortranType is also used to hold things like
        'SAVE :: /my_common/' and thus it is not always possible/appropriate
        to extract a type expression.
 
        :returns: the Fortran code specifying the type.
        :rtype: str
 
        :raises NotImplementedError: if declaration text cannot be
            extracted from the original Fortran declaration.
 
        '''
        if self._type_text:
            return self._type_text
 
        # Encapsulate fparser2 functionality here.
        # pylint:disable=import-outside-toplevel
        from fparser.common.readfortran import FortranStringReader
        from fparser.common.sourceinfo import FortranFormat
        from fparser.two import Fortran2003
        from fparser.two.parser import ParserFactory
        string_reader = FortranStringReader(self._declaration)
        # Set reader to free format.
        string_reader.set_format(FortranFormat(True, False))
        ParserFactory().create(std="f2008")
        try:
            ptree = Fortran2003.Specification_Part(
                string_reader)
        except Exception as err:
            raise NotImplementedError(
                f"Cannot extract the declaration part from UnsupportedFortran"
                f"Type '{self._declaration}' because parsing (attempting to "
                f"match a Fortran2003.Specification_Part) failed.") from err
        node = ptree.children[0]
        if isinstance(node, (Fortran2003.Declaration_Construct,
                             Fortran2003.Type_Declaration_Stmt)):
            self._type_text = str(node.children[0])
        elif isinstance(node, Fortran2003.Save_Stmt):
            self._type_text = "SAVE"
        elif isinstance(node, Fortran2003.Common_Stmt):
            self._type_text = "COMMON"
        else:
            raise NotImplementedError(
                f"Cannot extract the declaration part from UnsupportedFortran"
                f"Type '{self._declaration}'. Only Declaration_Construct, "
                f"Type_Declaration_Stmt, Save_Stmt and Common_Stmt are "
                f"supported but got '{type(node).__name__}' from the parser.")
        return self._type_text
 

References psyclone.psyir.symbols.datatypes.UnsupportedType._declaration, and psyclone.psyir.symbols.datatypes.UnsupportedFortranType._type_text.

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/psyir/symbols/datatypes.py