Package org.antlr.runtime

Class ParserRuleReturnScope

java.lang.Object

org.antlr.runtime.RuleReturnScope

org.antlr.runtime.ParserRuleReturnScope

Direct Known Subclasses:

ANTLRParser.action_return, ANTLRParser.actions_return, ANTLRParser.actionScopeName_return, ANTLRParser.alternative_return, ANTLRParser.atom_return, ANTLRParser.attrScope_return, ANTLRParser.attrScopes_return, ANTLRParser.block_return, ANTLRParser.defaultNodeOption_return, ANTLRParser.delegateGrammar_return, ANTLRParser.delegateGrammars_return, ANTLRParser.ebnf_return, ANTLRParser.ebnfSuffix_return, ANTLRParser.element_return, ANTLRParser.elementNoOptionSpec_return, ANTLRParser.elementOption_return, ANTLRParser.elementOptionId_return, ANTLRParser.elementOptions_return, ANTLRParser.exceptionGroup_return, ANTLRParser.exceptionHandler_return, ANTLRParser.finallyClause_return, ANTLRParser.grammar__return, ANTLRParser.grammarType_return, ANTLRParser.id_return, ANTLRParser.idList_return, ANTLRParser.label_return, ANTLRParser.notSet_return, ANTLRParser.notTerminal_return, ANTLRParser.option_return, ANTLRParser.optionsSpec_return, ANTLRParser.optionValue_return, ANTLRParser.range_return, ANTLRParser.rewrite_alternative_return, ANTLRParser.rewrite_atom_return, ANTLRParser.rewrite_block_return, ANTLRParser.rewrite_ebnf_return, ANTLRParser.rewrite_element_return, ANTLRParser.rewrite_indirect_template_head_return, ANTLRParser.rewrite_return, ANTLRParser.rewrite_template_arg_return, ANTLRParser.rewrite_template_args_return, ANTLRParser.rewrite_template_head_return, ANTLRParser.rewrite_template_return, ANTLRParser.rewrite_tree_return, ANTLRParser.rewrite_with_sempred_return, ANTLRParser.rule_return, ANTLRParser.ruleAction_return, ANTLRParser.ruleActions_return, ANTLRParser.ruleAltList_return, ANTLRParser.ruleref_return, ANTLRParser.rules_return, ANTLRParser.ruleScopeSpec_return, ANTLRParser.terminal_return, ANTLRParser.throwsSpec_return, ANTLRParser.tokenSpec_return, ANTLRParser.tokensSpec_return, ANTLRParser.tree__return, ANTLRParser.treeRoot_return, ANTLRv3Parser.action_return, ANTLRv3Parser.action_return, ANTLRv3Parser.actionScopeName_return, ANTLRv3Parser.actionScopeName_return, ANTLRv3Parser.alternative_return, ANTLRv3Parser.alternative_return, ANTLRv3Parser.altList_return, ANTLRv3Parser.altList_return, ANTLRv3Parser.altpair_return, ANTLRv3Parser.atom_return, ANTLRv3Parser.atom_return, ANTLRv3Parser.attrScope_return, ANTLRv3Parser.attrScope_return, ANTLRv3Parser.block_return, ANTLRv3Parser.block_return, ANTLRv3Parser.ebnf_return, ANTLRv3Parser.ebnf_return, ANTLRv3Parser.ebnfSuffix_return, ANTLRv3Parser.ebnfSuffix_return, ANTLRv3Parser.element_return, ANTLRv3Parser.element_return, ANTLRv3Parser.elementNoOptionSpec_return, ANTLRv3Parser.elementOption_return, ANTLRv3Parser.elementOptions_return, ANTLRv3Parser.exceptionGroup_return, ANTLRv3Parser.exceptionGroup_return, ANTLRv3Parser.exceptionHandler_return, ANTLRv3Parser.exceptionHandler_return, ANTLRv3Parser.finallyClause_return, ANTLRv3Parser.finallyClause_return, ANTLRv3Parser.grammarDef_return, ANTLRv3Parser.grammarDef_return, ANTLRv3Parser.id_return, ANTLRv3Parser.id_return, ANTLRv3Parser.notSet_return, ANTLRv3Parser.notSet_return, ANTLRv3Parser.notTerminal_return, ANTLRv3Parser.notTerminal_return, ANTLRv3Parser.option_return, ANTLRv3Parser.option_return, ANTLRv3Parser.optionsSpec_return, ANTLRv3Parser.optionsSpec_return, ANTLRv3Parser.optionValue_return, ANTLRv3Parser.optionValue_return, ANTLRv3Parser.qid_return, ANTLRv3Parser.range_return, ANTLRv3Parser.range_return, ANTLRv3Parser.rewrite_alternative_return, ANTLRv3Parser.rewrite_alternative_return, ANTLRv3Parser.rewrite_indirect_template_head_return, ANTLRv3Parser.rewrite_indirect_template_head_return, ANTLRv3Parser.rewrite_return, ANTLRv3Parser.rewrite_return, ANTLRv3Parser.rewrite_template_arg_return, ANTLRv3Parser.rewrite_template_arg_return, ANTLRv3Parser.rewrite_template_args_return, ANTLRv3Parser.rewrite_template_args_return, ANTLRv3Parser.rewrite_template_ref_return, ANTLRv3Parser.rewrite_template_ref_return, ANTLRv3Parser.rewrite_template_return, ANTLRv3Parser.rewrite_template_return, ANTLRv3Parser.rewrite_tree_alternative_return, ANTLRv3Parser.rewrite_tree_alternative_return, ANTLRv3Parser.rewrite_tree_atom_return, ANTLRv3Parser.rewrite_tree_atom_return, ANTLRv3Parser.rewrite_tree_block_return, ANTLRv3Parser.rewrite_tree_block_return, ANTLRv3Parser.rewrite_tree_ebnf_return, ANTLRv3Parser.rewrite_tree_ebnf_return, ANTLRv3Parser.rewrite_tree_element_return, ANTLRv3Parser.rewrite_tree_element_return, ANTLRv3Parser.rewrite_tree_return, ANTLRv3Parser.rewrite_tree_return, ANTLRv3Parser.rule_return, ANTLRv3Parser.rule_return, ANTLRv3Parser.ruleAction_return, ANTLRv3Parser.ruleAction_return, ANTLRv3Parser.ruleScopeSpec_return, ANTLRv3Parser.ruleScopeSpec_return, ANTLRv3Parser.terminal_return, ANTLRv3Parser.terminal_return, ANTLRv3Parser.throwsSpec_return, ANTLRv3Parser.throwsSpec_return, ANTLRv3Parser.tokenSpec_return, ANTLRv3Parser.tokenSpec_return, ANTLRv3Parser.tokensSpec_return, ANTLRv3Parser.tokensSpec_return, ANTLRv3Parser.treeSpec_return, ANTLRv3Parser.treeSpec_return, gUnitParser.file_return, gUnitParser.id_return, gUnitParser.option_return, gUnitParser.treeAdaptor_return, StGUnitParser.id_return, StGUnitParser.output_return

