01: /*
02: [The "BSD licence"]
03: Copyright (c) 2005-2006 Terence Parr
04: All rights reserved.
05:
06: Redistribution and use in source and binary forms, with or without
07: modification, are permitted provided that the following conditions
08: are met:
09: 1. Redistributions of source code must retain the above copyright
10: notice, this list of conditions and the following disclaimer.
11: 2. Redistributions in binary form must reproduce the above copyright
12: notice, this list of conditions and the following disclaimer in the
13: documentation and/or other materials provided with the distribution.
14: 3. The name of the author may not be used to endorse or promote products
15: derived from this software without specific prior written permission.
16:
17: THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18: IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20: IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21: INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22: NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23: DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24: THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25: (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26: THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27: */
28: package org.antlr.runtime;
29:
30: /** Rules that return more than a single value must return an object
31: * containing all the values. Besides the properties defined in
32: * RuleLabelScope.predefinedRulePropertiesScope there may be user-defined
33: * return values. This class simply defines the minimum properties that
34: * are always defined and methods to access the others that might be
35: * available depending on output option such as template and tree.
36: *
37: * Note text is not an actual property of the return value, it is computed
38: * from start and stop using the input stream's toString() method. I
39: * could add a ctor to this so that we can pass in and store the input
40: * stream, but I'm not sure we want to do that. It would seem to be undefined
41: * to get the .text property anyway if the rule matches tokens from multiple
42: * input streams.
43: *
44: * I do not use getters for fields of objects that are used simply to
45: * group values such as this aggregate.
46: */
47: public class ParserRuleReturnScope extends RuleReturnScope {
48: public Token start, stop;
49: }
|