/*

 * Copyright (C) 2012 David Anderson

 *

 * This file is part of JITCraft.

 *

 * JITCraft is free software: you can redistribute it and/or modify it under

 * the terms of the GNU General Public License as published by the Free

 * Software Foundation, either version 3 of the License, or (at your option)

 * any later version.

 * 

 * Foobar 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 for more details.

 *

 * You should have received a copy of the GNU General Public License along with

 * JITCraft. If not, see http://www.gnu.org/licenses/.

 */

#ifndef _include_jitcraft_scopes_h_

#define _include_jitcraft_scopes_h_

#include "../PoolAllocator.h"

#include "../Structures.h"

#include "AST.h"

#include "NameBinding.h"

namespace ke {

class CompileContext;

class EnvironmentMap;

class Struct;

class Scope : public PoolObject

{

  protected:

    PoolAllocator &pool_;

    PoolList<Symbol *> names_;

    PoolList<Scope *> children_;

    bool empty() const {

        return names_.length() == 0;

    }

    void unlink();

  public:

    enum Kind {

        IMPORT,

        GLOBAL,

        FUNCTION,

        BLOCK

    };

  public:

    Scope(PoolAllocator &pool, Kind kind, Scope *enclosing);

    bool initialize();

    Kind kind() const {

        return kind_;

    }

    Scope *enclosing() const {

        return enclosing_;

    }

    bool addSymbol(Symbol *symbol);

    Scope *unlinkIfEmpty();

    Symbol *localLookup(Handle<String> name);

    Symbol *lookup(Handle<String> name);

    EnvironmentMap *createEnvironmentMap(Zone *zone);

    void setParent(Scope *parent) {

        assert(!enclosing_ || enclosing_ == parent);

        enclosing_ = parent;

    }

  private:

    Kind kind_;

    Scope *enclosing_;

};

class ArgumentScope : public Scope

{

  public:

    static ArgumentScope *New(PoolAllocator &pool);

  private:

    ArgumentScope(PoolAllocator &pool);

};

class LocalScope : public Scope

{

  public:

    static LocalScope *New(PoolAllocator &pool);

  private:

    LocalScope(PoolAllocator &pool);

};

class GlobalScope : public Scope

{

  public:

    static GlobalScope *New(PoolAllocator &pool, ImportScope *parent);

    bool addPublic(Symbol *symbol);

    Symbol *findPublic(Handle<String> name);

    Struct *build(Zone *zone);

  private:

    GlobalScope(PoolAllocator &pool, ImportScope *parent);

  private:

    PoolList<Symbol *> publics_;

};

class ImportScope : public Scope

{

  public:

    static ImportScope *New(PoolAllocator &pool);

  private:

    ImportScope(PoolAllocator &pool);

};

}

#endif // _include_jitcraft_scopes_h_