net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/dom/ThisExpression.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2008 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11
  12 package net.sourceforge.phpdt.core.dom;
  13
  14 import java.util.ArrayList;
  15 import java.util.List;
  16
  17 /**
  18  * Simple or qualified "this" AST node type.
  19  *
  20  * <pre>
  21  * ThisExpression:
  22  *     [ ClassName <b>.</b> ] <b>this</b>
  23  * </pre>
  24  * <p>
  25  * See <code>FieldAccess</code> for guidelines on handling other expressions
  26  * that resemble qualified names.
  27  * </p>
  28  *
  29  * @see FieldAccess
  30  * @since 2.0
  31  * @noinstantiate This class is not intended to be instantiated by clients.
  32  */
  33 public class ThisExpression extends Expression {
  34
  35         /**
  36          * The "qualifier" structural property of this node type.
  37          * @since 3.0
  38          */
  39         public static final ChildPropertyDescriptor QUALIFIER_PROPERTY =
  40                 new ChildPropertyDescriptor(ThisExpression.class, "qualifier", Name.class, OPTIONAL, NO_CYCLE_RISK); //$NON-NLS-1$
  41
  42         /**
  43          * A list of property descriptors (element type:
  44          * {@link StructuralPropertyDescriptor}),
  45          * or null if uninitialized.
  46          */
  47         private static final List PROPERTY_DESCRIPTORS;
  48
  49         static {
  50                 List propertyList = new ArrayList(2);
  51                 createPropertyList(ThisExpression.class, propertyList);
  52                 addProperty(QUALIFIER_PROPERTY, propertyList);
  53                 PROPERTY_DESCRIPTORS = reapPropertyList(propertyList);
  54         }
  55
  56         /**
  57          * Returns a list of structural property descriptors for this node type.
  58          * Clients must not modify the result.
  59          *
  60          * @param apiLevel the API level; one of the
  61          * <code>AST.JLS*</code> constants
  62          * @return a list of property descriptors (element type:
  63          * {@link StructuralPropertyDescriptor})
  64          * @since 3.0
  65          */
  66         public static List propertyDescriptors(int apiLevel) {
  67                 return PROPERTY_DESCRIPTORS;
  68         }
  69
  70         /**
  71          * The optional qualifier; <code>null</code> for none; defaults to none.
  72          */
  73         private Name optionalQualifier = null;
  74
  75         /**
  76          * Creates a new AST node for a "this" expression owned by the
  77          * given AST. By default, there is no qualifier.
  78          *
  79          * @param ast the AST that is to own this node
  80          */
  81         ThisExpression(AST ast) {
  82                 super(ast);
  83         }
  84
  85         /* (omit javadoc for this method)
  86          * Method declared on ASTNode.
  87          */
  88         final List internalStructuralPropertiesForType(int apiLevel) {
  89                 return propertyDescriptors(apiLevel);
  90         }
  91
  92         /* (omit javadoc for this method)
  93          * Method declared on ASTNode.
  94          */
  95         final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child) {
  96                 if (property == QUALIFIER_PROPERTY) {
  97                         if (get) {
  98                                 return getQualifier();
  99                         } else {
 100                                 setQualifier((Name) child);
 101                                 return null;
 102                         }
 103                 }
 104                 // allow default implementation to flag the error
 105                 return super.internalGetSetChildProperty(property, get, child);
 106         }
 107
 108         /* (omit javadoc for this method)
 109          * Method declared on ASTNode.
 110          */
 111         final int getNodeType0() {
 112                 return THIS_EXPRESSION;
 113         }
 114
 115         /* (omit javadoc for this method)
 116          * Method declared on ASTNode.
 117          */
 118         ASTNode clone0(AST target) {
 119                 ThisExpression result = new ThisExpression(target);
 120                 result.setSourceRange(this.getStartPosition(), this.getLength());
 121                 result.setQualifier((Name) ASTNode.copySubtree(target, getQualifier()));
 122                 return result;
 123         }
 124
 125         /* (omit javadoc for this method)
 126          * Method declared on ASTNode.
 127          */
 128         final boolean subtreeMatch0(ASTMatcher matcher, Object other) {
 129                 // dispatch to correct overloaded match method
 130                 return matcher.match(this, other);
 131         }
 132
 133         /* (omit javadoc for this method)
 134          * Method declared on ASTNode.
 135          */
 136         void accept0(ASTVisitor visitor) {
 137                 boolean visitChildren = visitor.visit(this);
 138                 if (visitChildren) {
 139                         acceptChild(visitor, getQualifier());
 140                 }
 141                 visitor.endVisit(this);
 142         }
 143
 144         /**
 145          * Returns the qualifier of this "this" expression, or
 146          * <code>null</code> if there is none.
 147          *
 148          * @return the qualifier name node, or <code>null</code> if there is none
 149          */
 150         public Name getQualifier() {
 151                 return this.optionalQualifier;
 152         }
 153
 154         /**
 155          * Sets or clears the qualifier of this "this" expression.
 156          *
 157          * @param name the qualifier name node, or <code>null</code> if
 158          *    there is none
 159          * @exception IllegalArgumentException if:
 160          * <ul>
 161          * <li>the node belongs to a different AST</li>
 162          * <li>the node already has a parent</li>
 163          * </ul>
 164          */
 165         public void setQualifier(Name name) {
 166                 ASTNode oldChild = this.optionalQualifier;
 167                 preReplaceChild(oldChild, name, QUALIFIER_PROPERTY);
 168                 this.optionalQualifier = name;
 169                 postReplaceChild(oldChild, name, QUALIFIER_PROPERTY);
 170         }
 171
 172         /* (omit javadoc for this method)
 173          * Method declared on ASTNode.
 174          */
 175         int memSize() {
 176                 // treat Operator as free
 177                 return BASE_NODE_SIZE + 1 * 4;
 178         }
 179
 180         /* (omit javadoc for this method)
 181          * Method declared on ASTNode.
 182          */
 183         int treeSize() {
 184                 return
 185                         memSize()
 186                         + (this.optionalQualifier == null ? 0 : getQualifier().treeSize());
 187         }
 188 }