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