Adding a Frequently Asked Questions file
[freeglut] / src / freeglut_callbacks.c
index f395716..3d9a02b 100644 (file)
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
-#define  G_LOG_DOMAIN  "freeglut-callbacks"
-
-#include "../include/GL/freeglut.h"
+#include <GL/freeglut.h>
 #include "freeglut_internal.h"
 
-
 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
 
 /*
  * All of the callbacks setting methods can be generalized to this:
  */
-#define SET_CALLBACK(a) if( fgStructure.Window == NULL ) return;\
-                            fgStructure.Window->Callbacks.a = callback;
+#define SET_CALLBACK(a)                                         \
+do                                                              \
+{                                                               \
+    if( fgStructure.CurrentWindow == NULL )                     \
+        return;                                                 \
+    SET_WCB( ( *( fgStructure.CurrentWindow ) ), a, callback ); \
+} while( 0 )
 
 /*
  * Sets the Display callback for the current window
  */
 void FGAPIENTRY glutDisplayFunc( void (* callback)( void ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutDisplayFunc" );
     if( !callback )
-      fgError ("Fatal error in program.  NULL display callback not "
-          "permitted in GLUT 3.0+ or freeglut 2.0.1+\n");
+        fgError( "Fatal error in program.  NULL display callback not "
+                 "permitted in GLUT 3.0+ or freeglut 2.0.1+" );
     SET_CALLBACK( Display );
-    fgStructure.Window->State.Redisplay = TRUE;
 }
 
 /*
@@ -60,14 +58,17 @@ void FGAPIENTRY glutDisplayFunc( void (* callback)( void ) )
  */
 void FGAPIENTRY glutReshapeFunc( void (* callback)( int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutReshapeFunc" );
     SET_CALLBACK( Reshape );
 }
 
 /*
  * Sets the Keyboard callback for the current window
  */
-void FGAPIENTRY glutKeyboardFunc( void (* callback)( unsigned char, int, int ) )
+void FGAPIENTRY glutKeyboardFunc( void (* callback)
+                                  ( unsigned char, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutKeyboardFunc" );
     SET_CALLBACK( Keyboard );
 }
 
@@ -76,6 +77,7 @@ void FGAPIENTRY glutKeyboardFunc( void (* callback)( unsigned char, int, int ) )
  */
 void FGAPIENTRY glutSpecialFunc( void (* callback)( int, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSpecialFunc" );
     SET_CALLBACK( Special );
 }
 
@@ -84,28 +86,42 @@ void FGAPIENTRY glutSpecialFunc( void (* callback)( int, int, int ) )
  */
 void FGAPIENTRY glutIdleFunc( void (* callback)( void ) )
 {
-    freeglut_assert_ready;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutIdleFunc" );
     fgState.IdleCallback = callback;
 }
 
 /*
  * Sets the Timer callback for the current window
  */
-void FGAPIENTRY glutTimerFunc( unsigned int timeOut, void (* callback)( int ), int timerID )
+void FGAPIENTRY glutTimerFunc( unsigned int timeOut, void (* callback)( int ),
+                               int timerID )
 {
-    SFG_Timer* timer;
+    SFG_Timer *timer, *node;
 
-    freeglut_assert_ready;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutTimerFunc" );
 
-    timer = (SFG_Timer *)calloc( sizeof(SFG_Timer), 1 );
-    if (!timer)
-      fgError ("Fatal error: "
-          "Memory allocation failure in glutTimerFunc()\n");
+    if( (timer = fgState.FreeTimers.Last) )
+    {
+        fgListRemove( &fgState.FreeTimers, &timer->Node );
+    }
+    else
+    {
+        if( ! (timer = malloc(sizeof(SFG_Timer))) )
+            fgError( "Fatal error: "
+                     "Memory allocation failure in glutTimerFunc()" );
+    }
 
     timer->Callback  = callback;
     timer->ID        = timerID;
     timer->TriggerTime = fgElapsedTime() + timeOut;
-    fgListAppend( &fgState.Timers, &timer->Node );
+
+    for( node = fgState.Timers.First; node; node = node->Node.Next )
+    {
+        if( node->TriggerTime > timer->TriggerTime )
+            break;
+    }
+
+    fgListInsert( &fgState.Timers, &node->Node, &timer->Node );
 }
 
 /*
@@ -113,18 +129,19 @@ void FGAPIENTRY glutTimerFunc( unsigned int timeOut, void (* callback)( int ), i
  */
 static void fghVisibility( int status )
 {
-    freeglut_assert_ready;
-    freeglut_return_if_fail( fgStructure.Window != NULL );
-    freeglut_return_if_fail( fgStructure.Window->Callbacks.Visibility != NULL );
+    int glut_status = GLUT_VISIBLE;
 
-    if( status == GLUT_HIDDEN  || status == GLUT_FULLY_COVERED )
-        fgStructure.Window->Callbacks.Visibility( GLUT_NOT_VISIBLE );
-    else
-        fgStructure.Window->Callbacks.Visibility( GLUT_VISIBLE );
+    FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED ( "Visibility Callback" );
+    freeglut_return_if_fail( fgStructure.CurrentWindow );
+
+    if( ( GLUT_HIDDEN == status )  || ( GLUT_FULLY_COVERED == status ) )
+        glut_status = GLUT_NOT_VISIBLE;
+    INVOKE_WCB( *( fgStructure.CurrentWindow ), Visibility, ( glut_status ) );
 }
 
 void FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutVisibilityFunc" );
     SET_CALLBACK( Visibility );
 
     if( callback )
@@ -136,8 +153,10 @@ void FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) )
 /*
  * Sets the keyboard key release callback for the current window
  */
-void FGAPIENTRY glutKeyboardUpFunc( void (* callback)( unsigned char, int, int ) )
+void FGAPIENTRY glutKeyboardUpFunc( void (* callback)
+                                    ( unsigned char, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutKeyboardUpFunc" );
     SET_CALLBACK( KeyboardUp );
 }
 
@@ -146,22 +165,28 @@ void FGAPIENTRY glutKeyboardUpFunc( void (* callback)( unsigned char, int, int )
  */
 void FGAPIENTRY glutSpecialUpFunc( void (* callback)( int, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSpecialUpFunc" );
     SET_CALLBACK( SpecialUp );
 }
 
 /*
  * Sets the joystick callback and polling rate for the current window
  */
-void FGAPIENTRY glutJoystickFunc( void (* callback)( unsigned int, int, int, int ), int pollInterval )
+void FGAPIENTRY glutJoystickFunc( void (* callback)
+                                  ( unsigned int, int, int, int ),
+                                  int pollInterval )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutJoystickFunc" );
+    fgInitialiseJoysticks ();
+
     SET_CALLBACK( Joystick );
-    fgStructure.Window->State.JoystickPollRate = pollInterval;
+    fgStructure.CurrentWindow->State.JoystickPollRate = pollInterval;
 
-    fgStructure.Window->State.JoystickLastPoll =
-        fgElapsedTime() - fgStructure.Window->State.JoystickPollRate;
+    fgStructure.CurrentWindow->State.JoystickLastPoll =
+        fgElapsedTime() - fgStructure.CurrentWindow->State.JoystickPollRate;
 
-    if( fgStructure.Window->State.JoystickLastPoll < 0 )
-        fgStructure.Window->State.JoystickLastPoll = 0;
+    if( fgStructure.CurrentWindow->State.JoystickLastPoll < 0 )
+        fgStructure.CurrentWindow->State.JoystickLastPoll = 0;
 }
 
 /*
@@ -169,6 +194,7 @@ void FGAPIENTRY glutJoystickFunc( void (* callback)( unsigned int, int, int, int
  */
 void FGAPIENTRY glutMouseFunc( void (* callback)( int, int, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMouseFunc" );
     SET_CALLBACK( Mouse );
 }
 
@@ -177,6 +203,7 @@ void FGAPIENTRY glutMouseFunc( void (* callback)( int, int, int, int ) )
  */
 void FGAPIENTRY glutMouseWheelFunc( void (* callback)( int, int, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMouseWheelFunc" );
     SET_CALLBACK( MouseWheel );
 }
 
@@ -186,6 +213,7 @@ void FGAPIENTRY glutMouseWheelFunc( void (* callback)( int, int, int, int ) )
  */
 void FGAPIENTRY glutMotionFunc( void (* callback)( int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMotionFunc" );
     SET_CALLBACK( Motion );
 }
 
@@ -195,6 +223,7 @@ void FGAPIENTRY glutMotionFunc( void (* callback)( int, int ) )
  */
 void FGAPIENTRY glutPassiveMotionFunc( void (* callback)( int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPassiveMotionFunc" );
     SET_CALLBACK( Passive );
 }
 
@@ -203,6 +232,7 @@ void FGAPIENTRY glutPassiveMotionFunc( void (* callback)( int, int ) )
  */
 void FGAPIENTRY glutEntryFunc( void (* callback)( int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutEntryFunc" );
     SET_CALLBACK( Entry );
 }
 
@@ -211,20 +241,22 @@ void FGAPIENTRY glutEntryFunc( void (* callback)( int ) )
  */
 void FGAPIENTRY glutCloseFunc( void (* callback)( void ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutCloseFunc" );
     SET_CALLBACK( Destroy );
 }
 
 void FGAPIENTRY glutWMCloseFunc( void (* callback)( void ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutWMCloseFunc" );
     glutCloseFunc( callback );
 }
 
 /* A. Donev: Destruction callback for menus */
 void FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) )
 {
-   if( fgStructure.Menu == NULL )
-     return;
-   fgStructure.Menu->Destroy = callback;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMenuDestroyFunc" );
+    if( fgStructure.CurrentMenu )
+        fgStructure.CurrentMenu->Destroy = callback;
 }
 
 /*
@@ -232,7 +264,7 @@ void FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) )
  */
 void FGAPIENTRY glutMenuStateFunc( void (* callback)( int ) )
 {
-    freeglut_assert_ready;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMenuStateFunc" );
     fgState.MenuStateCallback = callback;
 }
 
@@ -241,7 +273,7 @@ void FGAPIENTRY glutMenuStateFunc( void (* callback)( int ) )
  */
 void FGAPIENTRY glutMenuStatusFunc( void (* callback)( int, int, int ) )
 {
-    freeglut_assert_ready;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMenuStatusFunc" );
     fgState.MenuStatusCallback = callback;
 }
 
@@ -250,6 +282,7 @@ void FGAPIENTRY glutMenuStatusFunc( void (* callback)( int, int, int ) )
  */
 void FGAPIENTRY glutOverlayDisplayFunc( void (* callback)( void ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutOverlayDisplayFunc" );
     SET_CALLBACK( OverlayDisplay );
 }
 
@@ -258,6 +291,7 @@ void FGAPIENTRY glutOverlayDisplayFunc( void (* callback)( void ) )
  */
 void FGAPIENTRY glutWindowStatusFunc( void (* callback)( int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutWindowStatusFunc" );
     SET_CALLBACK( WindowStatus );
 }
 
@@ -266,6 +300,7 @@ void FGAPIENTRY glutWindowStatusFunc( void (* callback)( int ) )
  */
 void FGAPIENTRY glutSpaceballMotionFunc( void (* callback)( int, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSpaceballMotionFunc" );
     SET_CALLBACK( SpaceMotion );
 }
 
@@ -274,6 +309,7 @@ void FGAPIENTRY glutSpaceballMotionFunc( void (* callback)( int, int, int ) )
  */
 void FGAPIENTRY glutSpaceballRotateFunc( void (* callback)( int, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSpaceballRotateFunc" );
     SET_CALLBACK( SpaceRotation );
 }
 
@@ -282,6 +318,7 @@ void FGAPIENTRY glutSpaceballRotateFunc( void (* callback)( int, int, int ) )
  */
 void FGAPIENTRY glutSpaceballButtonFunc( void (* callback)( int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSpaceballButtonFunc" );
     SET_CALLBACK( SpaceButton );
 }
 
@@ -290,6 +327,7 @@ void FGAPIENTRY glutSpaceballButtonFunc( void (* callback)( int, int ) )
  */
 void FGAPIENTRY glutButtonBoxFunc( void (* callback)( int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutButtonBoxFunc" );
     SET_CALLBACK( ButtonBox );
 }
 
@@ -298,6 +336,7 @@ void FGAPIENTRY glutButtonBoxFunc( void (* callback)( int, int ) )
  */
 void FGAPIENTRY glutDialsFunc( void (* callback)( int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutDialsFunc" );
     SET_CALLBACK( Dials );
 }
 
@@ -306,6 +345,7 @@ void FGAPIENTRY glutDialsFunc( void (* callback)( int, int ) )
  */
 void FGAPIENTRY glutTabletMotionFunc( void (* callback)( int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutTabletMotionFunc" );
     SET_CALLBACK( TabletMotion );
 }
 
@@ -314,6 +354,7 @@ void FGAPIENTRY glutTabletMotionFunc( void (* callback)( int, int ) )
  */
 void FGAPIENTRY glutTabletButtonFunc( void (* callback)( int, int, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutTabletButtonFunc" );
     SET_CALLBACK( TabletButton );
 }