src/osapi/osapi.cpp

   1 /*
   2  * Copyright (C) Volition, Inc. 1999.  All rights reserved.
   3  *
   4  * All source code herein is the property of Volition, Inc. You may not sell
   5  * or otherwise commercially exploit the source or things you created based on
   6  * the source.
   7  */
   8
   9 /*
  10  * $Logfile: /Freespace2/code/OsApi/OsApi.cpp $
  11  * $Revision$
  12  * $Date$
  13  * $Author$
  14  *
  15  * Low level Windows code
  16  *
  17  * $Log$
  18  * Revision 1.18  2005/10/01 21:49:11  taylor
  19  * don't use CTRL-Z for minimizing since it's an extrememly common key combo in the game
  20  *
  21  * Revision 1.17  2004/12/15 04:10:45  taylor
  22  * outwnd_unix.cpp from fs2_open for logging to file in debug mode
  23  * fixes for default function values
  24  * always use vm_* functions for sanity sake
  25  * make cfilearchiver 64-bit compatible
  26  * fix crash on exit from double free()
  27  * fix crash on startup from extra long GL extension string in debug
  28  *
  29  * Revision 1.16  2003/12/15 06:24:51  theoddone33
  30  * Bumpy ride... hang on.
  31  *
  32  * Revision 1.15  2003/08/03 15:56:59  taylor
  33  * simpler mouse usage; default ini settings in os_init(); cleanup
  34  *
  35  * Revision 1.14  2003/05/09 05:04:15  taylor
  36  * better window min/max/focus support
  37  *
  38  * Revision 1.13  2003/05/04 04:56:53  taylor
  39  * move SDL_Quit to os_deinit to fix fonttool segfault
  40  *
  41  * Revision 1.12  2003/02/20 17:41:07  theoddone33
  42  * Userdir patch from Taylor Richards
  43  *
  44  * Revision 1.11  2002/07/28 21:45:30  theoddone33
  45  * Add ctrl-z to iconify window
  46  *
  47  * Revision 1.10  2002/07/28 21:39:44  theoddone33
  48  * Add alt-enter to toggle fullscreen and ctrl-g to toggle mouse grabbing
  49  *
  50  * Revision 1.9  2002/06/16 23:59:31  relnev
  51  * untested joystick code
  52  *
  53  * Revision 1.8  2002/06/09 04:41:25  relnev
  54  * added copyright header
  55  *
  56  * Revision 1.7  2002/06/05 04:03:32  relnev
  57  * finished cfilesystem.
  58  *
  59  * removed some old code.
  60  *
  61  * fixed mouse save off-by-one.
  62  *
  63  * sound cleanups.
  64  *
  65  * Revision 1.6  2002/05/31 03:34:02  theoddone33
  66  * Fix Keyboard
  67  * Add titlebar
  68  *
  69  * Revision 1.5  2002/05/30 23:46:29  theoddone33
  70  * some minor key changes (not necessarily fixes)
  71  *
  72  * Revision 1.4  2002/05/30 16:50:24  theoddone33
  73  * Keyboard partially fixed
  74  *
  75  * Revision 1.3  2002/05/29 06:25:13  theoddone33
  76  * Keyboard input, mouse tracking now work
  77  *
  78  * Revision 1.2  2002/05/07 03:16:48  theoddone33
  79  * The Great Newline Fix
  80  *
  81  * Revision 1.1.1.1  2002/05/03 03:28:10  root
  82  * Initial import.
  83  *
  84  *
  85  * 7     6/30/99 5:53p Dave
  86  * Put in new anti-camper code.
  87  *
  88  * 6     6/03/99 6:37p Dave
  89  * More TNT fun. Made perspective bitmaps more flexible.
  90  *
  91  * 5     6/02/99 6:18p Dave
  92  * Fixed TNT lockup problems! Wheeeee!
  93  *
  94  * 4     12/18/98 1:13a Dave
  95  * Rough 1024x768 support for Direct3D. Proper detection and usage through
  96  * the launcher.
  97  *
  98  * 3     10/09/98 2:57p Dave
  99  * Starting splitting up OS stuff.
 100  *
 101  * 2     10/08/98 2:38p Dave
 102  * Cleanup up OsAPI code significantly. Removed old functions, centralized
 103  * registry functions.
 104  *
 105  * 118   7/10/98 5:04p Dave
 106  * Fix connection speed bug on standalone server.
 107  *
 108  * 117   5/24/98 2:28p Hoffoss
 109  * Because we never really care about if the left or the right shift or
 110  * alt key was used, but rather than either shift or alt was used, made
 111  * both map to the left one.  Solves some problems, causes none.
 112  *
 113  * 116   5/18/98 9:22p John
 114  * Took out the annoying tab check.
 115  *
 116  * 115   5/18/98 11:17a John
 117  * Fixed some bugs with software window and output window.
 118  *
 119  * 114   5/16/98 2:20p John
 120  * Changed the os_suspend and resume to use a critical section to prevent
 121  * threads from executing rather than just suspending the thread.  Had to
 122  * make sure gr_close was called before os_close.
 123  *
 124  * 113   5/15/98 4:49p John
 125  *
 126  * 112   5/15/98 3:36p John
 127  * Fixed bug with new graphics window code and standalone server.  Made
 128  * hwndApp not be a global anymore.
 129  *
 130  * 111   5/14/98 5:42p John
 131  * Revamped the whole window position/mouse code for the graphics windows.
 132  *
 133  * 110   5/04/98 11:08p Hoffoss
 134  * Expanded on Force Feedback code, and moved it all into Joy_ff.cpp.
 135  * Updated references everywhere to it.
 136  *
 137  * $NoKeywords: $
 138  */
 139
 140 #include "pstypes.h"
 141 #include "osapi.h"
 142 #include "key.h"
 143 #include "palman.h"
 144 #include "mouse.h"
 145 #include "outwnd.h"
 146 #include "2d.h"
 147 #include "cfile.h"
 148 #include "sound.h"
 149 #include "freespaceresource.h"
 150 #include "managepilot.h"
 151 #include "joy.h"
 152 #include "joy_ff.h"
 153 #include "gamesequence.h"
 154 #include "freespace.h"
 155 #include "osregistry.h"
 156 #include "cmdline.h"
 157
 158 // ----------------------------------------------------------------------------------------------------
 159 // OSAPI DEFINES/VARS
 160 //
 161
 162 // os-wide globals
 163 static int                      fAppActive = 1;
 164 static int                      Os_inited = 0;
 165 static char                     windowTitle[128];
 166
 167 static SDL_mutex *Os_lock;
 168
 169 int Os_debugger_running = 0;
 170
 171 // ----------------------------------------------------------------------------------------------------
 172 // OSAPI FORWARD DECLARATIONS
 173 //
 174
 175 // Fills in the Os_debugger_running with non-zero if debugger detected.
 176 void os_check_debugger();
 177
 178 // called at shutdown. Makes sure all thread processing terminates.
 179 void os_deinit();
 180
 181
 182 // ----------------------------------------------------------------------------------------------------
 183 // OSAPI FUNCTIONS
 184 //
 185
 186 // initialization/shutdown functions -----------------------------------------------
 187
 188
 189 // If app_name is NULL or ommited, then TITLE is used
 190 // for the app name, which is where registry keys are stored.
 191 void os_init(const char *wclass, const char *title, const char *app_name, const char *version_string)
 192 {
 193         os_set_title( (app_name != NULL) ? app_name : title );
 194
 195         // do some first-run stuff if needed
 196         if ( os_config_read_uint(NULL, "StraightToSetup", 1) == 1 ) {
 197                 // set some sane config defaults
 198                 os_init_registry_stuff();
 199
 200                 // in case an installer didn't do it, populate directory structure to
 201                 // make sure everything is usable
 202                 cf_create_directory(CF_TYPE_MAPS);
 203                 cf_create_directory(CF_TYPE_TEXT);
 204                 cf_create_directory(CF_TYPE_MISSIONS);
 205                 cf_create_directory(CF_TYPE_MODELS);
 206                 cf_create_directory(CF_TYPE_TABLES);
 207                 cf_create_directory(CF_TYPE_SOUNDS_8B22K);
 208                 cf_create_directory(CF_TYPE_SOUNDS_16B11K);
 209                 cf_create_directory(CF_TYPE_VOICE_BRIEFINGS);
 210                 cf_create_directory(CF_TYPE_VOICE_CMD_BRIEF);
 211                 cf_create_directory(CF_TYPE_VOICE_DEBRIEFINGS);
 212                 cf_create_directory(CF_TYPE_VOICE_PERSONAS);
 213                 cf_create_directory(CF_TYPE_VOICE_SPECIAL);
 214                 cf_create_directory(CF_TYPE_VOICE_TRAINING);
 215                 cf_create_directory(CF_TYPE_MUSIC);
 216                 cf_create_directory(CF_TYPE_MOVIES);
 217                 cf_create_directory(CF_TYPE_INTERFACE);
 218                 cf_create_directory(CF_TYPE_FONT);
 219                 cf_create_directory(CF_TYPE_EFFECTS);
 220                 cf_create_directory(CF_TYPE_HUD);
 221                 cf_create_directory(CF_TYPE_PLAYER_IMAGES_MAIN);
 222                 cf_create_directory(CF_TYPE_CACHE);
 223                 cf_create_directory(CF_TYPE_SINGLE_PLAYERS);
 224                 cf_create_directory(CF_TYPE_MULTI_PLAYERS);
 225                 cf_create_directory(CF_TYPE_MULTI_CACHE);
 226                 cf_create_directory(CF_TYPE_CONFIG);
 227                 cf_create_directory(CF_TYPE_SQUAD_IMAGES_MAIN);
 228                 cf_create_directory(CF_TYPE_DEMOS);
 229                 cf_create_directory(CF_TYPE_CBANIMS);
 230                 cf_create_directory(CF_TYPE_INTEL_ANIMS);
 231
 232                 // unset FirstRun flag
 233                 os_config_write_uint(NULL, "StraightToSetup", 0);
 234         }
 235
 236         Os_inited = 1;
 237
 238         Os_lock = SDL_CreateMutex();
 239
 240         // check to see if we're running under msdev
 241         os_check_debugger();
 242
 243         atexit(os_deinit);
 244 }
 245
 246 // set the main window title
 247 void os_set_title( const char *title )
 248 {
 249         extern SDL_Window *GL_window;
 250
 251         if ( !title ) {
 252                 return;
 253         }
 254
 255         memset(windowTitle, 0, sizeof(windowTitle));
 256
 257         SDL_strlcpy(windowTitle, title, sizeof(windowTitle));
 258
 259         SDL_SetWindowTitle(GL_window, title);
 260 }
 261
 262 const char *os_get_title()
 263 {
 264         return windowTitle;
 265 }
 266
 267 // call at program end
 268 void os_cleanup()
 269 {
 270 #ifndef NDEBUG
 271                 outwnd_close();
 272 #endif
 273 }
 274
 275
 276 // window management -----------------------------------------------------------------
 277
 278 // Returns 0 if app is not the foreground app.
 279 int os_foreground()
 280 {
 281         return fAppActive;
 282 }
 283
 284 // Returns the handle to the main window
 285 uint os_get_window()
 286 {
 287 //      STUB_FUNCTION;  // not used/needed with UNIX builds?
 288         return 0;
 289 }
 290
 291
 292 // process management -----------------------------------------------------------------
 293
 294 // Used to stop message processing
 295 void os_suspend()
 296 {
 297         SDL_LockMutex(Os_lock);
 298 }
 299
 300 // resume message processing
 301 void os_resume()
 302 {
 303         SDL_UnlockMutex(Os_lock);
 304 }
 305
 306
 307 // ----------------------------------------------------------------------------------------------------
 308 // OSAPI FORWARD DECLARATIONS
 309 //
 310
 311 // Fills in the Os_debugger_running with non-zero if debugger detected.
 312 void os_check_debugger()
 313 {
 314 }
 315
 316 // called at shutdown. Makes sure all thread processing terminates.
 317 void os_deinit()
 318 {
 319         SDL_DestroyMutex(Os_lock);
 320
 321         SDL_Quit();
 322 }
 323
 324 void os_poll()
 325 {
 326         SDL_Event e;
 327         int button, state;
 328
 329         while (SDL_PollEvent (&e)) {
 330                 switch (e.type) {
 331                         case SDL_MOUSEBUTTONDOWN:
 332                         case SDL_MOUSEBUTTONUP: {
 333                                 if (e.motion.windowID > 0) {
 334                                         mouse_mark_button(e.button.button, e.button.state);
 335                                 }
 336
 337                                 break;
 338                         }
 339
 340                         case SDL_MOUSEMOTION: {
 341                                 if (e.motion.windowID > 0) {
 342                                         mouse_update_pos(e.motion.x, e.motion.y, e.motion.xrel, e.motion.yrel);
 343                                 }
 344
 345                                 break;
 346                         }
 347
 348                         case SDL_TEXTINPUT: {
 349                                 key_set_text_input((int)e.text.text[0]);
 350
 351                                 break;
 352                         }
 353
 354                         case SDL_KEYDOWN: {
 355                                 if (e.key.keysym.mod & KMOD_GUI) {
 356                                         if (e.key.keysym.sym == SDLK_f ) {
 357                                                 gr_toggle_fullscreen();
 358                                 //      } else if (e.key.keysym.sym == SDLK_z) {
 359                                 //              SDL_MinimizeWindow(GL_window);
 360                                         }
 361                                 } else {
 362                                         key_mark(e.key.keysym.scancode, 1, e.key.keysym.mod, 0);
 363                                 }
 364
 365                                 break;
 366                         }
 367
 368                         case SDL_KEYUP: {
 369                                 if (e.key.keysym.mod & KMOD_GUI) {
 370                                         // blank, just don't want to process up keys we skipped
 371                                         // the down for
 372                                 } else {
 373                                         key_mark(e.key.keysym.scancode, 0, e.key.keysym.mod, 0);
 374                                 }
 375
 376                                 break;
 377                         }
 378 /*
 379                         case SDL_ACTIVEEVENT:
 380                                 if (e.active.state & SDL_APPACTIVE) {
 381                                         fAppActive = e.active.gain;
 382                                         gr_activate(fAppActive);
 383                                 }
 384                                 if (e.active.state & SDL_APPINPUTFOCUS) {
 385                                         gr_activate(e.active.gain);
 386                                 }
 387                                 break;
 388 */
 389                         case SDL_JOYDEVICEADDED: {
 390                                 if ( !Is_standalone ) {
 391                                         joy_init();
 392                                 }
 393
 394                                 break;
 395                         }
 396
 397                         case SDL_JOYDEVICEREMOVED: {
 398                                 if (e.jdevice.which == joystick_get_id()) {
 399                                         joy_close();
 400                                 }
 401
 402                                 break;
 403                         }
 404
 405                         case SDL_JOYAXISMOTION: {
 406                                 if (e.jaxis.which == joystick_get_id()) {
 407                                         joystick_update_axis(e.jaxis.axis, e.jaxis.value);
 408                                 }
 409
 410                                 break;
 411                         }
 412
 413                         case SDL_JOYBUTTONDOWN:
 414                         case SDL_JOYBUTTONUP: {
 415                                 if (e.jbutton.which == joystick_get_id()) {
 416                                         state = (e.jbutton.state == SDL_PRESSED) ? 1 : 0;
 417                                         joy_mark_button((int)e.jbutton.button, state);
 418                                 }
 419
 420                                 break;
 421                         }
 422
 423                         case SDL_JOYHATMOTION: {
 424                                 if (e.jhat.which == joystick_get_id()) {
 425                                         // can only handle one hat
 426                                         if (e.jhat.hat == 0) {
 427                                                 switch (e.jhat.value) {
 428                                                         case SDL_HAT_UP:
 429                                                                 button = JOY_HATFORWARD;
 430                                                                 state = 1;
 431                                                                 break;
 432                                                         case SDL_HAT_DOWN:
 433                                                                 button = JOY_HATBACK;
 434                                                                 state = 1;
 435                                                                 break;
 436                                                         case SDL_HAT_LEFT:
 437                                                                 button = JOY_HATLEFT;
 438                                                                 state = 1;
 439                                                                 break;
 440                                                         case SDL_HAT_RIGHT:
 441                                                                 button = JOY_HATRIGHT;
 442                                                                 state = 1;
 443                                                                 break;
 444                                                         default:
 445                                                                 // special case - will toggle all hat positions off
 446                                                                 button = JOY_HATBACK;
 447                                                                 state = 0;
 448                                                                 break;
 449                                                 }
 450
 451                                                 joy_mark_button(button, state);
 452                                         }
 453                                 }
 454
 455                                 break;
 456                         }
 457
 458                         case SDL_WINDOWEVENT: {
 459                                 switch (e.window.event) {
 460                                         case SDL_WINDOWEVENT_RESIZED:
 461                                                 gr_set_viewport(e.window.data1, e.window.data2);
 462                                                 break;
 463
 464                                         case SDL_WINDOWEVENT_FOCUS_LOST:
 465                                                 joy_unacquire_ff();
 466                                                 break;
 467
 468                                         case SDL_WINDOWEVENT_FOCUS_GAINED:
 469                                                 joy_reacquire_ff();
 470                                                 break;
 471
 472                                         case SDL_WINDOWEVENT_CLOSE:
 473                                         //      gameseq_post_event(GS_EVENT_QUIT_GAME);
 474                                                 break;
 475                                 }
 476
 477                                 break;
 478                         }
 479
 480                         case SDL_QUIT:
 481                                 gameseq_post_event(GS_EVENT_QUIT_GAME);
 482                                 break;
 483
 484                         default:
 485                                 break;
 486                 }
 487         }
 488 }
 489
 490 void debug_int3()
 491 {
 492         SDL_TriggerBreakpoint();
 493 }