Initial work on callbacks with user data parameters.
[freeglut] / src / fg_internal.h
index 85bb750..8e27f54 100644 (file)
@@ -32,6 +32,8 @@
 #    include "config.h"
 #endif
 
+#include "fg_version.h"
+
 /* Freeglut is intended to function under all Unix/X11 and Win32 platforms. */
 /* XXX: Don't all MS-Windows compilers (except Cygwin) have _WIN32 defined?
  * XXX: If so, remove the first set of defined()'s below.
 #elif defined (__ANDROID__)
 #   define  TARGET_HOST_ANDROID  1
 
+#elif defined (__QNXNTO__) || defined (__PLAYBOOK__)
+#   define  TARGET_HOST_BLACKBERRY  1
+
 #elif defined(__posix__) || defined(__unix__) || defined(__linux__) || defined(__sun)
-#   define  TARGET_HOST_POSIX_X11  1
+#   if defined(FREEGLUT_WAYLAND)
+#      define  TARGET_HOST_POSIX_WAYLAND  1
+#   else
+#      define  TARGET_HOST_POSIX_X11  1
+#   endif
 
 #elif defined(__APPLE__)
 /* This is a placeholder until we get native OSX support ironed out -- JFF 11/18/09 */
 #endif
 
 #ifndef TARGET_HOST_MS_WINDOWS
-#   define  TARGET_HOST_MS_WINDOWS 0
+#   define  TARGET_HOST_MS_WINDOWS     0
+#endif
+
+#ifndef TARGET_HOST_ANDROID
+#   define  TARGET_HOST_ANDROID        0
+#endif
+
+#ifndef TARGET_HOST_BLACKBERRY
+#   define  TARGET_HOST_BLACKBERRY     0
+#endif
+
+#ifndef  TARGET_HOST_POSIX_WAYLAND
+#   define  TARGET_HOST_POSIX_WAYLAND  0
 #endif
 
 #ifndef  TARGET_HOST_POSIX_X11
-#   define  TARGET_HOST_POSIX_X11  0
+#   define  TARGET_HOST_POSIX_X11      0
 #endif
 
 #ifndef  TARGET_HOST_MAC_OSX
-#   define  TARGET_HOST_MAC_OSX    0
+#   define  TARGET_HOST_MAC_OSX        0
 #endif
 
 #ifndef  TARGET_HOST_SOLARIS
-#   define  TARGET_HOST_SOLARIS    0
+#   define  TARGET_HOST_SOLARIS        0
 #endif
 
 /* -- FIXED CONFIGURATION LIMITS ------------------------------------------- */
 
-#define  FREEGLUT_MAX_MENUS         3
+#define  FREEGLUT_MAX_MENUS            3
 
 /* These files should be available on every platform. */
 #include <stdio.h>
 #endif
 
 /* Platform-specific includes */
+#if TARGET_HOST_POSIX_WAYLAND
+#include "wayland/fg_internal_wl.h"
+#endif
 #if TARGET_HOST_POSIX_X11
 #include "x11/fg_internal_x11.h"
 #endif
 #if TARGET_HOST_ANDROID
 #include "android/fg_internal_android.h"
 #endif
+#if TARGET_HOST_BLACKBERRY
+#include "blackberry/fg_internal_blackberry.h"
+#endif
 
 
 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
 
 /* Freeglut callbacks type definitions */
+typedef void* FGCBUserData;
+
 typedef void (* FGCBDisplay       )( void );
 typedef void (* FGCBReshape       )( int, int );
 typedef void (* FGCBPosition      )( int, int );
@@ -220,17 +249,19 @@ typedef void (* FGCBMultiMotion  )( int, int, int );
 typedef void (* FGCBMultiPassive )( int, int, int );
 
 typedef void (* FGCBInitContext)();
-typedef void (* FGCBPause)();
-typedef void (* FGCBResume)();
+typedef void (* FGCBAppStatus)(int);
 
 /* The global callbacks type definitions */
 typedef void (* FGCBIdle          )( void );
+typedef void (* FGCBIdleUC        )( FGCBUserData );
 typedef void (* FGCBTimer         )( int );
+typedef void (* FGCBTimerUC       )( int, FGCBUserData );
 typedef void (* FGCBMenuState     )( int );
 typedef void (* FGCBMenuStatus    )( int, int, int );
 
 /* The callback used when creating/using menus */
 typedef void (* FGCBMenu          )( int );
+typedef void (* FGCBMenuUC        )( int, FGCBUserData );
 
 /* The FreeGLUT error/warning handler type definition */
 typedef void (* FGError           ) ( const char *fmt, va_list ap);
@@ -301,11 +332,13 @@ struct tagSFG_State
     SFG_List         Timers;               /* The freeglut timer hooks       */
     SFG_List         FreeTimers;           /* The unused timer hooks         */
 
