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

 1/**
 2 * AmbientTalk/2 Project
 3 * ATImport.java created on 6-mrt-2007 at 21:17:12
 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.ATTable;
32
33/**
34 * The public interface to a native AST component of the form
35 * 'import <expression> (alias (symbol := symbol)+)? (exclude symbol (, symbol)*)?'
36 *
37 * Examples:
38 * 'import o' => (import (symbol o) (table) (table))
39 * 'import o alias foo := bar' => (import (symbol o) (table (table (symbol foo) (symbol bar))) (table))
40 * 'import o exclude foo, bar:' => (import (symbol o) (table) (table (symbol foo) (symbol bar:)))
41 * 'import o alias a: := b, c := d: exclude e, f =>
42 *      (import (symbol o) (table (table (sym a:) (sym b)) (table (sym c) (sym d:))) (table (sym e) (sym f)))
43 *
44 * @author tvcutsem
45 */
46public interface ATImport extends ATStatement {
47	
48	/**
49	 * Example: <code>`{ import o }.statements[1].importedObjectExpression == `o</code>
50	 * @return the expression that should evaluate to the object to import.
51	 */
52	public ATExpression base_getImportedObjectExpression() throws InterpreterException;
53	
54	/**
55	 * Example: <code>`{ import o alias foo := bar }.statements[1].aliasedSymbols == `[[foo, bar]]</code>
56	 * @return a table of pairs (tables of size two) of symbols that defines the mapping of symbols to alias.
57	 */
58	public ATTable base_getAliasedSymbols() throws InterpreterException;
59	
60	/**
61	 * Example: <code>`{ import o exclude a, b }.statements[1].excludedSymbols == `[a,b]</code>
62	 * @return a table of symbols that represent the symbols to be excluded from the imported object.
63	 */
64	public ATTable base_getExcludedSymbols() throws InterpreterException;
65
66}