Fixing the build after Diederick Niehorster's full screen fixes: they are only valid...
[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 #endif /* HAVE_X11_EXTENSIONS_XF86VMODE_H */
385
386     int             DisplayPointerX;    /* saved X location of the pointer   */
387     int             DisplayPointerY;    /* saved Y location of the pointer   */
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     /* Note that on Windows, sizes always refer to the client area, thus without the window decorations */
453     int             Width;              /* Window's width in pixels          */
454     int             Height;             /* The same about the height         */
455 #if TARGET_HOST_POSIX_X11
456     int             OldWidth;           /* Window width from before a resize */
457     int             OldHeight;          /*   "    height  "    "    "   "    */
458 #elif TARGET_HOST_MS_WINDOWS
459     RECT            OldRect;            /* window rect - stored before the window is made fullscreen */
460     DWORD           OldStyle;           /* window style - stored before the window is made fullscreen */
461 #endif
462
463     GLboolean       Redisplay;          /* Do we have to redisplay?          */
464     GLboolean       Visible;            /* Is the window visible now         */
465
466     int             Cursor;             /* The currently selected cursor     */
467
468     long            JoystickPollRate;   /* The joystick polling rate         */
469     long            JoystickLastPoll;   /* When the last poll happened       */
470
471     int             MouseX, MouseY;     /* The most recent mouse position    */
472
473     GLboolean       IgnoreKeyRepeat;    /* Whether to ignore key repeat.     */
474     GLboolean       KeyRepeating;       /* Currently in repeat mode          */
475
476     GLboolean       NeedToResize;       /* Do we need to resize the window?  */
477
478     GLboolean       IsFullscreen;       /* is the window fullscreen? */
479 };
480
481
482 /*
483  * A generic function pointer.  We should really use the GLUTproc type
484  * defined in freeglut_ext.h, but if we include that header in this file
485  * a bunch of other stuff (font-related) blows up!
486  */
487 typedef void (*SFG_Proc)();
488
489
490 /*
491  * SET_WCB() is used as:
492  *
493  *     SET_WCB( window, cbname, func );
494  *
495  * ...where {window} is the freeglut window to set the callback,
496  *          {cbname} is the window-specific callback to set,
497  *          {func} is a function-pointer.
498  *
499  * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
500  * but this can cause warnings because the FETCH_WCB() macro type-
501  * casts its result, and a type-cast value shouldn't be an lvalue.
502  *
503  * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
504  * and for no other reason.  Since it's hidden in the macro, the
505  * ugliness is felt to be rather benign.
506  */
507 #define SET_WCB(window,cbname,func)                            \
508 do                                                             \
509 {                                                              \
510     if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) )      \
511         (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
512 } while( 0 )
513
514 /*
515  * FETCH_WCB() is used as:
516  *
517  *     FETCH_WCB( window, cbname );
518  *
519  * ...where {window} is the freeglut window to fetch the callback from,
520  *          {cbname} is the window-specific callback to fetch.
521  *
522  * The result is correctly type-cast to the callback function pointer
523  * type.
524  */
525 #define FETCH_WCB(window,cbname) \
526     ((window).CallBacks[CB_ ## cbname])
527
528 /*
529  * INVOKE_WCB() is used as:
530  *
531  *     INVOKE_WCB( window, cbname, ( arg_list ) );
532  *
533  * ...where {window} is the freeglut window,
534  *          {cbname} is the window-specific callback to be invoked,
535  *          {(arg_list)} is the parameter list.
536  *
537  * The callback is invoked as:
538  *
539  *    callback( arg_list );
540  *
541  * ...so the parentheses are REQUIRED in the {arg_list}.
542  *
543  * NOTE that it does a sanity-check and also sets the
544  * current window.
545  *
546  */
547 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
548 #define INVOKE_WCB(window,cbname,arg_list)    \
549 do                                            \
550 {                                             \
551     if( FETCH_WCB( window, cbname ) )         \
552     {                                         \
553         FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
554         fgSetWindow( &window );               \
555         func arg_list;                        \
556     }                                         \
557 } while( 0 )
558 #else
559 #define INVOKE_WCB(window,cbname,arg_list)    \
560 do                                            \
561 {                                             \
562     if( FETCH_WCB( window, cbname ) )         \
563     {                                         \
564         fgSetWindow( &window );               \
565         ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
566     }                                         \
567 } while( 0 )
568 #endif
569
570 /*
571  * The window callbacks the user can supply us with. Should be kept portable.
572  *
573  * This enumeration provides the freeglut CallBack numbers.
574  * The symbolic constants are indices into a window's array of
575  * function callbacks.  The names are formed by splicing a common
576  * prefix onto the callback's base name.  (This was originally
577  * done so that an early stage of development could live side-by-
578  * side with the old callback code.  The old callback code used
579  * the bare callback's name as a structure member, so I used a
580  * prefix for the array index name.)
581  *
582  * XXX For consistancy, perhaps the prefix should match the
583  * XXX FETCH* and INVOKE* macro suffices.  I.e., WCB_, rather than
584  * XXX CB_.
585  */
586 enum
587 {
588     CB_Display,
589     CB_Reshape,
590     CB_Keyboard,
591     CB_KeyboardUp,
592     CB_Special,
593     CB_SpecialUp,
594     CB_Mouse,
595     CB_MouseWheel,
596     CB_Motion,
597     CB_Passive,
598     CB_Entry,
599     CB_Visibility,
600     CB_WindowStatus,
601     CB_Joystick,
602     CB_Destroy,
603
604     /* MPX-related */
605     CB_MultiEntry,
606     CB_MultiButton,
607     CB_MultiMotion,
608     CB_MultiPassive,
609
610     /* Presently ignored */
611     CB_Select,
612     CB_OverlayDisplay,
613     CB_SpaceMotion,     /* presently implemented only on UNIX/X11 */
614     CB_SpaceRotation,   /* presently implemented only on UNIX/X11 */
615     CB_SpaceButton,     /* presently implemented only on UNIX/X11 */
616     CB_Dials,
617     CB_ButtonBox,
618     CB_TabletMotion,
619     CB_TabletButton,
620
621     /* Always make this the LAST one */
622     TOTAL_CALLBACKS
623 };
624
625
626 /* This structure holds the OpenGL rendering context for all the menu windows */
627 typedef struct tagSFG_MenuContext SFG_MenuContext;
628 struct tagSFG_MenuContext
629 {
630     SFG_WindowContextType MContext;       /* The menu window's WGL context   */
631 };
632
633 /* This structure describes a menu */
634 typedef struct tagSFG_Window SFG_Window;
635 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
636 typedef struct tagSFG_Menu SFG_Menu;
637 struct tagSFG_Menu
638 {
639     SFG_Node            Node;
640     void               *UserData;     /* User data passed back at callback   */
641     int                 ID;           /* The global menu ID                  */
642     SFG_List            Entries;      /* The menu entries list               */
643     FGCBMenu            Callback;     /* The menu callback                   */
644     FGCBDestroy         Destroy;      /* Destruction callback                */
645     GLboolean           IsActive;     /* Is the menu selected?               */
646     int                 Width;        /* Menu box width in pixels            */
647     int                 Height;       /* Menu box height in pixels           */
648     int                 X, Y;         /* Menu box raster position            */
649
650     SFG_MenuEntry      *ActiveEntry;  /* Currently active entry in the menu  */
651     SFG_Window         *Window;       /* Window for menu                     */
652     SFG_Window         *ParentWindow; /* Window in which the menu is invoked */
653 };
654
655 /* This is a menu entry */
656 struct tagSFG_MenuEntry
657 {
658     SFG_Node            Node;
659     int                 ID;                     /* The menu entry ID (local) */
660     int                 Ordinal;                /* The menu's ordinal number */
661     char*               Text;                   /* The text to be displayed  */
662     SFG_Menu*           SubMenu;                /* Optional sub-menu tree    */
663     GLboolean           IsActive;               /* Is the entry highlighted? */
664     int                 Width;                  /* Label's width in pixels   */
665 };
666
667 /*
668  * A window, making part of freeglut windows hierarchy.
669  * Should be kept portable.
670  *
671  * NOTE that ActiveMenu is set to menu itself if the window is a menu.
672  */
673 struct tagSFG_Window
674 {
675     SFG_Node            Node;
676     int                 ID;                     /* Window's ID number        */
677
678     SFG_Context         Window;                 /* Window and OpenGL context */
679     SFG_WindowState     State;                  /* The window state          */
680     SFG_Proc            CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
681     void               *UserData ;              /* For use by user           */
682
683     SFG_Menu*       Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window  */
684     SFG_Menu*       ActiveMenu;                 /* The window's active menu  */
685
686     SFG_Window*         Parent;                 /* The parent to this window */
687     SFG_List            Children;               /* The subwindows d.l. list  */
688
689     GLboolean           IsMenu;                 /* Set to 1 if we are a menu */
690 };
691
692
693 /* A linked list structure of windows */
694 typedef struct tagSFG_WindowList SFG_WindowList ;
695 struct tagSFG_WindowList
696 {
697     SFG_Node node;
698     SFG_Window *window ;
699 };
700
701 /* This holds information about all the windows, menus etc. */
702 typedef struct tagSFG_Structure SFG_Structure;
703 struct tagSFG_Structure
704 {
705     SFG_List        Windows;         /* The global windows list            */
706     SFG_List        Menus;           /* The global menus list              */
707     SFG_List        WindowsToDestroy;
708
709     SFG_Window*     CurrentWindow;   /* The currently set window          */
710     SFG_Menu*       CurrentMenu;     /* Same, but menu...                 */
711
712     SFG_MenuContext* MenuContext;    /* OpenGL rendering context for menus */
713
714     SFG_Window*      GameModeWindow; /* The game mode window               */
715
716     int              WindowID;       /* The new current window ID          */
717     int              MenuID;         /* The new current menu ID            */
718 };
719
720 /*
721  * This structure is used for the enumeration purposes.
722  * You can easily extend its functionalities by declaring
723  * a structure containing enumerator's contents and custom
724  * data, then casting its pointer to (SFG_Enumerator *).
725  */
726 typedef struct tagSFG_Enumerator SFG_Enumerator;
727 struct tagSFG_Enumerator
728 {
729     GLboolean   found;                          /* Used to terminate search  */
730     void*       data;                           /* Custom data pointer       */
731 };
732 typedef void (* FGCBenumerator  )( SFG_Window *, SFG_Enumerator * );
733
734 /* The bitmap font structure */
735 typedef struct tagSFG_Font SFG_Font;
736 struct tagSFG_Font
737 {
738     char*           Name;         /* The source font name             */
739     int             Quantity;     /* Number of chars in font          */
740     int             Height;       /* Height of the characters         */
741     const GLubyte** Characters;   /* The characters mapping           */
742
743     float           xorig, yorig; /* Relative origin of the character */
744 };
745
746 /* The stroke font structures */
747
748 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
749 struct tagSFG_StrokeVertex
750 {
751     GLfloat         X, Y;
752 };
753
754 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
755 struct tagSFG_StrokeStrip
756 {
757     int             Number;
758     const SFG_StrokeVertex* Vertices;
759 };
760
761 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
762 struct tagSFG_StrokeChar
763 {
764     GLfloat         Right;
765     int             Number;
766     const SFG_StrokeStrip* Strips;
767 };
768
769 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
770 struct tagSFG_StrokeFont
771 {
772     char*           Name;                       /* The source font name      */
773     int             Quantity;                   /* Number of chars in font   */
774     GLfloat         Height;                     /* Height of the characters  */
775     const SFG_StrokeChar** Characters;          /* The characters mapping    */
776 };
777
778 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
779
780 /* Freeglut display related stuff (initialized once per session) */
781 extern SFG_Display fgDisplay;
782
783 /* Freeglut internal structure */
784 extern SFG_Structure fgStructure;
785
786 /* The current freeglut settings */
787 extern SFG_State fgState;
788
789
790 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
791
792 /*
793  * A call to this function makes us sure that the Display and Structure
794  * subsystems have been properly initialized and are ready to be used
795  */
796 #define  FREEGLUT_EXIT_IF_NOT_INITIALISED( string )               \
797   if ( ! fgState.Initialised )                                    \
798   {                                                               \
799     fgError ( " ERROR:  Function <%s> called"                     \
800               " without first calling 'glutInit'.", (string) ) ;  \
801   }
802
803 #define  FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string )  \
804   if ( ! fgState.Initialised )                                      \
805   {                                                                 \
806     fgError ( " ERROR:  Internal <%s> function called"              \
807               " without first calling 'glutInit'.", (string) ) ;    \
808   }
809
810 #define  FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function )  \
811   if ( ! ( cond ) )                                              \
812   {                                                              \
813     fgError ( " ERROR:  Internal error <%s> in function %s",     \
814               (string), (function) ) ;                           \
815   }
816
817 /*
818  * Following definitions are somewhat similiar to GLib's,
819  * but do not generate any log messages:
820  */
821 #define  freeglut_return_if_fail( expr ) \
822     if( !(expr) )                        \
823         return;
824 #define  freeglut_return_val_if_fail( expr, val ) \
825     if( !(expr) )                                 \
826         return val ;
827
828 /*
829  * A call to those macros assures us that there is a current
830  * window set, respectively:
831  */
832 #define  FREEGLUT_EXIT_IF_NO_WINDOW( string )                               \
833   if ( ! fgStructure.CurrentWindow &&                                       \
834        ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION ) )  \
835   {                                                                         \
836     fgError ( " ERROR:  Function <%s> called"                               \
837               " with no current window defined.", (string) ) ;              \
838   }
839
840 /*
841  * The deinitialize function gets called on glutMainLoop() end. It should clean up
842  * everything inside of the freeglut
843  */
844 void fgDeinitialize( void );
845
846 /*
847  * Those two functions are used to create/destroy the freeglut internal
848  * structures. This actually happens when calling glutInit() and when
849  * quitting the glutMainLoop() (which actually happens, when all windows
850  * have been closed).
851  */
852 void fgCreateStructure( void );
853 void fgDestroyStructure( void );
854
855 /* A helper function to check if a display mode is possible to use */
856 #if TARGET_HOST_POSIX_X11
857 GLXFBConfig* fgChooseFBConfig( int* numcfgs );
858 #endif
859
860 /* The window procedure for Win32 events handling */
861 #if TARGET_HOST_MS_WINDOWS
862 LRESULT CALLBACK fgWindowProc( HWND hWnd, UINT uMsg,
863                                WPARAM wParam, LPARAM lParam );
864 void fgNewWGLCreateContext( SFG_Window* window );
865 GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
866                               unsigned char layer_type );
867 #endif
868
869 /*
870  * Window creation, opening, closing and destruction.
871  * Also CallBack clearing/initialization.
872  * Defined in freeglut_structure.c, freeglut_window.c.
873  */
874 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
875                             GLboolean positionUse, int x, int y,
876                             GLboolean sizeUse, int w, int h,
877                             GLboolean gameMode, GLboolean isMenu );
878 void        fgSetWindow ( SFG_Window *window );
879 void        fgOpenWindow( SFG_Window* window, const char* title,
880                           GLboolean positionUse, int x, int y,
881                           GLboolean sizeUse, int w, int h,
882                           GLboolean gameMode, GLboolean isSubWindow );
883 void        fgCloseWindow( SFG_Window* window );
884 void        fgAddToWindowDestroyList ( SFG_Window* window );
885 void        fgCloseWindows ();
886 void        fgDestroyWindow( SFG_Window* window );
887
888 /* Menu creation and destruction. Defined in freeglut_structure.c */
889 SFG_Menu*   fgCreateMenu( FGCBMenu menuCallback );
890 void        fgDestroyMenu( SFG_Menu* menu );
891
892 /* Joystick device management functions, defined in freeglut_joystick.c */
893 int         fgJoystickDetect( void );
894 void        fgInitialiseJoysticks( void );
895 void        fgJoystickClose( void );
896 void        fgJoystickPollWindow( SFG_Window* window );
897
898 /* InputDevice Initialisation and Closure */
899 int         fgInputDeviceDetect( void );
900 void        fgInitialiseInputDevices( void );
901 void        fgInputDeviceClose( void );
902
903 /* spaceball device functions, defined in freeglut_spaceball.c */
904 void        fgInitialiseSpaceball( void );
905 void        fgSpaceballClose( void );
906 void        fgSpaceballSetWindow( SFG_Window *window );
907
908 int         fgHasSpaceball( void );
909 int         fgSpaceballNumButtons( void );
910
911 #if TARGET_HOST_POSIX_X11
912 int         fgIsSpaceballXEvent( const XEvent *ev );
913 void        fgSpaceballHandleXEvent( const XEvent *ev );
914 #endif
915
916 /* Setting the cursor for a given window */
917 void fgSetCursor ( SFG_Window *window, int cursorID );
918
919 /*
920  * Helper function to enumerate through all registered windows
921  * and one to enumerate all of a window's subwindows...
922  *
923  * The GFunc callback for those functions will be defined as:
924  *
925  *      void enumCallback( gpointer window, gpointer enumerator );
926  *
927  * where window is the enumerated (sub)window pointer (SFG_Window *),
928  * and userData is the a custom user-supplied pointer. Functions
929  * are defined and exported from freeglut_structure.c file.
930  */
931 void fgEnumWindows( FGCBenumerator enumCallback, SFG_Enumerator* enumerator );
932 void fgEnumSubWindows( SFG_Window* window, FGCBenumerator enumCallback,
933                        SFG_Enumerator* enumerator );
934
935 /* 
936  * Helper functions for getting client area from the window rect
937  * and the window rect from the client area given the style of the window
938  * (or a valid window pointer from which the style can be queried).
939  */
940 void fghComputeWindowRectFromClientArea_UseStyle   ( const DWORD windowStyle , RECT *clientRect, BOOL posIsOutside );
941 void fghComputeWindowRectFromClientArea_QueryWindow( const SFG_Window *window, RECT *clientRect, BOOL posIsOutside );
942 void fghComputeClientAreaFromWindowRect            ( const SFG_Window *window, RECT *windowRect, BOOL wantPosOutside );
943 RECT fghGetClientArea                              ( const SFG_Window *window,                   BOOL wantPosOutside );
944 void fghGetBorderWidth(const DWORD windowStyle, int* xBorderWidth, int* yBorderWidth);
945
946 /*
947  * fgWindowByHandle returns a (SFG_Window *) value pointing to the
948  * first window in the queue matching the specified window handle.
949  * The function is defined in freeglut_structure.c file.
950  */
951 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
952
953 /*
954  * This function is similiar to the previous one, except it is
955  * looking for a specified (sub)window identifier. The function
956  * is defined in freeglut_structure.c file.
957  */
958 SFG_Window* fgWindowByID( int windowID );
959
960 /*
961  * Looks up a menu given its ID. This is easier than fgWindowByXXX
962  * as all menus are placed in a single doubly linked list...
963  */
964 SFG_Menu* fgMenuByID( int menuID );
965
966 /*
967  * The menu activation and deactivation the code. This is the meat
968  * of the menu user interface handling code...
969  */
970 void fgUpdateMenuHighlight ( SFG_Menu *menu );
971 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
972                               int mouse_x, int mouse_y );
973 void fgDeactivateMenu( SFG_Window *window );
974
975 /*
976  * This function gets called just before the buffers swap, so that
977  * freeglut can display the pull-down menus via OpenGL. The function
978  * is defined in freeglut_menu.c file.
979  */
980 void fgDisplayMenu( void );
981
982 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
983 long fgElapsedTime( void );
984
985 /* System time in milliseconds */
986 long unsigned fgSystemTime(void);
987
988 /* List functions */
989 void fgListInit(SFG_List *list);
990 void fgListAppend(SFG_List *list, SFG_Node *node);
991 void fgListRemove(SFG_List *list, SFG_Node *node);
992 int fgListLength(SFG_List *list);
993 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
994
995 /* Error Message functions */
996 void fgError( const char *fmt, ... );
997 void fgWarning( const char *fmt, ... );
998
999 /*
1000  * Check if "hint" is present in "property" for "window".  See freeglut_init.c
1001  */
1002 #if TARGET_HOST_POSIX_X11
1003 int fgHintPresent(Window window, Atom property, Atom hint);
1004
1005 /* Handler for X extension Events */
1006 #ifdef HAVE_X11_EXTENSIONS_XINPUT2_H
1007   void fgHandleExtensionEvents( XEvent * ev );
1008   void fgRegisterDevices( Display* dpy, Window* win );
1009 #endif
1010
1011 #endif
1012
1013 SFG_Proc fghGetProcAddress( const char *procName );
1014
1015 #if TARGET_HOST_MS_WINDOWS
1016 extern void (__cdecl *__glutExitFunc)( int return_value );
1017 #endif
1018
1019 #endif /* FREEGLUT_INTERNAL_H */
1020
1021 /*** END OF FILE ***/