git.mutantstargoat.com Git - freeglut/blob - src/freeglut_internal.h

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