/interpreter/tags/at2dist091109/src/edu/vub/at/objects/natives/NATMethod.java

  1/**
  2 * AmbientTalk/2 Project
  3 * NATMethod.java created on Jul 24, 2006 at 11:30:35 PM
  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.natives;
 29
 30import edu.vub.at.eval.PartialBinder;
 31import edu.vub.at.exceptions.InterpreterException;
 32import edu.vub.at.exceptions.XTypeMismatch;
 33import edu.vub.at.objects.ATClosure;
 34import edu.vub.at.objects.ATContext;
 35import edu.vub.at.objects.ATMethod;
 36import edu.vub.at.objects.ATObject;
 37import edu.vub.at.objects.ATTable;
 38import edu.vub.at.objects.coercion.NativeTypeTags;
 39import edu.vub.at.objects.grammar.ATBegin;
 40import edu.vub.at.objects.grammar.ATSymbol;
 41import edu.vub.at.objects.mirrors.PrimitiveMethod;
 42import edu.vub.at.util.logging.Logging;
 43
 44/**
 45 * NATMethod implements methods as named functions which are in fact simply containers
 46 * for a name, a table of arguments and a body.
 47 * 
 48 * @author smostinc
 49 * @author tvcutsem
 50 */
 51public class NATMethod extends NATByCopy implements ATMethod {
 52
 53	private final ATSymbol 	name_;
 54	private final ATTable 	parameters_;
 55	private final ATBegin	body_;
 56	private final ATTable	annotations_;
 57	
 58	// partial function denoting a parameter binding algorithm specialized for this method's parameter list
 59	private final PartialBinder parameterBindingFunction_;
 60	
 61	/** construct a new method. This method may raise an exception if the parameter list is illegal. */
 62	public NATMethod(ATSymbol name, ATTable parameters, ATBegin body, ATTable annotations) throws InterpreterException {
 63		name_ 		= name;
 64		parameters_ = parameters;
 65		body_ 		= body;
 66		annotations_= annotations;
 67		
 68		// calculate the parameter binding strategy to use using partial evaluation
 69		parameterBindingFunction_ =
 70			PartialBinder.calculateResidual(name_.base_text().asNativeText().javaValue, parameters);
 71	}
 72	
 73	/**
 74	 * Constructor to be used by primitive methods only.
 75	 */
 76	protected NATMethod(ATSymbol name, ATTable parameters, PrimitiveMethod.PrimitiveBody body, ATTable annotations) {
 77		name_ 		= name;
 78		parameters_ = parameters;
 79		body_ 		= body;
 80		annotations_= annotations;
 81		
 82		PartialBinder parameterBindingFunction;
 83		try {
 84			// calculate the parameter binding strategy to use using partial evaluation
 85			parameterBindingFunction = PartialBinder.calculateResidual(name_.base_text().asNativeText().javaValue, parameters);
 86		} catch (InterpreterException e) {
 87			parameterBindingFunction = null;
 88			// this indicates a bug, primitive methods should not contain erroneous parameter lists
 89			Logging.VirtualMachine_LOG.fatal("error creating primitive method: ",e);
 90		}
 91		parameterBindingFunction_ = parameterBindingFunction;
 92	}
 93
 94	public ATClosure base_wrap(ATObject lexicalScope, ATObject dynamicReceiver) throws InterpreterException {
 95		return new NATClosure(this, lexicalScope, dynamicReceiver);
 96	}
 97	
 98	public ATSymbol base_name() {
 99		return name_;
100	}
101
102	public ATTable base_parameters() {
103		return parameters_;
104	}
105
106	public ATBegin base_bodyExpression() {
107		return body_;
108	}
109	
110	public ATTable base_annotations() throws InterpreterException {
111		return annotations_;
112	}
113	
114	/**
115	 * To apply a function, first bind its parameters to the evaluated arguments within a new call frame.
116	 * This call frame is lexically nested within the current lexical scope.
117	 * 
118	 * This method is invoked via the following paths:
119	 *  - either by directly 'calling a function', in which case this method is applied via NATClosure.base_apply.
120	 *    The closure ensures that the context used is the lexical scope, not the dynamic scope of invocation.
121	 *  - or by 'invoking a method' through an object, in which case this method is applied via NATObject.meta_invoke.
122	 *    The enclosing object ensures that the context is properly initialized with the implementor, the dynamic receiver
123	 *    and the implementor's parent.
124	 * 
125	 * @param arguments the evaluated actual arguments
126	 * @param ctx the context in which to evaluate the method body, where a call frame will be inserted first
127	 * @return the value of evaluating the function body
128	 */
129	public ATObject base_apply(ATTable arguments, ATContext ctx) throws InterpreterException {
130		NATCallframe cf = new NATCallframe(ctx.base_lexicalScope());
131		ATContext evalCtx = ctx.base_withLexicalEnvironment(cf);
132		PartialBinder.defineParamsForArgs(parameterBindingFunction_, evalCtx, arguments);
133		return body_.meta_eval(evalCtx);
134	}
135	
136	/**
137	 * Applies the method in the context given, without first inserting a call frame to bind parameters.
138	 * Arguments are bound directly in the given lexical scope.
139	 * 
140	 * This method is often invoked via its enclosing closure when used to implement various language
141	 * constructs such as object:, mirror:, extend:with: etc.
142	 * 
143	 * @param arguments the evaluated actual arguments
144	 * @param ctx the context in which to evaluate the method body, to be used as-is
145	 * @return the value of evaluating the function body
146	 */
147	public ATObject base_applyInScope(ATTable arguments, ATContext ctx) throws InterpreterException {
148		PartialBinder.defineParamsForArgs(parameterBindingFunction_, ctx, arguments);
149		return body_.meta_eval(ctx);
150	}
151
152	public NATText meta_print() throws InterpreterException {
153		return NATText.atValue("<method:"+name_.meta_print().javaValue+">");
154	}
155	
156	public ATObject meta_clone() throws InterpreterException {
157		return this;
158	}
159
160	public ATMethod asMethod() throws XTypeMismatch {
161		return this;
162	}
163	
164    public ATTable meta_typeTags() throws InterpreterException {
165    	return NATTable.atValue(NATTable.collate(
166    			new ATObject[] { NativeTypeTags._METHOD_, NativeTypeTags._ISOLATE_ },
167    			annotations_.asNativeTable().elements_));
168    }
169
170}