git.mutantstargoat.com Git - freeglut/blob - src/Common/freeglut_internal.h

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