/*
 *  This file is part of the X10 project (http://x10-lang.org).
 *
 *  This file is licensed to You under the Eclipse Public License (EPL);
 *  You may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *      http://www.opensource.org/licenses/eclipse-1.0.php
 *
 * This file was originally derived from the Polyglot extensible compiler framework.
 *
 *  (C) Copyright 2000-2007 Polyglot project group, Cornell University
 *  (C) Copyright IBM Corporation 2007-2012.
 */

package polyglot.ast;

import polyglot.types.LocalDef;
import polyglot.types.Type;

/**
 * A <code>VarDecl</code> represents a local variable declaration, of either a formal
 * or a local variable.
 */
public interface VarDecl extends Term
{
    /** Get the type object for the declaration's type. */
    Type declType();

    /** Get the declaration's flags. */
    FlagsNode flags();

    /** Set the declaration's flags (return a copy). */
    VarDecl flags(FlagsNode flags);

    /** Get the declaration's type. */
    TypeNode type();

    /** Set the declaration's type (return a copy). */
    VarDecl type(TypeNode type);

    /** Get the declaration's name. */
    Id name();

    /** Set the declaration's name (return a copy). */
    VarDecl name(Id name);

    /**
     * Get the type object for the local we are declaring.  This field may
     * not be valid until after signature disambiguation.
     */
    LocalDef localDef();

    /** Set the type object for the declaration (return a copy). */
    VarDecl localDef(LocalDef ld);
}