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

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