git.mutantstargoat.com Git - freeglut/blob - src/fg_internal.h

   1 /*
   2  * fg_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 #include "fg_version.h"
  36
  37 /* Freeglut is intended to function under all Unix/X11 and Win32 platforms. */
  38 /* XXX: Don't all MS-Windows compilers (except Cygwin) have _WIN32 defined?
  39  * XXX: If so, remove the first set of defined()'s below.
  40  */
  41 #if !defined(TARGET_HOST_POSIX_X11) && !defined(TARGET_HOST_MS_WINDOWS) && !defined(TARGET_HOST_MAC_OSX) && !defined(TARGET_HOST_SOLARIS)
  42 #if defined(_MSC_VER) || defined(__WATCOMC__) || defined(__MINGW32__) \
  43     || defined(_WIN32) || defined(_WIN32_WCE) \
  44     || ( defined(__CYGWIN__) && defined(X_DISPLAY_MISSING) )
  45 #   define  TARGET_HOST_MS_WINDOWS 1
  46
  47 #elif defined (__ANDROID__)
  48 #   define  TARGET_HOST_ANDROID  1
  49
  50 #elif defined (__QNXNTO__) || defined (__PLAYBOOK__)
  51 #   define  TARGET_HOST_BLACKBERRY  1
  52
  53 #elif defined(__posix__) || defined(__unix__) || defined(__linux__) || defined(__sun)
  54 #   define  TARGET_HOST_POSIX_X11  1
  55
  56 #elif defined(__APPLE__)
  57 /* This is a placeholder until we get native OSX support ironed out -- JFF 11/18/09 */
  58 #   define  TARGET_HOST_POSIX_X11  1
  59 /* #   define  TARGET_HOST_MAC_OSX    1 */
  60
  61 #else
  62 #   error "Unrecognized target host!"
  63
  64 #endif
  65 #endif
  66
  67 /* Detect both SunPro and gcc compilers on Sun Solaris */
  68 #if defined (__SVR4) && defined (__sun)
  69 #   define TARGET_HOST_SOLARIS 1
  70 #endif
  71
  72 #ifndef TARGET_HOST_MS_WINDOWS
  73 #   define  TARGET_HOST_MS_WINDOWS 0
  74 #endif
  75
  76 #ifndef TARGET_HOST_ANDROID
  77 #   define  TARGET_HOST_ANDROID    0
  78 #endif
  79
  80 #ifndef TARGET_HOST_BLACKBERRY
  81 #   define  TARGET_HOST_BLACKBERRY 0
  82 #endif
  83
  84 #ifndef  TARGET_HOST_POSIX_X11
  85 #   define  TARGET_HOST_POSIX_X11  0
  86 #endif
  87
  88 #ifndef  TARGET_HOST_MAC_OSX
  89 #   define  TARGET_HOST_MAC_OSX    0
  90 #endif
  91
  92 #ifndef  TARGET_HOST_SOLARIS
  93 #   define  TARGET_HOST_SOLARIS    0
  94 #endif
  95
  96 /* -- FIXED CONFIGURATION LIMITS ------------------------------------------- */
  97
  98 #define  FREEGLUT_MAX_MENUS         3
  99
 100 /* These files should be available on every platform. */
 101 #include <stdio.h>
 102 #include <string.h>
 103 #include <math.h>
 104 #include <stdlib.h>
 105 #include <stdarg.h>
 106
 107 /* These are included based on autoconf directives. */
 108 #ifdef HAVE_SYS_TYPES_H
 109 #    include <sys/types.h>
 110 #endif
 111 #ifdef HAVE_UNISTD_H
 112 #    include <unistd.h>
 113 #endif
 114 #ifdef TIME_WITH_SYS_TIME
 115 #    include <sys/time.h>
 116 #    include <time.h>
 117 #elif defined(HAVE_SYS_TIME_H)
 118 #    include <sys/time.h>
 119 #else
 120 #    include <time.h>
 121 #endif
 122
 123 /* -- AUTOCONF HACKS --------------------------------------------------------*/
 124
 125 /* XXX: Update autoconf to avoid these.
 126  * XXX: Are non-POSIX platforms intended not to use autoconf?
 127  * If so, perhaps there should be a config_guess.h for them. Alternatively,
 128  * config guesses could be placed above, just after the config.h exclusion.
 129  */
 130 #if defined(__FreeBSD__) || defined(__NetBSD__)
 131 #    define HAVE_USB_JS 1
 132 #    if defined(__NetBSD__) || ( defined(__FreeBSD__) && __FreeBSD_version >= 500000)
 133 #        define HAVE_USBHID_H 1
 134 #    endif
 135 #endif
 136
 137 #if defined(_MSC_VER) || defined(__WATCOMC__)
 138 /* strdup() is non-standard, for all but POSIX-2001 */
 139 #define strdup   _strdup
 140 #endif
 141
 142 /* M_PI is non-standard (defined by BSD, not ISO-C) */
 143 #ifndef M_PI
 144 #    define  M_PI  3.14159265358979323846
 145 #endif
 146
 147 #ifdef HAVE_STDBOOL_H
 148 #    include <stdbool.h>
 149 #    ifndef TRUE
 150 #        define TRUE true
 151 #    endif
 152 #    ifndef FALSE
 153 #        define FALSE false
 154 #    endif
 155 #else
 156 #    ifndef TRUE
 157 #        define  TRUE  1
 158 #    endif
 159 #    ifndef FALSE
 160 #        define  FALSE  0
 161 #    endif
 162 #endif
 163
 164 /* General defines */
 165 #define INVALID_MODIFIERS 0xffffffff
 166
 167 /* FreeGLUT internal time type */
 168 #if defined(HAVE_STDINT_H)
 169 #   include <stdint.h>
 170     typedef uint64_t fg_time_t;
 171 #elif defined(HAVE_INTTYPES_H)
 172 #   include <inttypes.h>
 173     typedef uint64_t fg_time_t;
 174 #elif defined(HAVE_U__INT64)
 175     typedef unsigned __int64 fg_time_t;
 176 #elif defined(HAVE_ULONG_LONG)
 177     typedef unsigned long long fg_time_t;
 178 #else
 179     typedef unsigned long fg_time_t;
 180 #endif
 181
 182 #ifndef __fg_unused
 183 # ifdef __GNUC__
 184 #  define __fg_unused __attribute__((unused))
 185 # else
 186 #  define __fg_unused
 187 # endif
 188 #endif
 189
 190 /* Platform-specific includes */
 191 #if TARGET_HOST_POSIX_X11
 192 #include "x11/fg_internal_x11.h"
 193 #endif
 194 #if TARGET_HOST_MS_WINDOWS
 195 #include "mswin/fg_internal_mswin.h"
 196 #endif
 197 #if TARGET_HOST_ANDROID
 198 #include "android/fg_internal_android.h"
 199 #endif
 200 #if TARGET_HOST_BLACKBERRY
 201 #include "blackberry/fg_internal_blackberry.h"
 202 #endif
 203
 204
 205 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
 206
 207 /* Freeglut callbacks type definitions */
 208 typedef void (* FGCBDisplay       )( void );
 209 typedef void (* FGCBReshape       )( int, int );
 210 typedef void (* FGCBPosition      )( int, int );
 211 typedef void (* FGCBVisibility    )( int );
 212 typedef void (* FGCBKeyboard      )( unsigned char, int, int );
 213 typedef void (* FGCBKeyboardUp    )( unsigned char, int, int );
 214 typedef void (* FGCBSpecial       )( int, int, int );
 215 typedef void (* FGCBSpecialUp     )( int, int, int );
 216 typedef void (* FGCBMouse         )( int, int, int, int );
 217 typedef void (* FGCBMouseWheel    )( int, int, int, int );
 218 typedef void (* FGCBMotion        )( int, int );
 219 typedef void (* FGCBPassive       )( int, int );
 220 typedef void (* FGCBEntry         )( int );
 221 typedef void (* FGCBWindowStatus  )( int );
 222 typedef void (* FGCBJoystick      )( unsigned int, int, int, int );
 223 typedef void (* FGCBOverlayDisplay)( void );
 224 typedef void (* FGCBSpaceMotion   )( int, int, int );
 225 typedef void (* FGCBSpaceRotation )( int, int, int );
 226 typedef void (* FGCBSpaceButton   )( int, int );
 227 typedef void (* FGCBDials         )( int, int );
 228 typedef void (* FGCBButtonBox     )( int, int );
 229 typedef void (* FGCBTabletMotion  )( int, int );
 230 typedef void (* FGCBTabletButton  )( int, int, int, int );
 231 typedef void (* FGCBDestroy       )( void );    /* Used for both window and menu destroy callbacks */
 232
 233 typedef void (* FGCBMultiEntry   )( int, int );
 234 typedef void (* FGCBMultiButton  )( int, int, int, int, int );
 235 typedef void (* FGCBMultiMotion  )( int, int, int );
 236 typedef void (* FGCBMultiPassive )( int, int, int );
 237
 238 typedef void (* FGCBInitContext)();
 239 typedef void (* FGCBAppStatus)(int);
 240
 241 /* The global callbacks type definitions */
 242 typedef void (* FGCBIdle          )( void );
 243 typedef void (* FGCBTimer         )( int );
 244 typedef void (* FGCBMenuState     )( int );
 245 typedef void (* FGCBMenuStatus    )( int, int, int );
 246
 247 /* The callback used when creating/using menus */
 248 typedef void (* FGCBMenu          )( int );
 249
 250 /* The FreeGLUT error/warning handler type definition */
 251 typedef void (* FGError           ) ( const char *fmt, va_list ap);
 252 typedef void (* FGWarning         ) ( const char *fmt, va_list ap);
 253
 254
 255 /* A list structure */
 256 typedef struct tagSFG_List SFG_List;
 257 struct tagSFG_List
 258 {
 259     void *First;
 260     void *Last;
 261 };
 262
 263 /* A list node structure */
 264 typedef struct tagSFG_Node SFG_Node;
 265 struct tagSFG_Node
 266 {
 267     void *Next;
 268     void *Prev;
 269 };
 270
 271 /* A helper structure holding two ints and a boolean */
 272 typedef struct tagSFG_XYUse SFG_XYUse;
 273 struct tagSFG_XYUse
 274 {
 275     GLint           X, Y;               /* The two integers...               */
 276     GLboolean       Use;                /* ...and a single boolean.          */
 277 };
 278
 279 /*
 280  * An enumeration containing the state of the GLUT execution:
 281  * initializing, running, or stopping
 282  */
 283 typedef enum
 284 {
 285   GLUT_EXEC_STATE_INIT,
 286   GLUT_EXEC_STATE_RUNNING,
 287   GLUT_EXEC_STATE_STOP
 288 } fgExecutionState ;
 289
 290 /* This structure holds different freeglut settings */
 291 typedef struct tagSFG_State SFG_State;
 292 struct tagSFG_State
 293 {
 294     SFG_XYUse        Position;             /* The default windows' position  */
 295     SFG_XYUse        Size;                 /* The default windows' size      */
 296     unsigned int     DisplayMode;          /* Display mode for new windows   */
 297
 298     GLboolean        Initialised;          /* freeglut has been initialised  */
 299
 300     int              DirectContext;        /* Direct rendering state         */
 301
 302     GLboolean        ForceIconic;          /* New top windows are iconified  */
 303     GLboolean        UseCurrentContext;    /* New windows share with current */
 304
 305     GLboolean        GLDebugSwitch;        /* OpenGL state debugging switch  */
 306     GLboolean        XSyncSwitch;          /* X11 sync protocol switch       */
 307
 308     int              KeyRepeat;            /* Global key repeat mode.        */
 309     int              Modifiers;            /* Current ALT/SHIFT/CTRL state   */
 310
 311     GLuint           FPSInterval;          /* Interval between FPS printfs   */
 312     GLuint           SwapCount;            /* Count of glutSwapBuffer calls  */
 313     GLuint           SwapTime;             /* Time of last SwapBuffers       */
 314
 315     fg_time_t        Time;                 /* Time that glutInit was called  */
 316     SFG_List         Timers;               /* The freeglut timer hooks       */
 317     SFG_List         FreeTimers;           /* The unused timer hooks         */
 318
 319     FGCBIdle         IdleCallback;         /* The global idle callback       */
 320
 321     int              ActiveMenus;          /* Num. of currently active menus */
 322     FGCBMenuState    MenuStateCallback;    /* Menu callbacks are global      */
 323     FGCBMenuStatus   MenuStatusCallback;
 324     void*            MenuFont;             /* Font to be used for newly created menus */
 325
 326     SFG_XYUse        GameModeSize;         /* Game mode screen's dimensions  */
 327     int              GameModeDepth;        /* The pixel depth for game mode  */
 328     int              GameModeRefresh;      /* The refresh rate for game mode */
 329
 330     int              ActionOnWindowClose; /* Action when user closes window  */
 331
 332     fgExecutionState ExecState;           /* Used for GLUT termination       */
 333     char            *ProgramName;         /* Name of the invoking program    */
 334     GLboolean        JoysticksInitialised;  /* Only initialize if application calls for them */
 335     int              NumActiveJoysticks;    /* Number of active joysticks (callback defined and positive pollrate) -- if zero, don't poll joysticks */
 336     GLboolean        InputDevsInitialised;  /* Only initialize if application calls for them */
 337
 338         int              MouseWheelTicks;      /* Number of ticks the mouse wheel has turned */
 339
 340     int              AuxiliaryBufferNumber;  /* Number of auxiliary buffers */
 341     int              SampleNumber;         /*  Number of samples per pixel  */
 342
 343     GLboolean        SkipStaleMotion;      /* skip stale motion events */
 344
 345     GLboolean        StrokeFontDrawJoinDots;/* Draw dots between line segments of stroke fonts? */
 346
 347     int              MajorVersion;         /* Major OpenGL context version  */
 348     int              MinorVersion;         /* Minor OpenGL context version  */
 349     int              ContextFlags;         /* OpenGL context flags          */
 350     int              ContextProfile;       /* OpenGL context profile        */
 351     int              HasOpenGL20;          /* fgInitGL2 could find all OpenGL 2.0 functions */
 352     FGError          ErrorFunc;            /* User defined error handler    */
 353     FGWarning        WarningFunc;          /* User defined warning handler  */
 354 };
 355
 356 /* The structure used by display initialization in fg_init.c */
 357 typedef struct tagSFG_Display SFG_Display;
 358 struct tagSFG_Display
 359 {
 360         SFG_PlatformDisplay pDisplay;
 361
 362     int             ScreenWidth;        /* The screen's width in pixels      */
 363     int             ScreenHeight;       /* The screen's height in pixels     */
 364     int             ScreenWidthMM;      /* The screen's width in milimeters  */
 365     int             ScreenHeightMM;     /* The screen's height in milimeters */
 366 };
 367
 368
 369 /* The user can create any number of timer hooks */
 370 typedef struct tagSFG_Timer SFG_Timer;
 371 struct tagSFG_Timer
 372 {
 373     SFG_Node        Node;
 374     int             ID;                 /* The timer ID integer              */
 375     FGCBTimer       Callback;           /* The timer callback                */
 376     fg_time_t       TriggerTime;        /* The timer trigger time            */
 377 };
 378
 379 /*
 380  * A window and its OpenGL context. The contents of this structure
 381  * are highly dependent on the target operating system we aim at...
 382  */
 383 typedef struct tagSFG_Context SFG_Context;
 384 struct tagSFG_Context
 385 {
 386     SFG_WindowHandleType  Handle;    /* The window's handle                 */
 387     SFG_WindowContextType Context;   /* The window's OpenGL/WGL context     */
 388
 389         SFG_PlatformContext pContext;    /* The window's FBConfig (X11) or device context (Windows) */
 390
 391     int             DoubleBuffered;  /* Treat the window as double-buffered */
 392
 393     /* When drawing geometry to vertex attribute buffers, user specifies
 394      * the attribute indices for vertices, normals and/or texture coords
 395      * to freeglut. Those are stored here
 396      */
 397     GLint           attribute_v_coord;
 398     GLint           attribute_v_normal;
 399     GLint           attribute_v_texture;
 400 };
 401
 402
 403 /*
 404  * Bitmasks indicating the different kinds of
 405  * actions that can be scheduled for a window.
 406  */
 407 #define GLUT_INIT_WORK        (1<<0)
 408 #define GLUT_VISIBILITY_WORK  (1<<1)
 409 #define GLUT_POSITION_WORK    (1<<2)
 410 #define GLUT_SIZE_WORK        (1<<3)
 411 #define GLUT_ZORDER_WORK      (1<<4)
 412 #define GLUT_FULL_SCREEN_WORK (1<<5)
 413 #define GLUT_DISPLAY_WORK     (1<<6)
 414
 415 /*
 416  * An enumeration containing the state of the GLUT execution:
 417  * initializing, running, or stopping
 418  */
 419 typedef enum
 420 {
 421   DesireHiddenState,
 422   DesireIconicState,
 423   DesireNormalState
 424 } fgDesiredVisibility ;
 425
 426 /*
 427  *  There is considerable confusion about the "right thing to
 428  *  do" concerning window  size and position.  GLUT itself is
 429  *  not consistent between Windows and UNIX/X11; since
 430  *  platform independence is a virtue for "freeglut", we
 431  *  decided to break with GLUT's behaviour.
 432  *
 433  *  Under UNIX/X11, it is apparently not possible to get the
 434  *  window border sizes in order to subtract them off the
 435  *  window's initial position until some time after the window
 436  *  has been created.  Therefore we decided on the following
 437  *  behaviour, both under Windows and under UNIX/X11:
 438  *  - When you create a window with position (x,y) and size
 439  *    (w,h), the upper left hand corner of the outside of the
 440  *    window is at (x,y) and the size of the drawable area is
 441  *    (w,h).
 442  *  - When you query the size and position of the window--as
 443  *    is happening here for Windows--"freeglut" will return
 444  *    the size of the drawable area--the (w,h) that you
 445  *    specified when you created the window--and the coordinates
 446  *    of the upper left hand corner of the drawable area, i.e.
 447  *    of the client rect--which is NOT the (x,y) you specified.
 448  */
 449 typedef struct tagSFG_WindowState SFG_WindowState;
 450 struct tagSFG_WindowState   /* as per notes above, sizes always refer to the client area (thus without the window decorations) */
 451 {
 452     /* window state - size, position, look */
 453     int             Xpos;               /* Window's top-left of client area, X-coordinate */
 454     int             Ypos;               /* Window's top-left of client area, Y-coordinate */
 455     int             Width;              /* Window's width in pixels          */
 456     int             Height;             /* The same about the height         */
 457     GLboolean       Visible;            /* Is the window visible now? Not using fgVisibilityState as we only care if visible or not */
 458     int             Cursor;             /* The currently selected cursor style */
 459     GLboolean       IsFullscreen;       /* is the window fullscreen?         */
 460
 461     /* FreeGLUT operations are deferred, that is, window moving, resizing,
 462      * Z-order changing, making full screen or not do not happen immediately
 463      * upon the user's request, but only in the next iteration of the main
 464      * loop, before the display callback is called. This allows multiple
 465      * reshape, position, etc requests to be combined into one and is
 466      * compatible with the way GLUT does things. Callbacks get triggered
 467      * based on the feedback/messages/notifications from the window manager.
 468      * Below here we define what work should be done, as well as the relevant
 469      * parameters for this work.
 470      */
 471     unsigned int    WorkMask;           /* work (resize, etc) to be done on the window */
 472     int             DesiredXpos;        /* desired X location */
 473     int             DesiredYpos;        /* desired Y location */
 474     int             DesiredWidth;       /* desired window width */
 475     int             DesiredHeight;      /* desired window height */
 476     int             DesiredZOrder;      /* desired window Z Order position */
 477     fgDesiredVisibility DesiredVisibility;/* desired visibility (hidden, iconic, shown/normal) */
 478
 479         SFG_PlatformWindowState pWState;    /* Window width/height (X11) or rectangle/style (Windows) from before a resize, and other stuff only needed on specific platforms */
 480
 481     long            JoystickPollRate;   /* The joystick polling rate         */
 482     fg_time_t       JoystickLastPoll;   /* When the last poll happened       */
 483
 484     int             MouseX, MouseY;     /* The most recent mouse position    */
 485
 486     GLboolean       IgnoreKeyRepeat;    /* Whether to ignore key repeat.     */
 487
 488     GLboolean       VisualizeNormals;   /* When drawing objects, draw vectors representing the normals as well? */
 489 };
 490
 491
 492 /*
 493  * A generic function pointer.  We should really use the GLUTproc type
 494  * defined in freeglut_ext.h, but if we include that header in this file
 495  * a bunch of other stuff (font-related) blows up!
 496  */
 497 typedef void (*SFG_Proc)();
 498
 499
 500 /*
 501  * SET_WCB() is used as:
 502  *
 503  *     SET_WCB( window, cbname, func );
 504  *
 505  * ...where {window} is the freeglut window to set the callback,
 506  *          {cbname} is the window-specific callback to set,
 507  *          {func} is a function-pointer.
 508  *
 509  * Originally, {FETCH_WCB( ... ) = func} was rather sloppily used,
 510  * but this can cause warnings because the FETCH_WCB() macro type-
 511  * casts its result, and a type-cast value shouldn't be an lvalue.
 512  *
 513  * The {if( FETCH_WCB( ... ) != func )} test is to do type-checking
 514  * and for no other reason.  Since it's hidden in the macro, the
 515  * ugliness is felt to be rather benign.
 516  */
 517 #define SET_WCB(window,cbname,func)                            \
 518 do                                                             \
 519 {                                                              \
 520     if( FETCH_WCB( window, cbname ) != (SFG_Proc)(func) )      \
 521         (((window).CallBacks[WCB_ ## cbname]) = (SFG_Proc)(func)); \
 522 } while( 0 )
 523
 524 /*
 525  * FETCH_WCB() is used as:
 526  *
 527  *     FETCH_WCB( window, cbname );
 528  *
 529  * ...where {window} is the freeglut window to fetch the callback from,
 530  *          {cbname} is the window-specific callback to fetch.
 531  *
 532  * The result is correctly type-cast to the callback function pointer
 533  * type.
 534  */
 535 #define FETCH_WCB(window,cbname) \
 536     ((window).CallBacks[WCB_ ## cbname])
 537
 538 /*
 539  * INVOKE_WCB() is used as:
 540  *
 541  *     INVOKE_WCB( window, cbname, ( arg_list ) );
 542  *
 543  * ...where {window} is the freeglut window,
 544  *          {cbname} is the window-specific callback to be invoked,
 545  *          {(arg_list)} is the parameter list.
 546  *
 547  * The callback is invoked as:
 548  *
 549  *    callback( arg_list );
 550  *
 551  * ...so the parentheses are REQUIRED in the {arg_list}.
 552  *
 553  * NOTE that it does a sanity-check and also sets the
 554  * current window.
 555  *
 556  */
 557 #if TARGET_HOST_MS_WINDOWS && !defined(_WIN32_WCE) /* FIXME: also WinCE? */
 558 #define INVOKE_WCB(window,cbname,arg_list)    \
 559 do                                            \
 560 {                                             \
 561     if( FETCH_WCB( window, cbname ) )         \
 562     {                                         \
 563         FGCB ## cbname func = (FGCB ## cbname)(FETCH_WCB( window, cbname )); \
 564         fgSetWindow( &window );               \
 565         func arg_list;                        \
 566     }                                         \
 567 } while( 0 )
 568 #else
 569 #define INVOKE_WCB(window,cbname,arg_list)    \
 570 do                                            \
 571 {                                             \
 572     if( FETCH_WCB( window, cbname ) )         \
 573     {                                         \
 574         fgSetWindow( &window );               \
 575         ((FGCB ## cbname)FETCH_WCB( window, cbname )) arg_list; \
 576     }                                         \
 577 } while( 0 )
 578 #endif
 579
 580 /*
 581  * The window callbacks the user can supply us with. Should be kept portable.
 582  *
 583  * This enumeration provides the freeglut CallBack numbers.
 584  * The symbolic constants are indices into a window's array of
 585  * function callbacks.  The names are formed by splicing a common
 586  * prefix onto the callback's base name.  (This was originally
 587  * done so that an early stage of development could live side-by-
 588  * side with the old callback code.  The old callback code used
 589  * the bare callback's name as a structure member, so I used a
 590  * prefix for the array index name.)
 591  */
 592 enum
 593 {
 594     WCB_Display,
 595     WCB_Reshape,
 596     WCB_Position,
 597     WCB_Keyboard,
 598     WCB_KeyboardUp,
 599     WCB_Special,
 600     WCB_SpecialUp,
 601     WCB_Mouse,
 602     WCB_MouseWheel,
 603     WCB_Motion,
 604     WCB_Passive,
 605     WCB_Entry,
 606     WCB_Visibility,
 607     WCB_WindowStatus,
 608     WCB_Joystick,
 609     WCB_Destroy,
 610
 611     /* Multi-Pointer X and touch related */
 612     WCB_MultiEntry,
 613     WCB_MultiButton,
 614     WCB_MultiMotion,
 615     WCB_MultiPassive,
 616
 617     /* Mobile platforms LifeCycle */
 618     WCB_InitContext,
 619     WCB_AppStatus,
 620
 621     /* Presently ignored */
 622     WCB_Select,
 623     WCB_OverlayDisplay,
 624     WCB_SpaceMotion,     /* presently implemented only on UNIX/X11 */
 625     WCB_SpaceRotation,   /* presently implemented only on UNIX/X11 */
 626     WCB_SpaceButton,     /* presently implemented only on UNIX/X11 */
 627     WCB_Dials,
 628     WCB_ButtonBox,
 629     WCB_TabletMotion,
 630     WCB_TabletButton,
 631
 632     /* Always make this the LAST one */
 633     TOTAL_CALLBACKS
 634 };
 635
 636
 637 /* This structure holds the OpenGL rendering context for all the menu windows */
 638 typedef struct tagSFG_MenuContext SFG_MenuContext;
 639 struct tagSFG_MenuContext
 640 {
 641     SFG_WindowContextType MContext;       /* The menu window's WGL context   */
 642 };
 643
 644 /* This structure describes a menu */
 645 typedef struct tagSFG_Window SFG_Window;
 646 typedef struct tagSFG_MenuEntry SFG_MenuEntry;
 647 typedef struct tagSFG_Menu SFG_Menu;
 648 struct tagSFG_Menu
 649 {
 650     SFG_Node            Node;
 651     void               *UserData;     /* User data passed back at callback   */
 652     int                 ID;           /* The global menu ID                  */
 653     SFG_List            Entries;      /* The menu entries list               */
 654     FGCBMenu            Callback;     /* The menu callback                   */
 655     FGCBDestroy         Destroy;      /* Destruction callback                */
 656     GLboolean           IsActive;     /* Is the menu selected?               */
 657     void*               Font;         /* Font to be used for displaying this menu */
 658     int                 Width;        /* Menu box width in pixels            */
 659     int                 Height;       /* Menu box height in pixels           */
 660     int                 X, Y;         /* Menu box raster position            */
 661
 662     SFG_MenuEntry      *ActiveEntry;  /* Currently active entry in the menu  */
 663     SFG_Window         *Window;       /* Window for menu                     */
 664     SFG_Window         *ParentWindow; /* Window in which the menu is invoked */
 665 };
 666
 667 /* This is a menu entry */
 668 struct tagSFG_MenuEntry
 669 {
 670     SFG_Node            Node;
 671     int                 ID;                     /* The menu entry ID (local) */
 672     int                 Ordinal;                /* The menu's ordinal number */
 673     char*               Text;                   /* The text to be displayed  */
 674     SFG_Menu*           SubMenu;                /* Optional sub-menu tree    */
 675     GLboolean           IsActive;               /* Is the entry highlighted? */
 676     int                 Width;                  /* Label's width in pixels   */
 677 };
 678
 679 /*
 680  * A window, making part of freeglut windows hierarchy.
 681  * Should be kept portable.
 682  *
 683  * NOTE that ActiveMenu is set to menu itself if the window is a menu.
 684  */
 685 struct tagSFG_Window
 686 {
 687     SFG_Node            Node;
 688     int                 ID;                     /* Window's ID number        */
 689
 690     SFG_Context         Window;                 /* Window and OpenGL context */
 691     SFG_WindowState     State;                  /* The window state          */
 692     SFG_Proc            CallBacks[ TOTAL_CALLBACKS ]; /* Array of window callbacks */
 693     void               *UserData ;              /* For use by user           */
 694
 695     SFG_Menu*       Menu[ FREEGLUT_MAX_MENUS ]; /* Menus appended to window  */
 696     SFG_Menu*       ActiveMenu;                 /* The window's active menu  */
 697
 698     SFG_Window*         Parent;                 /* The parent to this window */
 699     SFG_List            Children;               /* The subwindows d.l. list  */
 700
 701     GLboolean           IsMenu;                 /* Set to 1 if we are a menu */
 702 };
 703
 704
 705 /* A linked list structure of windows */
 706 typedef struct tagSFG_WindowList SFG_WindowList ;
 707 struct tagSFG_WindowList
 708 {
 709     SFG_Node node;
 710     SFG_Window *window ;
 711 };
 712
 713 /* This holds information about all the windows, menus etc. */
 714 typedef struct tagSFG_Structure SFG_Structure;
 715 struct tagSFG_Structure
 716 {
 717     SFG_List        Windows;         /* The global windows list            */
 718     SFG_List        Menus;           /* The global menus list              */
 719     SFG_List        WindowsToDestroy;
 720
 721     SFG_Window*     CurrentWindow;   /* The currently set window          */
 722     SFG_Menu*       CurrentMenu;     /* Same, but menu...                 */
 723
 724     SFG_MenuContext* MenuContext;    /* OpenGL rendering context for menus */
 725
 726     SFG_Window*      GameModeWindow; /* The game mode window               */
 727
 728     int              WindowID;       /* The window ID for the next window to be created */
 729     int              MenuID;         /* The menu ID for the next menu to be created */
 730 };
 731
 732 /*
 733  * This structure is used for the enumeration purposes.
 734  * You can easily extend its functionalities by declaring
 735  * a structure containing enumerator's contents and custom
 736  * data, then casting its pointer to (SFG_Enumerator *).
 737  */
 738 typedef struct tagSFG_Enumerator SFG_Enumerator;
 739 struct tagSFG_Enumerator
 740 {
 741     GLboolean   found;                          /* Used to terminate search  */
 742     void*       data;                           /* Custom data pointer       */
 743 };
 744 typedef void (* FGCBWindowEnumerator  )( SFG_Window *, SFG_Enumerator * );
 745 typedef void (* FGCBMenuEnumerator  )( SFG_Menu *, SFG_Enumerator * );
 746
 747 /* The bitmap font structure */
 748 typedef struct tagSFG_Font SFG_Font;
 749 struct tagSFG_Font
 750 {
 751     char*           Name;         /* The source font name             */
 752     int             Quantity;     /* Number of chars in font          */
 753     int             Height;       /* Height of the characters         */
 754     const GLubyte** Characters;   /* The characters mapping           */
 755
 756     float           xorig, yorig; /* Relative origin of the character */
 757 };
 758
 759 /* The stroke font structures */
 760
 761 typedef struct tagSFG_StrokeVertex SFG_StrokeVertex;
 762 struct tagSFG_StrokeVertex
 763 {
 764     GLfloat         X, Y;
 765 };
 766
 767 typedef struct tagSFG_StrokeStrip SFG_StrokeStrip;
 768 struct tagSFG_StrokeStrip
 769 {
 770     int             Number;
 771     const SFG_StrokeVertex* Vertices;
 772 };
 773
 774 typedef struct tagSFG_StrokeChar SFG_StrokeChar;
 775 struct tagSFG_StrokeChar
 776 {
 777     GLfloat         Right;
 778     int             Number;
 779     const SFG_StrokeStrip* Strips;
 780 };
 781
 782 typedef struct tagSFG_StrokeFont SFG_StrokeFont;
 783 struct tagSFG_StrokeFont
 784 {
 785     char*           Name;                       /* The source font name      */
 786     int             Quantity;                   /* Number of chars in font   */
 787     GLfloat         Height;                     /* Height of the characters  */
 788     const SFG_StrokeChar** Characters;          /* The characters mapping    */
 789 };
 790
 791
 792 /* -- JOYSTICK-SPECIFIC STRUCTURES AND TYPES ------------------------------- */
 793 /*
 794  * Initial defines from "js.h" starting around line 33 with the existing "fg_joystick.c"
 795  * interspersed
 796  */
 797
 798 #if TARGET_HOST_MACINTOSH
 799 #    include <InputSprocket.h>
 800 #endif
 801
 802 #if TARGET_HOST_MAC_OSX
 803 #    include <mach/mach.h>
 804 #    include <IOKit/IOkitLib.h>
 805 #    include <IOKit/hid/IOHIDLib.h>
 806 #endif
 807
 808 /* XXX It might be better to poll the operating system for the numbers of buttons and
 809  * XXX axes and then dynamically allocate the arrays.
 810  */
 811 #define _JS_MAX_BUTTONS 32
 812
 813 #if TARGET_HOST_MACINTOSH
 814 #    define _JS_MAX_AXES  9
 815 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
 816 struct tagSFG_PlatformJoystick
 817 {
 818 #define  ISP_NUM_AXIS    9
 819 #define  ISP_NUM_NEEDS  41
 820     ISpElementReference isp_elem  [ ISP_NUM_NEEDS ];
 821     ISpNeed             isp_needs [ ISP_NUM_NEEDS ];
 822 };
 823 #endif
 824
 825 #if TARGET_HOST_MAC_OSX
 826 #    define _JS_MAX_AXES 16
 827 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
 828 struct tagSFG_PlatformJoystick
 829 {
 830     IOHIDDeviceInterface ** hidDev;
 831     IOHIDElementCookie buttonCookies[41];
 832     IOHIDElementCookie axisCookies[_JS_MAX_AXES];
 833 /* The next two variables are not used anywhere */
 834 /*    long minReport[_JS_MAX_AXES],
 835  *         maxReport[_JS_MAX_AXES];
 836  */
 837 };
 838 #endif
 839
 840
 841 /*
 842  * Definition of "SFG_Joystick" structure -- based on JS's "jsJoystick" object class.
 843  * See "js.h" lines 80-178.
 844  */
 845 typedef struct tagSFG_Joystick SFG_Joystick;
 846 struct tagSFG_Joystick
 847 {
 848         SFG_PlatformJoystick pJoystick;
 849
 850     int          id;
 851     GLboolean    error;
 852     char         name [ 128 ];
 853     int          num_axes;
 854     int          num_buttons;
 855
 856     float dead_band[ _JS_MAX_AXES ];
 857     float saturate [ _JS_MAX_AXES ];
 858     float center   [ _JS_MAX_AXES ];
 859     float max      [ _JS_MAX_AXES ];
 860     float min      [ _JS_MAX_AXES ];
 861 };
 862
 863
 864
 865 /* -- GLOBAL VARIABLES EXPORTS --------------------------------------------- */
 866
 867 /* Freeglut display related stuff (initialized once per session) */
 868 extern SFG_Display fgDisplay;
 869
 870 /* Freeglut internal structure */
 871 extern SFG_Structure fgStructure;
 872
 873 /* The current freeglut settings */
 874 extern SFG_State fgState;
 875
 876
 877 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
 878
 879 /*
 880  * A call to this function makes us sure that the Display and Structure
 881  * subsystems have been properly initialized and are ready to be used
 882  */
 883 #define  FREEGLUT_EXIT_IF_NOT_INITIALISED( string )               \
 884   if ( ! fgState.Initialised )                                    \
 885   {                                                               \
 886     fgError ( " ERROR:  Function <%s> called"                     \
 887               " without first calling 'glutInit'.", (string) ) ;  \
 888   }
 889
 890 #define  FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED( string )  \
 891   if ( ! fgState.Initialised )                                      \
 892   {                                                                 \
 893     fgError ( " ERROR:  Internal <%s> function called"              \
 894               " without first calling 'glutInit'.", (string) ) ;    \
 895   }
 896
 897 #define  FREEGLUT_INTERNAL_ERROR_EXIT( cond, string, function )  \
 898   if ( ! ( cond ) )                                              \
 899   {                                                              \
 900     fgError ( " ERROR:  Internal error <%s> in function %s",     \
 901               (string), (function) ) ;                           \
 902   }
 903
 904 /*
 905  * Following definitions are somewhat similar to GLib's,
 906  * but do not generate any log messages:
 907  */
 908 #define  freeglut_return_if_fail( expr ) \
 909     if( !(expr) )                        \
 910         return;
 911 #define  freeglut_return_val_if_fail( expr, val ) \
 912     if( !(expr) )                                 \
 913         return val ;
 914
 915 /*
 916  * A call to those macros assures us that there is a current
 917  * window set, respectively:
 918  */
 919 #define  FREEGLUT_EXIT_IF_NO_WINDOW( string )                               \
 920   if ( ! fgStructure.CurrentWindow &&                                       \
 921        ( fgState.ActionOnWindowClose != GLUT_ACTION_CONTINUE_EXECUTION ) )  \
 922   {                                                                         \
 923     fgError ( " ERROR:  Function <%s> called"                               \
 924               " with no current window defined.", (string) ) ;              \
 925   }
 926
 927 /*
 928  * The deinitialize function gets called on glutMainLoop() end. It should clean up
 929  * everything inside of the freeglut
 930  */
 931 void fgDeinitialize( void );
 932
 933 /*
 934  * Those two functions are used to create/destroy the freeglut internal
 935  * structures. This actually happens when calling glutInit() and when
 936  * quitting the glutMainLoop() (which actually happens, when all windows
 937  * have been closed).
 938  */
 939 void fgCreateStructure( void );
 940 void fgDestroyStructure( void );
 941
 942 /*
 943  * Window creation, opening, closing and destruction.
 944  * Also CallBack clearing/initialization.
 945  * Defined in fg_structure.c, fg_window.c.
 946  */
 947 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
 948                             GLboolean positionUse, int x, int y,
 949                             GLboolean sizeUse, int w, int h,
 950                             GLboolean gameMode, GLboolean isMenu );
 951 void        fgSetWindow ( SFG_Window *window );
 952 void        fgOpenWindow( SFG_Window* window, const char* title,
 953                           GLboolean positionUse, int x, int y,
 954                           GLboolean sizeUse, int w, int h,
 955                           GLboolean gameMode, GLboolean isSubWindow );
 956 void        fgCloseWindow( SFG_Window* window );
 957 void        fgAddToWindowDestroyList ( SFG_Window* window );
 958 void        fgCloseWindows ();
 959 void        fgDestroyWindow( SFG_Window* window );
 960
 961 /* Menu creation and destruction. Defined in fg_structure.c */
 962 SFG_Menu*   fgCreateMenu( FGCBMenu menuCallback );
 963 void        fgDestroyMenu( SFG_Menu* menu );
 964
 965 /* Joystick device management functions, defined in fg_joystick.c */
 966 int         fgJoystickDetect( void );
 967 void        fgInitialiseJoysticks( void );
 968 void        fgJoystickClose( void );
 969 void        fgJoystickPollWindow( SFG_Window* window );
 970
 971 /* InputDevice Initialisation and Closure */
 972 int         fgInputDeviceDetect( void );
 973 void        fgInitialiseInputDevices( void );
 974 void        fgInputDeviceClose( void );
 975
 976 /* spaceball device functions, defined in fg_spaceball.c */
 977 void        fgInitialiseSpaceball( void );
 978 void        fgSpaceballClose( void );
 979 void        fgSpaceballSetWindow( SFG_Window *window );
 980
 981 int         fgHasSpaceball( void );
 982 int         fgSpaceballNumButtons( void );
 983
 984 /* Setting the cursor for a given window */
 985 void fgSetCursor ( SFG_Window *window, int cursorID );
 986
 987 /*
 988  * Helper function to enumerate through all registered windows
 989  * and one to enumerate all of a window's subwindows...
 990  *
 991  * The GFunc callback for those functions will be defined as:
 992  *
 993  *      void enumCallback( gpointer window, gpointer enumerator );
 994  *
 995  * where window is the enumerated (sub)window pointer (SFG_Window *),
 996  * and userData is the a custom user-supplied pointer. Functions
 997  * are defined and exported from fg_structure.c file.
 998  */
 999 void fgEnumWindows( FGCBWindowEnumerator enumCallback, SFG_Enumerator* enumerator );
1000 void fgEnumSubWindows( SFG_Window* window, FGCBWindowEnumerator enumCallback,
1001                        SFG_Enumerator* enumerator );
1002
1003 /*
1004  * fgWindowByHandle returns a (SFG_Window *) value pointing to the
1005  * first window in the queue matching the specified window handle.
1006  * The function is defined in fg_structure.c file.
1007  */
1008 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
1009
1010 /*
1011  * This function is similar to the previous one, except it is
1012  * looking for a specified (sub)window identifier. The function
1013  * is defined in fg_structure.c file.
1014  */
1015 SFG_Window* fgWindowByID( int windowID );
1016
1017 /*
1018  * Looks up a menu given its ID. This is easier than fgWindowByXXX
1019  * as all menus are placed in a single doubly linked list...
1020  */
1021 SFG_Menu* fgMenuByID( int menuID );
1022
1023 /*
1024  * Returns active menu, if any. Assumption: only one menu active throughout application at any one time.
1025  * This is easier than fgWindowByXXX as all menus are placed in one doubly linked list...
1026  */
1027 SFG_Menu* fgGetActiveMenu( );
1028
1029 /*
1030  * The menu activation and deactivation the code. This is the meat
1031  * of the menu user interface handling code...
1032  */
1033 void fgUpdateMenuHighlight ( SFG_Menu *menu );
1034 GLboolean fgCheckActiveMenu ( SFG_Window *window, int button, GLboolean pressed,
1035                               int mouse_x, int mouse_y );
1036 void fgDeactivateMenu( SFG_Window *window );
1037
1038 /*
1039  * This function gets called just before the buffers swap, so that
1040  * freeglut can display the pull-down menus via OpenGL. The function
1041  * is defined in fg_menu.c file.
1042  */
1043 void fgDisplayMenu( void );
1044
1045 /* Elapsed time as per glutGet(GLUT_ELAPSED_TIME). */
1046 fg_time_t fgElapsedTime( void );
1047
1048 /* System time in milliseconds */
1049 fg_time_t fgSystemTime(void);
1050
1051 /* List functions */
1052 void fgListInit(SFG_List *list);
1053 void fgListAppend(SFG_List *list, SFG_Node *node);
1054 void fgListRemove(SFG_List *list, SFG_Node *node);
1055 int fgListLength(SFG_List *list);
1056 void fgListInsert(SFG_List *list, SFG_Node *next, SFG_Node *node);
1057
1058 /* Error Message functions */
1059 void fgError( const char *fmt, ... );
1060 void fgWarning( const char *fmt, ... );
1061
1062 SFG_Proc fgPlatformGetProcAddress( const char *procName );
1063
1064 /* pushing attribute/value pairs into an array */
1065 #define ATTRIB(a) attributes[where++]=(a)
1066 #define ATTRIB_VAL(a,v) {ATTRIB(a); ATTRIB(v);}
1067
1068 int fghMapBit( int mask, int from, int to );
1069 int fghIsLegacyContextRequested( void );
1070 void fghContextCreationError( void );
1071 int fghNumberOfAuxBuffersRequested( void );
1072
1073 #endif /* FREEGLUT_INTERNAL_H */
1074
1075 /*** END OF FILE ***/