Scope.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file Scope.hh
 *
 * Declaration of Scope class.
 *
 * @author Ari Metsähalme 2005 (ari.metsahalme-no.spam-tut.fi)
 * @note rating: red
 */
 
#ifndef TTA_SCOPE_HH
#define TTA_SCOPE_HH
 
#include <string>
#include <vector>
 
#include "Address.hh"
#include "Exception.hh"
 
namespace TTAProgram {
 
class CodeLabel;
class DataLabel;
 
/**
 * Scopes provide containers for different visibility level labels.
 *
 * @todo Implement rest of the Scopes (only GlobalScope is supported 
 * currently).
 */
class Scope {
public:
    Scope();
    virtual ~Scope();
 
    virtual bool isGlobal() const;
    virtual bool isUnit() const;
    virtual bool isProcedure() const;
    virtual bool isLocal() const;
 
    bool containsCodeLabel(const std::string& name) const;
    bool containsDataLabel(const std::string& name) const;
 
    const CodeLabel& codeLabel(const std::string& name) const;
    const DataLabel& dataLabel(const std::string& name) const;
 
    int codeLabelCount(Address address) const;
    const CodeLabel& codeLabel(Address address, int index) const;
 
    int dataLabelCount(Address address) const;
    const DataLabel& dataLabel(Address address, int index) const;
 
    virtual void addCodeLabel(const CodeLabel* codeLabel);
    virtual void addDataLabel(const DataLabel* dataLabel);
    virtual void removeCodeLabels(InstructionAddress address);
 
    virtual Scope* copy() const = 0;
 
protected:
    /// List for child scopes.
    typedef std::vector<const Scope*> ScopeList;
    /// Child scopes.
    ScopeList children_;
 
    /// List of data labels.
    typedef std::vector<const DataLabel*> DataLabelList;
    /// List of code labels.
    typedef std::vector<const CodeLabel*> CodeLabelList;
 
    /// Data labels contained by this scope.
    DataLabelList dataLabels_;
    /// Code labels contained by this scope.
    CodeLabelList codeLabels_;
 
    /// Adds a code label and its owner to the global label bookkeeping.
    ///
    /// @param dataLabel The code label to be added.
    /// @param owner The owner scope of the label.
    virtual void addGlobalCodeLabel(
        const CodeLabel& codeLabel, const Scope& owner) = 0;
 
    /// Adds a data label and its owner to the global label bookkeeping.
    ///
    /// @param dataLabel The data label to be added.
    /// @param owner The owner scope of the label.
    virtual void addGlobalDataLabel(
        const DataLabel& dataLabel, const Scope& owner) = 0;
 
    Scope& parent() const;
    void setParent(Scope& scope);
 
    int childCount() const;
    void addChild(const Scope& scope);
    const Scope& child(int index) const;
 
private:
    /// Copying not allowed.
    Scope(const Scope&);
    /// Assignment not allowed.
    Scope& operator=(const Scope&);
 
    /// The smallest outer scope that contains this scope.
    Scope* parent_;
};
 
}
 
#endif