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  * which means you will still get in trouble when running the
 228  * application for more than 49.7 days.
 229  */
 230 fg_time_t fgSystemTime(void)
 231 {
 232         return fgPlatformSystemTime();
 233 }
 234
 235 /*
 236  * Elapsed Time
 237  */
 238 fg_time_t fgElapsedTime( void )
 239 {
 240     return fgSystemTime() - fgState.Time;
 241 }
 242
 243 /*
 244  * Error Messages.
 245  */
 246 void fgError( const char *fmt, ... )
 247 {
 248     va_list ap;
 249
 250     if (fgState.ErrorFunc) {
 251
 252         va_start( ap, fmt );
 253
 254         /* call user set error handler here */
 255         fgState.ErrorFunc(fmt, ap);
 256
 257         va_end( ap );
 258
 259     } else {
 260 #if FREEGLUT_ERRORS
 261         va_start( ap, fmt );
 262
 263         fprintf( stderr, "freeglut ");
 264         if( fgState.ProgramName )
 265             fprintf( stderr, "(%s): ", fgState.ProgramName );
 266         VFPRINTF( stderr, fmt, ap );
 267         fprintf( stderr, "\n" );
 268
 269         va_end( ap );
 270 #endif
 271
 272         if ( fgState.Initialised )
 273             fgDeinitialize ();
 274
 275         exit( 1 );
 276     }
 277 }
 278
 279 void fgWarning( const char *fmt, ... )
 280 {
 281     va_list ap;
 282
 283     if (fgState.WarningFunc) {
 284
 285         va_start( ap, fmt );
 286
 287         /* call user set warning handler here */
 288         fgState.WarningFunc(fmt, ap);
 289
 290         va_end( ap );
 291
 292     } else {
 293 #if FREEGLUT_WARNINGS
 294         va_start( ap, fmt );
 295
 296         fprintf( stderr, "freeglut ");
 297         if( fgState.ProgramName )
 298             fprintf( stderr, "(%s): ", fgState.ProgramName );
 299         VFPRINTF( stderr, fmt, ap );
 300         fprintf( stderr, "\n" );
 301
 302         va_end( ap );
 303 #endif
 304     }
 305 }
 306
 307
 308 /*
 309  * Indicates whether Joystick events are being used by ANY window.
 310  *
 311  * The current mechanism is to walk all of the windows and ask if
 312  * there is a joystick callback.  We have a short-circuit early
 313  * return if we find any joystick handler registered.
 314  *
 315  * The real way to do this is to make use of the glutTimer() API
 316  * to more cleanly re-implement the joystick API.  Then, this code
 317  * and all other "joystick timer" code can be yanked.
 318  *
 319  */
 320 static void fghCheckJoystickCallback( SFG_Window* w, SFG_Enumerator* e)
 321 {
 322     if( FETCH_WCB( *w, Joystick ) )
 323     {
 324         e->found = GL_TRUE;
 325         e->data = w;
 326     }
 327     fgEnumSubWindows( w, fghCheckJoystickCallback, e );
 328 }
 329 static int fghHaveJoystick( void )
 330 {
 331     SFG_Enumerator enumerator;
 332
 333     enumerator.found = GL_FALSE;
 334     enumerator.data = NULL;
 335     fgEnumWindows( fghCheckJoystickCallback, &enumerator );
 336     return !!enumerator.data;
 337 }
 338 static void fghHavePendingRedisplaysCallback( SFG_Window* w, SFG_Enumerator* e)
 339 {
 340     if( w->State.Redisplay && w->State.Visible )
 341     {
 342         e->found = GL_TRUE;
 343         e->data = w;
 344     }
 345     fgEnumSubWindows( w, fghHavePendingRedisplaysCallback, e );
 346 }
 347 static int fghHavePendingRedisplays (void)
 348 {
 349     SFG_Enumerator enumerator;
 350
 351     enumerator.found = GL_FALSE;
 352     enumerator.data = NULL;
 353     fgEnumWindows( fghHavePendingRedisplaysCallback, &enumerator );
 354     return !!enumerator.data;
 355 }
 356 /*
 357  * Returns the number of GLUT ticks (milliseconds) till the next timer event.
 358  */
 359 static fg_time_t fghNextTimer( void )
 360 {
 361     fg_time_t currentTime = fgElapsedTime();
 362     SFG_Timer *timer = fgState.Timers.First;
 363
 364     if( !timer )
 365         return INT_MAX;
 366
 367     if( timer->TriggerTime < currentTime )
 368         return 0;
 369     else
 370         return timer->TriggerTime - currentTime;
 371 }
 372
 373 static void fghSleepForEvents( void )
 374 {
 375     fg_time_t msec;
 376
 377     if( fghHavePendingRedisplays( ) )
 378         return;
 379
 380     msec = fghNextTimer( );
 381     /* XXX Use GLUT timers for joysticks... */
 382     /* XXX Dumb; forces granularity to .01sec */
 383     if( fghHaveJoystick( ) && ( msec > 10 ) )
 384         msec = 10;
 385
 386         fgPlatformSleepForEvents ( msec );
 387 }
 388
 389
 390 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
 391
 392 /*
 393  * Executes a single iteration in the freeglut processing loop.
 394  */
 395 void FGAPIENTRY glutMainLoopEvent( void )
 396 {
 397         fgPlatformProcessSingleEvent ();
 398
 399     if( fgState.Timers.First )
 400         fghCheckTimers( );
 401     fghCheckJoystickPolls( );
 402     fghDisplayAll( );
 403
 404     fgCloseWindows( );
 405 }
 406
 407 /*
 408  * Enters the freeglut processing loop.
 409  * Stays until the "ExecState" changes to "GLUT_EXEC_STATE_STOP".
 410  */
 411 void FGAPIENTRY glutMainLoop( void )
 412 {
 413     int action;
 414
 415     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMainLoop" );
 416
 417     if (!fgStructure.Windows.First)
 418         fgError(" ERROR:  glutMainLoop called with no windows created.");
 419
 420         fgPlatformMainLoopPreliminaryWork ();
 421
 422     fgState.ExecState = GLUT_EXEC_STATE_RUNNING ;
 423     while( fgState.ExecState == GLUT_EXEC_STATE_RUNNING )
 424     {
 425         SFG_Window *window;
 426
 427         glutMainLoopEvent( );
 428         /*
 429          * Step through the list of windows, seeing if there are any
 430          * that are not menus
 431          */
 432         for( window = ( SFG_Window * )fgStructure.Windows.First;
 433              window;
 434              window = ( SFG_Window * )window->Node.Next )
 435             if ( ! ( window->IsMenu ) )
 436                 break;
 437
 438         if( ! window )
 439             fgState.ExecState = GLUT_EXEC_STATE_STOP;
 440         else
 441         {
 442             if( fgState.IdleCallback )
 443             {
 444                 if( fgStructure.CurrentWindow &&
 445                     fgStructure.CurrentWindow->IsMenu )
 446                     /* fail safe */
 447                     fgSetWindow( window );
 448                 fgState.IdleCallback( );
 449             }
 450             else
 451                 fghSleepForEvents( );
 452         }
 453     }
 454
 455     /*
 456      * When this loop terminates, destroy the display, state and structure
 457      * of a freeglut session, so that another glutInit() call can happen
 458      *
 459      * Save the "ActionOnWindowClose" because "fgDeinitialize" resets it.
 460      */
 461     action = fgState.ActionOnWindowClose;
 462     fgDeinitialize( );
 463     if( action == GLUT_ACTION_EXIT )
 464         exit( 0 );
 465 }
 466
 467 /*
 468  * Leaves the freeglut processing loop.
 469  */
 470 void FGAPIENTRY glutLeaveMainLoop( void )
 471 {
 472     FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutLeaveMainLoop" );
 473     fgState.ExecState = GLUT_EXEC_STATE_STOP ;
 474 }
 475
 476
 477
 478 /*** END OF FILE ***/