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