/interpreter/tags/at2-build190607/src/edu/vub/at/objects/grammar/ATDefTable.java

 1/**
 2 * AmbientTalk/2 Project
 3 * ATDefTable.java created on 26-jul-2006 at 14:52:25
 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 * The public interface to a table definition AG element.
32 * 
33 * Example: <code>def tab[size] { init }</code> where <code>tab</code>
34 * is a literal symbol and <code>size</code> has to evaluate to a number.
35 * The <code>init</code> expression is evaluated <code>size</code> times.
36 * 
37 * @author tvc
38 */
39public interface ATDefTable extends ATDefinition {
40
41	/**
42	 * The name of the table must be a literal symbol
43	 * Example: <code>`{ def tab[5] { m() } }.statements[1].name == `tab</code>
44	 * @return the name of the table
45	 */
46	public ATSymbol base_getName();
47	
48	/**
49	 * The size may be any valid AmbientTalk expression that evaluates to a number
50	 * Example: <code>`{ def tab[5] { m() } }.statements[1].sizeExpression == `5</code>
51	 * @return the size expression
52	 */
53	public ATExpression base_getSizeExpression();
54	
55	/**
56	 * The initializer is at least one expression and may be a sequence of expressions
57	 * Example: <code>`{ def tab[5] { m() } }.statements[1].initializer == `{ m() }</code>
58	 * @return the initializer
59	 */
60	public ATBegin base_getInitializer();
61	
62}