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