/interpreter/tags/reactive-pattern-matching/src/edu/vub/at/objects/grammar/ATSymbol.java

 1/**
 2 * AmbientTalk/2 Project
 3 * ATSymbol.java created on 26-jul-2006 at 15:10:15
 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.grammar;
29
30import edu.vub.at.exceptions.InterpreterException;
31import edu.vub.at.objects.ATText;
32import edu.vub.at.objects.natives.grammar.AGAssignmentSymbol;
33
34/**
35 * The public interface to a symbol reference AG element.
36 * 
37 * @author tvcutsem
38 */
39public interface ATSymbol extends ATExpression {
40
41	/**
42	 * Transform a symbol into a string.
43	 * Example: <code>`foo.text == "foo"</code>
44	 * @return the text of the symbol
45	 */
46	public ATText base_text() throws InterpreterException;
47	
48	/**
49	 * Returns whether or not the receiver denotes a symbol ending in <tt>:=</tt>.
50	 */
51	public boolean isAssignmentSymbol() throws InterpreterException;
52	
53	/**
54	 * Example: `(foo).asAssignmentSymbol => `foo:=
55	 * @return a symbol denoting the assignment selector for the receiver field name
56	 */
57	public AGAssignmentSymbol asAssignmentSymbol() throws InterpreterException;
58	
59}