first scanner /parser copied from the jdt java version
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / compiler / ast / MessageSend.java
diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/MessageSend.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/MessageSend.java
new file mode 100644 (file)
index 0000000..fd761cc
--- /dev/null
@@ -0,0 +1,307 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2001, 2002 International Business Machines Corp. and others.
+ * All rights reserved. This program and the accompanying materials 
+ * are made available under the terms of the Common Public License v0.5 
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v05.html
+ * 
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ ******************************************************************************/
+package net.sourceforge.phpdt.internal.compiler.ast;
+
+import net.sourceforge.phpdt.internal.compiler.IAbstractSyntaxTreeVisitor;
+import net.sourceforge.phpdt.internal.compiler.impl.*;
+import net.sourceforge.phpdt.internal.compiler.flow.*;
+import net.sourceforge.phpdt.internal.compiler.codegen.*;
+import net.sourceforge.phpdt.internal.compiler.lookup.*;
+
+public class MessageSend extends Expression implements InvocationSite {
+       public Expression receiver ;
+       public char[] selector ;
+       public Expression[] arguments ;
+       public MethodBinding binding, codegenBinding;
+
+       public long nameSourcePosition ; //(start<<32)+end
+
+       MethodBinding syntheticAccessor;
+
+       public TypeBinding receiverType, qualifyingType;
+       
+public MessageSend() {
+       
+}
+public FlowInfo analyseCode(BlockScope currentScope, FlowContext flowContext, FlowInfo flowInfo) {
+
+       flowInfo = receiver.analyseCode(currentScope, flowContext, flowInfo, !binding.isStatic()).unconditionalInits();
+       if (arguments != null) {
+               int length = arguments.length;
+               for (int i = 0; i < length; i++) {
+                       flowInfo = arguments[i].analyseCode(currentScope, flowContext, flowInfo).unconditionalInits();
+               }
+       }
+       ReferenceBinding[] thrownExceptions;
+       if ((thrownExceptions = binding.thrownExceptions) != NoExceptions) {
+               // must verify that exceptions potentially thrown by this expression are caught in the method
+               flowContext.checkExceptionHandlers(thrownExceptions, this, flowInfo, currentScope);
+       }
+       // if invoking through an enclosing instance, then must perform the field generation -- only if reachable
+       manageEnclosingInstanceAccessIfNecessary(currentScope);
+       manageSyntheticAccessIfNecessary(currentScope); 
+       return flowInfo;
+}
+/**
+ * MessageSend code generation
+ *
+ * @param currentScope org.eclipse.jdt.internal.compiler.lookup.BlockScope
+ * @param codeStream org.eclipse.jdt.internal.compiler.codegen.CodeStream
+ * @param valueRequired boolean
+ */ 
+public void generateCode(BlockScope currentScope, CodeStream codeStream, boolean valueRequired) {
+
+       int pc = codeStream.position;
+
+       // generate receiver/enclosing instance access
+       boolean isStatic = codegenBinding.isStatic();
+       // outer access ?
+       if (!isStatic && ((bits & DepthMASK) != 0) && (receiver == ThisReference.ThisImplicit)){
+               // outer method can be reached through emulation if implicit access
+               Object[] path = currentScope.getExactEmulationPath(currentScope.enclosingSourceType().enclosingTypeAt((bits & DepthMASK) >> DepthSHIFT));
+               if (path == null) {
+                       // emulation was not possible (should not happen per construction)
+                       currentScope.problemReporter().needImplementation();
+               } else {
+                       codeStream.generateOuterAccess(path, this, currentScope);
+               }
+       } else {
+               receiver.generateCode(currentScope, codeStream, !isStatic);
+       }
+       // generate arguments
+       if (arguments != null){
+               for (int i = 0, max = arguments.length; i < max; i++){
+                       arguments[i].generateCode(currentScope, codeStream, true);
+               }
+       }
+       // actual message invocation
+       if (syntheticAccessor == null){
+               if (isStatic){
+                       codeStream.invokestatic(codegenBinding);
+               } else {
+                       if( (receiver.isSuper()) || codegenBinding.isPrivate()){
+                               codeStream.invokespecial(codegenBinding);
+                       } else {
+                               if (codegenBinding.declaringClass.isInterface()){
+                                       codeStream.invokeinterface(codegenBinding);
+                               } else {
+                                       codeStream.invokevirtual(codegenBinding);
+                               }
+                       }
+               }
+       } else {
+               codeStream.invokestatic(syntheticAccessor);
+       }
+       // operation on the returned value
+       if (valueRequired){
+               // implicit conversion if necessary
+               codeStream.generateImplicitConversion(implicitConversion);
+       } else {
+               // pop return value if any
+               switch(binding.returnType.id){
+                       case T_long :
+                       case T_double :
+                               codeStream.pop2();
+                               break;
+                       case T_void :
+                               break;
+                       default:
+                               codeStream.pop();
+               }
+       }
+       codeStream.recordPositionsFrom(pc, (int)(this.nameSourcePosition >>> 32)); // highlight selector
+}
+public boolean isSuperAccess() {       
+       return receiver.isSuper();
+}
+public boolean isTypeAccess() {        
+       return receiver != null && receiver.isTypeReference();
+}
+public void manageEnclosingInstanceAccessIfNecessary(BlockScope currentScope) {
+       if (((bits & DepthMASK) != 0) && !binding.isStatic() && (receiver == ThisReference.ThisImplicit)) {
+               ReferenceBinding compatibleType = currentScope.enclosingSourceType();
+               // the declaringClass of the target binding must be compatible with the enclosing
+               // type at <depth> levels outside
+               for (int i = 0, depth = (bits & DepthMASK) >> DepthSHIFT; i < depth; i++) {
+                       compatibleType = compatibleType.enclosingType();
+               }
+               currentScope.emulateOuterAccess((SourceTypeBinding) compatibleType, false); // request cascade of accesses
+       }
+}
+public void manageSyntheticAccessIfNecessary(BlockScope currentScope){
+
+       if (binding.isPrivate()){
+
+               // depth is set for both implicit and explicit access (see MethodBinding#canBeSeenBy)           
+               if (currentScope.enclosingSourceType() != binding.declaringClass){
+               
+                       syntheticAccessor = ((SourceTypeBinding)binding.declaringClass).addSyntheticMethod(binding);
+                       currentScope.problemReporter().needToEmulateMethodAccess(binding, this);
+                       return;
+               }
+
+       } else if (receiver instanceof QualifiedSuperReference){ // qualified super
+
+               // qualified super need emulation always
+               SourceTypeBinding destinationType = (SourceTypeBinding)(((QualifiedSuperReference)receiver).currentCompatibleType);
+               syntheticAccessor = destinationType.addSyntheticMethod(binding);
+               currentScope.problemReporter().needToEmulateMethodAccess(binding, this);
+               return;
+
+       } else if (binding.isProtected()){
+
+               SourceTypeBinding enclosingSourceType;
+               if (((bits & DepthMASK) != 0) 
+                               && binding.declaringClass.getPackage() 
+                                       != (enclosingSourceType = currentScope.enclosingSourceType()).getPackage()){
+
+                       SourceTypeBinding currentCompatibleType = (SourceTypeBinding)enclosingSourceType.enclosingTypeAt((bits & DepthMASK) >> DepthSHIFT);
+                       syntheticAccessor = currentCompatibleType.addSyntheticMethod(binding);
+                       currentScope.problemReporter().needToEmulateMethodAccess(binding, this);
+                       return;
+               }
+       }
+       // if the binding declaring class is not visible, need special action
+       // for runtime compatibility on 1.2 VMs : change the declaring class of the binding
+       // NOTE: from 1.4 on, method's declaring class is touched if any different from receiver type
+       // and not from Object or implicit static method call.  
+       if (binding.declaringClass != this.qualifyingType
+               && !this.qualifyingType.isArrayType()
+               && ((currentScope.environment().options.complianceLevel >= CompilerOptions.JDK1_4
+                               && (receiver != ThisReference.ThisImplicit || !binding.isStatic())
+                               && binding.declaringClass.id != T_Object) // no change for Object methods
+                       || !binding.declaringClass.canBeSeenBy(currentScope))) {
+
+               this.codegenBinding = currentScope.enclosingSourceType().getUpdatedMethodBinding(binding, (ReferenceBinding) this.qualifyingType);
+       }
+}
+
+public TypeBinding resolveType(BlockScope scope) {
+       // Answer the signature return type
+       // Base type promotion
+
+       constant = NotAConstant;
+       this.qualifyingType = this.receiverType = receiver.resolveType(scope); 
+       
+       // will check for null after args are resolved
+       TypeBinding[] argumentTypes = NoParameters;
+       if (arguments != null) {
+               boolean argHasError = false; // typeChecks all arguments 
+               int length = arguments.length;
+               argumentTypes = new TypeBinding[length];
+               for (int i = 0; i < length; i++){
+                       if ((argumentTypes[i] = arguments[i].resolveType(scope)) == null){
+                               argHasError = true;
+                       }
+               }
+               if (argHasError){
+                       MethodBinding closestMethod = null;
+                       if(receiverType instanceof ReferenceBinding) {
+                               // record any selector match, for clients who may still need hint about possible method match
+                               this.codegenBinding = this.binding = scope.findMethod((ReferenceBinding)receiverType, selector, new TypeBinding[]{}, this);
+                       }                       
+                       return null;
+               }
+       }
+       if (this.receiverType == null)
+               return null;
+
+       // base type cannot receive any message
+       if (this.receiverType.isBaseType()) {
+               scope.problemReporter().errorNoMethodFor(this, this.receiverType, argumentTypes);
+               return null;
+       }
+
+       this.codegenBinding = this.binding = 
+               receiver == ThisReference.ThisImplicit
+                       ? scope.getImplicitMethod(selector, argumentTypes, this)
+                       : scope.getMethod(this.receiverType, selector, argumentTypes, this); 
+       if (!binding.isValidBinding()) {
+               if (binding.declaringClass == null) {
+                       if (this.receiverType instanceof ReferenceBinding) {
+                               binding.declaringClass = (ReferenceBinding) this.receiverType;
+                       } else { // really bad error ....
+                               scope.problemReporter().errorNoMethodFor(this, this.receiverType, argumentTypes);
+                               return null;
+                       }
+               }
+               scope.problemReporter().invalidMethod(this, binding);
+               // record the closest match, for clients who may still need hint about possible method match
+               if (binding.problemId() == ProblemReasons.NotFound){
+                       this.codegenBinding = this.binding = ((ProblemMethodBinding)binding).closestMatch;
+               }
+               return null;
+       }
+       if (!binding.isStatic()) {
+               // the "receiver" must not be a type, i.e. a NameReference that the TC has bound to a Type
+               if (receiver instanceof NameReference) {
+                       if ((((NameReference) receiver).bits & BindingIds.TYPE) != 0) {
+                               scope.problemReporter().mustUseAStaticMethod(this, binding);
+                               return null;
+                       }
+               }
+       }
+       if (arguments != null)
+               for (int i = 0; i < arguments.length; i++)
+                       arguments[i].implicitWidening(binding.parameters[i], argumentTypes[i]);
+
+       //-------message send that are known to fail at compile time-----------
+       if (binding.isAbstract()) {
+               if (receiver.isSuper()) {
+                       scope.problemReporter().cannotDireclyInvokeAbstractMethod(this, binding);
+                       return null;
+               }
+               // abstract private methods cannot occur nor abstract static............
+       }
+       if (isMethodUseDeprecated(binding, scope))
+               scope.problemReporter().deprecatedMethod(binding, this);
+
+       return binding.returnType;
+}
+public void setActualReceiverType(ReferenceBinding receiverType) {
+       this.qualifyingType = receiverType;
+}
+public void setDepth(int depth) {
+       if (depth > 0) {
+               bits &= ~DepthMASK; // flush previous depth if any
+               bits |= (depth & 0xFF) << DepthSHIFT; // encoded on 8 bits
+       }
+}
+public void setFieldIndex(int depth) {
+       // ignore for here
+}
+
+public String toStringExpression(){
+       
+       String s = ""; //$NON-NLS-1$
+       if (receiver != ThisReference.ThisImplicit)
+               s = s + receiver.toStringExpression()+"."; //$NON-NLS-1$
+       s = s + new String(selector) + "(" ; //$NON-NLS-1$
+       if (arguments != null)
+               for (int i = 0; i < arguments.length ; i ++)
+               {       s = s + arguments[i].toStringExpression();
+                       if ( i != arguments.length -1 ) s = s + " , " ;};; //$NON-NLS-1$
+       s =s + ")" ; //$NON-NLS-1$
+       return s;
+}
+
+public void traverse(IAbstractSyntaxTreeVisitor visitor, BlockScope blockScope) {
+       if (visitor.visit(this, blockScope)) {
+               receiver.traverse(visitor, blockScope);
+               if (arguments != null) {
+                       int argumentsLength = arguments.length;
+                       for (int i = 0; i < argumentsLength; i++)
+                               arguments[i].traverse(visitor, blockScope);
+               }
+       }
+       visitor.endVisit(this, blockScope);
+}
+}