git.mutantstargoat.com Git - freeglut/blob - src/freeglut_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 #ifdef HAVE_CONFIG_H
  29 #include "config.h"
  30 #endif
  31
  32 #include "../include/GL/freeglut.h"
  33 #include "freeglut_internal.h"
  34
  35 #include <limits.h>
  36 #if TARGET_HOST_UNIX_X11
  37 #include <sys/types.h>
  38 #include <sys/time.h>
  39 #include <unistd.h>
  40 #include <errno.h>
  41 #include <sys/stat.h>
  42 #elif TARGET_HOST_WIN32
  43 #endif
  44
  45 #ifndef MAX
  46 #define MAX(a,b) (((a)>(b)) ? (a) : (b))
  47 #endif
  48
  49 #ifndef MIN
  50 #define MIN(a,b) (((a)<(b)) ? (a) : (b))
  51 #endif
  52
  53
  54 /*
  55  * TODO BEFORE THE STABLE RELEASE:
  56  *
  57  * There are some issues concerning window redrawing under X11, and maybe
  58  * some events are not handled. The Win32 version lacks some more features,
  59  * but seems acceptable for not demanding purposes.
  60  *
  61  * Need to investigate why the X11 version breaks out with an error when
  62  * closing a window (using the window manager, not glutDestroyWindow)...
  63  */
  64
  65 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
  66
  67 /*
  68  * Handle a window configuration change. When no reshape
  69  * callback is hooked, the viewport size is updated to
  70  * match the new window size.
  71  */
  72 static void fghReshapeWindowByHandle ( SFG_WindowHandleType handle,
  73                                        int width, int height )
  74 {
  75     SFG_Window *current_window = fgStructure.Window;
  76
  77     SFG_Window* window = fgWindowByHandle( handle );
  78     freeglut_return_if_fail( window != NULL );
  79
  80
  81 #if TARGET_HOST_UNIX_X11
  82
  83     XResizeWindow( fgDisplay.Display, window->Window.Handle,
  84                    width, height );
  85     XFlush( fgDisplay.Display ); /* XXX Shouldn't need this */
  86
  87 #elif TARGET_HOST_WIN32
  88
  89     {
  90         RECT rect;
  91
  92         /*
  93          * For windowed mode, get the current position of the
  94          * window and resize taking the size of the frame
  95          * decorations into account.
  96          */
  97
  98         GetWindowRect( window->Window.Handle, &rect );
  99         rect.right  = rect.left + width;
 100         rect.bottom = rect.top  + height;
 101
 102         if ( window->Parent == NULL )
 103         {
 104             if ( ! window->IsMenu && !window->State.IsGameMode )
 105             {
 106                 rect.right  += GetSystemMetrics( SM_CXSIZEFRAME ) * 2;
 107                 rect.bottom += GetSystemMetrics( SM_CYSIZEFRAME ) * 2 +
 108                                GetSystemMetrics( SM_CYCAPTION );
 109             }
 110         }
 111         else
 112         {
 113             GetWindowRect( window->Parent->Window.Handle, &rect );
 114             AdjustWindowRect ( &rect, WS_OVERLAPPEDWINDOW | WS_CLIPSIBLINGS |
 115                                       WS_CLIPCHILDREN, FALSE );
 116         }
 117
 118         /*
 119          * SWP_NOACTIVATE      Do not activate the window
 120          * SWP_NOOWNERZORDER   Do not change position in z-order
 121          * SWP_NOSENDCHANGING  Supress WM_WINDOWPOSCHANGING message
 122          * SWP_NOZORDER        Retains the current Z order (ignore 2nd param)
 123          */
 124
 125         SetWindowPos( window->Window.Handle,
 126                       HWND_TOP,
 127                       rect.left,
 128                       rect.top,
 129                       rect.right  - rect.left,
 130                       rect.bottom - rect.top,
 131                       SWP_NOACTIVATE | SWP_NOOWNERZORDER | SWP_NOSENDCHANGING |
 132                       SWP_NOZORDER
 133         );
 134     }
 135
 136     /*
 137      * XXX Should update {window->State.OldWidth, window->State.OldHeight}
 138      * XXX to keep in lockstep with UNIX_X11 code.
 139      */
 140     if( FETCH_WCB( *window, Reshape ) )
 141         INVOKE_WCB( *window, Reshape, ( width, height ) );
 142     else
 143     {
 144         fgSetWindow( window );
 145         glViewport( 0, 0, width, height );
 146     }
 147
 148 #endif
 149
 150     /*
 151      * Force a window redraw.  In Windows at least this is only a partial
 152      * solution:  if the window is increasing in size in either dimension,
 153      * the already-drawn part does not get drawn again and things look funny.
 154      * But without this we get this bad behaviour whenever we resize the
 155      * window.
 156      */
 157     window->State.Redisplay = GL_TRUE;
 158
 159     if( window->IsMenu )
 160         fgSetWindow( current_window );
 161 }
 162
 163 /*
 164  * Calls a window's redraw method. This is used when
 165  * a redraw is forced by the incoming window messages.
 166  */
 167 static void fghRedrawWindowByHandle ( SFG_WindowHandleType handle )
 168 {
 169     SFG_Window* window = fgWindowByHandle( handle );
 170     freeglut_return_if_fail( window );
 171     freeglut_return_if_fail( FETCH_WCB ( *window, Display ) );
 172
 173     window->State.Redisplay = GL_FALSE;
 174
 175     freeglut_return_if_fail( window->State.Visible );
 176
 177     if( window->State.NeedToResize )
 178     {
 179         SFG_Window *current_window = fgStructure.Window;
 180
 181         fgSetWindow( window );
 182
 183         fghReshapeWindowByHandle(
 184             window->Window.Handle,
 185             window->State.Width,
 186             window->State.Height
 187         );
 188
 189         window->State.NeedToResize = GL_FALSE;
 190         fgSetWindow( current_window );
 191     }
 192
 193     INVOKE_WCB( *window, Display, ( ) );
 194 }
 195
 196 /*
 197  * A static helper function to execute display callback for a window
 198  */
 199 static void fghcbDisplayWindow( SFG_Window *window,
 200                                 SFG_Enumerator *enumerator )
 201 {
 202     if( window->State.NeedToResize )
 203     {
 204         SFG_Window *current_window = fgStructure.Window;
 205
 206         fgSetWindow( window );
 207
 208         fghReshapeWindowByHandle(
 209             window->Window.Handle,
 210             window->State.Width,
 211             window->State.Height
 212         );
 213
 214         window->State.NeedToResize = GL_FALSE;
 215         fgSetWindow ( current_window );
 216     }
 217
 218     if( window->State.Redisplay &&
 219         window->State.Visible )
 220     {
 221         window->State.Redisplay = GL_FALSE;
 222
 223 #if TARGET_HOST_UNIX_X11
 224         {
 225             SFG_Window *current_window = fgStructure.Window;
 226
 227             INVOKE_WCB( *window, Display, ( ) );
 228             fgSetWindow( current_window );
 229         }
 230 #elif TARGET_HOST_WIN32
 231         RedrawWindow(
 232             window->Window.Handle, NULL, NULL,
 233             RDW_NOERASE | RDW_INTERNALPAINT | RDW_INVALIDATE | RDW_UPDATENOW
 234         );
 235 #endif
 236     }
 237
 238     fgEnumSubWindows( window, fghcbDisplayWindow, enumerator );
 239 }
 240
 241 /*
 242  * Make all windows perform a display call
 243  */
 244 static void fghDisplayAll( void )
 245 {
 246     SFG_Enumerator enumerator;
 247
 248     enumerator.found = GL_FALSE;
 249     enumerator.data  =  NULL;
 250
 251     fgEnumWindows( fghcbDisplayWindow, &enumerator );
 252 }
 253
 254 /*
 255  * Window enumerator callback to check for the joystick polling code
 256  */
 257 static void fghcbCheckJoystickPolls( SFG_Window *window,
 258                                      SFG_Enumerator *enumerator )
 259 {
 260     long int checkTime = fgElapsedTime( );
 261
 262     if( window->State.JoystickLastPoll + window->State.JoystickPollRate <=
 263         checkTime )
 264     {
 265         fgJoystickPollWindow( window );
 266         window->State.JoystickLastPoll = checkTime;
 267     }
 268
 269     fgEnumSubWindows( window, fghcbCheckJoystickPolls, enumerator );
 270 }
 271
 272 /*
 273  * Check all windows for joystick polling
 274  */
 275 static void fghCheckJoystickPolls( void )
 276 {
 277     SFG_Enumerator enumerator;
 278
 279     enumerator.found = GL_FALSE;
 280     enumerator.data  =  NULL;
 281
 282     fgEnumWindows( fghcbCheckJoystickPolls, &enumerator );
 283 }
 284
 285 /*
 286  * Check the global timers
 287  */
 288 static void fghCheckTimers( void )
 289 {
 290     long checkTime = fgElapsedTime( );
 291
 292     while( fgState.Timers.First )
 293     {
 294         SFG_Timer *timer = fgState.Timers.First;
 295
 296         if( timer->TriggerTime > checkTime )
 297             break;
 298
 299         fgListRemove( &fgState.Timers, &timer->Node );
 300         fgListAppend( &fgState.FreeTimers, &timer->Node );
 301
 302         timer->Callback( timer->ID );
 303     }
 304 }
 305
 306 /*
 307  * Elapsed Time
 308  */
 309 long fgElapsedTime( void )
 310 {
 311     if ( fgState.Time.Set )
 312     {
 313 #if TARGET_HOST_UNIX_X11
 314         struct timeval now;
 315         long elapsed;
 316
 317         gettimeofday( &now, NULL );
 318
 319         elapsed = (now.tv_usec - fgState.Time.Value.tv_usec) / 1000;
 320         elapsed += (now.tv_sec - fgState.Time.Value.tv_sec) * 1000;
 321
 322         return elapsed;
 323 #elif TARGET_HOST_WIN32
 324         return timeGetTime() - fgState.Time.Value;
 325 #endif
 326     }
 327     else
 328     {
 329 #if TARGET_HOST_UNIX_X11
 330         gettimeofday( &fgState.Time.Value, NULL );
 331 #elif TARGET_HOST_WIN32
 332         fgState.Time.Value = timeGetTime ();
 333 #endif
 334         fgState.Time.Set = GL_TRUE ;
 335
 336         return 0 ;
 337     }
 338 }
 339
 340 /*
 341  * Error Messages.
 342  */
 343 void fgError( const char *fmt, ... )
 344 {
 345     va_list ap;
 346
 347     va_start( ap, fmt );
 348
 349     fprintf( stderr, "freeglut ");
 350     if( fgState.ProgramName )
 351         fprintf (stderr, "(%s): ", fgState.ProgramName);
 352     vfprintf( stderr, fmt, ap );
 353     fprintf( stderr, "\n" );
 354
 355     va_end( ap );
 356
 357     if ( fgState.Initialised )
 358         fgDeinitialize ();
 359
 360     exit( 1 );
 361 }
 362
 363 void fgWarning( const char *fmt, ... )
 364 {
 365     va_list ap;
 366
 367     va_start( ap, fmt );
 368
 369     fprintf( stderr, "freeglut ");
 370     if( fgState.ProgramName )
 371         fprintf( stderr, "(%s): ", fgState.ProgramName );
 372     vfprintf( stderr, fmt, ap );
 373     fprintf( stderr, "\n" );
 374
 375     va_end( ap );
 376 }
 377
 378 /*
 379  * Indicates whether Joystick events are being used by ANY window.
 380  *
 381  * The current mechanism is to walk all of the windows and ask if
 382  * there is a joystick callback.  We have a short-circuit early
 383  * return if we find any joystick handler registered.
 384  *
 385  * The real way to do this is to make use of the glutTimer() API
 386  * to more cleanly re-implement the joystick API.  Then, this code
 387  * and all other "joystick timer" code can be yanked.
 388  *
 389  */
 390 static void fgCheckJoystickCallback( SFG_Window* w, SFG_Enumerator* e)
 391 {
 392     if( FETCH_WCB( *w, Joystick ) )
 393     {
 394         e->found = GL_TRUE;
 395         e->data = w;
 396     }
 397     fgEnumSubWindows( w, fgCheckJoystickCallback, e );
 398 }
 399 static int fgHaveJoystick( void )
 400 {
 401     SFG_Enumerator enumerator;
 402     enumerator.found = GL_FALSE;
 403     enumerator.data = NULL;
 404     fgEnumWindows( fgCheckJoystickCallback, &enumerator );
 405     return !!enumerator.data;
 406 }
 407 static void fgHavePendingRedisplaysCallback( SFG_Window* w, SFG_Enumerator* e)
 408 {
 409     if( w->State.Redisplay )
 410     {
 411         e->found = GL_TRUE;
 412         e->data = w;
 413     }
 414     fgEnumSubWindows( w, fgHavePendingRedisplaysCallback, e );
 415 }
 416 static int fgHavePendingRedisplays (void)
 417 {
 418     SFG_Enumerator enumerator;
 419     enumerator.found = GL_FALSE;
 420     enumerator.data = NULL;
 421     fgEnumWindows( fgHavePendingRedisplaysCallback, &enumerator );
 422     return !!enumerator.data;
 423 }
 424 /*
 425  * Returns the number of GLUT ticks (milliseconds) till the next timer event.
 426  */
 427 static long fgNextTimer( void )
 428 {
 429     long ret = INT_MAX;
 430     SFG_Timer *timer = fgState.Timers.First;
 431
 432     if( timer )
 433         ret = timer->TriggerTime - fgElapsedTime();
 434     if( ret < 0 )
 435         ret = 0;
 436
 437     return ret;
 438 }
 439 /*
 440  * Does the magic required to relinquish the CPU until something interesting
 441  * happens.
 442  */
 443 static void fgSleepForEvents( void )
 444 {
 445     long msec;
 446
 447     if( fgState.IdleCallback || fgHavePendingRedisplays( ) )
 448         return;
 449
 450     msec = fgNextTimer( );
 451     if( fgHaveJoystick( ) )     /* XXX Use GLUT timers for joysticks... */
 452         msec = MIN( msec, 10 ); /* XXX Dumb; forces granularity to .01sec */
 453
 454 #if TARGET_HOST_UNIX_X11
 455     /*
 456      * Possibly due to aggressive use of XFlush() and friends,
 457      * it is possible to have our socket drained but still have
 458      * unprocessed events.  (Or, this may just be normal with
 459      * X, anyway?)  We do non-trivial processing of X events
 460      * after tham in event-reading loop, in any case, so we
 461      * need to allow that we may have an empty socket but non-
 462      * empty event queue.
 463      */
 464     if( ! XPending( fgDisplay.Display ) )
 465     {
 466         fd_set fdset;
 467         int err;
 468         int socket;
 469         struct timeval wait;
 470
 471         socket = ConnectionNumber( fgDisplay.Display );
 472         FD_ZERO( &fdset );
 473         FD_SET( socket, &fdset );
 474         wait.tv_sec = msec / 1000;
 475         wait.tv_usec = (msec % 1000) * 1000;
 476         err = select( socket+1, &fdset, NULL, NULL, &wait );
 477
 478         if( -1 == err )
 479             fgWarning ( "freeglut select() error: %d\n", errno );
 480     }
 481 #elif TARGET_HOST_WIN32
 482     MsgWaitForMultipleObjects( 0, NULL, FALSE, msec, QS_ALLEVENTS );
 483 #endif
 484 }
 485
 486 #if TARGET_HOST_UNIX_X11
 487 /*
 488  * Returns GLUT modifier mask for an XEvent.
 489  */
 490 int fgGetXModifiers( XEvent *event )
 491 {
 492     int ret = 0;
 493
 494     if( event->xkey.state & ( ShiftMask | LockMask ) )
 495         ret |= GLUT_ACTIVE_SHIFT;
 496     if( event->xkey.state & ControlMask )
 497         ret |= GLUT_ACTIVE_CTRL;
 498     if( event->xkey.state & Mod1Mask )
 499         ret |= GLUT_ACTIVE_ALT;
 500
 501     return ret;
 502 }
 503 #endif
 504
 505
 506 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
 507
 508 /*
 509  * Executes a single iteration in the freeglut processing loop.
 510  */
 511 void FGAPIENTRY glutMainLoopEvent( void )
 512 {
 513 #if TARGET_HOST_UNIX_X11
 514     SFG_Window* window;
 515     XEvent event;
 516
 517     /*
 518      * This code was repeated constantly, so here it goes into a definition:
 519      */
 520 #define GETWINDOW(a)                             \
 521     window = fgWindowByHandle( event.a.window ); \
 522     if( window == NULL )                         \
 523         break;
 524
 525 #define GETMOUSE(a)                              \
 526     window->State.MouseX = event.a.x;            \
 527     window->State.MouseY = event.a.y;
 528
 529     freeglut_assert_ready;
 530
 531     while( XPending( fgDisplay.Display ) )
 532     {
 533         XNextEvent( fgDisplay.Display, &event );
 534
 535         switch( event.type )
 536         {
 537         case ClientMessage:
 538             /*
 539              * Destroy the window when the WM_DELETE_WINDOW message arrives
 540              */
 541             if( (Atom) event.xclient.data.l[ 0 ] == fgDisplay.DeleteWindow )
 542             {
 543                 GETWINDOW( xclient );
 544
 545                 fgDestroyWindow ( window );
 546
 547                 if( fgState.ActionOnWindowClose == GLUT_ACTION_EXIT )
 548                 {
 549                     fgDeinitialize( );
 550                     exit( 0 );
 551                 }
 552
 553                 fgState.ExecState = GLUT_EXEC_STATE_STOP;
 554                 return;
 555             }
 556             break;
 557
 558             /*
 559              * CreateNotify causes a configure-event so that sub-windows are
 560              * handled compatibly with GLUT.  Otherwise, your sub-windows
 561              * (in freeglut only) will not get an initial reshape event,
 562              * which can break things.
 563              *
 564              * GLUT presumably does this because it generally tries to treat
 565              * sub-windows the same as windows.
 566              *
 567              * XXX Technically, GETWINDOW( xconfigure ) and
 568              * XXX {event.xconfigure} may not be legit ways to get at
 569              * XXX data for CreateNotify events.  In practice, the data
 570              * XXX is in a union which is laid out much the same either
 571              * XXX way.  But if you want to split hairs, this isn't legit,
 572              * XXX and we should instead duplicate some code.
 573              */
 574         case CreateNotify:
 575         case ConfigureNotify:
 576             GETWINDOW( xconfigure );
 577             {
 578                 int width = event.xconfigure.width;
 579                 int height = event.xconfigure.height;
 580
 581                 if( ( width != window->State.OldWidth ) ||
 582                     ( height != window->State.OldHeight ) )
 583                 {
 584                     window->State.OldWidth = width;
 585                     window->State.OldHeight = height;
 586                     if( FETCH_WCB( *window, Reshape ) )
 587                         INVOKE_WCB( *window, Reshape, ( width, height ) );
 588                     else
 589                     {
 590                         fgSetWindow( window );
 591                         glViewport( 0, 0, width, height );
 592                     }
 593                     glutPostRedisplay( );
 594                 }
 595             }
 596             break;
 597
 598         case DestroyNotify:
 599             /*
 600              * This is sent to confirm the XDestroyWindow call.
 601              *
 602              * XXX WHY is this commented out?  Should we re-enable it?
 603              */
 604             /* fgAddToWindowDestroyList ( window ); */
 605             break;
 606
 607         case Expose:
 608             /*
 609              * We are too dumb to process partial exposes...
 610              *
 611              * XXX Well, we could do it.  However, it seems to only
 612              * XXX be potentially useful for single-buffered (since
 613              * XXX double-buffered does not respect viewport when we
 614              * XXX do a buffer-swap).
 615              *
 616              */
 617             if( event.xexpose.count == 0 )
 618             {
 619                 GETWINDOW( xexpose );
 620                 fgSetWindow( window );
 621                 glutPostRedisplay( );
 622             }
 623             break;
 624
 625         case MapNotify:
 626         case UnmapNotify:
 627             /*
 628              * If we never do anything with this, can we just not ask to
 629              * get these messages?
 630              */
 631             break;
 632
 633         case MappingNotify:
 634             /*
 635              * Have the client's keyboard knowledge updated (xlib.ps,
 636              * page 206, says that's a good thing to do)
 637              */
 638             XRefreshKeyboardMapping( (XMappingEvent *) &event );
 639             break;
 640
 641         case VisibilityNotify:
 642         {
 643             GETWINDOW( xvisibility );
 644             /*
 645              * XXX INVOKE_WCB() does this check for us.
 646              */
 647             if( ! FETCH_WCB( *window, WindowStatus ) )
 648                 break;
 649             fgSetWindow( window );
 650
 651             /*
 652              * Sending this event, the X server can notify us that the window
 653              * has just acquired one of the three possible visibility states:
 654              * VisibilityUnobscured, VisibilityPartiallyObscured or
 655              * VisibilityFullyObscured
 656              */
 657             switch( event.xvisibility.state )
 658             {
 659             case VisibilityUnobscured:
 660                 INVOKE_WCB( *window, WindowStatus, ( GLUT_FULLY_RETAINED ) );
 661                 window->State.Visible = GL_TRUE;
 662                 break;
 663
 664             case VisibilityPartiallyObscured:
 665                 INVOKE_WCB( *window, WindowStatus,
 666                             ( GLUT_PARTIALLY_RETAINED ) );
 667                 window->State.Visible = GL_TRUE;
 668                 break;
 669
 670             case VisibilityFullyObscured:
 671                 INVOKE_WCB( *window, WindowStatus, ( GLUT_FULLY_COVERED ) );
 672                 window->State.Visible = GL_FALSE;
 673                 break;
 674
 675             default:
 676                 fgWarning( "Uknown X visibility state: %d",
 677                            event.xvisibility.state );
 678                 break;
 679             }
 680         }
 681         break;
 682
 683         case EnterNotify:
 684         case LeaveNotify:
 685             GETWINDOW( xcrossing );
 686             GETMOUSE( xcrossing );
 687             INVOKE_WCB( *window, Entry, ( ( EnterNotify == event.type ) ?
 688                                           GLUT_ENTERED :
 689                                           GLUT_LEFT ) );
 690             break;
 691
 692         case MotionNotify:
 693         {
 694             GETWINDOW( xmotion );
 695             GETMOUSE( xmotion );
 696
 697             if( window->ActiveMenu )
 698             {
 699                 if( window == window->ActiveMenu->ParentWindow )
 700                 {
 701                     window->ActiveMenu->Window->State.MouseX =
 702                         event.xmotion.x_root - window->ActiveMenu->X;
 703                     window->ActiveMenu->Window->State.MouseY =
 704                         event.xmotion.y_root - window->ActiveMenu->Y;
 705                 }
 706                 window->ActiveMenu->Window->State.Redisplay = GL_TRUE ;
 707                 fgSetWindow( window->ActiveMenu->ParentWindow );
 708
 709                 break;
 710             }
 711
 712             /*
 713              * XXX For more than 5 buttons, just check {event.xmotion.state},
 714              * XXX rather than a host of bit-masks?  Or maybe we need to
 715              * XXX track ButtonPress/ButtonRelease events in our own
 716              * XXX bit-mask?
 717              */
 718 #define BUTTON_MASK \
 719   ( Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask )
 720             if ( event.xmotion.state & BUTTON_MASK )
 721                 INVOKE_WCB( *window, Motion, ( event.xmotion.x,
 722                                                event.xmotion.y ) );
 723             else
 724                 INVOKE_WCB( *window, Passive, ( event.xmotion.x,
 725                                                 event.xmotion.y ) );
 726         }
 727         break;
 728
 729         case ButtonRelease:
 730         case ButtonPress:
 731         {
 732             GLboolean pressed = GL_TRUE;
 733             int button;
 734
 735             if( event.type == ButtonRelease )
 736                 pressed = GL_FALSE ;
 737
 738             /*
 739              * A mouse button has been pressed or released. Traditionally,
 740              * break if the window was found within the freeglut structures.
 741              */
 742             GETWINDOW( xbutton );
 743             GETMOUSE( xbutton );
 744
 745             /*
 746              * An X button (at least in XFree86) is numbered from 1.
 747              * A GLUT button is numbered from 0.
 748              * Old GLUT passed through buttons other than just the first
 749              * three, though it only gave symbolic names and official
 750              * support to the first three.
 751              */
 752             button = event.xbutton.button - 1;
 753
 754             /*
 755              * XXX This comment is replicated in the WIN32 section and
 756              * XXX maybe also in the menu code.  Can we move the info
 757              * XXX to one central place and *reference* it from here?
 758              *
 759              * Do not execute the application's mouse callback if a menu
 760              * is hooked to this button.  In that case an appropriate
 761              * private call should be generated.
 762              * Near as I can tell, this is the menu behaviour:
 763              *  - Down-click the menu button, menu not active:  activate
 764              *    the menu with its upper left-hand corner at the mouse
 765              *    location.
 766              *  - Down-click any button outside the menu, menu active:
 767              *    deactivate the menu
 768              *  - Down-click any button inside the menu, menu active:
 769              *    select the menu entry and deactivate the menu
 770              *  - Up-click the menu button, menu not active:  nothing happens
 771              *  - Up-click the menu button outside the menu, menu active:
 772              *    nothing happens
 773              *  - Up-click the menu button inside the menu, menu active:
 774              *    select the menu entry and deactivate the menu
 775              */
 776             /* Window has an active menu, it absorbs any mouse click */
 777             if( window->ActiveMenu )
 778             {
 779                 if( window == window->ActiveMenu->ParentWindow )
 780                 {
 781                     window->ActiveMenu->Window->State.MouseX =
 782                         event.xbutton.x_root - window->ActiveMenu->X;
 783                     window->ActiveMenu->Window->State.MouseY =
 784                         event.xbutton.y_root - window->ActiveMenu->Y;
 785                 }
 786
 787                 /* In the menu, invoke the callback and deactivate the menu*/
 788                 if( fgCheckActiveMenu( window->ActiveMenu->Window,
 789                                        window->ActiveMenu ) )
 790                 {
 791                     /*
 792                      * Save the current window and menu and set the current
 793                      * window to the window whose menu this is
 794                      */
 795                     SFG_Window *save_window = fgStructure.Window;
 796                     SFG_Menu *save_menu = fgStructure.Menu;
 797                     SFG_Window *parent_window =
 798                         window->ActiveMenu->ParentWindow;
 799                     fgSetWindow( parent_window );
 800                     fgStructure.Menu = window->ActiveMenu;
 801
 802                     /* Execute the menu callback */
 803                     fgExecuteMenuCallback( window->ActiveMenu );
 804                     fgDeactivateMenu( parent_window );
 805
 806                     /* Restore the current window and menu */
 807                     fgSetWindow( save_window );
 808                     fgStructure.Menu = save_menu;
 809                 }
 810                 else if( pressed )
 811                     /*
 812                      * Outside the menu, deactivate if it's a downclick
 813                      *
 814                      * XXX This isn't enough.  A downclick outside of
 815                      * XXX the interior of our freeglut windows should also
 816                      * XXX deactivate the menu.  This is more complicated.
 817                      */
 818                     fgDeactivateMenu( window->ActiveMenu->ParentWindow );
 819
 820                 /*
 821                  * XXX Why does an active menu require a redisplay at
 822                  * XXX this point?  If this can come out cleanly, then
 823                  * XXX it probably should do so; if not, a comment should
 824                  * XXX explain it.
 825                  */
 826                 window->State.Redisplay = GL_TRUE;
 827                 break;
 828             }
 829
 830             /*
 831              * No active menu, let's check whether we need to activate one.
 832              */
 833             if( ( 0 <= button ) &&
 834                 ( FREEGLUT_MAX_MENUS > button ) &&
 835                 ( window->Menu[ button ] ) &&
 836                 pressed )
 837             {
 838                 /*
 839                  * XXX Posting a requisite Redisplay seems bogus.
 840                  */
 841                 window->State.Redisplay = GL_TRUE;
 842                 fgSetWindow( window );
 843                 fgActivateMenu( window, button );
 844                 break;
 845             }
 846
 847             /*
 848              * Check if there is a mouse or mouse wheel callback hooked to the
 849              * window
 850              */
 851             if( ! FETCH_WCB( *window, Mouse ) &&
 852                 ! FETCH_WCB( *window, MouseWheel ) )
 853                 break;
 854
 855             fgState.Modifiers = fgGetXModifiers( &event );
 856
 857             /*
 858              * Finally execute the mouse or mouse wheel callback
 859              *
 860              * XXX Use a symbolic constant, *not* "4"!  ("3, sire!")
 861              */
 862             if( ( button < 3 ) || ( ! FETCH_WCB( *window, MouseWheel ) ) )
 863                 INVOKE_WCB( *window, Mouse, ( button,
 864                                               pressed ? GLUT_DOWN : GLUT_UP,
 865                                               event.xbutton.x,
 866                                               event.xbutton.y )
 867                 );
 868             else
 869             {
 870                 /*
 871                  * Map 4 and 5 to wheel zero; EVEN to +1, ODD to -1
 872                  *  "  6 and 7 "    "   one; ...
 873                  *
 874                  * XXX This *should* be behind some variables/macros,
 875                  * XXX since the order and numbering isn't certain
 876                  * XXX See XFree86 configuration docs (even back in the
 877                  * XXX 3.x days, and especially with 4.x).
 878                  *
 879                  * XXX Note that {button} has already been decremeted
 880                  * XXX in mapping from X button numbering to GLUT.
 881                  */
 882                 int wheel_number = (button - 3) / 2;
 883                 int direction = -1;
 884                 if( button % 2 )
 885                     direction = 1;
 886
 887                 if( pressed )
 888                     INVOKE_WCB( *window, MouseWheel, ( wheel_number,
 889                                                        direction,
 890                                                        event.xbutton.x,
 891                                                        event.xbutton.y )
 892                     );
 893             }
 894
 895             /*
 896              * Trash the modifiers state
 897              */
 898             fgState.Modifiers = 0xffffffff;
 899         }
 900         break;
 901
 902         case KeyRelease:
 903         case KeyPress:
 904         {
 905             FGCBKeyboard keyboard_cb;
 906             FGCBSpecial special_cb;
 907
 908             GETWINDOW( xkey );
 909             GETMOUSE( xkey );
 910
 911             if( event.type == KeyPress )
 912             {
 913                 keyboard_cb = FETCH_WCB( *window, Keyboard );
 914                 special_cb  = FETCH_WCB( *window, Special  );
 915             }
 916             else
 917             {
 918                 keyboard_cb = FETCH_WCB( *window, KeyboardUp );
 919                 special_cb  = FETCH_WCB( *window, SpecialUp  );
 920             }
 921
 922             /*
 923              * Is there a keyboard/special callback hooked for this window?
 924              */
 925             if( keyboard_cb || special_cb )
 926             {
 927                 XComposeStatus composeStatus;
 928                 char asciiCode[ 32 ];
 929                 KeySym keySym;
 930                 int len;
 931
 932                 /*
 933                  * Check for the ASCII/KeySym codes associated with the event:
 934                  */
 935                 len = XLookupString( &event.xkey, asciiCode, sizeof(asciiCode),
 936                                      &keySym, &composeStatus
 937                 );
 938
 939                 /*
 940                  * GLUT API tells us to have two separate callbacks...
 941                  */
 942                 if( len > 0 )
 943                 {
 944                     /*
 945                      * ...one for the ASCII translateable keypresses...
 946                      */
 947                     if( keyboard_cb )
 948                     {
 949                         fgSetWindow( window );
 950                         fgState.Modifiers = fgGetXModifiers( &event );
 951                         keyboard_cb( asciiCode[ 0 ],
 952                                      event.xkey.x, event.xkey.y
 953                         );
 954                         fgState.Modifiers = 0xffffffff;
 955                     }
 956                 }
 957                 else
 958                 {
 959                     int special = -1;
 960
 961                     /*
 962                      * ...and one for all the others, which need to be
 963                      * translated to GLUT_KEY_Xs...
 964                      */
 965                     switch( keySym )
 966                     {
 967                     case XK_F1:     special = GLUT_KEY_F1;     break;
 968                     case XK_F2:     special = GLUT_KEY_F2;     break;
 969                     case XK_F3:     special = GLUT_KEY_F3;     break;
 970                     case XK_F4:     special = GLUT_KEY_F4;     break;
 971                     case XK_F5:     special = GLUT_KEY_F5;     break;
 972                     case XK_F6:     special = GLUT_KEY_F6;     break;
 973                     case XK_F7:     special = GLUT_KEY_F7;     break;
 974                     case XK_F8:     special = GLUT_KEY_F8;     break;
 975                     case XK_F9:     special = GLUT_KEY_F9;     break;
 976                     case XK_F10:    special = GLUT_KEY_F10;    break;
 977                     case XK_F11:    special = GLUT_KEY_F11;    break;
 978                     case XK_F12:    special = GLUT_KEY_F12;    break;
 979
 980                     case XK_Left:   special = GLUT_KEY_LEFT;   break;
 981                     case XK_Right:  special = GLUT_KEY_RIGHT;  break;
 982                     case XK_Up:     special = GLUT_KEY_UP;     break;
 983                     case XK_Down:   special = GLUT_KEY_DOWN;   break;
 984
 985                     case XK_KP_Prior:
 986                     case XK_Prior:  special = GLUT_KEY_PAGE_UP; break;
 987                     case XK_KP_Next:
 988                     case XK_Next:   special = GLUT_KEY_PAGE_DOWN; break;
 989                     case XK_KP_Home:
 990                     case XK_Home:   special = GLUT_KEY_HOME;   break;
 991                     case XK_KP_End:
 992                     case XK_End:    special = GLUT_KEY_END;    break;
 993                     case XK_KP_Insert:
 994                     case XK_Insert: special = GLUT_KEY_INSERT; break;
 995                     }
 996
 997                     /*
 998                      * Execute the callback (if one has been specified),
 999                      * given that the special code seems to be valid...
1000                      */
1001                     if( special_cb && (special != -1) )
1002                     {
1003                         fgSetWindow( window );
1004                         fgState.Modifiers = fgGetXModifiers( &event );
1005                         special_cb( special, event.xkey.x, event.xkey.y );
1006                         fgState.Modifiers = 0xffffffff;
1007                     }
1008                 }
1009             }
1010         }
1011         break;
1012
1013         case ReparentNotify:
1014             break; /* XXX Should disable this event */
1015
1016         default:
1017             fgWarning ("Unknown X event type: %d", event.type);
1018             break;
1019         }
1020     }
1021
1022 #elif TARGET_HOST_WIN32
1023
1024     MSG stMsg;
1025
1026     while( PeekMessage( &stMsg, NULL, 0, 0, PM_NOREMOVE ) )
1027     {
1028         if( GetMessage( &stMsg, NULL, 0, 0 ) == 0 )
1029         {
1030             if( fgState.ActionOnWindowClose == GLUT_ACTION_EXIT )
1031             {
1032                 fgDeinitialize( );
1033                 exit( 0 );
1034             }
1035             fgState.ExecState = GLUT_EXEC_STATE_STOP;
1036             return;
1037         }
1038
1039         TranslateMessage( &stMsg );
1040         DispatchMessage( &stMsg );
1041     }
1042 #endif
1043
1044     if( fgState.Timers.First )
1045         fghCheckTimers( );
1046     fghCheckJoystickPolls( );
1047     fghDisplayAll( );
1048
1049     fgCloseWindows( );
1050 }
1051
1052 /*
1053  * Enters the freeglut processing loop.
1054  * Stays until the "ExecState" changes to "GLUT_EXEC_STATE_STOP".
1055  */
1056 void FGAPIENTRY glutMainLoop( void )
1057 {
1058     int action;
1059
1060 #if TARGET_HOST_WIN32
1061     SFG_Window *window = (SFG_Window *)fgStructure.Windows.First ;
1062 #endif
1063
1064     freeglut_assert_ready;
1065
1066 #if TARGET_HOST_WIN32
1067     /*
1068      * Processing before the main loop:  If there is a window which is open and
1069      * which has a visibility callback, call it.  I know this is an ugly hack,
1070      * but I'm not sure what else to do about it.  Ideally we should leave
1071      * something uninitialized in the create window code and initialize it in
1072      * the main loop, and have that initialization create a "WM_ACTIVATE"
1073      * message.  Then we would put the visibility callback code in the
1074      * "case WM_ACTIVATE" block below.         - John Fay -- 10/24/02
1075      */
1076     while( window )
1077     {
1078         if ( FETCH_WCB( *window, Visibility ) )
1079         {
1080             SFG_Window *current_window = fgStructure.Window ;
1081
1082             INVOKE_WCB( *window, Visibility, ( window->State.Visible ) );
1083             fgSetWindow( current_window );
1084         }
1085
1086         window = (SFG_Window *)window->Node.Next ;
1087     }
1088 #endif
1089
1090     fgState.ExecState = GLUT_EXEC_STATE_RUNNING ;
1091     while( fgState.ExecState == GLUT_EXEC_STATE_RUNNING )
1092     {
1093         SFG_Window *window;
1094
1095         glutMainLoopEvent( );
1096         /*
1097          * Step through the list of windows, seeing if there are any
1098          * that are not menus
1099          */
1100         for( window = ( SFG_Window * )fgStructure.Windows.First;
1101              window;
1102              window = ( SFG_Window * )window->Node.Next )
1103             if ( ! ( window->IsMenu ) )
1104                 break;
1105
1106         if( ! window )
1107             fgState.ExecState = GLUT_EXEC_STATE_STOP;
1108         else
1109         {
1110             if( fgState.IdleCallback )
1111                 fgState.IdleCallback( );
1112
1113             fgSleepForEvents( );
1114         }
1115     }
1116
1117     /*
1118      * When this loop terminates, destroy the display, state and structure
1119      * of a freeglut session, so that another glutInit() call can happen
1120      *
1121      * Save the "ActionOnWindowClose" because "fgDeinitialize" resets it.
1122      */
1123     action = fgState.ActionOnWindowClose;
1124     fgDeinitialize( );
1125     if( action == GLUT_ACTION_EXIT )
1126         exit( 0 );
1127 }
1128
1129 /*
1130  * Leaves the freeglut processing loop.
1131  */
1132 void FGAPIENTRY glutLeaveMainLoop( void )
1133 {
1134     fgState.ExecState = GLUT_EXEC_STATE_STOP ;
1135 }
1136
1137
1138 #if TARGET_HOST_WIN32
1139 /*
1140  * Determine a GLUT modifer mask based on MS-WINDOWS system info.
1141  */
1142 int fgGetWin32Modifiers (void)
1143 {
1144     return
1145         ( ( ( GetKeyState( VK_LSHIFT   ) < 0 ) ||
1146             ( GetKeyState( VK_RSHIFT   ) < 0 )) ? GLUT_ACTIVE_SHIFT : 0 ) |
1147         ( ( ( GetKeyState( VK_LCONTROL ) < 0 ) ||
1148             ( GetKeyState( VK_RCONTROL ) < 0 )) ? GLUT_ACTIVE_CTRL  : 0 ) |
1149         ( ( ( GetKeyState( VK_LMENU    ) < 0 ) ||
1150             ( GetKeyState( VK_RMENU    ) < 0 )) ? GLUT_ACTIVE_ALT   : 0 );
1151 }
1152
1153 /*
1154  * The window procedure for handling Win32 events
1155  */
1156 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam,
1157                                LPARAM lParam )
1158 {
1159     SFG_Window* window = fgWindowByHandle( hWnd );
1160     PAINTSTRUCT ps;
1161     LONG lRet = 1;
1162
1163     if ( ( window == NULL ) && ( uMsg != WM_CREATE ) )
1164       return DefWindowProc( hWnd, uMsg, wParam, lParam );
1165
1166     /* printf ( "Window %3d message <%04x> %12d %12d\n", window?window->ID:0,
1167              uMsg, wParam, lParam ); */
1168     switch( uMsg )
1169     {
1170     case WM_CREATE:
1171         /*
1172          * The window structure is passed as the creation structure paramter...
1173          */
1174         window = (SFG_Window *) (((LPCREATESTRUCT) lParam)->lpCreateParams);
1175         assert( window != NULL );
1176
1177         window->Window.Handle = hWnd;
1178         window->Window.Device = GetDC( hWnd );
1179         if( window->IsMenu )
1180         {
1181             unsigned int current_DisplayMode = fgState.DisplayMode;
1182             fgState.DisplayMode = GLUT_DOUBLE | GLUT_RGB | GLUT_DEPTH;
1183             fgSetupPixelFormat( window, GL_FALSE, PFD_MAIN_PLANE );
1184             fgState.DisplayMode = current_DisplayMode;
1185
1186             if( fgStructure.MenuContext )
1187                 wglMakeCurrent( window->Window.Device,
1188                                 fgStructure.MenuContext->Context
1189                 );
1190             else
1191             {
1192                 fgStructure.MenuContext =
1193                     (SFG_MenuContext *)malloc( sizeof(SFG_MenuContext) );
1194                 fgStructure.MenuContext->Context =
1195                     wglCreateContext( window->Window.Device );
1196             }
1197
1198             /* window->Window.Context = wglGetCurrentContext ();   */
1199             window->Window.Context = wglCreateContext( window->Window.Device );
1200         }
1201         else
1202         {
1203             fgSetupPixelFormat( window, GL_FALSE, PFD_MAIN_PLANE );
1204
1205             if( ! fgState.UseCurrentContext )
1206                 window->Window.Context =
1207                     wglCreateContext( window->Window.Device );
1208             else
1209             {
1210                 window->Window.Context = wglGetCurrentContext( );
1211                 if( ! window->Window.Context )
1212                     window->Window.Context =
1213                         wglCreateContext( window->Window.Device );
1214             }
1215         }
1216
1217         window->State.NeedToResize = GL_TRUE;
1218         window->State.Width  = fgState.Size.X;
1219         window->State.Height = fgState.Size.Y;
1220
1221         ReleaseDC( window->Window.Handle, window->Window.Device );
1222         break;
1223
1224     case WM_SIZE:
1225         /*
1226          * If the window is visible, then it is the user manually resizing it.
1227          * If it is not, then it is the system sending us a dummy resize with
1228          * zero dimensions on a "glutIconifyWindow" call.
1229          */
1230         if( window->State.Visible )
1231         {
1232             window->State.NeedToResize = GL_TRUE;
1233             window->State.Width  = LOWORD(lParam);
1234             window->State.Height = HIWORD(lParam);
1235         }
1236
1237         break;
1238 #if 0
1239     case WM_SETFOCUS:
1240         printf("WM_SETFOCUS: %p\n", window );
1241         lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1242         break;
1243
1244     case WM_ACTIVATE:
1245         if (LOWORD(wParam) != WA_INACTIVE)
1246         {
1247             /* glutSetCursor( fgStructure.Window->State.Cursor ); */
1248             printf("WM_ACTIVATE: glutSetCursor( %p, %d)\n", window,
1249                    window->State.Cursor );
1250             glutSetCursor( window->State.Cursor );
1251         }
1252
1253         lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1254         break;
1255 #endif
1256
1257         /*
1258          * XXX Why not re-use some common code with the glutSetCursor()
1259          * XXX function (or perhaps invoke glutSetCursor())?
1260          * XXX That is, why are we duplicating code, here, from
1261          * XXX glutSetCursor()?  The WIN32 code should be able to just
1262          * XXX call glutSetCurdsor() instead of defining two macros
1263          * XXX and implementing a nested case in-line.
1264          */
1265     case WM_SETCURSOR:
1266         /* Set the cursor AND change it for this window class. */
1267 #define MAP_CURSOR(a,b)                 \
1268     case a:                             \
1269     SetCursor( LoadCursor( NULL, b ) ); \
1270     break;
1271
1272         /* Nuke the cursor AND change it for this window class. */
1273 #define ZAP_CURSOR(a,b) \
1274     case a:             \
1275     SetCursor( NULL );  \
1276     break;
1277
1278         if( LOWORD( lParam ) == HTCLIENT )
1279             switch( window->State.Cursor )
1280             {
1281                 MAP_CURSOR( GLUT_CURSOR_RIGHT_ARROW, IDC_ARROW     );
1282                 MAP_CURSOR( GLUT_CURSOR_LEFT_ARROW,  IDC_ARROW     );
1283                 MAP_CURSOR( GLUT_CURSOR_INFO,        IDC_HELP      );
1284                 MAP_CURSOR( GLUT_CURSOR_DESTROY,     IDC_CROSS     );
1285                 MAP_CURSOR( GLUT_CURSOR_HELP,        IDC_HELP      );
1286                 MAP_CURSOR( GLUT_CURSOR_CYCLE,       IDC_SIZEALL   );
1287                 MAP_CURSOR( GLUT_CURSOR_SPRAY,       IDC_CROSS     );
1288                 MAP_CURSOR( GLUT_CURSOR_WAIT,        IDC_WAIT      );
1289                 MAP_CURSOR( GLUT_CURSOR_TEXT,        IDC_UPARROW   );
1290                 MAP_CURSOR( GLUT_CURSOR_CROSSHAIR,   IDC_CROSS     );
1291                 /* MAP_CURSOR( GLUT_CURSOR_NONE,        IDC_NO         ); */
1292                 ZAP_CURSOR( GLUT_CURSOR_NONE,        NULL          );
1293
1294             default:
1295                 MAP_CURSOR( GLUT_CURSOR_UP_DOWN,     IDC_ARROW     );
1296             }
1297         else
1298             lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1299         break;
1300
1301     case WM_SHOWWINDOW:
1302         window->State.Visible = GL_TRUE;
1303         window->State.Redisplay = GL_TRUE;
1304         break;
1305
1306     case WM_PAINT:
1307         /* Turn on the visibility in case it was turned off somehow */
1308         window->State.Visible = GL_TRUE;
1309         BeginPaint( hWnd, &ps );
1310         fghRedrawWindowByHandle( hWnd );
1311         EndPaint( hWnd, &ps );
1312         break;
1313
1314     case WM_CLOSE:
1315         fgDestroyWindow ( window );
1316         if ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION )
1317             PostQuitMessage(0);
1318         break;
1319
1320     case WM_DESTROY:
1321         /*
1322          * The window already got destroyed, so don't bother with it.
1323          */
1324         return 0;
1325
1326     case WM_MOUSEMOVE:
1327     {
1328         window->State.MouseX = LOWORD( lParam );
1329         window->State.MouseY = HIWORD( lParam );
1330
1331         if ( window->ActiveMenu )
1332         {
1333             window->State.Redisplay = GL_TRUE;
1334             fgSetWindow ( window->ActiveMenu->ParentWindow );
1335             break;
1336         }
1337
1338         fgState.Modifiers = fgGetWin32Modifiers( );
1339
1340         if( ( wParam & MK_LBUTTON ) ||
1341             ( wParam & MK_MBUTTON ) ||
1342             ( wParam & MK_RBUTTON ) )
1343             INVOKE_WCB( *window, Motion, ( window->State.MouseX,
1344                                            window->State.MouseY ) );
1345         else
1346             INVOKE_WCB( *window, Passive, ( window->State.MouseX,
1347                                             window->State.MouseY ) );
1348
1349         fgState.Modifiers = 0xffffffff;
1350     }
1351     break;
1352
1353     case WM_LBUTTONDOWN:
1354     case WM_MBUTTONDOWN:
1355     case WM_RBUTTONDOWN:
1356     case WM_LBUTTONUP:
1357     case WM_MBUTTONUP:
1358     case WM_RBUTTONUP:
1359     {
1360         GLboolean pressed = GL_TRUE;
1361         int button;
1362
1363         window->State.MouseX = LOWORD( lParam );
1364         window->State.MouseY = HIWORD( lParam );
1365
1366         switch( uMsg )
1367         {
1368         case WM_LBUTTONDOWN:
1369             pressed = GL_TRUE;
1370             button = GLUT_LEFT_BUTTON;
1371             break;
1372         case WM_MBUTTONDOWN:
1373             pressed = GL_TRUE;
1374             button = GLUT_MIDDLE_BUTTON;
1375             break;
1376         case WM_RBUTTONDOWN:
1377             pressed = GL_TRUE;
1378             button = GLUT_RIGHT_BUTTON;
1379             break;
1380         case WM_LBUTTONUP:
1381             pressed = GL_FALSE;
1382             button = GLUT_LEFT_BUTTON;
1383             break;
1384         case WM_MBUTTONUP:
1385             pressed = GL_FALSE;
1386             button = GLUT_MIDDLE_BUTTON;
1387             break;
1388         case WM_RBUTTONUP:
1389             pressed = GL_FALSE;
1390             button = GLUT_RIGHT_BUTTON;
1391             break;
1392         default:
1393             pressed = GL_FALSE;
1394             button = -1;
1395             break;
1396         }
1397
1398         if( GetSystemMetrics( SM_SWAPBUTTON ) )
1399         {
1400             if( button == GLUT_LEFT_BUTTON )
1401                 button = GLUT_RIGHT_BUTTON;
1402             else
1403                 if( button == GLUT_RIGHT_BUTTON )
1404                     button = GLUT_LEFT_BUTTON;
1405         }
1406
1407         if( button == -1 )
1408             return DefWindowProc( hWnd, uMsg, lParam, wParam );
1409
1410         /*
1411          * XXX This comment is duplicated in two other spots.
1412          * XXX Can we centralize it?
1413          *
1414          * Do not execute the application's mouse callback if a
1415          * menu is hooked to this button.
1416          * In that case an appropriate private call should be generated.
1417          * Near as I can tell, this is the menu behaviour:
1418          *  - Down-click the menu button, menu not active:  activate
1419          *    the menu with its upper left-hand corner at the mouse location.
1420          *  - Down-click any button outside the menu, menu active:
1421          *    deactivate the menu
1422          *  - Down-click any button inside the menu, menu active:
1423          *    select the menu entry and deactivate the menu
1424          *  - Up-click the menu button, menu not active:  nothing happens
1425          *  - Up-click the menu button outside the menu, menu active:
1426          *    nothing happens
1427          *  - Up-click the menu button inside the menu, menu active:
1428          *    select the menu entry and deactivate the menu
1429          */
1430         /* Window has an active menu, it absorbs any mouse click */
1431         if( window->ActiveMenu )
1432         {
1433             /* Outside the menu, deactivate the menu if it's a downclick */
1434             if( ! fgCheckActiveMenu( window, window->ActiveMenu ) )
1435             {
1436                 if( pressed )
1437                     fgDeactivateMenu( window->ActiveMenu->ParentWindow );
1438             }
1439             else  /* In menu, invoke the callback and deactivate the menu*/
1440             {
1441                 /*
1442                  * Save the current window and menu and set the current
1443                  * window to the window whose menu this is
1444                  */
1445                 SFG_Window *save_window = fgStructure.Window;
1446                 SFG_Menu *save_menu = fgStructure.Menu;
1447                 SFG_Window *parent_window = window->ActiveMenu->ParentWindow;
1448                 fgSetWindow( parent_window );
1449                 fgStructure.Menu = window->ActiveMenu;
1450
1451                 /* Execute the menu callback */
1452                 fgExecuteMenuCallback( window->ActiveMenu );
1453                 fgDeactivateMenu( parent_window );
1454
1455                 /* Restore the current window and menu */
1456                 fgSetWindow( save_window );
1457                 fgStructure.Menu = save_menu;
1458             }
1459
1460             /*
1461              * Let's make the window redraw as a result of the mouse
1462              * click and menu activity.
1463              */
1464             if( ! window->IsMenu )
1465                 window->State.Redisplay = GL_TRUE;
1466
1467             break;
1468         }
1469
1470         if( window->Menu[ button ] && pressed )
1471         {
1472             window->State.Redisplay = GL_TRUE;
1473             fgSetWindow( window );
1474             fgActivateMenu( window, button );
1475
1476             break;
1477         }
1478
1479         if( ! FETCH_WCB( *window, Mouse ) )
1480             break;
1481
1482         fgSetWindow( window );
1483         fgState.Modifiers = fgGetWin32Modifiers( );
1484
1485         INVOKE_WCB(
1486             *window, Mouse,
1487             ( button,
1488               pressed ? GLUT_DOWN : GLUT_UP,
1489               window->State.MouseX,
1490               window->State.MouseY
1491             )
1492         );
1493
1494         fgState.Modifiers = 0xffffffff;
1495     }
1496     break;
1497
1498     case 0x020a:
1499         /* Should be WM_MOUSEWHEEL but my compiler doesn't recognize it */
1500     {
1501         /*
1502          * XXX THIS IS SPECULATIVE -- John Fay, 10/2/03
1503          * XXX Should use WHEEL_DELTA instead of 120
1504          */
1505         int wheel_number = LOWORD( wParam );
1506         short ticks = ( short )HIWORD( wParam ) / 120;
1507         int direction = 1;
1508
1509         if( ticks < 0 )
1510         {
1511             direction = -1;
1512             ticks = -ticks;
1513         }
1514
1515         /*
1516          * The mouse cursor has moved. Remember the new mouse cursor's position
1517          */
1518         /*        window->State.MouseX = LOWORD( lParam ); */
1519         /* Need to adjust by window position, */
1520         /*        window->State.MouseY = HIWORD( lParam ); */
1521         /* change "lParam" to other parameter */
1522
1523         if( ! FETCH_WCB( *window, MouseWheel ) &&
1524             ! FETCH_WCB( *window, Mouse ) )
1525             break;
1526
1527         fgSetWindow( window );
1528         fgState.Modifiers = fgGetWin32Modifiers( );
1529
1530         while( ticks-- )
1531             if( FETCH_WCB( *window, MouseWheel ) )
1532                 INVOKE_WCB( *window, MouseWheel,
1533                             ( wheel_number,
1534                               direction,
1535                               window->State.MouseX,
1536                               window->State.MouseY
1537                             )
1538                 );
1539             else  /* No mouse wheel, call the mouse button callback twice */
1540             {
1541                 /*
1542                  * XXX The below assumes that you have no more than 3 mouse
1543                  * XXX buttons.  Sorry.
1544                  */
1545                 int button = wheel_number*2 + 4;
1546                 if( direction > 0 )
1547                     ++button;
1548                 INVOKE_WCB( *window, Mouse,
1549                             ( button, GLUT_DOWN,
1550                               window->State.MouseX, window->State.MouseY )
1551                 );
1552                 INVOKE_WCB( *window, Mouse,
1553                             ( button, GLUT_UP,
1554                               window->State.MouseX, window->State.MouseX )
1555                 );
1556             }
1557
1558         fgState.Modifiers = 0xffffffff;
1559     }
1560     break ;
1561
1562     case WM_SYSKEYDOWN:
1563     case WM_KEYDOWN:
1564     {
1565         int keypress = -1;
1566         POINT mouse_pos ;
1567
1568         if( fgState.IgnoreKeyRepeat && (lParam & KF_REPEAT) )
1569             break;
1570
1571         /*
1572          * Remember the current modifiers state. This is done here in order
1573          * to make sure the VK_DELETE keyboard callback is executed properly.
1574          */
1575         fgState.Modifiers = fgGetWin32Modifiers( );
1576
1577         GetCursorPos( &mouse_pos );
1578         ScreenToClient( window->Window.Handle, &mouse_pos );
1579
1580         window->State.MouseX = mouse_pos.x;
1581         window->State.MouseY = mouse_pos.y;
1582
1583         /*
1584          * Convert the Win32 keystroke codes to GLUTtish way
1585          */
1586 #       define KEY(a,b) case a: keypress = b; break;
1587
1588         switch( wParam )
1589         {
1590             KEY( VK_F1,     GLUT_KEY_F1        );
1591             KEY( VK_F2,     GLUT_KEY_F2        );
1592             KEY( VK_F3,     GLUT_KEY_F3        );
1593             KEY( VK_F4,     GLUT_KEY_F4        );
1594             KEY( VK_F5,     GLUT_KEY_F5        );
1595             KEY( VK_F6,     GLUT_KEY_F6        );
1596             KEY( VK_F7,     GLUT_KEY_F7        );
1597             KEY( VK_F8,     GLUT_KEY_F8        );
1598             KEY( VK_F9,     GLUT_KEY_F9        );
1599             KEY( VK_F10,    GLUT_KEY_F10       );
1600             KEY( VK_F11,    GLUT_KEY_F11       );
1601             KEY( VK_F12,    GLUT_KEY_F12       );
1602             KEY( VK_PRIOR,  GLUT_KEY_PAGE_UP   );
1603             KEY( VK_NEXT,   GLUT_KEY_PAGE_DOWN );
1604             KEY( VK_HOME,   GLUT_KEY_HOME      );
1605             KEY( VK_END,    GLUT_KEY_END       );
1606             KEY( VK_LEFT,   GLUT_KEY_LEFT      );
1607             KEY( VK_UP,     GLUT_KEY_UP        );
1608             KEY( VK_RIGHT,  GLUT_KEY_RIGHT     );
1609             KEY( VK_DOWN,   GLUT_KEY_DOWN      );
1610             KEY( VK_INSERT, GLUT_KEY_INSERT    );
1611
1612         case VK_DELETE:
1613             /*
1614              * The delete key should be treated as an ASCII keypress:
1615              */
1616             INVOKE_WCB( *window, Keyboard,
1617                         ( 127, window->State.MouseX, window->State.MouseY )
1618             );
1619         }
1620
1621         if( keypress != -1 )
1622             INVOKE_WCB( *window, Special,
1623                         ( keypress,
1624                           window->State.MouseX, window->State.MouseY )
1625             );
1626
1627         fgState.Modifiers = 0xffffffff;
1628     }
1629     break;
1630
1631     case WM_SYSKEYUP:
1632     case WM_KEYUP:
1633     {
1634         int keypress = -1;
1635         POINT mouse_pos;
1636
1637         /*
1638          * Remember the current modifiers state. This is done here in order
1639          * to make sure the VK_DELETE keyboard callback is executed properly.
1640          */
1641         fgState.Modifiers = fgGetWin32Modifiers( );
1642
1643         GetCursorPos( &mouse_pos );
1644         ScreenToClient( window->Window.Handle, &mouse_pos );
1645
1646         window->State.MouseX = mouse_pos.x;
1647         window->State.MouseY = mouse_pos.y;
1648
1649         /*
1650          * Convert the Win32 keystroke codes to GLUTtish way.
1651          * "KEY(a,b)" was defined under "WM_KEYDOWN"
1652          */
1653
1654         switch( wParam )
1655         {
1656             KEY( VK_F1,     GLUT_KEY_F1        );
1657             KEY( VK_F2,     GLUT_KEY_F2        );
1658             KEY( VK_F3,     GLUT_KEY_F3        );
1659             KEY( VK_F4,     GLUT_KEY_F4        );
1660             KEY( VK_F5,     GLUT_KEY_F5        );
1661             KEY( VK_F6,     GLUT_KEY_F6        );
1662             KEY( VK_F7,     GLUT_KEY_F7        );
1663             KEY( VK_F8,     GLUT_KEY_F8        );
1664             KEY( VK_F9,     GLUT_KEY_F9        );
1665             KEY( VK_F10,    GLUT_KEY_F10       );
1666             KEY( VK_F11,    GLUT_KEY_F11       );
1667             KEY( VK_F12,    GLUT_KEY_F12       );
1668             KEY( VK_PRIOR,  GLUT_KEY_PAGE_UP   );
1669             KEY( VK_NEXT,   GLUT_KEY_PAGE_DOWN );
1670             KEY( VK_HOME,   GLUT_KEY_HOME      );
1671             KEY( VK_END,    GLUT_KEY_END       );
1672             KEY( VK_LEFT,   GLUT_KEY_LEFT      );
1673             KEY( VK_UP,     GLUT_KEY_UP        );
1674             KEY( VK_RIGHT,  GLUT_KEY_RIGHT     );
1675             KEY( VK_DOWN,   GLUT_KEY_DOWN      );
1676             KEY( VK_INSERT, GLUT_KEY_INSERT    );
1677
1678           case VK_DELETE:
1679               /*
1680                * The delete key should be treated as an ASCII keypress:
1681                */
1682               INVOKE_WCB( *window, KeyboardUp,
1683                           ( 127, window->State.MouseX, window->State.MouseY )
1684               );
1685               break;
1686
1687         default:
1688         {
1689             BYTE state[ 256 ];
1690             WORD code[ 2 ];
1691
1692             GetKeyboardState( state );
1693
1694             if( ToAscii( wParam, 0, state, code, 0 ) == 1 )
1695                 wParam=code[ 0 ];
1696
1697             INVOKE_WCB( *window, KeyboardUp,
1698                         ( (char)wParam,
1699                           window->State.MouseX, window->State.MouseY )
1700             );
1701         }
1702         }
1703
1704         if( keypress != -1 )
1705             INVOKE_WCB( *window, SpecialUp,
1706                         ( keypress,
1707                           window->State.MouseX, window->State.MouseY )
1708             );
1709
1710         fgState.Modifiers = 0xffffffff;
1711     }
1712     break;
1713
1714     case WM_SYSCHAR:
1715     case WM_CHAR:
1716     {
1717         if( fgState.IgnoreKeyRepeat && (lParam & KF_REPEAT) )
1718             break;
1719
1720         fgState.Modifiers = fgGetWin32Modifiers( );
1721         INVOKE_WCB( *window, Keyboard,
1722                     ( (char)wParam,
1723                       window->State.MouseX, window->State.MouseY )
1724         );
1725         fgState.Modifiers = 0xffffffff;
1726     }
1727     break;
1728
1729     case WM_CAPTURECHANGED:
1730         /* User has finished resizing the window, force a redraw */
1731         INVOKE_WCB( *window, Display, ( ) );
1732
1733         /*lRet = DefWindowProc( hWnd, uMsg, wParam, lParam ); */
1734         break;
1735
1736         /*
1737          * Other messages that I have seen and which are not handled already
1738          */
1739     case WM_SETTEXT:  /* 0x000c */
1740         lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1741         /* Pass it on to "DefWindowProc" to set the window text */
1742         break;
1743
1744     case WM_GETTEXT:  /* 0x000d */
1745         /* Ideally we would copy the title of the window into "lParam" */
1746         /* strncpy ( (char *)lParam, "Window Title", wParam );
1747            lRet = ( wParam > 12 ) ? 12 : wParam;  */
1748         /* the number of characters copied */
1749         lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1750         break;
1751
1752     case WM_GETTEXTLENGTH:  /* 0x000e */
1753         /* Ideally we would get the length of the title of the window */
1754         lRet = 12;
1755         /* the number of characters in "Window Title\0" (see above) */
1756         break;
1757
1758     case WM_ERASEBKGND:  /* 0x0014 */
1759         lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1760         break;
1761
1762     case WM_SYNCPAINT:  /* 0x0088 */
1763         /* Another window has moved, need to update this one */
1764         window->State.Redisplay = GL_TRUE;
1765         lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1766         /* Help screen says this message must be passed to "DefWindowProc" */
1767         break;
1768
1769     case WM_NCPAINT:  /* 0x0085 */
1770       /* Need to update the border of this window */
1771         lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1772         /* Pass it on to "DefWindowProc" to repaint a standard border */
1773         break;
1774
1775     case WM_SYSCOMMAND :  /* 0x0112 */
1776         {
1777           /*
1778            * We have received a system command message.  Try to act on it.
1779            * The commands are passed in through the "lParam" parameter:
1780            * Clicking on a corner to resize the window gives a "F004" message
1781            * but this is not defined in my header file.
1782            */
1783             switch ( lParam )
1784             {
1785             case SC_SIZE       :
1786                 break ;
1787
1788             case SC_MOVE       :
1789                 break ;
1790
1791             case SC_MINIMIZE   :
1792                 /* User has clicked on the "-" to minimize the window */
1793                 /* Turn off the visibility */
1794                 window->State.Visible = GL_FALSE ;
1795
1796                 break ;
1797
1798             case SC_MAXIMIZE   :
1799                 break ;
1800
1801             case SC_NEXTWINDOW :
1802                 break ;
1803
1804             case SC_PREVWINDOW :
1805                 break ;
1806
1807             case SC_CLOSE      :
1808                 /* Followed very closely by a WM_CLOSE message */
1809                 break ;
1810
1811             case SC_VSCROLL    :
1812                 break ;
1813
1814             case SC_HSCROLL    :
1815                 break ;
1816
1817             case SC_MOUSEMENU  :
1818                 break ;
1819
1820             case SC_KEYMENU    :
1821                 break ;
1822
1823             case SC_ARRANGE    :
1824                 break ;
1825
1826             case SC_RESTORE    :
1827                 break ;
1828
1829             case SC_TASKLIST   :
1830                 break ;
1831
1832             case SC_SCREENSAVE :
1833                 break ;
1834
1835             case SC_HOTKEY     :
1836                 break ;
1837             }
1838         }
1839
1840         /* We need to pass the message on to the operating system as well */
1841         lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1842         break;
1843
1844     default:
1845         /*
1846          * Handle unhandled messages
1847          */
1848         lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1849         break;
1850     }
1851
1852     return lRet;
1853 }
1854 #endif
1855
1856 /*** END OF FILE ***/