include/core/window.hpp

   1 #ifndef _window__hpp__included__
   2 #define _window__hpp__included__
   3
   4 #include "render.hpp"
   5 #include "messagebuffer.hpp"
   6 #include <string>
   7 #include <map>
   8 #include <list>
   9 #include <stdexcept>
  10
  11 #define WINSTATE_NORMAL 0
  12 #define WINSTATE_COMMAND 1
  13 #define WINSTATE_MODAL 2
  14 #define WINSTATE_IDENTIFY 3
  15
  16 class window;
  17
  18 /**
  19  * Sound/Graphics init/quit functions. Sound init is called after graphics init, and vice versa for quit.
  20  *
  21  * These need to be implemented by the corresponding plugins.
  22  */
  23 void graphics_init();
  24 void sound_init();
  25 void sound_quit();
  26 void graphics_quit();
  27 void joystick_init();
  28 void joystick_quit();
  29
  30 /**
  31  * This is a handle to graphics system. Note that creating multiple contexts produces undefined results.
  32  */
  33 class window
  34 {
  35 public:
  36 /**
  37  * Window constructor.
  38  */
  39         window() throw() {}
  40
  41 /**
  42  * Initialize the graphics system.
  43  *
  44  * Implemented by generic window code.
  45  */
  46         static void init();
  47
  48 /**
  49  * Shut down the graphics system.
  50  *
  51  * Implemented by generic window code.
  52  */
  53         static void quit();
  54
  55 /**
  56  * Get output stream printing into message queue.
  57  *
  58  * Note that lines printed there should be terminated by '\n'.
  59  *
  60  * Implemented by the generic window code.
  61  *
  62  * returns: The output stream.
  63  * throws std::bad_alloc: Not enough memory.
  64  */
  65         static std::ostream& out() throw(std::bad_alloc);
  66
  67 /**
  68  * Get emulator status area
  69  *
  70  * Implemented by the generic window code.
  71  *
  72  * returns: Emulator status area.
  73  */
  74         static std::map<std::string, std::string>& get_emustatus() throw();
  75
  76 /**
  77  * Message buffer.
  78  *
  79  * Implemented by the generic window code.
  80  */
  81         static messagebuffer msgbuf;
  82
  83 /**
  84  * Adds a messages to mesage queue to be shown.
  85  *
  86  * Implemented by the generic window code.
  87  *
  88  * parameter msg: The messages to add (split by '\n').
  89  * throws std::bad_alloc: Not enough memory.
  90  */
  91         static void message(const std::string& msg) throw(std::bad_alloc);
  92
  93 /**
  94  * Displays fatal error message, quitting after the user acks it (called by fatal_error()).
  95  *
  96  * Needs to be implemented by the graphics plugin.
  97  */
  98         static void fatal_error() throw();
  99
 100 /**
 101  * Enable or disable sound.
 102  *
 103  * Implemented by the generic window code.
 104  *
 105  * parameter enable: Enable sounds if true, otherwise disable sounds.
 106  */
 107         static void sound_enable(bool enable) throw();
 108
 109 /**
 110  * Are sounds enabled?
 111  */
 112         static bool is_sound_enabled() throw();
 113
 114 /**
 115  * Set sound device.
 116  *
 117  * Implemented by the generic window code.
 118  */
 119         static void set_sound_device(const std::string& dev) throw();
 120
 121 /******************************** GRAPHICS PLUGIN **********************************/
 122 /**
 123  * Notification when messages get updated.
 124  *
 125  * Needs to be implemented by the graphics plugin.
 126  */
 127         static void notify_message() throw(std::bad_alloc, std::runtime_error);
 128
 129 /**
 130  * Displays a modal message, not returning until the message is acknowledged. Keybindings are not available, but
 131  * should quit be generated somehow, modal message will be closed and command callback triggered.
 132  *
 133  * Needs to be implemented by the graphics plugin.
 134  *
 135  * parameter msg: The message to show.
 136  * parameter confirm: If true, ask for Ok/cancel type input.
 137  * returns: If confirm is true, true if ok was chosen, false if cancel was chosen. Otherwise always false.
 138  * throws std::bad_alloc: Not enough memory.
 139  */
 140         static bool modal_message(const std::string& msg, bool confirm = false) throw(std::bad_alloc);
 141
 142 /**
 143  * Displays fatal error message, quitting after the user acks it (called by fatal_error()).
 144  *
 145  * Needs to be implemented by the graphics plugin.
 146  */
 147         static void fatal_error2() throw();
 148
 149 /**
 150  * Processes inputs. If in non-modal mode (normal mode without pause), this returns quickly. Otherwise it waits
 151  * for modal mode to exit. Also needs to call window::poll_joysticks().
 152  *
 153  * Needs to be implemented by the graphics plugin.
 154  *
 155  * throws std::bad_alloc: Not enough memory.
 156  */
 157         static void poll_inputs() throw(std::bad_alloc);
 158
 159 /**
 160  * Enable/Disable pause mode.
 161  *
 162  * Needs to be implemented by the graphics plugin.
 163  *
 164  * parameter enable: Enable pause if true, disable otherwise.
 165  */
 166         static void paused(bool enable) throw();
 167
 168 /**
 169  * Wait specified number of microseconds (polling for input).
 170  *
 171  * Needs to be implemented by the graphics plugin.
 172  *
 173  * parameter usec: Number of us to wait.
 174  * throws std::bad_alloc: Not enough memory.
 175  */
 176         static void wait_usec(uint64_t usec) throw(std::bad_alloc);
 177
 178 /**
 179  * Cancel pending wait_usec, making it return now.
 180  *
 181  * Needs to be implemented by the graphics plugin.
 182  */
 183         static void cancel_wait() throw();
 184
 185 /******************************** SOUND PLUGIN **********************************/
 186 /**
 187  * Enable or disable sound.
 188  *
 189  * Needs to be implemented by the sound plugin.
 190  *
 191  * parameter enable: Enable sounds if true, otherwise disable sounds.
 192  */
 193         static void _sound_enable(bool enable) throw();
 194
 195 /**
 196  * Input audio sample (at specified rate).
 197  *
 198  * Needs to be implemented by the sound plugin.
 199  *
 200  * parameter left: Left sample.
 201  * parameter right: Right sample.
 202  */
 203         static void play_audio_sample(uint16_t left, uint16_t right) throw();
 204
 205 /**
 206  * Has the sound system been successfully initialized?
 207  *
 208  * Needs to be implemented by the sound plugin.
 209  */
 210         static bool sound_initialized();
 211
 212 /**
 213  * Set sound device.
 214  *
 215  * Needs to be implemented by the sound plugin.
 216  */
 217         static void _set_sound_device(const std::string& dev);
 218
 219 /**
 220  * Get current sound device.
 221  *
 222  * Needs to be implemented by the sound plugin.
 223  */
 224         static std::string get_current_sound_device();
 225
 226 /**
 227  * Get available sound devices.
 228  *
 229  * Needs to be implemented by the sound plugin.
 230  */
 231         static std::map<std::string, std::string> get_sound_devices();
 232
 233 /******************************** JOYSTICK PLUGIN **********************************/
 234 /**
 235  * Poll joysticks.
 236  *
 237  * Needs to be implemented by the joystick plugin.
 238  */
 239         static void poll_joysticks();
 240 private:
 241         window(const window&);
 242         window& operator==(const window&);
 243 };
 244
 245
 246 /**
 247  * Names of plugins.
 248  */
 249 extern const char* sound_plugin_name;
 250 extern const char* graphics_plugin_name;
 251 extern const char* joystick_plugin_name;
 252
 253 #endif