-    FGCBIdle         IdleCallback;         /* The global idle callback       */
+    FGCBIdleUC       IdleCallback;         /* The global idle callback       */
+    FGCBUserData     IdleCallbackData;     /* The global idle callback data  */
 
     int              ActiveMenus;          /* Num. of currently active menus */
     FGCBMenuState    MenuStateCallback;    /* Menu callbacks are global      */
     FGCBMenuStatus   MenuStatusCallback;
+    void*            MenuFont;             /* Font to be used for newly created menus */
 
     SFG_XYUse        GameModeSize;         /* Game mode screen's dimensions  */
     int              GameModeDepth;        /* The pixel depth for game mode  */
@@ -316,7 +349,7 @@ struct tagSFG_State
     fgExecutionState ExecState;           /* Used for GLUT termination       */
     char            *ProgramName;         /* Name of the invoking program    */
     GLboolean        JoysticksInitialised;  /* Only initialize if application calls for them */
-    int              NumActiveJoysticks;    /* Number of active joysticks -- if zero, don't poll joysticks */
+    int              NumActiveJoysticks;    /* Number of active joysticks (callback defined and positive pollrate) -- if zero, don't poll joysticks */
     GLboolean        InputDevsInitialised;  /* Only initialize if application calls for them */
 
        int              MouseWheelTicks;      /* Number of ticks the mouse wheel has turned */
@@ -326,6 +359,9 @@ struct tagSFG_State
 
     GLboolean        SkipStaleMotion;      /* skip stale motion events */
 
+    GLboolean        StrokeFontDrawJoinDots;/* Draw dots between line segments of stroke fonts? */
+    GLboolean        AllowNegativeWindowPosition; /* GLUT, by default, doesn't allow negative window positions. Enable it? */
+
     int              MajorVersion;         /* Major OpenGL context version  */
     int              MinorVersion;         /* Minor OpenGL context version  */
     int              ContextFlags;         /* OpenGL context flags          */
@@ -335,7 +371,7 @@ struct tagSFG_State
     FGWarning        WarningFunc;          /* User defined warning handler  */
 };
 
-/* The structure used by display initialization in freeglut_init.c */
+/* The structure used by display initialization in fg_init.c */
 typedef struct tagSFG_Display SFG_Display;
 struct tagSFG_Display
 {
@@ -354,13 +390,14 @@ struct tagSFG_Timer
 {
     SFG_Node        Node;
     int             ID;                 /* The timer ID integer              */
-    FGCBTimer       Callback;           /* The timer callback                */
+    FGCBTimerUC     Callback;           /* The timer callback                */
+    FGCBUserData    CallbackData;       /* The timer callback user data      */
     fg_time_t       TriggerTime;        /* The timer trigger time            */
 };
 
 /*
  * A window and its OpenGL context. The contents of this structure
- * are highly dependant on the target operating system we aim at...
+ * are highly dependent on the target operating system we aim at...
  */
 typedef struct tagSFG_Context SFG_Context;
 struct tagSFG_Context
@@ -371,38 +408,100 @@ struct tagSFG_Context
        SFG_PlatformContext pContext;    /* The window's FBConfig (X11) or device context (Windows) */
 
     int             DoubleBuffered;  /* Treat the window as double-buffered */
+
+    /* When drawing geometry to vertex attribute buffers, user specifies
+     * the attribute indices for vertices, normals and/or texture coords
+     * to freeglut. Those are stored here
+     */
     GLint           attribute_v_coord;
     GLint           attribute_v_normal;
+    GLint           attribute_v_texture;
 };
 
 
+/*
+ * Bitmasks indicating the different kinds of
+ * actions that can be scheduled for a window.
+ */
+#define GLUT_INIT_WORK        (1<<0)
+#define GLUT_VISIBILITY_WORK  (1<<1)
+#define GLUT_POSITION_WORK    (1<<2)
+#define GLUT_SIZE_WORK        (1<<3)
+#define GLUT_ZORDER_WORK      (1<<4)
+#define GLUT_FULL_SCREEN_WORK (1<<5)
+#define GLUT_DISPLAY_WORK     (1<<6)
+
+/*
+ * An enumeration containing the desired mapping state of a window
+ */
+typedef enum
+{
+  DesireHiddenState,
+  DesireIconicState,
+  DesireNormalState
+} fgDesiredVisibility ;
+
+/*
+ *  There is considerable confusion about the "right thing to
+ *  do" concerning window  size and position.  GLUT itself is
+ *  not consistent between Windows and UNIX/X11; since
+ *  platform independence is a virtue for "freeglut", we
+ *  decided to break with GLUT's behaviour.
+ *
+ *  Under UNIX/X11, it is apparently not possible to get the
+ *  window border sizes in order to subtract them off the
+ *  window's initial position until some time after the window
+ *  has been created.  Therefore we decided on the following
+ *  behaviour, both under Windows and under UNIX/X11:
+ *  - When you create a window with position (x,y) and size
+ *    (w,h), the upper left hand corner of the outside of the
+ *    window is at (x,y) and the size of the drawable area is
+ *    (w,h).
+ *  - When you query the size and position of the window--as
+ *    is happening here for Windows--"freeglut" will return
+ *    the size of the drawable area--the (w,h) that you
+ *    specified when you created the window--and the coordinates
+ *    of the upper left hand corner of the drawable area, i.e.
+ *    of the client rect--which is NOT the (x,y) you specified.
+ */
 typedef struct tagSFG_WindowState SFG_WindowState;
