/*******************************************************************************
* Copyright (c) 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package net.sourceforge.phpdt.core.dom;
import net.sourceforge.phpdt.core.ICompilationUnit;
/**
* An AST requestor handles ASTs for compilation units passed to
* ASTParser.createASTs
.
*
* ASTRequestor.acceptAST
is called for each of the
* compilation units passed to ASTParser.createASTs
.
* After all the compilation units have been processed,
* ASTRequestor.acceptBindings
is called for each
* of the binding keys passed to ASTParser.createASTs
.
*
* This class is intended to be subclassed by clients. * AST requestors are serially reusable, but neither reentrant nor * thread-safe. *
* * @see ASTParser#createASTs(ICompilationUnit[], String[], ASTRequestor, org.eclipse.core.runtime.IProgressMonitor) * @since 3.1 */ public abstract class ASTRequestor { /** * The compilation unit resolver used to resolve bindings, or *null
if none. Note that this field is non-null
* only within the dynamic scope of a call to
* ASTParser.createASTs
.
*/
CompilationUnitResolver compilationUnitResolver = null;
/**
* Creates a new instance.
*/
protected ASTRequestor() {
// do nothing
}
/**
* Accepts an AST corresponding to the compilation unit.
* That is, ast
is an AST for source
.
* * The default implementation of this method does nothing. * Clients should override to process the resulting AST. *
* * @param source the compilation unit the ast is coming from * @param ast the requested abtract syntax tree */ public void acceptAST(ICompilationUnit source, CompilationUnit ast) { // do nothing } /** * Accepts a binding corresponding to the binding key. * That is,binding
is the binding for
* bindingKey
; binding
is null
* if the key cannot be resolved.
* * The default implementation of this method does nothing. * Clients should override to process the resulting binding. *
* * @param bindingKey the key of the requested binding * @param binding the requested binding, ornull
if none
*/
public void acceptBinding(String bindingKey, IBinding binding) {
// do nothing
}
/**
* Resolves bindings for the given binding keys.
* The given binding keys must have been obtained earlier
* using {@link IBinding#getKey()}.
*
* If a binding key cannot be resolved, null
is put in the resulting array.
* Bindings can only be resolved in the dynamic scope of a ASTParser.createASTs
,
* and only if ASTParser.resolveBindings(true)
was specified.
*
* Caveat: During an acceptAST
callback, there are implementation
* limitations concerning the look up of binding keys representing local elements.
* In some cases, the binding is unavailable, and null
will be returned.
* This is only an issue during an acceptAST
callback, and only
* when the binding key represents a local element (e.g., local variable,
* local class, method declared in anonymous class). There is no such limitation
* outside of acceptAST
callbacks, or for top-level types and their
* members even within acceptAST
callbacks.
*
bindingKeys
parameter,
* with null
entries for keys that could not be resolved
*/
public final IBinding[] createBindings(String[] bindingKeys) {
int length = bindingKeys.length;
IBinding[] result = new IBinding[length];
for (int i = 0; i < length; i++) {
result[i] = null;
if (this.compilationUnitResolver != null) {
result[i] = this.compilationUnitResolver.createBinding(bindingKeys[i]);
}
}
return result;
}
}