joystick updates from John Fay
[freeglut] / src / freeglut_init.c
1 /*
2  * freeglut_init.c
3  *
4  * Various freeglut initialization functions.
5  *
6  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
7  * Written by Pawel W. Olszta, <olszta@sourceforge.net>
8  * Creation date: Thu Dec 2 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 <GL/freeglut.h>
33 #include "freeglut_internal.h"
34
35 /*
36  * TODO BEFORE THE STABLE RELEASE:
37  *
38  *  fgDeinitialize()        -- Win32's OK, X11 needs the OS-specific
39  *                             deinitialization done
40  *  glutInitDisplayString() -- display mode string parsing
41  *
42  * Wouldn't it be cool to use gettext() for error messages? I just love
43  * bash saying  "nie znaleziono pliku" instead of "file not found" :)
44  * Is gettext easily portable?
45  */
46
47 /* -- GLOBAL VARIABLES ----------------------------------------------------- */
48
49 /*
50  * A structure pointed by g_pDisplay holds all information
51  * regarding the display, screen, root window etc.
52  */
53 SFG_Display fgDisplay;
54
55 /*
56  * The settings for the current freeglut session
57  */
58 SFG_State fgState = { { -1, -1, GL_FALSE },  /* Position */
59                       { 300, 300, GL_TRUE }, /* Size */
60                       GLUT_RGBA | GLUT_SINGLE | GLUT_DEPTH,  /* DisplayMode */
61                       GL_FALSE,              /* Initialised */
62                       GLUT_TRY_DIRECT_CONTEXT,  /* DirectContext */
63                       GL_FALSE,              /* ForceIconic */
64                       GL_FALSE,              /* UseCurrentContext */
65                       GL_FALSE,              /* GLDebugSwitch */
66                       GL_FALSE,              /* XSyncSwitch */
67                       GL_TRUE,               /* KeyRepeat */
68                       0xffffffff,            /* Modifiers */
69                       0,                     /* FPSInterval */
70                       0,                     /* SwapCount */
71                       0,                     /* SwapTime */
72 #if TARGET_HOST_WIN32 || TARGET_HOST_WINCE
73                       { 0, GL_FALSE },       /* Time */
74 #else
75                       { { 0, 0 }, GL_FALSE },
76 #endif
77                       { NULL, NULL },         /* Timers */
78                       { NULL, NULL },         /* FreeTimers */
79                       NULL,                   /* IdleCallback */
80                       0,                      /* ActiveMenus */
81                       NULL,                   /* MenuStateCallback */
82                       NULL,                   /* MenuStatusCallback */
83                       { 640, 480, GL_TRUE },  /* GameModeSize */
84                       16,                     /* GameModeDepth */
85                       72,                     /* GameModeRefresh */
86                       GLUT_ACTION_EXIT,       /* ActionOnWindowClose */
87                       GLUT_EXEC_STATE_INIT,   /* ExecState */
88                       NULL,                   /* ProgramName */
89                       GL_FALSE                /* JoysticksInitialised */
90 };
91
92
93 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
94
95 /*
96  * A call to this function should initialize all the display stuff...
97  */
98 void fgInitialize( const char* displayName )
99 {
100 #if TARGET_HOST_UNIX_X11
101     fgDisplay.Display = XOpenDisplay( displayName );
102
103     if( fgDisplay.Display == NULL )
104         fgError( "failed to open display '%s'", XDisplayName( displayName ) );
105
106     if( !glXQueryExtension( fgDisplay.Display, NULL, NULL ) )
107         fgError( "OpenGL GLX extension not supported by display '%s'",
108             XDisplayName( displayName ) );
109
110     fgDisplay.Screen = DefaultScreen( fgDisplay.Display );
111     fgDisplay.RootWindow = RootWindow(
112         fgDisplay.Display,
113         fgDisplay.Screen
114     );
115
116     fgDisplay.ScreenWidth  = DisplayWidth(
117         fgDisplay.Display,
118         fgDisplay.Screen
119     );
120     fgDisplay.ScreenHeight = DisplayHeight(
121         fgDisplay.Display,
122         fgDisplay.Screen
123     );
124
125     fgDisplay.ScreenWidthMM = DisplayWidthMM(
126         fgDisplay.Display,
127         fgDisplay.Screen
128     );
129     fgDisplay.ScreenHeightMM = DisplayHeightMM(
130         fgDisplay.Display,
131         fgDisplay.Screen
132     );
133
134     fgDisplay.Connection = ConnectionNumber( fgDisplay.Display );
135
136     /* Create the window deletion atom */
137     fgDisplay.DeleteWindow = XInternAtom(
138         fgDisplay.Display,
139         "WM_DELETE_WINDOW",
140         FALSE
141     );
142
143 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
144
145     WNDCLASS wc;
146     ATOM atom;
147
148     /* What we need to do is to initialize the fgDisplay global structure here. */
149     fgDisplay.Instance = GetModuleHandle( NULL );
150
151     atom = GetClassInfo( fgDisplay.Instance, _T("FREEGLUT"), &wc );
152
153     if( atom == 0 )
154     {
155         ZeroMemory( &wc, sizeof(WNDCLASS) );
156
157         /*
158          * Each of the windows should have its own device context, and we
159          * want redraw events during Vertical and Horizontal Resizes by
160          * the user.
161          *
162          * XXX Old code had "| CS_DBCLCKS" commented out.  Plans for the
163          * XXX future?  Dead-end idea?
164          */
165         wc.lpfnWndProc    = fgWindowProc;
166         wc.cbClsExtra     = 0;
167         wc.cbWndExtra     = 0;
168         wc.hInstance      = fgDisplay.Instance;
169         wc.hIcon          = LoadIcon( fgDisplay.Instance, _T("GLUT_ICON") );
170
171 #if TARGET_HOST_WIN32
172         wc.style          = CS_OWNDC | CS_HREDRAW | CS_VREDRAW;
173         if (!wc.hIcon)
174           wc.hIcon        = LoadIcon( NULL, IDI_WINLOGO );
175 #else /* TARGET_HOST_WINCE */
176         wc.style          = CS_HREDRAW | CS_VREDRAW;
177 #endif
178
179         wc.hCursor        = LoadCursor( NULL, IDC_ARROW );
180         wc.hbrBackground  = NULL;
181         wc.lpszMenuName   = NULL;
182         wc.lpszClassName  = _T("FREEGLUT");
183
184         /* Register the window class */
185         atom = RegisterClass( &wc );
186         assert( atom );
187     }
188
189     /* The screen dimensions can be obtained via GetSystemMetrics() calls */
190     fgDisplay.ScreenWidth  = GetSystemMetrics( SM_CXSCREEN );
191     fgDisplay.ScreenHeight = GetSystemMetrics( SM_CYSCREEN );
192
193     {
194         HWND desktop = GetDesktopWindow( );
195         HDC  context = GetDC( desktop );
196
197         fgDisplay.ScreenWidthMM  = GetDeviceCaps( context, HORZSIZE );
198         fgDisplay.ScreenHeightMM = GetDeviceCaps( context, VERTSIZE );
199
200         ReleaseDC( desktop, context );
201     }
202
203 #endif
204
205     fgState.Initialised = GL_TRUE;
206 }
207
208 /*
209  * Perform the freeglut deinitialization...
210  */
211 void fgDeinitialize( void )
212 {
213     SFG_Timer *timer;
214
215     if( !fgState.Initialised )
216     {
217         fgWarning( "fgDeinitialize(): "
218                    "no valid initialization has been performed" );
219         return;
220     }
221
222     /* fgState.Initialised = GL_FALSE; */
223
224     /* If there was a menu created, destroy the rendering context */
225     if( fgStructure.MenuContext )
226     {
227         free( fgStructure.MenuContext );
228         fgStructure.MenuContext = NULL;
229     }
230
231     fgDestroyStructure( );
232
233     while( (timer = fgState.Timers.First) )
234     {
235         fgListRemove( &fgState.Timers, &timer->Node );
236         free( timer );
237     }
238
239     while( (timer = fgState.FreeTimers.First) )
240     {
241         fgListRemove( &fgState.FreeTimers, &timer->Node );
242         free( timer );
243     }
244
245 #if !TARGET_HOST_WINCE
246     if ( fgState.JoysticksInitialised )
247         fgJoystickClose( );
248 #endif /* !TARGET_HOST_WINCE */
249     fgState.JoysticksInitialised = GL_FALSE;
250
251     fgState.Initialised = GL_FALSE;
252
253     fgState.Position.X = -1;
254     fgState.Position.Y = -1;
255     fgState.Position.Use = GL_FALSE;
256
257     fgState.Size.X = 300;
258     fgState.Size.Y = 300;
259     fgState.Size.Use = GL_TRUE;
260
261     fgState.DisplayMode = GLUT_RGBA | GLUT_SINGLE | GLUT_DEPTH;
262
263     fgState.DirectContext  = GLUT_TRY_DIRECT_CONTEXT;
264     fgState.ForceIconic         = GL_FALSE;
265     fgState.UseCurrentContext   = GL_FALSE;
266     fgState.GLDebugSwitch       = GL_FALSE;
267     fgState.XSyncSwitch         = GL_FALSE;
268     fgState.ActionOnWindowClose = GLUT_ACTION_EXIT;
269     fgState.ExecState           = GLUT_EXEC_STATE_INIT;
270
271     fgState.KeyRepeat       = GL_FALSE;
272     fgState.Modifiers       = 0xffffffff;
273
274     fgState.GameModeSize.X  = 640;
275     fgState.GameModeSize.Y  = 480;
276     fgState.GameModeDepth   =  16;
277     fgState.GameModeRefresh =  72;
278
279     fgState.Time.Set = GL_FALSE;
280
281     fgListInit( &fgState.Timers );
282     fgListInit( &fgState.FreeTimers );
283
284     fgState.IdleCallback = NULL;
285     fgState.MenuStateCallback = ( FGCBMenuState )NULL;
286     fgState.MenuStatusCallback = ( FGCBMenuStatus )NULL;
287
288     fgState.SwapCount   = 0;
289     fgState.SwapTime    = 0;
290     fgState.FPSInterval = 0;
291
292     if( fgState.ProgramName )
293     {
294         free( fgState.ProgramName );
295         fgState.ProgramName = NULL;
296     }
297
298
299 #if TARGET_HOST_UNIX_X11
300
301     /*
302      * Make sure all X-client data we have created will be destroyed on
303      * display closing
304      */
305     XSetCloseDownMode( fgDisplay.Display, DestroyAll );
306
307     /*
308      * Close the display connection, destroying all windows we have
309      * created so far
310      */
311     XCloseDisplay( fgDisplay.Display );
312
313 #endif
314 }
315
316 /*
317  * Everything inside the following #ifndef is copied from the X sources.
318  */
319
320 #if TARGET_HOST_WIN32 || TARGET_HOST_WINCE
321
322 /*
323
324 Copyright 1985, 1986, 1987,1998  The Open Group
325
326 Permission to use, copy, modify, distribute, and sell this software and its
327 documentation for any purpose is hereby granted without fee, provided that
328 the above copyright notice appear in all copies and that both that
329 copyright notice and this permission notice appear in supporting
330 documentation.
331
332 The above copyright notice and this permission notice shall be included
333 in all copies or substantial portions of the Software.
334
335 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
336 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
337 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
338 IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
339 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
340 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
341 OTHER DEALINGS IN THE SOFTWARE.
342
343 Except as contained in this notice, the name of The Open Group shall
344 not be used in advertising or otherwise to promote the sale, use or
345 other dealings in this Software without prior written authorization
346 from The Open Group.
347
348 */
349
350 #define NoValue         0x0000
351 #define XValue          0x0001
352 #define YValue          0x0002
353 #define WidthValue      0x0004
354 #define HeightValue     0x0008
355 #define AllValues       0x000F
356 #define XNegative       0x0010
357 #define YNegative       0x0020
358
359 /*
360  *    XParseGeometry parses strings of the form
361  *   "=<width>x<height>{+-}<xoffset>{+-}<yoffset>", where
362  *   width, height, xoffset, and yoffset are unsigned integers.
363  *   Example:  "=80x24+300-49"
364  *   The equal sign is optional.
365  *   It returns a bitmask that indicates which of the four values
366  *   were actually found in the string.  For each value found,
367  *   the corresponding argument is updated;  for each value
368  *   not found, the corresponding argument is left unchanged.
369  */
370
371 static int
372 ReadInteger(char *string, char **NextString)
373 {
374     register int Result = 0;
375     int Sign = 1;
376
377     if (*string == '+')
378         string++;
379     else if (*string == '-')
380     {
381         string++;
382         Sign = -1;
383     }
384     for (; (*string >= '0') && (*string <= '9'); string++)
385     {
386         Result = (Result * 10) + (*string - '0');
387     }
388     *NextString = string;
389     if (Sign >= 0)
390         return Result;
391     else
392         return -Result;
393 }
394
395 static int XParseGeometry (
396     const char *string,
397     int *x,
398     int *y,
399     unsigned int *width,    /* RETURN */
400     unsigned int *height)    /* RETURN */
401 {
402     int mask = NoValue;
403     register char *strind;
404     unsigned int tempWidth = 0, tempHeight = 0;
405     int tempX = 0, tempY = 0;
406     char *nextCharacter;
407
408     if ( (string == NULL) || (*string == '\0'))
409       return mask;
410     if (*string == '=')
411         string++;  /* ignore possible '=' at beg of geometry spec */
412
413     strind = (char *)string;
414     if (*strind != '+' && *strind != '-' && *strind != 'x') {
415         tempWidth = ReadInteger(strind, &nextCharacter);
416         if (strind == nextCharacter)
417             return 0;
418         strind = nextCharacter;
419         mask |= WidthValue;
420     }
421
422     if (*strind == 'x' || *strind == 'X') {
423         strind++;
424         tempHeight = ReadInteger(strind, &nextCharacter);
425         if (strind == nextCharacter)
426             return 0;
427         strind = nextCharacter;
428         mask |= HeightValue;
429     }
430
431     if ((*strind == '+') || (*strind == '-')) {
432         if (*strind == '-') {
433             strind++;
434             tempX = -ReadInteger(strind, &nextCharacter);
435             if (strind == nextCharacter)
436                 return 0;
437             strind = nextCharacter;
438             mask |= XNegative;
439         }
440         else
441         {
442             strind++;
443             tempX = ReadInteger(strind, &nextCharacter);
444             if (strind == nextCharacter)
445                 return 0;
446             strind = nextCharacter;
447         }
448         mask |= XValue;
449         if ((*strind == '+') || (*strind == '-')) {
450             if (*strind == '-') {
451                 strind++;
452                 tempY = -ReadInteger(strind, &nextCharacter);
453                 if (strind == nextCharacter)
454                     return 0;
455                 strind = nextCharacter;
456                 mask |= YNegative;
457             }
458             else
459             {
460                 strind++;
461                 tempY = ReadInteger(strind, &nextCharacter);
462                 if (strind == nextCharacter)
463                     return 0;
464                 strind = nextCharacter;
465             }
466             mask |= YValue;
467         }
468     }
469
470     /* If strind isn't at the end of the string the it's an invalid
471        geometry specification. */
472
473     if (*strind != '\0') return 0;
474
475     if (mask & XValue)
476         *x = tempX;
477     if (mask & YValue)
478         *y = tempY;
479     if (mask & WidthValue)
480         *width = tempWidth;
481     if (mask & HeightValue)
482         *height = tempHeight;
483     return mask;
484 }
485 #endif
486
487 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
488
489 /*
490  * Perform initialization. This usually happens on the program startup
491  * and restarting after glutMainLoop termination...
492  */
493 void FGAPIENTRY glutInit( int* pargc, char** argv )
494 {
495     char* displayName = NULL;
496     char* geometry = NULL;
497     int i, j, argc = *pargc;
498
499     if( fgState.Initialised )
500         fgError( "illegal glutInit() reinitialization attempt" );
501
502     if (pargc && *pargc && argv && *argv && **argv)
503     {
504         fgState.ProgramName = strdup (*argv);
505
506         if( !fgState.ProgramName )
507             fgError ("Could not allocate space for the program's name.");
508     }
509
510     fgCreateStructure( );
511
512     fgElapsedTime( );
513
514     /* check if GLUT_FPS env var is set */
515 #if !TARGET_HOST_WINCE
516     {
517         const char *fps = getenv( "GLUT_FPS" );
518         if( fps )
519         {
520             int interval;
521             sscanf( fps, "%d", &interval );
522
523             if( interval <= 0 )
524                 fgState.FPSInterval = 5000;  /* 5000 millisecond default */
525             else
526                 fgState.FPSInterval = interval;
527         }
528     }
529
530     displayName = getenv( "DISPLAY");
531
532     for( i = 1; i < argc; i++ )
533     {
534         if( strcmp( argv[ i ], "-display" ) == 0 )
535         {
536             if( ++i >= argc )
537                 fgError( "-display parameter must be followed by display name" );
538
539             displayName = argv[ i ];
540
541             argv[ i - 1 ] = NULL;
542             argv[ i     ] = NULL;
543             ( *pargc ) -= 2;
544         }
545         else if( strcmp( argv[ i ], "-geometry" ) == 0 )
546         {
547             if( ++i >= argc )
548                 fgError( "-geometry parameter must be followed by window "
549                          "geometry settings" );
550
551             geometry = argv[ i ];
552
553             argv[ i - 1 ] = NULL;
554             argv[ i     ] = NULL;
555             ( *pargc ) -= 2;
556         }
557         else if( strcmp( argv[ i ], "-direct" ) == 0)
558         {
559             if( fgState.DirectContext == GLUT_FORCE_INDIRECT_CONTEXT )
560                 fgError( "parameters ambiguity, -direct and -indirect "
561                     "cannot be both specified" );
562
563             fgState.DirectContext = GLUT_FORCE_DIRECT_CONTEXT;
564             argv[ i ] = NULL;
565             ( *pargc )--;
566         }
567         else if( strcmp( argv[ i ], "-indirect" ) == 0 )
568         {
569             if( fgState.DirectContext == GLUT_FORCE_DIRECT_CONTEXT )
570                 fgError( "parameters ambiguity, -direct and -indirect "
571                     "cannot be both specified" );
572
573             fgState.DirectContext = GLUT_FORCE_INDIRECT_CONTEXT;
574             argv[ i ] = NULL;
575             (*pargc)--;
576         }
577         else if( strcmp( argv[ i ], "-iconic" ) == 0 )
578         {
579             fgState.ForceIconic = GL_TRUE;
580             argv[ i ] = NULL;
581             ( *pargc )--;
582         }
583         else if( strcmp( argv[ i ], "-gldebug" ) == 0 )
584         {
585             fgState.GLDebugSwitch = GL_TRUE;
586             argv[ i ] = NULL;
587             ( *pargc )--;
588         }
589         else if( strcmp( argv[ i ], "-sync" ) == 0 )
590         {
591             fgState.XSyncSwitch = GL_TRUE;
592             argv[ i ] = NULL;
593             ( *pargc )--;
594         }
595     }
596
597     /*
598      * Compact {argv}.
599      */
600     j = 2;
601     for( i = 1; i < *pargc; i++, j++ )
602     {
603         if( argv[ i ] == NULL )
604         {
605             /* Guaranteed to end because there are "*pargc" arguments left */
606             while ( argv[ j ] == NULL )
607                 j++;
608             argv[ i ] = argv[ j ];
609         }
610     }
611
612 #endif /* TARGET_HOST_WINCE */
613
614     /*
615      * Have the display created now. If there wasn't a "-display"
616      * in the program arguments, we will use the DISPLAY environment
617      * variable for opening the X display (see code above):
618      */
619     fgInitialize( displayName );
620
621     /*
622      * Geometry parsing deffered until here because we may need the screen
623      * size.
624      */
625
626     if (geometry )
627     {
628         int mask = XParseGeometry( geometry,
629                                    &fgState.Position.X, &fgState.Position.Y,
630                                    &fgState.Size.X, &fgState.Size.Y );
631
632         if( (mask & (WidthValue|HeightValue)) == (WidthValue|HeightValue) )
633             fgState.Size.Use = GL_TRUE;
634
635         if( mask & XNegative )
636             fgState.Position.X += fgDisplay.ScreenWidth - fgState.Size.X;
637
638         if( mask & YNegative )
639             fgState.Position.Y += fgDisplay.ScreenHeight - fgState.Size.Y;
640
641         if( (mask & (XValue|YValue)) == (XValue|YValue) )
642             fgState.Position.Use = GL_TRUE;
643     }
644 }
645
646 /*
647  * Sets the default initial window position for new windows
648  */
649 void FGAPIENTRY glutInitWindowPosition( int x, int y )
650 {
651     fgState.Position.X = x;
652     fgState.Position.Y = y;
653
654     if( ( x >= 0 ) && ( y >= 0 ) )
655         fgState.Position.Use = GL_TRUE;
656     else
657         fgState.Position.Use = GL_FALSE;
658 }
659
660 /*
661  * Sets the default initial window size for new windows
662  */
663 void FGAPIENTRY glutInitWindowSize( int width, int height )
664 {
665     fgState.Size.X = width;
666     fgState.Size.Y = height;
667
668     if( ( width > 0 ) && ( height > 0 ) )
669         fgState.Size.Use = GL_TRUE;
670     else
671         fgState.Size.Use = GL_FALSE;
672 }
673
674 /*
675  * Sets the default display mode for all new windows
676  */
677 void FGAPIENTRY glutInitDisplayMode( unsigned int displayMode )
678 {
679     /* We will make use of this value when creating a new OpenGL context... */
680     fgState.DisplayMode = displayMode;
681 }
682
683
684 /* -- INIT DISPLAY STRING PARSING ------------------------------------------ */
685
686 #define NUM_TOKENS             28
687 static char* Tokens[] =
688 {
689     "alpha", "acca", "acc", "blue", "buffer", "conformant", "depth", "double",
690     "green", "index", "num", "red", "rgba", "rgb", "luminance", "stencil",
691     "single", "stereo", "samples", "slow", "win32pdf", "xvisual",
692     "xstaticgray", "xgrayscale", "xstaticcolor", "xpseudocolor",
693     "xtruecolor", "xdirectcolor"
694 };
695
696 static int TokenLengths[] =
697 {
698     5,       4,      3,     4,      6,        10,           5,       6,
699     5,       5,       3,     3,     4,      3,     9,           7,
700     6,        6,        7,         4,      8,          7,
701     11,            10,           12,             12,
702     10,           12
703 };
704
705 void FGAPIENTRY glutInitDisplayString( const char* displayMode )
706 {
707     int glut_state_flag = 0 ;
708     /*
709      * Unpack a lot of options from a character string.  The options are
710      * delimited by blanks or tabs.
711      */
712     char *token ;
713     int len = strlen ( displayMode );
714     char *buffer = (char *)malloc ( (len+1) * sizeof(char) );
715     memcpy ( buffer, displayMode, len );
716     buffer[len] = '\0';
717
718     token = strtok ( buffer, " \t" );
719     while ( token )
720     {
721         /* Process this token */
722         int i ;
723         for ( i = 0; i < NUM_TOKENS; i++ )
724         {
725             if ( strncmp ( token, Tokens[i], TokenLengths[i] ) == 0 ) break ;
726         }
727
728         switch ( i )
729         {
730         case 0 :  /* "alpha":  Alpha color buffer precision in bits */
731             glut_state_flag |= GLUT_ALPHA ;  /* Somebody fix this for me! */
732             break ;
733
734         case 1 :  /* "acca":  Red, green, blue, and alpha accumulation buffer
735                      precision in bits */
736             break ;
737
738         case 2 :  /* "acc":  Red, green, and blue accumulation buffer precision
739                      in bits with zero bits alpha */
740             glut_state_flag |= GLUT_ACCUM ;  /* Somebody fix this for me! */
741             break ;
742
743         case 3 :  /* "blue":  Blue color buffer precision in bits */
744             break ;
745
746         case 4 :  /* "buffer":  Number of bits in the color index color buffer
747                    */
748             break ;
749
750         case 5 :  /* "conformant":  Boolean indicating if the frame buffer
751                      configuration is conformant or not */
752             break ;
753
754         case 6 : /* "depth":  Number of bits of precsion in the depth buffer */
755             glut_state_flag |= GLUT_DEPTH ;  /* Somebody fix this for me! */
756             break ;
757
758         case 7 :  /* "double":  Boolean indicating if the color buffer is
759                      double buffered */
760             glut_state_flag |= GLUT_DOUBLE ;
761             break ;
762
763         case 8 :  /* "green":  Green color buffer precision in bits */
764             break ;
765
766         case 9 :  /* "index":  Boolean if the color model is color index or not
767                    */
768             glut_state_flag |= GLUT_INDEX ;
769             break ;
770
771         case 10 :  /* "num":  A special capability  name indicating where the
772                       value represents the Nth frame buffer configuration
773                       matching the description string */
774             break ;
775
776         case 11 :  /* "red":  Red color buffer precision in bits */
777             break ;
778
779         case 12 :  /* "rgba":  Number of bits of red, green, blue, and alpha in
780                       the RGBA color buffer */
781             glut_state_flag |= GLUT_RGBA ;  /* Somebody fix this for me! */
782             break ;
783
784         case 13 :  /* "rgb":  Number of bits of red, green, and blue in the
785                       RGBA color buffer with zero bits alpha */
786             glut_state_flag |= GLUT_RGB ;  /* Somebody fix this for me! */
787             break ;
788
789         case 14 :  /* "luminance":  Number of bits of red in the RGBA and zero
790                       bits of green, blue (alpha not specified) of color buffer
791                       precision */
792             glut_state_flag |= GLUT_LUMINANCE ; /* Somebody fix this for me! */
793             break ;
794
795         case 15 :  /* "stencil":  Number of bits in the stencil buffer */
796             glut_state_flag |= GLUT_STENCIL;  /* Somebody fix this for me! */
797             break ;
798
799         case 16 :  /* "single":  Boolean indicate the color buffer is single
800                       buffered */
801             glut_state_flag |= GLUT_SINGLE ;
802             break ;
803
804         case 17 :  /* "stereo":  Boolean indicating the color buffer supports
805                       OpenGL-style stereo */
806             glut_state_flag |= GLUT_STEREO ;
807             break ;
808
809         case 18 :  /* "samples":  Indicates the number of multisamples to use
810                       based on GLX's SGIS_multisample extension (for
811                       antialiasing) */
812             glut_state_flag |= GLUT_MULTISAMPLE ; /*Somebody fix this for me!*/
813             break ;
814
815         case 19 :  /* "slow":  Boolean indicating if the frame buffer
816                       configuration is slow or not */
817             break ;
818
819         case 20 :  /* "win32pdf":  matches the Win32 Pixel Format Descriptor by
820                       number */
821 #if TARGET_HOST_WIN32
822 #endif
823             break ;
824
825         case 21 :  /* "xvisual":  matches the X visual ID by number */
826 #if TARGET_HOST_UNIX_X11
827 #endif
828             break ;
829
830         case 22 :  /* "xstaticgray":  boolean indicating if the frame buffer
831                       configuration's X visual is of type StaticGray */
832 #if TARGET_HOST_UNIX_X11
833 #endif
834             break ;
835
836         case 23 :  /* "xgrayscale":  boolean indicating if the frame buffer
837                       configuration's X visual is of type GrayScale */
838 #if TARGET_HOST_UNIX_X11
839 #endif
840             break ;
841
842         case 24 :  /* "xstaticcolor":  boolean indicating if the frame buffer
843                       configuration's X visual is of type StaticColor */
844 #if TARGET_HOST_UNIX_X11
845 #endif
846             break ;
847
848         case 25 :  /* "xpseudocolor":  boolean indicating if the frame buffer
849                       configuration's X visual is of type PseudoColor */
850 #if TARGET_HOST_UNIX_X11
851 #endif
852             break ;
853
854         case 26 :  /* "xtruecolor":  boolean indicating if the frame buffer
855                       configuration's X visual is of type TrueColor */
856 #if TARGET_HOST_UNIX_X11
857 #endif
858             break ;
859
860         case 27 :  /* "xdirectcolor":  boolean indicating if the frame buffer
861                       configuration's X visual is of type DirectColor */
862 #if TARGET_HOST_UNIX_X11
863 #endif
864             break ;
865
866         case 28 :  /* Unrecognized */
867             printf ( "WARNING - Display string token not recognized:  %s\n",
868                      token );
869             break ;
870         }
871
872         token = strtok ( NULL, " \t" );
873     }
874
875     free ( buffer );
876
877     /* We will make use of this value when creating a new OpenGL context... */
878     fgState.DisplayMode = glut_state_flag;
879 }
880
881 /*** END OF FILE ***/