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