public class ParserRuleReturnScope
extends RuleReturnScope

Rules that return more than a single value must return an object containing all the values. Besides the properties defined in RuleLabelScope.predefinedRulePropertiesScope there may be user-defined return values. This class simply defines the minimum properties that are always defined and methods to access the others that might be available depending on output option such as template and tree. Note text is not an actual property of the return value, it is computed from start and stop using the input stream's toString() method. I could add a ctor to this so that we can pass in and store the input stream, but I'm not sure we want to do that. It would seem to be undefined to get the .text property anyway if the rule matches tokens from multiple input streams. I do not use getters for fields of objects that are used simply to group values such as this aggregate. The getters/setters are there to satisfy the superclass interface.

Field Summary

Fields

Modifier and Type	Field	Description
Token	start
Token	stop

Constructor Summary

Constructors

Constructor	Description
ParserRuleReturnScope()

Method Summary

Modifier and Type	Method	Description
Object	getStart()	Return the start token or tree
Object	getStop()	Return the stop token or tree
Object	getTree()	Has a value potentially if output=AST;

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.antlr.runtime.RuleReturnScope

getTemplate

Field Detail

start

public Token start

stop

public Token stop

Constructor Detail

ParserRuleReturnScope

public ParserRuleReturnScope()

Method Detail

getStart

public Object getStart()

Description copied from class: RuleReturnScope

Return the start token or tree

Overrides:

getStart in class RuleReturnScope

getStop

public Object getStop()

Description copied from class: RuleReturnScope

Return the stop token or tree

Overrides:

getStop in class RuleReturnScope

getTree

public Object getTree()

Description copied from class: RuleReturnScope

Has a value potentially if output=AST;

Overrides:

getTree in class RuleReturnScope