1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * [The "BSD license"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Copyright (c) 2010 Terence Parr 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * All rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Redistribution and use in source and binary forms, with or without 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * modification, are permitted provided that the following conditions 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * are met: 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 1. Redistributions of source code must retain the above copyright 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer. 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 2. Redistributions in binary form must reproduce the above copyright 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer in the 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * documentation and/or other materials provided with the distribution. 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 3. The name of the author may not be used to endorse or promote products 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * derived from this software without specific prior written permission. 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpackage org.antlr.tool; 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport org.antlr.runtime.Token; 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic class RuleLabelScope extends AttributeScope { 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Rules have a predefined set of attributes as well as 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the return values. 'text' needs to be computed though so. 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static AttributeScope predefinedRulePropertiesScope = 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver new AttributeScope("RulePredefined",null) {{ 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("text", null); 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("start", null); 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("stop", null); 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("tree", null); 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("st", null); 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver isPredefinedRuleScope = true; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver }}; 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static AttributeScope predefinedTreeRulePropertiesScope = 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver new AttributeScope("RulePredefined",null) {{ 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("text", null); 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("start", null); // note: no stop; not meaningful 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("tree", null); 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("st", null); 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver isPredefinedRuleScope = true; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver }}; 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static AttributeScope predefinedLexerRulePropertiesScope = 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver new AttributeScope("LexerRulePredefined",null) {{ 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("text", null); 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("type", null); 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("line", null); 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("index", null); 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("pos", null); 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("channel", null); 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("start", null); 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("stop", null); 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver addAttribute("int", null); 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver isPredefinedLexerRuleScope = true; 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver }}; 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static AttributeScope[] grammarTypeToRulePropertiesScope = 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver null, 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver predefinedLexerRulePropertiesScope, // LEXER 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver predefinedRulePropertiesScope, // PARSER 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver predefinedTreeRulePropertiesScope, // TREE_PARSER 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver predefinedRulePropertiesScope, // COMBINED 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver }; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Rule referencedRule; 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public RuleLabelScope(Rule referencedRule, Token actionToken) { 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super("ref_"+referencedRule.name,actionToken); 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.referencedRule = referencedRule; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** If you label a rule reference, you can access that rule's 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * return values as well as any predefined attributes. 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Attribute getAttribute(String name) { 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver AttributeScope rulePropertiesScope = 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver RuleLabelScope.grammarTypeToRulePropertiesScope[grammar.type]; 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( rulePropertiesScope.getAttribute(name)!=null ) { 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return rulePropertiesScope.getAttribute(name); 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( referencedRule.returnScope!=null ) { 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return referencedRule.returnScope.getAttribute(name); 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 101