CodeSnippet.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 CodeSnippet.hh
 *
 * Declaration of CodeSnippet class.
 *
 * @author Ari Metsähalme 2005 (ari.metsahalme-no.spam-tut.fi)
 * @note rating: red
 */
 
#ifndef TTA_CODESNIPPET_HH
#define TTA_CODESNIPPET_HH
 
#include <vector>
 
#include "Exception.hh"
#include "Address.hh"
 
namespace TTAMachine {
    class AddressSpace;
}
 
namespace TTAProgram {
    class Program;
    class Instruction;
    class Address;
 
/**
 * A code snippet is an ordered sequence of adjacent instructions.
 *
 * It is a helper class for representing pieces of code that are not
 * necessarily full procedures, for example basic blocks. Code snippet
 * doesn't care, whether the sequence of instructions in it makes sense
 * or not. That's the responsibility of the client that created the
 * snippet.
 */
class CodeSnippet {
public:
    CodeSnippet();
    CodeSnippet(const TTAProgram::Address& start);
 
    virtual ~CodeSnippet();
 
    virtual void clear();
 
    virtual void removeLastInstruction();
    virtual int instructionCount() const;
 
    virtual Program& parent() const;
    virtual void setParent(Program& prog);
    virtual bool isInProgram() const;
 
    virtual Address address(const Instruction& ins) const;
 
    virtual Address startAddress() const;
    virtual void setStartAddress(Address start);
    virtual Address endAddress() const;
    virtual void setEndAddress(Address end);
 
    virtual Instruction& firstInstruction() const;
    virtual Instruction& instructionAt(UIntWord address) const;
 
    virtual Instruction& instructionAtIndex(int index) const;
    virtual Instruction& operator[](size_t index) const;
 
    virtual bool hasNextInstruction(const Instruction& ins) const;
    virtual Instruction& nextInstruction(const Instruction& ins) const;
    virtual Instruction& previousInstruction(const Instruction& ins) const;
    virtual Instruction& lastInstruction() const;
 
    virtual void addFront(Instruction* ins);
    virtual void add(Instruction* ins);
    virtual void insertAfter(const Instruction& pos, Instruction* ins);
    virtual void insertBefore(const Instruction& pos, Instruction* ins);
 
    virtual void remove(Instruction& ins);
 
    virtual void deleteInstructionAt(InstructionAddress address);
 
    virtual CodeSnippet* copy() const;
 
    virtual void prepend(const CodeSnippet& cs);
    virtual void prepend(CodeSnippet* cs);
    virtual void append(const CodeSnippet& cs);
    virtual void append(CodeSnippet* cs);
    
    virtual void insertBefore(const Instruction& pos, const CodeSnippet& cs);
    virtual void insertBefore(const Instruction& pos, CodeSnippet* cs);
    virtual void insertAfter(const Instruction& pos, const CodeSnippet& cs);
    virtual void insertAfter(const Instruction& pos, CodeSnippet* cs);
 
    bool hasReturn() const;
 
    virtual std::string disassembly() const;
    virtual std::string toString() const { return disassembly(); }
 
protected:
    /// List of instructions.
    typedef std::vector<Instruction*> InsList;
    /// Iterator for the instruction list.
    typedef InsList::iterator InsIter;
 
    /// The instructions in this procedure.
    InsList instructions_;
    /// The parent program of the procedure.
    Program* parent_;
    /// The start (lowest) address of the procedure.
    Address startAddr_;
    /// The highest address of the procedure.
    Address endAddr_;
 
};
 
}
 
#endif