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 * Handle a window configuration change. When no reshape
69 * callback is hooked, the viewport size is updated to
70 * match the new window size.
72 static void fghReshapeWindowByHandle ( SFG_WindowHandleType handle,
73 int width, int height )
75 SFG_Window *current_window = fgStructure.Window;
77 SFG_Window* window = fgWindowByHandle( handle );
78 freeglut_return_if_fail( window != NULL );
81 #if TARGET_HOST_UNIX_X11
83 XResizeWindow( fgDisplay.Display, window->Window.Handle,
85 XFlush( fgDisplay.Display ); /* XXX Shouldn't need this */
87 #elif TARGET_HOST_WIN32
93 * For windowed mode, get the current position of the
94 * window and resize taking the size of the frame
95 * decorations into account.
98 GetWindowRect( window->Window.Handle, &rect );
99 rect.right = rect.left + width;
100 rect.bottom = rect.top + height;
102 if ( window->Parent == NULL )
104 if ( ! window->IsMenu && !window->State.IsGameMode )
106 rect.right += GetSystemMetrics( SM_CXSIZEFRAME ) * 2;
107 rect.bottom += GetSystemMetrics( SM_CYSIZEFRAME ) * 2 +
108 GetSystemMetrics( SM_CYCAPTION );
113 GetWindowRect( window->Parent->Window.Handle, &rect );
114 AdjustWindowRect ( &rect, WS_OVERLAPPEDWINDOW | WS_CLIPSIBLINGS |
115 WS_CLIPCHILDREN, FALSE );
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)
125 SetWindowPos( window->Window.Handle,
129 rect.right - rect.left,
130 rect.bottom - rect.top,
131 SWP_NOACTIVATE | SWP_NOOWNERZORDER | SWP_NOSENDCHANGING |
137 * XXX Should update {window->State.OldWidth, window->State.OldHeight}
138 * XXX to keep in lockstep with UNIX_X11 code.
140 if( FETCH_WCB( *window, Reshape ) )
141 INVOKE_WCB( *window, Reshape, ( width, height ) );
144 fgSetWindow( window );
145 glViewport( 0, 0, width, height );
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
157 window->State.Redisplay = GL_TRUE;
160 fgSetWindow( current_window );
164 * Calls a window's redraw method. This is used when
165 * a redraw is forced by the incoming window messages.
167 static void fghRedrawWindowByHandle ( SFG_WindowHandleType handle )
169 SFG_Window* window = fgWindowByHandle( handle );
170 freeglut_return_if_fail( window );
171 freeglut_return_if_fail( FETCH_WCB ( *window, Display ) );
173 window->State.Redisplay = GL_FALSE;
175 freeglut_return_if_fail( window->State.Visible );
177 if( window->State.NeedToResize )
179 SFG_Window *current_window = fgStructure.Window;
181 fgSetWindow( window );
183 fghReshapeWindowByHandle(
184 window->Window.Handle,
189 window->State.NeedToResize = GL_FALSE;
190 fgSetWindow( current_window );
193 INVOKE_WCB( *window, Display, ( ) );
197 * A static helper function to execute display callback for a window
199 static void fghcbDisplayWindow( SFG_Window *window,
200 SFG_Enumerator *enumerator )
202 if( window->State.NeedToResize )
204 SFG_Window *current_window = fgStructure.Window;
206 fgSetWindow( window );
208 fghReshapeWindowByHandle(
209 window->Window.Handle,
214 window->State.NeedToResize = GL_FALSE;
215 fgSetWindow ( current_window );
218 if( window->State.Redisplay &&
219 window->State.Visible )
221 window->State.Redisplay = GL_FALSE;
223 #if TARGET_HOST_UNIX_X11
225 SFG_Window *current_window = fgStructure.Window;
227 INVOKE_WCB( *window, Display, ( ) );
228 fgSetWindow( current_window );
230 #elif TARGET_HOST_WIN32
232 window->Window.Handle, NULL, NULL,
233 RDW_NOERASE | RDW_INTERNALPAINT | RDW_INVALIDATE | RDW_UPDATENOW
238 fgEnumSubWindows( window, fghcbDisplayWindow, enumerator );
242 * Make all windows perform a display call
244 static void fghDisplayAll( void )
246 SFG_Enumerator enumerator;
248 enumerator.found = GL_FALSE;
249 enumerator.data = NULL;
251 fgEnumWindows( fghcbDisplayWindow, &enumerator );
255 * Window enumerator callback to check for the joystick polling code
257 static void fghcbCheckJoystickPolls( SFG_Window *window,
258 SFG_Enumerator *enumerator )
260 long int checkTime = fgElapsedTime( );
262 if( window->State.JoystickLastPoll + window->State.JoystickPollRate <=
265 fgJoystickPollWindow( window );
266 window->State.JoystickLastPoll = checkTime;
269 fgEnumSubWindows( window, fghcbCheckJoystickPolls, enumerator );
273 * Check all windows for joystick polling
275 static void fghCheckJoystickPolls( void )
277 SFG_Enumerator enumerator;
279 enumerator.found = GL_FALSE;
280 enumerator.data = NULL;
282 fgEnumWindows( fghcbCheckJoystickPolls, &enumerator );
286 * Check the global timers
288 static void fghCheckTimers( void )
290 long checkTime = fgElapsedTime( );
292 while( fgState.Timers.First )
294 SFG_Timer *timer = fgState.Timers.First;
296 if( timer->TriggerTime > checkTime )
299 fgListRemove( &fgState.Timers, &timer->Node );
300 fgListAppend( &fgState.FreeTimers, &timer->Node );
302 timer->Callback( timer->ID );
309 long fgElapsedTime( void )
311 if ( fgState.Time.Set )
313 #if TARGET_HOST_UNIX_X11
317 gettimeofday( &now, NULL );
319 elapsed = (now.tv_usec - fgState.Time.Value.tv_usec) / 1000;
320 elapsed += (now.tv_sec - fgState.Time.Value.tv_sec) * 1000;
323 #elif TARGET_HOST_WIN32
324 return timeGetTime() - fgState.Time.Value;
329 #if TARGET_HOST_UNIX_X11
330 gettimeofday( &fgState.Time.Value, NULL );
331 #elif TARGET_HOST_WIN32
332 fgState.Time.Value = timeGetTime ();
334 fgState.Time.Set = GL_TRUE ;
343 void fgError( const char *fmt, ... )
349 fprintf( stderr, "freeglut ");
350 if( fgState.ProgramName )
351 fprintf (stderr, "(%s): ", fgState.ProgramName);
352 vfprintf( stderr, fmt, ap );
353 fprintf( stderr, "\n" );
357 if ( fgState.Initialised )
363 void fgWarning( const char *fmt, ... )
369 fprintf( stderr, "freeglut ");
370 if( fgState.ProgramName )
371 fprintf( stderr, "(%s): ", fgState.ProgramName );
372 vfprintf( stderr, fmt, ap );
373 fprintf( stderr, "\n" );
379 * Indicates whether Joystick events are being used by ANY window.
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.
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.
390 static void fgCheckJoystickCallback( SFG_Window* w, SFG_Enumerator* e)
392 if( FETCH_WCB( *w, Joystick ) )
397 fgEnumSubWindows( w, fgCheckJoystickCallback, e );
399 static int fgHaveJoystick( void )
401 SFG_Enumerator enumerator;
402 enumerator.found = GL_FALSE;
403 enumerator.data = NULL;
404 fgEnumWindows( fgCheckJoystickCallback, &enumerator );
405 return !!enumerator.data;
407 static void fgHavePendingRedisplaysCallback( SFG_Window* w, SFG_Enumerator* e)
409 if( w->State.Redisplay )
414 fgEnumSubWindows( w, fgHavePendingRedisplaysCallback, e );
416 static int fgHavePendingRedisplays (void)
418 SFG_Enumerator enumerator;
419 enumerator.found = GL_FALSE;
420 enumerator.data = NULL;
421 fgEnumWindows( fgHavePendingRedisplaysCallback, &enumerator );
422 return !!enumerator.data;
425 * Returns the number of GLUT ticks (milliseconds) till the next timer event.
427 static long fgNextTimer( void )
430 SFG_Timer *timer = fgState.Timers.First;
433 ret = timer->TriggerTime - fgElapsedTime();
440 * Does the magic required to relinquish the CPU until something interesting
443 static void fgSleepForEvents( void )
447 if( fgState.IdleCallback || fgHavePendingRedisplays( ) )
450 msec = fgNextTimer( );
451 if( fgHaveJoystick( ) ) /* XXX Use GLUT timers for joysticks... */
452 msec = MIN( msec, 10 ); /* XXX Dumb; forces granularity to .01sec */
454 #if TARGET_HOST_UNIX_X11
461 socket = ConnectionNumber( fgDisplay.Display );
463 FD_SET( socket, &fdset );
464 wait.tv_sec = msec / 1000;
465 wait.tv_usec = (msec % 1000) * 1000;
466 err = select( socket+1, &fdset, NULL, NULL, &wait );
469 fgWarning ( "freeglut select() error: %d\n", errno );
471 #elif TARGET_HOST_WIN32
472 MsgWaitForMultipleObjects( 0, NULL, FALSE, msec, QS_ALLEVENTS );
476 #if TARGET_HOST_UNIX_X11
478 * Returns GLUT modifier mask for an XEvent.
480 int fgGetXModifiers( XEvent *event )
484 if( event->xkey.state & ( ShiftMask | LockMask ) )
485 ret |= GLUT_ACTIVE_SHIFT;
486 if( event->xkey.state & ControlMask )
487 ret |= GLUT_ACTIVE_CTRL;
488 if( event->xkey.state & Mod1Mask )
489 ret |= GLUT_ACTIVE_ALT;
496 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
499 * Executes a single iteration in the freeglut processing loop.
501 void FGAPIENTRY glutMainLoopEvent( void )
503 #if TARGET_HOST_UNIX_X11
508 * This code was repeated constantly, so here it goes into a definition:
510 #define GETWINDOW(a) \
511 window = fgWindowByHandle( event.a.window ); \
512 if( window == NULL ) \
515 #define GETMOUSE(a) \
516 window->State.MouseX = event.a.x; \
517 window->State.MouseY = event.a.y;
519 freeglut_assert_ready;
521 while( XPending( fgDisplay.Display ) )
523 XNextEvent( fgDisplay.Display, &event );
529 * Destroy the window when the WM_DELETE_WINDOW message arrives
531 if( (Atom) event.xclient.data.l[ 0 ] == fgDisplay.DeleteWindow )
533 GETWINDOW( xclient );
535 fgDestroyWindow ( window );
537 if( fgState.ActionOnWindowClose == GLUT_ACTION_EXIT )
543 fgState.ExecState = GLUT_EXEC_STATE_STOP;
549 * CreateNotify causes a configure-event so that sub-windows are
550 * handled compatibly with GLUT. Otherwise, your sub-windows
551 * (in freeglut only) will not get an initial reshape event,
552 * which can break things.
554 * GLUT presumably does this because it generally tries to treat
555 * sub-windows the same as windows.
557 * XXX Technically, GETWINDOW( xconfigure ) and
558 * XXX {event.xconfigure} may not be legit ways to get at
559 * XXX data for CreateNotify events. In practice, the data
560 * XXX is in a union which is laid out much the same either
561 * XXX way. But if you want to split hairs, this isn't legit,
562 * XXX and we should instead duplicate some code.
565 case ConfigureNotify:
566 GETWINDOW( xconfigure );
568 int width = event.xconfigure.width;
569 int height = event.xconfigure.height;
571 if( ( width != window->State.OldWidth ) ||
572 ( height != window->State.OldHeight ) )
574 window->State.OldWidth = width;
575 window->State.OldHeight = height;
576 if( FETCH_WCB( *window, Reshape ) )
577 INVOKE_WCB( *window, Reshape, ( width, height ) );
580 fgSetWindow( window );
581 glViewport( 0, 0, width, height );
583 glutPostRedisplay( );
590 * This is sent to confirm the XDestroyWindow call.
592 * XXX WHY is this commented out? Should we re-enable it?
594 /* fgAddToWindowDestroyList ( window ); */
599 * We are too dumb to process partial exposes...
601 * XXX Well, we could do it. However, it seems to only
602 * XXX be potentially useful for single-buffered (since
603 * XXX double-buffered does not respect viewport when we
604 * XXX do a buffer-swap).
606 * XXX GETWINDOW( xexpose );
607 * XXX fgSetWindow( window );
608 * XXX glutPostRedisplay( );
610 if( event.xexpose.count == 0 )
611 fghRedrawWindowByHandle( event.xexpose.window );
617 * If we never do anything with this, can we just not ask to
618 * get these messages?
624 * Have the client's keyboard knowledge updated (xlib.ps,
625 * page 206, says that's a good thing to do)
627 XRefreshKeyboardMapping( (XMappingEvent *) &event );
630 case VisibilityNotify:
632 GETWINDOW( xvisibility );
634 * XXX INVOKE_WCB() does this check for us.
636 if( ! FETCH_WCB( *window, WindowStatus ) )
638 fgSetWindow( window );
641 * Sending this event, the X server can notify us that the window
642 * has just acquired one of the three possible visibility states:
643 * VisibilityUnobscured, VisibilityPartiallyObscured or
644 * VisibilityFullyObscured
646 switch( event.xvisibility.state )
648 case VisibilityUnobscured:
649 INVOKE_WCB( *window, WindowStatus, ( GLUT_FULLY_RETAINED ) );
650 window->State.Visible = GL_TRUE;
653 case VisibilityPartiallyObscured:
654 INVOKE_WCB( *window, WindowStatus,
655 ( GLUT_PARTIALLY_RETAINED ) );
656 window->State.Visible = GL_TRUE;
659 case VisibilityFullyObscured:
660 INVOKE_WCB( *window, WindowStatus, ( GLUT_FULLY_COVERED ) );
661 window->State.Visible = GL_FALSE;
665 fgWarning( "Uknown X visibility state: %d",
666 event.xvisibility.state );
674 GETWINDOW( xcrossing );
675 GETMOUSE( xcrossing );
676 INVOKE_WCB( *window, Entry, ( ( EnterNotify == event.type ) ?
683 GETWINDOW( xmotion );
686 if( window->ActiveMenu )
688 if( window == window->ActiveMenu->ParentWindow )
690 window->ActiveMenu->Window->State.MouseX =
691 event.xmotion.x_root - window->ActiveMenu->X;
692 window->ActiveMenu->Window->State.MouseY =
693 event.xmotion.y_root - window->ActiveMenu->Y;
695 window->ActiveMenu->Window->State.Redisplay = GL_TRUE ;
696 fgSetWindow( window->ActiveMenu->ParentWindow );
702 * XXX For more than 5 buttons, just check {event.xmotion.state},
703 * XXX rather than a host of bit-masks? Or maybe we need to
704 * XXX track ButtonPress/ButtonRelease events in our own
707 #define BUTTON_MASK \
708 ( Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask )
709 if ( event.xmotion.state & BUTTON_MASK )
710 INVOKE_WCB( *window, Motion, ( event.xmotion.x,
713 INVOKE_WCB( *window, Passive, ( event.xmotion.x,
721 GLboolean pressed = GL_TRUE;
724 if( event.type == ButtonRelease )
728 * A mouse button has been pressed or released. Traditionally,
729 * break if the window was found within the freeglut structures.
731 GETWINDOW( xbutton );
735 * An X button (at least in XFree86) is numbered from 1.
736 * A GLUT button is numbered from 0.
737 * Old GLUT passed through buttons other than just the first
738 * three, though it only gave symbolic names and official
739 * support to the first three.
741 button = event.xbutton.button - 1;
744 * XXX This comment is replicated in the WIN32 section and
745 * XXX maybe also in the menu code. Can we move the info
746 * XXX to one central place and *reference* it from here?
748 * Do not execute the application's mouse callback if a menu
749 * is hooked to this button. In that case an appropriate
750 * private call should be generated.
751 * Near as I can tell, this is the menu behaviour:
752 * - Down-click the menu button, menu not active: activate
753 * the menu with its upper left-hand corner at the mouse
755 * - Down-click any button outside the menu, menu active:
756 * deactivate the menu
757 * - Down-click any button inside the menu, menu active:
758 * select the menu entry and deactivate the menu
759 * - Up-click the menu button, menu not active: nothing happens
760 * - Up-click the menu button outside the menu, menu active:
762 * - Up-click the menu button inside the menu, menu active:
763 * select the menu entry and deactivate the menu
765 /* Window has an active menu, it absorbs any mouse click */
766 if( window->ActiveMenu )
768 if( window == window->ActiveMenu->ParentWindow )
770 window->ActiveMenu->Window->State.MouseX =
771 event.xbutton.x_root - window->ActiveMenu->X;
772 window->ActiveMenu->Window->State.MouseY =
773 event.xbutton.y_root - window->ActiveMenu->Y;
776 /* In the menu, invoke the callback and deactivate the menu*/
777 if( fgCheckActiveMenu( window->ActiveMenu->Window,
778 window->ActiveMenu ) )
781 * Save the current window and menu and set the current
782 * window to the window whose menu this is
784 SFG_Window *save_window = fgStructure.Window;
785 SFG_Menu *save_menu = fgStructure.Menu;
786 SFG_Window *parent_window =
787 window->ActiveMenu->ParentWindow;
788 fgSetWindow( parent_window );
789 fgStructure.Menu = window->ActiveMenu;
791 /* Execute the menu callback */
792 fgExecuteMenuCallback( window->ActiveMenu );
793 fgDeactivateMenu( parent_window );
795 /* Restore the current window and menu */
796 fgSetWindow( save_window );
797 fgStructure.Menu = save_menu;
801 * Outside the menu, deactivate if it's a downclick
803 * XXX This isn't enough. A downclick outside of
804 * XXX the interior of our freeglut windows should also
805 * XXX deactivate the menu. This is more complicated.
807 fgDeactivateMenu( window->ActiveMenu->ParentWindow );
810 * XXX Why does an active menu require a redisplay at
811 * XXX this point? If this can come out cleanly, then
812 * XXX it probably should do so; if not, a comment should
815 window->State.Redisplay = GL_TRUE;
820 * No active menu, let's check whether we need to activate one.
822 if( ( 0 <= button ) &&
823 ( FREEGLUT_MAX_MENUS > button ) &&
824 ( window->Menu[ button ] ) &&
828 * XXX Posting a requisite Redisplay seems bogus.
830 window->State.Redisplay = GL_TRUE;
831 fgSetWindow( window );
832 fgActivateMenu( window, button );
837 * Check if there is a mouse or mouse wheel callback hooked to the
840 if( ! FETCH_WCB( *window, Mouse ) &&
841 ! FETCH_WCB( *window, MouseWheel ) )
844 fgState.Modifiers = fgGetXModifiers( &event );
847 * Finally execute the mouse or mouse wheel callback
849 * XXX Use a symbolic constant, *not* "4"! ("3, sire!")
851 if( ( button < 3 ) || ( ! FETCH_WCB( *window, MouseWheel ) ) )
852 INVOKE_WCB( *window, Mouse, ( button,
853 pressed ? GLUT_DOWN : GLUT_UP,
860 * Map 4 and 5 to wheel zero; EVEN to +1, ODD to -1
861 * " 6 and 7 " " one; ...
863 * XXX This *should* be behind some variables/macros,
864 * XXX since the order and numbering isn't certain
865 * XXX See XFree86 configuration docs (even back in the
866 * XXX 3.x days, and especially with 4.x).
868 * XXX Note that {button} has already been decremeted
869 * XXX in mapping from X button numbering to GLUT.
871 int wheel_number = (button - 3) / 2;
877 INVOKE_WCB( *window, MouseWheel, ( wheel_number,
885 * Trash the modifiers state
887 fgState.Modifiers = 0xffffffff;
894 FGCBKeyboard keyboard_cb;
895 FGCBSpecial special_cb;
900 if( event.type == KeyPress )
902 keyboard_cb = FETCH_WCB( *window, Keyboard );
903 special_cb = FETCH_WCB( *window, Special );
907 keyboard_cb = FETCH_WCB( *window, KeyboardUp );
908 special_cb = FETCH_WCB( *window, SpecialUp );
912 * Is there a keyboard/special callback hooked for this window?
914 if( keyboard_cb || special_cb )
916 XComposeStatus composeStatus;
917 char asciiCode[ 32 ];
922 * Check for the ASCII/KeySym codes associated with the event:
924 len = XLookupString( &event.xkey, asciiCode, sizeof(asciiCode),
925 &keySym, &composeStatus
929 * GLUT API tells us to have two separate callbacks...
934 * ...one for the ASCII translateable keypresses...
938 fgSetWindow( window );
939 fgState.Modifiers = fgGetXModifiers( &event );
940 keyboard_cb( asciiCode[ 0 ],
941 event.xkey.x, event.xkey.y
943 fgState.Modifiers = 0xffffffff;
951 * ...and one for all the others, which need to be
952 * translated to GLUT_KEY_Xs...
956 case XK_F1: special = GLUT_KEY_F1; break;
957 case XK_F2: special = GLUT_KEY_F2; break;
958 case XK_F3: special = GLUT_KEY_F3; break;
959 case XK_F4: special = GLUT_KEY_F4; break;
960 case XK_F5: special = GLUT_KEY_F5; break;
961 case XK_F6: special = GLUT_KEY_F6; break;
962 case XK_F7: special = GLUT_KEY_F7; break;
963 case XK_F8: special = GLUT_KEY_F8; break;
964 case XK_F9: special = GLUT_KEY_F9; break;
965 case XK_F10: special = GLUT_KEY_F10; break;
966 case XK_F11: special = GLUT_KEY_F11; break;
967 case XK_F12: special = GLUT_KEY_F12; break;
969 case XK_Left: special = GLUT_KEY_LEFT; break;
970 case XK_Right: special = GLUT_KEY_RIGHT; break;
971 case XK_Up: special = GLUT_KEY_UP; break;
972 case XK_Down: special = GLUT_KEY_DOWN; break;
975 case XK_Prior: special = GLUT_KEY_PAGE_UP; break;
977 case XK_Next: special = GLUT_KEY_PAGE_DOWN; break;
979 case XK_Home: special = GLUT_KEY_HOME; break;
981 case XK_End: special = GLUT_KEY_END; break;
983 case XK_Insert: special = GLUT_KEY_INSERT; break;
987 * Execute the callback (if one has been specified),
988 * given that the special code seems to be valid...
990 if( special_cb && (special != -1) )
992 fgSetWindow( window );
993 fgState.Modifiers = fgGetXModifiers( &event );
994 special_cb( special, event.xkey.x, event.xkey.y );
995 fgState.Modifiers = 0xffffffff;
1002 case ReparentNotify:
1003 break; /* XXX Should disable this event */
1006 fgWarning ("Unknown X event type: %d", event.type);
1011 #elif TARGET_HOST_WIN32
1015 while( PeekMessage( &stMsg, NULL, 0, 0, PM_NOREMOVE ) )
1017 if( GetMessage( &stMsg, NULL, 0, 0 ) == 0 )
1019 if( fgState.ActionOnWindowClose == GLUT_ACTION_EXIT )
1024 fgState.ExecState = GLUT_EXEC_STATE_STOP;
1028 TranslateMessage( &stMsg );
1029 DispatchMessage( &stMsg );
1033 if( fgState.Timers.First )
1035 fghCheckJoystickPolls( );
1042 * Enters the freeglut processing loop.
1043 * Stays until the "ExecState" changes to "GLUT_EXEC_STATE_STOP".
1045 void FGAPIENTRY glutMainLoop( void )
1049 #if TARGET_HOST_WIN32
1050 SFG_Window *window = (SFG_Window *)fgStructure.Windows.First ;
1053 freeglut_assert_ready;
1055 #if TARGET_HOST_WIN32
1057 * Processing before the main loop: If there is a window which is open and
1058 * which has a visibility callback, call it. I know this is an ugly hack,
1059 * but I'm not sure what else to do about it. Ideally we should leave
1060 * something uninitialized in the create window code and initialize it in
1061 * the main loop, and have that initialization create a "WM_ACTIVATE"
1062 * message. Then we would put the visibility callback code in the
1063 * "case WM_ACTIVATE" block below. - John Fay -- 10/24/02
1067 if ( FETCH_WCB( *window, Visibility ) )
1069 SFG_Window *current_window = fgStructure.Window ;
1071 INVOKE_WCB( *window, Visibility, ( window->State.Visible ) );
1072 fgSetWindow( current_window );
1075 window = (SFG_Window *)window->Node.Next ;
1079 fgState.ExecState = GLUT_EXEC_STATE_RUNNING ;
1080 while( fgState.ExecState == GLUT_EXEC_STATE_RUNNING )
1084 glutMainLoopEvent( );
1086 * Step through the list of windows, seeing if there are any
1087 * that are not menus
1089 for( window = ( SFG_Window * )fgStructure.Windows.First;
1091 window = ( SFG_Window * )window->Node.Next )
1092 if ( ! ( window->IsMenu ) )
1096 fgState.ExecState = GLUT_EXEC_STATE_STOP;
1099 if( fgState.IdleCallback )
1100 fgState.IdleCallback( );
1102 fgSleepForEvents( );
1107 * When this loop terminates, destroy the display, state and structure
1108 * of a freeglut session, so that another glutInit() call can happen
1110 * Save the "ActionOnWindowClose" because "fgDeinitialize" resets it.
1112 action = fgState.ActionOnWindowClose;
1114 if( action == GLUT_ACTION_EXIT )
1119 * Leaves the freeglut processing loop.
1121 void FGAPIENTRY glutLeaveMainLoop( void )
1123 fgState.ExecState = GLUT_EXEC_STATE_STOP ;
1127 #if TARGET_HOST_WIN32
1129 * Determine a GLUT modifer mask based on MS-WINDOWS system info.
1131 int fgGetWin32Modifiers (void)
1134 ( ( ( GetKeyState( VK_LSHIFT ) < 0 ) ||
1135 ( GetKeyState( VK_RSHIFT ) < 0 )) ? GLUT_ACTIVE_SHIFT : 0 ) |
1136 ( ( ( GetKeyState( VK_LCONTROL ) < 0 ) ||
1137 ( GetKeyState( VK_RCONTROL ) < 0 )) ? GLUT_ACTIVE_CTRL : 0 ) |
1138 ( ( ( GetKeyState( VK_LMENU ) < 0 ) ||
1139 ( GetKeyState( VK_RMENU ) < 0 )) ? GLUT_ACTIVE_ALT : 0 );
1143 * The window procedure for handling Win32 events
1145 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam,
1148 SFG_Window* window = fgWindowByHandle( hWnd );
1152 if ( ( window == NULL ) && ( uMsg != WM_CREATE ) )
1153 return DefWindowProc( hWnd, uMsg, wParam, lParam );
1155 /* printf ( "Window %3d message <%04x> %12d %12d\n", window?window->ID:0,
1156 uMsg, wParam, lParam ); */
1161 * The window structure is passed as the creation structure paramter...
1163 window = (SFG_Window *) (((LPCREATESTRUCT) lParam)->lpCreateParams);
1164 assert( window != NULL );
1166 window->Window.Handle = hWnd;
1167 window->Window.Device = GetDC( hWnd );
1168 if( window->IsMenu )
1170 unsigned int current_DisplayMode = fgState.DisplayMode;
1171 fgState.DisplayMode = GLUT_DOUBLE | GLUT_RGB | GLUT_DEPTH;
1172 fgSetupPixelFormat( window, GL_FALSE, PFD_MAIN_PLANE );
1173 fgState.DisplayMode = current_DisplayMode;
1175 if( fgStructure.MenuContext )
1176 wglMakeCurrent( window->Window.Device,
1177 fgStructure.MenuContext->Context
1181 fgStructure.MenuContext =
1182 (SFG_MenuContext *)malloc( sizeof(SFG_MenuContext) );
1183 fgStructure.MenuContext->Context =
1184 wglCreateContext( window->Window.Device );
1187 /* window->Window.Context = wglGetCurrentContext (); */
1188 window->Window.Context = wglCreateContext( window->Window.Device );
1192 fgSetupPixelFormat( window, GL_FALSE, PFD_MAIN_PLANE );
1194 if( ! fgState.UseCurrentContext )
1195 window->Window.Context =
1196 wglCreateContext( window->Window.Device );
1199 window->Window.Context = wglGetCurrentContext( );
1200 if( ! window->Window.Context )
1201 window->Window.Context =
1202 wglCreateContext( window->Window.Device );
1206 window->State.NeedToResize = GL_TRUE;
1207 window->State.Width = fgState.Size.X;
1208 window->State.Height = fgState.Size.Y;
1210 ReleaseDC( window->Window.Handle, window->Window.Device );
1215 * If the window is visible, then it is the user manually resizing it.
1216 * If it is not, then it is the system sending us a dummy resize with
1217 * zero dimensions on a "glutIconifyWindow" call.
1219 if( window->State.Visible )
1221 window->State.NeedToResize = GL_TRUE;
1222 window->State.Width = LOWORD(lParam);
1223 window->State.Height = HIWORD(lParam);
1229 printf("WM_SETFOCUS: %p\n", window );
1230 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1234 if (LOWORD(wParam) != WA_INACTIVE)
1236 /* glutSetCursor( fgStructure.Window->State.Cursor ); */
1237 printf("WM_ACTIVATE: glutSetCursor( %p, %d)\n", window,
1238 window->State.Cursor );
1239 glutSetCursor( window->State.Cursor );
1242 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1247 * XXX Why not re-use some common code with the glutSetCursor()
1248 * XXX function (or perhaps invoke glutSetCursor())?
1249 * XXX That is, why are we duplicating code, here, from
1250 * XXX glutSetCursor()? The WIN32 code should be able to just
1251 * XXX call glutSetCurdsor() instead of defining two macros
1252 * XXX and implementing a nested case in-line.
1255 /* Set the cursor AND change it for this window class. */
1256 #define MAP_CURSOR(a,b) \
1258 SetCursor( LoadCursor( NULL, b ) ); \
1261 /* Nuke the cursor AND change it for this window class. */
1262 #define ZAP_CURSOR(a,b) \
1264 SetCursor( NULL ); \
1267 if( LOWORD( lParam ) == HTCLIENT )
1268 switch( window->State.Cursor )
1270 MAP_CURSOR( GLUT_CURSOR_RIGHT_ARROW, IDC_ARROW );
1271 MAP_CURSOR( GLUT_CURSOR_LEFT_ARROW, IDC_ARROW );
1272 MAP_CURSOR( GLUT_CURSOR_INFO, IDC_HELP );
1273 MAP_CURSOR( GLUT_CURSOR_DESTROY, IDC_CROSS );
1274 MAP_CURSOR( GLUT_CURSOR_HELP, IDC_HELP );
1275 MAP_CURSOR( GLUT_CURSOR_CYCLE, IDC_SIZEALL );
1276 MAP_CURSOR( GLUT_CURSOR_SPRAY, IDC_CROSS );
1277 MAP_CURSOR( GLUT_CURSOR_WAIT, IDC_WAIT );
1278 MAP_CURSOR( GLUT_CURSOR_TEXT, IDC_UPARROW );
1279 MAP_CURSOR( GLUT_CURSOR_CROSSHAIR, IDC_CROSS );
1280 /* MAP_CURSOR( GLUT_CURSOR_NONE, IDC_NO ); */
1281 ZAP_CURSOR( GLUT_CURSOR_NONE, NULL );
1284 MAP_CURSOR( GLUT_CURSOR_UP_DOWN, IDC_ARROW );
1287 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1291 window->State.Visible = GL_TRUE;
1292 window->State.Redisplay = GL_TRUE;
1296 /* Turn on the visibility in case it was turned off somehow */
1297 window->State.Visible = GL_TRUE;
1298 BeginPaint( hWnd, &ps );
1299 fghRedrawWindowByHandle( hWnd );
1300 EndPaint( hWnd, &ps );
1304 fgDestroyWindow ( window );
1305 if ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION )
1311 * The window already got destroyed, so don't bother with it.
1317 window->State.MouseX = LOWORD( lParam );
1318 window->State.MouseY = HIWORD( lParam );
1320 if ( window->ActiveMenu )
1322 window->State.Redisplay = GL_TRUE;
1323 fgSetWindow ( window->ActiveMenu->ParentWindow );
1327 fgState.Modifiers = fgGetWin32Modifiers( );
1329 if( ( wParam & MK_LBUTTON ) ||
1330 ( wParam & MK_MBUTTON ) ||
1331 ( wParam & MK_RBUTTON ) )
1332 INVOKE_WCB( *window, Motion, ( window->State.MouseX,
1333 window->State.MouseY ) );
1335 INVOKE_WCB( *window, Passive, ( window->State.MouseX,
1336 window->State.MouseY ) );
1338 fgState.Modifiers = 0xffffffff;
1342 case WM_LBUTTONDOWN:
1343 case WM_MBUTTONDOWN:
1344 case WM_RBUTTONDOWN:
1349 GLboolean pressed = GL_TRUE;
1352 window->State.MouseX = LOWORD( lParam );
1353 window->State.MouseY = HIWORD( lParam );
1357 case WM_LBUTTONDOWN:
1359 button = GLUT_LEFT_BUTTON;
1361 case WM_MBUTTONDOWN:
1363 button = GLUT_MIDDLE_BUTTON;
1365 case WM_RBUTTONDOWN:
1367 button = GLUT_RIGHT_BUTTON;
1371 button = GLUT_LEFT_BUTTON;
1375 button = GLUT_MIDDLE_BUTTON;
1379 button = GLUT_RIGHT_BUTTON;
1387 if( GetSystemMetrics( SM_SWAPBUTTON ) )
1389 if( button == GLUT_LEFT_BUTTON )
1390 button = GLUT_RIGHT_BUTTON;
1392 if( button == GLUT_RIGHT_BUTTON )
1393 button = GLUT_LEFT_BUTTON;
1397 return DefWindowProc( hWnd, uMsg, lParam, wParam );
1400 * XXX This comment is duplicated in two other spots.
1401 * XXX Can we centralize it?
1403 * Do not execute the application's mouse callback if a
1404 * menu is hooked to this button.
1405 * In that case an appropriate private call should be generated.
1406 * Near as I can tell, this is the menu behaviour:
1407 * - Down-click the menu button, menu not active: activate
1408 * the menu with its upper left-hand corner at the mouse location.
1409 * - Down-click any button outside the menu, menu active:
1410 * deactivate the menu
1411 * - Down-click any button inside the menu, menu active:
1412 * select the menu entry and deactivate the menu
1413 * - Up-click the menu button, menu not active: nothing happens
1414 * - Up-click the menu button outside the menu, menu active:
1416 * - Up-click the menu button inside the menu, menu active:
1417 * select the menu entry and deactivate the menu
1419 /* Window has an active menu, it absorbs any mouse click */
1420 if( window->ActiveMenu )
1422 /* Outside the menu, deactivate the menu if it's a downclick */
1423 if( ! fgCheckActiveMenu( window, window->ActiveMenu ) )
1426 fgDeactivateMenu( window->ActiveMenu->ParentWindow );
1428 else /* In menu, invoke the callback and deactivate the menu*/
1431 * Save the current window and menu and set the current
1432 * window to the window whose menu this is
1434 SFG_Window *save_window = fgStructure.Window;
1435 SFG_Menu *save_menu = fgStructure.Menu;
1436 SFG_Window *parent_window = window->ActiveMenu->ParentWindow;
1437 fgSetWindow( parent_window );
1438 fgStructure.Menu = window->ActiveMenu;
1440 /* Execute the menu callback */
1441 fgExecuteMenuCallback( window->ActiveMenu );
1442 fgDeactivateMenu( parent_window );
1444 /* Restore the current window and menu */
1445 fgSetWindow( save_window );
1446 fgStructure.Menu = save_menu;
1450 * Let's make the window redraw as a result of the mouse
1451 * click and menu activity.
1453 if( ! window->IsMenu )
1454 window->State.Redisplay = GL_TRUE;
1459 if( window->Menu[ button ] && pressed )
1461 window->State.Redisplay = GL_TRUE;
1462 fgSetWindow( window );
1463 fgActivateMenu( window, button );
1468 if( ! FETCH_WCB( *window, Mouse ) )
1471 fgSetWindow( window );
1472 fgState.Modifiers = fgGetWin32Modifiers( );
1477 pressed ? GLUT_DOWN : GLUT_UP,
1478 window->State.MouseX,
1479 window->State.MouseY
1483 fgState.Modifiers = 0xffffffff;
1488 /* Should be WM_MOUSEWHEEL but my compiler doesn't recognize it */
1491 * XXX THIS IS SPECULATIVE -- John Fay, 10/2/03
1492 * XXX Should use WHEEL_DELTA instead of 120
1494 int wheel_number = LOWORD( wParam );
1495 short ticks = ( short )HIWORD( wParam ) / 120;
1505 * The mouse cursor has moved. Remember the new mouse cursor's position
1507 /* window->State.MouseX = LOWORD( lParam ); */
1508 /* Need to adjust by window position, */
1509 /* window->State.MouseY = HIWORD( lParam ); */
1510 /* change "lParam" to other parameter */
1512 if( ! FETCH_WCB( *window, MouseWheel ) &&
1513 ! FETCH_WCB( *window, Mouse ) )
1516 fgSetWindow( window );
1517 fgState.Modifiers = fgGetWin32Modifiers( );
1520 if( FETCH_WCB( *window, MouseWheel ) )
1521 INVOKE_WCB( *window, MouseWheel,
1524 window->State.MouseX,
1525 window->State.MouseY
1528 else /* No mouse wheel, call the mouse button callback twice */
1531 * XXX The below assumes that you have no more than 3 mouse
1532 * XXX buttons. Sorry.
1534 int button = wheel_number*2 + 4;
1537 INVOKE_WCB( *window, Mouse,
1538 ( button, GLUT_DOWN,
1539 window->State.MouseX, window->State.MouseY )
1541 INVOKE_WCB( *window, Mouse,
1543 window->State.MouseX, window->State.MouseX )
1547 fgState.Modifiers = 0xffffffff;
1557 if( fgState.IgnoreKeyRepeat && (lParam & KF_REPEAT) )
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 fgState.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
1575 # define KEY(a,b) case a: keypress = b; break;
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, Keyboard,
1606 ( 127, window->State.MouseX, window->State.MouseY )
1610 if( keypress != -1 )
1611 INVOKE_WCB( *window, Special,
1613 window->State.MouseX, window->State.MouseY )
1616 fgState.Modifiers = 0xffffffff;
1627 * Remember the current modifiers state. This is done here in order
1628 * to make sure the VK_DELETE keyboard callback is executed properly.
1630 fgState.Modifiers = fgGetWin32Modifiers( );
1632 GetCursorPos( &mouse_pos );
1633 ScreenToClient( window->Window.Handle, &mouse_pos );
1635 window->State.MouseX = mouse_pos.x;
1636 window->State.MouseY = mouse_pos.y;
1639 * Convert the Win32 keystroke codes to GLUTtish way.
1640 * "KEY(a,b)" was defined under "WM_KEYDOWN"
1645 KEY( VK_F1, GLUT_KEY_F1 );
1646 KEY( VK_F2, GLUT_KEY_F2 );
1647 KEY( VK_F3, GLUT_KEY_F3 );
1648 KEY( VK_F4, GLUT_KEY_F4 );
1649 KEY( VK_F5, GLUT_KEY_F5 );
1650 KEY( VK_F6, GLUT_KEY_F6 );
1651 KEY( VK_F7, GLUT_KEY_F7 );
1652 KEY( VK_F8, GLUT_KEY_F8 );
1653 KEY( VK_F9, GLUT_KEY_F9 );
1654 KEY( VK_F10, GLUT_KEY_F10 );
1655 KEY( VK_F11, GLUT_KEY_F11 );
1656 KEY( VK_F12, GLUT_KEY_F12 );
1657 KEY( VK_PRIOR, GLUT_KEY_PAGE_UP );
1658 KEY( VK_NEXT, GLUT_KEY_PAGE_DOWN );
1659 KEY( VK_HOME, GLUT_KEY_HOME );
1660 KEY( VK_END, GLUT_KEY_END );
1661 KEY( VK_LEFT, GLUT_KEY_LEFT );
1662 KEY( VK_UP, GLUT_KEY_UP );
1663 KEY( VK_RIGHT, GLUT_KEY_RIGHT );
1664 KEY( VK_DOWN, GLUT_KEY_DOWN );
1665 KEY( VK_INSERT, GLUT_KEY_INSERT );
1669 * The delete key should be treated as an ASCII keypress:
1671 INVOKE_WCB( *window, KeyboardUp,
1672 ( 127, window->State.MouseX, window->State.MouseY )
1681 GetKeyboardState( state );
1683 if( ToAscii( wParam, 0, state, code, 0 ) == 1 )
1686 INVOKE_WCB( *window, KeyboardUp,
1688 window->State.MouseX, window->State.MouseY )
1693 if( keypress != -1 )
1694 INVOKE_WCB( *window, SpecialUp,
1696 window->State.MouseX, window->State.MouseY )
1699 fgState.Modifiers = 0xffffffff;
1706 if( fgState.IgnoreKeyRepeat && (lParam & KF_REPEAT) )
1709 fgState.Modifiers = fgGetWin32Modifiers( );
1710 INVOKE_WCB( *window, Keyboard,
1712 window->State.MouseX, window->State.MouseY )
1714 fgState.Modifiers = 0xffffffff;
1718 case WM_CAPTURECHANGED:
1719 /* User has finished resizing the window, force a redraw */
1720 INVOKE_WCB( *window, Display, ( ) );
1722 /*lRet = DefWindowProc( hWnd, uMsg, wParam, lParam ); */
1726 * Other messages that I have seen and which are not handled already
1728 case WM_SETTEXT: /* 0x000c */
1729 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1730 /* Pass it on to "DefWindowProc" to set the window text */
1733 case WM_GETTEXT: /* 0x000d */
1734 /* Ideally we would copy the title of the window into "lParam" */
1735 /* strncpy ( (char *)lParam, "Window Title", wParam );
1736 lRet = ( wParam > 12 ) ? 12 : wParam; */
1737 /* the number of characters copied */
1738 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1741 case WM_GETTEXTLENGTH: /* 0x000e */
1742 /* Ideally we would get the length of the title of the window */
1744 /* the number of characters in "Window Title\0" (see above) */
1747 case WM_ERASEBKGND: /* 0x0014 */
1748 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1751 case WM_SYNCPAINT: /* 0x0088 */
1752 /* Another window has moved, need to update this one */
1753 window->State.Redisplay = GL_TRUE;
1754 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1755 /* Help screen says this message must be passed to "DefWindowProc" */
1758 case WM_NCPAINT: /* 0x0085 */
1759 /* Need to update the border of this window */
1760 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1761 /* Pass it on to "DefWindowProc" to repaint a standard border */
1764 case WM_SYSCOMMAND : /* 0x0112 */
1767 * We have received a system command message. Try to act on it.
1768 * The commands are passed in through the "lParam" parameter:
1769 * Clicking on a corner to resize the window gives a "F004" message
1770 * but this is not defined in my header file.
1781 /* User has clicked on the "-" to minimize the window */
1782 /* Turn off the visibility */
1783 window->State.Visible = GL_FALSE ;
1790 case SC_NEXTWINDOW :
1793 case SC_PREVWINDOW :
1797 /* Followed very closely by a WM_CLOSE message */
1821 case SC_SCREENSAVE :
1829 /* We need to pass the message on to the operating system as well */
1830 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1835 * Handle unhandled messages
1837 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1845 /*** END OF FILE ***/