git.mutantstargoat.com Git - freeglut/blob - 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 (* FGCBVisibility    )( int );
 195 typedef void (* FGCBKeyboard      )( unsigned char, int, int );
 196 typedef void (* FGCBSpecial       )( int, int, int );
 197 typedef void (* FGCBMouse         )( int, int, int, int );
 198 typedef void (* FGCBMouseWheel    )( int, int, int, int );
 199 typedef void (* FGCBMotion        )( int, int );
 200 typedef void (* FGCBPassive       )( int, int );
 201 typedef void (* FGCBEntry         )( int );
 202 typedef void (* FGCBWindowStatus  )( int );
 203 typedef void (* FGCBSelect        )( int, int, int );
 204 typedef void (* FGCBJoystick      )( unsigned int, int, int, int );
 205 typedef void (* FGCBKeyboardUp    )( unsigned char, int, int );
 206 typedef void (* FGCBSpecialUp     )( 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 );
 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 -- 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     GLint attribute_v_coord;
 375     GLint attribute_v_normal;
 376 };
 377
 378
 379 typedef struct tagSFG_WindowState SFG_WindowState;
 380 struct tagSFG_WindowState
 381 {
 382     /* Note that on Windows, sizes always refer to the client area, thus without the window decorations */
 383     int             Width;              /* Window's width in pixels          */
 384     int             Height;             /* The same about the height         */
 385
 386         SFG_PlatformWindowState pWState;    /* Window width/height (X11) or rectangle/style (Windows) from before a resize */
 387
 388     GLboolean       Redisplay;          /* Do we have to redisplay?          */
 389     GLboolean       Visible;            /* Is the window visible now         */
 390
 391     int             Cursor;             /* The currently selected cursor     */
 392
 393     long            JoystickPollRate;   /* The joystick polling rate         */
 394     fg_time_t       JoystickLastPoll;   /* When the last poll happened       */
 395
 396     int             MouseX, MouseY;     /* The most recent mouse position    */
 397
 398     GLboolean       IgnoreKeyRepeat;    /* Whether to ignore key repeat.     */
 399     GLboolean       KeyRepeating;       /* Currently in repeat mode          */
 400
 401     GLboolean       NeedToResize;       /* Do we need to resize the window?  */
 402
 403     GLboolean       IsFullscreen;       /* is the window fullscreen? */
 404
 405     GLboolean       NeedToInitContext; /* are OpenGL context/resources loaded? */
 406 };
 407
 408
 409 /*
 410  * A generic function pointer.  We should really use the GLUTproc type
 411  * defined in freeglut_ext.h, but if we include that header in this file
 412  * a bunch of other stuff (font-related) blows up!
 413  */
 414 typedef void (*SFG_Proc)();
 415
 416
 417 /*
 418  * SET_WCB() is used as:
 419  *
 420  *     SET_WCB( window, cbname, func );
 421  *
 422  * ...where {window} is the freeglut window to set the callback,
 423  *          {cbname} is the window-specific callback to set,
 424  *          {func} is a function-pointer.
 425  *
 426  * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
 427  * but this can cause warnings because the FETCH_WCB() macro type-
 428  * casts its result, and a type-cast value shouldn't be an lvalue.
 429  *
 430  * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
 431  * and for no other reason.  Since it's hidden in the macro, the
 432  * ugliness is felt to be rather benign.
 433  */
 434 #define SET_WCB(window,cbname,func)                            \
 435 do                                                             \
 436 {                                                              \
 437     if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) )      \
 438         (((window).CallBacks[CB_ ## cbname]) = (SFG_Proc)(func)); \
 439 } while( 0 )
 440
 441 /*
 442  * FETCH_WCB() is used as:
 443  *
 444  *     FETCH_WCB( window, cbname );
 445  *
 446  * ...where {window} is the freeglut window to fetch the callback from,
 447  *          {cbname} is the window-specific callback to fetch.
 448  *
 449  * The result is correctly type-cast to the callback function pointer
 450  * type.
 451  */
 452 #define FETCH_WCB(window,cbname) \
 453     ((window).CallBacks[CB_ ## cbname])
 454
 455 /*
 456  * INVOKE_WCB() is used as:
 457  *
 458  *     INVOKE_WCB( window, cbname, ( arg_list ) );
 459  *
 460  * ...where {window} is the freeglut window,
 461  *          {cbname} is the window-specific callback to be invoked,
 462  *          {(arg_list)} is the parameter list.
 463  *
 464  * The callback is invoked as:
 465  *
 466  *    callback( arg_list );
 467  *
 468  * ...so the parentheses are REQUIRED in the {arg_list}.
 469  *
 470  * NOTE that it does a sanity-check and also sets the
 471  * current window.
 472  *
 473  */
 474 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
 475 #define INVOKE_WCB(window,cbname,arg_list)    \
 476 do                                            \
 477 {                                             \
 478     if( FETCH_WCB( window, cbname ) )         \
 479     {                                         \
 480         FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
 481         fgSetWindow( &window );               \
 482         func arg_list;                        \
 483     }                                         \
 484 } while( 0 )
 485 #else
 486 #define INVOKE_WCB(window,cbname,arg_list)    \
 487 do                                            \
 488 {                                             \
 489     if( FETCH_WCB( window, cbname ) )         \
 490     {                                         \
 491         fgSetWindow( &window );               \
 492         ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
 493     }                                         \
 494 } while( 0 )
 495 #endif
 496
 497 /*
 498  * The window callbacks the user can supply us with. Should be kept portable.
 499  *
 500  * This enumeration provides the freeglut CallBack numbers.
 501  * The symbolic constants are indices into a window's array of
 502  * function callbacks.  The names are formed by splicing a common
 503  * prefix onto the callback's base name.  (This was originally
 504  * done so that an early stage of development could live side-by-
 505  * side with the old callback code.  The old callback code used
 506  * the bare callback's name as a structure member, so I used a
 507  * prefix for the array index name.)
 508  *
 509  * XXX For consistancy, perhaps the prefix should match the
 510  * XXX FETCH* and INVOKE* macro suffices.  I.e., WCB_, rather than
 511  * XXX CB_.
 512  */
 513 enum
 514 {
 515     CB_Display,
 516     CB_Reshape,
 517     CB_Keyboard,
 518     CB_KeyboardUp,
 519     CB_Special,
 520     CB_SpecialUp,
 521     CB_Mouse,
 522     CB_MouseWheel,
 523     CB_Motion,
 524     CB_Passive,
 525     CB_Entry,
 526     CB_Visibility,
 527     CB_WindowStatus,
 528     CB_Joystick,
 529     CB_Destroy,
 530
 531     /* MPX-related */
 532     CB_MultiEntry,
 533     CB_MultiButton,
 534     CB_MultiMotion,
 535     CB_MultiPassive,
 536
 537     /* Mobile platforms LifeCycle */
 538     CB_InitContext,
 539     CB_Pause,
 540     CB_Resume,
 541
 542     /* Presently ignored */
 543     CB_Select,
 544     CB_OverlayDisplay,
 545     CB_SpaceMotion,     /* presently implemented only on UNIX/X11 */
 546     CB_SpaceRotation,   /* presently implemented only on UNIX/X11 */
 547     CB_SpaceButton,     /* presently implemented only on UNIX/X11 */
 548     CB_Dials,
 549     CB_ButtonBox,
 550     CB_TabletMotion,
 551     CB_TabletButton,
 552
 553     /* Always make this the LAST one */
 554     TOTAL_CALLBACKS
 555 };
 556
 557
 558 /* This structure holds the OpenGL rendering context for all the menu windows */
 559 typedef struct tagSFG_MenuContext SFG_MenuContext;
 560 struct tagSFG_MenuContext
 561 {
 562     SFG_WindowContextType MContext;       /* The menu window's WGL context   */
 563 };
 564
 565 /* This structure describes a menu */
 566 typedef struct tagSFG_Window SFG_Window;
 567 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
 568 typedef struct tagSFG_Menu SFG_Menu;
 569 struct tagSFG_Menu
 570 {
 571     SFG_Node            Node;
 572     void               *UserData;     /* User data passed back at callback   */
 573     int                 ID;           /* The global menu ID                  */
 574     SFG_List            Entries;      /* The menu entries list               */
 575     FGCBMenu            Callback;     /* The menu callback                   */
 576     FGCBDestroy         Destroy;      /* Destruction callback                */
 577     GLboolean           IsActive;     /* Is the menu selected?               */
 578     int                 Width;        /* Menu box width in pixels            */
 579     int                 Height;       /* Menu box height in pixels           */
 580     int                 X, Y;         /* Menu box raster position            */
 581
 582     SFG_MenuEntry      *ActiveEntry;  /* Currently active entry in the menu  */
 583     SFG_Window         *Window;       /* Window for menu                     */
 584     SFG_Window         *ParentWindow; /* Window in which the menu is invoked */
 585 };
 586
 587 /* This is a menu entry */
 588 struct tagSFG_MenuEntry
 589 {
 590     SFG_Node            Node;
 591     int                 ID;                     /* The menu entry ID (local) */
 592     int                 Ordinal;                /* The menu's ordinal number */
 593     char*               Text;                   /* The text to be displayed  */
 594     SFG_Menu*           SubMenu;                /* Optional sub-menu tree    */
 595     GLboolean           IsActive;               /* Is the entry highlighted? */
 596     int                 Width;                  /* Label's width in pixels   */
 597 };
 598
 599 /*
 600  * A window, making part of freeglut windows hierarchy.
 601  * Should be kept portable.
 602  *
 603  * NOTE that ActiveMenu is set to menu itself if the window is a menu.
 604  */
 605 struct tagSFG_Window
 606 {
 607     SFG_Node            Node;
 608     int                 ID;                     /* Window's ID number        */
 609
 610     SFG_Context         Window;                 /* Window and OpenGL context */
 611     SFG_WindowState     State;                  /* The window state          */
 612     SFG_Proc            CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
 613     void               *UserData ;              /* For use by user           */
 614
 615     SFG_Menu*       Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window  */
 616     SFG_Menu*       ActiveMenu;                 /* The window's active menu  */
 617
 618     SFG_Window*         Parent;                 /* The parent to this window */
 619     SFG_List            Children;               /* The subwindows d.l. list  */
 620
 621     GLboolean           IsMenu;                 /* Set to 1 if we are a menu */
 622 };
 623
 624
 625 /* A linked list structure of windows */
 626 typedef struct tagSFG_WindowList SFG_WindowList ;
 627 struct tagSFG_WindowList
 628 {
 629     SFG_Node node;
 630     SFG_Window *window ;
 631 };
 632
 633 /* This holds information about all the windows, menus etc. */
 634 typedef struct tagSFG_Structure SFG_Structure;
 635 struct tagSFG_Structure
 636 {
 637     SFG_List        Windows;         /* The global windows list            */
 638     SFG_List        Menus;           /* The global menus list              */
 639     SFG_List        WindowsToDestroy;
 640
 641     SFG_Window*     CurrentWindow;   /* The currently set window          */
 642     SFG_Menu*       CurrentMenu;     /* Same, but menu...                 */
 643
 644     SFG_MenuContext* MenuContext;    /* OpenGL rendering context for menus */
 645
 646     SFG_Window*      GameModeWindow; /* The game mode window               */
 647
 648     int              WindowID;       /* The new current window ID          */
 649     int              MenuID;         /* The new current menu ID            */
 650 };
 651
 652 /*
 653  * This structure is used for the enumeration purposes.
 654  * You can easily extend its functionalities by declaring
 655  * a structure containing enumerator's contents and custom
 656  * data, then casting its pointer to (SFG_Enumerator *).
 657  */
 658 typedef struct tagSFG_Enumerator SFG_Enumerator;
 659 struct tagSFG_Enumerator
 660 {
 661     GLboolean   found;                          /* Used to terminate search  */
 662     void*       data;                           /* Custom data pointer       */
 663 };
 664 typedef void (* FGCBWindowEnumerator  )( SFG_Window *, SFG_Enumerator * );
 665 typedef void (* FGCBMenuEnumerator  )( SFG_Menu *, SFG_Enumerator * );
 666
 667 /* The bitmap font structure */
 668 typedef struct tagSFG_Font SFG_Font;
 669 struct tagSFG_Font
 670 {
 671     char*           Name;         /* The source font name             */
 672     int             Quantity;     /* Number of chars in font          */
 673     int             Height;       /* Height of the characters         */
 674     const GLubyte** Characters;   /* The characters mapping           */
 675
 676     float           xorig, yorig; /* Relative origin of the character */
 677 };
 678
 679 /* The stroke font structures */
 680
 681 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
 682 struct tagSFG_StrokeVertex
 683 {
 684     GLfloat         X, Y;
 685 };
 686
 687 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
 688 struct tagSFG_StrokeStrip
 689 {
 690     int             Number;
 691     const SFG_StrokeVertex* Vertices;
 692 };
 693
 694 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
 695 struct tagSFG_StrokeChar
 696 {
 697     GLfloat         Right;
 698     int             Number;
 699     const SFG_StrokeStrip* Strips;
 700 };
 701
 702 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
 703 struct tagSFG_StrokeFont
 704 {
 705     char*           Name;                       /* The source font name      */
 706     int             Quantity;                   /* Number of chars in font   */
 707     GLfloat         Height;                     /* Height of the characters  */
 708     const SFG_StrokeChar** Characters;          /* The characters mapping    */
 709 };
 710
 711
 712 /* -- JOYSTICK-SPECIFIC STRUCTURES AND TYPES ------------------------------- */
 713 /*
 714  * Initial defines from "js.h" starting around line 33 with the existing "freeglut_joystick.c"
 715  * interspersed
 716  */
 717
 718 #if TARGET_HOST_MACINTOSH
 719 #    include <InputSprocket.h>
 720 #endif
 721
 722 #if TARGET_HOST_MAC_OSX
 723 #    include <mach/mach.h>
 724 #    include <IOKit/IOkitLib.h>
 725 #    include <IOKit/hid/IOHIDLib.h>
 726 #endif
 727
 728 /* XXX It might be better to poll the operating system for the numbers of buttons and
 729  * XXX axes and then dynamically allocate the arrays.
 730  */
 731 #define _JS_MAX_BUTTONS 32
 732
 733 #if TARGET_HOST_MACINTOSH
 734 #    define _JS_MAX_AXES  9
 735 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
 736 struct tagSFG_PlatformJoystick
 737 {
 738 #define  ISP_NUM_AXIS    9
 739 #define  ISP_NUM_NEEDS  41
 740     ISpElementReference isp_elem  [ ISP_NUM_NEEDS ];
 741     ISpNeed             isp_needs [ ISP_NUM_NEEDS ];
 742 };
 743 #endif
 744
 745 #if TARGET_HOST_MAC_OSX
 746 #    define _JS_MAX_AXES 16
 747 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
 748 struct tagSFG_PlatformJoystick
 749 {
 750     IOHIDDeviceInterface ** hidDev;
 751     IOHIDElementCookie buttonCookies[41];
 752     IOHIDElementCookie axisCookies[_JS_MAX_AXES];
 753 /* The next two variables are not used anywhere */
 754 /*    long minReport[_JS_MAX_AXES],
 755  *         maxReport[_JS_MAX_AXES];
 756  */
 757 };
 758 #endif
 759
 760
 761 /*
 762  * Definition of "SFG_Joystick" structure -- based on JS's "jsJoystick" object class.
 763  * See "js.h" lines 80-178.
 764  */
 765 typedef struct tagSFG_Joystick SFG_Joystick;
 766 struct tagSFG_Joystick
 767 {
 768         SFG_PlatformJoystick pJoystick;
 769
 770     int          id;
 771     GLboolean    error;
 772     char         name [ 128 ];
 773     int          num_axes;
 774     int          num_buttons;
 775
 776     float dead_band[ _JS_MAX_AXES ];
 777     float saturate [ _JS_MAX_AXES ];
 778     float center   [ _JS_MAX_AXES ];
 779     float max      [ _JS_MAX_AXES ];
 780     float min      [ _JS_MAX_AXES ];
 781 };
 782
 783
 784
 785 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
 786
 787 /* Freeglut display related stuff (initialized once per session) */
 788 extern SFG_Display fgDisplay;
 789
 790 /* Freeglut internal structure */
 791 extern SFG_Structure fgStructure;
 792
 793 /* The current freeglut settings */
 794 extern SFG_State fgState;
 795
 796
 797 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
 798
 799 /*
 800  * A call to this function makes us sure that the Display and Structure
 801  * subsystems have been properly initialized and are ready to be used
 802  */
 803 #define  FREEGLUT_EXIT_IF_NOT_INITIALISED( string )               \
 804   if ( ! fgState.Initialised )                                    \
 805   {                                                               \
 806     fgError ( " ERROR:  Function <%s> called"                     \
 807               " without first calling 'glutInit'.", (string) ) ;  \
 808   }
 809
 810 #define  FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string )  \
 811   if ( ! fgState.Initialised )                                      \
 812   {                                                                 \
 813     fgError ( " ERROR:  Internal <%s> function called"              \
 814               " without first calling 'glutInit'.", (string) ) ;    \
 815   }
 816
 817 #define  FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function )  \
 818   if ( ! ( cond ) )                                              \
 819   {                                                              \
 820     fgError ( " ERROR:  Internal error <%s> in function %s",     \
 821               (string), (function) ) ;                           \
 822   }
 823
 824 /*
 825  * Following definitions are somewhat similiar to GLib's,
 826  * but do not generate any log messages:
 827  */
 828 #define  freeglut_return_if_fail( expr ) \
 829     if( !(expr) )                        \
 830         return;
 831 #define  freeglut_return_val_if_fail( expr, val ) \
 832     if( !(expr) )                                 \
 833         return val ;
 834
 835 /*
 836  * A call to those macros assures us that there is a current
 837  * window set, respectively:
 838  */
 839 #define  FREEGLUT_EXIT_IF_NO_WINDOW( string )                               \
 840   if ( ! fgStructure.CurrentWindow &&                                       \
 841        ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION ) )  \
 842   {                                                                         \
 843     fgError ( " ERROR:  Function <%s> called"                               \
 844               " with no current window defined.", (string) ) ;              \
 845   }
 846
 847 /*
 848  * The deinitialize function gets called on glutMainLoop() end. It should clean up
 849  * everything inside of the freeglut
 850  */
 851 void fgDeinitialize( void );
 852
 853 /*
 854  * Those two functions are used to create/destroy the freeglut internal
 855  * structures. This actually happens when calling glutInit() and when
 856  * quitting the glutMainLoop() (which actually happens, when all windows
 857  * have been closed).
 858  */
 859 void fgCreateStructure( void );
 860 void fgDestroyStructure( void );
 861
 862 /*
 863  * Window creation, opening, closing and destruction.
 864  * Also CallBack clearing/initialization.
 865  * Defined in freeglut_structure.c, freeglut_window.c.
 866  */
 867 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
 868                             GLboolean positionUse, int x, int y,
 869                             GLboolean sizeUse, int w, int h,
 870                             GLboolean gameMode, GLboolean isMenu );
 871 void        fgSetWindow ( SFG_Window *window );
 872 void        fgOpenWindow( SFG_Window* window, const char* title,
 873                           GLboolean positionUse, int x, int y,
 874                           GLboolean sizeUse, int w, int h,
 875                           GLboolean gameMode, GLboolean isSubWindow );
 876 void        fgCloseWindow( SFG_Window* window );
 877 void        fgAddToWindowDestroyList ( SFG_Window* window );
 878 void        fgCloseWindows ();
 879 void        fgDestroyWindow( SFG_Window* window );
 880
 881 /* Menu creation and destruction. Defined in freeglut_structure.c */
 882 SFG_Menu*   fgCreateMenu( FGCBMenu menuCallback );
 883 void        fgDestroyMenu( SFG_Menu* menu );
 884
 885 /* Joystick device management functions, defined in freeglut_joystick.c */
 886 int         fgJoystickDetect( void );
 887 void        fgInitialiseJoysticks( void );
 888 void        fgJoystickClose( void );
 889 void        fgJoystickPollWindow( SFG_Window* window );
 890
 891 /* InputDevice Initialisation and Closure */
 892 int         fgInputDeviceDetect( void );
 893 void        fgInitialiseInputDevices( void );
 894 void        fgInputDeviceClose( void );
 895
 896 /* spaceball device functions, defined in freeglut_spaceball.c */
 897 void        fgInitialiseSpaceball( void );
 898 void        fgSpaceballClose( void );
 899 void        fgSpaceballSetWindow( SFG_Window *window );
 900
 901 int         fgHasSpaceball( void );
 902 int         fgSpaceballNumButtons( void );
 903
 904 /* Setting the cursor for a given window */
 905 void fgSetCursor ( SFG_Window *window, int cursorID );
 906
 907 /*
 908  * Helper function to enumerate through all registered windows
 909  * and one to enumerate all of a window's subwindows...
 910  *
 911  * The GFunc callback for those functions will be defined as:
 912  *
 913  *      void enumCallback( gpointer window, gpointer enumerator );
 914  *
 915  * where window is the enumerated (sub)window pointer (SFG_Window *),
 916  * and userData is the a custom user-supplied pointer. Functions
 917  * are defined and exported from freeglut_structure.c file.
 918  */
 919 void fgEnumWindows( FGCBWindowEnumerator enumCallback, SFG_Enumerator* enumerator );
 920 void fgEnumSubWindows( SFG_Window* window, FGCBWindowEnumerator enumCallback,
 921                        SFG_Enumerator* enumerator );
 922
 923 /*
 924  * fgWindowByHandle returns a (SFG_Window *) value pointing to the
 925  * first window in the queue matching the specified window handle.
 926  * The function is defined in freeglut_structure.c file.
 927  */
 928 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
 929
 930 /*
 931  * This function is similiar to the previous one, except it is
 932  * looking for a specified (sub)window identifier. The function
 933  * is defined in freeglut_structure.c file.
 934  */
 935 SFG_Window* fgWindowByID( int windowID );
 936
 937 /*
 938  * Looks up a menu given its ID. This is easier than fgWindowByXXX
 939  * as all menus are placed in a single doubly linked list...
 940  */
 941 SFG_Menu* fgMenuByID( int menuID );
 942
 943 /*
 944  * Returns active menu, if any. Assumption: only one menu active throughout application at any one time.
 945  * This is easier than fgWindowByXXX as all menus are placed in one doubly linked list...
 946  */
 947 SFG_Menu* fgGetActiveMenu( );
 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 fg_time_t fgElapsedTime( void );
 967
 968 /* System time in milliseconds */
 969 fg_time_t 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 SFG_Proc fgPlatformGetProcAddress( const char *procName );
 983
 984 /* pushing attribute/value pairs into an array */
 985 #define ATTRIB(a) attributes[where++]=(a)
 986 #define ATTRIB_VAL(a,v) {ATTRIB(a); ATTRIB(v);}
 987
 988 int fghMapBit( int mask, int from, int to );
 989 int fghIsLegacyContextRequested( void );
 990 void fghContextCreationError( void );
 991 int fghNumberOfAuxBuffersRequested( void );
 992
 993 #endif /* FREEGLUT_INTERNAL_H */
 994
 995 /*** END OF FILE ***/