Cleanup pass after committing callback conversion (from structure to
[freeglut] / src / freeglut_callbacks.c
1 /*
2  * freeglut_callbacks.c
3  *
4  * The callbacks setting methods.
5  *
6  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
7  * Written by Pawel W. Olszta, <olszta@sourceforge.net>
8  * Creation date: Fri Dec 3 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 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include "../include/GL/freeglut.h"
33 #include "freeglut_internal.h"
34
35
36 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
37
38 /*
39  * All of the callbacks setting methods can be generalized to this:
40  */
41 #define SET_CALLBACK(a)              \
42     if( fgStructure.Window == NULL ) \
43         return;                      \
44     FETCH_WCB( ( *( fgStructure.Window ) ), a ) = callback;
45
46 /*
47  * Sets the Display callback for the current window
48  */
49 void FGAPIENTRY glutDisplayFunc( void (* callback)( void ) )
50 {
51     if( !callback )
52         fgError( "Fatal error in program.  NULL display callback not "
53                  "permitted in GLUT 3.0+ or freeglut 2.0.1+\n" );
54     SET_CALLBACK( Display );
55     fgStructure.Window->State.Redisplay = TRUE;
56 }
57
58 /*
59  * Sets the Reshape callback for the current window
60  */
61 void FGAPIENTRY glutReshapeFunc( void (* callback)( int, int ) )
62 {
63     SET_CALLBACK( Reshape );
64 }
65
66 /*
67  * Sets the Keyboard callback for the current window
68  */
69 void FGAPIENTRY glutKeyboardFunc( void (* callback)
70                                   ( unsigned char, int, int ) )
71 {
72     SET_CALLBACK( Keyboard );
73 }
74
75 /*
76  * Sets the Special callback for the current window
77  */
78 void FGAPIENTRY glutSpecialFunc( void (* callback)( int, int, int ) )
79 {
80     SET_CALLBACK( Special );
81 }
82
83 /*
84  * Sets the global idle callback
85  */
86 void FGAPIENTRY glutIdleFunc( void (* callback)( void ) )
87 {
88     freeglut_assert_ready;
89     fgState.IdleCallback = callback;
90 }
91
92 /*
93  * Sets the Timer callback for the current window
94  */
95 void FGAPIENTRY glutTimerFunc( unsigned int timeOut, void (* callback)( int ),
96                                int timerID )
97 {
98     SFG_Timer* timer;
99
100     freeglut_assert_ready;
101
102     timer = (SFG_Timer *)calloc( sizeof(SFG_Timer), 1 );
103     if( !timer )
104         fgError( "Fatal error: "
105                  "Memory allocation failure in glutTimerFunc()\n" );
106
107     timer->Callback  = callback;
108     timer->ID        = timerID;
109     timer->TriggerTime = fgElapsedTime() + timeOut;
110     fgListAppend( &fgState.Timers, &timer->Node );
111 }
112
113 /*
114  * Sets the Visibility callback for the current window.
115  */
116 static void fghVisibility( int status )
117 {
118     FGCBVisibility vis;
119     int glut_status;
120     
121     freeglut_assert_ready;
122     freeglut_return_if_fail( fgStructure.Window );
123     vis = FETCH_WCB( ( *( fgStructure.Window ) ), Visibility );
124     freeglut_return_if_fail( vis );
125
126     if( status == GLUT_HIDDEN  || status == GLUT_FULLY_COVERED )
127         glut_status = GLUT_NOT_VISIBLE;
128     else
129         glut_status = GLUT_VISIBLE;
130     vis( glut_status );
131 }
132
133 void FGAPIENTRY glutVisibilityFunc( void (* callback)( int ) )
134 {
135     SET_CALLBACK( Visibility );
136
137     if( callback )
138         glutWindowStatusFunc( fghVisibility );
139     else
140         glutWindowStatusFunc( NULL );
141 }
142
143 /*
144  * Sets the keyboard key release callback for the current window
145  */
146 void FGAPIENTRY glutKeyboardUpFunc( void (* callback)
147                                     ( unsigned char, int, int ) )
148 {
149     SET_CALLBACK( KeyboardUp );
150 }
151
152 /*
153  * Sets the special key release callback for the current window
154  */
155 void FGAPIENTRY glutSpecialUpFunc( void (* callback)( int, int, int ) )
156 {
157     SET_CALLBACK( SpecialUp );
158 }
159
160 /*
161  * Sets the joystick callback and polling rate for the current window
162  */
163 void FGAPIENTRY glutJoystickFunc( void (* callback)
164                                   ( unsigned int, int, int, int ),
165                                   int pollInterval )
166 {
167     SET_CALLBACK( Joystick );
168     fgStructure.Window->State.JoystickPollRate = pollInterval;
169
170     fgStructure.Window->State.JoystickLastPoll =
171         fgElapsedTime() - fgStructure.Window->State.JoystickPollRate;
172
173     if( fgStructure.Window->State.JoystickLastPoll < 0 )
174         fgStructure.Window->State.JoystickLastPoll = 0;
175 }
176
177 /*
178  * Sets the mouse callback for the current window
179  */
180 void FGAPIENTRY glutMouseFunc( void (* callback)( int, int, int, int ) )
181 {
182     SET_CALLBACK( Mouse );
183 }
184
185 /*
186  * Sets the mouse wheel callback for the current window
187  */
188 void FGAPIENTRY glutMouseWheelFunc( void (* callback)( int, int, int, int ) )
189 {
190     SET_CALLBACK( MouseWheel );
191 }
192
193 /*
194  * Sets the mouse motion callback for the current window (one or more buttons
195  * are pressed)
196  */
197 void FGAPIENTRY glutMotionFunc( void (* callback)( int, int ) )
198 {
199     SET_CALLBACK( Motion );
200 }
201
202 /*
203  * Sets the passive mouse motion callback for the current window (no mouse
204  * buttons are pressed)
205  */
206 void FGAPIENTRY glutPassiveMotionFunc( void (* callback)( int, int ) )
207 {
208     SET_CALLBACK( Passive );
209 }
210
211 /*
212  * Window mouse entry/leave callback
213  */
214 void FGAPIENTRY glutEntryFunc( void (* callback)( int ) )
215 {
216     SET_CALLBACK( Entry );
217 }
218
219 /*
220  * Window destruction callbacks
221  */
222 void FGAPIENTRY glutCloseFunc( void (* callback)( void ) )
223 {
224     SET_CALLBACK( Destroy );
225 }
226
227 void FGAPIENTRY glutWMCloseFunc( void (* callback)( void ) )
228 {
229     glutCloseFunc( callback );
230 }
231
232 /* A. Donev: Destruction callback for menus */
233 void FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) )
234 {
235     if( fgStructure.Menu == NULL )
236         return;
237     fgStructure.Menu->Destroy = callback;
238 }
239
240 /*
241  * Deprecated version of glutMenuStatusFunc callback setting method
242  */
243 void FGAPIENTRY glutMenuStateFunc( void (* callback)( int ) )
244 {
245     freeglut_assert_ready;
246     fgState.MenuStateCallback = callback;
247 }
248
249 /*
250  * Sets the global menu status callback for the current window
251  */
252 void FGAPIENTRY glutMenuStatusFunc( void (* callback)( int, int, int ) )
253 {
254     freeglut_assert_ready;
255     fgState.MenuStatusCallback = callback;
256 }
257
258 /*
259  * Sets the overlay display callback for the current window
260  */
261 void FGAPIENTRY glutOverlayDisplayFunc( void (* callback)( void ) )
262 {
263     SET_CALLBACK( OverlayDisplay );
264 }
265
266 /*
267  * Sets the window status callback for the current window
268  */
269 void FGAPIENTRY glutWindowStatusFunc( void (* callback)( int ) )
270 {
271     SET_CALLBACK( WindowStatus );
272 }
273
274 /*
275  * Sets the spaceball motion callback for the current window
276  */
277 void FGAPIENTRY glutSpaceballMotionFunc( void (* callback)( int, int, int ) )
278 {
279     SET_CALLBACK( SpaceMotion );
280 }
281
282 /*
283  * Sets the spaceball rotate callback for the current window
284  */
285 void FGAPIENTRY glutSpaceballRotateFunc( void (* callback)( int, int, int ) )
286 {
287     SET_CALLBACK( SpaceRotation );
288 }
289
290 /*
291  * Sets the spaceball button callback for the current window
292  */
293 void FGAPIENTRY glutSpaceballButtonFunc( void (* callback)( int, int ) )
294 {
295     SET_CALLBACK( SpaceButton );
296 }
297
298 /*
299  * Sets the button box callback for the current window
300  */
301 void FGAPIENTRY glutButtonBoxFunc( void (* callback)( int, int ) )
302 {
303     SET_CALLBACK( ButtonBox );
304 }
305
306 /*
307  * Sets the dials box callback for the current window
308  */
309 void FGAPIENTRY glutDialsFunc( void (* callback)( int, int ) )
310 {
311     SET_CALLBACK( Dials );
312 }
313
314 /*
315  * Sets the tablet motion callback for the current window
316  */
317 void FGAPIENTRY glutTabletMotionFunc( void (* callback)( int, int ) )
318 {
319     SET_CALLBACK( TabletMotion );
320 }
321
322 /*
323  * Sets the tablet buttons callback for the current window
324  */
325 void FGAPIENTRY glutTabletButtonFunc( void (* callback)( int, int, int, int ) )
326 {
327     SET_CALLBACK( TabletButton );
328 }
329
330 /*** END OF FILE ***/