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 GetWindowRect( window->Window.Handle, &winRect );
97 if ( window->Parent == NULL )
100 * Adjust the size of the window to allow for the size of the
101 * frame, if we are not a menu
103 if ( ! window->IsMenu )
105 width += GetSystemMetrics( SM_CXSIZEFRAME ) * 2;
106 height += GetSystemMetrics( SM_CYSIZEFRAME ) * 2 +
107 GetSystemMetrics( SM_CYCAPTION );
112 GetWindowRect( window->Parent->Window.Handle,
114 x -= winRect.left + GetSystemMetrics( SM_CXSIZEFRAME );
115 y -= winRect.top + GetSystemMetrics( SM_CYSIZEFRAME ) +
116 GetSystemMetrics( SM_CYCAPTION );
120 window->Window.Handle,
130 * XXX Should update {window->State.OldWidth, window->State.OldHeight}
131 * XXX to keep in lockstep with UNIX_X11 code.
133 if( FETCH_WCB( *window, Reshape ) )
134 INVOKE_WCB( *window, Reshape, ( width, height ) );
137 fgSetWindow( window );
138 glViewport( 0, 0, width, height );
144 * Force a window redraw. In Windows at least this is only a partial
145 * solution: if the window is increasing in size in either dimension,
146 * the already-drawn part does not get drawn again and things look funny.
147 * But without this we get this bad behaviour whenever we resize the
150 window->State.Redisplay = GL_TRUE;
153 fgSetWindow( current_window );
157 * Calls a window's redraw method. This is used when
158 * a redraw is forced by the incoming window messages.
160 static void fghRedrawWindowByHandle ( SFG_WindowHandleType handle )
162 SFG_Window* window = fgWindowByHandle( handle );
163 freeglut_return_if_fail( window );
164 freeglut_return_if_fail( FETCH_WCB ( *window, Display ) );
166 window->State.Redisplay = GL_FALSE;
168 freeglut_return_if_fail( window->State.Visible );
170 if( window->State.NeedToResize )
172 SFG_Window *current_window = fgStructure.Window;
174 fgSetWindow( window );
176 fghReshapeWindowByHandle(
177 window->Window.Handle,
182 window->State.NeedToResize = GL_FALSE;
183 fgSetWindow ( current_window );
186 INVOKE_WCB( *window, Display, ( ) );
190 * A static helper function to execute display callback for a window
192 static void fghcbDisplayWindow( SFG_Window *window,
193 SFG_Enumerator *enumerator )
195 if( window->State.Redisplay &&
196 window->State.Visible )
199 * XXX Resizing should *not* depend upon whether there
200 * XXX is a pending redisplay flag, as far as I can tell.
202 * XXX Note, too, that the {NeedToResize} flag is a little
203 * XXX fuzzy in its meaning, since for WIN32, this also
204 * XXX means "we need to tell the application that the window has
205 * XXX changed size", while in X11, it only means "we need
206 * XXX to ask the window system to resize the window.
207 * XXX Splitting the flag's meaning might be desirable, but
208 * XXX that could complicate the code more. (On X11, the
209 * XXX user callback is called as soon as the event is
210 * XXX discovered, but resizing the window is postponed
211 * XXX until after other events.)
213 if( window->State.NeedToResize )
215 SFG_Window *current_window = fgStructure.Window;
217 fgSetWindow( window );
219 fghReshapeWindowByHandle(
220 window->Window.Handle,
225 window->State.NeedToResize = GL_FALSE;
226 fgSetWindow ( current_window );
229 window->State.Redisplay = GL_FALSE;
231 #if TARGET_HOST_UNIX_X11
233 SFG_Window *current_window = fgStructure.Window;
235 INVOKE_WCB( *window, Display, ( ) );
236 fgSetWindow( current_window );
238 #elif TARGET_HOST_WIN32
240 window->Window.Handle, NULL, NULL,
241 RDW_NOERASE | RDW_INTERNALPAINT | RDW_INVALIDATE | RDW_UPDATENOW
246 fgEnumSubWindows( window, fghcbDisplayWindow, enumerator );
250 * Make all windows perform a display call
252 static void fghDisplayAll( void )
254 SFG_Enumerator enumerator;
256 enumerator.found = GL_FALSE;
257 enumerator.data = NULL;
259 fgEnumWindows( fghcbDisplayWindow, &enumerator );
263 * Window enumerator callback to check for the joystick polling code
265 static void fghcbCheckJoystickPolls( SFG_Window *window,
266 SFG_Enumerator *enumerator )
268 long int checkTime = fgElapsedTime( );
270 if( window->State.JoystickLastPoll + window->State.JoystickPollRate <=
273 fgJoystickPollWindow( window );
274 window->State.JoystickLastPoll = checkTime;
277 fgEnumSubWindows( window, fghcbCheckJoystickPolls, enumerator );
281 * Check all windows for joystick polling
283 static void fghCheckJoystickPolls( void )
285 SFG_Enumerator enumerator;
287 enumerator.found = GL_FALSE;
288 enumerator.data = NULL;
290 fgEnumWindows( fghcbCheckJoystickPolls, &enumerator );
294 * Check the global timers
296 static void fghCheckTimers( void )
298 long checkTime = fgElapsedTime( );
301 while( timer = fgState.Timers.First )
303 if( timer->TriggerTime > checkTime )
306 fgListRemove( &fgState.Timers, &timer->Node );
307 fgListAppend( &fgState.FreeTimers, &timer->Node );
309 timer->Callback( timer->ID );
316 long fgElapsedTime( void )
318 if ( fgState.Time.Set )
320 #if TARGET_HOST_UNIX_X11
324 gettimeofday( &now, NULL );
326 elapsed = (now.tv_usec - fgState.Time.Value.tv_usec) / 1000;
327 elapsed += (now.tv_sec - fgState.Time.Value.tv_sec) * 1000;
330 #elif TARGET_HOST_WIN32
331 return timeGetTime() - fgState.Time.Value;
336 #if TARGET_HOST_UNIX_X11
337 gettimeofday( &fgState.Time.Value, NULL );
338 #elif TARGET_HOST_WIN32
339 fgState.Time.Value = timeGetTime ();
341 fgState.Time.Set = GL_TRUE ;
350 void fgError( const char *fmt, ... )
356 fprintf( stderr, "freeglut ");
357 if( fgState.ProgramName )
358 fprintf (stderr, "(%s): ", fgState.ProgramName);
359 vfprintf( stderr, fmt, ap );
360 fprintf( stderr, "\n" );
364 if ( fgState.Initialised )
370 void fgWarning( const char *fmt, ... )
376 fprintf( stderr, "freeglut ");
377 if( fgState.ProgramName )
378 fprintf( stderr, "(%s): ", fgState.ProgramName );
379 vfprintf( stderr, fmt, ap );
380 fprintf( stderr, "\n" );
386 * Indicates whether Joystick events are being used by ANY window.
388 * The current mechanism is to walk all of the windows and ask if
389 * there is a joystick callback. Certainly in some cases, maybe
390 * in all cases, the joystick is attached to the system and accessed
391 * from ONE point by GLUT/freeglut, so this is not the right way,
392 * in general, to do this. However, the Joystick code is segregated
393 * in its own little world, so we can't access the information that
394 * we need in order to do that nicely.
397 * * Store Joystick data into freeglut global state.
398 * * Provide NON-static functions or data from Joystick *.c file.
400 * Basically, the RIGHT way to do this requires knowing something
401 * about the Joystick. Right now, the Joystick code is behind
405 static void fgCheckJoystickCallback( SFG_Window* w, SFG_Enumerator* e)
407 if( FETCH_WCB( *w, Joystick ) )
412 fgEnumSubWindows( w, fgCheckJoystickCallback, e );
414 static int fgHaveJoystick( void )
416 SFG_Enumerator enumerator;
417 enumerator.found = GL_FALSE;
418 enumerator.data = NULL;
419 fgEnumWindows( fgCheckJoystickCallback, &enumerator );
420 return !!enumerator.data;
422 static void fgHavePendingRedisplaysCallback( SFG_Window* w, SFG_Enumerator* e)
424 if( w->State.Redisplay )
429 fgEnumSubWindows( w, fgHavePendingRedisplaysCallback, e );
431 static int fgHavePendingRedisplays (void)
433 SFG_Enumerator enumerator;
434 enumerator.found = GL_FALSE;
435 enumerator.data = NULL;
436 fgEnumWindows( fgHavePendingRedisplaysCallback, &enumerator );
437 return !!enumerator.data;
440 * Returns the number of GLUT ticks (milliseconds) till the next timer event.
442 static long fgNextTimer( void )
445 SFG_Timer *timer = fgState.Timers.First;
448 ret = timer->TriggerTime - fgElapsedTime();
455 * Does the magic required to relinquish the CPU until something interesting
458 static void fgSleepForEvents( void )
460 #if TARGET_HOST_UNIX_X11
467 if( fgState.IdleCallback || fgHavePendingRedisplays( ) )
469 socket = ConnectionNumber( fgDisplay.Display );
471 FD_SET( socket, &fdset );
473 msec = fgNextTimer( );
474 if( fgHaveJoystick( ) )
475 msec = MIN( msec, 10 );
477 wait.tv_sec = msec / 1000;
478 wait.tv_usec = (msec % 1000) * 1000;
479 err = select( socket+1, &fdset, NULL, NULL, &wait );
482 fgWarning ( "freeglut select() error: %d\n", errno );
484 #elif TARGET_HOST_WIN32
488 #if TARGET_HOST_UNIX_X11
490 * Returns GLUT modifier mask for an XEvent.
492 int fgGetXModifiers( XEvent *event )
496 if( event->xkey.state & ( ShiftMask | LockMask ) )
497 ret |= GLUT_ACTIVE_SHIFT;
498 if( event->xkey.state & ControlMask )
499 ret |= GLUT_ACTIVE_CTRL;
500 if( event->xkey.state & Mod1Mask )
501 ret |= GLUT_ACTIVE_ALT;
508 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
511 * Executes a single iteration in the freeglut processing loop.
513 void FGAPIENTRY glutMainLoopEvent( void )
515 #if TARGET_HOST_UNIX_X11
520 * This code was repeated constantly, so here it goes into a definition:
522 #define GETWINDOW(a) \
523 window = fgWindowByHandle( event.a.window ); \
524 if( window == NULL ) \
527 #define GETMOUSE(a) \
528 window->State.MouseX = event.a.x; \
529 window->State.MouseY = event.a.y;
531 freeglut_assert_ready;
533 while( XPending( fgDisplay.Display ) )
535 XNextEvent( fgDisplay.Display, &event );
541 * Destroy the window when the WM_DELETE_WINDOW message arrives
543 if( (Atom) event.xclient.data.l[ 0 ] == fgDisplay.DeleteWindow )
545 GETWINDOW( xclient );
547 fgDestroyWindow ( window );
549 if( fgState.ActionOnWindowClose == GLUT_ACTION_EXIT )
555 fgState.ExecState = GLUT_EXEC_STATE_STOP;
561 * CreateNotify causes a configure-event so that sub-windows are
562 * handled compatibly with GLUT. Otherwise, your sub-windows
563 * (in freeglut only) will not get an initial reshape event,
564 * which can break things.
566 * GLUT presumably does this because it generally tries to treat
567 * sub-windows the same as windows.
569 * XXX Technically, GETWINDOW( xconfigure ) and
570 * XXX {event.xconfigure} may not be legit ways to get at
571 * XXX data for CreateNotify events. In practice, the data
572 * XXX is in a union which is laid out much the same either
573 * XXX way. But if you want to split hairs, this isn't legit,
574 * XXX and we should instead duplicate some code.
577 case ConfigureNotify:
578 GETWINDOW( xconfigure );
580 int width = event.xconfigure.width;
581 int height = event.xconfigure.height;
583 if( ( width != window->State.OldWidth ) ||
584 ( height != window->State.OldHeight ) )
586 window->State.OldWidth = width;
587 window->State.OldHeight = height;
588 if( FETCH_WCB( *window, Reshape ) )
589 INVOKE_WCB( *window, Reshape, ( width, height ) );
592 fgSetWindow( window );
593 glViewport( 0, 0, width, height );
595 glutPostRedisplay( );
602 * This is sent to confirm the XDestroyWindow call.
603 * XXX WHY is this commented out? Should we re-enable it?
605 /* fgAddToWindowDestroyList ( window ); */
610 * We are too dumb to process partial exposes...
612 * XXX Well, we could do it. However, it seems to only
613 * XXX be potentially useful for single-buffered (since
614 * XXX double-buffered does not respect viewport when we
615 * XXX do a buffer-swap).
617 * XXX GETWINDOW( xexpose );
618 * XXX fgSetWindow( window );
619 * XXX glutPostRedisplay( );
621 if( event.xexpose.count == 0 )
622 fghRedrawWindowByHandle( event.xexpose.window );
628 * If we never do anything with this, can we just not ask to
629 * get these messages?
635 * Have the client's keyboard knowledge updated (xlib.ps,
636 * page 206, says that's a good thing to do)
638 XRefreshKeyboardMapping( (XMappingEvent *) &event );
641 case VisibilityNotify:
643 GETWINDOW( xvisibility );
645 * XXX INVOKE_WCB() does this check for us.
647 if( ! FETCH_WCB( *window, WindowStatus ) )
649 fgSetWindow( window );
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
657 switch( event.xvisibility.state )
659 case VisibilityUnobscured:
660 INVOKE_WCB( *window, WindowStatus, ( GLUT_FULLY_RETAINED ) );
661 window->State.Visible = GL_TRUE;
664 case VisibilityPartiallyObscured:
665 INVOKE_WCB( *window, WindowStatus,
666 ( GLUT_PARTIALLY_RETAINED ) );
667 window->State.Visible = GL_TRUE;
670 case VisibilityFullyObscured:
671 INVOKE_WCB( *window, WindowStatus, ( GLUT_FULLY_COVERED ) );
672 window->State.Visible = GL_FALSE;
676 fgWarning( "Uknown X visibility state: %d",
677 event.xvisibility.state );
685 GETWINDOW( xcrossing );
686 GETMOUSE( xcrossing );
687 INVOKE_WCB( *window, Entry, ( ( EnterNotify == event.type ) ?
694 GETWINDOW( xmotion );
697 if( window->ActiveMenu )
699 if( window == window->ActiveMenu->ParentWindow )
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;
706 window->ActiveMenu->Window->State.Redisplay = GL_TRUE ;
707 fgSetWindow( window->ActiveMenu->ParentWindow );
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
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,
724 INVOKE_WCB( *window, Passive, ( event.xmotion.x,
732 GLboolean pressed = GL_TRUE;
735 if( event.type == ButtonRelease )
739 * A mouse button has been pressed or released. Traditionally,
740 * break if the window was found within the freeglut structures.
742 GETWINDOW( xbutton );
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.
752 button = event.xbutton.button - 1;
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?
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
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:
773 * - Up-click the menu button inside the menu, menu active:
774 * select the menu entry and deactivate the menu
776 /* Window has an active menu, it absorbs any mouse click */
777 if( window->ActiveMenu )
779 if( window == window->ActiveMenu->ParentWindow )
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;
787 /* In the menu, invoke the callback and deactivate the menu*/
788 if( fgCheckActiveMenu( window->ActiveMenu->Window,
789 window->ActiveMenu ) )
792 * Save the current window and menu and set the current
793 * window to the window whose menu this is
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;
802 /* Execute the menu callback */
803 fgExecuteMenuCallback( window->ActiveMenu );
804 fgDeactivateMenu( parent_window );
806 /* Restore the current window and menu */
807 fgSetWindow( save_window );
808 fgStructure.Menu = save_menu;
812 * Outside the menu, deactivate if it's a downclick
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.
818 fgDeactivateMenu( window->ActiveMenu->ParentWindow );
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
826 window->State.Redisplay = GL_TRUE;
831 * No active menu, let's check whether we need to activate one.
833 if( ( 0 <= button ) &&
834 ( FREEGLUT_MAX_MENUS > button ) &&
835 ( window->Menu[ button ] ) &&
839 * XXX Posting a requisite Redisplay seems bogus.
841 window->State.Redisplay = GL_TRUE;
842 fgSetWindow( window );
843 fgActivateMenu( window, button );
848 * Check if there is a mouse or mouse wheel callback hooked to the
851 if( ! FETCH_WCB( *window, Mouse ) &&
852 ! FETCH_WCB( *window, MouseWheel ) )
855 fgState.Modifiers = fgGetXModifiers( &event );
858 * Finally execute the mouse or mouse wheel callback
860 * XXX Use a symbolic constant, *not* "4"! ("3, sire!")
862 if( ( button < 3 ) || ( ! FETCH_WCB( *window, MouseWheel ) ) )
863 INVOKE_WCB( *window, Mouse, ( button,
864 pressed ? GLUT_DOWN : GLUT_UP,
871 * Map 4 and 5 to wheel zero; EVEN to +1, ODD to -1
872 * " 6 and 7 " " one; ...
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).
879 * XXX Note that {button} has already been decremeted
880 * XXX in mapping from X button numbering to GLUT.
882 int wheel_number = (button - 3) / 2;
888 INVOKE_WCB( *window, MouseWheel, ( wheel_number,
896 * Trash the modifiers state
898 fgState.Modifiers = 0xffffffff;
905 FGCBKeyboard keyboard_cb;
906 FGCBSpecial special_cb;
911 if( event.type == KeyPress )
913 keyboard_cb = FETCH_WCB( *window, Keyboard );
914 special_cb = FETCH_WCB( *window, Special );
918 keyboard_cb = FETCH_WCB( *window, KeyboardUp );
919 special_cb = FETCH_WCB( *window, SpecialUp );
923 * Is there a keyboard/special callback hooked for this window?
925 if( keyboard_cb || special_cb )
927 XComposeStatus composeStatus;
928 char asciiCode[ 32 ];
933 * Check for the ASCII/KeySym codes associated with the event:
935 len = XLookupString( &event.xkey, asciiCode, sizeof(asciiCode),
936 &keySym, &composeStatus
940 * GLUT API tells us to have two separate callbacks...
945 * ...one for the ASCII translateable keypresses...
949 fgSetWindow( window );
950 fgState.Modifiers = fgGetXModifiers( &event );
951 keyboard_cb( asciiCode[ 0 ],
952 event.xkey.x, event.xkey.y
954 fgState.Modifiers = 0xffffffff;
962 * ...and one for all the others, which need to be
963 * translated to GLUT_KEY_Xs...
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;
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;
986 case XK_Prior: special = GLUT_KEY_PAGE_UP; break;
988 case XK_Next: special = GLUT_KEY_PAGE_DOWN; break;
990 case XK_Home: special = GLUT_KEY_HOME; break;
992 case XK_End: special = GLUT_KEY_END; break;
994 case XK_Insert: special = GLUT_KEY_INSERT; break;
998 * Execute the callback (if one has been specified),
999 * given that the special code seems to be valid...
1001 if( special_cb && (special != -1) )
1003 fgSetWindow( window );
1004 fgState.Modifiers = fgGetXModifiers( &event );
1005 special_cb( special, event.xkey.x, event.xkey.y );
1006 fgState.Modifiers = 0xffffffff;
1013 case ReparentNotify:
1014 break; /* XXX Should disable this event */
1017 fgWarning ("Unknown X event type: %d", event.type);
1022 #elif TARGET_HOST_WIN32
1026 while( PeekMessage( &stMsg, NULL, 0, 0, PM_NOREMOVE ) )
1028 if( GetMessage( &stMsg, NULL, 0, 0 ) == 0 )
1030 if( fgState.ActionOnWindowClose == GLUT_ACTION_EXIT )
1035 fgState.ExecState = GLUT_EXEC_STATE_STOP;
1039 TranslateMessage( &stMsg );
1040 DispatchMessage( &stMsg );
1044 if( fgState.Timers.First )
1046 fghCheckJoystickPolls( );
1053 * Enters the freeglut processing loop.
1054 * Stays until the "ExecState" changes to "GLUT_EXEC_STATE_STOP".
1056 void FGAPIENTRY glutMainLoop( void )
1058 #if TARGET_HOST_WIN32
1059 SFG_Window *window = (SFG_Window *)fgStructure.Windows.First ;
1062 freeglut_assert_ready;
1064 #if TARGET_HOST_WIN32
1066 * Processing before the main loop: If there is a window which is open and
1067 * which has a visibility callback, call it. I know this is an ugly hack,
1068 * but I'm not sure what else to do about it. Ideally we should leave
1069 * something uninitialized in the create window code and initialize it in
1070 * the main loop, and have that initialization create a "WM_ACTIVATE"
1071 * message. Then we would put the visibility callback code in the
1072 * "case WM_ACTIVATE" block below. - John Fay -- 10/24/02
1076 if ( FETCH_WCB( *window, Visibility ) )
1078 SFG_Window *current_window = fgStructure.Window ;
1080 INVOKE_WCB( *window, Visibility, ( window->State.Visible ) );
1081 fgSetWindow( current_window );
1084 window = (SFG_Window *)window->Node.Next ;
1088 fgState.ExecState = GLUT_EXEC_STATE_RUNNING ;
1089 while( fgState.ExecState == GLUT_EXEC_STATE_RUNNING )
1093 glutMainLoopEvent( );
1095 * Step through the list of windows, seeing if there are any
1096 * that are not menus
1098 for( window = ( SFG_Window * )fgStructure.Windows.First;
1100 window = ( SFG_Window * )window->Node.Next )
1101 if ( ! ( window->IsMenu ) )
1105 fgState.ExecState = GLUT_EXEC_STATE_STOP;
1108 if( fgState.IdleCallback )
1109 fgState.IdleCallback( );
1111 fgSleepForEvents( );
1116 * When this loop terminates, destroy the display, state and structure
1117 * of a freeglut session, so that another glutInit() call can happen
1120 if( fgState.ActionOnWindowClose == GLUT_ACTION_EXIT )
1125 * Leaves the freeglut processing loop.
1127 void FGAPIENTRY glutLeaveMainLoop( void )
1129 fgState.ExecState = GLUT_EXEC_STATE_STOP ;
1133 #if TARGET_HOST_WIN32
1135 * Determine a GLUT modifer mask based on MS-WINDOWS system info.
1137 int fgGetWin32Modifiers (void)
1140 ( ( ( GetKeyState( VK_LSHIFT ) < 0 ) ||
1141 ( GetKeyState( VK_RSHIFT ) < 0 )) ? GLUT_ACTIVE_SHIFT : 0 ) |
1142 ( ( ( GetKeyState( VK_LCONTROL ) < 0 ) ||
1143 ( GetKeyState( VK_RCONTROL ) < 0 )) ? GLUT_ACTIVE_CTRL : 0 ) |
1144 ( ( ( GetKeyState( VK_LMENU ) < 0 ) ||
1145 ( GetKeyState( VK_RMENU ) < 0 )) ? GLUT_ACTIVE_ALT : 0 );
1149 * The window procedure for handling Win32 events
1151 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam,
1154 SFG_Window* window = fgWindowByHandle( hWnd );
1158 if ( ( window == NULL ) && ( uMsg != WM_CREATE ) )
1159 return DefWindowProc( hWnd, uMsg, wParam, lParam );
1161 /* printf ( "Window %3d message <%04x> %12d %12d\n", window?window->ID:0,
1162 uMsg, wParam, lParam ); */
1167 * The window structure is passed as the creation structure paramter...
1169 window = (SFG_Window *) (((LPCREATESTRUCT) lParam)->lpCreateParams);
1170 assert( window != NULL );
1172 window->Window.Handle = hWnd;
1173 window->Window.Device = GetDC( hWnd );
1174 if( window->IsMenu )
1176 unsigned int current_DisplayMode = fgState.DisplayMode;
1177 fgState.DisplayMode = GLUT_DOUBLE | GLUT_RGB | GLUT_DEPTH;
1178 fgSetupPixelFormat( window, GL_FALSE, PFD_MAIN_PLANE );
1179 fgState.DisplayMode = current_DisplayMode;
1181 if( fgStructure.MenuContext )
1182 wglMakeCurrent( window->Window.Device,
1183 fgStructure.MenuContext->Context
1187 fgStructure.MenuContext =
1188 (SFG_MenuContext *)malloc( sizeof(SFG_MenuContext) );
1189 fgStructure.MenuContext->Context =
1190 wglCreateContext( window->Window.Device );
1193 /* window->Window.Context = wglGetCurrentContext (); */
1194 window->Window.Context = wglCreateContext( window->Window.Device );
1198 fgSetupPixelFormat( window, GL_FALSE, PFD_MAIN_PLANE );
1200 if( ! fgState.UseCurrentContext )
1201 window->Window.Context =
1202 wglCreateContext( window->Window.Device );
1205 window->Window.Context = wglGetCurrentContext( );
1206 if( ! window->Window.Context )
1207 window->Window.Context =
1208 wglCreateContext( window->Window.Device );
1212 window->State.NeedToResize = GL_TRUE;
1213 window->State.Width = fgState.Size.X;
1214 window->State.Height = fgState.Size.Y;
1216 ReleaseDC( window->Window.Handle, window->Window.Device );
1221 * We got resized... But check if the window has been already added...
1223 window->State.NeedToResize = GL_TRUE;
1224 window->State.Width = LOWORD(lParam);
1225 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 ) )
1388 if( button == GLUT_LEFT_BUTTON )
1389 button = GLUT_RIGHT_BUTTON;
1390 else if( button == GLUT_RIGHT_BUTTON )
1391 button = GLUT_LEFT_BUTTON;
1394 return DefWindowProc( hWnd, uMsg, lParam, wParam );
1397 * XXX This comment is duplicated in two other spots.
1398 * XXX Can we centralize it?
1400 * Do not execute the application's mouse callback if a
1401 * menu is hooked to this button.
1402 * In that case an appropriate private call should be generated.
1403 * Near as I can tell, this is the menu behaviour:
1404 * - Down-click the menu button, menu not active: activate
1405 * the menu with its upper left-hand corner at the mouse location.
1406 * - Down-click any button outside the menu, menu active:
1407 * deactivate the menu
1408 * - Down-click any button inside the menu, menu active:
1409 * select the menu entry and deactivate the menu
1410 * - Up-click the menu button, menu not active: nothing happens
1411 * - Up-click the menu button outside the menu, menu active:
1413 * - Up-click the menu button inside the menu, menu active:
1414 * select the menu entry and deactivate the menu
1416 /* Window has an active menu, it absorbs any mouse click */
1417 if( window->ActiveMenu )
1419 /* Outside the menu, deactivate the menu if it's a downclick */
1420 if( ! fgCheckActiveMenu( window, window->ActiveMenu ) )
1423 fgDeactivateMenu( window->ActiveMenu->ParentWindow );
1425 else /* In menu, invoke the callback and deactivate the menu*/
1428 * Save the current window and menu and set the current
1429 * window to the window whose menu this is
1431 SFG_Window *save_window = fgStructure.Window;
1432 SFG_Menu *save_menu = fgStructure.Menu;
1433 SFG_Window *parent_window = window->ActiveMenu->ParentWindow;
1434 fgSetWindow( parent_window );
1435 fgStructure.Menu = window->ActiveMenu;
1437 /* Execute the menu callback */
1438 fgExecuteMenuCallback( window->ActiveMenu );
1439 fgDeactivateMenu( parent_window );
1441 /* Restore the current window and menu */
1442 fgSetWindow( save_window );
1443 fgStructure.Menu = save_menu;
1447 * Let's make the window redraw as a result of the mouse
1448 * click and menu activity.
1450 if( ! window->IsMenu )
1451 window->State.Redisplay = GL_TRUE;
1456 if( window->Menu[ button ] && pressed )
1458 window->State.Redisplay = GL_TRUE;
1459 fgSetWindow( window );
1460 fgActivateMenu( window, button );
1465 if( ! FETCH_WCB( *window, Mouse ) )
1468 fgSetWindow( window );
1469 fgState.Modifiers = fgGetWin32Modifiers( );
1474 pressed ? GLUT_DOWN : GLUT_UP,
1475 window->State.MouseX,
1476 window->State.MouseY
1480 fgState.Modifiers = 0xffffffff;
1485 /* Should be WM_MOUSEWHEEL but my compiler doesn't recognize it */
1488 * XXX THIS IS SPECULATIVE -- John Fay, 10/2/03
1489 * XXX Should use WHEEL_DELTA instead of 120
1491 int wheel_number = LOWORD( wParam );
1492 short ticks = ( short )HIWORD( wParam ) / 120;
1502 * The mouse cursor has moved. Remember the new mouse cursor's position
1504 /* window->State.MouseX = LOWORD( lParam ); */
1505 /* Need to adjust by window position, */
1506 /* window->State.MouseY = HIWORD( lParam ); */
1507 /* change "lParam" to other parameter */
1509 if( ! FETCH_WCB( *window, MouseWheel ) &&
1510 ! FETCH_WCB( *window, Mouse ) )
1513 fgSetWindow( window );
1514 fgState.Modifiers = fgGetWin32Modifiers( );
1517 if( FETCH_WCB( *window, MouseWheel ) )
1518 INVOKE_WCB( *window, MouseWheel,
1521 window->State.MouseX,
1522 window->State.MouseY
1525 else /* No mouse wheel, call the mouse button callback twice */
1528 * XXX The below assumes that you have no more than 3 mouse
1529 * XXX buttons. Sorry.
1531 int button = wheel_number*2 + 4;
1534 INVOKE_WCB( *window, Mouse,
1535 ( button, GLUT_DOWN,
1536 window->State.MouseX, window->State.MouseY )
1538 INVOKE_WCB( *window, Mouse,
1540 window->State.MouseX, window->State.MouseX )
1544 fgState.Modifiers = 0xffffffff;
1554 if( fgState.IgnoreKeyRepeat && (lParam & KF_REPEAT) )
1558 * Remember the current modifiers state. This is done here in order
1559 * to make sure the VK_DELETE keyboard callback is executed properly.
1561 fgState.Modifiers = fgGetWin32Modifiers( );
1563 GetCursorPos( &mouse_pos );
1564 ScreenToClient( window->Window.Handle, &mouse_pos );
1566 window->State.MouseX = mouse_pos.x;
1567 window->State.MouseY = mouse_pos.y;
1570 * Convert the Win32 keystroke codes to GLUTtish way
1572 # define KEY(a,b) case a: keypress = b; break;
1576 KEY( VK_F1, GLUT_KEY_F1 );
1577 KEY( VK_F2, GLUT_KEY_F2 );
1578 KEY( VK_F3, GLUT_KEY_F3 );
1579 KEY( VK_F4, GLUT_KEY_F4 );
1580 KEY( VK_F5, GLUT_KEY_F5 );
1581 KEY( VK_F6, GLUT_KEY_F6 );
1582 KEY( VK_F7, GLUT_KEY_F7 );
1583 KEY( VK_F8, GLUT_KEY_F8 );
1584 KEY( VK_F9, GLUT_KEY_F9 );
1585 KEY( VK_F10, GLUT_KEY_F10 );
1586 KEY( VK_F11, GLUT_KEY_F11 );
1587 KEY( VK_F12, GLUT_KEY_F12 );
1588 KEY( VK_PRIOR, GLUT_KEY_PAGE_UP );
1589 KEY( VK_NEXT, GLUT_KEY_PAGE_DOWN );
1590 KEY( VK_HOME, GLUT_KEY_HOME );
1591 KEY( VK_END, GLUT_KEY_END );
1592 KEY( VK_LEFT, GLUT_KEY_LEFT );
1593 KEY( VK_UP, GLUT_KEY_UP );
1594 KEY( VK_RIGHT, GLUT_KEY_RIGHT );
1595 KEY( VK_DOWN, GLUT_KEY_DOWN );
1596 KEY( VK_INSERT, GLUT_KEY_INSERT );
1600 * The delete key should be treated as an ASCII keypress:
1602 INVOKE_WCB( *window, Keyboard,
1603 ( 127, window->State.MouseX, window->State.MouseY )
1607 if( keypress != -1 )
1608 INVOKE_WCB( *window, Special,
1610 window->State.MouseX, window->State.MouseY )
1613 fgState.Modifiers = 0xffffffff;
1624 * Remember the current modifiers state. This is done here in order
1625 * to make sure the VK_DELETE keyboard callback is executed properly.
1627 fgState.Modifiers = fgGetWin32Modifiers( );
1629 GetCursorPos( &mouse_pos );
1630 ScreenToClient( window->Window.Handle, &mouse_pos );
1632 window->State.MouseX = mouse_pos.x;
1633 window->State.MouseY = mouse_pos.y;
1636 * Convert the Win32 keystroke codes to GLUTtish way.
1637 * "KEY(a,b)" was defined under "WM_KEYDOWN"
1642 KEY( VK_F1, GLUT_KEY_F1 );
1643 KEY( VK_F2, GLUT_KEY_F2 );
1644 KEY( VK_F3, GLUT_KEY_F3 );
1645 KEY( VK_F4, GLUT_KEY_F4 );
1646 KEY( VK_F5, GLUT_KEY_F5 );
1647 KEY( VK_F6, GLUT_KEY_F6 );
1648 KEY( VK_F7, GLUT_KEY_F7 );
1649 KEY( VK_F8, GLUT_KEY_F8 );
1650 KEY( VK_F9, GLUT_KEY_F9 );
1651 KEY( VK_F10, GLUT_KEY_F10 );
1652 KEY( VK_F11, GLUT_KEY_F11 );
1653 KEY( VK_F12, GLUT_KEY_F12 );
1654 KEY( VK_PRIOR, GLUT_KEY_PAGE_UP );
1655 KEY( VK_NEXT, GLUT_KEY_PAGE_DOWN );
1656 KEY( VK_HOME, GLUT_KEY_HOME );
1657 KEY( VK_END, GLUT_KEY_END );
1658 KEY( VK_LEFT, GLUT_KEY_LEFT );
1659 KEY( VK_UP, GLUT_KEY_UP );
1660 KEY( VK_RIGHT, GLUT_KEY_RIGHT );
1661 KEY( VK_DOWN, GLUT_KEY_DOWN );
1662 KEY( VK_INSERT, GLUT_KEY_INSERT );
1666 * The delete key should be treated as an ASCII keypress:
1668 INVOKE_WCB( *window, KeyboardUp,
1669 ( 127, window->State.MouseX, window->State.MouseY )
1678 GetKeyboardState( state );
1680 if( ToAscii( wParam, 0, state, code, 0 ) == 1 )
1683 INVOKE_WCB( *window, KeyboardUp,
1685 window->State.MouseX, window->State.MouseY )
1690 if( keypress != -1 )
1691 INVOKE_WCB( *window, SpecialUp,
1693 window->State.MouseX, window->State.MouseY )
1696 fgState.Modifiers = 0xffffffff;
1703 if( fgState.IgnoreKeyRepeat && (lParam & KF_REPEAT) )
1706 fgState.Modifiers = fgGetWin32Modifiers( );
1707 INVOKE_WCB( *window, Keyboard,
1709 window->State.MouseX, window->State.MouseY )
1711 fgState.Modifiers = 0xffffffff;
1715 case WM_CAPTURECHANGED:
1716 /* User has finished resizing the window, force a redraw */
1717 INVOKE_WCB( *window, Display, ( ) );
1719 /*lRet = DefWindowProc( hWnd, uMsg, wParam, lParam ); */
1723 * Other messages that I have seen and which are not handled already
1725 case WM_SETTEXT: /* 0x000c */
1726 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1727 /* Pass it on to "DefWindowProc" to set the window text */
1730 case WM_GETTEXT: /* 0x000d */
1731 /* Ideally we would copy the title of the window into "lParam" */
1732 /* strncpy ( (char *)lParam, "Window Title", wParam );
1733 lRet = ( wParam > 12 ) ? 12 : wParam; */
1734 /* the number of characters copied */
1735 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1738 case WM_GETTEXTLENGTH: /* 0x000e */
1739 /* Ideally we would get the length of the title of the window */
1741 /* the number of characters in "Window Title\0" (see above) */
1744 case WM_ERASEBKGND: /* 0x0014 */
1745 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1748 case WM_SYNCPAINT: /* 0x0088 */
1749 /* Another window has moved, need to update this one */
1750 window->State.Redisplay = GL_TRUE;
1751 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1752 /* Help screen says this message must be passed to "DefWindowProc" */
1755 case WM_NCPAINT: /* 0x0085 */
1756 /* Need to update the border of this window */
1757 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1758 /* Pass it on to "DefWindowProc" to repaint a standard border */
1761 case WM_SYSCOMMAND : /* 0x0112 */
1764 * We have received a system command message. Try to act on it.
1765 * The commands are passed in through the "lParam" parameter:
1766 * Clicking on a corner to resize the window gives a "F004" message
1767 * but this is not defined in my header file.
1778 /* User has clicked on the "-" to minimize the window */
1779 /* Turn off the visibility */
1780 window->State.Visible = GL_FALSE ;
1787 case SC_NEXTWINDOW :
1790 case SC_PREVWINDOW :
1794 /* Followed very closely by a WM_CLOSE message */
1818 case SC_SCREENSAVE :
1826 /* We need to pass the message on to the operating system as well */
1827 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1832 * Handle unhandled messages
1834 lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
1842 /*** END OF FILE ***/