blob: 4cc69de3de5b977886d737688af074e866bc686e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
/**
* @module cinstruction
* @author Guenther Neuwirth (0626638), Manuel Mausz (0728348)
* @brief Abstract class for displays
* @date 13.05.2009
*/
#ifndef CINSTRUCTION_H
#define CINSTRUCTION_H 1
#include <iostream>
#include <list>
/* forward declare CCPU */
class CCPU;
/**
* @class CInstruction
*
* Abstract class for displays
*/
class CInstruction
{
public:
/**
* @method CInstruction
* @brief Default ctor
* @param name name of instruction
* @return -
* @globalvars none
* @exception none
* @conditions none
*/
CInstruction(std::string name)
: m_name(name)
{}
/**
* @method ~CInstruction
* @brief Default dtor
* @param -
* @return -
* @globalvars none
* @exception none
* @conditions none
*/
virtual ~CInstruction()
{}
/**
* @method operator==
* @brief implementation of operator ==
* @param name reference to std::string
* @return true if instructionname is name
* @globalvars none
* @exception none
* @conditions none
*/
virtual bool operator==(std::string& name)
{
return name == m_name;
}
/**
* @method operator()
* @brief implementation of operator (CCPU)
* @param cpu pointer to cpu
* @return -
* @globalvars none
* @exception std::runtime_error
* @conditions none
*/
virtual CInstruction& operator()(CCPU *cpu)
{
execute(cpu);
return *this;
}
/**
* @method getName
* @brief returns instruction name
* @param -
* @return name of instruction
* @globalvars none
* @exception none
* @conditions none
*/
virtual const std::string& getName()
{
return m_name;
}
/**
* @method dump
* @brief dumps information about instruction to outputstream
* @param stream outputstream
* @return reference to outputstream
* @globalvars none
* @exception none
* @conditions none
*/
virtual std::ostream& dump(std::ostream& stream)
{
stream << m_name;
return stream;
}
/**
* @method operator<<
* @brief Shift/output operator for outputstream
* @param stream reference to outputstream
* @param instr object which will be printed to stream
* @return reference to outputstream
* @globalvars none
* @exception none
* @conditions none
*/
friend std::ostream& operator<<(std::ostream& stream, CInstruction& instr)
{
return instr.dump(stream);
}
/**
* @method parseRegister
* @brief parses register syntax Rx (e.g. "R1")
* @param str register in assembler syntax
* @return registernumber
* @globalvars none
* @exception std::runtime_error
* @conditions none
*/
virtual const unsigned parseRegister(const std::string& str);
/**
* @method checkRegister
* @brief performs a register boundary check
* does the register exist in cpu?
* @param cpu pointer to cpu
* @param regidx registernumber
* @return -
* @globalvars none
* @exception std::runtime_error
* @conditions none
*/
virtual void checkRegister(CCPU *cpu, const unsigned regidx);
/**
* @method factory
* @brief creates a new instance of this instruction
* @param -
* @return new instruction instance
* @globalvars none
* @exception none
* @conditions none
*/
virtual CInstruction *factory() = 0;
/**
* @method compile
* @brief parses instruction parameters and prepares the
* instruction for executing
* @param params list of parameters of this instruction
* @return -
* @globalvars none
* @exception std::runtime_error
* @conditions none
*/
virtual void compile(std::list<std::string>& params) = 0;
/**
* @method execute
* @brief executes the instruction
* @param cpu pointer to cpu
* @return -
* @globalvars none
* @exception std::runtime_error
* @conditions none
*/
virtual void execute(CCPU *cpu) = 0;
protected:
/* members */
/** name of instruction */
std::string m_name;
};
#endif
/* vim: set et sw=2 ts=2: */
|
