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