Adding a Frequently Asked Questions file

[freeglut] / src / freeglut_callbacks.c

diff --git a/src/freeglut_callbacks.c b/src/freeglut_callbacks.c
index 38adc58..3d9a02b 100644 (file)
--- a/src/freeglut_callbacks.c
+++ b/src/freeglut_callbacks.c
@@ -25,29 +25,28 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
 #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;                      \
-    SET_WCB( ( *( fgStructure.Window ) ), 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+" );
@@ -59,6 +58,7 @@ void FGAPIENTRY glutDisplayFunc( void (* callback)( void ) )
  */
 void FGAPIENTRY glutReshapeFunc( void (* callback)( int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutReshapeFunc" );
     SET_CALLBACK( Reshape );
 }
 
@@ -68,6 +68,7 @@ void FGAPIENTRY glutReshapeFunc( void (* callback)( 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)
  */
 void FGAPIENTRY glutSpecialFunc( void (* callback)( int, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSpecialFunc" );
     SET_CALLBACK( Special );
 }
 
@@ -84,7 +86,7 @@ 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;
 }
 
@@ -96,7 +98,7 @@ void FGAPIENTRY glutTimerFunc( unsigned int timeOut, void (* callback)( int ),
 {
     SFG_Timer *timer, *node;
 
-    freeglut_assert_ready;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutTimerFunc" );
 
     if( (timer = fgState.FreeTimers.Last) )
     {
@@ -129,16 +131,17 @@ static void fghVisibility( int status )
 {
     int glut_status = GLUT_VISIBLE;
 
-    freeglut_assert_ready;
-    freeglut_return_if_fail( fgStructure.Window );
+    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.Window ), Visibility, ( glut_status ) );
+    INVOKE_WCB( *( fgStructure.CurrentWindow ), Visibility, ( glut_status ) );
 }
 
 void FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutVisibilityFunc" );
     SET_CALLBACK( Visibility );
 
     if( callback )
@@ -153,6 +156,7 @@ void FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) )
 void FGAPIENTRY glutKeyboardUpFunc( void (* callback)
                                     ( unsigned char, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutKeyboardUpFunc" );
     SET_CALLBACK( KeyboardUp );
 }
 
@@ -161,6 +165,7 @@ void FGAPIENTRY glutKeyboardUpFunc( void (* callback)
  */
 void FGAPIENTRY glutSpecialUpFunc( void (* callback)( int, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSpecialUpFunc" );
     SET_CALLBACK( SpecialUp );
 }
 
@@ -171,16 +176,17 @@ 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;
 }
 
 /*
@@ -188,6 +194,7 @@ void FGAPIENTRY glutJoystickFunc( void (* callback)
  */
 void FGAPIENTRY glutMouseFunc( void (* callback)( int, int, int, int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMouseFunc" );
     SET_CALLBACK( Mouse );
 }
 
@@ -196,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 );
 }
 
@@ -205,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 );
 }
 
@@ -214,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 );
 }
 
@@ -222,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 );
 }
 
@@ -230,19 +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 )
-        fgStructure.Menu->Destroy = callback;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutMenuDestroyFunc" );
+    if( fgStructure.CurrentMenu )
+        fgStructure.CurrentMenu->Destroy = callback;
 }
 
 /*
@@ -250,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;
 }
 
@@ -259,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;
 }
 
@@ -268,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 );
 }
 
@@ -276,6 +291,7 @@ void FGAPIENTRY glutOverlayDisplayFunc( void (* callback)( void ) )
  */
 void FGAPIENTRY glutWindowStatusFunc( void (* callback)( int ) )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutWindowStatusFunc" );
     SET_CALLBACK( WindowStatus );
 }
 
@@ -284,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 );
 }
 
@@ -292,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 );
 }
 
@@ -300,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 );
 }
 
@@ -308,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 );
 }
 
@@ -316,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 );
 }
 
@@ -324,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 );
 }
 
@@ -332,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 );
 }