1 /*******************************************************************************
2 * Copyright (c) 2000, 2003 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Common Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/cpl-v10.html
9 * IBM Corporation - initial API and implementation
10 *******************************************************************************/
11 package net.sourceforge.phpdt.internal.compiler.lookup;
13 import net.sourceforge.phpdt.core.compiler.CharOperation;
14 import net.sourceforge.phpdt.internal.compiler.env.IBinaryType;
15 import net.sourceforge.phpdt.internal.compiler.env.INameEnvironment;
16 import net.sourceforge.phpdt.internal.compiler.env.NameEnvironmentAnswer;
17 import net.sourceforge.phpdt.internal.compiler.impl.ITypeRequestor;
18 import net.sourceforge.phpdt.internal.compiler.problem.ProblemReporter;
19 import net.sourceforge.phpdt.internal.compiler.util.HashtableOfPackage;
20 import net.sourceforge.phpdt.internal.compiler.util.Util;
21 import net.sourceforge.phpeclipse.internal.compiler.ast.CompilationUnitDeclaration;
23 public class LookupEnvironment implements BaseTypes, ProblemReasons, TypeConstants {
24 // public CompilerOptions options;
25 public ProblemReporter problemReporter;
26 public ITypeRequestor typeRequestor;
28 PackageBinding defaultPackage;
29 ImportBinding[] defaultImports;
30 HashtableOfPackage knownPackages;
31 static final ProblemPackageBinding TheNotFoundPackage = new ProblemPackageBinding(CharOperation.NO_CHAR, NotFound);
32 static final ProblemReferenceBinding TheNotFoundType = new ProblemReferenceBinding(CharOperation.NO_CHAR, NotFound);
34 private INameEnvironment nameEnvironment;
35 private MethodVerifier verifier;
36 private ArrayBinding[][] uniqueArrayBindings;
38 private CompilationUnitDeclaration[] units = new CompilationUnitDeclaration[4];
39 private int lastUnitIndex = -1;
40 private int lastCompletedUnitIndex = -1;
42 // indicate in which step on the compilation we are.
43 // step 1 : build the reference binding
44 // step 2 : conect the hierarchy (connect bindings)
45 // step 3 : build fields and method bindings.
46 private int stepCompleted;
47 final static int BUILD_TYPE_HIERARCHY = 1;
48 final static int CHECK_AND_SET_IMPORTS = 2;
49 final static int CONNECT_TYPE_HIERARCHY = 3;
50 final static int BUILD_FIELDS_AND_METHODS = 4;
51 public LookupEnvironment(ITypeRequestor typeRequestor,ProblemReporter problemReporter, INameEnvironment nameEnvironment) {
52 // CompilerOptions options, ProblemReporter problemReporter, INameEnvironment nameEnvironment) {
53 this.typeRequestor = typeRequestor;
54 // this.options = options;
55 this.problemReporter = problemReporter;
56 this.defaultPackage = new PackageBinding(this); // assume the default package always exists
57 this.defaultImports = null;
58 this.nameEnvironment = nameEnvironment;
59 this.knownPackages = new HashtableOfPackage();
60 this.uniqueArrayBindings = new ArrayBinding[5][];
61 this.uniqueArrayBindings[0] = new ArrayBinding[50]; // start off the most common 1 dimension array @ 50
63 /* Ask the oracle for a type which corresponds to the compoundName.
64 * Answer null if the name cannot be found.
67 public ReferenceBinding askForType(char[][] compoundName) {
68 NameEnvironmentAnswer answer = nameEnvironment.findType(compoundName);
72 if (answer.isBinaryType())
73 // the type was found as a .class file
74 typeRequestor.accept(answer.getBinaryType(), computePackageFrom(compoundName));
75 else if (answer.isCompilationUnit())
76 // the type was found as a .java file, try to build it then search the cache
77 typeRequestor.accept(answer.getCompilationUnit());
78 else if (answer.isSourceType())
79 // the type was found as a source model
80 typeRequestor.accept(answer.getSourceTypes(), computePackageFrom(compoundName));
82 return getCachedType(compoundName);
84 /* Ask the oracle for a type named name in the packageBinding.
85 * Answer null if the name cannot be found.
88 ReferenceBinding askForType(PackageBinding packageBinding, char[] name) {
89 if (packageBinding == null) {
90 if (defaultPackage == null)
92 packageBinding = defaultPackage;
94 NameEnvironmentAnswer answer = nameEnvironment.findType(name, packageBinding.compoundName);
98 if (answer.isBinaryType())
99 // the type was found as a .class file
100 typeRequestor.accept(answer.getBinaryType(), packageBinding);
101 else if (answer.isCompilationUnit())
102 // the type was found as a .java file, try to build it then search the cache
103 typeRequestor.accept(answer.getCompilationUnit());
104 else if (answer.isSourceType())
105 // the type was found as a source model
106 typeRequestor.accept(answer.getSourceTypes(), packageBinding);
108 return packageBinding.getType0(name);
110 /* Create the initial type bindings for the compilation unit.
112 * See completeTypeBindings() for a description of the remaining steps
114 * NOTE: This method can be called multiple times as additional source files are needed
117 public void buildTypeBindings(CompilationUnitDeclaration unit) {
118 CompilationUnitScope scope = new CompilationUnitScope(unit, this);
119 scope.buildTypeBindings();
121 int unitsLength = units.length;
122 if (++lastUnitIndex >= unitsLength)
123 System.arraycopy(units, 0, units = new CompilationUnitDeclaration[2 * unitsLength], 0, unitsLength);
124 units[lastUnitIndex] = unit;
126 /* Cache the binary type since we know it is needed during this compile.
128 * Answer the created BinaryTypeBinding or null if the type is already in the cache.
131 public BinaryTypeBinding cacheBinaryType(IBinaryType binaryType) {
132 return cacheBinaryType(binaryType, true);
134 /* Cache the binary type since we know it is needed during this compile.
136 * Answer the created BinaryTypeBinding or null if the type is already in the cache.
139 public BinaryTypeBinding cacheBinaryType(IBinaryType binaryType, boolean needFieldsAndMethods) {
140 char[][] compoundName = CharOperation.splitOn('/', binaryType.getName());
141 ReferenceBinding existingType = getCachedType(compoundName);
143 if (existingType == null || existingType instanceof UnresolvedReferenceBinding)
144 // only add the binary type if its not already in the cache
145 return createBinaryTypeFrom(binaryType, computePackageFrom(compoundName), needFieldsAndMethods);
146 return null; // the type already exists & can be retrieved from the cache
149 * 1. Connect the type hierarchy for the type bindings created for parsedUnits.
150 * 2. Create the field bindings
151 * 3. Create the method bindings
154 /* We know each known compilationUnit is free of errors at this point...
156 * Each step will create additional bindings unless a problem is detected, in which
157 * case either the faulty import/superinterface/field/method will be skipped or a
158 * suitable replacement will be substituted (such as Object for a missing superclass)
161 public void completeTypeBindings() {
162 stepCompleted = BUILD_TYPE_HIERARCHY;
164 // for (int i = lastCompletedUnitIndex + 1; i <= lastUnitIndex; i++) {
165 // units[i].scope.checkAndSetImports();
167 stepCompleted = CHECK_AND_SET_IMPORTS;
169 // for (int i = lastCompletedUnitIndex + 1; i <= lastUnitIndex; i++) {
170 // units[i].scope.connectTypeHierarchy();
172 stepCompleted = CONNECT_TYPE_HIERARCHY;
174 for (int i = lastCompletedUnitIndex + 1; i <= lastUnitIndex; i++) {
175 // units[i].scope.buildFieldsAndMethods();
176 units[i] = null; // release unnecessary reference to the parsed unit
178 stepCompleted = BUILD_FIELDS_AND_METHODS;
179 lastCompletedUnitIndex = lastUnitIndex;
182 * 1. Connect the type hierarchy for the type bindings created for parsedUnits.
183 * 2. Create the field bindings
184 * 3. Create the method bindings
188 * Each step will create additional bindings unless a problem is detected, in which
189 * case either the faulty import/superinterface/field/method will be skipped or a
190 * suitable replacement will be substituted (such as Object for a missing superclass)
193 public void completeTypeBindings(CompilationUnitDeclaration parsedUnit) {
194 if (stepCompleted == BUILD_FIELDS_AND_METHODS) {
195 // This can only happen because the original set of units are completely built and
196 // are now being processed, so we want to treat all the additional units as a group
197 // until they too are completely processed.
198 completeTypeBindings();
200 if (parsedUnit.scope == null) return; // parsing errors were too severe
202 if (stepCompleted >= CHECK_AND_SET_IMPORTS)
203 parsedUnit.scope.checkAndSetImports();
205 if (stepCompleted >= CONNECT_TYPE_HIERARCHY)
206 parsedUnit.scope.connectTypeHierarchy();
210 * Used by other compiler tools which do not start by calling completeTypeBindings().
212 * 1. Connect the type hierarchy for the type bindings created for parsedUnits.
213 * 2. Create the field bindings
214 * 3. Create the method bindings
217 public void completeTypeBindings(CompilationUnitDeclaration parsedUnit, boolean buildFieldsAndMethods) {
218 if (parsedUnit.scope == null) return; // parsing errors were too severe
220 parsedUnit.scope.checkAndSetImports();
221 parsedUnit.scope.connectTypeHierarchy();
223 if (buildFieldsAndMethods)
224 parsedUnit.scope.buildFieldsAndMethods();
226 private PackageBinding computePackageFrom(char[][] constantPoolName) {
227 if (constantPoolName.length == 1)
228 return defaultPackage;
230 PackageBinding packageBinding = getPackage0(constantPoolName[0]);
231 if (packageBinding == null || packageBinding == TheNotFoundPackage) {
232 packageBinding = new PackageBinding(constantPoolName[0], this);
233 knownPackages.put(constantPoolName[0], packageBinding);
236 for (int i = 1, length = constantPoolName.length - 1; i < length; i++) {
237 PackageBinding parent = packageBinding;
238 if ((packageBinding = parent.getPackage0(constantPoolName[i])) == null || packageBinding == TheNotFoundPackage) {
239 packageBinding = new PackageBinding(CharOperation.subarray(constantPoolName, 0, i + 1), parent, this);
240 parent.addPackage(packageBinding);
243 return packageBinding;
245 /* Used to guarantee array type identity.
248 ArrayBinding createArrayType(TypeBinding type, int dimensionCount) {
249 if (type instanceof LocalTypeBinding) // cache local type arrays with the local type itself
250 return ((LocalTypeBinding) type).createArrayType(dimensionCount);
252 // find the array binding cache for this dimension
253 int dimIndex = dimensionCount - 1;
254 int length = uniqueArrayBindings.length;
255 ArrayBinding[] arrayBindings;
256 if (dimIndex < length) {
257 if ((arrayBindings = uniqueArrayBindings[dimIndex]) == null)
258 uniqueArrayBindings[dimIndex] = arrayBindings = new ArrayBinding[10];
261 uniqueArrayBindings, 0,
262 uniqueArrayBindings = new ArrayBinding[dimensionCount][], 0,
264 uniqueArrayBindings[dimIndex] = arrayBindings = new ArrayBinding[10];
267 // find the cached array binding for this leaf component type (if any)
269 length = arrayBindings.length;
270 while (++index < length) {
271 ArrayBinding currentBinding = arrayBindings[index];
272 if (currentBinding == null) // no matching array, but space left
273 return arrayBindings[index] = new ArrayBinding(type, dimensionCount);
274 if (currentBinding.leafComponentType == type)
275 return currentBinding;
278 // no matching array, no space left
281 (arrayBindings = new ArrayBinding[length * 2]), 0,
283 uniqueArrayBindings[dimIndex] = arrayBindings;
284 return arrayBindings[length] = new ArrayBinding(type, dimensionCount);
286 public BinaryTypeBinding createBinaryTypeFrom(IBinaryType binaryType, PackageBinding packageBinding) {
287 return createBinaryTypeFrom(binaryType, packageBinding, true);
289 public BinaryTypeBinding createBinaryTypeFrom(IBinaryType binaryType, PackageBinding packageBinding, boolean needFieldsAndMethods) {
290 BinaryTypeBinding binaryBinding = new BinaryTypeBinding(packageBinding, binaryType, this);
292 // resolve any array bindings which reference the unresolvedType
293 ReferenceBinding cachedType = packageBinding.getType0(binaryBinding.compoundName[binaryBinding.compoundName.length - 1]);
294 if (cachedType != null) {
295 if (cachedType.isBinaryBinding()) // sanity check before the cast... at this point the cache should ONLY contain unresolved types
296 return (BinaryTypeBinding) cachedType;
298 UnresolvedReferenceBinding unresolvedType = (UnresolvedReferenceBinding) cachedType;
299 unresolvedType.resolvedType = binaryBinding;
300 updateArrayCache(unresolvedType, binaryBinding);
303 packageBinding.addType(binaryBinding);
304 binaryBinding.cachePartsFrom(binaryType, needFieldsAndMethods);
305 return binaryBinding;
307 /* Used to create packages from the package statement.
310 PackageBinding createPackage(char[][] compoundName) {
311 PackageBinding packageBinding = getPackage0(compoundName[0]);
312 if (packageBinding == null || packageBinding == TheNotFoundPackage) {
313 packageBinding = new PackageBinding(compoundName[0], this);
314 knownPackages.put(compoundName[0], packageBinding);
317 for (int i = 1, length = compoundName.length; i < length; i++) {
318 // check to see if it collides with a known type...
319 // this case can only happen if the package does not exist as a directory in the file system
320 // otherwise when the source type was defined, the correct error would have been reported
321 // unless its an unresolved type which is referenced from an inconsistent class file
322 ReferenceBinding type = packageBinding.getType0(compoundName[i]);
323 if (type != null && type != TheNotFoundType && !(type instanceof UnresolvedReferenceBinding))
326 PackageBinding parent = packageBinding;
327 if ((packageBinding = parent.getPackage0(compoundName[i])) == null || packageBinding == TheNotFoundPackage) {
328 // if the package is unknown, check to see if a type exists which would collide with the new package
329 // catches the case of a package statement of: package java.lang.Object;
330 // since the package can be added after a set of source files have already been compiled, we need
331 // whenever a package statement is encountered
332 if (nameEnvironment.findType(compoundName[i], parent.compoundName) != null)
335 packageBinding = new PackageBinding(CharOperation.subarray(compoundName, 0, i + 1), parent, this);
336 parent.addPackage(packageBinding);
339 return packageBinding;
341 /* Answer the type for the compoundName if it exists in the cache.
342 * Answer theNotFoundType if it could not be resolved the first time
343 * it was looked up, otherwise answer null.
345 * NOTE: Do not use for nested types... the answer is NOT the same for a.b.C or a.b.C.D.E
346 * assuming C is a type in both cases. In the a.b.C.D.E case, null is the answer.
349 public ReferenceBinding getCachedType(char[][] compoundName) {
350 if (compoundName.length == 1) {
351 if (defaultPackage == null)
353 return defaultPackage.getType0(compoundName[0]);
356 PackageBinding packageBinding = getPackage0(compoundName[0]);
357 if (packageBinding == null || packageBinding == TheNotFoundPackage)
360 for (int i = 1, packageLength = compoundName.length - 1; i < packageLength; i++)
361 if ((packageBinding = packageBinding.getPackage0(compoundName[i])) == null || packageBinding == TheNotFoundPackage)
363 return packageBinding.getType0(compoundName[compoundName.length - 1]);
365 /* Answer the top level package named name if it exists in the cache.
366 * Answer theNotFoundPackage if it could not be resolved the first time
367 * it was looked up, otherwise answer null.
369 * NOTE: Senders must convert theNotFoundPackage into a real problem
370 * package if its to returned.
373 PackageBinding getPackage0(char[] name) {
374 return knownPackages.get(name);
376 /* Answer the top level package named name.
377 * Ask the oracle for the package if its not in the cache.
378 * Answer null if the package cannot be found.
381 PackageBinding getTopLevelPackage(char[] name) {
382 PackageBinding packageBinding = getPackage0(name);
383 if (packageBinding != null) {
384 if (packageBinding == TheNotFoundPackage)
387 return packageBinding;
390 if (nameEnvironment.isPackage(null, name)) {
391 knownPackages.put(name, packageBinding = new PackageBinding(name, this));
392 return packageBinding;
395 knownPackages.put(name, TheNotFoundPackage); // saves asking the oracle next time
398 /* Answer the type corresponding to the compoundName.
399 * Ask the oracle for the type if its not in the cache.
400 * Answer null if the type cannot be found... likely a fatal error.
403 public ReferenceBinding getType(char[][] compoundName) {
404 ReferenceBinding referenceBinding;
406 if (compoundName.length == 1) {
407 if (defaultPackage == null)
410 if ((referenceBinding = defaultPackage.getType0(compoundName[0])) == null) {
411 PackageBinding packageBinding = getPackage0(compoundName[0]);
412 if (packageBinding != null && packageBinding != TheNotFoundPackage)
413 return null; // collides with a known package... should not call this method in such a case
414 referenceBinding = askForType(defaultPackage, compoundName[0]);
417 PackageBinding packageBinding = getPackage0(compoundName[0]);
418 if (packageBinding == TheNotFoundPackage)
421 if (packageBinding != null) {
422 for (int i = 1, packageLength = compoundName.length - 1; i < packageLength; i++) {
423 if ((packageBinding = packageBinding.getPackage0(compoundName[i])) == null)
425 if (packageBinding == TheNotFoundPackage)
430 if (packageBinding == null)
431 referenceBinding = askForType(compoundName);
432 else if ((referenceBinding = packageBinding.getType0(compoundName[compoundName.length - 1])) == null)
433 referenceBinding = askForType(packageBinding, compoundName[compoundName.length - 1]);
436 if (referenceBinding == null || referenceBinding == TheNotFoundType)
438 if (referenceBinding instanceof UnresolvedReferenceBinding)
439 referenceBinding = ((UnresolvedReferenceBinding) referenceBinding).resolve(this);
441 // compoundName refers to a nested type incorrectly (for example, package1.A$B)
442 if (referenceBinding.isNestedType())
443 return new ProblemReferenceBinding(compoundName, InternalNameProvided);
445 return referenceBinding;
447 /* Answer the type corresponding to the name from the binary file.
448 * Does not ask the oracle for the type if its not found in the cache... instead an
449 * unresolved type is returned which must be resolved before used.
451 * NOTE: Does NOT answer base types nor array types!
453 * NOTE: Aborts compilation if the class file cannot be found.
456 ReferenceBinding getTypeFromConstantPoolName(char[] signature, int start, int end) {
458 end = signature.length;
460 char[][] compoundName = CharOperation.splitOn('/', signature, start, end);
461 ReferenceBinding binding = getCachedType(compoundName);
462 if (binding == null) {
463 PackageBinding packageBinding = computePackageFrom(compoundName);
464 binding = new UnresolvedReferenceBinding(compoundName, packageBinding);
465 packageBinding.addType(binding);
466 } else if (binding == TheNotFoundType) {
467 problemReporter.isClassPathCorrect(compoundName, null);
468 return null; // will not get here since the above error aborts the compilation
472 /* Answer the type corresponding to the signature from the binary file.
473 * Does not ask the oracle for the type if its not found in the cache... instead an
474 * unresolved type is returned which must be resolved before used.
476 * NOTE: Does answer base types & array types.
478 * NOTE: Aborts compilation if the class file cannot be found.
481 TypeBinding getTypeFromSignature(char[] signature, int start, int end) {
483 while (signature[start] == '[') {
488 end = signature.length - 1;
490 // Just switch on signature[start] - the L case is the else
491 TypeBinding binding = null;
493 switch (signature[start]) {
495 binding = IntBinding;
498 binding = BooleanBinding;
501 binding = VoidBinding;
504 binding = CharBinding;
507 binding = DoubleBinding;
510 binding = ByteBinding;
513 binding = FloatBinding;
516 binding = LongBinding;
519 binding = ShortBinding;
522 throw new Error(Util.bind("error.undefinedBaseType",String.valueOf(signature[start]))); //$NON-NLS-1$
525 binding = getTypeFromConstantPoolName(signature, start + 1, end);
531 return createArrayType(binding, dimension);
533 /* Ask the oracle if a package exists named name in the package named compoundName.
536 boolean isPackage(char[][] compoundName, char[] name) {
537 if (compoundName == null || compoundName.length == 0)
538 return nameEnvironment.isPackage(null, name);
540 return nameEnvironment.isPackage(compoundName, name);
542 // The method verifier is lazily initialized to guarantee the receiver, the compiler & the oracle are ready.
544 public MethodVerifier methodVerifier() {
545 if (verifier == null)
546 verifier = new MethodVerifier(this);
549 public void reset() {
550 this.defaultPackage = new PackageBinding(this); // assume the default package always exists
551 this.defaultImports = null;
552 this.knownPackages = new HashtableOfPackage();
554 this.verifier = null;
555 for (int i = this.uniqueArrayBindings.length; --i >= 0;)
556 this.uniqueArrayBindings[i] = null;
557 this.uniqueArrayBindings[0] = new ArrayBinding[50]; // start off the most common 1 dimension array @ 50
559 for (int i = this.units.length; --i >= 0;)
560 this.units[i] = null;
561 this.lastUnitIndex = -1;
562 this.lastCompletedUnitIndex = -1;
564 // name environment has a longer life cycle, and must be reset in
565 // the code which created it.
567 void updateArrayCache(UnresolvedReferenceBinding unresolvedType, ReferenceBinding resolvedType) {
568 nextDimension : for (int i = 0, length = uniqueArrayBindings.length; i < length; i++) {
569 ArrayBinding[] arrayBindings = uniqueArrayBindings[i];
570 if (arrayBindings != null) {
571 for (int j = 0, max = arrayBindings.length; j < max; j++) {
572 ArrayBinding currentBinding = arrayBindings[j];
573 if (currentBinding == null)
574 continue nextDimension;
575 if (currentBinding.leafComponentType == unresolvedType) {
576 currentBinding.leafComponentType = resolvedType;
577 continue nextDimension;