/usr/include/gpsim/gpsim_interface.h is in gpsim-dev 0.26.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 | /*
Copyright (C) 1998 T. Scott Dattalo
This file is part of the libgpsim library of gpsim
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see
<http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
#ifndef __GPSIM_INTERFACE_H__
#define __GPSIM_INTERFACE_H__
#include "gpsim_classes.h"
#include "interface.h"
#include "trigger.h"
class Stimulus;
class Stimulus_Node;
class ISimConsole;
//---------------------------------------------------------------------------
//
// struct Interface
//
// Here's a structure containing all of the information for gpsim
// and an external interface like the GUI to communicate. There are
// two major functions. First, a GUI can provide pointers to callback
// functions that the simulator can invoke upon certain conditions.
// For example, if the contents of a register change, the simulator
// can notify the GUI and thus save the gui having to continuously
// poll. (This may occur when the command line interface changes
// something; such changes need to be propogated up to the gui.)
//
// FIXME -- shouldn't this be a pure virtual class?
class Interface
{
public:
unsigned int interface_id;
gpointer objectPTR;
/*
* UpdateObject - Invoked when an object changes
*
* If an object, like the contents of a register, changes then this function
* will be called. There are two parameters:
* xref - this is a pointer to some structure in the client's data space.
* new_value - this is the new value to which the object has changed.
*
*/
virtual void UpdateObject (gpointer xref,int new_value){};
/*
* remove_object - Invoked when gpsim has removed something.
*
* If an object, like a register, is deleted then this function
* will be called. There is one parameter:
* xref - this is a pointer to some structure in the client's data space.
*
*/
virtual void RemoveObject (gpointer xref) {};
/*
* simulation_has_stopped - invoked when gpsim has stopped simulating (e.g.
* when a breakpoint is encountered).
*
* Some interfaces have more than one instance, so the 'object' parameter
* allows the interface to uniquely identify the particular one.
*/
virtual void SimulationHasStopped (gpointer object) {};
/*
* new_processor - Invoked when a new processor is added to gpsim
*/
virtual void NewProcessor (Processor *new_cpu) {};
/*
* new_module - Invoked when a new module is instantiated.
*
*/
virtual void NewModule (Module *module) {};
/*
* node_configuration_changed - invoked when stimulus configuration has changed
*/
virtual void NodeConfigurationChanged (Stimulus_Node *node) {};
/*
* new_program - Invoked when a new program is loaded into gpsim
*
*/
virtual void NewProgram (Processor *new_cpu) { };
/*
* Update - Invoked when the interface should update itself
*/
virtual void Update (gpointer object) {};
/*
* destructor - called when the interface is destroyed - this gives
* the interface object a chance to save state information.
*/
virtual ~Interface()
{
}
unsigned int get_id(void) { return interface_id;};
void set_id(unsigned int new_id) { interface_id = new_id;};
Interface(gpointer new_object=NULL);
};
class gpsimInterface : public TriggerObject
{
public:
gpsimInterface();
/*
* start_simulation -begin simulating. Simulation stops whenever
* a breakpoint is encountered or the specified duration has expired.
*/
void start_simulation (double duration=0.0);
/*
* step_simulation - run the simulation for one or more simulation cycles.
*/
void step_simulation(int nSteps);
/*
* advance_simulation - run simulation until advancement condition is met.
*/
enum eAdvancementModes {
eAdvanceNextInstruction, // processors - step over call instructions
eAdvanceNextCycle, // system -
eAdvanceNextCall, // processors - run until call instruction
eAdvanceNextReturn, // processors - run until next return
};
void advance_simulation(eAdvancementModes nAdvancement);
void reset (RESET_TYPE resetType=SIM_RESET);
void simulation_has_stopped ();
bool bSimulating();
bool bUsingGUI();
void setGUImode(bool);
// gpsim will call these functions to notify gui and/or modules
// that something has changed.
void update_object (gpointer xref,int new_value);
void remove_object (gpointer xref);
void update ();
void new_processor (Processor *);
void new_module (Module *module);
void node_configuration_changed (Stimulus_Node *node);
void new_program (Processor *);
void set_update_rate(guint64 rate);
guint64 get_update_rate();
unsigned int add_interface(Interface *new_interface);
unsigned int add_socket_interface(Interface *new_interface);
Interface *get_socket_interface() { return socket_interface;}
void remove_interface(unsigned int interface_id);
virtual bool set_break() {return false;}
virtual void callback();
virtual void callback_print();
virtual void print();
virtual void clear();
virtual char const * bpName() { return "gpsim interface"; }
virtual ISimConsole &GetConsole();
private:
GSList *interfaces;
Interface *socket_interface;
unsigned int interface_seq_number;
guint64 update_rate;
guint64 future_cycle;
bool mbSimulating; // Set true if the simulation is running.
bool mbUseGUI; // Set true if gui is being used.
};
#if defined(IN_MODULE) && defined(_WIN32)
// we are in a module: don't access gi object directly!
LIBGPSIM_EXPORT gpsimInterface & get_interface();
#else
// we are in gpsim: use of get_interface() is recommended,
// even if gi object can be accessed directly.
extern gpsimInterface gi;
inline gpsimInterface &get_interface()
{
return gi;
}
#endif
//------------------------------------------------------------------------
class Module;
class ModuleInterface
{
public:
Module *module; // The module we're interfacing with.
ModuleInterface(Module *new_module);
};
//------------------------------------------------------------------------
class Processor;
class ProcessorInterface : public ModuleInterface
{
public:
ProcessorInterface(Processor *cpu);
};
class ISimConsole;
#define CMD_ERR_OK 0
#define CMD_ERR_ABORTED 1
#define CMD_ERR_ERROR 2
#define CMD_ERR_PROCESSORDEFINED 3
#define CMD_ERR_PROCESSORNOTDEFINED 4
#define CMD_ERR_COMMANDNOTDEFINED 5
#define CMD_ERR_NOTIMPLEMENTED 6
#define GPSIM_GETCOMMANDHANDLER "GetCommandHandler"
typedef ICommandHandler * (*PFNGETCOMMANDHANDLER)(void);
class ICommandHandler {
public:
virtual ~ICommandHandler()
{
}
virtual const char *GetName(void) = 0;
// Fixme: should Execute be renamed ExecuteCommand?
virtual int Execute(const char * commandline, ISimConsole *out) = 0;
virtual int ExecuteScript(list<string *> &script, ISimConsole *out) = 0;
};
#endif // __GPSIM_INTERFACE_H__
|