OpenASIP  2.0
SimulatorTextGenerator.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 SimulatorTextGenerator.hh
26  *
27  * Declaration of the SimulatorTextGenerator class.
28  *
29  * @author Pekka Jääskeläinen 2005 (pjaaskel-no.spam-.cs.tut.fi)
30  * @note rating: red
31  */
32 
33 #ifndef TTA_SIM_TEXT_GENERATOR_HH
34 #define TTA_SIM_TEXT_GENERATOR_HH
35 
36 #include "TextGenerator.hh"
37 
38 /**
39  * Provides common texts for simulator user interfaces.
40  */
42 public:
44  virtual ~SimulatorTextGenerator();
45  virtual void generateCompiledSimTexts();
46 };
47 
48 namespace Texts {
49  /// Ids for the generated texts.
50  enum {
60  ///< Help text for command "prog" of the CLI.
62  ///< Help text for command "mach" of the CLI.
64  ///< Help text for command "conf" of the CLI.
66  ///< Help text for command "quit" of the CLI.
68  ///< Help text for command "disassemble" of the CLI.
70  ///< Help text for command "run" of the CLI.
72  ///< Help text for command "stepi" of the CLI.
74  ///< Help text for command "commands" of the CLI.
76  ///< Help text for command "stepi" of the CLI.
78  ///< Help text for command "setting" of the CLI.
80  ///< Help text for command "resume" of the CLI.
82  ///< Help text for command "help" of the CLI.
84  ///< Help text for command "info" of the CLI.
86  ///< Help text for command "bp" of the CLI.
88  ///< Help text for command "watch" of the CLI.
90  ///< Help text for command "tbp" of the CLI.
92  ///< Help text for command "condition" of the CLI.
94  ///< Help text for command "ignore" of the CLI.
96  ///< Help text for command "deletebp" of the CLI.
98  ///< Help text for command "enablebp" of the CLI.
100  ///< Help text for command "disablebp" of the CLI.
102  ///< Help text for command "nexti" of the CLI.
104  ///< Help text for command "kill" of the CLI.
106  ///< Help text for command "x" of the CLI.
108  ///< Help text for command "load_data" of the CLI.
110  ///< Online help text.
113  ///< Text of the exception thrown when Immediate Unit state could not
114  /// be found and there is instruction referring to it.
116  ///< Text of the exception thrown when the terminal type of a move is
117  /// not regocnized.
119  ///< Text of the exception thrown when RegisterFileState could not
120  /// be found and there is instruction referring to it.
122  ///< Text of the exception thrown when FUPortState could not
123  /// be found and there is instruction referring to it.
125  ///< Text of the exception thrown when FUPortState could not
126  /// be found and there is instruction referring to it.
128  ///< Text of the exception thrown when a port to be written is an
129  /// opcode setting port and no opcode is found in the move.
132  ///< Text to be printed when simulation is not initialized and
133  /// it should be.
135  ///< Text to be printed when simulation is already running and
136  /// it should not be.
138  ///< Text to be printed when simulation is not running and
139  /// it should be.
141  ///< Text to be printed when simulation has not ended and
142  /// it should be.
144  ///< In case user tried to set a setting with illegal parameter.
153  ///< Description of the execution trace setting.
155  ///< Description of the simulation time statistics setting
157  ///< Simulation timeout in seconds
159  ///< Use static compilation when using compiled simulator
161  ///< Description of the execution trace setting.
163  ///< Status string of stopped simulation.
165  ///< Status string of a finished simulation.
167  ///< Status string of initialized simulation (program loaded).
169  ///< Status string of non-initialized simulation (program not loaded).
171  ///< Stop reason: breakpoint.
173  ///< Stop reason: temporary breakpoint.
175  ///< Stop reason: until.
177  ///< Stop reason: timeout
179  ///< Stop reason: stepping.
181  ///< Stop reason: user requested.
183  ///< Stop reason: user requested.
205  };
206 
207 }
208 
209 #endif
Texts::TXT_INTERP_HELP_RUN
@ TXT_INTERP_HELP_RUN
Help text for command "run" of the CLI.
Definition: SimulatorTextGenerator.hh:69
Texts::TXT_BREAKPOINT_NOT_FOUND
@ TXT_BREAKPOINT_NOT_FOUND
Definition: SimulatorTextGenerator.hh:186
Texts::TXT_ILLEGAL_PROGRAM_IU_STATE_NOT_FOUND
@ TXT_ILLEGAL_PROGRAM_IU_STATE_NOT_FOUND
Text of the exception thrown when Immediate Unit state could not be found and there is instruction re...
Definition: SimulatorTextGenerator.hh:112
Texts::TXT_ILLEGAL_PROGRAM_UNKNOWN_MOVE_TERMINAL_TYPE
@ TXT_ILLEGAL_PROGRAM_UNKNOWN_MOVE_TERMINAL_TYPE
Text of the exception thrown when the terminal type of a move is not regocnized.
Definition: SimulatorTextGenerator.hh:115
Texts::TXT_INTERP_HELP_MACH
@ TXT_INTERP_HELP_MACH
Help text for command "mach" of the CLI.
Definition: SimulatorTextGenerator.hh:61
Texts::TXT_INTERP_HELP_DISABLEBP
@ TXT_INTERP_HELP_DISABLEBP
Help text for command "disablebp" of the CLI.
Definition: SimulatorTextGenerator.hh:99
Texts::TXT_INTERP_SETTING_MEMORY_ACCESS_TRACKING
@ TXT_INTERP_SETTING_MEMORY_ACCESS_TRACKING
Definition: SimulatorTextGenerator.hh:199
Texts::TXT_STOPREASON_BREAKPOINT
@ TXT_STOPREASON_BREAKPOINT
Stop reason: breakpoint.
Definition: SimulatorTextGenerator.hh:170
Texts::TXT_STOPREASON_DELETED_BREAKPOINT
@ TXT_STOPREASON_DELETED_BREAKPOINT
Stop reason: temporary breakpoint.
Definition: SimulatorTextGenerator.hh:172
Texts::TXT_INTERP_HELP_DISASSEMBLE
@ TXT_INTERP_HELP_DISASSEMBLE
Help text for command "disassemble" of the CLI.
Definition: SimulatorTextGenerator.hh:67
Texts::TXT_INTERP_SETTING_NEXT_INSTRUCTION_PRINTING
@ TXT_INTERP_SETTING_NEXT_INSTRUCTION_PRINTING
Definition: SimulatorTextGenerator.hh:149
Texts::TXT_INTERP_SETTING_RFTRACKING
@ TXT_INTERP_SETTING_RFTRACKING
Definition: SimulatorTextGenerator.hh:147
Texts::TXT_STARTUP_SETTINGS_CHANGED_WARNING
@ TXT_STARTUP_SETTINGS_CHANGED_WARNING
Definition: SimulatorTextGenerator.hh:204
Texts::TXT_ILLEGAL_ADDRESS_EXPRESSION
@ TXT_ILLEGAL_ADDRESS_EXPRESSION
Definition: SimulatorTextGenerator.hh:185
Texts::TXT_ADDRESS_OUT_OF_RANGE
@ TXT_ADDRESS_OUT_OF_RANGE
Definition: SimulatorTextGenerator.hh:192
Texts::TXT_ADDRESS_SPACE_NOT_FOUND
@ TXT_ADDRESS_SPACE_NOT_FOUND
Definition: SimulatorTextGenerator.hh:193
Texts::TXT_EXPRESSION_EMPTY
@ TXT_EXPRESSION_EMPTY
Definition: SimulatorTextGenerator.hh:189
Texts::TXT_INTERP_HELP_WATCH
@ TXT_INTERP_HELP_WATCH
Help text for command "watch" of the CLI.
Definition: SimulatorTextGenerator.hh:87
Texts::TXT_INTERP_HELP_TBREAK
@ TXT_INTERP_HELP_TBREAK
Help text for command "tbp" of the CLI.
Definition: SimulatorTextGenerator.hh:89
Texts::TXT_INTERP_SETTING_PROCEDURE_TRANSFER_TRACKING
@ TXT_INTERP_SETTING_PROCEDURE_TRANSFER_TRACKING
Definition: SimulatorTextGenerator.hh:198
Texts::TXT_INTERP_HELP_DELETEBP
@ TXT_INTERP_HELP_DELETEBP
Help text for command "deletebp" of the CLI.
Definition: SimulatorTextGenerator.hh:95
Texts::TXT_INTERP_HELP_ENABLEBP
@ TXT_INTERP_HELP_ENABLEBP
Help text for command "enablebp" of the CLI.
Definition: SimulatorTextGenerator.hh:97
Texts::TXT_INTERP_SETTING_HISTORY_SAVE
@ TXT_INTERP_SETTING_HISTORY_SAVE
Definition: SimulatorTextGenerator.hh:150
Texts::TXT_FUPORT_NOT_FOUND
@ TXT_FUPORT_NOT_FOUND
Definition: SimulatorTextGenerator.hh:58
Texts::TXT_CMD_LINE_HELP
@ TXT_CMD_LINE_HELP
Definition: SimulatorTextGenerator.hh:111
Texts::TXT_INTERP_HELP_STEPI
@ TXT_INTERP_HELP_STEPI
Help text for command "stepi" of the CLI.
Definition: SimulatorTextGenerator.hh:71
Texts::TXT_UNABLE_TO_LOAD_PROGRAM
@ TXT_UNABLE_TO_LOAD_PROGRAM
Definition: SimulatorTextGenerator.hh:195
Texts::TXT_STATUS_STOPPED
@ TXT_STATUS_STOPPED
Status string of stopped simulation.
Definition: SimulatorTextGenerator.hh:162
Texts::TXT_INTERP_HELP_CONDITION
@ TXT_INTERP_HELP_CONDITION
Help text for command "condition" of the CLI.
Definition: SimulatorTextGenerator.hh:91
Texts::TXT_STOPREASON_USERREQUEST
@ TXT_STOPREASON_USERREQUEST
Stop reason: user requested.
Definition: SimulatorTextGenerator.hh:180
Texts::TXT_STATIC_COMPILATION
@ TXT_STATIC_COMPILATION
Use static compilation when using compiled simulator.
Definition: SimulatorTextGenerator.hh:158
Texts::TXT_INTERP_SETTING_BUSTRACE
@ TXT_INTERP_SETTING_BUSTRACE
Definition: SimulatorTextGenerator.hh:146
Texts::TXT_IMMEDIATE_UNIT_NOT_FOUND
@ TXT_IMMEDIATE_UNIT_NOT_FOUND
Definition: SimulatorTextGenerator.hh:55
Texts::TXT_INTERP_ENTER_CONDITION_PROMPT
@ TXT_INTERP_ENTER_CONDITION_PROMPT
Definition: SimulatorTextGenerator.hh:187
Texts::TXT_INTERP_HELP_X
@ TXT_INTERP_HELP_X
Help text for command "x" of the CLI.
Definition: SimulatorTextGenerator.hh:105
Texts::TXT_CONFIRM_KILL_SIMULATION
@ TXT_CONFIRM_KILL_SIMULATION
Definition: SimulatorTextGenerator.hh:191
SimulatorTextGenerator::~SimulatorTextGenerator
virtual ~SimulatorTextGenerator()
Definition: SimulatorTextGenerator.cc:582
Texts::TXT_INTERP_SETTING_PARSE_ERROR
@ TXT_INTERP_SETTING_PARSE_ERROR
In case user tried to set a setting with illegal parameter.
Definition: SimulatorTextGenerator.hh:143
Texts::TXT_BUS_NOT_FOUND
@ TXT_BUS_NOT_FOUND
Definition: SimulatorTextGenerator.hh:57
Texts::TXT_STOPREASON_RUNTIME_ERROR
@ TXT_STOPREASON_RUNTIME_ERROR
Stop reason: user requested.
Definition: SimulatorTextGenerator.hh:182
SimulatorTextGenerator
Definition: SimulatorTextGenerator.hh:41
Texts::TXT_INTERP_SETTING_HISTORY_SIZE
@ TXT_INTERP_SETTING_HISTORY_SIZE
Description of the execution trace setting.
Definition: SimulatorTextGenerator.hh:152
Texts::TXT_INTERP_SETTING_HISTORY_FILENAME
@ TXT_INTERP_SETTING_HISTORY_FILENAME
Definition: SimulatorTextGenerator.hh:148
Texts::TXT_INTERP_SIMULATION_NOT_RUNNING
@ TXT_INTERP_SIMULATION_NOT_RUNNING
Text to be printed when simulation is not running and it should be.
Definition: SimulatorTextGenerator.hh:137
Texts::TXT_INTERP_ENTER_EXPRESSION_PROMPT
@ TXT_INTERP_ENTER_EXPRESSION_PROMPT
Definition: SimulatorTextGenerator.hh:188
Texts::TXT_CLI_ONLINE_HELP
@ TXT_CLI_ONLINE_HELP
Online help text.
Definition: SimulatorTextGenerator.hh:109
Texts::TXT_INTERP_HELP_COMMANDS
@ TXT_INTERP_HELP_COMMANDS
Help text for command "commands" of the CLI.
Definition: SimulatorTextGenerator.hh:73
Texts::TXT_STOPREASON_STEPPING
@ TXT_STOPREASON_STEPPING
Stop reason: stepping.
Definition: SimulatorTextGenerator.hh:178
Texts::TXT_INTERP_SIMULATION_NOT_INITIALIZED
@ TXT_INTERP_SIMULATION_NOT_INITIALIZED
Text to be printed when simulation is not initialized and it should be.
Definition: SimulatorTextGenerator.hh:131
Texts::TXT_INTERP_HELP_INFO
@ TXT_INTERP_HELP_INFO
Help text for command "info" of the CLI.
Definition: SimulatorTextGenerator.hh:83
Texts::TXT_INTERP_SETTING_UTILIZATION_SAVING
@ TXT_INTERP_SETTING_UTILIZATION_SAVING
Definition: SimulatorTextGenerator.hh:200
Texts::TXT_LABEL_NOT_FOUND
@ TXT_LABEL_NOT_FOUND
Definition: SimulatorTextGenerator.hh:184
Texts::TXT_ILLEGAL_PROGRAM_PORT_STATE_NOT_FOUND
@ TXT_ILLEGAL_PROGRAM_PORT_STATE_NOT_FOUND
Text of the exception thrown when FUPortState could not be found and there is instruction referring t...
Definition: SimulatorTextGenerator.hh:121
Texts::TXT_INTERP_HELP_IGNORE
@ TXT_INTERP_HELP_IGNORE
Help text for command "ignore" of the CLI.
Definition: SimulatorTextGenerator.hh:93
Texts::TXT_STOPREASON_UNTIL
@ TXT_STOPREASON_UNTIL
Stop reason: until.
Definition: SimulatorTextGenerator.hh:174
Texts::TXT_INTERP_HELP_NEXTI
@ TXT_INTERP_HELP_NEXTI
Help text for command "nexti" of the CLI.
Definition: SimulatorTextGenerator.hh:101
Texts::TXT_NO_PROGRAM_LOADED
@ TXT_NO_PROGRAM_LOADED
Definition: SimulatorTextGenerator.hh:202
Texts::TXT_SIMULATION_TIME_STATISTICS
@ TXT_SIMULATION_TIME_STATISTICS
Description of the simulation time statistics setting.
Definition: SimulatorTextGenerator.hh:154
Texts::TXT_INTERP_SIMULATION_NOT_ENDED
@ TXT_INTERP_SIMULATION_NOT_ENDED
Text to be printed when simulation has not ended and it should be.
Definition: SimulatorTextGenerator.hh:140
Texts::TXT_INTERP_HELP_QUIT
@ TXT_INTERP_HELP_QUIT
Help text for command "quit" of the CLI.
Definition: SimulatorTextGenerator.hh:65
Texts::TXT_ILLEGAL_ADF_FILE
@ TXT_ILLEGAL_ADF_FILE
Definition: SimulatorTextGenerator.hh:52
Texts::TextGenerator
Definition: TextGenerator.hh:79
Texts::TXT_INTERP_HELP_RESUME
@ TXT_INTERP_HELP_RESUME
Help text for command "resume" of the CLI.
Definition: SimulatorTextGenerator.hh:79
Texts::TXT_FU_NOT_FOUND
@ TXT_FU_NOT_FOUND
Definition: SimulatorTextGenerator.hh:56
Texts::TXT_SIMULATION_TIMEOUT
@ TXT_SIMULATION_TIMEOUT
Simulation timeout in seconds.
Definition: SimulatorTextGenerator.hh:156
Texts::TXT_UNABLE_TO_LOAD_MACHINE
@ TXT_UNABLE_TO_LOAD_MACHINE
Definition: SimulatorTextGenerator.hh:196
TextGenerator.hh
Texts::TXT_NO_ADDRESS_SPACE_GIVEN
@ TXT_NO_ADDRESS_SPACE_GIVEN
Definition: SimulatorTextGenerator.hh:197
Texts::TXT_INTERP_HELP_BREAK
@ TXT_INTERP_HELP_BREAK
Help text for command "bp" of the CLI.
Definition: SimulatorTextGenerator.hh:85
Texts::TXT_ILLEGAL_PROGRAM_BUS_STATE_NOT_FOUND
@ TXT_ILLEGAL_PROGRAM_BUS_STATE_NOT_FOUND
Text of the exception thrown when FUPortState could not be found and there is instruction referring t...
Definition: SimulatorTextGenerator.hh:124
Texts::TXT_INTERP_SIMULATION_ALREDY_RUNNING
@ TXT_INTERP_SIMULATION_ALREDY_RUNNING
Text to be printed when simulation is already running and it should not be.
Definition: SimulatorTextGenerator.hh:134
Texts::TXT_OPERATION_X_NOT_FOUND
@ TXT_OPERATION_X_NOT_FOUND
Definition: SimulatorTextGenerator.hh:130
Texts::TXT_INTERP_SETTING_PROFILE_SAVING
@ TXT_INTERP_SETTING_PROFILE_SAVING
Definition: SimulatorTextGenerator.hh:201
Texts::TXT_REGISTER_NOT_FOUND
@ TXT_REGISTER_NOT_FOUND
Definition: SimulatorTextGenerator.hh:53
Texts::TXT_INTERP_HELP_LOADDATA
@ TXT_INTERP_HELP_LOADDATA
Help text for command "load_data" of the CLI.
Definition: SimulatorTextGenerator.hh:107
Texts::TXT_AUTOMATIC_FINISH_IMPOSSIBLE
@ TXT_AUTOMATIC_FINISH_IMPOSSIBLE
Definition: SimulatorTextGenerator.hh:203
SimulatorTextGenerator::generateCompiledSimTexts
virtual void generateCompiledSimTexts()
Definition: SimulatorTextGenerator.cc:590
Texts
Definition: SimulatorTextGenerator.hh:48
Texts::TXT_REGISTER_FILE_NOT_FOUND
@ TXT_REGISTER_FILE_NOT_FOUND
Definition: SimulatorTextGenerator.hh:54
Texts::TXT_INTERP_HELP_UNTIL
@ TXT_INTERP_HELP_UNTIL
Help text for command "stepi" of the CLI.
Definition: SimulatorTextGenerator.hh:75
Texts::TXT_STATUS_NOT_INITIALIZED
@ TXT_STATUS_NOT_INITIALIZED
Status string of non-initialized simulation (program not loaded).
Definition: SimulatorTextGenerator.hh:168
Texts::TXT_INTERP_HELP_SETTING
@ TXT_INTERP_HELP_SETTING
Help text for command "setting" of the CLI.
Definition: SimulatorTextGenerator.hh:77
SimulatorTextGenerator::SimulatorTextGenerator
SimulatorTextGenerator()
Definition: SimulatorTextGenerator.cc:40
Texts::TXT_INTERP_HELP_COMMANDS_AVAILABLE
@ TXT_INTERP_HELP_COMMANDS_AVAILABLE
Description of the execution trace setting.
Definition: SimulatorTextGenerator.hh:160
Texts::TXT_STOPREASON_TIMEOUT
@ TXT_STOPREASON_TIMEOUT
Stop reason: timeout
Definition: SimulatorTextGenerator.hh:176
Texts::TXT_INTERP_HELP_CONF
@ TXT_INTERP_HELP_CONF
Help text for command "conf" of the CLI.
Definition: SimulatorTextGenerator.hh:63
Texts::TXT_INTERP_SETTING_EXECTRACE
@ TXT_INTERP_SETTING_EXECTRACE
Definition: SimulatorTextGenerator.hh:145
Texts::TXT_NOT_RUNNING_PARALLEL_SIMULATION
@ TXT_NOT_RUNNING_PARALLEL_SIMULATION
Definition: SimulatorTextGenerator.hh:194
Texts::TXT_NO_ADF_DEFINED_IN_PCF
@ TXT_NO_ADF_DEFINED_IN_PCF
Definition: SimulatorTextGenerator.hh:51
Texts::TXT_STATUS_FINISHED
@ TXT_STATUS_FINISHED
Status string of a finished simulation.
Definition: SimulatorTextGenerator.hh:164
Texts::TXT_CONFIRM_DELETE_ALL_BREAKPOINTS
@ TXT_CONFIRM_DELETE_ALL_BREAKPOINTS
Definition: SimulatorTextGenerator.hh:190
Texts::TXT_ILLEGAL_PROGRAM_OPCODE_NOT_FOUND
@ TXT_ILLEGAL_PROGRAM_OPCODE_NOT_FOUND
Text of the exception thrown when a port to be written is an opcode setting port and no opcode is fou...
Definition: SimulatorTextGenerator.hh:127
Texts::TXT_INTERP_HELP_KILL
@ TXT_INTERP_HELP_KILL
Help text for command "kill" of the CLI.
Definition: SimulatorTextGenerator.hh:103
Texts::TXT_INTERP_HELP_PROG
@ TXT_INTERP_HELP_PROG
Help text for command "prog" of the CLI.
Definition: SimulatorTextGenerator.hh:59
Texts::TXT_ILLEGAL_PROGRAM_RF_STATE_NOT_FOUND
@ TXT_ILLEGAL_PROGRAM_RF_STATE_NOT_FOUND
Text of the exception thrown when RegisterFileState could not be found and there is instruction refer...
Definition: SimulatorTextGenerator.hh:118
Texts::LAST__
@ LAST__
Definition: TextGenerator.hh:68
Texts::TXT_STATUS_INITIALIZED
@ TXT_STATUS_INITIALIZED
Status string of initialized simulation (program loaded).
Definition: SimulatorTextGenerator.hh:166
Texts::TXT_INTERP_SETTING_FU_CONFLICT_DETECTION
@ TXT_INTERP_SETTING_FU_CONFLICT_DETECTION
Definition: SimulatorTextGenerator.hh:151
Texts::TXT_INTERP_HELP_HELP
@ TXT_INTERP_HELP_HELP
Help text for command "help" of the CLI.
Definition: SimulatorTextGenerator.hh:81