/interpreter/tags/at2dist220411/src/edu/vub/at/objects/ATAbstractGrammar.java

 1/**
 2 * AmbientTalk/2 Project
 3 * ATParsetree.java created on Jul 23, 2006 at 11:17:27 AM
 4 * (c) Programming Technology Lab, 2006 - 2007
 5 * Authors: Tom Van Cutsem & Stijn Mostinckx
 6 * 
 7 * Permission is hereby granted, free of charge, to any person
 8 * obtaining a copy of this software and associated documentation
 9 * files (the "Software"), to deal in the Software without
10 * restriction, including without limitation the rights to use,
11 * copy, modify, merge, publish, distribute, sublicense, and/or
12 * sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following
14 * conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
21 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
22 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
23 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
24 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
25 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26 * OTHER DEALINGS IN THE SOFTWARE.
27 */
28package edu.vub.at.objects;
29
30import edu.vub.at.exceptions.InterpreterException;
31import edu.vub.at.objects.grammar.ATSymbol;
32import edu.vub.at.parser.SourceLocation;
33
34import java.util.Set;
35
36
37/**
38 * ATAbstractGrammar contains all methods to be understood by any parsetree element
39 * in the ambienttalk/2 programming language. As the parsetree is a first-class
40 * entity (it can be manipulated in the language using the MOP) parsetree elements
41 * are also ATObjects.
42 * 
43 * @author smostinc
44 */
45public interface ATAbstractGrammar extends ATObject {
46	
47	/**
48	 * Return a table of {@link ATSymbol} objects representing
49	 * the set of free variables of the Abstract Grammar expression.
50	 */
51	public ATTable base_freeVariables() throws InterpreterException;
52	
53	/**
54	 * @return the free variables of this abstract grammar element
55	 * as a set (whose elements are of type {@link ATSymbol}).
56	 */
57	public abstract Set impl_freeVariables() throws InterpreterException;
58	
59	/**
60     * Should return the set of free variables contained within this AG element,
61     * given that the AG element appears in the context of a quoted expression.
62	 * @return a set of elements of type {@link ATSymbol}).
63	 */
64	public abstract Set impl_quotedFreeVariables() throws InterpreterException;
65
66	/**
67	 * @return the source location of this AG element or null if not set.
68	 */
69	public abstract SourceLocation impl_getLocation();
70	public abstract void impl_setLocation(SourceLocation loc);
71
72}