7d0a7fde159d3fff69de8e447ac15f32c124f4a4
[rocksndiamonds.git] / src / misc.c
1 /***********************************************************
2 *  Rocks'n'Diamonds -- McDuffin Strikes Back!              *
3 *----------------------------------------------------------*
4 *  (c) 1995-98 Artsoft Entertainment                       *
5 *              Holger Schemel                              *
6 *              Oststrasse 11a                              *
7 *              33604 Bielefeld                             *
8 *              phone: ++49 +521 290471                     *
9 *              email: aeglos@valinor.owl.de                *
10 *----------------------------------------------------------*
11 *  misc.c                                                  *
12 ***********************************************************/
13
14 #include <pwd.h>
15 #include <unistd.h>
16 #include <time.h>
17 #include <sys/time.h>
18 #include <sys/param.h>
19 #include <sys/types.h>
20 #include <stdarg.h>
21
22 #include "misc.h"
23 #include "init.h"
24 #include "tools.h"
25 #include "sound.h"
26 #include "random.h"
27 #include "joystick.h"
28
29 static unsigned long mainCounter(int mode)
30 {
31   static struct timeval base_time = { 0, 0 };
32   struct timeval current_time;
33   unsigned long counter_ms;
34
35   gettimeofday(&current_time, NULL);
36
37   if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
38     base_time = current_time;
39
40   counter_ms = (current_time.tv_sec  - base_time.tv_sec)  * 1000
41              + (current_time.tv_usec - base_time.tv_usec) / 1000;
42
43   return counter_ms;            /* return milliseconds since last init */
44 }
45
46 void InitCounter()              /* set counter back to zero */
47 {
48   mainCounter(INIT_COUNTER);
49 }
50
51 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
52 {
53   return(mainCounter(READ_COUNTER));
54 }
55
56 static void sleep_milliseconds(unsigned long milliseconds_delay)
57 {
58   if (milliseconds_delay < 5)
59   {
60     /* we want to wait only a few ms -- if we assume that we have a
61        kernel timer resolution of 10 ms, we would wait far to long;
62        therefore it's better to do a short interval of busy waiting
63        to get our sleeping time more accurate */
64
65     unsigned long base_counter = Counter(), actual_counter = Counter();
66
67     while (actual_counter < base_counter + milliseconds_delay &&
68            actual_counter >= base_counter)
69       actual_counter = Counter();
70   }
71   else
72   {
73     struct timeval delay;
74
75     delay.tv_sec  = milliseconds_delay / 1000;
76     delay.tv_usec = 1000 * (milliseconds_delay % 1000);
77
78     if (select(0, NULL, NULL, NULL, &delay) != 0)
79       Error(ERR_WARN, "sleep_milliseconds(): select() failed");
80   }
81 }
82
83 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
84 {
85   sleep_milliseconds(delay);
86 }
87
88 boolean FrameReached(unsigned long *frame_counter_var,
89                      unsigned long frame_delay)
90 {
91   unsigned long actual_frame_counter = FrameCounter;
92
93   if (actual_frame_counter < *frame_counter_var+frame_delay &&
94       actual_frame_counter >= *frame_counter_var)
95     return(FALSE);
96
97   *frame_counter_var = actual_frame_counter;
98   return(TRUE);
99 }
100
101 boolean DelayReached(unsigned long *counter_var,
102                      unsigned long delay)
103 {
104   unsigned long actual_counter = Counter();
105
106   if (actual_counter < *counter_var + delay &&
107       actual_counter >= *counter_var)
108     return(FALSE);
109
110   *counter_var = actual_counter;
111   return(TRUE);
112 }
113
114 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
115 {
116   unsigned long actual_counter;
117
118   while(1)
119   {
120     actual_counter = Counter();
121
122     if (actual_counter < *counter_var + delay &&
123         actual_counter >= *counter_var)
124       sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
125     else
126       break;
127   }
128
129   *counter_var = actual_counter;
130 }
131
132 char *int2str(int number, int size)
133 {
134   static char s[40];
135
136   if (size > 20)
137     size = 20;
138
139   if (size)
140   {
141     sprintf(s, "                    %09d", number);
142     return &s[strlen(s) - size];
143   }
144   else
145   {
146     sprintf(s, "%d", number);
147     return s;
148   }
149 }
150
151 unsigned int SimpleRND(unsigned int max)
152 {
153   static unsigned long root = 654321;
154   struct timeval current_time;
155
156   gettimeofday(&current_time,NULL);
157   root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
158   return (root % max);
159 }
160
161 unsigned int RND(unsigned int max)
162 {
163   return (random_linux_libc() % max);
164 }
165
166 unsigned int InitRND(long seed)
167 {
168   struct timeval current_time;
169
170   if (seed == NEW_RANDOMIZE)
171   {
172     gettimeofday(&current_time,NULL);
173     srandom_linux_libc((unsigned int) current_time.tv_usec);
174     return (unsigned int)current_time.tv_usec;
175   }
176   else
177   {
178     srandom_linux_libc((unsigned int) seed);
179     return (unsigned int)seed;
180   }
181 }
182
183 char *getLoginName()
184 {
185   struct passwd *pwd;
186
187   if (!(pwd = getpwuid(getuid())))
188     return "ANONYMOUS";
189   else
190     return pwd->pw_name;
191 }
192
193 char *getHomeDir()
194 {
195   static char *home_dir = NULL;
196
197   if (!home_dir)
198   {
199     if (!(home_dir = getenv("HOME")))
200     {
201       struct passwd *pwd;
202
203       if ((pwd = getpwuid(getuid())))
204         home_dir = pwd->pw_dir;
205       else
206         home_dir = ".";
207     }
208   }
209
210   return home_dir;
211 }
212
213 void MarkTileDirty(int x, int y)
214 {
215   int xx = redraw_x1 + x;
216   int yy = redraw_y1 + y;
217
218   if (!redraw[xx][yy])
219     redraw_tiles++;
220
221   redraw[xx][yy] = TRUE;
222   redraw_mask |= REDRAW_TILES;
223 }
224
225 void GetOptions(char *argv[])
226 {
227   char **options_left = &argv[1];
228
229   /* initialize global program options */
230   options.display_name = NULL;
231   options.server_host = NULL;
232   options.server_port = 0;
233   options.serveronly = FALSE;
234   options.network = FALSE;
235   options.verbose = FALSE;
236
237   while (*options_left)
238   {
239     char option_str[MAX_OPTION_LEN];
240     char *option = options_left[0];
241     char *next_option = options_left[1];
242     char *option_arg = NULL;
243     int option_len = strlen(option);
244
245     strcpy(option_str, option);                 /* copy argument into buffer */
246     option = option_str;
247
248     if (strcmp(option, "--") == 0)              /* stop scanning arguments */
249       break;
250
251     if (option_len >= MAX_OPTION_LEN)
252       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
253
254     if (strncmp(option, "--", 2) == 0)          /* treat '--' like '-' */
255       option++;
256
257     option_arg = strchr(option, '=');
258     if (option_arg == NULL)                     /* no '=' in option */
259       option_arg = next_option;
260     else
261     {
262       *option_arg++ = '\0';                     /* cut argument from option */
263       if (*option_arg == '\0')                  /* no argument after '=' */
264         Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
265     }
266
267     option_len = strlen(option);
268
269     if (strcmp(option, "-") == 0)
270       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
271     else if (strncmp(option, "-help", option_len) == 0)
272     {
273       printf("Usage: %s [options] [server.name [port]]\n"
274              "Options:\n"
275              "  -d, --display machine:0       X server display\n"
276              "  -l, --levels directory        alternative level directory\n"
277              "  -s, --serveronly              only start network server\n"
278              "  -n, --network                 network multiplayer game\n"
279              "  -v, --verbose                 verbose mode\n",
280              program_name);
281       exit(0);
282     }
283     else if (strncmp(option, "-display", option_len) == 0)
284     {
285       if (option_arg == NULL)
286         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
287
288       options.display_name = option_arg;
289       if (option_arg == next_option)
290         options_left++;
291
292       printf("--display == '%s'\n", options.display_name);
293     }
294     else if (strncmp(option, "-levels", option_len) == 0)
295     {
296       if (option_arg == NULL)
297         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
298
299       level_directory = option_arg;
300       if (option_arg == next_option)
301         options_left++;
302
303       printf("--levels == '%s'\n", level_directory);
304     }
305     else if (strncmp(option, "-network", option_len) == 0)
306     {
307       printf("--network\n");
308
309       options.network = TRUE;
310     }
311     else if (strncmp(option, "-serveronly", option_len) == 0)
312     {
313       printf("--serveronly\n");
314
315       options.serveronly = TRUE;
316     }
317     else if (strncmp(option, "-verbose", option_len) == 0)
318     {
319       printf("--verbose\n");
320
321       options.verbose = TRUE;
322     }
323     else if (*option == '-')
324       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
325     else if (options.server_host == NULL)
326     {
327       options.server_host = *options_left;
328
329       printf("server.name == '%s'\n", options.server_host);
330     }
331     else if (options.server_port == 0)
332     {
333       options.server_port = atoi(*options_left);
334       if (options.server_port < 1024)
335         Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
336
337       printf("port == %d\n", options.server_port);
338     }
339     else
340       Error(ERR_EXIT_HELP, "too many arguments");
341
342     options_left++;
343   }
344 }
345
346 void Error(int mode, char *format_str, ...)
347 {
348   FILE *output_stream = stderr;
349   char *process_name = "";
350
351   if (mode & ERR_SOUNDSERVER)
352     process_name = " sound server";
353
354   if (format_str)
355   {
356     va_list ap;
357     char *format_ptr;
358     char *s_value;
359     int i_value;
360     double d_value;
361
362     fprintf(output_stream, "%s%s: ", program_name, process_name);
363
364     if (mode & ERR_WARN)
365       fprintf(output_stream, "warning: ");
366
367     va_start(ap, format_str);   /* ap points to first unnamed argument */
368   
369     for(format_ptr=format_str; *format_ptr; format_ptr++)
370     {
371       if (*format_ptr != '%')
372       {
373         fprintf(output_stream, "%c", *format_ptr);
374         continue;
375       }
376   
377       switch(*++format_ptr)
378       {
379         case 'd':
380           i_value = va_arg(ap, int);
381           fprintf(output_stream, "%d", i_value);
382           break;
383   
384         case 'f':
385           d_value = va_arg(ap, double);
386           fprintf(output_stream, "%f", d_value);
387           break;
388   
389         case 's':
390           s_value = va_arg(ap, char *);
391           fprintf(output_stream, "%s", s_value);
392           break;
393   
394         default:
395           fprintf(stderr, "\n%s: Error(): invalid format string: %s\n",
396                   program_name, format_str);
397           CloseAllAndExit(10);
398       }
399     }
400
401     va_end(ap);
402   
403     fprintf(output_stream, "\n");
404   }
405   
406   if (mode & ERR_HELP)
407     fprintf(output_stream, "%s: Try option '--help' for more information.\n",
408             program_name);
409
410   if (mode & ERR_EXIT)
411   {
412     fprintf(output_stream, "%s%s: aborting\n", program_name, process_name);
413     CloseAllAndExit(1);
414   }
415 }
416
417 void *checked_malloc(unsigned long size)
418 {
419   void *ptr;
420
421   ptr = malloc(size);
422
423   if (ptr == NULL)
424     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
425
426   return ptr;
427 }
428
429 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
430 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
431 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  2
432
433 void translate_keyname(KeySym *keysym, char **x11name, char **name, int mode)
434 {
435   static struct
436   {
437     KeySym keysym;
438     char *x11name;
439     char *name;
440   } translate_key[] =
441   {
442     /* normal cursor keys */
443     { XK_Left,          "XK_Left",              "cursor left" },
444     { XK_Right,         "XK_Right",             "cursor right" },
445     { XK_Up,            "XK_Up",                "cursor up" },
446     { XK_Down,          "XK_Down",              "cursor down" },
447
448     /* keypad cursor keys */
449 #ifdef XK_KP_Left
450     { XK_KP_Left,       "XK_KP_Left",           "keypad left" },
451     { XK_KP_Right,      "XK_KP_Right",          "keypad right" },
452     { XK_KP_Up,         "XK_KP_Up",             "keypad up" },
453     { XK_KP_Down,       "XK_KP_Down",           "keypad down" },
454 #endif
455
456     /* other keypad keys */
457 #ifdef XK_KP_Enter
458     { XK_KP_Enter,      "XK_KP_Enter",          "keypad enter" },
459     { XK_KP_Add,        "XK_KP_Add",            "keypad +" },
460     { XK_KP_Subtract,   "XK_KP_Subtract",       "keypad -" },
461     { XK_KP_Multiply,   "XK_KP_Multiply",       "keypad mltply" },
462     { XK_KP_Divide,     "XK_KP_Divide",         "keypad /" },
463     { XK_KP_Separator,  "XK_KP_Separator",      "keypad ," },
464 #endif
465
466     /* modifier keys */
467     { XK_Shift_L,       "XK_Shift_L",           "left shift" },
468     { XK_Shift_R,       "XK_Shift_R",           "right shift" },
469     { XK_Control_L,     "XK_Control_L",         "left control" },
470     { XK_Control_R,     "XK_Control_R",         "right control" },
471     { XK_Meta_L,        "XK_Meta_L",            "left meta" },
472     { XK_Meta_R,        "XK_Meta_R",            "right meta" },
473     { XK_Alt_L,         "XK_Alt_L",             "left alt" },
474     { XK_Alt_R,         "XK_Alt_R",             "right alt" },
475     { XK_Mode_switch,   "XK_Mode_switch",       "mode switch" },
476     { XK_Multi_key,     "XK_Multi_key",         "multi key" },
477
478     /* some special keys */
479     { XK_BackSpace,     "XK_BackSpace",         "backspace" },
480     { XK_Delete,        "XK_Delete",            "delete" },
481     { XK_Insert,        "XK_Insert",            "insert" },
482     { XK_Tab,           "XK_Tab",               "tab" },
483     { XK_Home,          "XK_Home",              "home" },
484     { XK_End,           "XK_End",               "end" },
485     { XK_Page_Up,       "XK_Page_Up",           "page up" },
486     { XK_Page_Down,     "XK_Page_Down",         "page down" },
487     { XK_space,         "XK_space",             "space" },
488
489     /* even more special keys */
490     { XK_adiaeresis,    "XK_adiaeresis",        "ä" },
491     { XK_odiaeresis,    "XK_odiaeresis",        "ö" },
492     { XK_udiaeresis,    "XK_udiaeresis",        "ü" },
493     { XK_apostrophe,    "XK_apostrophe",        "'" },
494     { XK_plus,          "XK_plus",              "+" },
495     { XK_minus,         "XK_minus",             "-" },
496     { XK_comma,         "XK_comma",             "," },
497     { XK_period,        "XK_period",            "." },
498     { XK_numbersign,    "XK_numbersign",        "#" },
499     { XK_less,          "XK_less",              "less" },
500     { XK_greater,       "XK_greater",           "greater" },
501     { XK_asciicircum,   "XK_asciicircum",       "circumflex" },
502     { XK_ssharp,        "XK_ssharp",            "sharp s" },
503
504     /* end-of-array identifier */
505     { 0,                NULL,                   NULL }
506   };
507
508   int i;
509
510   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
511   {
512     static char name_buffer[30];
513     KeySym key = *keysym;
514
515     if (key >= XK_A && key <= XK_Z)
516       sprintf(name_buffer, "%c", 'A' + (char)(key - XK_A));
517     else if (key >= XK_a && key <= XK_z)
518       sprintf(name_buffer, "%c", 'a' + (char)(key - XK_a));
519     else if (key >= XK_0 && key <= XK_9)
520       sprintf(name_buffer, "%c", '0' + (char)(key - XK_0));
521     else if (key >= XK_KP_0 && key <= XK_KP_9)
522       sprintf(name_buffer, "keypad %c", '0' + (char)(key - XK_KP_0));
523     else if (key >= XK_F1 && key <= XK_F24)
524       sprintf(name_buffer, "function F%d", (int)(key - XK_F1 + 1));
525     else if (key == KEY_UNDEFINDED)
526       strcpy(name_buffer, "(undefined)");
527     else
528     {
529       i = 0;
530
531       do
532       {
533         if (key == translate_key[i].keysym)
534         {
535           strcpy(name_buffer, translate_key[i].name);
536           break;
537         }
538       }
539       while (translate_key[++i].name);
540
541       if (!translate_key[i].name)
542         strcpy(name_buffer, "(unknown)");
543     }
544
545     *name = name_buffer;
546   }
547   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
548   {
549     static char name_buffer[30];
550     KeySym key = *keysym;
551
552     if (key >= XK_A && key <= XK_Z)
553       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - XK_A));
554     else if (key >= XK_a && key <= XK_z)
555       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - XK_a));
556     else if (key >= XK_0 && key <= XK_9)
557       sprintf(name_buffer, "XK_%c", '0' + (char)(key - XK_0));
558     else if (key >= XK_KP_0 && key <= XK_KP_9)
559       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - XK_KP_0));
560     else if (key >= XK_F1 && key <= XK_F24)
561       sprintf(name_buffer, "XK_F%d", (int)(key - XK_F1 + 1));
562     else if (key == KEY_UNDEFINDED)
563       strcpy(name_buffer, "[undefined]");
564     else
565     {
566       i = 0;
567
568       do
569       {
570         if (key == translate_key[i].keysym)
571         {
572           strcpy(name_buffer, translate_key[i].x11name);
573           break;
574         }
575       }
576       while (translate_key[++i].x11name);
577
578       if (!translate_key[i].x11name)
579         sprintf(name_buffer, "0x%04lx", (unsigned long)key);
580     }
581
582     *x11name = name_buffer;
583   }
584   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
585   {
586     KeySym key = XK_VoidSymbol;
587     char *name_ptr = *x11name;
588
589     if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
590     {
591       char c = name_ptr[3];
592
593       if (c >= 'A' && c <= 'Z')
594         key = XK_A + (KeySym)(c - 'A');
595       else if (c >= 'a' && c <= 'z')
596         key = XK_a + (KeySym)(c - 'a');
597       else if (c >= '0' && c <= '9')
598         key = XK_0 + (KeySym)(c - '0');
599     }
600     else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
601     {
602       char c = name_ptr[6];
603
604       if (c >= '0' && c <= '9')
605         key = XK_0 + (KeySym)(c - '0');
606     }
607     else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
608     {
609       char c1 = name_ptr[4];
610       char c2 = name_ptr[5];
611       int d = 0;
612
613       if ((c1 >= '0' && c1 <= '9') &&
614           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
615         d = atoi(&name_ptr[4]);
616
617       if (d >=1 && d <= 24)
618         key = XK_F1 + (KeySym)(d - 1);
619     }
620     else if (strncmp(name_ptr, "XK_", 3) == 0)
621     {
622       i = 0;
623
624       do
625       {
626         if (strcmp(name_ptr, translate_key[i].x11name) == 0)
627         {
628           key = translate_key[i].keysym;
629           break;
630         }
631       }
632       while (translate_key[++i].x11name);
633     }
634     else if (strncmp(name_ptr, "0x", 2) == 0)
635     {
636       unsigned long value = 0;
637
638       name_ptr += 2;
639
640       while (name_ptr)
641       {
642         char c = *name_ptr++;
643         int d = -1;
644
645         if (c >= '0' && c <= '9')
646           d = (int)(c - '0');
647         else if (c >= 'a' && c <= 'f')
648           d = (int)(c - 'a' + 10);
649         else if (c >= 'A' && c <= 'F')
650           d = (int)(c - 'A' + 10);
651
652         if (d == -1)
653         {
654           value = -1;
655           break;
656         }
657
658         value = value * 16 + d;
659       }
660
661       if (value != -1)
662         key = (KeySym)value;
663     }
664
665     *keysym = key;
666   }
667 }
668
669 char *getKeyNameFromKeySym(KeySym keysym)
670 {
671   char *name;
672
673   translate_keyname(&keysym, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
674   return name;
675 }
676
677 char *getX11KeyNameFromKeySym(KeySym keysym)
678 {
679   char *x11name;
680
681   translate_keyname(&keysym, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
682   return x11name;
683 }
684
685 KeySym getKeySymFromX11KeyName(char *x11name)
686 {
687   KeySym keysym;
688
689   translate_keyname(&keysym, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
690   return keysym;
691 }
692
693 #define TRANSLATE_JOYSYMBOL_TO_JOYNAME  0
694 #define TRANSLATE_JOYNAME_TO_JOYSYMBOL  1
695
696 void translate_joyname(int *joysymbol, char **name, int mode)
697 {
698   static struct
699   {
700     int joysymbol;
701     char *name;
702   } translate_joy[] =
703   {
704     { JOY_LEFT,         "joystick_left" },
705     { JOY_RIGHT,        "joystick_right" },
706     { JOY_UP,           "joystick_up" },
707     { JOY_DOWN,         "joystick_down" },
708     { JOY_BUTTON_1,     "joystick_button_1" },
709     { JOY_BUTTON_2,     "joystick_button_2" },
710   };
711
712   int i;
713
714   if (mode == TRANSLATE_JOYSYMBOL_TO_JOYNAME)
715   {
716     *name = "[undefined]";
717
718     for (i=0; i<6; i++)
719     {
720       if (*joysymbol == translate_joy[i].joysymbol)
721       {
722         *name = translate_joy[i].name;
723         break;
724       }
725     }
726   }
727   else if (mode == TRANSLATE_JOYNAME_TO_JOYSYMBOL)
728   {
729     *joysymbol = 0;
730
731     for (i=0; i<6; i++)
732     {
733       if (strcmp(*name, translate_joy[i].name) == 0)
734       {
735         *joysymbol = translate_joy[i].joysymbol;
736         break;
737       }
738     }
739   }
740 }
741
742 char *getJoyNameFromJoySymbol(int joysymbol)
743 {
744   char *name;
745
746   translate_joyname(&joysymbol, &name, TRANSLATE_JOYSYMBOL_TO_JOYNAME);
747   return name;
748 }
749
750 int getJoySymbolFromJoyName(char *name)
751 {
752   int joysymbol;
753
754   translate_joyname(&joysymbol, &name, TRANSLATE_JOYNAME_TO_JOYSYMBOL);
755   return joysymbol;
756 }