git.mutantstargoat.com Git - freeglut/blob - src/fg_main.c

   1 /*
   2  * freeglut_main.c
   3  *
   4  * The windows message processing methods.
   5  *
   6  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
   7  * Written by Pawel W. Olszta, <olszta@sourceforge.net>
   8  * Creation date: Fri Dec 3 1999
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a
  11  * copy of this software and associated documentation files (the "Software"),
  12  * to deal in the Software without restriction, including without limitation
  13  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  14  * and/or sell copies of the Software, and to permit persons to whom the
  15  * Software is furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included
  18  * in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  23  * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  24  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  25  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26  */
  27
  28 #include <GL/freeglut.h>
  29 #include "fg_internal.h"
  30 #ifdef HAVE_ERRNO_H
  31 #    include <errno.h>
  32 #endif
  33 #include <stdarg.h>
  34 #ifdef  HAVE_VFPRINTF
  35 #    define VFPRINTF(s,f,a) vfprintf((s),(f),(a))
  36 #elif defined(HAVE__DOPRNT)
  37 #    define VFPRINTF(s,f,a) _doprnt((f),(a),(s))
  38 #else
  39 #    define VFPRINTF(s,f,a)
  40 #endif
  41
  42 /*
  43  * Try to get the maximum value allowed for ints, falling back to the minimum
  44  * guaranteed by ISO C99 if there is no suitable header.
  45  */
  46 #ifdef HAVE_LIMITS_H
  47 #    include <limits.h>
  48 #endif
  49 #ifndef INT_MAX
  50 #    define INT_MAX 32767
  51 #endif
  52
  53 #ifndef MIN
  54 #    define MIN(a,b) (((a)<(b)) ? (a) : (b))
  55 #endif
  56
  57 extern void fgPlatformReshapeWindow ( SFG_Window *window, int width, int height );
  58 extern void fgPlatformDisplayWindow ( SFG_Window *window );
  59 extern fg_time_t fgPlatformSystemTime ( void );
  60 extern void fgPlatformSleepForEvents( fg_time_t msec );
  61 extern void fgPlatformProcessSingleEvent ( void );
  62 extern void fgPlatformMainLoopPreliminaryWork ( void );
  63
  64
  65
  66
  67 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
  68
  69 static void fghReshapeWindow ( SFG_Window *window, int width, int height )
  70 {
  71     SFG_Window *current_window = fgStructure.CurrentWindow;
  72
  73     freeglut_return_if_fail( window != NULL );
  74
  75         fgPlatformReshapeWindow ( window, width, height );
  76
  77     if( FETCH_WCB( *window, Reshape ) )
  78         INVOKE_WCB( *window, Reshape, ( width, height ) );
  79     else
  80     {
  81         fgSetWindow( window );
  82         glViewport( 0, 0, width, height );
  83     }
  84
  85     /*
  86      * Force a window redraw.  In Windows at least this is only a partial
  87      * solution:  if the window is increasing in size in either dimension,
  88      * the already-drawn part does not get drawn again and things look funny.
  89      * But without this we get this bad behaviour whenever we resize the
  90      * window.
  91      * DN: Hmm.. the above sounds like a concern only in single buffered mode...
  92      */
  93     window->State.Redisplay = GL_TRUE;
  94
  95     if( window->IsMenu )
  96         fgSetWindow( current_window );
  97 }
  98
  99 /*
 100  * Calls a window's redraw method. This is used when
 101  * a redraw is forced by the incoming window messages.
 102  */
 103 void fghRedrawWindow ( SFG_Window *window )
 104 {
 105     SFG_Window *current_window = fgStructure.CurrentWindow;
 106
 107     freeglut_return_if_fail( window );
 108
 109     if( window->State.NeedToInitContext ) {
 110         INVOKE_WCB( *window, InitContext, ());
 111         window->State.NeedToInitContext = GL_FALSE;
 112     }
 113
 114     freeglut_return_if_fail( FETCH_WCB ( *window, Display ) );
 115
 116     window->State.Redisplay = GL_FALSE;
 117
 118     freeglut_return_if_fail( window->State.Visible );
 119
 120     fgSetWindow( window );
 121
 122     if( window->State.NeedToResize )
 123     {
 124         /* Set need to resize to false before calling fghReshapeWindow, otherwise
 125            in the case the user's reshape callback calls glutReshapeWindow,
 126            his request would get canceled after fghReshapeWindow gets called.
 127          */
 128         window->State.NeedToResize = GL_FALSE;
 129
 130         fghReshapeWindow(
 131             window,
 132             window->State.Width,
 133             window->State.Height
 134         );
 135     }
 136
 137     INVOKE_WCB( *window, Display, ( ) );
 138
 139     fgSetWindow( current_window );
 140 }
 141
 142
 143 static void fghcbDisplayWindow( SFG_Window *window,
 144                                 SFG_Enumerator *enumerator )
 145 {
 146     if( window->State.Redisplay &&
 147         window->State.Visible )
 148     {
 149         window->State.Redisplay = GL_FALSE;
 150                 fgPlatformDisplayWindow ( window );
 151     }
 152
 153     fgEnumSubWindows( window, fghcbDisplayWindow, enumerator );
 154 }
 155
 156 /*
 157  * Make all windows perform a display call
 158  */
 159 static void fghDisplayAll( void )
 160 {
 161     SFG_Enumerator enumerator;
 162
 163     enumerator.found = GL_FALSE;
 164     enumerator.data  =  NULL;
 165
 166     fgEnumWindows( fghcbDisplayWindow, &enumerator );
 167 }
 168
 169 /*
 170  * Window enumerator callback to check for the joystick polling code
 171  */
 172 static void fghcbCheckJoystickPolls( SFG_Window *window,
 173                                      SFG_Enumerator *enumerator )
 174 {
 175     fg_time_t checkTime = fgElapsedTime( );
 176
 177     if( window->State.JoystickLastPoll + window->State.JoystickPollRate <=
 178         checkTime )
 179     {
 180 #if !defined(_WIN32_WCE)
 181         fgJoystickPollWindow( window );
 182 #endif /* !defined(_WIN32_WCE) */
 183         window->State.JoystickLastPoll = checkTime;
 184     }
 185
 186     fgEnumSubWindows( window, fghcbCheckJoystickPolls, enumerator );
 187 }
 188
 189 /*
 190  * Check all windows for joystick polling
 191  */
 192 static void fghCheckJoystickPolls( void )
 193 {
 194     SFG_Enumerator enumerator;
 195
 196     enumerator.found = GL_FALSE;
 197     enumerator.data  =  NULL;
 198
 199     fgEnumWindows( fghcbCheckJoystickPolls, &enumerator );
 200 }
 201
 202 /*
 203  * Check the global timers
 204  */
 205 static void fghCheckTimers( void )
 206 {
 207     fg_time_t checkTime = fgElapsedTime( );
 208
 209     while( fgState.Timers.First )
 210     {
 211         SFG_Timer *timer = fgState.Timers.First;
 212
 213         if( timer->TriggerTime > checkTime )
 214             break;
 215
 216         fgListRemove( &fgState.Timers, &timer->Node );
 217         fgListAppend( &fgState.FreeTimers, &timer->Node );
 218
 219         timer->Callback( timer->ID );
 220     }
 221 }
 222
 223
 224 /* Platform-dependent time in milliseconds, as an unsigned 64-bit integer.
 225  * This doesn't overflow in any reasonable time, so no need to worry about
 226  * that. The GLUT API return value will however overflow after 49.7 days,
 227  * and on Windows we (currently) do not have access to a 64-bit timestamp,
 228  * which means internal time will still get in trouble when running the
 229  * application for more than 49.7 days.
 230  * This value wraps every 49.7 days, but integer overflows cancel
 231  * when subtracting an initial start time, unless the total time exceeds
 232  * 32-bit, where the GLUT API return value is also overflowed.
 233  */
 234 fg_time_t fgSystemTime(void)
 235 {
 236         return fgPlatformSystemTime();
 237 }
 238
 239 /*
 240  * Elapsed Time
 241  */
 242 fg_time_t fgElapsedTime( void )
 243 {
 244     return fgSystemTime() - fgState.Time;
 245 }
 246
 247 /*
 248  * Error Messages.
 249  */
 250 void fgError( const char *fmt, ... )
 251 {
 252     va_list ap;
 253
 254     if (fgState.ErrorFunc) {
 255
 256         va_start( ap, fmt );
 257
 258         /* call user set error handler here */
 259         fgState.ErrorFunc(fmt, ap);
 260
 261         va_end( ap );
 262
 263     } else {
 264
 265         va_start( ap, fmt );
 266
 267         fprintf( stderr, "freeglut ");
 268         if( fgState.ProgramName )
 269             fprintf( stderr, "(%s): ", fgState.ProgramName );
 270         VFPRINTF( stderr, fmt, ap );
 271         fprintf( stderr, "\n" );
 272
 273         va_end( ap );
 274
 275         if ( fgState.Initialised )
 276             fgDeinitialize ();
 277
 278         exit( 1 );
 279     }
 280 }
 281
 282 void fgWarning( const char *fmt, ... )
 283 {
 284     va_list ap;
 285
 286     if (fgState.WarningFunc) {
 287
 288         va_start( ap, fmt );
 289
 290         /* call user set warning handler here */
 291         fgState.WarningFunc(fmt, ap);
 292
 293         va_end( ap );
 294
 295     } else {
 296
 297         va_start( ap, fmt );
 298
 299         fprintf( stderr, "freeglut ");
 300         if( fgState.ProgramName )
 301             fprintf( stderr, "(%s): ", fgState.ProgramName );
 302         VFPRINTF( stderr, fmt, ap );
 303         fprintf( stderr, "\n" );
 304
 305         va_end( ap );
 306     }
 307 }
 308
 309
 310 /*
 311  * Indicates whether Joystick events are being used by ANY window.
 312  *
 313  * The current mechanism is to walk all of the windows and ask if
 314  * there is a joystick callback.  We have a short-circuit early
 315  * return if we find any joystick handler registered.
 316  *
 317  * The real way to do this is to make use of the glutTimer() API
 318  * to more cleanly re-implement the joystick API.  Then, this code
 319  * and all other "joystick timer" code can be yanked.
 320  *
 321  */
 322 static void fghCheckJoystickCallback( SFG_Window* w, SFG_Enumerator* e)
 323 {
 324     if( FETCH_WCB( *w, Joystick ) )
 325     {
 326         e->found = GL_TRUE;
 327         e->data = w;
 328     }
 329     fgEnumSubWindows( w, fghCheckJoystickCallback, e );
 330 }
 331 static int fghHaveJoystick( void )
 332 {
 333     SFG_Enumerator enumerator;
 334
 335     enumerator.found = GL_FALSE;
 336     enumerator.data = NULL;
 337     fgEnumWindows( fghCheckJoystickCallback, &enumerator );
 338     return !!enumerator.data;
 339 }
 340 static void fghHavePendingRedisplaysCallback( SFG_Window* w, SFG_Enumerator* e)
 341 {
 342     if( w->State.Redisplay && w->State.Visible )
 343     {
 344         e->found = GL_TRUE;
 345         e->data = w;
 346     }
 347     fgEnumSubWindows( w, fghHavePendingRedisplaysCallback, e );
 348 }
 349 static int fghHavePendingRedisplays (void)
 350 {
 351     SFG_Enumerator enumerator;
 352
 353     enumerator.found = GL_FALSE;
 354     enumerator.data = NULL;
 355     fgEnumWindows( fghHavePendingRedisplaysCallback, &enumerator );
 356     return !!enumerator.data;
 357 }
 358 /*
 359  * Returns the number of GLUT ticks (milliseconds) till the next timer event.
 360  */
 361 static fg_time_t fghNextTimer( void )
 362 {
 363     fg_time_t currentTime = fgElapsedTime();
 364     SFG_Timer *timer = fgState.Timers.First;
 365
 366     if( !timer )
 367         return INT_MAX;
 368
 369     if( timer->TriggerTime < currentTime )
 370         return 0;
 371     else
 372         return timer->TriggerTime - currentTime;
 373 }
 374
 375 static void fghSleepForEvents( void )
 376 {
 377     fg_time_t msec;
 378
 379     if( fgState.IdleCallback || fghHavePendingRedisplays( ) )
 380         return;
 381
 382     msec = fghNextTimer( );
 383     /* XXX Use GLUT timers for joysticks... */
 384     /* XXX Dumb; forces granularity to .01sec */
 385     if( fghHaveJoystick( ) && ( msec > 10 ) )
 386         msec = 10;
 387
 388         fgPlatformSleepForEvents ( msec );
 389 }
 390
 391
 392 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
 393
 394 /*
 395  * Executes a single iteration in the freeglut processing loop.
 396  */
 397 void FGAPIENTRY glutMainLoopEvent( void )
 398 {
 399         fgPlatformProcessSingleEvent ();
 400
 401     if( fgState.Timers.First )
 402         fghCheckTimers( );
 403     fghCheckJoystickPolls( );
 404     fghDisplayAll( );
 405
 406     fgCloseWindows( );
 407 }
 408
 409 /*
 410  * Enters the freeglut processing loop.
 411  * Stays until the "ExecState" changes to "GLUT_EXEC_STATE_STOP".
 412  */
 413 void FGAPIENTRY glutMainLoop( void )
 414 {
 415     int action;
 416
 417     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMainLoop" );
 418
 419         fgPlatformMainLoopPreliminaryWork ();
 420
 421     fgState.ExecState = GLUT_EXEC_STATE_RUNNING ;
 422     while( fgState.ExecState == GLUT_EXEC_STATE_RUNNING )
 423     {
 424         SFG_Window *window;
 425
 426         glutMainLoopEvent( );
 427         /*
 428          * Step through the list of windows, seeing if there are any
 429          * that are not menus
 430          */
 431         for( window = ( SFG_Window * )fgStructure.Windows.First;
 432              window;
 433              window = ( SFG_Window * )window->Node.Next )
 434             if ( ! ( window->IsMenu ) )
 435                 break;
 436
 437         if( ! window )
 438             fgState.ExecState = GLUT_EXEC_STATE_STOP;
 439         else
 440         {
 441             if( fgState.IdleCallback )
 442             {
 443                 if( fgStructure.CurrentWindow &&
 444                     fgStructure.CurrentWindow->IsMenu )
 445                     /* fail safe */
 446                     fgSetWindow( window );
 447                 fgState.IdleCallback( );
 448             }
 449
 450             fghSleepForEvents( );
 451         }
 452     }
 453
 454     /*
 455      * When this loop terminates, destroy the display, state and structure
 456      * of a freeglut session, so that another glutInit() call can happen
 457      *
 458      * Save the "ActionOnWindowClose" because "fgDeinitialize" resets it.
 459      */
 460     action = fgState.ActionOnWindowClose;
 461     fgDeinitialize( );
 462     if( action == GLUT_ACTION_EXIT )
 463         exit( 0 );
 464 }
 465
 466 /*
 467  * Leaves the freeglut processing loop.
 468  */
 469 void FGAPIENTRY glutLeaveMainLoop( void )
 470 {
 471     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutLeaveMainLoop" );
 472     fgState.ExecState = GLUT_EXEC_STATE_STOP ;
 473 }
 474
 475
 476
 477 /*** END OF FILE ***/