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