2de99b1035e6225b906e01ae7da9c20e6ff23edd
[freeglut] / src / fg_internal.h
1 /*
2  * fg_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 /* Freeglut is intended to function under all Unix/X11 and Win32 platforms. */
36 /* XXX: Don't all MS-Windows compilers (except Cygwin) have _WIN32 defined?
37  * XXX: If so, remove the first set of defined()'s below.
38  */
39 #if !defined(TARGET_HOST_POSIX_X11) && !defined(TARGET_HOST_MS_WINDOWS) && !defined(TARGET_HOST_MAC_OSX) && !defined(TARGET_HOST_SOLARIS)
40 #if defined(_MSC_VER) || defined(__WATCOMC__) || defined(__MINGW32__) \
41     || defined(_WIN32) || defined(_WIN32_WCE) \
42     || ( defined(__CYGWIN__) && defined(X_DISPLAY_MISSING) )
43 #   define  TARGET_HOST_MS_WINDOWS 1
44
45 #elif defined (__ANDROID__)
46 #   define  TARGET_HOST_ANDROID  1
47
48 #elif defined(__posix__) || defined(__unix__) || defined(__linux__) || defined(__sun)
49 #   define  TARGET_HOST_POSIX_X11  1
50
51 #elif defined(__APPLE__)
52 /* This is a placeholder until we get native OSX support ironed out -- JFF 11/18/09 */
53 #   define  TARGET_HOST_POSIX_X11  1
54 /* #   define  TARGET_HOST_MAC_OSX    1 */
55
56 #else
57 #   error "Unrecognized target host!"
58
59 #endif
60 #endif
61
62 /* Detect both SunPro and gcc compilers on Sun Solaris */
63 #if defined (__SVR4) && defined (__sun)
64 #   define TARGET_HOST_SOLARIS 1
65 #endif
66
67 #ifndef TARGET_HOST_MS_WINDOWS
68 #   define  TARGET_HOST_MS_WINDOWS 0
69 #endif
70
71 #ifndef  TARGET_HOST_POSIX_X11
72 #   define  TARGET_HOST_POSIX_X11  0
73 #endif
74
75 #ifndef  TARGET_HOST_MAC_OSX
76 #   define  TARGET_HOST_MAC_OSX    0
77 #endif
78
79 #ifndef  TARGET_HOST_SOLARIS
80 #   define  TARGET_HOST_SOLARIS    0
81 #endif
82
83 /* -- FIXED CONFIGURATION LIMITS ------------------------------------------- */
84
85 #define  FREEGLUT_MAX_MENUS         3
86
87 /* These files should be available on every platform. */
88 #include <stdio.h>
89 #include <string.h>
90 #include <math.h>
91 #include <stdlib.h>
92 #include <stdarg.h>
93
94 /* These are included based on autoconf directives. */
95 #ifdef HAVE_SYS_TYPES_H
96 #    include <sys/types.h>
97 #endif
98 #ifdef HAVE_UNISTD_H
99 #    include <unistd.h>
100 #endif
101 #ifdef TIME_WITH_SYS_TIME
102 #    include <sys/time.h>
103 #    include <time.h>
104 #elif defined(HAVE_SYS_TIME_H)
105 #    include <sys/time.h>
106 #else
107 #    include <time.h>
108 #endif
109
110 /* -- AUTOCONF HACKS --------------------------------------------------------*/
111
112 /* XXX: Update autoconf to avoid these.
113  * XXX: Are non-POSIX platforms intended not to use autoconf?
114  * If so, perhaps there should be a config_guess.h for them. Alternatively,
115  * config guesses could be placed above, just after the config.h exclusion.
116  */
117 #if defined(__FreeBSD__) || defined(__NetBSD__)
118 #    define HAVE_USB_JS 1
119 #    if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
120 #        define HAVE_USBHID_H 1
121 #    endif
122 #endif
123
124 #if defined(_MSC_VER) || defined(__WATCOMC__)
125 /* strdup() is non-standard, for all but POSIX-2001 */
126 #define strdup   _strdup
127 #endif
128
129 /* M_PI is non-standard (defined by BSD, not ISO-C) */
130 #ifndef M_PI
131 #    define  M_PI  3.14159265358979323846
132 #endif
133
134 #ifdef HAVE_STDBOOL_H
135 #    include <stdbool.h>
136 #    ifndef TRUE
137 #        define TRUE true
138 #    endif
139 #    ifndef FALSE
140 #        define FALSE false
141 #    endif
142 #else
143 #    ifndef TRUE
144 #        define  TRUE  1
145 #    endif
146 #    ifndef FALSE
147 #        define  FALSE  0
148 #    endif
149 #endif
150
151 /* General defines */
152 #define INVALID_MODIFIERS 0xffffffff
153
154 /* FreeGLUT internal time type */
155 #if defined(HAVE_STDINT_H)
156 #   include <stdint.h>
157     typedef uint64_t fg_time_t;
158 #elif defined(HAVE_INTTYPES_H)
159 #   include <inttypes.h>
160     typedef uint64_t fg_time_t;
161 #elif defined(HAVE_U__INT64)
162     typedef unsigned __int64 fg_time_t;
163 #elif defined(HAVE_ULONG_LONG)
164     typedef unsigned long long fg_time_t;
165 #else
166     typedef unsigned long fg_time_t;
167 #endif
168
169 #ifndef __fg_unused
170 # ifdef __GNUC__
171 #  define __fg_unused __attribute__((unused))
172 # else
173 #  define __fg_unused
174 # endif
175 #endif
176
177 /* Platform-specific includes */
178 #if TARGET_HOST_POSIX_X11
179 #include "x11/fg_internal_x11.h"
180 #endif
181 #if TARGET_HOST_MS_WINDOWS
182 #include "mswin/fg_internal_mswin.h"
183 #endif
184 #if TARGET_HOST_ANDROID
185 #include "android/fg_internal_android.h"
186 #endif
187
188
189 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
190
191 /* Freeglut callbacks type definitions */
192 typedef void (* FGCBDisplay       )( void );
193 typedef void (* FGCBReshape       )( int, int );
194 typedef void (* FGCBPosition      )( int, int );
195 typedef void (* FGCBVisibility    )( int );
196 typedef void (* FGCBKeyboard      )( unsigned char, int, int );
197 typedef void (* FGCBKeyboardUp    )( unsigned char, int, int );
198 typedef void (* FGCBSpecial       )( int, int, int );
199 typedef void (* FGCBSpecialUp     )( int, int, int );
200 typedef void (* FGCBMouse         )( int, int, int, int );
201 typedef void (* FGCBMouseWheel    )( int, int, int, int );
202 typedef void (* FGCBMotion        )( int, int );
203 typedef void (* FGCBPassive       )( int, int );
204 typedef void (* FGCBEntry         )( int );
205 typedef void (* FGCBWindowStatus  )( int );
206 typedef void (* FGCBJoystick      )( unsigned int, int, int, int );
207 typedef void (* FGCBOverlayDisplay)( void );
208 typedef void (* FGCBSpaceMotion   )( int, int, int );
209 typedef void (* FGCBSpaceRotation )( int, int, int );
210 typedef void (* FGCBSpaceButton   )( int, int );
211 typedef void (* FGCBDials         )( int, int );
212 typedef void (* FGCBButtonBox     )( int, int );
213 typedef void (* FGCBTabletMotion  )( int, int );
214 typedef void (* FGCBTabletButton  )( int, int, int, int );
215 typedef void (* FGCBDestroy       )( void );    /* Used for both window and menu destroy callbacks */
216
217 typedef void (* FGCBMultiEntry   )( int, int );
218 typedef void (* FGCBMultiButton  )( int, int, int, int, int );
219 typedef void (* FGCBMultiMotion  )( int, int, int );
220 typedef void (* FGCBMultiPassive )( int, int, int );
221
222 typedef void (* FGCBInitContext)();
223 typedef void (* FGCBPause)();
224 typedef void (* FGCBResume)();
225
226 /* The global callbacks type definitions */
227 typedef void (* FGCBIdle          )( void );
228 typedef void (* FGCBTimer         )( int );
229 typedef void (* FGCBMenuState     )( int );
230 typedef void (* FGCBMenuStatus    )( int, int, int );
231
232 /* The callback used when creating/using menus */
233 typedef void (* FGCBMenu          )( int );
234
235 /* The FreeGLUT error/warning handler type definition */
236 typedef void (* FGError           ) ( const char *fmt, va_list ap);
237 typedef void (* FGWarning         ) ( const char *fmt, va_list ap);
238
239
240 /* A list structure */
241 typedef struct tagSFG_List SFG_List;
242 struct tagSFG_List
243 {
244     void *First;
245     void *Last;
246 };
247
248 /* A list node structure */
249 typedef struct tagSFG_Node SFG_Node;
250 struct tagSFG_Node
251 {
252     void *Next;
253     void *Prev;
254 };
255
256 /* A helper structure holding two ints and a boolean */
257 typedef struct tagSFG_XYUse SFG_XYUse;
258 struct tagSFG_XYUse
259 {
260     GLint           X, Y;               /* The two integers...               */
261     GLboolean       Use;                /* ...and a single boolean.          */
262 };
263
264 /*
265  * An enumeration containing the state of the GLUT execution:
266  * initializing, running, or stopping
267  */
268 typedef enum
269 {
270   GLUT_EXEC_STATE_INIT,
271   GLUT_EXEC_STATE_RUNNING,
272   GLUT_EXEC_STATE_STOP
273 } fgExecutionState ;
274
275 /* This structure holds different freeglut settings */
276 typedef struct tagSFG_State SFG_State;
277 struct tagSFG_State
278 {
279     SFG_XYUse        Position;             /* The default windows' position  */
280     SFG_XYUse        Size;                 /* The default windows' size      */
281     unsigned int     DisplayMode;          /* Display mode for new windows   */
282
283     GLboolean        Initialised;          /* freeglut has been initialised  */
284
285     int              DirectContext;        /* Direct rendering state         */
286
287     GLboolean        ForceIconic;          /* New top windows are iconified  */
288     GLboolean        UseCurrentContext;    /* New windows share with current */
289
290     GLboolean        GLDebugSwitch;        /* OpenGL state debugging switch  */
291     GLboolean        XSyncSwitch;          /* X11 sync protocol switch       */
292
293     int              KeyRepeat;            /* Global key repeat mode.        */
294     int              Modifiers;            /* Current ALT/SHIFT/CTRL state   */
295
296     GLuint           FPSInterval;          /* Interval between FPS printfs   */
297     GLuint           SwapCount;            /* Count of glutSwapBuffer calls  */
298     GLuint           SwapTime;             /* Time of last SwapBuffers       */
299
300     fg_time_t        Time;                 /* Time that glutInit was called  */
301     SFG_List         Timers;               /* The freeglut timer hooks       */
302     SFG_List         FreeTimers;           /* The unused timer hooks         */
303
304     FGCBIdle         IdleCallback;         /* The global idle callback       */
305
306     int              ActiveMenus;          /* Num. of currently active menus */
307     FGCBMenuState    MenuStateCallback;    /* Menu callbacks are global      */
308     FGCBMenuStatus   MenuStatusCallback;
309
310     SFG_XYUse        GameModeSize;         /* Game mode screen's dimensions  */
311     int              GameModeDepth;        /* The pixel depth for game mode  */
312     int              GameModeRefresh;      /* The refresh rate for game mode */
313
314     int              ActionOnWindowClose; /* Action when user closes window  */
315
316     fgExecutionState ExecState;           /* Used for GLUT termination       */
317     char            *ProgramName;         /* Name of the invoking program    */
318     GLboolean        JoysticksInitialised;  /* Only initialize if application calls for them */
319     int              NumActiveJoysticks;    /* Number of active joysticks (callback defined and positive pollrate) -- if zero, don't poll joysticks */
320     GLboolean        InputDevsInitialised;  /* Only initialize if application calls for them */
321
322         int              MouseWheelTicks;      /* Number of ticks the mouse wheel has turned */
323
324     int              AuxiliaryBufferNumber;  /* Number of auxiliary buffers */
325     int              SampleNumber;         /*  Number of samples per pixel  */
326
327     GLboolean        SkipStaleMotion;      /* skip stale motion events */
328
329     int              MajorVersion;         /* Major OpenGL context version  */
330     int              MinorVersion;         /* Minor OpenGL context version  */
331     int              ContextFlags;         /* OpenGL context flags          */
332     int              ContextProfile;       /* OpenGL context profile        */
333     int              HasOpenGL20;          /* fgInitGL2 could find all OpenGL 2.0 functions */
334     FGError          ErrorFunc;            /* User defined error handler    */
335     FGWarning        WarningFunc;          /* User defined warning handler  */
336 };
337
338 /* The structure used by display initialization in freeglut_init.c */
339 typedef struct tagSFG_Display SFG_Display;
340 struct tagSFG_Display
341 {
342         SFG_PlatformDisplay pDisplay;
343
344     int             ScreenWidth;        /* The screen's width in pixels      */
345     int             ScreenHeight;       /* The screen's height in pixels     */
346     int             ScreenWidthMM;      /* The screen's width in milimeters  */
347     int             ScreenHeightMM;     /* The screen's height in milimeters */
348 };
349
350
351 /* The user can create any number of timer hooks */
352 typedef struct tagSFG_Timer SFG_Timer;
353 struct tagSFG_Timer
354 {
355     SFG_Node        Node;
356     int             ID;                 /* The timer ID integer              */
357     FGCBTimer       Callback;           /* The timer callback                */
358     fg_time_t       TriggerTime;        /* The timer trigger time            */
359 };
360
361 /*
362  * A window and its OpenGL context. The contents of this structure
363  * are highly dependant on the target operating system we aim at...
364  */
365 typedef struct tagSFG_Context SFG_Context;
366 struct tagSFG_Context
367 {
368     SFG_WindowHandleType  Handle;    /* The window's handle                 */
369     SFG_WindowContextType Context;   /* The window's OpenGL/WGL context     */
370
371         SFG_PlatformContext pContext;    /* The window's FBConfig (X11) or device context (Windows) */
372
373     int             DoubleBuffered;  /* Treat the window as double-buffered */
374
375     /* When drawing geometry to vertex attribute buffers, user specifies 
376      * the attribute indices for vertices, normals and/or texture coords
377      * to freeglut. Those are stored here
378      */
379     GLint           attribute_v_coord;
380     GLint           attribute_v_normal;
381     GLint           attribute_v_texture;
382 };
383
384
385 typedef struct tagSFG_WindowState SFG_WindowState;
386 struct tagSFG_WindowState
387 {
388     /* Note that on Windows, sizes always refer to the client area, thus without the window decorations */
389     int             Width;              /* Window's width in pixels          */
390     int             Height;             /* The same about the height         */
391
392         SFG_PlatformWindowState pWState;    /* Window width/height (X11) or rectangle/style (Windows) from before a resize, and other stuff only needed on specific platforms */
393
394     GLboolean       Redisplay;          /* Do we have to redisplay?          */
395     GLboolean       Visible;            /* Is the window visible now         */
396
397     int             Cursor;             /* The currently selected cursor     */
398
399     long            JoystickPollRate;   /* The joystick polling rate         */
400     fg_time_t       JoystickLastPoll;   /* When the last poll happened       */
401
402     int             MouseX, MouseY;     /* The most recent mouse position    */
403
404     GLboolean       IgnoreKeyRepeat;    /* Whether to ignore key repeat.     */
405     GLboolean       KeyRepeating;       /* Currently in repeat mode          */
406
407     GLboolean       NeedToResize;       /* Do we need to resize the window?  */
408
409     GLboolean       IsFullscreen;       /* is the window fullscreen? */
410
411     GLboolean       NeedToInitContext;  /* are OpenGL context/resources loaded? */
412
413     GLboolean       VisualizeNormals;   /* When drawing objects, draw vectors representing the normals as well? */
414 };
415
416
417 /*
418  * A generic function pointer.  We should really use the GLUTproc type
419  * defined in freeglut_ext.h, but if we include that header in this file
420  * a bunch of other stuff (font-related) blows up!
421  */
422 typedef void (*SFG_Proc)();
423
424
425 /*
426  * SET_WCB() is used as:
427  *
428  *     SET_WCB( window, cbname, func );
429  *
430  * ...where {window} is the freeglut window to set the callback,
431  *          {cbname} is the window-specific callback to set,
432  *          {func} is a function-pointer.
433  *
434  * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
435  * but this can cause warnings because the FETCH_WCB() macro type-
436  * casts its result, and a type-cast value shouldn't be an lvalue.
437  *
438  * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
439  * and for no other reason.  Since it's hidden in the macro, the
440  * ugliness is felt to be rather benign.
441  */
442 #define SET_WCB(window,cbname,func)                            \
443 do                                                             \
444 {                                                              \
445     if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) )      \
446         (((window).CallBacks[WCB_ ## cbname]) = (SFG_Proc)(func)); \
447 } while( 0 )
448
449 /*
450  * FETCH_WCB() is used as:
451  *
452  *     FETCH_WCB( window, cbname );
453  *
454  * ...where {window} is the freeglut window to fetch the callback from,
455  *          {cbname} is the window-specific callback to fetch.
456  *
457  * The result is correctly type-cast to the callback function pointer
458  * type.
459  */
460 #define FETCH_WCB(window,cbname) \
461     ((window).CallBacks[WCB_ ## cbname])
462
463 /*
464  * INVOKE_WCB() is used as:
465  *
466  *     INVOKE_WCB( window, cbname, ( arg_list ) );
467  *
468  * ...where {window} is the freeglut window,
469  *          {cbname} is the window-specific callback to be invoked,
470  *          {(arg_list)} is the parameter list.
471  *
472  * The callback is invoked as:
473  *
474  *    callback( arg_list );
475  *
476  * ...so the parentheses are REQUIRED in the {arg_list}.
477  *
478  * NOTE that it does a sanity-check and also sets the
479  * current window.
480  *
481  */
482 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
483 #define INVOKE_WCB(window,cbname,arg_list)    \
484 do                                            \
485 {                                             \
486     if( FETCH_WCB( window, cbname ) )         \
487     {                                         \
488         FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
489         fgSetWindow( &window );               \
490         func arg_list;                        \
491     }                                         \
492 } while( 0 )
493 #else
494 #define INVOKE_WCB(window,cbname,arg_list)    \
495 do                                            \
496 {                                             \
497     if( FETCH_WCB( window, cbname ) )         \
498     {                                         \
499         fgSetWindow( &window );               \
500         ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
501     }                                         \
502 } while( 0 )
503 #endif
504
505 /*
506  * The window callbacks the user can supply us with. Should be kept portable.
507  *
508  * This enumeration provides the freeglut CallBack numbers.
509  * The symbolic constants are indices into a window's array of
510  * function callbacks.  The names are formed by splicing a common
511  * prefix onto the callback's base name.  (This was originally
512  * done so that an early stage of development could live side-by-
513  * side with the old callback code.  The old callback code used
514  * the bare callback's name as a structure member, so I used a
515  * prefix for the array index name.)
516  */
517 enum
518 {
519     WCB_Display,
520     WCB_Reshape,
521     WCB_Position,
522     WCB_Keyboard,
523     WCB_KeyboardUp,
524     WCB_Special,
525     WCB_SpecialUp,
526     WCB_Mouse,
527     WCB_MouseWheel,
528     WCB_Motion,
529     WCB_Passive,
530     WCB_Entry,
531     WCB_Visibility,
532     WCB_WindowStatus,
533     WCB_Joystick,
534     WCB_Destroy,
535
536     /* Multi-Pointer X and touch related */
537     WCB_MultiEntry,
538     WCB_MultiButton,
539     WCB_MultiMotion,
540     WCB_MultiPassive,
541
542     /* Mobile platforms LifeCycle */
543     WCB_InitContext,
544     WCB_Pause,
545     WCB_Resume,
546
547     /* Presently ignored */
548     WCB_Select,
549     WCB_OverlayDisplay,
550     WCB_SpaceMotion,     /* presently implemented only on UNIX/X11 */
551     WCB_SpaceRotation,   /* presently implemented only on UNIX/X11 */
552     WCB_SpaceButton,     /* presently implemented only on UNIX/X11 */
553     WCB_Dials,
554     WCB_ButtonBox,
555     WCB_TabletMotion,
556     WCB_TabletButton,
557
558     /* Always make this the LAST one */
559     TOTAL_CALLBACKS
560 };
561
562
563 /* This structure holds the OpenGL rendering context for all the menu windows */
564 typedef struct tagSFG_MenuContext SFG_MenuContext;
565 struct tagSFG_MenuContext
566 {
567     SFG_WindowContextType MContext;       /* The menu window's WGL context   */
568 };
569
570 /* This structure describes a menu */
571 typedef struct tagSFG_Window SFG_Window;
572 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
573 typedef struct tagSFG_Menu SFG_Menu;
574 struct tagSFG_Menu
575 {
576     SFG_Node            Node;
577     void               *UserData;     /* User data passed back at callback   */
578     int                 ID;           /* The global menu ID                  */
579     SFG_List            Entries;      /* The menu entries list               */
580     FGCBMenu            Callback;     /* The menu callback                   */
581     FGCBDestroy         Destroy;      /* Destruction callback                */
582     GLboolean           IsActive;     /* Is the menu selected?               */
583     int                 Width;        /* Menu box width in pixels            */
584     int                 Height;       /* Menu box height in pixels           */
585     int                 X, Y;         /* Menu box raster position            */
586
587     SFG_MenuEntry      *ActiveEntry;  /* Currently active entry in the menu  */
588     SFG_Window         *Window;       /* Window for menu                     */
589     SFG_Window         *ParentWindow; /* Window in which the menu is invoked */
590 };
591
592 /* This is a menu entry */
593 struct tagSFG_MenuEntry
594 {
595     SFG_Node            Node;
596     int                 ID;                     /* The menu entry ID (local) */
597     int                 Ordinal;                /* The menu's ordinal number */
598     char*               Text;                   /* The text to be displayed  */
599     SFG_Menu*           SubMenu;                /* Optional sub-menu tree    */
600     GLboolean           IsActive;               /* Is the entry highlighted? */
601     int                 Width;                  /* Label's width in pixels   */
602 };
603
604 /*
605  * A window, making part of freeglut windows hierarchy.
606  * Should be kept portable.
607  *
608  * NOTE that ActiveMenu is set to menu itself if the window is a menu.
609  */
610 struct tagSFG_Window
611 {
612     SFG_Node            Node;
613     int                 ID;                     /* Window's ID number        */
614
615     SFG_Context         Window;                 /* Window and OpenGL context */
616     SFG_WindowState     State;                  /* The window state          */
617     SFG_Proc            CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
618     void               *UserData ;              /* For use by user           */
619
620     SFG_Menu*       Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window  */
621     SFG_Menu*       ActiveMenu;                 /* The window's active menu  */
622
623     SFG_Window*         Parent;                 /* The parent to this window */
624     SFG_List            Children;               /* The subwindows d.l. list  */
625
626     GLboolean           IsMenu;                 /* Set to 1 if we are a menu */
627 };
628
629
630 /* A linked list structure of windows */
631 typedef struct tagSFG_WindowList SFG_WindowList ;
632 struct tagSFG_WindowList
633 {
634     SFG_Node node;
635     SFG_Window *window ;
636 };
637
638 /* This holds information about all the windows, menus etc. */
639 typedef struct tagSFG_Structure SFG_Structure;
640 struct tagSFG_Structure
641 {
642     SFG_List        Windows;         /* The global windows list            */
643     SFG_List        Menus;           /* The global menus list              */
644     SFG_List        WindowsToDestroy;
645
646     SFG_Window*     CurrentWindow;   /* The currently set window          */
647     SFG_Menu*       CurrentMenu;     /* Same, but menu...                 */
648
649     SFG_MenuContext* MenuContext;    /* OpenGL rendering context for menus */
650
651     SFG_Window*      GameModeWindow; /* The game mode window               */
652
653     int              WindowID;       /* The window ID for the next window to be created */
654     int              MenuID;         /* The menu ID for the next menu to be created */
655 };
656
657 /*
658  * This structure is used for the enumeration purposes.
659  * You can easily extend its functionalities by declaring
660  * a structure containing enumerator's contents and custom
661  * data, then casting its pointer to (SFG_Enumerator *).
662  */
663 typedef struct tagSFG_Enumerator SFG_Enumerator;
664 struct tagSFG_Enumerator
665 {
666     GLboolean   found;                          /* Used to terminate search  */
667     void*       data;                           /* Custom data pointer       */
668 };
669 typedef void (* FGCBWindowEnumerator  )( SFG_Window *, SFG_Enumerator * );
670 typedef void (* FGCBMenuEnumerator  )( SFG_Menu *, SFG_Enumerator * );
671
672 /* The bitmap font structure */
673 typedef struct tagSFG_Font SFG_Font;
674 struct tagSFG_Font
675 {
676     char*           Name;         /* The source font name             */
677     int             Quantity;     /* Number of chars in font          */
678     int             Height;       /* Height of the characters         */
679     const GLubyte** Characters;   /* The characters mapping           */
680
681     float           xorig, yorig; /* Relative origin of the character */
682 };
683
684 /* The stroke font structures */
685
686 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
687 struct tagSFG_StrokeVertex
688 {
689     GLfloat         X, Y;
690 };
691
692 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
693 struct tagSFG_StrokeStrip
694 {
695     int             Number;
696     const SFG_StrokeVertex* Vertices;
697 };
698
699 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
700 struct tagSFG_StrokeChar
701 {
702     GLfloat         Right;
703     int             Number;
704     const SFG_StrokeStrip* Strips;
705 };
706
707 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
708 struct tagSFG_StrokeFont
709 {
710     char*           Name;                       /* The source font name      */
711     int             Quantity;                   /* Number of chars in font   */
712     GLfloat         Height;                     /* Height of the characters  */
713     const SFG_StrokeChar** Characters;          /* The characters mapping    */
714 };
715
716
717 /* -- JOYSTICK-SPECIFIC STRUCTURES AND TYPES ------------------------------- */
718 /*
719  * Initial defines from "js.h" starting around line 33 with the existing "freeglut_joystick.c"
720  * interspersed
721  */
722
723 #if TARGET_HOST_MACINTOSH
724 #    include <InputSprocket.h>
725 #endif
726
727 #if TARGET_HOST_MAC_OSX
728 #    include <mach/mach.h>
729 #    include <IOKit/IOkitLib.h>
730 #    include <IOKit/hid/IOHIDLib.h>
731 #endif
732
733 /* XXX It might be better to poll the operating system for the numbers of buttons and
734  * XXX axes and then dynamically allocate the arrays.
735  */
736 #define _JS_MAX_BUTTONS 32
737
738 #if TARGET_HOST_MACINTOSH
739 #    define _JS_MAX_AXES  9
740 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
741 struct tagSFG_PlatformJoystick
742 {
743 #define  ISP_NUM_AXIS    9
744 #define  ISP_NUM_NEEDS  41
745     ISpElementReference isp_elem  [ ISP_NUM_NEEDS ];
746     ISpNeed             isp_needs [ ISP_NUM_NEEDS ];
747 };
748 #endif
749
750 #if TARGET_HOST_MAC_OSX
751 #    define _JS_MAX_AXES 16
752 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
753 struct tagSFG_PlatformJoystick
754 {
755     IOHIDDeviceInterface ** hidDev;
756     IOHIDElementCookie buttonCookies[41];
757     IOHIDElementCookie axisCookies[_JS_MAX_AXES];
758 /* The next two variables are not used anywhere */
759 /*    long minReport[_JS_MAX_AXES],
760  *         maxReport[_JS_MAX_AXES];
761  */
762 };
763 #endif
764
765
766 /*
767  * Definition of "SFG_Joystick" structure -- based on JS's "jsJoystick" object class.
768  * See "js.h" lines 80-178.
769  */
770 typedef struct tagSFG_Joystick SFG_Joystick;
771 struct tagSFG_Joystick
772 {
773         SFG_PlatformJoystick pJoystick;
774
775     int          id;
776     GLboolean    error;
777     char         name [ 128 ];
778     int          num_axes;
779     int          num_buttons;
780
781     float dead_band[ _JS_MAX_AXES ];
782     float saturate [ _JS_MAX_AXES ];
783     float center   [ _JS_MAX_AXES ];
784     float max      [ _JS_MAX_AXES ];
785     float min      [ _JS_MAX_AXES ];
786 };
787
788
789
790 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
791
792 /* Freeglut display related stuff (initialized once per session) */
793 extern SFG_Display fgDisplay;
794
795 /* Freeglut internal structure */
796 extern SFG_Structure fgStructure;
797
798 /* The current freeglut settings */
799 extern SFG_State fgState;
800
801
802 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
803
804 /*
805  * A call to this function makes us sure that the Display and Structure
806  * subsystems have been properly initialized and are ready to be used
807  */
808 #define  FREEGLUT_EXIT_IF_NOT_INITIALISED( string )               \
809   if ( ! fgState.Initialised )                                    \
810   {                                                               \
811     fgError ( " ERROR:  Function <%s> called"                     \
812               " without first calling 'glutInit'.", (string) ) ;  \
813   }
814
815 #define  FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string )  \
816   if ( ! fgState.Initialised )                                      \
817   {                                                                 \
818     fgError ( " ERROR:  Internal <%s> function called"              \
819               " without first calling 'glutInit'.", (string) ) ;    \
820   }
821
822 #define  FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function )  \
823   if ( ! ( cond ) )                                              \
824   {                                                              \
825     fgError ( " ERROR:  Internal error <%s> in function %s",     \
826               (string), (function) ) ;                           \
827   }
828
829 /*
830  * Following definitions are somewhat similiar to GLib's,
831  * but do not generate any log messages:
832  */
833 #define  freeglut_return_if_fail( expr ) \
834     if( !(expr) )                        \
835         return;
836 #define  freeglut_return_val_if_fail( expr, val ) \
837     if( !(expr) )                                 \
838         return val ;
839
840 /*
841  * A call to those macros assures us that there is a current
842  * window set, respectively:
843  */
844 #define  FREEGLUT_EXIT_IF_NO_WINDOW( string )                               \
845   if ( ! fgStructure.CurrentWindow &&                                       \
846        ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION ) )  \
847   {                                                                         \
848     fgError ( " ERROR:  Function <%s> called"                               \
849               " with no current window defined.", (string) ) ;              \
850   }
851
852 /*
853  * The deinitialize function gets called on glutMainLoop() end. It should clean up
854  * everything inside of the freeglut
855  */
856 void fgDeinitialize( void );
857
858 /*
859  * Those two functions are used to create/destroy the freeglut internal
860  * structures. This actually happens when calling glutInit() and when
861  * quitting the glutMainLoop() (which actually happens, when all windows
862  * have been closed).
863  */
864 void fgCreateStructure( void );
865 void fgDestroyStructure( void );
866
867 /*
868  * Window creation, opening, closing and destruction.
869  * Also CallBack clearing/initialization.
870  * Defined in freeglut_structure.c, freeglut_window.c.
871  */
872 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
873                             GLboolean positionUse, int x, int y,
874                             GLboolean sizeUse, int w, int h,
875                             GLboolean gameMode, GLboolean isMenu );
876 void        fgSetWindow ( SFG_Window *window );
877 void        fgOpenWindow( SFG_Window* window, const char* title,
878                           GLboolean positionUse, int x, int y,
879                           GLboolean sizeUse, int w, int h,
880                           GLboolean gameMode, GLboolean isSubWindow );
881 void        fgCloseWindow( SFG_Window* window );
882 void        fgAddToWindowDestroyList ( SFG_Window* window );
883 void        fgCloseWindows ();
884 void        fgDestroyWindow( SFG_Window* window );
885
886 /* Menu creation and destruction. Defined in freeglut_structure.c */
887 SFG_Menu*   fgCreateMenu( FGCBMenu menuCallback );
888 void        fgDestroyMenu( SFG_Menu* menu );
889
890 /* Joystick device management functions, defined in freeglut_joystick.c */
891 int         fgJoystickDetect( void );
892 void        fgInitialiseJoysticks( void );
893 void        fgJoystickClose( void );
894 void        fgJoystickPollWindow( SFG_Window* window );
895
896 /* InputDevice Initialisation and Closure */
897 int         fgInputDeviceDetect( void );
898 void        fgInitialiseInputDevices( void );
899 void        fgInputDeviceClose( void );
900
901 /* spaceball device functions, defined in freeglut_spaceball.c */
902 void        fgInitialiseSpaceball( void );
903 void        fgSpaceballClose( void );
904 void        fgSpaceballSetWindow( SFG_Window *window );
905
906 int         fgHasSpaceball( void );
907 int         fgSpaceballNumButtons( void );
908
909 /* Setting the cursor for a given window */
910 void fgSetCursor ( SFG_Window *window, int cursorID );
911
912 /*
913  * Helper function to enumerate through all registered windows
914  * and one to enumerate all of a window's subwindows...
915  *
916  * The GFunc callback for those functions will be defined as:
917  *
918  *      void enumCallback( gpointer window, gpointer enumerator );
919  *
920  * where window is the enumerated (sub)window pointer (SFG_Window *),
921  * and userData is the a custom user-supplied pointer. Functions
922  * are defined and exported from freeglut_structure.c file.
923  */
924 void fgEnumWindows( FGCBWindowEnumerator enumCallback, SFG_Enumerator* enumerator );
925 void fgEnumSubWindows( SFG_Window* window, FGCBWindowEnumerator enumCallback,
926                        SFG_Enumerator* enumerator );
927
928 /*
929  * fgWindowByHandle returns a (SFG_Window *) value pointing to the
930  * first window in the queue matching the specified window handle.
931  * The function is defined in freeglut_structure.c file.
932  */
933 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
934
935 /*
936  * This function is similiar to the previous one, except it is
937  * looking for a specified (sub)window identifier. The function
938  * is defined in freeglut_structure.c file.
939  */
940 SFG_Window* fgWindowByID( int windowID );
941
942 /*
943  * Looks up a menu given its ID. This is easier than fgWindowByXXX
944  * as all menus are placed in a single doubly linked list...
945  */
946 SFG_Menu* fgMenuByID( int menuID );
947
948 /*
949  * Returns active menu, if any. Assumption: only one menu active throughout application at any one time.
950  * This is easier than fgWindowByXXX as all menus are placed in one doubly linked list...
951  */
952 SFG_Menu* fgGetActiveMenu( );
953
954 /*
955  * The menu activation and deactivation the code. This is the meat
956  * of the menu user interface handling code...
957  */
958 void fgUpdateMenuHighlight ( SFG_Menu *menu );
959 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
960                               int mouse_x, int mouse_y );
961 void fgDeactivateMenu( SFG_Window *window );
962
963 /*
964  * This function gets called just before the buffers swap, so that
965  * freeglut can display the pull-down menus via OpenGL. The function
966  * is defined in freeglut_menu.c file.
967  */
968 void fgDisplayMenu( void );
969
970 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
971 fg_time_t fgElapsedTime( void );
972
973 /* System time in milliseconds */
974 fg_time_t fgSystemTime(void);
975
976 /* List functions */
977 void fgListInit(SFG_List *list);
978 void fgListAppend(SFG_List *list, SFG_Node *node);
979 void fgListRemove(SFG_List *list, SFG_Node *node);
980 int fgListLength(SFG_List *list);
981 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
982
983 /* Error Message functions */
984 void fgError( const char *fmt, ... );
985 void fgWarning( const char *fmt, ... );
986
987 SFG_Proc fgPlatformGetProcAddress( const char *procName );
988
989 /* pushing attribute/value pairs into an array */
990 #define ATTRIB(a) attributes[where++]=(a)
991 #define ATTRIB_VAL(a,v) {ATTRIB(a); ATTRIB(v);}
992
993 int fghMapBit( int mask, int from, int to );
994 int fghIsLegacyContextRequested( void );
995 void fghContextCreationError( void );
996 int fghNumberOfAuxBuffersRequested( void );
997
998 #endif /* FREEGLUT_INTERNAL_H */
999
1000 /*** END OF FILE ***/