Interface IASTReturnStatement

  • All Superinterfaces:
    IASTAttributeOwner, IASTNode, IASTStatement

    public interface IASTReturnStatement
    extends IASTStatement
    Restriction:
    This interface is not intended to be implemented by clients.
    Restriction:
    This interface is not intended to be extended by clients.
    • Method Detail

      • getReturnValue

        IASTExpression getReturnValue()
        This is the optional return value for this function.
        Returns:
        the return expression or null.
      • setReturnArgument

        void setReturnArgument​(IASTInitializerClause returnValue)
        Not allowed on frozen AST.
        Since:
        5.2
      • setReturnValue

        void setReturnValue​(IASTExpression returnValue)
        Not allowed on frozen AST.
      • copy

        IASTReturnStatement copy()
        Description copied from interface: IASTNode
        Returns a mutable copy of the tree rooted at this node. The following postconditions hold:
         copy.getParent() == null
         copy.getPropertyInParent() == null
         copy.isFrozen() == false
         
        Preprocessor nodes do not currently support being copied. Implicit name nodes are not copied, instead they can be regenerated if required.

        Calling this method is equivalent to copy(CopyStyle.withoutLocations).

        Specified by:
        copy in interface IASTNode
        Specified by:
        copy in interface IASTStatement
        Since:
        5.1
      • copy

        IASTReturnStatement copy​(IASTNode.CopyStyle style)
        Description copied from interface: IASTNode
        Returns a mutable copy of the tree rooted at this node. The following postconditions hold:
         copy.getParent() == null
         copy.getPropertyInParent() == null
         copy.isFrozen() == false
         
        Preprocessor nodes do not currently support being copied. Implicit name nodes are not copied, instead they can be regenerated if required.
        Specified by:
        copy in interface IASTNode
        Specified by:
        copy in interface IASTStatement
        Parameters:
        style - IASTNode.CopyStyle create a copy with or without locations. Please see IASTNode.CopyStyle for restrictions on copies with Locations.
        Since:
        5.3