4 * The windows message processing methods.
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
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:
17 * The above copyright notice and this permission notice shall be included
18 * in all copies or substantial portions of the Software.
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.
32 #include "../include/GL/freeglut.h"
33 #include "freeglut_internal.h"
36 #if TARGET_HOST_UNIX_X11
37 #include <sys/types.h>
42 #elif TARGET_HOST_WIN32
46 #define MAX(a,b) (((a)>(b)) ? (a) : (b))
50 #define MIN(a,b) (((a)<(b)) ? (a) : (b))
55 * TODO BEFORE THE STABLE RELEASE:
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.
61 * Need to investigate why the X11 version breaks out with an error when
62 * closing a window (using the window manager, not glutDestroyWindow)...
65 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
68 * Calls a window's redraw method. This is used when
69 * a redraw is forced by the incoming window messages.
71 * XXX We can/should make a "unified" window handle type so that
72 * XXX the function headers don't need this silly #ifdef junk.
73 * XXX Make the type, say, {fgWindow}. On UNIX_X11, this is
74 * XXX {Window}. On WIN32, it is {HWND}. Then do the #ifdef
75 * XXX junk *once* in "freeglut_internal.h".
77 static void fghRedrawWindowByHandle
78 #if TARGET_HOST_UNIX_X11
80 #elif TARGET_HOST_WIN32
84 SFG_Window* window = fgWindowByHandle( handle );
85 freeglut_return_if_fail( window != NULL );
88 * XXX Other than clearing the Redisplay flag or not,
89 * XXX we may as well rely on the INVOK_WCB() doing this
92 * XXX If we do not invoke the display because the pointer
93 * XXX is not defined (should never happen, really), then
94 * XXX we may enter an infinite busy-loop trying to update
95 * XXX the window. Similarly, if we skip because the window
96 * XXX is not visible. However, if the window becomes visible
97 * XXX at a later time, the window should get its callback
98 * XXX invoked. I would recommend removing the first check,
99 * XXX and making the second check only affect whether the
100 * XXX callback is invoked---but always clear the flag, if
101 * XXX the {window} pointer is defined.
103 freeglut_return_if_fail( FETCH_WCB( *window, Display ) );
104 freeglut_return_if_fail( window->State.Visible == TRUE );
106 window->State.Redisplay = FALSE;
107 INVOKE_WCB( *window, Display, ( ) );
111 * Handle a window configuration change. When no reshape
112 * callback is hooked, the viewport size is updated to
113 * match the new window size.
115 static void fghReshapeWindowByHandle
116 #if TARGET_HOST_UNIX_X11
117 ( Window handle, int width, int height )
118 #elif TARGET_HOST_WIN32
119 ( HWND handle, int width, int height )
122 SFG_Window *current_window = fgStructure.Window;
124 SFG_Window* window = fgWindowByHandle( handle );
125 freeglut_return_if_fail( window != NULL );
127 if( !( FETCH_WCB( *window, Reshape ) ) )
129 fgSetWindow( window );
130 glViewport( 0, 0, width, height );
133 INVOKE_WCB( *window, Reshape, ( width, height ) );
136 * Force a window redraw. In Windows at least this is only a partial
137 * solution: if the window is increasing in size in either dimension,
138 * the already-drawn part does not get drawn again and things look funny.
139 * But without this we get this bad behaviour whenever we resize the
142 window->State.Redisplay = TRUE;
145 fgSetWindow( current_window );
149 * A static helper function to execute display callback for a window
151 static void fghcbDisplayWindow( SFG_Window *window, SFG_Enumerator *enumerator )
153 #if TARGET_HOST_UNIX_X11
155 * XXX Do we need/want to check the callback pointer here?
156 * XXX INVOKE_WCB() will check for us. Arguably, the
157 * XXX Redisplay status flag should be cleared regardless
158 * XXX of any concern but that {window} is a valid pointer
159 * XXX (which this function is assuming anyway).
160 * XXX Especially since old GLUT wouldn't even enter its main
161 * XXX loop if you didn't have a display callback defined...
163 if( ( FETCH_WCB( *window, Display ) ) &&
164 ( window->State.Redisplay == TRUE ) &&
165 ( window->State.Visible == TRUE ) )
167 SFG_Window *current_window = fgStructure.Window ;
169 window->State.Redisplay = FALSE;
170 INVOKE_WCB( *window, Display, ( ) );
171 fgSetWindow( current_window );
174 #elif TARGET_HOST_WIN32
176 if( window->State.NeedToResize )
178 SFG_Window *current_window = fgStructure.Window;
180 fgSetWindow( window );
182 fghReshapeWindowByHandle(
183 window->Window.Handle,
184 glutGet( GLUT_WINDOW_WIDTH ),
185 glutGet( GLUT_WINDOW_HEIGHT )
188 window->State.NeedToResize = FALSE;
189 fgSetWindow ( current_window );
193 * XXX See above comment about the Redisplay flag...
195 if( ( FETCH_WCB( *window, Display ) ) &&
196 ( window->State.Redisplay == TRUE ) &&
197 ( window->State.Visible == TRUE ) )
199 window->State.Redisplay = FALSE;
202 window->Window.Handle, NULL, NULL,
203 RDW_NOERASE | RDW_INTERNALPAINT | RDW_INVALIDATE | RDW_UPDATENOW
209 fgEnumSubWindows( window, fghcbDisplayWindow, enumerator );
213 * Make all windows perform a display call
215 static void fghDisplayAll( void )
217 SFG_Enumerator enumerator;
219 enumerator.found = FALSE;
220 enumerator.data = NULL;
222 fgEnumWindows( fghcbDisplayWindow, &enumerator );
226 * Window enumerator callback to check for the joystick polling code
228 static void fghcbCheckJoystickPolls( SFG_Window *window,
229 SFG_Enumerator *enumerator )
231 long int checkTime = fgElapsedTime( );
233 if( window->State.JoystickLastPoll + window->State.JoystickPollRate <=
236 fgJoystickPollWindow( window );
237 window->State.JoystickLastPoll = checkTime;
240 fgEnumSubWindows( window, fghcbCheckJoystickPolls, enumerator );
244 * Check all windows for joystick polling
246 static void fghCheckJoystickPolls( void )
248 SFG_Enumerator enumerator;
250 enumerator.found = FALSE;
251 enumerator.data = NULL;
253 fgEnumWindows( fghcbCheckJoystickPolls, &enumerator );
257 * Check the global timers
259 static void fghCheckTimers( void )
261 long checkTime = fgElapsedTime( );
262 SFG_Timer *timer, *next;
265 fgListInit(&timedOut);
267 for( timer = (SFG_Timer *)fgState.Timers.First;
269 timer = (SFG_Timer *)next )
271 next = (SFG_Timer *)timer->Node.Next;
273 if( timer->TriggerTime <= checkTime )
275 fgListRemove( &fgState.Timers, &timer->Node );
276 fgListAppend( &timedOut, &timer->Node );
281 * Now feel free to execute all the hooked and timed out timer callbacks
282 * And delete the timed out timers...
284 while ( (timer = (SFG_Timer *)timedOut.First) )
286 if( timer->Callback != NULL )
287 timer->Callback( timer->ID );
288 fgListRemove( &timedOut, &timer->Node );
297 long fgElapsedTime( void )
299 #if TARGET_HOST_UNIX_X11
303 gettimeofday( &now, NULL );
305 elapsed = (now.tv_usec - fgState.Time.Value.tv_usec) / 1000;
306 elapsed += (now.tv_sec - fgState.Time.Value.tv_sec) * 1000;
309 #elif TARGET_HOST_WIN32
310 return timeGetTime() - fgState.Time.Value;
317 void fgError( const char *fmt, ... )
323 fprintf( stderr, "freeglut ");
324 if( fgState.ProgramName )
325 fprintf (stderr, "(%s): ", fgState.ProgramName);
326 vfprintf( stderr, fmt, ap );
327 fprintf( stderr, "\n" );
334 void fgWarning( const char *fmt, ... )
340 fprintf( stderr, "freeglut ");
341 if( fgState.ProgramName )
342 fprintf( stderr, "(%s): ", fgState.ProgramName );
343 vfprintf( stderr, fmt, ap );
344 fprintf( stderr, "\n" );
350 * Indicates whether Joystick events are being used by ANY window.
352 * The current mechanism is to walk all of the windows and ask if
353 * there is a joystick callback. Certainly in some cases, maybe
354 * in all cases, the joystick is attached to the system and accessed
355 * from ONE point by GLUT/freeglut, so this is not the right way,
356 * in general, to do this. However, the Joystick code is segregated
357 * in its own little world, so we can't access the information that
358 * we need in order to do that nicely.
361 * * Store Joystick data into freeglut global state.
362 * * Provide NON-static functions or data from Joystick *.c file.
364 * Basically, the RIGHT way to do this requires knowing something
365 * about the Joystick. Right now, the Joystick code is behind
369 static void fgCheckJoystickCallback( SFG_Window* w, SFG_Enumerator* e)
371 if( FETCH_WCB( *w, Joystick ) )
376 fgEnumSubWindows( w, fgCheckJoystickCallback, e );
378 static int fgHaveJoystick( void )
380 SFG_Enumerator enumerator;
381 enumerator.found = FALSE;
382 enumerator.data = NULL;
383 fgEnumWindows( fgCheckJoystickCallback, &enumerator );
384 return !!enumerator.data;
386 static void fgHavePendingRedisplaysCallback( SFG_Window* w, SFG_Enumerator* e)
388 if( w->State.Redisplay )
393 fgEnumSubWindows( w, fgHavePendingRedisplaysCallback, e );
395 static int fgHavePendingRedisplays (void)
397 SFG_Enumerator enumerator;
398 enumerator.found = FALSE;
399 enumerator.data = NULL;
400 fgEnumWindows( fgHavePendingRedisplaysCallback, &enumerator );
401 return !!enumerator.data;
404 * Indicates whether there are any outstanding timers.
406 static int fgHaveTimers( void )
408 return !!fgState.Timers.First;
411 * Returns the number of GLUT ticks (milliseconds) till the next timer event.
413 static long fgNextTimer( void )
415 long now = fgElapsedTime();
419 for( timer = (SFG_Timer *)fgState.Timers.First;
421 timer = (SFG_Timer *)timer->Node.Next )
422 ret = MIN( ret, MAX( 0, (timer->TriggerTime) - now ) );
427 * Does the magic required to relinquish the CPU until something interesting
430 static void fgSleepForEvents( void )
432 #if TARGET_HOST_UNIX_X11
439 if( fgState.IdleCallback || fgHavePendingRedisplays( ) )
441 socket = ConnectionNumber( fgDisplay.Display );
443 FD_SET( socket, &fdset );
445 msec = fgNextTimer( );
446 if( fgHaveJoystick( ) )
447 msec = MIN( msec, 10 );
449 wait.tv_sec = msec / 1000;
450 wait.tv_usec = (msec % 1000) * 1000;
451 err = select( socket+1, &fdset, NULL, NULL, &wait );
454 printf( "freeglut select() error: %d\n", errno );
456 #elif TARGET_HOST_WIN32
460 #if TARGET_HOST_UNIX_X11
462 * Returns GLUT modifier mask for an XEvent.
464 int fgGetXModifiers( XEvent *event )
468 if( event->xkey.state & ( ShiftMask | LockMask ) )
469 ret |= GLUT_ACTIVE_SHIFT;
470 if( event->xkey.state & ControlMask )
471 ret |= GLUT_ACTIVE_CTRL;
472 if( event->xkey.state & Mod1Mask )
473 ret |= GLUT_ACTIVE_ALT;
480 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
483 * Executes a single iteration in the freeglut processing loop.
485 void FGAPIENTRY glutMainLoopEvent( void )
487 #if TARGET_HOST_UNIX_X11
492 * This code was repeated constantly, so here it goes into a definition:
494 #define GETWINDOW(a) \
495 window = fgWindowByHandle( event.a.window ); \
496 if( window == NULL ) \
499 #define GETMOUSE(a) \
500 window->State.MouseX = event.a.x; \
501 window->State.MouseY = event.a.y;
503 freeglut_assert_ready;
505 while( XPending( fgDisplay.Display ) )
507 XNextEvent( fgDisplay.Display, &event );
513 * This is sent to confirm the XDestroyWindow call.
514 * XXX WHY is this commented out? Should we re-enable it?
516 /* fgAddToWindowDestroyList ( window, FALSE ); */
521 * Destroy the window when the WM_DELETE_WINDOW message arrives
523 if( (Atom) event.xclient.data.l[ 0 ] == fgDisplay.DeleteWindow )
525 GETWINDOW( xclient );
527 fgCloseWindow ( window ) ;
528 fgAddToWindowDestroyList ( window, FALSE );
535 * If we never do anything with this, can we just not ask to
536 * get these messages?
542 * We are too dumb to process partial exposes...
543 * XXX Well, we could do it. However, it seems to only
544 * XXX be potentially useful for single-buffered (since
545 * XXX double-buffered does not respect viewport when we
546 * XXX do a buffer-swap).
548 if( event.xexpose.count == 0 )
549 fghRedrawWindowByHandle( event.xexpose.window );
553 * CreateNotify causes a configure-event so that sub-windows are
554 * handled compatibly with GLUT. Otherwise, your sub-windows
555 * (in freeglut only) will not get an initial reshape event,
556 * which can break things.
558 * XXX NOTE that it is possible that you will more than one Reshape
559 * XXX event for your top-level window, but something like this
560 * XXX appears to be required for compatbility.
562 * GLUT presumably does this because it generally tries to treat
563 * sub-windows the same as windows.
566 case ConfigureNotify:
567 fghReshapeWindowByHandle(
568 event.xconfigure.window,
569 event.xconfigure.width,
570 event.xconfigure.height
576 * Have the client's keyboard knowledge updated (xlib.ps,
577 * page 206, says that's a good thing to do)
579 XRefreshKeyboardMapping( (XMappingEvent *) &event );
582 case VisibilityNotify:
584 GETWINDOW( xvisibility );
585 if( ! FETCH_WCB( *window, WindowStatus ) )
587 fgSetWindow( window );
590 * Sending this event, the X server can notify us that the window
591 * has just acquired one of the three possible visibility states:
592 * VisibilityUnobscured, VisibilityPartiallyObscured or
593 * VisibilityFullyObscured
595 switch( event.xvisibility.state )
597 case VisibilityUnobscured:
598 INVOKE_WCB( *window, WindowStatus, ( GLUT_FULLY_RETAINED ) );
599 window->State.Visible = TRUE;
602 case VisibilityPartiallyObscured:
603 INVOKE_WCB( *window, WindowStatus,
604 ( GLUT_PARTIALLY_RETAINED ) );
605 window->State.Visible = TRUE;
608 case VisibilityFullyObscured:
609 INVOKE_WCB( *window, WindowStatus, ( GLUT_FULLY_COVERED ) );
610 window->State.Visible = FALSE;
614 fgWarning( "Uknown X visibility state: %d",
615 event.xvisibility.state );
623 GETWINDOW( xcrossing );
624 GETMOUSE( xcrossing );
625 INVOKE_WCB( *window, Entry, ( GLUT_ENTERED ) );
628 /* XXX Combine EnterNotify and LeaveNotify */
631 GETWINDOW( xcrossing );
632 GETMOUSE( xcrossing );
633 INVOKE_WCB( *window, Entry, ( GLUT_LEFT ) );
639 GETWINDOW( xmotion );
642 if( window->ActiveMenu )
644 if( window == window->ActiveMenu->ParentWindow )
646 window->ActiveMenu->Window->State.MouseX =
647 event.xmotion.x_root - window->ActiveMenu->X;
648 window->ActiveMenu->Window->State.MouseY =
649 event.xmotion.y_root - window->ActiveMenu->Y;
651 window->ActiveMenu->Window->State.Redisplay = TRUE ;
652 fgSetWindow( window->ActiveMenu->ParentWindow ) ;
658 * XXX For more than 5 buttons, just check {event.xmotion.state},
659 * XXX rather than a host of bit-masks?
661 if( (event.xmotion.state & Button1Mask) ||
662 (event.xmotion.state & Button2Mask) ||
663 (event.xmotion.state & Button3Mask) ||
664 (event.xmotion.state & Button4Mask) ||
665 (event.xmotion.state & Button5Mask) )
667 INVOKE_WCB( *window, Motion, ( event.xmotion.x,
672 INVOKE_WCB( *window, Passive, ( event.xmotion.x,
681 GLboolean pressed = TRUE;
684 if( event.type == ButtonRelease )
688 * A mouse button has been pressed or released. Traditionally,
689 * break if the window was found within the freeglut structures.
691 GETWINDOW( xbutton );
695 * An X button (at least in XFree86) is numbered from 1.
696 * A GLUT button is numbered from 0.
697 * Old GLUT passed through buttons other than just the first
698 * three, though it only gave symbolic names and official
699 * support to the first three.
701 button = event.xbutton.button - 1;
704 * XXX This comment is replicated in the WIN32 section and
705 * XXX maybe also in the menu code. Can we move the info
706 * XXX to one central place and *reference* it from here?
708 * Do not execute the application's mouse callback if a menu
709 * is hooked to this button. In that case an appropriate
710 * private call should be generated.
711 * Near as I can tell, this is the menu behaviour:
712 * - Down-click the menu button, menu not active: activate
713 * the menu with its upper left-hand corner at the mouse
715 * - Down-click any button outside the menu, menu active:
716 * deactivate the menu
717 * - Down-click any button inside the menu, menu active:
718 * select the menu entry and deactivate the menu
719 * - Up-click the menu button, menu not active: nothing happens
720 * - Up-click the menu button outside the menu, menu active:
722 * - Up-click the menu button inside the menu, menu active:
723 * select the menu entry and deactivate the menu
725 /* Window has an active menu, it absorbs any mouse click */
726 if( window->ActiveMenu )
728 if( window == window->ActiveMenu->ParentWindow )
730 window->ActiveMenu->Window->State.MouseX =
731 event.xbutton.x_root - window->ActiveMenu->X;
732 window->ActiveMenu->Window->State.MouseY =
733 event.xbutton.y_root - window->ActiveMenu->Y;
736 /* In the menu, invoke the callback and deactivate the menu*/
737 if( fgCheckActiveMenu( window->ActiveMenu->Window,
738 window->ActiveMenu ) == TRUE )
741 * Save the current window and menu and set the current
742 * window to the window whose menu this is
744 SFG_Window *save_window = fgStructure.Window;
745 SFG_Menu *save_menu = fgStructure.Menu;
746 SFG_Window *parent_window =
747 window->ActiveMenu->ParentWindow;
748 fgSetWindow( parent_window );
749 fgStructure.Menu = window->ActiveMenu;
751 /* Execute the menu callback */
752 fgExecuteMenuCallback( window->ActiveMenu );
753 fgDeactivateMenu( parent_window );
755 /* Restore the current window and menu */
756 fgSetWindow( save_window );
757 fgStructure.Menu = save_menu;
761 * Outside the menu, deactivate if it's a downclick
762 * XXX This isn't enough. A downclick outside of
763 * XXX the interior of our freeglut windows should also
764 * XXX deactivate the menu. This is more complicated.
766 fgDeactivateMenu( window->ActiveMenu->ParentWindow );
768 window->State.Redisplay = TRUE;
773 * No active menu, let's check whether we need to activate one.
775 if( ( 0 <= button ) &&
777 ( window->Menu[ button ] ) &&
780 window->State.Redisplay = TRUE;
781 fgSetWindow( window );
782 fgActivateMenu( window, button );
787 * Check if there is a mouse or mouse wheel callback hooked to the
790 if( ! FETCH_WCB( *window, Mouse ) &&
791 ! FETCH_WCB( *window, MouseWheel ) )
795 * XXX Why don't we use {window}? Other code here does...
797 fgStructure.Window->State.Modifiers = fgGetXModifiers( &event );
800 * Finally execute the mouse or mouse wheel callback
802 * XXX Use a symbolic constant, *not* "4"!
804 if( ( button < 3 ) || ( ! FETCH_WCB( *window, MouseWheel ) ) )
806 INVOKE_WCB( *window, Mouse, ( button,
807 pressed ? GLUT_DOWN : GLUT_UP,
815 * Map 4 and 5 to wheel zero; EVEN to +1, ODD to -1
816 * " 6 and 7 " " one; ...
818 * XXX This *should* be behind some variables/macros,
819 * XXX since the order and numbering isn't certain
820 * XXX See XFree86 configuration docs (even back in the
821 * XXX 3.x days, and especially with 4.x).
823 * XXX Note that {button} has already been decremeted
824 * XXX in mapping from X button numbering to GLUT.
826 int wheel_number = (button - 3) / 2;
832 INVOKE_WCB( *window, MouseWheel, ( wheel_number,
840 * Trash the modifiers state
842 fgStructure.Window->State.Modifiers = 0xffffffff;
849 FGCBKeyboard keyboard_cb;
850 FGCBSpecial special_cb;
855 if( event.type == KeyPress )
857 keyboard_cb = FETCH_WCB( *window, Keyboard );
858 special_cb = FETCH_WCB( *window, Special );
862 keyboard_cb = FETCH_WCB( *window, KeyboardUp );
863 special_cb = FETCH_WCB( *window, SpecialUp );
867 * Is there a keyboard/special callback hooked for this window?
869 if( keyboard_cb || special_cb )
871 XComposeStatus composeStatus;
872 char asciiCode[ 32 ];
877 * Check for the ASCII/KeySym codes associated with the event:
879 len = XLookupString( &event.xkey, asciiCode, sizeof(asciiCode),
880 &keySym, &composeStatus );
883 * GLUT API tells us to have two separate callbacks...
888 * ...one for the ASCII translateable keypresses...
892 fgSetWindow( window );
893 window->State.Modifiers = fgGetXModifiers( &event );
894 keyboard_cb( asciiCode[ 0 ],
895 event.xkey.x, event.xkey.y );
896 window->State.Modifiers = 0xffffffff;
904 * ...and one for all the others, which need to be
905 * translated to GLUT_KEY_Xs...
909 case XK_F1: special = GLUT_KEY_F1; break;
910 case XK_F2: special = GLUT_KEY_F2; break;
911 case XK_F3: special = GLUT_KEY_F3; break;
912 case XK_F4: special = GLUT_KEY_F4; break;
913 case XK_F5: special = GLUT_KEY_F5; break;
914 case XK_F6: special = GLUT_KEY_F6; break;
915 case XK_F7: special = GLUT_KEY_F7; break;
916 case XK_F8: special = GLUT_KEY_F8; break;
917 case XK_F9: special = GLUT_KEY_F9; break;
918 case XK_F10: special = GLUT_KEY_F10; break;
919 case XK_F11: special = GLUT_KEY_F11; break;
920 case XK_F12: special = GLUT_KEY_F12; break;
922 case XK_Left: special = GLUT_KEY_LEFT; break;
923 case XK_Right: special = GLUT_KEY_RIGHT; break;
924 case XK_Up: special = GLUT_KEY_UP; break;
925 case XK_Down: special = GLUT_KEY_DOWN; break;
928 case XK_Prior: special = GLUT_KEY_PAGE_UP; break;
930 case XK_Next: special = GLUT_KEY_PAGE_DOWN; break;
932 case XK_Home: special = GLUT_KEY_HOME; break;
934 case XK_End: special = GLUT_KEY_END; break;
936 case XK_Insert: special = GLUT_KEY_INSERT; break;
940 * Execute the callback (if one has been specified),
941 * given that the special code seems to be valid...
943 if( special_cb && (special != -1) )
945 fgSetWindow( window );
946 window->State.Modifiers = fgGetXModifiers( &event );
947 special_cb( special, event.xkey.x, event.xkey.y );
948 window->State.Modifiers = 0xffffffff;
956 break; /* XXX Should disable this event */
959 fgWarning ("Unknown X event type: %d", event.type);
964 #elif TARGET_HOST_WIN32
968 while( PeekMessage( &stMsg, NULL, 0, 0, PM_NOREMOVE ) )
970 if( GetMessage( &stMsg, NULL, 0, 0 ) == 0 )
971 fgState.ExecState = GLUT_EXEC_STATE_STOP ;
973 TranslateMessage( &stMsg );
974 DispatchMessage( &stMsg );
979 fghCheckJoystickPolls( );
986 * Enters the freeglut processing loop.
987 * Stays until the "ExecState" changes to "GLUT_EXEC_STATE_STOP".
989 void FGAPIENTRY glutMainLoop( void )
991 #if TARGET_HOST_WIN32
992 SFG_Window *window = (SFG_Window *)fgStructure.Windows.First ;
995 freeglut_assert_ready;
997 #if TARGET_HOST_WIN32
999 * Processing before the main loop: If there is a window which is open and
1000 * which has a visibility callback, call it. I know this is an ugly hack,
1001 * but I'm not sure what else to do about it. Ideally we should leave
1002 * something uninitialized in the create window code and initialize it in
1003 * the main loop, and have that initialization create a "WM_ACTIVATE"
1004 * message. Then we would put the visibility callback code in the
1005 * "case WM_ACTIVATE" block below. - John Fay -- 10/24/02
1009 if ( FETCH_WCB( *window, Visibility ) )
1011 SFG_Window *current_window = fgStructure.Window ;
1013 INVOKE_WCB( *window, Visibility, ( window->State.Visible ) );
1014 fgSetWindow( current_window );
1017 window = (SFG_Window *)window->Node.Next ;
1021 fgState.ExecState = GLUT_EXEC_STATE_RUNNING ;
1022 while( fgState.ExecState == GLUT_EXEC_STATE_RUNNING )
1024 glutMainLoopEvent( );
1026 if( fgStructure.Windows.First == NULL )
1027 fgState.ExecState = GLUT_EXEC_STATE_STOP;
1030 if( fgState.IdleCallback )
1031 fgState.IdleCallback( );
1038 fgExecutionState execState = fgState.ExecState;
1041 * When this loop terminates, destroy the display, state and structure
1042 * of a freeglut session, so that another glutInit() call can happen
1046 if( execState == GLUT_ACTION_EXIT )
1052 * Leaves the freeglut processing loop.
1054 void FGAPIENTRY glutLeaveMainLoop( void )
1056 fgState.ExecState = GLUT_EXEC_STATE_STOP ;
1060 #if TARGET_HOST_WIN32
1062 * Determine a GLUT modifer mask based on MS-WINDOWS system info.
1064 int fgGetWin32Modifiers (void)
1067 ( ( ( GetKeyState( VK_LSHIFT ) < 0 ) ||
1068 ( GetKeyState( VK_RSHIFT ) < 0 )) ? GLUT_ACTIVE_SHIFT : 0 ) |
1069 ( ( ( GetKeyState( VK_LCONTROL ) < 0 ) ||
1070 ( GetKeyState( VK_RCONTROL ) < 0 )) ? GLUT_ACTIVE_CTRL : 0 ) |
1071 ( ( ( GetKeyState( VK_LMENU ) < 0 ) ||
1072 ( GetKeyState( VK_RMENU ) < 0 )) ? GLUT_ACTIVE_ALT : 0 );
1076 * The window procedure for handling Win32 events
1078 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam,
1081 SFG_Window* window = fgWindowByHandle( hWnd );
1085 if ( ( window == NULL ) && ( uMsg != WM_CREATE ) )
1086 return( DefWindowProc( hWnd, uMsg, wParam, lParam ) );
1088 /* printf ( "Window %3d message <%04x> %12d %12d\n", window?window->ID:0,
1089 uMsg, wParam, lParam ); */
1094 * The window structure is passed as the creation structure paramter...
1096 window = (SFG_Window *) (((LPCREATESTRUCT) lParam)->lpCreateParams);
1097 assert( window != NULL );
1099 window->Window.Handle = hWnd;
1100 window->Window.Device = GetDC( hWnd );
1101 if( fgState.BuildingAMenu )
1103 unsigned int current_DisplayMode = fgState.DisplayMode;
1104 fgState.DisplayMode = GLUT_DOUBLE | GLUT_RGB | GLUT_DEPTH;
1105 fgSetupPixelFormat( window, FALSE, PFD_MAIN_PLANE );
1106 fgState.DisplayMode = current_DisplayMode;
1108 if( fgStructure.MenuContext )
1109 wglMakeCurrent( window->Window.Device,
1110 fgStructure.MenuContext->Context ) ;
1113 fgStructure.MenuContext =
1114 (SFG_MenuContext *)malloc( sizeof(SFG_MenuContext) );
1115 fgStructure.MenuContext->Context =
1116 wglCreateContext( window->Window.Device );
1119 /* window->Window.Context = wglGetCurrentContext () ; */
1120 window->Window.Context = wglCreateContext( window->Window.Device );
1124 fgSetupPixelFormat( window, FALSE, PFD_MAIN_PLANE );
1126 if( fgState.UseCurrentContext != TRUE )
1127 window->Window.Context =
1128 wglCreateContext( window->Window.Device );
1131 window->Window.Context = wglGetCurrentContext( );
1132 if( ! window->Window.Context )
1133 window->Window.Context =
1134 wglCreateContext( window->Window.Device );
1138 window->State.NeedToResize = TRUE;
1139 ReleaseDC( window->Window.Handle, window->Window.Device );
1144 * We got resized... But check if the window has been already added...
1146 fghReshapeWindowByHandle( hWnd, LOWORD(lParam), HIWORD(lParam) );
1150 printf("WM_SETFOCUS: %p\n", window );
1151 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1155 if (LOWORD(wParam) != WA_INACTIVE)
1157 /* glutSetCursor( fgStructure.Window->State.Cursor ); */
1158 printf("WM_ACTIVATE: glutSetCursor( %p, %d)\n", window,
1159 window->State.Cursor );
1160 glutSetCursor( window->State.Cursor );
1163 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1169 * Windows seems to need reminding to erase the cursor for NONE.
1172 if ((LOWORD(lParam) == HTCLIENT) &&
1173 (fgStructure.Window->State.Cursor == GLUT_CURSOR_NONE))
1177 /* Set the cursor AND change it for this window class. */
1178 #define MAP_CURSOR(a,b) \
1180 SetCursor( LoadCursor( NULL, b ) ); \
1183 /* Nuke the cursor AND change it for this window class. */
1184 #define ZAP_CURSOR(a,b) \
1186 SetCursor( NULL ); \
1189 if( LOWORD( lParam ) == HTCLIENT )
1190 switch( window->State.Cursor )
1192 MAP_CURSOR( GLUT_CURSOR_RIGHT_ARROW, IDC_ARROW );
1193 MAP_CURSOR( GLUT_CURSOR_LEFT_ARROW, IDC_ARROW );
1194 MAP_CURSOR( GLUT_CURSOR_INFO, IDC_HELP );
1195 MAP_CURSOR( GLUT_CURSOR_DESTROY, IDC_CROSS );
1196 MAP_CURSOR( GLUT_CURSOR_HELP, IDC_HELP );
1197 MAP_CURSOR( GLUT_CURSOR_CYCLE, IDC_SIZEALL );
1198 MAP_CURSOR( GLUT_CURSOR_SPRAY, IDC_CROSS );
1199 MAP_CURSOR( GLUT_CURSOR_WAIT, IDC_WAIT );
1200 MAP_CURSOR( GLUT_CURSOR_TEXT, IDC_UPARROW );
1201 MAP_CURSOR( GLUT_CURSOR_CROSSHAIR, IDC_CROSS );
1202 /* MAP_CURSOR( GLUT_CURSOR_NONE, IDC_NO ); */
1203 ZAP_CURSOR( GLUT_CURSOR_NONE, NULL );
1206 MAP_CURSOR( GLUT_CURSOR_UP_DOWN, IDC_ARROW );
1210 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1214 window->State.Visible = TRUE;
1215 window->State.Redisplay = TRUE;
1219 BeginPaint( hWnd, &ps );
1220 fghRedrawWindowByHandle( hWnd );
1221 EndPaint( hWnd, &ps );
1226 * Make sure we don't close a window with current context active
1228 if( fgStructure.Window == window )
1233 wglMakeCurrent( NULL, NULL );
1235 * Step through the list of windows. If the rendering context
1236 * is not being used by another window, then we delete it.
1238 for( iter = (SFG_Window *)fgStructure.Windows.First;
1240 iter = (SFG_Window *)iter->Node.Next )
1242 if( ( iter->Window.Context == window->Window.Context ) &&
1243 ( iter != window ) )
1248 wglDeleteContext( window->Window.Context );
1252 * Put on a linked list of windows to be removed after all the
1253 * callbacks have returned
1255 fgAddToWindowDestroyList( window, FALSE );
1256 DestroyWindow( hWnd );
1261 * The window already got destroyed, so don't bother with it.
1267 window->State.MouseX = LOWORD( lParam );
1268 window->State.MouseY = HIWORD( lParam );
1270 if ( window->ActiveMenu )
1272 window->State.Redisplay = TRUE;
1273 fgSetWindow ( window->ActiveMenu->ParentWindow );
1277 window->State.Modifiers = fgGetWin32Modifiers( );
1279 if( ( wParam & MK_LBUTTON ) ||
1280 ( wParam & MK_MBUTTON ) ||
1281 ( wParam & MK_RBUTTON ) )
1283 INVOKE_WCB( *window, Motion, ( window->State.MouseX,
1284 window->State.MouseY ) );
1288 INVOKE_WCB( *window, Passive, ( window->State.MouseX,
1289 window->State.MouseY ) );
1292 window->State.Modifiers = 0xffffffff;
1296 case WM_LBUTTONDOWN:
1297 case WM_MBUTTONDOWN:
1298 case WM_RBUTTONDOWN:
1303 GLboolean pressed = TRUE;
1306 window->State.MouseX = LOWORD( lParam );
1307 window->State.MouseY = HIWORD( lParam );
1311 case WM_LBUTTONDOWN:
1312 pressed = TRUE; button = GLUT_LEFT_BUTTON; break;
1313 case WM_MBUTTONDOWN:
1314 pressed = TRUE; button = GLUT_MIDDLE_BUTTON; break;
1315 case WM_RBUTTONDOWN:
1316 pressed = TRUE; button = GLUT_RIGHT_BUTTON; break;
1318 pressed = FALSE; button = GLUT_LEFT_BUTTON; break;
1320 pressed = FALSE; button = GLUT_MIDDLE_BUTTON; break;
1322 pressed = FALSE; button = GLUT_RIGHT_BUTTON; break;
1324 pressed = FALSE; button = -1; break;
1327 if( GetSystemMetrics( SM_SWAPBUTTON ) )
1328 if( button == GLUT_LEFT_BUTTON )
1329 button = GLUT_RIGHT_BUTTON;
1330 else if( button == GLUT_RIGHT_BUTTON )
1331 button = GLUT_LEFT_BUTTON;
1334 return DefWindowProc( hWnd, uMsg, lParam, wParam );
1337 * Do not execute the application's mouse callback if a
1338 * menu is hooked to this button.
1339 * In that case an appropriate private call should be generated.
1340 * Near as I can tell, this is the menu behaviour:
1341 * - Down-click the menu button, menu not active: activate
1342 * the menu with its upper left-hand corner at the mouse location.
1343 * - Down-click any button outside the menu, menu active:
1344 * deactivate the menu
1345 * - Down-click any button inside the menu, menu active:
1346 * select the menu entry and deactivate the menu
1347 * - Up-click the menu button, menu not active: nothing happens
1348 * - Up-click the menu button outside the menu, menu active:
1350 * - Up-click the menu button inside the menu, menu active:
1351 * select the menu entry and deactivate the menu
1353 /* Window has an active menu, it absorbs any mouse click */
1354 if( window->ActiveMenu )
1356 /* Inside the menu, invoke the callback and deactivate the menu*/
1357 if( fgCheckActiveMenu( window, window->ActiveMenu ) == TRUE )
1360 * Save the current window and menu and set the current
1361 * window to the window whose menu this is
1363 SFG_Window *save_window = fgStructure.Window;
1364 SFG_Menu *save_menu = fgStructure.Menu;
1365 SFG_Window *parent_window = window->ActiveMenu->ParentWindow;
1366 fgSetWindow( parent_window );
1367 fgStructure.Menu = window->ActiveMenu;
1369 /* Execute the menu callback */
1370 fgExecuteMenuCallback( window->ActiveMenu );
1371 fgDeactivateMenu( parent_window );
1373 /* Restore the current window and menu */
1374 fgSetWindow( save_window );
1375 fgStructure.Menu = save_menu;
1377 else /* Out of menu, deactivate the menu if it's a downclick */
1379 if( pressed == TRUE )
1380 fgDeactivateMenu( window->ActiveMenu->ParentWindow );
1384 * Let's make the window redraw as a result of the mouse
1385 * click and menu activity.
1387 if( ! window->IsMenu )
1388 window->State.Redisplay = TRUE;
1393 if ( ( window->Menu[ button ] ) && ( pressed == TRUE ) )
1395 window->State.Redisplay = TRUE;
1396 fgSetWindow( window );
1397 fgActivateMenu( window, button );
1402 if( ! FETCH_WCB( *window, Mouse ) )
1405 fgSetWindow( window );
1406 fgStructure.Window->State.Modifiers = fgGetWin32Modifiers( );
1411 pressed == TRUE ? GLUT_DOWN : GLUT_UP,
1412 window->State.MouseX,
1413 window->State.MouseY
1417 fgStructure.Window->State.Modifiers = 0xffffffff;
1422 /* Should be WM_MOUSEWHEEL but my compiler doesn't recognize it */
1424 int wheel_number = LOWORD( wParam );
1425 /* THIS IS SPECULATIVE -- John Fay, 10/2/03 */
1426 short ticks = HIWORD( wParam ) / 120;
1427 /* Should be WHEEL_DELTA instead of 120 */
1437 * The mouse cursor has moved. Remember the new mouse cursor's position
1439 /* window->State.MouseX = LOWORD( lParam ); */
1440 /* Need to adjust by window position, */
1441 /* window->State.MouseY = HIWORD( lParam ); */
1442 /* change "lParam" to other parameter */
1444 if( ! FETCH_WCB( *window, MouseWheel ) &&
1445 ! FETCH_WCB( *window, Mouse ) )
1448 fgSetWindow( window );
1449 fgStructure.Window->State.Modifiers = fgGetWin32Modifiers( );
1452 if( FETCH_WCB( *window, MouseWheel ) )
1454 INVOKE_WCB( *window, MouseWheel,
1457 window->State.MouseX,
1458 window->State.MouseY
1462 else /* No mouse wheel, call the mouse button callback twice */
1465 * XXX The below assumes that you have no more than 3 mouse
1466 * XXX buttons. Sorry.
1468 int button = wheel_number*2 + 4;
1471 INVOKE_WCB( *window, Mouse,
1472 ( button, GLUT_DOWN,
1473 window->State.MouseX, window->State.MouseY )
1475 INVOKE_WCB( *window, Mouse,
1477 window->State.MouseX, window->State.MouseX )
1481 fgStructure.Window->State.Modifiers = 0xffffffff;
1491 if( fgState.IgnoreKeyRepeat && (lParam & KF_REPEAT) )
1495 * Remember the current modifiers state. This is done here in order
1496 * to make sure the VK_DELETE keyboard callback is executed properly.
1498 window->State.Modifiers = fgGetWin32Modifiers( );
1500 GetCursorPos( &mouse_pos );
1501 ScreenToClient( window->Window.Handle, &mouse_pos );
1503 window->State.MouseX = mouse_pos.x;
1504 window->State.MouseY = mouse_pos.y;
1507 * Convert the Win32 keystroke codes to GLUTtish way
1509 # define KEY(a,b) case a: keypress = b; break;
1513 KEY( VK_F1, GLUT_KEY_F1 );
1514 KEY( VK_F2, GLUT_KEY_F2 );
1515 KEY( VK_F3, GLUT_KEY_F3 );
1516 KEY( VK_F4, GLUT_KEY_F4 );
1517 KEY( VK_F5, GLUT_KEY_F5 );
1518 KEY( VK_F6, GLUT_KEY_F6 );
1519 KEY( VK_F7, GLUT_KEY_F7 );
1520 KEY( VK_F8, GLUT_KEY_F8 );
1521 KEY( VK_F9, GLUT_KEY_F9 );
1522 KEY( VK_F10, GLUT_KEY_F10 );
1523 KEY( VK_F11, GLUT_KEY_F11 );
1524 KEY( VK_F12, GLUT_KEY_F12 );
1525 KEY( VK_PRIOR, GLUT_KEY_PAGE_UP );
1526 KEY( VK_NEXT, GLUT_KEY_PAGE_DOWN );
1527 KEY( VK_HOME, GLUT_KEY_HOME );
1528 KEY( VK_END, GLUT_KEY_END );
1529 KEY( VK_LEFT, GLUT_KEY_LEFT );
1530 KEY( VK_UP, GLUT_KEY_UP );
1531 KEY( VK_RIGHT, GLUT_KEY_RIGHT );
1532 KEY( VK_DOWN, GLUT_KEY_DOWN );
1533 KEY( VK_INSERT, GLUT_KEY_INSERT );
1537 * The delete key should be treated as an ASCII keypress:
1539 INVOKE_WCB( *window, Keyboard,
1540 ( 127, window->State.MouseX, window->State.MouseY )
1544 if( keypress != -1 )
1545 INVOKE_WCB( *window, Special,
1547 window->State.MouseX, window->State.MouseY )
1550 window->State.Modifiers = 0xffffffff;
1561 * Remember the current modifiers state. This is done here in order
1562 * to make sure the VK_DELETE keyboard callback is executed properly.
1564 window->State.Modifiers = fgGetWin32Modifiers( );
1566 GetCursorPos( &mouse_pos );
1567 ScreenToClient( window->Window.Handle, &mouse_pos );
1569 window->State.MouseX = mouse_pos.x;
1570 window->State.MouseY = mouse_pos.y;
1573 * Convert the Win32 keystroke codes to GLUTtish way.
1574 * "KEY(a,b)" was defined under "WM_KEYDOWN"
1579 KEY( VK_F1, GLUT_KEY_F1 );
1580 KEY( VK_F2, GLUT_KEY_F2 );
1581 KEY( VK_F3, GLUT_KEY_F3 );
1582 KEY( VK_F4, GLUT_KEY_F4 );
1583 KEY( VK_F5, GLUT_KEY_F5 );
1584 KEY( VK_F6, GLUT_KEY_F6 );
1585 KEY( VK_F7, GLUT_KEY_F7 );
1586 KEY( VK_F8, GLUT_KEY_F8 );
1587 KEY( VK_F9, GLUT_KEY_F9 );
1588 KEY( VK_F10, GLUT_KEY_F10 );
1589 KEY( VK_F11, GLUT_KEY_F11 );
1590 KEY( VK_F12, GLUT_KEY_F12 );
1591 KEY( VK_PRIOR, GLUT_KEY_PAGE_UP );
1592 KEY( VK_NEXT, GLUT_KEY_PAGE_DOWN );
1593 KEY( VK_HOME, GLUT_KEY_HOME );
1594 KEY( VK_END, GLUT_KEY_END );
1595 KEY( VK_LEFT, GLUT_KEY_LEFT );
1596 KEY( VK_UP, GLUT_KEY_UP );
1597 KEY( VK_RIGHT, GLUT_KEY_RIGHT );
1598 KEY( VK_DOWN, GLUT_KEY_DOWN );
1599 KEY( VK_INSERT, GLUT_KEY_INSERT );
1603 * The delete key should be treated as an ASCII keypress:
1605 INVOKE_WCB( *window, KeyboardUp,
1606 ( 127, window->State.MouseX, window->State.MouseY )
1615 GetKeyboardState( state );
1617 if( ToAscii( wParam, 0, state, code, 0 ) == 1 )
1620 INVOKE_WCB( *window, KeyboardUp,
1622 window->State.MouseX, window->State.MouseY )
1627 if( keypress != -1 )
1628 INVOKE_WCB( *window, SpecialUp,
1630 window->State.MouseX, window->State.MouseY )
1633 window->State.Modifiers = 0xffffffff;
1640 if( fgState.IgnoreKeyRepeat && (lParam & KF_REPEAT) )
1644 * XXX INVOKE_WCB() takes care of the callback-pointer check.
1645 * XXX We could just uncoditionally find/trash the Modifiers
1646 * XXX and get rid of the "if( ... ) {" and "}". Unconditinal
1647 * XXX code is simpler code. (^&
1649 if( FETCH_WCB( *window, Keyboard ) )
1651 window->State.Modifiers = fgGetWin32Modifiers( );
1652 INVOKE_WCB( *window, Keyboard,
1654 window->State.MouseX, window->State.MouseY )
1656 window->State.Modifiers = 0xffffffff;
1661 case WM_CAPTURECHANGED:
1662 /* User has finished resizing the window, force a redraw */
1663 INVOKE_WCB( *window, Display, ( ) );
1665 /*lRet = DefWindowProc( hWnd, uMsg, wParam, lParam ) ; */
1669 * Other messages that I have seen and which are not handled already
1671 case WM_SETTEXT: /* 0x000c */
1672 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1673 /* Pass it on to "DefWindowProc" to set the window text */
1676 case WM_GETTEXT: /* 0x000d */
1677 /* Ideally we would copy the title of the window into "lParam" */
1678 /* strncpy ( (char *)lParam, "Window Title", wParam );
1679 lRet = ( wParam > 12 ) ? 12 : wParam; */
1680 /* the number of characters copied */
1681 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1684 case WM_GETTEXTLENGTH: /* 0x000e */
1685 /* Ideally we would get the length of the title of the window */
1687 /* the number of characters in "Window Title\0" (see above) */
1690 case WM_ERASEBKGND: /* 0x0014 */
1691 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1694 case WM_SYNCPAINT: /* 0x0088 */
1695 /* Another window has moved, need to update this one */
1696 window->State.Redisplay = TRUE;
1697 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1698 /* Help screen says this message must be passed to "DefWindowProc" */
1701 case WM_NCPAINT: /* 0x0085 */
1702 /* Need to update the border of this window */
1703 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1704 /* Pass it on to "DefWindowProc" to repaint a standard border */
1709 * Handle unhandled messages
1711 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1719 /*** END OF FILE ***/