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