more kinds of menu_event are handled directly in the menu-code now.
[supertux.git] / src / setup.cpp
1 /*
2   setup.c
3   
4   Super Tux - Setup
5   
6   by Bill Kendrick
7   bill@newbreedsoftware.com
8   http://www.newbreedsoftware.com/supertux/
9   
10   April 11, 2000 - March 15, 2004
11 */
12
13 #include <assert.h>
14 #include <stdio.h>
15 #include <stdlib.h>
16 #include <string.h>
17 #include <errno.h>
18 #include <unistd.h>
19 #include <SDL.h>
20 #include <SDL_image.h>
21 #ifndef NOOPENGL
22 #include <SDL_opengl.h>
23 #endif
24
25 #include <sys/stat.h>
26 #include <sys/types.h>
27 #include <dirent.h>
28 #ifndef WIN32
29 #include <libgen.h>
30 #endif
31 #include <ctype.h>
32
33 #include "defines.h"
34 #include "globals.h"
35 #include "setup.h"
36 #include "screen.h"
37 #include "texture.h"
38 #include "menu.h"
39 #include "gameloop.h"
40 #include "configfile.h"
41 #include "scene.h"
42
43 #ifdef WIN32
44 #define mkdir(dir, mode)    mkdir(dir)
45 // on win32 we typically don't want LFS paths
46 #undef DATA_PREFIX
47 #define DATA_PREFIX "./data/"
48 #endif
49
50 /* Local function prototypes: */
51
52 void seticon(void);
53 void usage(char * prog, int ret);
54
55 /* Does the given file exist and is it accessible? */
56 int faccessible(const char *filename)
57 {
58   struct stat filestat;
59   if (stat(filename, &filestat) == -1)
60     {
61       return false;
62     }
63   else
64     {
65       if(S_ISREG(filestat.st_mode))
66         return true;
67       else
68         return false;
69     }
70 }
71
72 /* Can we write to this location? */
73 int fwriteable(const char *filename)
74 {
75   FILE* fi;
76   fi = fopen(filename, "wa");
77   if (fi == NULL)
78     {
79       return false;
80     }
81   return true;
82 }
83
84 /* Makes sure a directory is created in either the SuperTux home directory or the SuperTux base directory.*/
85 int fcreatedir(const char* relative_dir)
86 {
87   char path[1024];
88   snprintf(path, 1024, "%s/%s/", st_dir, relative_dir);
89   if(mkdir(path,0755) != 0)
90     {
91       snprintf(path, 1024, "%s/%s/", datadir.c_str(), relative_dir);
92       if(mkdir(path,0755) != 0)
93         {
94           return false;
95         }
96       else
97         {
98           return true;
99         }
100     }
101   else
102     {
103       return true;
104     }
105 }
106
107 FILE * opendata(const char * rel_filename, const char * mode)
108 {
109   char * filename = NULL;
110   FILE * fi;
111
112   filename = (char *) malloc(sizeof(char) * (strlen(st_dir) +
113                                              strlen(rel_filename) + 1));
114
115   strcpy(filename, st_dir);
116   /* Open the high score file: */
117
118   strcat(filename, rel_filename);
119
120   /* Try opening the file: */
121   fi = fopen(filename, mode);
122
123   if (fi == NULL)
124     {
125       fprintf(stderr, "Warning: Unable to open the file \"%s\" ", filename);
126
127       if (strcmp(mode, "r") == 0)
128         fprintf(stderr, "for read!!!\n");
129       else if (strcmp(mode, "w") == 0)
130         fprintf(stderr, "for write!!!\n");
131     }
132   free( filename );
133
134   return(fi);
135 }
136
137 /* Get all names of sub-directories in a certain directory. */
138 /* Returns the number of sub-directories found. */
139 /* Note: The user has to free the allocated space. */
140 string_list_type dsubdirs(const char *rel_path,const  char* expected_file)
141 {
142   DIR *dirStructP;
143   struct dirent *direntp;
144   string_list_type sdirs;
145   char filename[1024];
146   char path[1024];
147
148   string_list_init(&sdirs);
149   sprintf(path,"%s/%s",st_dir,rel_path);
150   if((dirStructP = opendir(path)) != NULL)
151     {
152       while((direntp = readdir(dirStructP)) != NULL)
153         {
154           char absolute_filename[1024];
155           struct stat buf;
156
157           sprintf(absolute_filename, "%s/%s", path, direntp->d_name);
158
159           if (stat(absolute_filename, &buf) == 0 && S_ISDIR(buf.st_mode))
160             {
161               if(expected_file != NULL)
162                 {
163                   sprintf(filename,"%s/%s/%s",path,direntp->d_name,expected_file);
164                   if(!faccessible(filename))
165                     continue;
166                 }
167
168               string_list_add_item(&sdirs,direntp->d_name);
169             }
170         }
171       closedir(dirStructP);
172     }
173
174   sprintf(path,"%s/%s",datadir.c_str(),rel_path);
175   if((dirStructP = opendir(path)) != NULL)
176     {
177       while((direntp = readdir(dirStructP)) != NULL)
178         {
179           char absolute_filename[1024];
180           struct stat buf;
181
182           sprintf(absolute_filename, "%s/%s", path, direntp->d_name);
183
184           if (stat(absolute_filename, &buf) == 0 && S_ISDIR(buf.st_mode))
185             {
186               if(expected_file != NULL)
187                 {
188                   sprintf(filename,"%s/%s/%s",path,direntp->d_name,expected_file);
189                   if(!faccessible(filename))
190                     {
191                       continue;
192                     }
193                   else
194                     {
195                       sprintf(filename,"%s/%s/%s/%s",st_dir,rel_path,direntp->d_name,expected_file);
196                       if(faccessible(filename))
197                         continue;
198                     }
199                 }
200
201               string_list_add_item(&sdirs,direntp->d_name);
202             }
203         }
204       closedir(dirStructP);
205     }
206
207   return sdirs;
208 }
209
210 string_list_type dfiles(const char *rel_path, const  char* glob, const  char* exception_str)
211 {
212   DIR *dirStructP;
213   struct dirent *direntp;
214   string_list_type sdirs;
215   char path[1024];
216
217   string_list_init(&sdirs);
218   sprintf(path,"%s/%s",st_dir,rel_path);
219   if((dirStructP = opendir(path)) != NULL)
220     {
221       while((direntp = readdir(dirStructP)) != NULL)
222         {
223           char absolute_filename[1024];
224           struct stat buf;
225
226           sprintf(absolute_filename, "%s/%s", path, direntp->d_name);
227
228           if (stat(absolute_filename, &buf) == 0 && S_ISREG(buf.st_mode))
229             {
230               if(exception_str != NULL)
231                 {
232                   if(strstr(direntp->d_name,exception_str) != NULL)
233                     continue;
234                 }
235               if(glob != NULL)
236                 if(strstr(direntp->d_name,glob) == NULL)
237                   continue;
238
239               string_list_add_item(&sdirs,direntp->d_name);
240             }
241         }
242       closedir(dirStructP);
243     }
244
245   sprintf(path,"%s/%s",datadir.c_str(),rel_path);
246   if((dirStructP = opendir(path)) != NULL)
247     {
248       while((direntp = readdir(dirStructP)) != NULL)
249         {
250           char absolute_filename[1024];
251           struct stat buf;
252
253           sprintf(absolute_filename, "%s/%s", path, direntp->d_name);
254
255           if (stat(absolute_filename, &buf) == 0 && S_ISREG(buf.st_mode))
256             {
257               if(exception_str != NULL)
258                 {
259                   if(strstr(direntp->d_name,exception_str) != NULL)
260                     continue;
261                 }
262               if(glob != NULL)
263                 if(strstr(direntp->d_name,glob) == NULL)
264                   continue;
265
266               string_list_add_item(&sdirs,direntp->d_name);
267             }
268         }
269       closedir(dirStructP);
270     }
271
272   return sdirs;
273 }
274
275 void free_strings(char **strings, int num)
276 {
277   int i;
278   for(i=0; i < num; ++i)
279     free(strings[i]);
280 }
281
282 /* --- SETUP --- */
283 /* Set SuperTux configuration and save directories */
284 void st_directory_setup(void)
285 {
286   char *home;
287   char str[1024];
288   /* Get home directory (from $HOME variable)... if we can't determine it,
289      use the current directory ("."): */
290   if (getenv("HOME") != NULL)
291     home = getenv("HOME");
292   else
293     home = ".";
294
295   st_dir = (char *) malloc(sizeof(char) * (strlen(home) +
296                                            strlen("/.supertux") + 1));
297   strcpy(st_dir, home);
298   strcat(st_dir, "/.supertux");
299
300   /* Remove .supertux config-file from old SuperTux versions */
301   if(faccessible(st_dir))
302     {
303       remove
304         (st_dir);
305     }
306
307   st_save_dir = (char *) malloc(sizeof(char) * (strlen(st_dir) + strlen("/save") + 1));
308
309   strcpy(st_save_dir,st_dir);
310   strcat(st_save_dir,"/save");
311
312   /* Create them. In the case they exist they won't destroy anything. */
313   mkdir(st_dir, 0755);
314   mkdir(st_save_dir, 0755);
315
316   sprintf(str, "%s/levels", st_dir);
317   mkdir(str, 0755);
318
319   // User has not that a datadir, so we try some magic
320   if (datadir.empty())
321     {
322 #ifndef WIN32
323       // Detect datadir
324       char exe_file[PATH_MAX];
325       if (readlink("/proc/self/exe", exe_file, PATH_MAX) < 0)
326         {
327           puts("Couldn't read /proc/self/exe, using default path: " DATA_PREFIX);
328           datadir = DATA_PREFIX;
329         }
330       else
331         {
332           std::string exedir = std::string(dirname(exe_file)) + "/";
333           
334           datadir = exedir + "../data/"; // SuperTux run from source dir
335           if (access(datadir.c_str(), F_OK) != 0)
336             {
337               datadir = exedir + "../share/supertux/"; // SuperTux run from PATH
338               if (access(datadir.c_str(), F_OK) != 0) 
339                 { // If all fails, fall back to compiled path
340                   datadir = DATA_PREFIX; 
341                 }
342             }
343         }
344 #else
345   datadir = DATA_PREFIX;
346 #endif
347     }
348   printf("Datadir: %s\n", datadir.c_str());
349 }
350
351 /* Create and setup menus. */
352 void st_menu(void)
353 {
354   main_menu      = new Menu();
355   options_menu   = new Menu();
356   options_controls_menu   = new Menu();
357   load_game_menu = new Menu();
358   save_game_menu = new Menu();
359   game_menu      = new Menu();
360   highscore_menu = new Menu();
361
362   main_menu->additem(MN_LABEL,"Main Menu",0,0);
363   main_menu->additem(MN_HL,"",0,0);
364   main_menu->additem(MN_ACTION,"Start Game",0,0);
365   main_menu->additem(MN_GOTO,"Load Game",0,load_game_menu);
366   main_menu->additem(MN_GOTO,"Options",0,options_menu);
367   main_menu->additem(MN_ACTION,"Level editor",0,0);
368   main_menu->additem(MN_ACTION,"Credits",0,0);
369   main_menu->additem(MN_HL,"",0,0);
370   main_menu->additem(MN_ACTION,"Quit",0,0);
371
372   options_menu->additem(MN_LABEL,"Options",0,0);
373   options_menu->additem(MN_HL,"",0,0);
374   options_menu->additem(MN_TOGGLE,"Fullscreen",use_fullscreen,0);
375   if(audio_device)
376     {
377       options_menu->additem(MN_TOGGLE,"Sound     ",use_sound,0);
378       options_menu->additem(MN_TOGGLE,"Music     ",use_music,0);
379     }
380   else
381     {
382       options_menu->additem(MN_DEACTIVE,"Sound     ",use_sound,0);
383       options_menu->additem(MN_DEACTIVE,"Music     ",use_music,0);
384     }
385   options_menu->additem(MN_TOGGLE,"Show FPS  ",show_fps,0);
386   options_menu->additem(MN_GOTO,"Controls  ",0,options_controls_menu);
387   options_menu->additem(MN_HL,"",0,0);
388   options_menu->additem(MN_BACK,"Back",0,0);
389   
390   options_controls_menu->additem(MN_LABEL,"Controls",0,0);
391   options_controls_menu->additem(MN_HL,"",0,0);
392   options_controls_menu->additem(MN_CONTROLFIELD,"Move Right",tux.keymap.right,0);
393   options_controls_menu->additem(MN_HL,"",0,0);
394   options_controls_menu->additem(MN_BACK,"Back",0,0);
395
396   load_game_menu->additem(MN_LABEL,"Load Game",0,0);
397   load_game_menu->additem(MN_HL,"",0,0);
398   load_game_menu->additem(MN_DEACTIVE,"Slot 1",0,0);
399   load_game_menu->additem(MN_DEACTIVE,"Slot 2",0,0);
400   load_game_menu->additem(MN_DEACTIVE,"Slot 3",0,0);
401   load_game_menu->additem(MN_DEACTIVE,"Slot 4",0,0);
402   load_game_menu->additem(MN_DEACTIVE,"Slot 5",0,0);
403   load_game_menu->additem(MN_HL,"",0,0);
404   load_game_menu->additem(MN_BACK,"Back",0,0);
405
406   save_game_menu->additem(MN_LABEL,"Save Game",0,0);
407   save_game_menu->additem(MN_HL,"",0,0);
408   save_game_menu->additem(MN_DEACTIVE,"Slot 1",0,0);
409   save_game_menu->additem(MN_DEACTIVE,"Slot 2",0,0);
410   save_game_menu->additem(MN_DEACTIVE,"Slot 3",0,0);
411   save_game_menu->additem(MN_DEACTIVE,"Slot 4",0,0);
412   save_game_menu->additem(MN_DEACTIVE,"Slot 5",0,0);
413   save_game_menu->additem(MN_HL,"",0,0);
414   save_game_menu->additem(MN_BACK,"Back",0,0);
415
416   game_menu->additem(MN_LABEL,"InGame Menu",0,0);
417   game_menu->additem(MN_HL,"",0,0);
418   game_menu->additem(MN_ACTION,"Return To Game",0,0);
419   game_menu->additem(MN_GOTO,"Save Game",0,save_game_menu);
420   game_menu->additem(MN_GOTO,"Load Game",0,load_game_menu);
421   game_menu->additem(MN_GOTO,"Options",0,options_menu);
422   game_menu->additem(MN_HL,"",0,0);
423   game_menu->additem(MN_ACTION,"Quit Game",0,0);
424
425   highscore_menu->additem(MN_TEXTFIELD,"Enter your name:",0,0);
426 }
427
428 void update_load_save_game_menu(Menu* pmenu, int load)
429 {
430   for(int i = 2; i < 7; ++i)
431     {
432       char *tmp;
433       slotinfo(&tmp,i-1);
434       if(load && strlen(tmp) == strlen("Slot X - Free") )
435         pmenu->item[i].kind = MN_DEACTIVE;
436       else
437         pmenu->item[i].kind = MN_ACTION;
438       menu_item_change_text(&pmenu->item[i],tmp);
439       free(tmp);
440     }
441 }
442
443 void process_save_load_game_menu(int save)
444 {
445   int slot;
446   switch (slot = (save ? save_game_menu->check() : load_game_menu->check()))
447     {
448     default:
449       if(slot != -1)
450         {
451           if(save)
452             {
453               savegame(slot - 1);
454             }
455           else
456             {
457               if (game_started)
458                 {
459                   gameloop("default",slot - 1,ST_GL_LOAD_GAME);
460                   show_menu = true;
461                   Menu::set_current(main_menu);
462                 }
463               else
464                 loadgame(slot - 1);
465             }
466           st_pause_ticks_stop();
467         }
468       break;
469     }
470 }
471
472 /* Handle changes made to global settings in the options menu. */
473 void process_options_menu(void)
474 {
475   switch (options_menu->check())
476     {
477     case 2:
478       if(use_fullscreen != options_menu->item[2].toggled)
479         {
480           use_fullscreen = !use_fullscreen;
481           st_video_setup();
482         }
483       break;
484     case 3:
485       if(use_sound != options_menu->item[3].toggled)
486         use_sound = !use_sound;
487       break;
488     case 4:
489       if(use_music != options_menu->item[4].toggled)
490         {
491           if(use_music)
492             {
493               if(playing_music())
494                 {
495                   halt_music();
496                 }
497               use_music = false;
498             }
499           else
500             {
501               use_music = true;
502               if (!playing_music())
503                 {
504                   play_current_music();
505                 }
506             }
507         }
508       break;
509     case 5:
510       if(show_fps != options_menu->item[5].toggled)
511         show_fps = !show_fps;
512       break;
513     }
514 }
515
516 void st_general_setup(void)
517 {
518   /* Seed random number generator: */
519
520   srand(SDL_GetTicks());
521
522   /* Set icon image: */
523
524   seticon();
525
526   /* Unicode needed for input handling: */
527
528   SDL_EnableUNICODE(1);
529
530   /* Load global images: */
531
532   text_load(&black_text, datadir + "/images/status/letters-black.png", TEXT_TEXT, 16,18);
533   text_load(&gold_text,datadir + "/images/status/letters-gold.png", TEXT_TEXT, 16,18);
534   text_load(&blue_text,datadir + "/images/status/letters-blue.png", TEXT_TEXT, 16,18);
535   text_load(&red_text,datadir + "/images/status/letters-red.png", TEXT_TEXT, 16,18);
536   text_load(&white_text,datadir + "/images/status/letters-white.png", TEXT_TEXT, 16,18);
537   text_load(&white_small_text,datadir + "/images/status/letters-white-small.png", TEXT_TEXT, 8,9);
538   text_load(&white_big_text,datadir + "/images/status/letters-white-big.png", TEXT_TEXT, 20,23);
539   text_load(&yellow_nums,datadir + "/images/status/numbers.png", TEXT_NUM, 32,32);
540
541   /* Load GUI/menu images: */
542   texture_load(&checkbox, datadir + "/images/status/checkbox.png", USE_ALPHA);
543   texture_load(&checkbox_checked, datadir + "/images/status/checkbox-checked.png", USE_ALPHA);
544   texture_load(&back, datadir + "/images/status/back.png", USE_ALPHA);
545   texture_load(&arrow_left, datadir + "/images/icons/left.png", USE_ALPHA);
546   texture_load(&arrow_right, datadir + "/images/icons/right.png", USE_ALPHA);
547
548 }
549
550 void st_general_free(void)
551 {
552
553   /* Free global images: */
554
555   text_free(&black_text);
556   text_free(&gold_text);
557   text_free(&white_text);
558   text_free(&blue_text);
559   text_free(&red_text);
560   text_free(&white_small_text);
561   text_free(&white_big_text);
562
563   /* Free GUI/menu images: */
564   texture_free(&checkbox);
565   texture_free(&checkbox_checked);
566   texture_free(&back);
567   texture_free(&arrow_left);
568   texture_free(&arrow_right);
569
570   /* Free menus */
571   delete main_menu;
572   delete game_menu;
573   delete options_menu;
574   delete highscore_menu;
575   delete save_game_menu;
576   delete load_game_menu;
577 }
578
579 void st_video_setup(void)
580 {
581
582   if(screen != NULL)
583     SDL_FreeSurface(screen);
584
585   /* Init SDL Video: */
586
587   if (SDL_Init(SDL_INIT_VIDEO) < 0)
588     {
589       fprintf(stderr,
590               "\nError: I could not initialize video!\n"
591               "The Simple DirectMedia error that occured was:\n"
592               "%s\n\n", SDL_GetError());
593       exit(1);
594     }
595
596   /* Open display: */
597
598   if(use_gl)
599     st_video_setup_gl();
600   else
601     st_video_setup_sdl();
602
603   texture_setup();
604
605   /* Set window manager stuff: */
606
607   SDL_WM_SetCaption("Super Tux", "Super Tux");
608
609 }
610
611 void st_video_setup_sdl(void)
612 {
613   SDL_FreeSurface(screen);
614
615   if (use_fullscreen)
616     {
617       screen = SDL_SetVideoMode(640, 480, 0, SDL_FULLSCREEN ) ; /* | SDL_HWSURFACE); */
618       if (screen == NULL)
619         {
620           fprintf(stderr,
621                   "\nWarning: I could not set up fullscreen video for "
622                   "640x480 mode.\n"
623                   "The Simple DirectMedia error that occured was:\n"
624                   "%s\n\n", SDL_GetError());
625           use_fullscreen = false;
626         }
627     }
628   else
629     {
630       screen = SDL_SetVideoMode(640, 480, 0, SDL_HWSURFACE | SDL_DOUBLEBUF );
631
632       if (screen == NULL)
633         {
634           fprintf(stderr,
635                   "\nError: I could not set up video for 640x480 mode.\n"
636                   "The Simple DirectMedia error that occured was:\n"
637                   "%s\n\n", SDL_GetError());
638           exit(1);
639         }
640     }
641 }
642
643 void st_video_setup_gl(void)
644 {
645 #ifndef NOOPENGL
646
647   SDL_GL_SetAttribute(SDL_GL_RED_SIZE, 5);
648   SDL_GL_SetAttribute(SDL_GL_GREEN_SIZE, 5);
649   SDL_GL_SetAttribute(SDL_GL_BLUE_SIZE, 5);
650   SDL_GL_SetAttribute(SDL_GL_DEPTH_SIZE, 16);
651   SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 1);
652
653   if (use_fullscreen)
654     {
655       screen = SDL_SetVideoMode(640, 480, 0, SDL_FULLSCREEN | SDL_OPENGL) ; /* | SDL_HWSURFACE); */
656       if (screen == NULL)
657         {
658           fprintf(stderr,
659                   "\nWarning: I could not set up fullscreen video for "
660                   "640x480 mode.\n"
661                   "The Simple DirectMedia error that occured was:\n"
662                   "%s\n\n", SDL_GetError());
663           use_fullscreen = false;
664         }
665     }
666   else
667     {
668       screen = SDL_SetVideoMode(640, 480, 0, SDL_OPENGL);
669
670       if (screen == NULL)
671         {
672           fprintf(stderr,
673                   "\nError: I could not set up video for 640x480 mode.\n"
674                   "The Simple DirectMedia error that occured was:\n"
675                   "%s\n\n", SDL_GetError());
676           exit(1);
677         }
678     }
679
680   /*
681    * Set up OpenGL for 2D rendering.
682    */
683   glDisable(GL_DEPTH_TEST);
684   glDisable(GL_CULL_FACE);
685
686   glViewport(0, 0, screen->w, screen->h);
687   glMatrixMode(GL_PROJECTION);
688   glLoadIdentity();
689   glOrtho(0, screen->w, screen->h, 0, -1.0, 1.0);
690
691   glMatrixMode(GL_MODELVIEW);
692   glLoadIdentity();
693   glTranslatef(0.0f, 0.0f, 0.0f);
694
695 #endif
696
697 }
698
699 void st_joystick_setup(void)
700 {
701
702   /* Init Joystick: */
703
704   use_joystick = true;
705
706   if (SDL_Init(SDL_INIT_JOYSTICK) < 0)
707     {
708       fprintf(stderr, "Warning: I could not initialize joystick!\n"
709               "The Simple DirectMedia error that occured was:\n"
710               "%s\n\n", SDL_GetError());
711
712       use_joystick = false;
713     }
714   else
715     {
716       /* Open joystick: */
717       if (SDL_NumJoysticks() <= 0)
718         {
719           fprintf(stderr, "Warning: No joysticks are available.\n");
720
721           use_joystick = false;
722         }
723       else
724         {
725           js = SDL_JoystickOpen(joystick_num);
726
727           if (js == NULL)
728             {
729               fprintf(stderr, "Warning: Could not open joystick %d.\n"
730                       "The Simple DirectMedia error that occured was:\n"
731                       "%s\n\n", joystick_num, SDL_GetError());
732
733               use_joystick = false;
734             }
735           else
736             {
737               /* Check for proper joystick configuration: */
738
739               if (SDL_JoystickNumAxes(js) < 2)
740                 {
741                   fprintf(stderr,
742                           "Warning: Joystick does not have enough axes!\n");
743
744                   use_joystick = false;
745                 }
746               else
747                 {
748                   if (SDL_JoystickNumButtons(js) < 2)
749                     {
750                       fprintf(stderr,
751                               "Warning: "
752                               "Joystick does not have enough buttons!\n");
753
754                       use_joystick = false;
755                     }
756                 }
757             }
758         }
759     }
760 }
761
762 void st_audio_setup(void)
763 {
764
765   /* Init SDL Audio silently even if --disable-sound : */
766
767   if (audio_device)
768     {
769       if (SDL_Init(SDL_INIT_AUDIO) < 0)
770         {
771           /* only print out message if sound or music
772              was not disabled at command-line
773            */
774           if (use_sound || use_music)
775             {
776               fprintf(stderr,
777                       "\nWarning: I could not initialize audio!\n"
778                       "The Simple DirectMedia error that occured was:\n"
779                       "%s\n\n", SDL_GetError());
780             }
781           /* keep the programming logic the same :-)
782              because in this case, use_sound & use_music' values are ignored
783              when there's no available audio device
784           */
785           use_sound = false;
786           use_music = false;
787           audio_device = false;
788         }
789     }
790
791
792   /* Open sound silently regarless the value of "use_sound": */
793
794   if (audio_device)
795     {
796       if (open_audio(44100, AUDIO_S16, 2, 2048) < 0)
797         {
798           /* only print out message if sound or music
799              was not disabled at command-line
800            */
801           if (use_sound || use_music)
802             {
803               fprintf(stderr,
804                       "\nWarning: I could not set up audio for 44100 Hz "
805                       "16-bit stereo.\n"
806                       "The Simple DirectMedia error that occured was:\n"
807                       "%s\n\n", SDL_GetError());
808             }
809           use_sound = false;
810           use_music = false;
811           audio_device = false;
812         }
813     }
814
815 }
816
817
818 /* --- SHUTDOWN --- */
819
820 void st_shutdown(void)
821 {
822   close_audio();
823   SDL_Quit();
824   saveconfig();
825 }
826
827 /* --- ABORT! --- */
828
829 void st_abort(const std::string& reason, const std::string& details)
830 {
831   fprintf(stderr, "\nError: %s\n%s\n\n", reason.c_str(), details.c_str());
832   st_shutdown();
833   abort();
834 }
835
836
837 /* Set Icon (private) */
838
839 void seticon(void)
840 {
841   int masklen;
842   Uint8 * mask;
843   SDL_Surface * icon;
844
845
846   /* Load icon into a surface: */
847
848   icon = IMG_Load((datadir + "/images/icon.png").c_str());
849   if (icon == NULL)
850     {
851       fprintf(stderr,
852               "\nError: I could not load the icon image: %s%s\n"
853               "The Simple DirectMedia error that occured was:\n"
854               "%s\n\n", datadir.c_str(), "/images/icon.png", SDL_GetError());
855       exit(1);
856     }
857
858
859   /* Create mask: */
860
861   masklen = (((icon -> w) + 7) / 8) * (icon -> h);
862   mask = (Uint8*) malloc(masklen * sizeof(Uint8));
863   memset(mask, 0xFF, masklen);
864
865
866   /* Set icon: */
867
868   SDL_WM_SetIcon(icon, mask);
869
870
871   /* Free icon surface & mask: */
872
873   free(mask);
874   SDL_FreeSurface(icon);
875 }
876
877
878 /* Parse command-line arguments: */
879
880 void parseargs(int argc, char * argv[])
881 {
882   int i;
883
884   loadconfig();
885
886   /* Parse arguments: */
887
888   for (i = 1; i < argc; i++)
889     {
890       if (strcmp(argv[i], "--fullscreen") == 0 ||
891           strcmp(argv[i], "-f") == 0)
892         {
893           /* Use full screen: */
894
895           use_fullscreen = true;
896         }
897       else if (strcmp(argv[i], "--joystick") == 0 || strcmp(argv[i], "-j") == 0)
898         {
899           assert(i+1 < argc);
900           joystick_num = atoi(argv[++i]);
901         }
902       else if (strcmp(argv[i], "--worldmap") == 0)
903         {
904           launch_worldmap_mode = true;
905         }
906       else if (strcmp(argv[i], "--datadir") == 0 
907                || strcmp(argv[i], "-d") == 0 )
908         {
909           assert(i+1 < argc);
910           datadir = argv[++i];
911         }
912       else if (strcmp(argv[i], "--show-fps") == 0)
913         {
914           /* Use full screen: */
915
916           show_fps = true;
917         }
918       else if (strcmp(argv[i], "--opengl") == 0 ||
919                strcmp(argv[i], "-gl") == 0)
920         {
921 #ifndef NOOPENGL
922           /* Use OpengGL: */
923
924           use_gl = true;
925 #endif
926
927         }
928       else if (strcmp(argv[i], "--usage") == 0)
929         {
930           /* Show usage: */
931
932           usage(argv[0], 0);
933         }
934       else if (strcmp(argv[i], "--version") == 0)
935         {
936           /* Show version: */
937
938           printf("Super Tux - version " VERSION "\n");
939           exit(0);
940         }
941       else if (strcmp(argv[i], "--disable-sound") == 0)
942         {
943           /* Disable the compiled in sound feature */
944           printf("Sounds disabled \n");
945           use_sound = false;
946         }
947       else if (strcmp(argv[i], "--disable-music") == 0)
948         {
949           /* Disable the compiled in sound feature */
950           printf("Music disabled \n");
951           use_music = false;
952         }
953       else if (strcmp(argv[i], "--debug-mode") == 0)
954         {
955           /* Enable the debug-mode */
956           debug_mode = true;
957
958         }
959       else if (strcmp(argv[i], "--help") == 0)
960         {     /* Show help: */
961           puts("Super Tux " VERSION "\n"
962                "  Please see the file \"README.txt\" for more details.\n");
963           printf("Usage: %s [OPTIONS] FILENAME\n\n", argv[0]);
964           puts("Display Options:\n"
965                "  --fullscreen        Run in fullscreen mode.\n"
966                "  --opengl            If opengl support was compiled in, this will enable\n"
967                "                      the EXPERIMENTAL OpenGL mode.\n"
968                "\n"
969                "Sound Options:\n"
970                "  --disable-sound     If sound support was compiled in,  this will\n"
971                "                      disable sound for this session of the game.\n"
972                "  --disable-music     Like above, but this will disable music.\n"
973                "\n"
974                "Misc Options:\n"
975                "  -j, --joystick NUM  Use joystick NUM (default: 0)\n" 
976                "  --worldmap          Start in worldmap-mode (EXPERIMENTAL)\n"          
977                "  -d, --datadir DIR   Load Game data from DIR (default: automatic)\n"
978                "  --debug-mode        Enables the debug-mode, which is useful for developers.\n"
979                "  --help              Display a help message summarizing command-line\n"
980                "                      options, license and game controls.\n"
981                "  --usage             Display a brief message summarizing command-line options.\n"
982                "  --version           Display the version of SuperTux you're running.\n\n"
983                );
984           exit(0);
985         }
986       else if (argv[i][0] != '-')
987         {
988           level_startup_file = argv[i];
989         }
990       else
991         {
992           /* Unknown - complain! */
993
994           usage(argv[0], 1);
995         }
996     }
997 }
998
999
1000 /* Display usage: */
1001
1002 void usage(char * prog, int ret)
1003 {
1004   FILE * fi;
1005
1006
1007   /* Determine which stream to write to: */
1008
1009   if (ret == 0)
1010     fi = stdout;
1011   else
1012     fi = stderr;
1013
1014
1015   /* Display the usage message: */
1016
1017   fprintf(fi, "Usage: %s [--fullscreen] [--opengl] [--disable-sound] [--disable-music] [--debug-mode] | [--usage | --help | --version] [--worldmap] FILENAME\n",
1018           prog);
1019
1020
1021   /* Quit! */
1022
1023   exit(ret);
1024 }
1025