* Example: Create basic AST from source string *
* char[] source = ...; * ASTParser parser = ASTParser.newParser(AST.JLS3); // handles JDK 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6 * parser.setSource(source); * CompilationUnit result = (CompilationUnit) parser.createAST(null); ** Once a configured parser instance has been used to create an AST, * the settings are automatically reset to their defaults, * ready for the parser instance to be reused. * *
* There are a number of configurable features: *
AST
* @return new ASTParser instance
*/
public static ASTParser newParser(int level) {
return new ASTParser(level);
}
/**
* Level of AST API desired.
*/
private final int apiLevel;
/**
* Kind of parse requested. Defaults to an entire compilation unit.
*/
private int astKind;
/**
* Compiler options. Defaults to JavaCore.getOptions().
*/
private Map compilerOptions;
/**
* Request for bindings. Defaults to false.
*/
private boolean resolveBindings;
/**
* Request for a partial AST. Defaults to false.
*/
private boolean partial = false;
/**
* Request for a statements recovery. Defaults to false.
*/
private boolean statementsRecovery;
/**
* Request for a bindings recovery. Defaults to false.
*/
private boolean bindingsRecovery;
/**
* The focal point for a partial AST request.
* Only used when partial is true.
*/
private int focalPointPosition;
/**
* Source string.
*/
private char[] rawSource = null;
/**
* Java model class file or compilation unit supplying the source.
*/
private ITypeRoot typeRoot = null;
/**
* Character-based offset into the source string where parsing is to
* begin. Defaults to 0.
*/
private int sourceOffset = 0;
/**
* Character-based length limit, or -1 if unlimited.
* All characters in the source string between offset
* and offset+length-1 inclusive are parsed. Defaults to -1,
* which means the rest of the source string.
*/
private int sourceLength = -1;
/**
* Working copy owner. Defaults to primary owner.
*/
private WorkingCopyOwner workingCopyOwner = DefaultWorkingCopyOwner.PRIMARY;
/**
* Java project used to resolve names, or null if none.
* Defaults to none.
*/
private IJavaProject project = null;
/**
* Name of the compilation unit for resolving bindings, or
* null if none. Defaults to none.
*/
private String unitName = null;
/**
* Creates a new AST parser for the given API level.
* * N.B. This constructor is package-private. *
* * @param level the API level; one of the LEVEL constants * declared onAST
*/
ASTParser(int level) {
if ((level != AST.JLS2_INTERNAL)
&& (level != AST.JLS3)) {
throw new IllegalArgumentException();
}
this.apiLevel = level;
initializeDefaults();
}
/**
* Sets all the setting to their default values.
*/
private void initializeDefaults() {
this.astKind = K_COMPILATION_UNIT;
this.rawSource = null;
this.typeRoot = null;
this.resolveBindings = false;
this.sourceLength = -1;
this.sourceOffset = 0;
this.workingCopyOwner = DefaultWorkingCopyOwner.PRIMARY;
this.unitName = null;
this.project = null;
this.partial = false;
Map options = JavaCore.getOptions();
options.remove(JavaCore.COMPILER_TASK_TAGS); // no need to parse task tags
this.compilerOptions = options;
}
/**
* Requests that the compiler should perform bindings recovery.
* When bindings recovery is enabled the compiler returns incomplete bindings.
*
* Default to false.
*
This should be set to true only if bindings are resolved. It has no effect if there is no binding * resolution.
* * @param enabledtrue if incomplete bindings are expected,
* and false if only complete bindings are expected.
*
* @see IBinding#isRecovered()
* @since 3.3
*/
public void setBindingsRecovery(boolean enabled) {
this.bindingsRecovery = enabled;
}
/**
* Sets the compiler options to be used when parsing.
*
* Note that {@link #setSource(IClassFile)},
* {@link #setSource(ICompilationUnit)},
* and {@link #setProject(IJavaProject)} reset the compiler options
* based on the Java project. In other cases, compiler options default
* to {@link JavaCore#getOptions()}. In either case, and especially
* in the latter, the caller should carefully weight the consequences of
* allowing compiler options to be defaulted as opposed to being
* explicitly specified for the ASTParser instance.
* For instance, there is a compiler option called "Source Compatibility Mode"
* which determines which JDK level the source code is expected to meet.
* If you specify "1.4", then "assert" is treated as a keyword and disallowed
* as an identifier; if you specify "1.3", then "assert" is allowed as an
* identifier. So this particular setting has a major bearing on what is
* considered syntactically legal. By explicitly specifying the setting,
* the client control exactly how the parser works. On the other hand,
* allowing default settings means the parsing behaves like other JDT tools.
*
String;
* value type: String), or null
* to set it back to the default
*/
public void setCompilerOptions(Map options) {
if (options == null) {
options = JavaCore.getOptions();
} else {
// copy client's options so as to not do any side effect on them
options = new HashMap(options);
}
options.remove(JavaCore.COMPILER_TASK_TAGS); // no need to parse task tags
this.compilerOptions = options;
}
/**
* Requests that the compiler should provide binding information for
* the AST nodes it creates.
*
* Default to false (no bindings).
*
* If setResolveBindings(true), the various names
* and types appearing in the AST can be resolved to "bindings"
* by calling the resolveBinding methods. These bindings
* draw connections between the different parts of a program, and
* generally afford a more powerful vantage point for clients who wish to
* analyze a program's structure more deeply. These bindings come at a
* considerable cost in both time and space, however, and should not be
* requested frivolously. The additional space is not reclaimed until the
* AST, all its nodes, and all its bindings become garbage. So it is very
* important to not retain any of these objects longer than absolutely
* necessary. Bindings are resolved at the time the AST is created. Subsequent
* modifications to the AST do not affect the bindings returned by
* resolveBinding methods in any way; these methods return the
* same binding as before the AST was modified (including modifications
* that rearrange subtrees by reparenting nodes).
* If setResolveBindings(false) (the default), the analysis
* does not go beyond parsing and building the tree, and all
* resolveBinding methods return null from the
* outset.
*
* When bindings are requested, instead of considering compilation units on disk only
* one can supply a WorkingCopyOwner. Working copies owned
* by this owner take precedence over the underlying compilation units when looking
* up names and drawing the connections.
*
* Binding information is obtained from the Java model. * This means that the compilation unit must be located relative to the * Java model. This happens automatically when the source code comes from * either {@link #setSource(ICompilationUnit) setSource(ICompilationUnit)} * or {@link #setSource(IClassFile) setSource(IClassFile)}. * When source is supplied by {@link #setSource(char[]) setSource(char[])}, * the location must be extablished explicitly by calling * {@link #setProject(IJavaProject)} and {@link #setUnitName(String)}. * Note that the compiler options that affect doc comment checking may also * affect whether any bindings are resolved for nodes within doc comments. *
* * @param bindingstrue if bindings are wanted,
* and false if bindings are not of interest
*/
public void setResolveBindings(boolean bindings) {
this.resolveBindings = bindings;
}
/**
* Requests an abridged abstract syntax tree.
* By default, complete ASTs are returned.
*
* When true the resulting AST does not have nodes for
* the entire compilation unit. Rather, the AST is only fleshed out
* for the node that include the given source position. This kind of limited
* AST is sufficient for certain purposes but totally unsuitable for others.
* In places where it can be used, the limited AST offers the advantage of
* being smaller and faster to construct.
*
* The AST will include nodes for all of the compilation unit's * package, import, and top-level type declarations. It will also always contain * nodes for all the body declarations for those top-level types, as well * as body declarations for any member types. However, some of the body * declarations may be abridged. In particular, the statements ordinarily * found in the body of a method declaration node will not be included * (the block will be empty) unless the source position falls somewhere * within the source range of that method declaration node. The same is true * for initializer declarations; the statements ordinarily found in the body * of initializer node will not be included unless the source position falls * somewhere within the source range of that initializer declaration node. * Field declarations are never abridged. Note that the AST for the body of * that one unabridged method (or initializer) is 100% complete; it has all * its statements, including any local or anonymous type declarations * embedded within them. When the the given position is not located within * the source range of any body declaration of a top-level type, the AST * returned will be a skeleton that includes nodes for all and only the major * declarations; this kind of AST is still quite useful because it contains * all the constructs that introduce names visible to the world outside the * compilation unit. *
* * @param position a position into the corresponding body declaration */ public void setFocalPosition(int position) { this.partial = true; this.focalPointPosition = position; } /** * Sets the kind of constructs to be parsed from the source. * Defaults to an entire compilation unit. ** When the parse is successful the result returned includes the ASTs for the * requested source: *
source[offset] through source[offset+length-1]).source; line positions are for the subrange scanned.* Lexical or syntax errors detected while parsing can result in * a result node being marked as {@link ASTNode#MALFORMED MALFORMED}. * In more severe failure cases where the parser is unable to * recognize the input, this method returns * a {@link CompilationUnit CompilationUnit} node with at least the * compiler messages. *
*Each node in the subtree (other than the contrived nodes) * carries source range(s) information relating back * to positions in the given source (the given source itself * is not remembered with the AST). * The source range usually begins at the first character of the first token * corresponding to the node; leading whitespace and comments are not * included. The source range usually extends through the last character of * the last token corresponding to the node; trailing whitespace and * comments are not included. There are a handful of exceptions * (including the various body declarations); the * specification for these node type spells out the details. * Source ranges nest properly: the source range for a child is always * within the source range of its parent, and the source ranges of sibling * nodes never overlap. *
*
* Binding information is only computed when kind is
* K_COMPILATION_UNIT.
*
null if none
*/
public void setSource(char[] source) {
this.rawSource = source;
// clear the type root
this.typeRoot = null;
}
/**
* Sets the source code to be parsed.
* This method automatically sets the project (and compiler
* options) based on the given compilation unit, in a manner
* equivalent to setProject(source.getJavaProject())
*
* @param source the Java model compilation unit whose source code
* is to be parsed, or null if none
*/
public void setSource(ICompilationUnit source) {
setSource((ITypeRoot)source);
}
/**
* Sets the source code to be parsed.
* This method automatically sets the project (and compiler
* options) based on the given compilation unit, in a manner
* equivalent to setProject(source.getJavaProject()).
If the given class file has no source attachment, the creation of the * ast will fail with an IllegalStateException.
* * @param source the Java model class file whose corresponding source code * is to be parsed, ornull if none
*/
public void setSource(IClassFile source) {
setSource((ITypeRoot)source);
}
/**
* Sets the source code to be parsed.
* This method automatically sets the project (and compiler
* options) based on the given compilation unit of class file, in a manner
* equivalent to setProject(source.getJavaProject()).
If the source is a class file without source attachment, the creation of the * ast will fail with an IllegalStateException.
* * @param source the Java model compilation unit or class file whose corresponding source code * is to be parsed, ornull if none
* @since 3.3
*/
public void setSource(ITypeRoot source) {
this.typeRoot = source;
// clear the raw source
this.rawSource = null;
if (source != null) {
this.project = source.getJavaProject();
Map options = this.project.getOptions(true);
options.remove(JavaCore.COMPILER_TASK_TAGS); // no need to parse task tags
this.compilerOptions = options;
}
}
/**
* Sets the subrange of the source code to be parsed.
* By default, the entire source string will be parsed
* (offset 0 and length -1).
*
* @param offset the index of the first character to parse
* @param length the number of characters to parse, or -1 if
* the remainder of the source string is
*/
public void setSourceRange(int offset, int length) {
if (offset < 0 || length < -1) {
throw new IllegalArgumentException();
}
this.sourceOffset = offset;
this.sourceLength = length;
}
/**
* Requests that the compiler should perform statements recovery.
* When statements recovery is enabled the compiler tries to create statement nodes
* from code containing syntax errors
*
* Default to false.
*
true if statements containing syntax errors are wanted,
* and false if these statements aren't wanted.
*
* @since 3.2
*/
public void setStatementsRecovery(boolean enabled) {
this.statementsRecovery = enabled;
}
/**
* Sets the working copy owner using when resolving bindings, where
* null means the primary owner. Defaults to the primary owner.
*
* @param owner the owner of working copies that take precedence over underlying
* compilation units, or null if the primary owner should be used
*/
public void setWorkingCopyOwner(WorkingCopyOwner owner) {
if (owner == null) {
this.workingCopyOwner = DefaultWorkingCopyOwner.PRIMARY;
} else {
this.workingCopyOwner = owner;
}
}
/**
* Sets the name of the compilation unit that would hypothetically contains
* the source string. This is used in conjunction with {@link #setSource(char[])}
* and {@link #setProject(IJavaProject) } to locate the compilation unit relative to a Java project.
* Defaults to none (null).
* * The name of the compilation unit must be supplied for resolving bindings. * This name should be suffixed by a dot ('.') followed by one of the * {@link JavaCore#getJavaLikeExtensions() Java-like extensions} * and match the name of the main (public) class or interface declared in the source.
* *This name must represent the full path of the unit inside the given project. For example, if the source * declares a public class named "Foo" in a project "P", the name of the compilation unit must be * "/P/Foo.java". If the source declares a public class name "Bar" in a package "p1.p2" in a project "P", * the name of the compilation unit must be "/P/p1/p2/Bar.java".
* * @param unitName the name of the compilation unit that would contain the source * string, ornull if none
*/
public void setUnitName(String unitName) {
this.unitName = unitName;
}
/**
* Sets the Java project used when resolving bindings.
* This method automatically sets the compiler
* options based on the given project:
* * setCompilerOptions(project.getOptions(true)); ** See {@link #setCompilerOptions(Map)} for a discussion of * the pros and cons of using these options vs specifying * compiler options explicitly. * This setting is used in conjunction with
setSource(char[]).
* For the purposes of resolving bindings, types declared in the
* source string will hide types by the same name available
* through the classpath of the given project.
* Defaults to none (null).
*
* @param project the Java project used to resolve names, or
* null if none
*/
public void setProject(IJavaProject project) {
this.project = project;
if (project != null) {
Map options = project.getOptions(true);
options.remove(JavaCore.COMPILER_TASK_TAGS); // no need to parse task tags
this.compilerOptions = options;
}
}
/**
* Creates an abstract syntax tree.
* * A successful call to this method returns all settings to their * default values so the object is ready to be reused. *
* * @param monitor the progress monitor used to report progress and request cancelation, * ornull if none
* @return an AST node whose type depends on the kind of parse
* requested, with a fallback to a CompilationUnit
* in the case of severe parsing errors
* @exception IllegalStateException if the settings provided
* are insufficient, contradictory, or otherwise unsupported
*/
public ASTNode createAST(IProgressMonitor monitor) {
ASTNode result = null;
if (monitor != null) monitor.beginTask("", 1); //$NON-NLS-1$
try {
if (this.rawSource == null && this.typeRoot == null) {
throw new IllegalStateException("source not specified"); //$NON-NLS-1$
}
result = internalCreateAST(monitor);
} finally {
// re-init defaults to allow reuse (and avoid leaking)
initializeDefaults();
if (monitor != null) monitor.done();
}
return result;
}
/**
* Creates ASTs for a batch of compilation units.
* When bindings are being resolved, processing a
* batch of compilation units is more efficient because much
* of the work involved in resolving bindings can be shared.
*
* When bindings are being resolved, all compilation units must
* come from the same Java project, which must be set beforehand
* with setProject.
* The compilation units are processed one at a time in no
* specified order. For each of the compilation units in turn,
*
ASTParser.createAST is called to parse it
* and create a corresponding AST. The calls to
* ASTParser.createAST all employ the same settings.ASTRequestor.acceptAST is called passing
* the compilation unit and the corresponding AST to
* requestor.
* * Note also the following parser parameters are used, regardless of what * may have been specified: *
K_COMPILATION_UNIT(0, -1)
* The bindingKeys parameter specifies bindings keys
* ({@link IBinding#getKey()}) that are to be looked up. These keys may
* be for elements either inside or outside the set of compilation
* units being processed. When bindings are being resolved,
* the keys and corresponding bindings (or null if none) are
* passed to ASTRequestor.acceptBinding. Note that binding keys
* for elements outside the set of compilation units being processed are looked up
* after all ASTRequestor.acceptAST callbacks have been made.
* Binding keys for elements inside the set of compilation units being processed
* are looked up and reported right after the corresponding
* ASTRequestor.acceptAST callback has been made.
* No ASTRequestor.acceptBinding callbacks are made unless
* bindings are being resolved.
*
* A successful call to this method returns all settings to their * default values so the object is ready to be reused. *
* * @param compilationUnits the compilation units to create ASTs for * @param bindingKeys the binding keys to create bindings for * @param requestor the AST requestor that collects abtract syntax trees and bindings * @param monitor the progress monitor used to report progress and request cancelation, * ornull if none
* @exception IllegalStateException if the settings provided
* are insufficient, contradictory, or otherwise unsupported
* @since 3.1
*/
public void createASTs(ICompilationUnit[] compilationUnits, String[] bindingKeys, ASTRequestor requestor, IProgressMonitor monitor) {
try {
int flags = 0;
if (this.statementsRecovery) flags |= ICompilationUnit.ENABLE_STATEMENTS_RECOVERY;
if (this.resolveBindings) {
if (this.project == null)
throw new IllegalStateException("project not specified"); //$NON-NLS-1$
if (this.bindingsRecovery) flags |= ICompilationUnit.ENABLE_BINDINGS_RECOVERY;
CompilationUnitResolver.resolve(compilationUnits, bindingKeys, requestor, this.apiLevel, this.compilerOptions, this.project, this.workingCopyOwner, flags, monitor);
} else {
CompilationUnitResolver.parse(compilationUnits, requestor, this.apiLevel, this.compilerOptions, flags, monitor);
}
} finally {
// re-init defaults to allow reuse (and avoid leaking)
initializeDefaults();
}
}
/**
* Creates bindings for a batch of Java elements. These elements are either
* enclosed in {@link ICompilationUnit}s or in {@link IClassFile}s.
*
* All enclosing compilation units and class files must
* come from the same Java project, which must be set beforehand
* with setProject.
*
* All elements must exist. If one doesn't exist, an IllegalStateException
* is thrown.
*
* The returned array has the same size as the given elements array. At a given position
* it contains the binding of the corresponding Java element, or null
* if no binding could be created.
*
* Note also the following parser parameters are used, regardless of what * may have been specified: *
trueK_COMPILATION_UNIT(0, -1)* A successful call to this method returns all settings to their * default values so the object is ready to be reused. *
* * @param elements the Java elements to create bindings for * @return the bindings for the given Java elements, possibly containingnulls
* if some bindings could not be created
* @exception IllegalStateException if the settings provided
* are insufficient, contradictory, or otherwise unsupported
* @since 3.1
*/
public IBinding[] createBindings(IJavaElement[] elements, IProgressMonitor monitor) {
try {
if (this.project == null)
throw new IllegalStateException("project not specified"); //$NON-NLS-1$
int flags = 0;
if (this.statementsRecovery) flags |= ICompilationUnit.ENABLE_STATEMENTS_RECOVERY;
if (this.bindingsRecovery) flags |= ICompilationUnit.ENABLE_BINDINGS_RECOVERY;
return CompilationUnitResolver.resolve(elements, this.apiLevel, this.compilerOptions, this.project, this.workingCopyOwner, flags, monitor);
} finally {
// re-init defaults to allow reuse (and avoid leaking)
initializeDefaults();
}
}
private ASTNode internalCreateAST(IProgressMonitor monitor) {
boolean needToResolveBindings = this.resolveBindings;
switch(this.astKind) {
case K_CLASS_BODY_DECLARATIONS :
case K_EXPRESSION :
case K_STATEMENTS :
if (this.rawSource != null) {
if (this.sourceOffset + this.sourceLength > this.rawSource.length) {
throw new IllegalStateException();
}
return internalCreateASTForKind();
}
break;
case K_COMPILATION_UNIT :
CompilationUnitDeclaration compilationUnitDeclaration = null;
try {
NodeSearcher searcher = null;
net.sourceforge.phpdt.internal.compiler.env.ICompilationUnit sourceUnit = null;
WorkingCopyOwner wcOwner = this.workingCopyOwner;
if (this.typeRoot instanceof ICompilationUnit) {
/*
* this.compilationUnitSource is an instance of org.eclipse.jdt.internal.core.CompilationUnit that implements
* both org.eclipse.jdt.core.ICompilationUnit and org.eclipse.jdt.internal.compiler.env.ICompilationUnit
*/
sourceUnit = (net.sourceforge.phpdt.internal.compiler.env.ICompilationUnit) this.typeRoot;
/*
* use a BasicCompilation that caches the source instead of using the compilationUnitSource directly
* (if it is a working copy, the source can change between the parse and the AST convertion)
* (see https://bugs.eclipse.org/bugs/show_bug.cgi?id=75632)
*/
sourceUnit = new BasicCompilationUnit(sourceUnit.getContents(), sourceUnit.getPackageName(), new String(sourceUnit.getFileName()), this.project);
wcOwner = ((ICompilationUnit) this.typeRoot).getOwner();
} else if (this.typeRoot instanceof IClassFile) {
try {
String sourceString = this.typeRoot.getSource();
if (sourceString == null) {
throw new IllegalStateException();
}
PackageFragment packageFragment = (PackageFragment) this.typeRoot.getParent();
BinaryType type = (BinaryType) this.typeRoot.findPrimaryType();
IBinaryType binaryType = (IBinaryType) type.getElementInfo();
// file name is used to recreate the Java element, so it has to be the toplevel .class file name
char[] fileName = binaryType.getFileName();
int firstDollar = CharOperation.indexOf('$', fileName);
if (firstDollar != -1) {
char[] suffix = SuffixConstants.SUFFIX_class;
int suffixLength = suffix.length;
char[] newFileName = new char[firstDollar + suffixLength];
System.arraycopy(fileName, 0, newFileName, 0, firstDollar);
System.arraycopy(suffix, 0, newFileName, firstDollar, suffixLength);
fileName = newFileName;
}
sourceUnit = new BasicCompilationUnit(sourceString.toCharArray(), Util.toCharArrays(packageFragment.names), new String(fileName), this.project);
} catch(JavaModelException e) {
// an error occured accessing the java element
StringWriter stringWriter = new StringWriter();
PrintWriter writer = null;
try {
writer = new PrintWriter(stringWriter);
e.printStackTrace(writer);
} finally {
if (writer != null) writer.close();
}
throw new IllegalStateException(String.valueOf(stringWriter.getBuffer()));
}
} else if (this.rawSource != null) {
needToResolveBindings = this.resolveBindings && this.unitName != null && this.project != null && this.compilerOptions != null;
sourceUnit = new BasicCompilationUnit(this.rawSource, null, this.unitName == null ? "" : this.unitName, this.project); //$NON-NLS-1$
} else {
throw new IllegalStateException();
}
if (this.partial) {
searcher = new NodeSearcher(this.focalPointPosition);
}
int flags = 0;
if (this.statementsRecovery) flags |= ICompilationUnit.ENABLE_STATEMENTS_RECOVERY;
if (needToResolveBindings) {
if (this.bindingsRecovery) flags |= ICompilationUnit.ENABLE_BINDINGS_RECOVERY;
try {
// parse and resolve
compilationUnitDeclaration =
CompilationUnitResolver.resolve(
sourceUnit,
this.project,
searcher,
this.compilerOptions,
this.workingCopyOwner,
flags,
monitor);
} catch (JavaModelException e) {
flags &= ~ICompilationUnit.ENABLE_BINDINGS_RECOVERY;
compilationUnitDeclaration = CompilationUnitResolver.parse(
sourceUnit,
searcher,
this.compilerOptions,
flags);
needToResolveBindings = false;
}
} else {
compilationUnitDeclaration = CompilationUnitResolver.parse(
sourceUnit,
searcher,
this.compilerOptions,
flags);
needToResolveBindings = false;
}
CompilationUnit result = CompilationUnitResolver.convert(
compilationUnitDeclaration,
sourceUnit.getContents(),
this.apiLevel,
this.compilerOptions,
needToResolveBindings,
wcOwner,
needToResolveBindings ? new DefaultBindingResolver.BindingTables() : null,
flags,
monitor);
result.setTypeRoot(this.typeRoot);
return result;
} finally {
if (compilationUnitDeclaration != null && this.resolveBindings) {
compilationUnitDeclaration.cleanUp();
}
}
}
throw new IllegalStateException();
}
/**
* Parses the given source between the bounds specified by the given offset (inclusive)
* and the given length and creates and returns a corresponding abstract syntax tree.
* * When the parse is successful the result returned includes the ASTs for the * requested source: *
source[offset] through source[offset+length-1]).source; line positions are for the subrange scanned.* Lexical or syntax errors detected while parsing can result in * a result node being marked as {@link ASTNode#MALFORMED MALFORMED}. * In more severe failure cases where the parser is unable to * recognize the input, this method returns * a {@link CompilationUnit CompilationUnit} node with at least the * compiler messages. *
*Each node in the subtree (other than the contrived nodes) * carries source range(s) information relating back * to positions in the given source (the given source itself * is not remembered with the AST). * The source range usually begins at the first character of the first token * corresponding to the node; leading whitespace and comments are not * included. The source range usually extends through the last character of * the last token corresponding to the node; trailing whitespace and * comments are not included. There are a handful of exceptions * (including the various body declarations); the * specification for these node type spells out the details. * Source ranges nest properly: the source range for a child is always * within the source range of its parent, and the source ranges of sibling * nodes never overlap. *
*
* This method does not compute binding information; all resolveBinding
* methods applied to nodes of the resulting AST return null.
*
CompilationUnit
* in the case of severe parsing errors
* @see ASTNode#getStartPosition()
* @see ASTNode#getLength()
*/
private ASTNode internalCreateASTForKind() {
final ASTConverter converter = new ASTConverter(this.compilerOptions, false, null);
converter.compilationUnitSource = this.rawSource;
converter.compilationUnitSourceLength = this.rawSource.length;
converter.scanner.setSource(this.rawSource);
AST ast = AST.newAST(this.apiLevel);
ast.setDefaultNodeFlag(ASTNode.ORIGINAL);
ast.setBindingResolver(new BindingResolver());
if (this.statementsRecovery) {
ast.setFlag(ICompilationUnit.ENABLE_STATEMENTS_RECOVERY);
}
converter.setAST(ast);
CodeSnippetParsingUtil codeSnippetParsingUtil = new CodeSnippetParsingUtil();
CompilationUnit compilationUnit = ast.newCompilationUnit();
if (this.sourceLength == -1) {
this.sourceLength = this.rawSource.length;
}
switch(this.astKind) {
case K_STATEMENTS :
ConstructorDeclaration constructorDeclaration = codeSnippetParsingUtil.parseStatements(this.rawSource, this.sourceOffset, this.sourceLength, this.compilerOptions, true, this.statementsRecovery);
RecoveryScannerData data = constructorDeclaration.compilationResult.recoveryScannerData;
if(data != null) {
Scanner scanner = converter.scanner;
converter.scanner = new RecoveryScanner(scanner, data.removeUnused());
converter.docParser.scanner = converter.scanner;
converter.scanner.setSource(scanner.source);
}
RecordedParsingInformation recordedParsingInformation = codeSnippetParsingUtil.recordedParsingInformation;
int[][] comments = recordedParsingInformation.commentPositions;
if (comments != null) {
converter.buildCommentsTable(compilationUnit, comments);
}
compilationUnit.setLineEndTable(recordedParsingInformation.lineEnds);
Block block = ast.newBlock();
block.setSourceRange(this.sourceOffset, this.sourceOffset + this.sourceLength);
net.sourceforge.phpdt.internal.compiler.ast.Statement[] statements = constructorDeclaration.statements;
if (statements != null) {
int statementsLength = statements.length;
for (int i = 0; i < statementsLength; i++) {
if (statements[i] instanceof net.sourceforge.phpdt.internal.compiler.ast.LocalDeclaration) {
converter.checkAndAddMultipleLocalDeclaration(statements, i, block.statements());
} else {
Statement statement = converter.convert(statements[i]);
if (statement != null) {
block.statements().add(statement);
}
}
}
}
rootNodeToCompilationUnit(ast, compilationUnit, block, recordedParsingInformation, data);
ast.setDefaultNodeFlag(0);
ast.setOriginalModificationCount(ast.modificationCount());
return block;
case K_EXPRESSION :
net.sourceforge.phpdt.internal.compiler.ast.Expression expression = codeSnippetParsingUtil.parseExpression(this.rawSource, this.sourceOffset, this.sourceLength, this.compilerOptions, true);
recordedParsingInformation = codeSnippetParsingUtil.recordedParsingInformation;
comments = recordedParsingInformation.commentPositions;
if (comments != null) {
converter.buildCommentsTable(compilationUnit, comments);
}
compilationUnit.setLineEndTable(recordedParsingInformation.lineEnds);
if (expression != null) {
Expression expression2 = converter.convert(expression);
rootNodeToCompilationUnit(expression2.getAST(), compilationUnit, expression2, codeSnippetParsingUtil.recordedParsingInformation, null);
ast.setDefaultNodeFlag(0);
ast.setOriginalModificationCount(ast.modificationCount());
return expression2;
} else {
CategorizedProblem[] problems = recordedParsingInformation.problems;
if (problems != null) {
compilationUnit.setProblems(problems);
}
ast.setDefaultNodeFlag(0);
ast.setOriginalModificationCount(ast.modificationCount());
return compilationUnit;
}
case K_CLASS_BODY_DECLARATIONS :
final net.sourceforge.phpdt.internal.compiler.ast.ASTNode[] nodes = codeSnippetParsingUtil.parseClassBodyDeclarations(this.rawSource, this.sourceOffset, this.sourceLength, this.compilerOptions, true);
recordedParsingInformation = codeSnippetParsingUtil.recordedParsingInformation;
comments = recordedParsingInformation.commentPositions;
if (comments != null) {
converter.buildCommentsTable(compilationUnit, comments);
}
compilationUnit.setLineEndTable(recordedParsingInformation.lineEnds);
if (nodes != null) {
TypeDeclaration typeDeclaration = converter.convert(nodes);
typeDeclaration.setSourceRange(this.sourceOffset, this.sourceOffset + this.sourceLength);
rootNodeToCompilationUnit(typeDeclaration.getAST(), compilationUnit, typeDeclaration, codeSnippetParsingUtil.recordedParsingInformation, null);
ast.setDefaultNodeFlag(0);
ast.setOriginalModificationCount(ast.modificationCount());
return typeDeclaration;
} else {
CategorizedProblem[] problems = recordedParsingInformation.problems;
if (problems != null) {
compilationUnit.setProblems(problems);
}
ast.setDefaultNodeFlag(0);
ast.setOriginalModificationCount(ast.modificationCount());
return compilationUnit;
}
}
throw new IllegalStateException();
}
private void propagateErrors(ASTNode astNode, CategorizedProblem[] problems, RecoveryScannerData data) {
astNode.accept(new ASTSyntaxErrorPropagator(problems));
if (data != null) {
astNode.accept(new ASTRecoveryPropagator(problems, data));
}
}
private void rootNodeToCompilationUnit(AST ast, CompilationUnit compilationUnit, ASTNode node, RecordedParsingInformation recordedParsingInformation, RecoveryScannerData data) {
final int problemsCount = recordedParsingInformation.problemsCount;
switch(node.getNodeType()) {
case ASTNode.BLOCK :
{
Block block = (Block) node;
if (problemsCount != 0) {
// propagate and record problems
final CategorizedProblem[] problems = recordedParsingInformation.problems;
propagateErrors(block, problems, data);
compilationUnit.setProblems(problems);
}
TypeDeclaration typeDeclaration = ast.newTypeDeclaration();
Initializer initializer = ast.newInitializer();
initializer.setBody(block);
typeDeclaration.bodyDeclarations().add(initializer);
compilationUnit.types().add(typeDeclaration);
}
break;
case ASTNode.TYPE_DECLARATION :
{
TypeDeclaration typeDeclaration = (TypeDeclaration) node;
if (problemsCount != 0) {
// propagate and record problems
final CategorizedProblem[] problems = recordedParsingInformation.problems;
propagateErrors(typeDeclaration, problems, data);
compilationUnit.setProblems(problems);
}
compilationUnit.types().add(typeDeclaration);
}
break;
default :
if (node instanceof Expression) {
Expression expression = (Expression) node;
if (problemsCount != 0) {
// propagate and record problems
final CategorizedProblem[] problems = recordedParsingInformation.problems;
propagateErrors(expression, problems, data);
compilationUnit.setProblems(problems);
}
ExpressionStatement expressionStatement = ast.newExpressionStatement(expression);
Block block = ast.newBlock();
block.statements().add(expressionStatement);
Initializer initializer = ast.newInitializer();
initializer.setBody(block);
TypeDeclaration typeDeclaration = ast.newTypeDeclaration();
typeDeclaration.bodyDeclarations().add(initializer);
compilationUnit.types().add(typeDeclaration);
}
}
}
}