-struct tagSFG_WindowState
+struct tagSFG_WindowState   /* as per notes above, sizes always refer to the client area (thus without the window decorations) */
 {
-    /* Note that on Windows, sizes always refer to the client area, thus without the window decorations */
+    /* window state - size, position, look */
+    int             Xpos;               /* Window's top-left of client area, X-coordinate */
+    int             Ypos;               /* Window's top-left of client area, Y-coordinate */
     int             Width;              /* Window's width in pixels          */
     int             Height;             /* The same about the height         */
+    GLboolean       Visible;            /* Is the window visible now? Not using fgVisibilityState as we only care if visible or not */
+    int             Cursor;             /* The currently selected cursor style */
+    GLboolean       IsFullscreen;       /* is the window fullscreen?         */
+
+    /* FreeGLUT operations are deferred, that is, window moving, resizing,
+     * Z-order changing, making full screen or not do not happen immediately
+     * upon the user's request, but only in the next iteration of the main
+     * loop, before the display callback is called. This allows multiple
+     * reshape, position, etc requests to be combined into one and is
+     * compatible with the way GLUT does things. Callbacks get triggered
+     * based on the feedback/messages/notifications from the window manager.
+     * Below here we define what work should be done, as well as the relevant
+     * parameters for this work.
+     */
+    unsigned int    WorkMask;           /* work (resize, etc) to be done on the window */
+    int             DesiredXpos;        /* desired X location */
+    int             DesiredYpos;        /* desired Y location */
+    int             DesiredWidth;       /* desired window width */
+    int             DesiredHeight;      /* desired window height */
+    int             DesiredZOrder;      /* desired window Z Order position */
+    fgDesiredVisibility DesiredVisibility;/* desired visibility (hidden, iconic, shown/normal) */
 
        SFG_PlatformWindowState pWState;    /* Window width/height (X11) or rectangle/style (Windows) from before a resize, and other stuff only needed on specific platforms */
 
-    GLboolean       Redisplay;          /* Do we have to redisplay?          */
-    GLboolean       Visible;            /* Is the window visible now         */
-
-    int             Cursor;             /* The currently selected cursor     */
-
     long            JoystickPollRate;   /* The joystick polling rate         */
     fg_time_t       JoystickLastPoll;   /* When the last poll happened       */
 
     int             MouseX, MouseY;     /* The most recent mouse position    */
 
     GLboolean       IgnoreKeyRepeat;    /* Whether to ignore key repeat.     */
-    GLboolean       KeyRepeating;       /* Currently in repeat mode          */
-
-    GLboolean       NeedToResize;       /* Do we need to resize the window?  */
-
-    GLboolean       IsFullscreen;       /* is the window fullscreen? */
-
-    GLboolean       NeedToInitContext;  /* are OpenGL context/resources loaded? */
 
     GLboolean       VisualizeNormals;   /* When drawing objects, draw vectors representing the normals as well? */
 };
@@ -535,15 +634,14 @@ enum
 
     /* Mobile platforms LifeCycle */
     WCB_InitContext,
-    WCB_Pause,
-    WCB_Resume,
+    WCB_AppStatus,
 
     /* Presently ignored */
     WCB_Select,
     WCB_OverlayDisplay,
-    WCB_SpaceMotion,     /* presently implemented only on UNIX/X11 */
-    WCB_SpaceRotation,   /* presently implemented only on UNIX/X11 */
-    WCB_SpaceButton,     /* presently implemented only on UNIX/X11 */
+    WCB_SpaceMotion,     /* presently implemented only on UNIX/X11 and Windows */
+    WCB_SpaceRotation,   /* presently implemented only on UNIX/X11 and Windows */
+    WCB_SpaceButton,     /* presently implemented only on UNIX/X11 and Windows */
     WCB_Dials,
     WCB_ButtonBox,
     WCB_TabletMotion,
@@ -571,9 +669,11 @@ struct tagSFG_Menu
     void               *UserData;     /* User data passed back at callback   */
     int                 ID;           /* The global menu ID                  */
     SFG_List            Entries;      /* The menu entries list               */
