/*
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.nashorn.internal.ir;

import static jdk.nashorn.internal.runtime.UnwarrantedOptimismException.INVALID_PROGRAM_POINT;

import jdk.nashorn.internal.codegen.types.Type;
import jdk.nashorn.internal.ir.annotations.Immutable;
import jdk.nashorn.internal.parser.TokenType;

IR base for accessing/indexing nodes.
See Also:
AccessNode
IndexNode/**
 * IR base for accessing/indexing nodes.
 *
 * @see AccessNode
 * @see IndexNode
 */
@Immutable
public abstract class BaseNode extends Expression implements FunctionCall, Optimistic {
    private static final long serialVersionUID = 1L;

    
Base Node. /** Base Node. */
    protected final Expression base;

    private final boolean isFunction;

    
Callsite type for this node, if overridden optimistically or conservatively depending on coercion /** Callsite type for this node, if overridden optimistically or conservatively depending on coercion */
    protected final Type type;

    
Program point id /** Program point id */
    protected final int programPoint;

    
Super property access. /** Super property access. */
    private final boolean isSuper;

    
Constructor
Params:
token –  token
finish – finish
base –   base node
isFunction – is this a function
isSuper – is this a super property access/**
     * Constructor
     *
     * @param token  token
     * @param finish finish
     * @param base   base node
     * @param isFunction is this a function
     * @param isSuper is this a super property access
     */
    public BaseNode(final long token, final int finish, final Expression base, final boolean isFunction, final boolean isSuper) {
        super(token, base.getStart(), finish);
        this.base           = base;
        this.isFunction     = isFunction;
        this.type = null;
        this.programPoint   = INVALID_PROGRAM_POINT;
        this.isSuper        = isSuper;
    }

    
Copy constructor for immutable nodes
Params:
baseNode – node to inherit from
base – base
isFunction – is this a function
callSiteType –  the callsite type for this base node, either optimistic or conservative
programPoint –  program point id
isSuper – is this a super property access/**
     * Copy constructor for immutable nodes
     * @param baseNode node to inherit from
     * @param base base
     * @param isFunction is this a function
     * @param callSiteType  the callsite type for this base node, either optimistic or conservative
     * @param programPoint  program point id
     * @param isSuper is this a super property access
     */
    protected BaseNode(final BaseNode baseNode, final Expression base, final boolean isFunction, final Type callSiteType, final int programPoint, final boolean isSuper) {
        super(baseNode);
        this.base           = base;
        this.isFunction     = isFunction;
        this.type = callSiteType;
        this.programPoint   = programPoint;
        this.isSuper        = isSuper;
    }

    
Get the base node for this access
Returns:
the base node/**
     * Get the base node for this access
     * @return the base node
     */
    public Expression getBase() {
        return base;
    }

    @Override
    public boolean isFunction() {
        return isFunction;
    }

    @Override
    public Type getType() {
        return type == null ? getMostPessimisticType() : type;
    }

    @Override
    public int getProgramPoint() {
        return programPoint;
    }

    @Override
    public Type getMostOptimisticType() {
        return Type.INT;
    }

    @Override
    public Type getMostPessimisticType() {
        return Type.OBJECT;
    }

    @Override
    public boolean canBeOptimistic() {
        return true;
    }

    
Return true if this node represents an index operation normally represented as IndexNode. 
Returns:
true if an index access./**
     * Return true if this node represents an index operation normally represented as {@link IndexNode}.
     * @return true if an index access.
     */
    public boolean isIndex() {
        return isTokenType(TokenType.LBRACKET);
    }

    
Mark this node as being the callee operand of a CallNode. 
Returns:
a base node identical to this one in all aspects except with its function flag set./**
     * Mark this node as being the callee operand of a {@link CallNode}.
     * @return a base node identical to this one in all aspects except with its function flag set.
     */
    public abstract BaseNode setIsFunction();

    
Returns:
true if a SuperProperty access./**
     * @return {@code true} if a SuperProperty access.
     */
    public boolean isSuper() {
        return isSuper;
    }

    
Mark this node as being a SuperProperty access.
Returns:
 a base node identical to this one in all aspects except with its super flag set./**
     * Mark this node as being a SuperProperty access.
     *
     * @return  a base node identical to this one in all aspects except with its super flag set.
     */
    public abstract BaseNode setIsSuper();
}