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