-    FGCBMenu            Callback;     /* The menu callback                   */
+    FGCBMenuUC          Callback;     /* The menu callback                   */
+    FGCBUserData        CallbackData; /* The menu callback user data         */
     FGCBDestroy         Destroy;      /* Destruction callback                */
     GLboolean           IsActive;     /* Is the menu selected?               */
+    void*               Font;         /* Font to be used for displaying this menu */
     int                 Width;        /* Menu box width in pixels            */
     int                 Height;       /* Menu box height in pixels           */
     int                 X, Y;         /* Menu box raster position            */
@@ -710,7 +810,7 @@ struct tagSFG_StrokeFont
 
 /* -- JOYSTICK-SPECIFIC STRUCTURES AND TYPES ------------------------------- */
 /*
- * Initial defines from "js.h" starting around line 33 with the existing "freeglut_joystick.c"
+ * Initial defines from "js.h" starting around line 33 with the existing "fg_joystick.c"
  * interspersed
  */
 
@@ -821,7 +921,7 @@ extern SFG_State fgState;
   }
 
 /*
- * Following definitions are somewhat similiar to GLib's,
+ * Following definitions are somewhat similar to GLib's,
  * but do not generate any log messages:
  */
 #define  freeglut_return_if_fail( expr ) \
@@ -861,7 +961,7 @@ void fgDestroyStructure( void );
 /*
  * Window creation, opening, closing and destruction.
  * Also CallBack clearing/initialization.
- * Defined in freeglut_structure.c, freeglut_window.c.
+ * Defined in fg_structure.c, fg_window.c.
  */
 SFG_Window* fgCreateWindow( SFG_Window* parent, const char* title,
                             GLboolean positionUse, int x, int y,
@@ -877,11 +977,11 @@ void        fgAddToWindowDestroyList ( SFG_Window* window );
 void        fgCloseWindows ();
 void        fgDestroyWindow( SFG_Window* window );
 
-/* Menu creation and destruction. Defined in freeglut_structure.c */
-SFG_Menu*   fgCreateMenu( FGCBMenu menuCallback );
+/* Menu creation and destruction. Defined in fg_structure.c */
+SFG_Menu*   fgCreateMenu( FGCBMenuUC menuCallback, FGCBUserData userData );
 void        fgDestroyMenu( SFG_Menu* menu );
 
-/* Joystick device management functions, defined in freeglut_joystick.c */
+/* Joystick device management functions, defined in fg_joystick.c */
 int         fgJoystickDetect( void );
 void        fgInitialiseJoysticks( void );
 void        fgJoystickClose( void );
@@ -892,7 +992,7 @@ int         fgInputDeviceDetect( void );
 void        fgInitialiseInputDevices( void );
 void        fgInputDeviceClose( void );
 
-/* spaceball device functions, defined in freeglut_spaceball.c */
+/* spaceball device functions, defined in fg_spaceball.c */
 void        fgInitialiseSpaceball( void );
 void        fgSpaceballClose( void );
 void        fgSpaceballSetWindow( SFG_Window *window );
@@ -913,7 +1013,7 @@ void fgSetCursor ( SFG_Window *window, int cursorID );
  *
  * where window is the enumerated (sub)window pointer (SFG_Window *),
  * and userData is the a custom user-supplied pointer. Functions
- * are defined and exported from freeglut_structure.c file.
+ * are defined and exported from fg_structure.c file.
  */
 void fgEnumWindows( FGCBWindowEnumerator enumCallback, SFG_Enumerator* enumerator );
 void fgEnumSubWindows( SFG_Window* window, FGCBWindowEnumerator enumCallback,
@@ -922,14 +1022,14 @@ void fgEnumSubWindows( SFG_Window* window, FGCBWindowEnumerator enumCallback,
 /*
  * fgWindowByHandle returns a (SFG_Window *) value pointing to the
  * first window in the queue matching the specified window handle.
- * The function is defined in freeglut_structure.c file.
+ * The function is defined in fg_structure.c file.
  */
 SFG_Window* fgWindowByHandle( SFG_WindowHandleType hWindow );
 
 /*
- * This function is similiar to the previous one, except it is
+ * This function is similar to the previous one, except it is
  * looking for a specified (sub)window identifier. The function
- * is defined in freeglut_structure.c file.
+ * is defined in fg_structure.c file.
  */
 SFG_Window* fgWindowByID( int windowID );
 
@@ -957,7 +1057,7 @@ void fgDeactivateMenu( SFG_Window *window );
 /*
  * This function gets called just before the buffers swap, so that
  * freeglut can display the pull-down menus via OpenGL. The function
- * is defined in freeglut_menu.c file.
+ * is defined in fg_menu.c file.
  */
 void fgDisplayMenu( void );