Fixing a 'gamemode at_exit' bug courtesy of Diederick Niehorster per e-mail dated...
[freeglut] / src / freeglut_internal.h
1 /*
2  * freeglut_internal.h
3  *
4  * The freeglut library private include file.
5  *
6  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
7  * Written by Pawel W. Olszta, <olszta@sourceforge.net>
8  * Creation date: Thu Dec 2 1999
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining a
11  * copy of this software and associated documentation files (the "Software"),
12  * to deal in the Software without restriction, including without limitation
13  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
14  * and/or sell copies of the Software, and to permit persons to whom the
15  * Software is furnished to do so, subject to the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be included
18  * in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
23  * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
24  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
25  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26  */
27
28 #ifndef  FREEGLUT_INTERNAL_H
29 #define  FREEGLUT_INTERNAL_H
30
31 #ifdef HAVE_CONFIG_H
32 #    include "config.h"
33 #endif
34
35 /* XXX Update these for each release! */
36 #define  VERSION_MAJOR 2
37 #define  VERSION_MINOR 7
38 #define  VERSION_PATCH 0
39
40 /* Freeglut is intended to function under all Unix/X11 and Win32 platforms. */
41 /* XXX: Don't all MS-Windows compilers (except Cygwin) have _WIN32 defined?
42  * XXX: If so, remove the first set of defined()'s below.
43  */
44 #if !defined(TARGET_HOST_POSIX_X11) && !defined(TARGET_HOST_MS_WINDOWS) && !defined(TARGET_HOST_MAC_OSX) && !defined(TARGET_HOST_SOLARIS)
45 #if defined(_MSC_VER) || defined(__WATCOMC__) || defined(__MINGW32__) \
46     || defined(_WIN32) || defined(_WIN32_WCE) \
47     || ( defined(__CYGWIN__) && defined(X_DISPLAY_MISSING) )
48 #   define  TARGET_HOST_MS_WINDOWS 1
49
50 #elif defined(__posix__) || defined(__unix__) || defined(__linux__) || defined(__sun)
51 #   define  TARGET_HOST_POSIX_X11  1
52
53 #elif defined(__APPLE__)
54 /* This is a placeholder until we get native OSX support ironed out -- JFF 11/18/09 */
55 #   define  TARGET_HOST_POSIX_X11  1
56 /* #   define  TARGET_HOST_MAC_OSX    1 */
57
58 #else
59 #   error "Unrecognized target host!"
60
61 #endif
62 #endif
63
64 /* Detect both SunPro and gcc compilers on Sun Solaris */
65 #if defined (__SVR4) && defined (__sun)
66 #   define TARGET_HOST_SOLARIS 1
67 #endif
68
69 #ifndef TARGET_HOST_MS_WINDOWS
70 #   define  TARGET_HOST_MS_WINDOWS 0
71 #endif
72
73 #ifndef  TARGET_HOST_POSIX_X11
74 #   define  TARGET_HOST_POSIX_X11  0
75 #endif
76
77 #ifndef  TARGET_HOST_MAC_OSX
78 #   define  TARGET_HOST_MAC_OSX    0
79 #endif
80
81 #ifndef  TARGET_HOST_SOLARIS
82 #   define  TARGET_HOST_SOLARIS    0
83 #endif
84
85 /* -- FIXED CONFIGURATION LIMITS ------------------------------------------- */
86
87 #define  FREEGLUT_MAX_MENUS         3
88
89 /* -- PLATFORM-SPECIFIC INCLUDES ------------------------------------------- */
90
91 /* All Win32 headers depend on the huge windows.h recursive include.
92  * Note: Lower-case header names are used, for best cross-platform
93  * compatibility.
94  */
95 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE)
96 #    include <windows.h>
97 #    include <windowsx.h>
98 #    include <mmsystem.h>
99 /* CYGWIN does not have tchar.h, but has TEXT(x), defined in winnt.h. */
100 #    ifndef __CYGWIN__
101 #      include <tchar.h>
102 #    else
103 #      define _TEXT(x) TEXT(x)
104 #      define _T(x)    TEXT(x)
105 #    endif
106
107 #elif TARGET_HOST_POSIX_X11
108 #    include <GL/glx.h>
109 #    include <X11/Xlib.h>
110 #    include <X11/Xatom.h>
111 #    include <X11/keysym.h>
112 #    include <X11/extensions/XInput.h>
113 #    ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
114 #        include <X11/extensions/xf86vmode.h>
115 #    endif
116 #    ifdef HAVE_X11_EXTENSIONS_XRANDR_H
117 #        include <X11/extensions/Xrandr.h>
118 #    endif
119 /* If GLX is too old, we will fail during runtime when multisampling
120    is requested, but at least freeglut compiles. */
121 #    ifndef GLX_SAMPLE_BUFFERS
122 #        define GLX_SAMPLE_BUFFERS 0x80A8
123 #    endif
124 #    ifndef GLX_SAMPLES
125 #        define GLX_SAMPLES 0x80A9
126 #    endif
127
128 #endif
129
130 /* These files should be available on every platform. */
131 #include <stdio.h>
132 #include <string.h>
133 #include <math.h>
134 #include <stdlib.h>
135 #include <stdarg.h>
136
137 /* These are included based on autoconf directives. */
138 #ifdef HAVE_SYS_TYPES_H
139 #    include <sys/types.h>
140 #endif
141 #ifdef HAVE_UNISTD_H
142 #    include <unistd.h>
143 #endif
144 #ifdef TIME_WITH_SYS_TIME
145 #    include <sys/time.h>
146 #    include <time.h>
147 #elif defined(HAVE_SYS_TIME_H)
148 #    include <sys/time.h>
149 #else
150 #    include <time.h>
151 #endif
152
153 /* -- AUTOCONF HACKS --------------------------------------------------------*/
154
155 /* XXX: Update autoconf to avoid these.
156  * XXX: Are non-POSIX platforms intended not to use autoconf?
157  * If so, perhaps there should be a config_guess.h for them. Alternatively,
158  * config guesses could be placed above, just after the config.h exclusion.
159  */
160 #if defined(__FreeBSD__) || defined(__NetBSD__)
161 #    define HAVE_USB_JS 1
162 #    if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
163 #        define HAVE_USBHID_H 1
164 #    endif
165 #endif
166
167 #if TARGET_HOST_MS_WINDOWS
168 #    define  HAVE_VFPRINTF 1
169 #endif
170
171 /* MinGW may lack a prototype for ChangeDisplaySettingsEx() (depending on the version?) */
172 #if TARGET_HOST_MS_WINDOWS && !defined(ChangeDisplaySettingsEx)
173 LONG WINAPI ChangeDisplaySettingsExA(LPCSTR,LPDEVMODEA,HWND,DWORD,LPVOID);
174 LONG WINAPI ChangeDisplaySettingsExW(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
175 #    ifdef UNICODE
176 #        define ChangeDisplaySettingsEx ChangeDisplaySettingsExW
177 #    else
178 #        define ChangeDisplaySettingsEx ChangeDisplaySettingsExA
179 #    endif
180 #endif
181
182 #if defined(_MSC_VER) || defined(__WATCOMC__)
183 /* strdup() is non-standard, for all but POSIX-2001 */
184 #define strdup   _strdup
185 #endif
186
187 /* M_PI is non-standard (defined by BSD, not ISO-C) */
188 #ifndef M_PI
189 #    define  M_PI  3.14159265358979323846
190 #endif
191
192 #ifdef HAVE_STDBOOL_H
193 #    include <stdbool.h>
194 #    ifndef TRUE
195 #        define TRUE true
196 #    endif
197 #    ifndef FALSE
198 #        define FALSE false
199 #    endif
200 #else
201 #    ifndef TRUE
202 #        define  TRUE  1
203 #    endif
204 #    ifndef FALSE
205 #        define  FALSE  0
206 #    endif
207 #endif
208
209 /* General defines */
210
211 #define INVALID_MODIFIERS 0xffffffff
212
213 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
214
215 /* Freeglut callbacks type definitions */
216 typedef void (* FGCBDisplay       )( void );
217 typedef void (* FGCBReshape       )( int, int );
218 typedef void (* FGCBVisibility    )( int );
219 typedef void (* FGCBKeyboard      )( unsigned char, int, int );
220 typedef void (* FGCBSpecial       )( int, int, int );
221 typedef void (* FGCBMouse         )( int, int, int, int );
222 typedef void (* FGCBMouseWheel    )( int, int, int, int );
223 typedef void (* FGCBMotion        )( int, int );
224 typedef void (* FGCBPassive       )( int, int );
225 typedef void (* FGCBEntry         )( int );
226 typedef void (* FGCBWindowStatus  )( int );
227 typedef void (* FGCBSelect        )( int, int, int );
228 typedef void (* FGCBJoystick      )( unsigned int, int, int, int );
229 typedef void (* FGCBKeyboardUp    )( unsigned char, int, int );
230 typedef void (* FGCBSpecialUp     )( int, int, int );
231 typedef void (* FGCBOverlayDisplay)( void );
232 typedef void (* FGCBSpaceMotion   )( int, int, int );
233 typedef void (* FGCBSpaceRotation )( int, int, int );
234 typedef void (* FGCBSpaceButton   )( int, int );
235 typedef void (* FGCBDials         )( int, int );
236 typedef void (* FGCBButtonBox     )( int, int );
237 typedef void (* FGCBTabletMotion  )( int, int );
238 typedef void (* FGCBTabletButton  )( int, int, int, int );
239 typedef void (* FGCBDestroy       )( void );
240
241 typedef void (* FGCBMultiEntry   )( int, int );
242 typedef void (* FGCBMultiButton  )( int, int, int, int, int );
243 typedef void (* FGCBMultiMotion  )( int, int, int );
244 typedef void (* FGCBMultiPassive )( int, int, int );
245
246 /* The global callbacks type definitions */
247 typedef void (* FGCBIdle          )( void );
248 typedef void (* FGCBTimer         )( int );
249 typedef void (* FGCBMenuState     )( int );
250 typedef void (* FGCBMenuStatus    )( int, int, int );
251
252 /* The callback used when creating/using menus */
253 typedef void (* FGCBMenu          )( int );
254
255 /* The FreeGLUT error/warning handler type definition */
256 typedef void (* FGError           ) ( const char *fmt, va_list ap);
257 typedef void (* FGWarning         ) ( const char *fmt, va_list ap);
258
259
260 /* A list structure */
261 typedef struct tagSFG_List SFG_List;
262 struct tagSFG_List
263 {
264     void *First;
265     void *Last;
266 };
267
268 /* A list node structure */
269 typedef struct tagSFG_Node SFG_Node;
270 struct tagSFG_Node
271 {
272     void *Next;
273     void *Prev;
274 };
275
276 /* A helper structure holding two ints and a boolean */
277 typedef struct tagSFG_XYUse SFG_XYUse;
278 struct tagSFG_XYUse
279 {
280     GLint           X, Y;               /* The two integers...               */
281     GLboolean       Use;                /* ...and a single boolean.          */
282 };
283
284 /*
285  * An enumeration containing the state of the GLUT execution:
286  * initializing, running, or stopping
287  */
288 typedef enum
289 {
290   GLUT_EXEC_STATE_INIT,
291   GLUT_EXEC_STATE_RUNNING,
292   GLUT_EXEC_STATE_STOP
293 } fgExecutionState ;
294
295 /* This structure holds different freeglut settings */
296 typedef struct tagSFG_State SFG_State;
297 struct tagSFG_State
298 {
299     SFG_XYUse        Position;             /* The default windows' position  */
300     SFG_XYUse        Size;                 /* The default windows' size      */
301     unsigned int     DisplayMode;          /* Display mode for new windows   */
302
303     GLboolean        Initialised;          /* freeglut has been initialised  */
304
305     int              DirectContext;        /* Direct rendering state         */
306
307     GLboolean        ForceIconic;          /* New top windows are iconified  */
308     GLboolean        UseCurrentContext;    /* New windows share with current */
309
310     GLboolean        GLDebugSwitch;        /* OpenGL state debugging switch  */
311     GLboolean        XSyncSwitch;          /* X11 sync protocol switch       */
312
313     int              KeyRepeat;            /* Global key repeat mode.        */
314     int              Modifiers;            /* Current ALT/SHIFT/CTRL state   */
315
316     GLuint           FPSInterval;          /* Interval between FPS printfs   */
317     GLuint           SwapCount;            /* Count of glutSwapBuffer calls  */
318     GLuint           SwapTime;             /* Time of last SwapBuffers       */
319
320     unsigned long    Time;                 /* Time that glutInit was called  */
321     SFG_List         Timers;               /* The freeglut timer hooks       */
322     SFG_List         FreeTimers;           /* The unused timer hooks         */
323
324     FGCBIdle         IdleCallback;         /* The global idle callback       */
325
326     int              ActiveMenus;          /* Num. of currently active menus */
327     FGCBMenuState    MenuStateCallback;    /* Menu callbacks are global      */
328     FGCBMenuStatus   MenuStatusCallback;
329
330     SFG_XYUse        GameModeSize;         /* Game mode screen's dimensions  */
331     int              GameModeDepth;        /* The pixel depth for game mode  */
332     int              GameModeRefresh;      /* The refresh rate for game mode */
333
334     int              ActionOnWindowClose; /* Action when user closes window  */
335
336     fgExecutionState ExecState;           /* Used for GLUT termination       */
337     char            *ProgramName;         /* Name of the invoking program    */
338     GLboolean        JoysticksInitialised;  /* Only initialize if application calls for them */
339     int              NumActiveJoysticks;    /* Number of active joysticks -- if zero, don't poll joysticks */
340     GLboolean        InputDevsInitialised;  /* Only initialize if application calls for them */
341
342         int              MouseWheelTicks;      /* Number of ticks the mouse wheel has turned */
343
344     int              AuxiliaryBufferNumber;  /* Number of auxiliary buffers */
345     int              SampleNumber;         /*  Number of samples per pixel  */
346
347     int              MajorVersion;         /* Major OpenGL context version  */
348     int              MinorVersion;         /* Minor OpenGL context version  */
349     int              ContextFlags;         /* OpenGL context flags          */
350     int              ContextProfile;       /* OpenGL context profile        */
351     FGError          ErrorFunc;            /* User defined error handler    */
352     FGWarning        WarningFunc;          /* User defined warning handler  */
353 };
354
355 /* The structure used by display initialization in freeglut_init.c */
356 typedef struct tagSFG_Display SFG_Display;
357 struct tagSFG_Display
358 {
359 #if TARGET_HOST_POSIX_X11
360     Display*        Display;            /* The display we are being run in.  */
361     int             Screen;             /* The screen we are about to use.   */
362     Window          RootWindow;         /* The screen's root window.         */
363     int             Connection;         /* The display's connection number   */
364     Atom            DeleteWindow;       /* The window deletion atom          */
365     Atom            State;              /* The state atom                    */
366     Atom            StateFullScreen;    /* The full screen atom              */
367
368 #ifdef HAVE_X11_EXTENSIONS_XRANDR_H
369     int prev_xsz, prev_ysz;
370     int prev_refresh;
371     int prev_size_valid;
372 #endif  /* HAVE_X11_EXTENSIONS_XRANDR_H */
373
374 #ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
375     /*
376      * XF86VidMode may be compilable even if it fails at runtime.  Therefore,
377      * the validity of the VidMode has to be tracked
378      */
379     int             DisplayModeValid;   /* Flag that indicates runtime status*/
380     XF86VidModeModeLine DisplayMode;    /* Current screen's display settings */
381     int             DisplayModeClock;   /* The display mode's refresh rate   */
382     int             DisplayViewPortX;   /* saved X location of the viewport  */
383     int             DisplayViewPortY;   /* saved Y location of the viewport  */
384     int             DisplayPointerX;    /* saved X location of the pointer   */
385     int             DisplayPointerY;    /* saved Y location of the pointer   */
386
387 #endif /* HAVE_X11_EXTENSIONS_XF86VMODE_H */
388
389 #elif TARGET_HOST_MS_WINDOWS
390     HINSTANCE        Instance;          /* The application's instance        */
391     DEVMODE         DisplayMode;        /* Desktop's display settings        */
392     char           *DisplayName;        /* Display name for multi display support*/ 
393
394 #endif
395
396     int             ScreenWidth;        /* The screen's width in pixels      */
397     int             ScreenHeight;       /* The screen's height in pixels     */
398     int             ScreenWidthMM;      /* The screen's width in milimeters  */
399     int             ScreenHeightMM;     /* The screen's height in milimeters */
400 };
401
402
403 /* The user can create any number of timer hooks */
404 typedef struct tagSFG_Timer SFG_Timer;
405 struct tagSFG_Timer
406 {
407     SFG_Node        Node;
408     int             ID;                 /* The timer ID integer              */
409     FGCBTimer       Callback;           /* The timer callback                */
410     long            TriggerTime;        /* The timer trigger time            */
411 };
412
413 /*
414  * Make "freeglut" window handle and context types so that we don't need so
415  * much conditionally-compiled code later in the library.
416  */
417 #if TARGET_HOST_POSIX_X11
418
419 typedef Window     SFG_WindowHandleType ;
420 typedef GLXContext SFG_WindowContextType ;
421
422 #elif TARGET_HOST_MS_WINDOWS
423
424 typedef HWND    SFG_WindowHandleType ;
425 typedef HGLRC   SFG_WindowContextType ;
426
427 #endif
428
429 /*
430  * A window and its OpenGL context. The contents of this structure
431  * are highly dependant on the target operating system we aim at...
432  */
433 typedef struct tagSFG_Context SFG_Context;
434 struct tagSFG_Context
435 {
436     SFG_WindowHandleType  Handle;    /* The window's handle                 */
437     SFG_WindowContextType Context;   /* The window's OpenGL/WGL context     */
438
439 #if TARGET_HOST_POSIX_X11
440     GLXFBConfig*    FBConfig;        /* The window's FBConfig               */
441 #elif TARGET_HOST_MS_WINDOWS
442     HDC             Device;          /* The window's device context         */
443 #endif
444
445     int             DoubleBuffered;  /* Treat the window as double-buffered */
446 };
447
448 /* Window's state description. This structure should be kept portable. */
449 typedef struct tagSFG_WindowState SFG_WindowState;
450 struct tagSFG_WindowState
451 {
452     int             Width;              /* Window's width in pixels          */
453     int             Height;             /* The same about the height         */
454     int             OldWidth;           /* Window width from before a resize */
455     int             OldHeight;          /*   "    height  "    "    "   "    */
456
457     GLboolean       Redisplay;          /* Do we have to redisplay?          */
458     GLboolean       Visible;            /* Is the window visible now         */
459
460     int             Cursor;             /* The currently selected cursor     */
461
462     long            JoystickPollRate;   /* The joystick polling rate         */
463     long            JoystickLastPoll;   /* When the last poll happened       */
464
465     int             MouseX, MouseY;     /* The most recent mouse position    */
466
467     GLboolean       IgnoreKeyRepeat;    /* Whether to ignore key repeat.     */
468     GLboolean       KeyRepeating;       /* Currently in repeat mode          */
469
470     GLboolean       NeedToResize;       /* Do we need to resize the window?  */
471
472     GLboolean       IsFullscreen;       /* is the window fullscreen? */
473 };
474
475
476 /*
477  * A generic function pointer.  We should really use the GLUTproc type
478  * defined in freeglut_ext.h, but if we include that header in this file
479  * a bunch of other stuff (font-related) blows up!
480  */
481 typedef void (*SFG_Proc)();
482
483
484 /*
485  * SET_WCB() is used as:
486  *
487  *     SET_WCB( window, cbname, func );
488  *
489  * ...where {window} is the freeglut window to set the callback,
490  *          {cbname} is the window-specific callback to set,
491  *          {func} is a function-pointer.
492  *
493  * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
494  * but this can cause warnings because the FETCH_WCB() macro type-
495  * casts its result, and a type-cast value shouldn't be an lvalue.
496  *
497  * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
498  * and for no other reason.  Since it's hidden in the macro, the
499  * ugliness is felt to be rather benign.
500  */
501 #define SET_WCB(window,cbname,func)                            \
502 do                                                             \
503 {                                                              \
504     if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) )      \
505         (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
506 } while( 0 )
507
508 /*
509  * FETCH_WCB() is used as:
510  *
511  *     FETCH_WCB( window, cbname );
512  *
513  * ...where {window} is the freeglut window to fetch the callback from,
514  *          {cbname} is the window-specific callback to fetch.
515  *
516  * The result is correctly type-cast to the callback function pointer
517  * type.
518  */
519 #define FETCH_WCB(window,cbname) \
520     ((window).CallBacks[CB_ ## cbname])
521
522 /*
523  * INVOKE_WCB() is used as:
524  *
525  *     INVOKE_WCB( window, cbname, ( arg_list ) );
526  *
527  * ...where {window} is the freeglut window,
528  *          {cbname} is the window-specific callback to be invoked,
529  *          {(arg_list)} is the parameter list.
530  *
531  * The callback is invoked as:
532  *
533  *    callback( arg_list );
534  *
535  * ...so the parentheses are REQUIRED in the {arg_list}.
536  *
537  * NOTE that it does a sanity-check and also sets the
538  * current window.
539  *
540  */
541 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
542 #define INVOKE_WCB(window,cbname,arg_list)    \
543 do                                            \
544 {                                             \
545     if( FETCH_WCB( window, cbname ) )         \
546     {                                         \
547         FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
548         fgSetWindow( &window );               \
549         func arg_list;                        \
550     }                                         \
551 } while( 0 )
552 #else
553 #define INVOKE_WCB(window,cbname,arg_list)    \
554 do                                            \
555 {                                             \
556     if( FETCH_WCB( window, cbname ) )         \
557     {                                         \
558         fgSetWindow( &window );               \
559         ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
560     }                                         \
561 } while( 0 )
562 #endif
563
564 /*
565  * The window callbacks the user can supply us with. Should be kept portable.
566  *
567  * This enumeration provides the freeglut CallBack numbers.
568  * The symbolic constants are indices into a window's array of
569  * function callbacks.  The names are formed by splicing a common
570  * prefix onto the callback's base name.  (This was originally
571  * done so that an early stage of development could live side-by-
572  * side with the old callback code.  The old callback code used
573  * the bare callback's name as a structure member, so I used a
574  * prefix for the array index name.)
575  *
576  * XXX For consistancy, perhaps the prefix should match the
577  * XXX FETCH* and INVOKE* macro suffices.  I.e., WCB_, rather than
578  * XXX CB_.
579  */
580 enum
581 {
582     CB_Display,
583     CB_Reshape,
584     CB_Keyboard,
585     CB_KeyboardUp,
586     CB_Special,
587     CB_SpecialUp,
588     CB_Mouse,
589     CB_MouseWheel,
590     CB_Motion,
591     CB_Passive,
592     CB_Entry,
593     CB_Visibility,
594     CB_WindowStatus,
595     CB_Joystick,
596     CB_Destroy,
597
598     /* MPX-related */
599     CB_MultiEntry,
600     CB_MultiButton,
601     CB_MultiMotion,
602     CB_MultiPassive,
603
604     /* Presently ignored */
605     CB_Select,
606     CB_OverlayDisplay,
607     CB_SpaceMotion,     /* presently implemented only on UNIX/X11 */
608     CB_SpaceRotation,   /* presently implemented only on UNIX/X11 */
609     CB_SpaceButton,     /* presently implemented only on UNIX/X11 */
610     CB_Dials,
611     CB_ButtonBox,
612     CB_TabletMotion,
613     CB_TabletButton,
614
615     /* Always make this the LAST one */
616     TOTAL_CALLBACKS
617 };
618
619
620 /* This structure holds the OpenGL rendering context for all the menu windows */
621 typedef struct tagSFG_MenuContext SFG_MenuContext;
622 struct tagSFG_MenuContext
623 {
624     SFG_WindowContextType MContext;       /* The menu window's WGL context   */
625 };
626
627 /* This structure describes a menu */
628 typedef struct tagSFG_Window SFG_Window;
629 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
630 typedef struct tagSFG_Menu SFG_Menu;
631 struct tagSFG_Menu
632 {
633     SFG_Node            Node;
634     void               *UserData;     /* User data passed back at callback   */
635     int                 ID;           /* The global menu ID                  */
636     SFG_List            Entries;      /* The menu entries list               */
637     FGCBMenu            Callback;     /* The menu callback                   */
638     FGCBDestroy         Destroy;      /* Destruction callback                */
639     GLboolean           IsActive;     /* Is the menu selected?               */
640     int                 Width;        /* Menu box width in pixels            */
641     int                 Height;       /* Menu box height in pixels           */
642     int                 X, Y;         /* Menu box raster position            */
643
644     SFG_MenuEntry      *ActiveEntry;  /* Currently active entry in the menu  */
645     SFG_Window         *Window;       /* Window for menu                     */
646     SFG_Window         *ParentWindow; /* Window in which the menu is invoked */
647 };
648
649 /* This is a menu entry */
650 struct tagSFG_MenuEntry
651 {
652     SFG_Node            Node;
653     int                 ID;                     /* The menu entry ID (local) */
654     int                 Ordinal;                /* The menu's ordinal number */
655     char*               Text;                   /* The text to be displayed  */
656     SFG_Menu*           SubMenu;                /* Optional sub-menu tree    */
657     GLboolean           IsActive;               /* Is the entry highlighted? */
658     int                 Width;                  /* Label's width in pixels   */
659 };
660
661 /*
662  * A window, making part of freeglut windows hierarchy.
663  * Should be kept portable.
664  *
665  * NOTE that ActiveMenu is set to menu itself if the window is a menu.
666  */
667 struct tagSFG_Window
668 {
669     SFG_Node            Node;
670     int                 ID;                     /* Window's ID number        */
671
672     SFG_Context         Window;                 /* Window and OpenGL context */
673     SFG_WindowState     State;                  /* The window state          */
674     SFG_Proc            CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
675     void               *UserData ;              /* For use by user           */
676
677     SFG_Menu*       Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window  */
678     SFG_Menu*       ActiveMenu;                 /* The window's active menu  */
679
680     SFG_Window*         Parent;                 /* The parent to this window */
681     SFG_List            Children;               /* The subwindows d.l. list  */
682
683     GLboolean           IsMenu;                 /* Set to 1 if we are a menu */
684 };
685
686
687 /* A linked list structure of windows */
688 typedef struct tagSFG_WindowList SFG_WindowList ;
689 struct tagSFG_WindowList
690 {
691     SFG_Node node;
692     SFG_Window *window ;
693 };
694
695 /* This holds information about all the windows, menus etc. */
696 typedef struct tagSFG_Structure SFG_Structure;
697 struct tagSFG_Structure
698 {
699     SFG_List        Windows;         /* The global windows list            */
700     SFG_List        Menus;           /* The global menus list              */
701     SFG_List        WindowsToDestroy;
702
703     SFG_Window*     CurrentWindow;   /* The currently set window          */
704     SFG_Menu*       CurrentMenu;     /* Same, but menu...                 */
705
706     SFG_MenuContext* MenuContext;    /* OpenGL rendering context for menus */
707
708     SFG_Window*      GameModeWindow; /* The game mode window               */
709
710     int              WindowID;       /* The new current window ID          */
711     int              MenuID;         /* The new current menu ID            */
712 };
713
714 /*
715  * This structure is used for the enumeration purposes.
716  * You can easily extend its functionalities by declaring
717  * a structure containing enumerator's contents and custom
718  * data, then casting its pointer to (SFG_Enumerator *).
719  */
720 typedef struct tagSFG_Enumerator SFG_Enumerator;
721 struct tagSFG_Enumerator
722 {
723     GLboolean   found;                          /* Used to terminate search  */
724     void*       data;                           /* Custom data pointer       */
725 };
726 typedef void (* FGCBenumerator  )( SFG_Window *, SFG_Enumerator * );
727
728 /* The bitmap font structure */
729 typedef struct tagSFG_Font SFG_Font;
730 struct tagSFG_Font
731 {
732     char*           Name;         /* The source font name             */
733     int             Quantity;     /* Number of chars in font          */
734     int             Height;       /* Height of the characters         */
735     const GLubyte** Characters;   /* The characters mapping           */
736
737     float           xorig, yorig; /* Relative origin of the character */
738 };
739
740 /* The stroke font structures */
741
742 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
743 struct tagSFG_StrokeVertex
744 {
745     GLfloat         X, Y;
746 };
747
748 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
749 struct tagSFG_StrokeStrip
750 {
751     int             Number;
752     const SFG_StrokeVertex* Vertices;
753 };
754
755 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
756 struct tagSFG_StrokeChar
757 {
758     GLfloat         Right;
759     int             Number;
760     const SFG_StrokeStrip* Strips;
761 };
762
763 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
764 struct tagSFG_StrokeFont
765 {
766     char*           Name;                       /* The source font name      */
767     int             Quantity;                   /* Number of chars in font   */
768     GLfloat         Height;                     /* Height of the characters  */
769     const SFG_StrokeChar** Characters;          /* The characters mapping    */
770 };
771
772 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
773
774 /* Freeglut display related stuff (initialized once per session) */
775 extern SFG_Display fgDisplay;
776
777 /* Freeglut internal structure */
778 extern SFG_Structure fgStructure;
779
780 /* The current freeglut settings */
781 extern SFG_State fgState;
782
783
784 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
785
786 /*
787  * A call to this function makes us sure that the Display and Structure
788  * subsystems have been properly initialized and are ready to be used
789  */
790 #define  FREEGLUT_EXIT_IF_NOT_INITIALISED( string )               \
791   if ( ! fgState.Initialised )                                    \
792   {                                                               \
793     fgError ( " ERROR:  Function <%s> called"                     \
794               " without first calling 'glutInit'.", (string) ) ;  \
795   }
796
797 #define  FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string )  \
798   if ( ! fgState.Initialised )                                      \
799   {                                                                 \
800     fgError ( " ERROR:  Internal <%s> function called"              \
801               " without first calling 'glutInit'.", (string) ) ;    \
802   }
803
804 #define  FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function )  \
805   if ( ! ( cond ) )                                              \
806   {                                                              \
807     fgError ( " ERROR:  Internal error <%s> in function %s",     \
808               (string), (function) ) ;                           \
809   }
810
811 /*
812  * Following definitions are somewhat similiar to GLib's,
813  * but do not generate any log messages:
814  */
815 #define  freeglut_return_if_fail( expr ) \
816     if( !(expr) )                        \
817         return;
818 #define  freeglut_return_val_if_fail( expr, val ) \
819     if( !(expr) )                                 \
820         return val ;
821
822 /*
823  * A call to those macros assures us that there is a current
824  * window set, respectively:
825  */
826 #define  FREEGLUT_EXIT_IF_NO_WINDOW( string )                               \
827   if ( ! fgStructure.CurrentWindow &&                                       \
828        ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION ) )  \
829   {                                                                         \
830     fgError ( " ERROR:  Function <%s> called"                               \
831               " with no current window defined.", (string) ) ;              \
832   }
833
834 /*
835  * The deinitialize function gets called on glutMainLoop() end. It should clean up
836  * everything inside of the freeglut
837  */
838 void fgDeinitialize( void );
839
840 /*
841  * Those two functions are used to create/destroy the freeglut internal
842  * structures. This actually happens when calling glutInit() and when
843  * quitting the glutMainLoop() (which actually happens, when all windows
844  * have been closed).
845  */
846 void fgCreateStructure( void );
847 void fgDestroyStructure( void );
848
849 /* A helper function to check if a display mode is possible to use */
850 #if TARGET_HOST_POSIX_X11
851 GLXFBConfig* fgChooseFBConfig( int* numcfgs );
852 #endif
853
854 /* The window procedure for Win32 events handling */
855 #if TARGET_HOST_MS_WINDOWS
856 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
857                                WPARAM wParam, LPARAM lParam );
858 void fgNewWGLCreateContext( SFG_Window* window );
859 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
860                               unsigned char layer_type );
861 #endif
862
863 /*
864  * Window creation, opening, closing and destruction.
865  * Also CallBack clearing/initialization.
866  * Defined in freeglut_structure.c, freeglut_window.c.
867  */
868 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
869                             GLboolean positionUse, int x, int y,
870                             GLboolean sizeUse, int w, int h,
871                             GLboolean gameMode, GLboolean isMenu );
872 void        fgSetWindow ( SFG_Window *window );
873 void        fgOpenWindow( SFG_Window* window, const char* title,
874                           GLboolean positionUse, int x, int y,
875                           GLboolean sizeUse, int w, int h,
876                           GLboolean gameMode, GLboolean isSubWindow );
877 void        fgCloseWindow( SFG_Window* window );
878 void        fgAddToWindowDestroyList ( SFG_Window* window );
879 void        fgCloseWindows ();
880 void        fgDestroyWindow( SFG_Window* window );
881
882 /* Menu creation and destruction. Defined in freeglut_structure.c */
883 SFG_Menu*   fgCreateMenu( FGCBMenu menuCallback );
884 void        fgDestroyMenu( SFG_Menu* menu );
885
886 /* Joystick device management functions, defined in freeglut_joystick.c */
887 int         fgJoystickDetect( void );
888 void        fgInitialiseJoysticks( void );
889 void        fgJoystickClose( void );
890 void        fgJoystickPollWindow( SFG_Window* window );
891
892 /* InputDevice Initialisation and Closure */
893 int         fgInputDeviceDetect( void );
894 void        fgInitialiseInputDevices( void );
895 void        fgInputDeviceClose( void );
896
897 /* spaceball device functions, defined in freeglut_spaceball.c */
898 void        fgInitialiseSpaceball( void );
899 void        fgSpaceballClose( void );
900 void        fgSpaceballSetWindow( SFG_Window *window );
901
902 int         fgHasSpaceball( void );
903 int         fgSpaceballNumButtons( void );
904
905 #if TARGET_HOST_POSIX_X11
906 int         fgIsSpaceballXEvent( const XEvent *ev );
907 void        fgSpaceballHandleXEvent( const XEvent *ev );
908 #endif
909
910 /* Setting the cursor for a given window */
911 void fgSetCursor ( SFG_Window *window, int cursorID );
912
913 /*
914  * Helper function to enumerate through all registered windows
915  * and one to enumerate all of a window's subwindows...
916  *
917  * The GFunc callback for those functions will be defined as:
918  *
919  *      void enumCallback( gpointer window, gpointer enumerator );
920  *
921  * where window is the enumerated (sub)window pointer (SFG_Window *),
922  * and userData is the a custom user-supplied pointer. Functions
923  * are defined and exported from freeglut_structure.c file.
924  */
925 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
926 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
927                        SFG_Enumerator* enumerator );
928
929 /*
930  * fgWindowByHandle returns a (SFG_Window *) value pointing to the
931  * first window in the queue matching the specified window handle.
932  * The function is defined in freeglut_structure.c file.
933  */
934 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
935
936 /*
937  * This function is similiar to the previous one, except it is
938  * looking for a specified (sub)window identifier. The function
939  * is defined in freeglut_structure.c file.
940  */
941 SFG_Window* fgWindowByID( int windowID );
942
943 /*
944  * Looks up a menu given its ID. This is easier than fgWindowByXXX
945  * as all menus are placed in a single doubly linked list...
946  */
947 SFG_Menu* fgMenuByID( int menuID );
948
949 /*
950  * The menu activation and deactivation the code. This is the meat
951  * of the menu user interface handling code...
952  */
953 void fgUpdateMenuHighlight ( SFG_Menu *menu );
954 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
955                               int mouse_x, int mouse_y );
956 void fgDeactivateMenu( SFG_Window *window );
957
958 /*
959  * This function gets called just before the buffers swap, so that
960  * freeglut can display the pull-down menus via OpenGL. The function
961  * is defined in freeglut_menu.c file.
962  */
963 void fgDisplayMenu( void );
964
965 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
966 long fgElapsedTime( void );
967
968 /* System time in milliseconds */
969 long unsigned fgSystemTime(void);
970
971 /* List functions */
972 void fgListInit(SFG_List *list);
973 void fgListAppend(SFG_List *list, SFG_Node *node);
974 void fgListRemove(SFG_List *list, SFG_Node *node);
975 int fgListLength(SFG_List *list);
976 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
977
978 /* Error Message functions */
979 void fgError( const char *fmt, ... );
980 void fgWarning( const char *fmt, ... );
981
982 /*
983  * Check if "hint" is present in "property" for "window".  See freeglut_init.c
984  */
985 #if TARGET_HOST_POSIX_X11
986 int fgHintPresent(Window window, Atom property, Atom hint);
987
988 /* Handler for X extension Events */
989 #ifdef HAVE_X11_EXTENSIONS_XINPUT2_H
990   void fgHandleExtensionEvents( XEvent * ev );
991   void fgRegisterDevices( Display* dpy, Window* win );
992 #endif
993
994 #endif
995
996 SFG_Proc fghGetProcAddress( const char *procName );
997
998 #if TARGET_HOST_MS_WINDOWS
999 extern void (__cdecl *__glutExitFunc)( int return_value );
1000 #endif
1001
1002 #endif /* FREEGLUT_INTERNAL_H */
1003
1004 /*** END OF FILE ***/