rnd-19981106-1
[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 void MarkTileDirty(int x, int y)
194 {
195   int xx = redraw_x1 + x;
196   int yy = redraw_y1 + y;
197
198   if (!redraw[xx][yy])
199     redraw_tiles++;
200
201   redraw[xx][yy] = TRUE;
202   redraw_mask |= REDRAW_TILES;
203 }
204
205 void GetOptions(char *argv[])
206 {
207   char **options_left = &argv[1];
208
209   /* initialize global program options */
210   options.display_name = NULL;
211   options.server_host = NULL;
212   options.server_port = 0;
213   options.serveronly = FALSE;
214   options.network = FALSE;
215   options.verbose = FALSE;
216
217   while (*options_left)
218   {
219     char option_str[MAX_OPTION_LEN];
220     char *option = options_left[0];
221     char *next_option = options_left[1];
222     char *option_arg = NULL;
223     int option_len = strlen(option);
224
225     strcpy(option_str, option);                 /* copy argument into buffer */
226     option = option_str;
227
228     if (strcmp(option, "--") == 0)              /* stop scanning arguments */
229       break;
230
231     if (option_len >= MAX_OPTION_LEN)
232       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
233
234     if (strncmp(option, "--", 2) == 0)          /* treat '--' like '-' */
235       option++;
236
237     option_arg = strchr(option, '=');
238     if (option_arg == NULL)                     /* no '=' in option */
239       option_arg = next_option;
240     else
241     {
242       *option_arg++ = '\0';                     /* cut argument from option */
243       if (*option_arg == '\0')                  /* no argument after '=' */
244         Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
245     }
246
247     option_len = strlen(option);
248
249     if (strcmp(option, "-") == 0)
250       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
251     else if (strncmp(option, "-help", option_len) == 0)
252     {
253       printf("Usage: %s [options] [server.name [port]]\n"
254              "Options:\n"
255              "  -d, --display machine:0       X server display\n"
256              "  -l, --levels directory        alternative level directory\n"
257              "  -s, --serveronly              only start network server\n"
258              "  -n, --network                 network multiplayer game\n"
259              "  -v, --verbose                 verbose mode\n",
260              program_name);
261       exit(0);
262     }
263     else if (strncmp(option, "-display", option_len) == 0)
264     {
265       if (option_arg == NULL)
266         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
267
268       options.display_name = option_arg;
269       if (option_arg == next_option)
270         options_left++;
271
272       printf("--display == '%s'\n", options.display_name);
273     }
274     else if (strncmp(option, "-levels", option_len) == 0)
275     {
276       if (option_arg == NULL)
277         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
278
279       level_directory = option_arg;
280       if (option_arg == next_option)
281         options_left++;
282
283       printf("--levels == '%s'\n", level_directory);
284     }
285     else if (strncmp(option, "-network", option_len) == 0)
286     {
287       printf("--network\n");
288
289       options.network = TRUE;
290     }
291     else if (strncmp(option, "-serveronly", option_len) == 0)
292     {
293       printf("--serveronly\n");
294
295       options.serveronly = TRUE;
296     }
297     else if (strncmp(option, "-verbose", option_len) == 0)
298     {
299       printf("--verbose\n");
300
301       options.verbose = TRUE;
302     }
303     else if (*option == '-')
304       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
305     else if (options.server_host == NULL)
306     {
307       options.server_host = *options_left;
308
309       printf("server.name == '%s'\n", options.server_host);
310     }
311     else if (options.server_port == 0)
312     {
313       options.server_port = atoi(*options_left);
314       if (options.server_port < 1024)
315         Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
316
317       printf("port == %d\n", options.server_port);
318     }
319     else
320       Error(ERR_EXIT_HELP, "too many arguments");
321
322     options_left++;
323   }
324 }
325
326 void Error(int mode, char *format_str, ...)
327 {
328   FILE *output_stream = stderr;
329   char *process_name = "";
330
331   if (mode & ERR_SOUNDSERVER)
332     process_name = " sound server";
333
334   if (format_str)
335   {
336     va_list ap;
337     char *format_ptr;
338     char *s_value;
339     int i_value;
340     double d_value;
341
342     fprintf(output_stream, "%s%s: ", program_name, process_name);
343
344     if (mode & ERR_WARN)
345       fprintf(output_stream, "warning: ");
346
347     va_start(ap, format_str);   /* ap points to first unnamed argument */
348   
349     for(format_ptr=format_str; *format_ptr; format_ptr++)
350     {
351       if (*format_ptr != '%')
352       {
353         fprintf(output_stream, "%c", *format_ptr);
354         continue;
355       }
356   
357       switch(*++format_ptr)
358       {
359         case 'd':
360           i_value = va_arg(ap, int);
361           fprintf(output_stream, "%d", i_value);
362           break;
363   
364         case 'f':
365           d_value = va_arg(ap, double);
366           fprintf(output_stream, "%f", d_value);
367           break;
368   
369         case 's':
370           s_value = va_arg(ap, char *);
371           fprintf(output_stream, "%s", s_value);
372           break;
373   
374         default:
375           fprintf(stderr, "\n%s: Error(): invalid format string: %s\n",
376                   program_name, format_str);
377           CloseAllAndExit(10);
378       }
379     }
380
381     va_end(ap);
382   
383     fprintf(output_stream, "\n");
384   }
385   
386   if (mode & ERR_HELP)
387     fprintf(output_stream, "%s: Try option '--help' for more information.\n",
388             program_name);
389
390   if (mode & ERR_EXIT)
391   {
392     fprintf(output_stream, "%s%s: aborting\n", program_name, process_name);
393     CloseAllAndExit(1);
394   }
395 }
396
397 void *checked_malloc(unsigned long size)
398 {
399   void *ptr;
400
401   ptr = malloc(size);
402
403   if (ptr == NULL)
404     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
405
406   return ptr;
407 }
408
409 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
410 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
411 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  2
412
413 void translate_keyname(KeySym *keysym, char **x11name, char **name, int mode)
414 {
415   static struct
416   {
417     KeySym keysym;
418     char *x11name;
419     char *name;
420   } translate_key[] =
421   {
422     /* normal cursor keys */
423     { XK_Left,          "XK_Left",              "cursor left" },
424     { XK_Right,         "XK_Right",             "cursor right" },
425     { XK_Up,            "XK_Up",                "cursor up" },
426     { XK_Down,          "XK_Down",              "cursor down" },
427
428     /* keypad cursor keys */
429 #ifdef XK_KP_Left
430     { XK_KP_Left,       "XK_KP_Left",           "keypad left" },
431     { XK_KP_Right,      "XK_KP_Right",          "keypad right" },
432     { XK_KP_Up,         "XK_KP_Up",             "keypad up" },
433     { XK_KP_Down,       "XK_KP_Down",           "keypad down" },
434 #endif
435
436     /* other keypad keys */
437 #ifdef XK_KP_Enter
438     { XK_KP_Enter,      "XK_KP_Enter",          "keypad enter" },
439     { XK_KP_Add,        "XK_KP_Add",            "keypad +" },
440     { XK_KP_Subtract,   "XK_KP_Subtract",       "keypad -" },
441     { XK_KP_Multiply,   "XK_KP_Multiply",       "keypad mltply" },
442     { XK_KP_Divide,     "XK_KP_Divide",         "keypad /" },
443     { XK_KP_Separator,  "XK_KP_Separator",      "keypad ," },
444 #endif
445
446     /* modifier keys */
447     { XK_Shift_L,       "XK_Shift_L",           "left shift" },
448     { XK_Shift_R,       "XK_Shift_R",           "right shift" },
449     { XK_Control_L,     "XK_Control_L",         "left control" },
450     { XK_Control_R,     "XK_Control_R",         "right control" },
451     { XK_Meta_L,        "XK_Meta_L",            "left meta" },
452     { XK_Meta_R,        "XK_Meta_R",            "right meta" },
453     { XK_Alt_L,         "XK_Alt_L",             "left alt" },
454     { XK_Alt_R,         "XK_Alt_R",             "right alt" },
455     { XK_Mode_switch,   "XK_Mode_switch",       "mode switch" },
456     { XK_Multi_key,     "XK_Multi_key",         "multi key" },
457
458     /* some special keys */
459     { XK_BackSpace,     "XK_BackSpace",         "backspace" },
460     { XK_Delete,        "XK_Delete",            "delete" },
461     { XK_Insert,        "XK_Insert",            "insert" },
462     { XK_Tab,           "XK_Tab",               "tab" },
463     { XK_Home,          "XK_Home",              "home" },
464     { XK_End,           "XK_End",               "end" },
465     { XK_Page_Up,       "XK_Page_Up",           "page up" },
466     { XK_Page_Down,     "XK_Page_Down",         "page down" },
467     { XK_space,         "XK_space",             "space" },
468
469     /* even more special keys */
470     { XK_adiaeresis,    "XK_adiaeresis",        "ä" },
471     { XK_odiaeresis,    "XK_odiaeresis",        "ö" },
472     { XK_udiaeresis,    "XK_udiaeresis",        "ü" },
473     { XK_apostrophe,    "XK_apostrophe",        "'" },
474     { XK_plus,          "XK_plus",              "+" },
475     { XK_minus,         "XK_minus",             "-" },
476     { XK_comma,         "XK_comma",             "," },
477     { XK_period,        "XK_period",            "." },
478     { XK_numbersign,    "XK_numbersign",        "#" },
479     { XK_less,          "XK_less",              "less" },
480     { XK_greater,       "XK_greater",           "greater" },
481     { XK_asciicircum,   "XK_asciicircum",       "circumflex" },
482     { XK_ssharp,        "XK_ssharp",            "sharp s" },
483
484     /* end-of-array identifier */
485     { 0,                NULL,                   NULL }
486   };
487
488   int i;
489
490   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
491   {
492     static char name_buffer[30];
493     KeySym key = *keysym;
494
495     if (key >= XK_A && key <= XK_Z)
496       sprintf(name_buffer, "%c", 'A' + (char)(key - XK_A));
497     else if (key >= XK_a && key <= XK_z)
498       sprintf(name_buffer, "%c", 'a' + (char)(key - XK_a));
499     else if (key >= XK_0 && key <= XK_9)
500       sprintf(name_buffer, "%c", '0' + (char)(key - XK_0));
501     else if (key >= XK_KP_0 && key <= XK_KP_9)
502       sprintf(name_buffer, "keypad %c", '0' + (char)(key - XK_KP_0));
503     else if (key >= XK_F1 && key <= XK_F24)
504       sprintf(name_buffer, "function F%d", (int)(key - XK_F1 + 1));
505     else if (key == KEY_UNDEFINDED)
506       strcpy(name_buffer, "(undefined)");
507     else
508     {
509       i = 0;
510
511       do
512       {
513         if (key == translate_key[i].keysym)
514         {
515           strcpy(name_buffer, translate_key[i].name);
516           break;
517         }
518       }
519       while (translate_key[++i].name);
520
521       if (!translate_key[i].name)
522         strcpy(name_buffer, "(unknown)");
523     }
524
525     *name = name_buffer;
526   }
527   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
528   {
529     static char name_buffer[30];
530     KeySym key = *keysym;
531
532     if (key >= XK_A && key <= XK_Z)
533       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - XK_A));
534     else if (key >= XK_a && key <= XK_z)
535       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - XK_a));
536     else if (key >= XK_0 && key <= XK_9)
537       sprintf(name_buffer, "XK_%c", '0' + (char)(key - XK_0));
538     else if (key >= XK_KP_0 && key <= XK_KP_9)
539       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - XK_KP_0));
540     else if (key >= XK_F1 && key <= XK_F24)
541       sprintf(name_buffer, "XK_F%d", (int)(key - XK_F1 + 1));
542     else if (key == KEY_UNDEFINDED)
543       strcpy(name_buffer, "[undefined]");
544     else
545     {
546       i = 0;
547
548       do
549       {
550         if (key == translate_key[i].keysym)
551         {
552           strcpy(name_buffer, translate_key[i].x11name);
553           break;
554         }
555       }
556       while (translate_key[++i].x11name);
557
558       if (!translate_key[i].x11name)
559         sprintf(name_buffer, "0x%04lx", (unsigned long)key);
560     }
561
562     *x11name = name_buffer;
563   }
564   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
565   {
566     KeySym key = XK_VoidSymbol;
567     char *name_ptr = *x11name;
568
569     if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
570     {
571       char c = name_ptr[3];
572
573       if (c >= 'A' && c <= 'Z')
574         key = XK_A + (KeySym)(c - 'A');
575       else if (c >= 'a' && c <= 'z')
576         key = XK_a + (KeySym)(c - 'a');
577       else if (c >= '0' && c <= '9')
578         key = XK_0 + (KeySym)(c - '0');
579     }
580     else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
581     {
582       char c = name_ptr[6];
583
584       if (c >= '0' && c <= '9')
585         key = XK_0 + (KeySym)(c - '0');
586     }
587     else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
588     {
589       char c1 = name_ptr[4];
590       char c2 = name_ptr[5];
591       int d = 0;
592
593       if ((c1 >= '0' && c1 <= '9') &&
594           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
595         d = atoi(&name_ptr[4]);
596
597       if (d >=1 && d <= 24)
598         key = XK_F1 + (KeySym)(d - 1);
599     }
600     else if (strncmp(name_ptr, "XK_", 3) == 0)
601     {
602       i = 0;
603
604       do
605       {
606         if (strcmp(name_ptr, translate_key[i].x11name) == 0)
607         {
608           key = translate_key[i].keysym;
609           break;
610         }
611       }
612       while (translate_key[++i].x11name);
613     }
614     else if (strncmp(name_ptr, "0x", 2) == 0)
615     {
616       unsigned long value = 0;
617
618       name_ptr += 2;
619
620       while (name_ptr)
621       {
622         char c = *name_ptr++;
623         int d = -1;
624
625         if (c >= '0' && c <= '9')
626           d = (int)(c - '0');
627         else if (c >= 'a' && c <= 'f')
628           d = (int)(c - 'a' + 10);
629         else if (c >= 'A' && c <= 'F')
630           d = (int)(c - 'A' + 10);
631
632         if (d == -1)
633         {
634           value = -1;
635           break;
636         }
637
638         value = value * 16 + d;
639       }
640
641       if (value != -1)
642         key = (KeySym)value;
643     }
644
645     *keysym = key;
646   }
647 }
648
649 char *getKeyNameFromKeySym(KeySym keysym)
650 {
651   char *name;
652
653   translate_keyname(&keysym, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
654   return name;
655 }
656
657 char *getX11KeyNameFromKeySym(KeySym keysym)
658 {
659   char *x11name;
660
661   translate_keyname(&keysym, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
662   return x11name;
663 }
664
665 KeySym getKeySymFromX11KeyName(char *x11name)
666 {
667   KeySym keysym;
668
669   translate_keyname(&keysym, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
670   return keysym;
671 }
672
673 #define TRANSLATE_JOYSYMBOL_TO_JOYNAME  0
674 #define TRANSLATE_JOYNAME_TO_JOYSYMBOL  1
675
676 void translate_joyname(int *joysymbol, char **name, int mode)
677 {
678   static struct
679   {
680     int joysymbol;
681     char *name;
682   } translate_joy[] =
683   {
684     { JOY_LEFT,         "joystick_left" },
685     { JOY_RIGHT,        "joystick_right" },
686     { JOY_UP,           "joystick_up" },
687     { JOY_DOWN,         "joystick_down" },
688     { JOY_BUTTON_1,     "joystick_button_1" },
689     { JOY_BUTTON_2,     "joystick_button_2" },
690   };
691
692   int i;
693
694   if (mode == TRANSLATE_JOYSYMBOL_TO_JOYNAME)
695   {
696     *name = "[undefined]";
697
698     for (i=0; i<6; i++)
699     {
700       if (*joysymbol == translate_joy[i].joysymbol)
701       {
702         *name = translate_joy[i].name;
703         break;
704       }
705     }
706   }
707   else if (mode == TRANSLATE_JOYNAME_TO_JOYSYMBOL)
708   {
709     *joysymbol = 0;
710
711     for (i=0; i<6; i++)
712     {
713       if (strcmp(*name, translate_joy[i].name) == 0)
714       {
715         *joysymbol = translate_joy[i].joysymbol;
716         break;
717       }
718     }
719   }
720 }
721
722 char *getJoyNameFromJoySymbol(int joysymbol)
723 {
724   char *name;
725
726   translate_joyname(&joysymbol, &name, TRANSLATE_JOYSYMBOL_TO_JOYNAME);
727   return name;
728 }
729
730 int getJoySymbolFromJoyName(char *name)
731 {
732   int joysymbol;
733
734   translate_joyname(&joysymbol, &name, TRANSLATE_JOYNAME_TO_JOYSYMBOL);
735   return joysymbol;
736 }