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