OpenASIP  2.0
NullProcedure.hh
Go to the documentation of this file.
1 /*
2  Copyright (c) 2002-2009 Tampere University.
3 
4  This file is part of TTA-Based Codesign Environment (TCE).
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23  */
24 /**
25  * @file NullProcedure.hh
26  *
27  * Declaration of NullProcedure class.
28  *
29  * @author Ari Metsähalme 2005 (ari.metsahalme-no.spam-tut.fi)
30  * @note rating: red
31  */
32 
33 #ifndef TTA_NULL_PROCEDURE_HH
34 #define TTA_NULL_PROCEDURE_HH
35 
36 #include "BaseType.hh"
37 #include "Procedure.hh"
38 #include "Address.hh"
39 
40 namespace TTAProgram {
41 
42 class Instruction;
43 class CodeSnippet;
44 
45 /**
46  * A singleton class that represents a null procedure.
47  *
48  * Calling any method causes the program to abort.
49  */
50 class NullProcedure : public Procedure {
51 public:
52  virtual ~NullProcedure();
53  static NullProcedure& instance();
54 
55  Program& parent() const;
56  void setParent(Program& prog);
57  bool isInProgram() const;
58  std::string name() const;
59  int alignment() const;
60 
61  Address address(const Instruction& ins) const;
62 
63  Address startAddress() const;
64  void setStartAddress(Address start);
65  Address endAddress() const;
66 
67  int instructionCount() const;
70  bool hasNextInstruction(const Instruction& ins) const;
71  Instruction& nextInstruction(const Instruction& ins) const;
72  Instruction& previousInstruction(const Instruction& ins) const;
74 
75  void addInstruction(Instruction& ins);
76  void insertInstructionAfter(const Instruction& pos, Instruction* ins);
77 
78 protected:
79  NullProcedure();
80 
81 private:
82  /// Copying not allowed.
84  /// Assignment not allowed.
86 
87  /// Unique instance of NullProcedure.
89 };
90 
91 }
92 
93 #endif
TTAProgram::NullProcedure::NullProcedure
NullProcedure()
Definition: NullProcedure.cc:52
TTAProgram
Definition: Estimator.hh:65
UIntWord
Word UIntWord
Definition: BaseType.hh:144
TTAProgram::NullProcedure::insertInstructionAfter
void insertInstructionAfter(const Instruction &pos, Instruction *ins)
Definition: NullProcedure.cc:250
TTAProgram::Program
Definition: Program.hh:63
BaseType.hh
TTAProgram::NullProcedure::addInstruction
void addInstruction(Instruction &ins)
Definition: NullProcedure.cc:240
TTAProgram::Address
Definition: Address.hh:51
TTAProgram::NullProcedure::instructionAt
Instruction & instructionAt(UIntWord address) const
Definition: NullProcedure.cc:181
TTAProgram::NullProcedure::~NullProcedure
virtual ~NullProcedure()
Definition: NullProcedure.cc:59
TTAProgram::Instruction
Definition: Instruction.hh:57
TTAProgram::NullProcedure::alignment
int alignment() const
Definition: NullProcedure.cc:110
Procedure.hh
TTAProgram::NullProcedure::instance
static NullProcedure & instance()
Definition: NullProcedure.cc:68
TTAProgram::NullProcedure
Definition: NullProcedure.hh:50
TTAProgram::NullProcedure::instructionCount
int instructionCount() const
Definition: NullProcedure.cc:163
TTAProgram::NullProcedure::parent
Program & parent() const
Definition: NullProcedure.cc:79
TTAProgram::NullProcedure::isInProgram
bool isInProgram() const
Definition: NullProcedure.cc:98
TTAProgram::NullProcedure::previousInstruction
Instruction & previousInstruction(const Instruction &ins) const
Definition: NullProcedure.cc:217
TTAProgram::NullProcedure::setParent
void setParent(Program &prog)
Definition: NullProcedure.cc:88
TTAProgram::NullProcedure::setStartAddress
void setStartAddress(Address start)
Definition: NullProcedure.cc:142
TTAProgram::NullProcedure::name
std::string name() const
Definition: NullProcedure.cc:104
TTAProgram::NullProcedure::startAddress
Address startAddress() const
Definition: NullProcedure.cc:133
TTAProgram::NullProcedure::endAddress
Address endAddress() const
Definition: NullProcedure.cc:152
TTAProgram::NullProcedure::instance_
static NullProcedure instance_
Unique instance of NullProcedure.
Definition: NullProcedure.hh:88
Address.hh
TTAProgram::NullProcedure::address
Address address(const Instruction &ins) const
Definition: NullProcedure.cc:122
TTAProgram::NullProcedure::operator=
NullProcedure & operator=(const NullProcedure &)
Assignment not allowed.
TTAProgram::NullProcedure::nextInstruction
Instruction & nextInstruction(const Instruction &ins) const
Definition: NullProcedure.cc:205
TTAProgram::NullProcedure::firstInstruction
Instruction & firstInstruction() const
Definition: NullProcedure.cc:169
TTAProgram::NullProcedure::hasNextInstruction
bool hasNextInstruction(const Instruction &ins) const
Definition: NullProcedure.cc:193
TTAProgram::Procedure
Definition: Procedure.hh:55
TTAProgram::NullProcedure::lastInstruction
Instruction & lastInstruction() const
Definition: NullProcedure.cc:229