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