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