generic/window.hpp

   1 #ifndef _window__hpp__included__
   2 #define _window__hpp__included__
   3
   4 #include "render.hpp"
   5 #include <string>
   6 #include <map>
   7 #include <list>
   8 #include <stdexcept>
   9
  10 #define WINSTATE_NORMAL 0
  11 #define WINSTATE_COMMAND 1
  12 #define WINSTATE_MODAL 2
  13 #define WINSTATE_IDENTIFY 3
  14
  15 class window;
  16
  17 /**
  18  * Some backnotifications.
  19  */
  20 class window_callback
  21 {
  22 public:
  23         virtual ~window_callback() throw();
  24 /**
  25  * Called when user tries to close the window.
  26  */
  27         virtual void on_close() throw();
  28 /**
  29  * Called when user clicks on the screen.
  30  */
  31         virtual void on_click(int32_t x, int32_t y, uint32_t buttonmask) throw();
  32 /**
  33  * Do try to close the window.
  34  */
  35         static void do_close() throw();
  36 /**
  37  * Do click on the screen.
  38  */
  39         static void do_click(int32_t x, int32_t y, uint32_t buttonmask) throw();
  40 /**
  41  * Set the callback handler.
  42  */
  43         static void set_callback_handler(window_callback& cb) throw();
  44 };
  45
  46 /**
  47  * Sound/Graphics init/quit functions. Sound init is called after graphics init, and vice versa for quit.
  48  */
  49 void graphics_init();
  50 void sound_init();
  51 void sound_quit();
  52 void graphics_quit();
  53 void joystick_init();
  54 void joystick_quit();
  55
  56 /**
  57  * This is a handle to graphics system. Note that creating multiple contexts produces undefined results.
  58  */
  59 class window
  60 {
  61 public:
  62         window() throw() {}
  63
  64 /**
  65  * Initialize the graphics system.
  66  */
  67         static void init();
  68
  69 /**
  70  * Shut down the graphics system.
  71  */
  72         static void quit();
  73
  74 /**
  75  * Adds a messages to mesage queue to be shown.
  76  *
  77  * parameter msg: The messages to add (split by '\n').
  78  * throws std::bad_alloc: Not enough memory.
  79  */
  80         static void message(const std::string& msg) throw(std::bad_alloc);
  81
  82 /**
  83  * Get output stream printing into message queue.
  84  *
  85  * Note that lines printed there should be terminated by '\n'.
  86  *
  87  * returns: The output stream.
  88  * throws std::bad_alloc: Not enough memory.
  89  */
  90         static std::ostream& out() throw(std::bad_alloc);
  91
  92 /**
  93  * Displays a modal message, not returning until the message is acknowledged. Keybindings are not available, but
  94  * should quit be generated somehow, modal message will be closed and command callback triggered.
  95  *
  96  * parameter msg: The message to show.
  97  * parameter confirm: If true, ask for Ok/cancel type input.
  98  * returns: If confirm is true, true if ok was chosen, false if cancel was chosen. Otherwise always false.
  99  * throws std::bad_alloc: Not enough memory.
 100  */
 101         static bool modal_message(const std::string& msg, bool confirm = false) throw(std::bad_alloc);
 102
 103 /**
 104  * Displays fatal error message, quitting after the user acks it.
 105  */
 106         static void fatal_error() throw();
 107
 108 /**
 109  * Processes inputs. If in non-modal mode (normal mode without pause), this returns quickly. Otherwise it waits
 110  * for modal mode to exit. Also needs to call poll_joysticks().
 111  *
 112  * throws std::bad_alloc: Not enough memory.
 113  */
 114         static void poll_inputs() throw(std::bad_alloc);
 115
 116 /**
 117  * Get emulator status area
 118  *
 119  * returns: Emulator status area.
 120  */
 121         static std::map<std::string, std::string>& get_emustatus() throw();
 122
 123 /**
 124  * Notify that the screen has been updated.
 125  *
 126  * parameter full: Do full refresh if true.
 127  */
 128         static void notify_screen_update(bool full = false) throw();
 129
 130 /**
 131  * Set the screen to use as main surface.
 132  *
 133  * parameter scr: The screen to use.
 134  */
 135         static void set_main_surface(screen& scr) throw();
 136
 137 /**
 138  * Enable/Disable pause mode.
 139  *
 140  * parameter enable: Enable pause if true, disable otherwise.
 141  */
 142         static void paused(bool enable) throw();
 143
 144 /**
 145  * Wait specified number of microseconds (polling for input).
 146  *
 147  * parameter usec: Number of us to wait.
 148  * throws std::bad_alloc: Not enough memory.
 149  */
 150         static void wait_usec(uint64_t usec) throw(std::bad_alloc);
 151
 152 /**
 153  * Cancel pending wait_usec, making it return now.
 154  */
 155         static void cancel_wait() throw();
 156
 157 /**
 158  * Enable or disable sound.
 159  *
 160  * parameter enable: Enable sounds if true, otherwise disable sounds.
 161  */
 162         static void sound_enable(bool enable) throw();
 163
 164 /**
 165  * Input audio sample (at 32040.5Hz).
 166  *
 167  * parameter left: Left sample.
 168  * parameter right: Right sample.
 169  */
 170         static void play_audio_sample(uint16_t left, uint16_t right) throw();
 171
 172 /**
 173  * Set window main screen compensation parameters. This is used for mouse click reporting.
 174  *
 175  * parameter xoffset: X coordinate of origin.
 176  * parameter yoffset: Y coordinate of origin.
 177  * parameter hscl: Horizontal scaling factor.
 178  * parameter vscl: Vertical scaling factor.
 179  */
 180         static void set_window_compensation(uint32_t xoffset, uint32_t yoffset, uint32_t hscl, uint32_t vscl);
 181
 182 /**
 183  * Set sound sampling rate.
 184  *
 185  * parameter rate_n: Numerator of sampling rate.
 186  * parameter rate_d: Denomerator of sampling rate.
 187  */
 188         static void set_sound_rate(uint32_t rate_n, uint32_t rate_d);
 189
 190 /**
 191  * Has the sound system been successfully initialized?
 192  */
 193         static bool sound_initialized();
 194
 195 /**
 196  * Set sound device.
 197  */
 198         static void set_sound_device(const std::string& dev);
 199
 200 /**
 201  * Get current sound device.
 202  */
 203         static std::string get_current_sound_device();
 204
 205 /**
 206  * Get available sound devices.
 207  */
 208         static std::map<std::string, std::string> get_sound_devices();
 209 private:
 210         window(const window&);
 211         window& operator==(const window&);
 212 };
 213
 214 void poll_joysticks();
 215
 216 extern const char* sound_plugin_name;
 217 extern const char* graphics_plugin_name;
 218 extern const char* joystick_plugin_name;
 219
 220 #endif