Removing some build warnings from deprecated functions for VS2008 per e-mail from...
[freeglut] / src / freeglut_input_devices.c
1 /*
2  * freeglut_input_devices.c
3  *
4  * Handles miscellaneous input devices via direct serial-port access.
5  * Proper X11 XInput device support is not yet supported.
6  * Also lacks Mac support.
7  *
8  * Written by Joe Krahn <krahn@niehs.nih.gov> 2005
9  *
10  * Copyright (c) 2005 Stephen J. Baker. All Rights Reserved.
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a
13  * copy of this software and associated documentation files (the "Software"),
14  * to deal in the Software without restriction, including without limitation
15  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16  * and/or sell copies of the Software, and to permit persons to whom the
17  * Software is furnished to do so, subject to the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be included
20  * in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
25  * PAWEL W. OLSZTA OR STEPHEN J. BAKER BE LIABLE FOR ANY CLAIM, DAMAGES OR
26  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28  * DEALINGS IN THE SOFTWARE.
29  */
30
31 #ifdef HAVE_CONFIG_H
32 #    include "config.h"
33 #endif
34
35 #include <GL/freeglut.h>
36 #include "freeglut_internal.h"
37
38 #if TARGET_HOST_POSIX_X11
39 #include <errno.h>
40 #include <sys/ioctl.h>
41 #include <sys/time.h>
42 #include <time.h>
43 #include <stdio.h>
44 #include <stdlib.h>
45 #include <unistd.h>
46 #include <string.h>
47 #include <termios.h>
48 #include <fcntl.h>
49 #include <sys/types.h>
50
51 typedef struct {
52    int fd;
53    struct termios termio, termio_save;
54 } SERIALPORT;
55
56 #elif TARGET_HOST_MS_WINDOWS
57 #include <sys/types.h>
58 #include <winbase.h>
59 typedef struct {
60    HANDLE fh;
61    COMMTIMEOUTS timeouts_save;
62    DCB dcb_save;
63 } SERIALPORT;
64
65 #endif
66
67 /********************* Dialbox definitions ***********************/
68
69 #define DIAL_NUM_VALUATORS 8
70
71 /* dial parser state machine states */
72 #define DIAL_NEW                (-1)
73 #define DIAL_WHICH_DEVICE       0
74 #define DIAL_VALUE_HIGH         1
75 #define DIAL_VALUE_LOW          2
76
77 /* dial/button box commands */
78 #define DIAL_INITIALIZE                 0x20
79 #define DIAL_SET_LEDS                   0x75
80 #define DIAL_SET_TEXT                   0x61
81 #define DIAL_SET_AUTO_DIALS             0x50
82 #define DIAL_SET_AUTO_DELTA_DIALS       0x51
83 #define DIAL_SET_FILTER                 0x53
84 #define DIAL_SET_BUTTONS_MOM_TYPE       0x71
85 #define DIAL_SET_AUTO_MOM_BUTTONS       0x73
86 #define DIAL_SET_ALL_LEDS               0x4b
87 #define DIAL_CLEAR_ALL_LEDS             0x4c
88
89 /* dial/button box replies and events */
90 #define DIAL_INITIALIZED        0x20
91 #define DIAL_BASE               0x30
92 #define DIAL_DELTA_BASE         0x40
93 #define DIAL_PRESS_BASE         0xc0
94 #define DIAL_RELEASE_BASE       0xe0
95
96 /* macros to determine reply type */
97 #define IS_DIAL_EVENT(ch)       (((ch)>=DIAL_BASE)&&((ch)<DIAL_BASE+DIAL_NUM_VALUATORS))
98 #define IS_KEY_PRESS(ch)        (((ch)>=DIAL_PRESS_BASE)&&((ch)<DIAL_PRESS_BASE+DIAL_NUM_BUTTONS))
99 #define IS_KEY_RELEASE(ch)      (((ch)>=DIAL_RELEASE_BASE)&&((ch)<DIAL_RELEASE_BASE+DIAL_NUM_BUTTONS))
100 #define IS_INIT_EVENT(ch)       ((ch)==DIAL_INITIALIZED)
101
102 /*****************************************************************/
103
104 static SERIALPORT *serial_open ( const char *device );
105 static void serial_close ( SERIALPORT *port );
106 static int serial_getchar ( SERIALPORT *port );
107 static int serial_putchar ( SERIALPORT *port, unsigned char ch );
108 static void serial_flush ( SERIALPORT *port );
109
110 static void send_dial_event(int dial, int value);
111 static void poll_dials(int id);
112
113 /* local variables */
114 static SERIALPORT *dialbox_port=NULL;
115
116 /*****************************************************************/
117
118 /*
119  * Implementation for glutDeviceGet(GLUT_HAS_DIAL_AND_BUTTON_BOX)
120  */
121 int fgInputDeviceDetect( void )
122 {
123     fgInitialiseInputDevices ();
124
125     if ( !dialbox_port )
126         return 0;
127
128     if ( !fgState.InputDevsInitialised )
129         return 0;
130
131     return 1;
132 }
133
134 /*
135  * Try initializing the input device(s)
136  */
137 void fgInitialiseInputDevices ( void )
138 {
139     const char *dial_device=NULL;
140     if( !fgState.InputDevsInitialised )
141     {
142 #if TARGET_HOST_MS_WINDOWS && ( _MSC_VER >= 1400 ) // will return true for VC8 (VC2005) and higher
143         size_t sLen;
144         errno_t err = _dupenv_s( &dial_device, &sLen, "GLUT_DIALS_SERIAL" );
145         if (err)
146             fgError("Error getting GLUT_DIALS_SERIAL environment variable");
147 #else
148         dial_device = getenv ( "GLUT_DIALS_SERIAL" );
149 #endif
150 #if TARGET_HOST_MS_WINDOWS
151         if (!dial_device){
152             static char devname[256];
153             DWORD size=sizeof(devname);
154             DWORD type = REG_SZ;
155             HKEY key;
156             if (RegOpenKeyA(HKEY_LOCAL_MACHINE,"SOFTWARE\\FreeGLUT",&key)==ERROR_SUCCESS) {
157                 if (RegQueryValueExA(key,"DialboxSerialPort",NULL,&type,(LPBYTE)devname,&size)==ERROR_SUCCESS){
158                     dial_device=devname;
159                 }
160                 RegCloseKey(key);
161             }
162         }
163 #endif
164         if ( !dial_device ) return;
165         if ( !( dialbox_port = serial_open ( dial_device ) ) ) return;
166 #if TARGET_HOST_MS_WINDOWS && ( _MSC_VER >= 1400 ) // will return true for VC8 (VC2005) and higher
167         free ( dial_device );  dial_device = NULL;  /* dupenv_s allocates a string that we must free */
168 #endif
169         serial_putchar(dialbox_port,DIAL_INITIALIZE);
170         glutTimerFunc ( 10, poll_dials, 0 );
171         fgState.InputDevsInitialised = GL_TRUE;
172     }
173 }
174
175 /*
176  *
177  */
178 void fgInputDeviceClose( void )
179 {
180     if ( fgState.InputDevsInitialised )
181     {
182         serial_close ( dialbox_port );
183         dialbox_port = NULL;
184         fgState.InputDevsInitialised = GL_FALSE;
185     }
186 }
187
188 /********************************************************************/
189
190 /* Check all windows for dialbox callbacks */
191 static void fghcbEnumDialCallbacks ( SFG_Window *window, SFG_Enumerator *enumerator )
192 {
193     /* Built-in to INVOKE_WCB():  if window->Callbacks[CB_Dials] */
194     INVOKE_WCB ( *window,Dials, ( ((int*)enumerator->data)[0], ((int*)enumerator->data)[1]) );
195     fgEnumSubWindows ( window, fghcbEnumDialCallbacks, enumerator );
196 }
197
198 static void send_dial_event ( int num, int value )
199 {
200     SFG_Enumerator enumerator;
201     int data[2];
202     data[0] = num;
203     data[1] = value;
204     enumerator.found = GL_FALSE;
205     enumerator.data  =  data;
206     fgEnumWindows ( fghcbEnumDialCallbacks, &enumerator );
207 }
208
209 /********************************************************************/
210 static void poll_dials ( int id )
211 {
212     int data;
213     static int dial_state = DIAL_NEW;
214     static int dial_which;
215     static int dial_value;
216     static int dials[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
217
218     if ( !dialbox_port ) return;
219
220     while ( (data=serial_getchar(dialbox_port)) != EOF )
221     {
222         if ( ( dial_state > DIAL_WHICH_DEVICE ) || IS_DIAL_EVENT ( data ) )
223         {
224             switch ( dial_state )
225             {
226             case DIAL_WHICH_DEVICE:
227                 dial_which = data - DIAL_BASE;
228                 dial_state++;
229                 break;
230             case DIAL_VALUE_HIGH:
231                 dial_value = ( data << 8 );
232                 dial_state++;
233                 break;
234             case DIAL_VALUE_LOW:
235                 dial_value |= data;
236                 if ( dial_value & 0x8000 ) dial_value -= 0x10000;
237                 dials[dial_which] = dial_value;
238                 send_dial_event ( dial_which + 1, dial_value * 360 / 256 );
239                 dial_state = DIAL_WHICH_DEVICE;
240                 break;
241             default:
242                 /* error: Impossible state value! */
243                 break;
244             }
245         }
246         else if ( data == DIAL_INITIALIZED )
247         {
248             fgState.InputDevsInitialised = GL_TRUE;
249             dial_state = DIAL_WHICH_DEVICE;
250             serial_putchar(dialbox_port,DIAL_SET_AUTO_DIALS);
251             serial_putchar(dialbox_port,0xff);
252             serial_putchar(dialbox_port,0xff);
253         }
254         else  /* Unknown data; try flushing. */
255             serial_flush(dialbox_port);
256     }
257
258     glutTimerFunc ( 2, poll_dials, 0 );
259 }
260
261
262 /******** OS Specific Serial I/O routines *******/
263 #if TARGET_HOST_POSIX_X11 /* ==> Linux/BSD/UNIX POSIX serial I/O */
264 static SERIALPORT *serial_open ( const char *device )
265 {
266     int fd;
267     struct termios termio;
268     SERIALPORT *port;
269
270     fd = open(device, O_RDWR | O_NONBLOCK );
271     if (fd <0) {
272         perror(device);
273         return NULL;
274     }
275
276     port = malloc(sizeof(SERIALPORT));
277     memset(port, 0, sizeof(SERIALPORT));
278     port->fd = fd;
279
280     /* save current port settings */
281     tcgetattr(fd,&port->termio_save);
282
283     memset(&termio, 0, sizeof(termio));
284     termio.c_cflag = CS8 | CREAD | HUPCL ;
285     termio.c_iflag = IGNPAR | IGNBRK ;
286     termio.c_cc[VTIME]    = 0;   /* inter-character timer */
287     termio.c_cc[VMIN]     = 1;   /* block read until 1 chars received, when blocking I/O */
288
289     cfsetispeed(&termio, B9600);
290     cfsetospeed(&termio, B9600);
291     tcsetattr(fd,TCSANOW,&termio);
292
293     serial_flush(port);
294     return port;
295 }
296
297 static void serial_close(SERIALPORT *port)
298 {
299     if (port)
300     {
301         /* restore old port settings */
302         tcsetattr(port->fd,TCSANOW,&port->termio_save);
303         close(port->fd);
304         free(port);
305     }
306 }
307
308 static int serial_getchar(SERIALPORT *port)
309 {
310     unsigned char ch;
311     if (!port) return EOF;
312     if (read(port->fd,&ch,1)) return ch;
313     return EOF;
314 }
315
316 static int serial_putchar(SERIALPORT *port, unsigned char ch){
317     if (!port) return 0;
318     return write(port->fd,&ch,1);
319 }
320
321 static void serial_flush ( SERIALPORT *port )
322 {
323     tcflush ( port->fd, TCIOFLUSH );
324 }
325
326 #elif TARGET_HOST_MS_WINDOWS
327
328 static SERIALPORT *serial_open(const char *device){
329     HANDLE fh;
330     DCB dcb={sizeof(DCB)};
331     COMMTIMEOUTS timeouts;
332     SERIALPORT *port;
333
334     fh = CreateFile(device,GENERIC_READ|GENERIC_WRITE,0,NULL,
335       OPEN_EXISTING,FILE_ATTRIBUTE_NORMAL,NULL);
336     if (!fh) return NULL;
337
338     port = malloc(sizeof(SERIALPORT));
339     ZeroMemory(port, sizeof(SERIALPORT));
340     port->fh = fh;
341
342     /* save current port settings */
343     GetCommState(fh,&port->dcb_save);
344     GetCommTimeouts(fh,&port->timeouts_save);
345
346     dcb.DCBlength=sizeof(DCB);
347     BuildCommDCB("96,n,8,1",&dcb);
348     SetCommState(fh,&dcb);
349
350     ZeroMemory(&timeouts,sizeof(timeouts));
351     timeouts.ReadTotalTimeoutConstant=1;
352     timeouts.WriteTotalTimeoutConstant=1;
353     SetCommTimeouts(fh,&timeouts);
354
355     serial_flush(port);
356
357     return port;
358 }
359
360 static void serial_close(SERIALPORT *port){
361     if (port){
362         /* restore old port settings */
363         SetCommState(port->fh,&port->dcb_save);
364         SetCommTimeouts(port->fh,&port->timeouts_save);
365         CloseHandle(port->fh);
366         free(port);
367     }
368 }
369
370 static int serial_getchar(SERIALPORT *port){
371     DWORD n;
372     unsigned char ch;
373     if (!port) return EOF;
374     if (!ReadFile(port->fh,&ch,1,&n,NULL)) return EOF;
375     if (n==1) return ch;
376     return EOF;
377 }
378
379 static int serial_putchar(SERIALPORT *port, unsigned char ch){
380     DWORD n;
381     if (!port) return 0;
382     return WriteFile(port->fh,&ch,1,&n,NULL);
383 }
384
385 static void serial_flush ( SERIALPORT *port )
386 {
387     FlushFileBuffers(port->fh);
388 }
389
390 #endif