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