| /******************************************************************************* |
| * Copyright (c) 2000, 2003 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Common Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/cpl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| |
| package org.eclipse.jdt.core.dom; |
| |
| import org.eclipse.jdt.core.compiler.InvalidInputException; |
| import org.eclipse.jdt.internal.compiler.parser.Scanner; |
| |
| /** |
| * AST node for a simple name. A simple name is an identifier other than |
| * a keyword, boolean literal ("true", "false") or null literal ("null"). |
| * <pre> |
| * SimpleName: |
| * Identifier |
| * </pre> |
| * |
| * @since 2.0 |
| */ |
| public class SimpleName extends Name { |
| |
| /** |
| * An unspecified (but externally observable) legal Java identifier. |
| */ |
| private static final String MISSING_IDENTIFIER = "MISSING";//$NON-NLS-1$ |
| |
| /** |
| * The identifier; defaults to a unspecified, legal Java identifier. |
| */ |
| private String identifier = MISSING_IDENTIFIER; |
| |
| /** |
| * Creates a new AST node for a simple name owned by the given AST. |
| * The new node has an unspecified, legal Java identifier. |
| * <p> |
| * N.B. This constructor is package-private; all subclasses must be |
| * declared in the same package; clients are unable to declare |
| * additional subclasses. |
| * </p> |
| * |
| * @param ast the AST that is to own this node |
| */ |
| SimpleName(AST ast) { |
| super(ast); |
| } |
| |
| /* (omit javadoc for this method) |
| * Method declared on ASTNode. |
| */ |
| public int getNodeType() { |
| return SIMPLE_NAME; |
| } |
| |
| /* (omit javadoc for this method) |
| * Method declared on ASTNode. |
| */ |
| ASTNode clone(AST target) { |
| SimpleName result = new SimpleName(target); |
| result.setSourceRange(this.getStartPosition(), this.getLength()); |
| result.setIdentifier(getIdentifier()); |
| return result; |
| } |
| |
| /* (omit javadoc for this method) |
| * Method declared on ASTNode. |
| */ |
| public boolean subtreeMatch(ASTMatcher matcher, Object other) { |
| // dispatch to correct overloaded match method |
| return matcher.match(this, other); |
| } |
| |
| /* (omit javadoc for this method) |
| * Method declared on ASTNode. |
| */ |
| void accept0(ASTVisitor visitor) { |
| visitor.visit(this); |
| visitor.endVisit(this); |
| } |
| |
| /** |
| * Returns this node's identifier. |
| * |
| * @return the identifier of this node |
| */ |
| public String getIdentifier() { |
| return identifier; |
| } |
| |
| /** |
| * Sets the identifier of this node to the given value. |
| * The identifier should be legal according to the rules |
| * of the Java language. Note that keywords are not legal |
| * identifiers. |
| * <p> |
| * Note that the list of keywords may depend on the version of the |
| * language (determined when the AST object was created). |
| * </p> |
| * |
| * @param identifier the identifier of this node |
| * @exception IllegalArgumentException if the identifier is invalid |
| * @see AST#AST(java.util.Map) |
| */ |
| public void setIdentifier(String identifier) { |
| if (identifier == null) { |
| throw new IllegalArgumentException(); |
| } |
| Scanner scanner = getAST().scanner; |
| char[] source = identifier.toCharArray(); |
| scanner.setSource(source); |
| scanner.resetTo(0, source.length); |
| try { |
| int tokenType = scanner.getNextToken(); |
| switch(tokenType) { |
| case Scanner.TokenNameIdentifier: |
| break; |
| default: |
| throw new IllegalArgumentException(); |
| } |
| } catch(InvalidInputException e) { |
| throw new IllegalArgumentException(); |
| } |
| modifying(); |
| this.identifier = identifier; |
| } |
| |
| /** |
| * Returns whether this simple name represents a name that is being defined, |
| * as opposed to one being referenced. The following positions are considered |
| * ones where a name is defined: |
| * <ul> |
| * <li>The type name in a <code>TypeDeclaration</code> node.</li> |
| * <li>The method name in a <code>MethodDeclaration</code> node |
| * providing <code>isConstructor</code> is <code>false</code>.</li> |
| * <li>The variable name in any type of <code>VariableDeclaration</code> |
| * node.</li> |
| * </ul> |
| * <p> |
| * Note that this is a convenience method that simply checks whether |
| * this node appears in the declaration position relative to its parent. |
| * It always returns <code>false</code> if this node is unparented. |
| * </p> |
| * |
| * @return <code>true</code> if this node declares a name, and |
| * <code>false</code> otherwise |
| */ |
| public boolean isDeclaration() { |
| ASTNode parent = getParent(); |
| if (parent == null) { |
| // unparented node |
| return false; |
| } |
| if (parent instanceof TypeDeclaration) { |
| // could only be the name of the type |
| return true; |
| } |
| if (parent instanceof MethodDeclaration) { |
| // could be the name of the method or constructor |
| MethodDeclaration p = (MethodDeclaration) parent; |
| return !p.isConstructor(); |
| } |
| if (parent instanceof SingleVariableDeclaration) { |
| SingleVariableDeclaration p = (SingleVariableDeclaration) parent; |
| // make sure its the name of the variable (not the initializer) |
| return (p.getName() == this); |
| } |
| if (parent instanceof VariableDeclarationFragment) { |
| VariableDeclarationFragment p = (VariableDeclarationFragment) parent; |
| // make sure its the name of the variable (not the initializer) |
| return (p.getName() == this); |
| } |
| return false; |
| } |
| |
| /* (omit javadoc for this method) |
| * Method declared on ASTNode. |
| */ |
| int memSize() { |
| int size = BASE_NODE_SIZE + 1 * 4; |
| if (identifier != null) { |
| size += HEADERS + 3 * 4 + HEADERS + 2 * identifier.length(); |
| } |
| return size; |
| } |
| |
| /* (omit javadoc for this method) |
| * Method declared on ASTNode. |
| */ |
| int treeSize() { |
| return memSize(); |
| } |
| } |
| |