/interpreter/tags/at2dist030708/src/edu/vub/at/objects/grammar/ATAssignVariable.java

 1/**
 2 * AmbientTalk/2 Project
 3 * ATAssignVariable.java created on 26-jul-2006 at 14:55:05
 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
30
31/**
32 * The public interface to a variable assignment AG element.
33 * 
34 * <p>
35 * Example: <code>x := 5</code>
36 * </p><p>
37 * The left-hand side must be a literal symbol available in the
38 * lexical scope.
39 * </p>
40 *  
41 *  @author tvc
42 */
43public interface ATAssignVariable extends ATAssignment {
44
45	/**
46	 * The name of the variable must be a literal symbol
47	 * Example: <code>`{ x := 5}.statements[1].name == `x</code>
48	 * @return The name of the variable
49	 */
50	public ATSymbol base_name();
51	
52	/**
53	 * The value expression may be any valid AmbientTalk expression.
54	 * Example: <code>`{ x := 5}.statements[1].valueExpression == `5</code>
55	 * @return The expression for the value that will be assigned to the variable
56	 */
57	public ATExpression base_valueExpression();
58	
59}