1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2001 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
16 #include <sys/types.h>
25 #if !defined(PLATFORM_WIN32)
27 #include <sys/param.h>
34 #if defined(PLATFORM_MSDOS)
35 volatile unsigned long counter = 0;
37 void increment_counter()
42 END_OF_FUNCTION(increment_counter);
46 /* maximal allowed length of a command line option */
47 #define MAX_OPTION_LEN 256
50 static unsigned long mainCounter(int mode)
52 static unsigned long base_ms = 0;
53 unsigned long current_ms;
54 unsigned long counter_ms;
56 current_ms = SDL_GetTicks();
58 /* reset base time in case of counter initializing or wrap-around */
59 if (mode == INIT_COUNTER || current_ms < base_ms)
62 counter_ms = current_ms - base_ms;
64 return counter_ms; /* return milliseconds since last init */
67 #else /* !TARGET_SDL */
69 #if defined(PLATFORM_UNIX)
70 static unsigned long mainCounter(int mode)
72 static struct timeval base_time = { 0, 0 };
73 struct timeval current_time;
74 unsigned long counter_ms;
76 gettimeofday(¤t_time, NULL);
78 /* reset base time in case of counter initializing or wrap-around */
79 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
80 base_time = current_time;
82 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
83 + (current_time.tv_usec - base_time.tv_usec) / 1000;
85 return counter_ms; /* return milliseconds since last init */
87 #endif /* PLATFORM_UNIX */
88 #endif /* !TARGET_SDL */
90 void InitCounter() /* set counter back to zero */
92 #if !defined(PLATFORM_MSDOS)
93 mainCounter(INIT_COUNTER);
95 LOCK_VARIABLE(counter);
96 LOCK_FUNCTION(increment_counter);
97 install_int_ex(increment_counter, BPS_TO_TIMER(100));
101 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
103 #if !defined(PLATFORM_MSDOS)
104 return mainCounter(READ_COUNTER);
106 return (counter * 10);
110 static void sleep_milliseconds(unsigned long milliseconds_delay)
112 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
114 #if defined(PLATFORM_MSDOS)
115 /* don't use select() to perform waiting operations under DOS/Windows
116 environment; always use a busy loop for waiting instead */
117 do_busy_waiting = TRUE;
122 /* we want to wait only a few ms -- if we assume that we have a
123 kernel timer resolution of 10 ms, we would wait far to long;
124 therefore it's better to do a short interval of busy waiting
125 to get our sleeping time more accurate */
127 unsigned long base_counter = Counter(), actual_counter = Counter();
129 while (actual_counter < base_counter + milliseconds_delay &&
130 actual_counter >= base_counter)
131 actual_counter = Counter();
135 #if defined(TARGET_SDL)
136 SDL_Delay(milliseconds_delay);
138 struct timeval delay;
140 delay.tv_sec = milliseconds_delay / 1000;
141 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
143 if (select(0, NULL, NULL, NULL, &delay) != 0)
144 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
149 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
151 sleep_milliseconds(delay);
154 boolean FrameReached(unsigned long *frame_counter_var,
155 unsigned long frame_delay)
157 unsigned long actual_frame_counter = FrameCounter;
159 if (actual_frame_counter < *frame_counter_var+frame_delay &&
160 actual_frame_counter >= *frame_counter_var)
163 *frame_counter_var = actual_frame_counter;
167 boolean DelayReached(unsigned long *counter_var,
170 unsigned long actual_counter = Counter();
172 if (actual_counter < *counter_var + delay &&
173 actual_counter >= *counter_var)
176 *counter_var = actual_counter;
180 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
182 unsigned long actual_counter;
186 actual_counter = Counter();
188 if (actual_counter < *counter_var + delay &&
189 actual_counter >= *counter_var)
190 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
195 *counter_var = actual_counter;
198 /* int2str() returns a number converted to a string;
199 the used memory is static, but will be overwritten by later calls,
200 so if you want to save the result, copy it to a private string buffer;
201 there can be 10 local calls of int2str() without buffering the result --
202 the 11th call will then destroy the result from the first call and so on.
205 char *int2str(int number, int size)
207 static char shift_array[10][40];
208 static int shift_counter = 0;
209 char *s = shift_array[shift_counter];
211 shift_counter = (shift_counter + 1) % 10;
218 sprintf(s, " %09d", number);
219 return &s[strlen(s) - size];
223 sprintf(s, "%d", number);
228 unsigned int SimpleRND(unsigned int max)
230 #if defined(TARGET_SDL)
231 static unsigned long root = 654321;
232 unsigned long current_ms;
234 current_ms = SDL_GetTicks();
235 root = root * 4253261 + current_ms;
238 static unsigned long root = 654321;
239 struct timeval current_time;
241 gettimeofday(¤t_time, NULL);
242 root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
248 static unsigned int last_RND_value = 0;
250 unsigned int last_RND()
252 return last_RND_value;
256 unsigned int RND(unsigned int max)
259 return (last_RND_value = random_linux_libc() % max);
261 return (random_linux_libc() % max);
265 unsigned int InitRND(long seed)
267 #if defined(TARGET_SDL)
268 unsigned long current_ms;
270 if (seed == NEW_RANDOMIZE)
272 current_ms = SDL_GetTicks();
273 srandom_linux_libc((unsigned int) current_ms);
274 return (unsigned int) current_ms;
278 srandom_linux_libc((unsigned int) seed);
279 return (unsigned int) seed;
282 struct timeval current_time;
284 if (seed == NEW_RANDOMIZE)
286 gettimeofday(¤t_time, NULL);
287 srandom_linux_libc((unsigned int) current_time.tv_usec);
288 return (unsigned int) current_time.tv_usec;
292 srandom_linux_libc((unsigned int) seed);
293 return (unsigned int) seed;
300 #if defined(PLATFORM_WIN32)
301 return ANONYMOUS_NAME;
305 if ((pwd = getpwuid(getuid())) == NULL)
306 return ANONYMOUS_NAME;
314 #if defined(PLATFORM_UNIX)
317 if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0)
318 return ANONYMOUS_NAME;
321 static char real_name[1024];
322 char *from_ptr = pwd->pw_gecos, *to_ptr = real_name;
324 if (strchr(pwd->pw_gecos, 'ß') == NULL)
325 return pwd->pw_gecos;
327 /* the user's real name contains a 'ß' character (german sharp s),
328 which has no equivalent in upper case letters (which our fonts use) */
329 while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2)
331 if (*from_ptr != 'ß')
332 *to_ptr++ = *from_ptr++;
344 #else /* !PLATFORM_UNIX */
345 return ANONYMOUS_NAME;
351 #if defined(PLATFORM_UNIX)
352 static char *home_dir = NULL;
356 if (!(home_dir = getenv("HOME")))
360 if ((pwd = getpwuid(getuid())))
361 home_dir = pwd->pw_dir;
373 char *getPath2(char *path1, char *path2)
375 char *complete_path = checked_malloc(strlen(path1) + 1 +
378 sprintf(complete_path, "%s/%s", path1, path2);
379 return complete_path;
382 char *getPath3(char *path1, char *path2, char *path3)
384 char *complete_path = checked_malloc(strlen(path1) + 1 +
388 sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
389 return complete_path;
392 char *getStringCopy(char *s)
399 s_copy = checked_malloc(strlen(s) + 1);
405 char *getStringToLower(char *s)
407 char *s_copy = checked_malloc(strlen(s) + 1);
408 char *s_ptr = s_copy;
411 *s_ptr++ = tolower(*s++);
417 void GetOptions(char *argv[])
419 char **options_left = &argv[1];
421 /* initialize global program options */
422 options.display_name = NULL;
423 options.server_host = NULL;
424 options.server_port = 0;
425 options.ro_base_directory = RO_BASE_PATH;
426 options.rw_base_directory = RW_BASE_PATH;
427 options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
428 options.serveronly = FALSE;
429 options.network = FALSE;
430 options.verbose = FALSE;
431 options.debug = FALSE;
433 while (*options_left)
435 char option_str[MAX_OPTION_LEN];
436 char *option = options_left[0];
437 char *next_option = options_left[1];
438 char *option_arg = NULL;
439 int option_len = strlen(option);
441 if (option_len >= MAX_OPTION_LEN)
442 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
444 strcpy(option_str, option); /* copy argument into buffer */
447 if (strcmp(option, "--") == 0) /* stop scanning arguments */
450 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
453 option_arg = strchr(option, '=');
454 if (option_arg == NULL) /* no '=' in option */
455 option_arg = next_option;
458 *option_arg++ = '\0'; /* cut argument from option */
459 if (*option_arg == '\0') /* no argument after '=' */
460 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
463 option_len = strlen(option);
465 if (strcmp(option, "-") == 0)
466 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
467 else if (strncmp(option, "-help", option_len) == 0)
469 printf("Usage: %s [options] [server.name [port]]\n"
471 " -d, --display machine:0 X server display\n"
472 " -b, --basepath directory alternative base directory\n"
473 " -l, --level directory alternative level directory\n"
474 " -s, --serveronly only start network server\n"
475 " -n, --network network multiplayer game\n"
476 " -v, --verbose verbose mode\n"
477 " --debug display debugging information\n",
478 program.command_basename);
481 else if (strncmp(option, "-display", option_len) == 0)
483 if (option_arg == NULL)
484 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
486 options.display_name = option_arg;
487 if (option_arg == next_option)
490 else if (strncmp(option, "-basepath", option_len) == 0)
492 if (option_arg == NULL)
493 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
495 /* this should be extended to separate options for ro and rw data */
496 options.ro_base_directory = option_arg;
497 options.rw_base_directory = option_arg;
498 if (option_arg == next_option)
501 /* adjust path for level directory accordingly */
502 options.level_directory =
503 getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
505 else if (strncmp(option, "-levels", option_len) == 0)
507 if (option_arg == NULL)
508 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
510 options.level_directory = option_arg;
511 if (option_arg == next_option)
514 else if (strncmp(option, "-network", option_len) == 0)
516 options.network = TRUE;
518 else if (strncmp(option, "-serveronly", option_len) == 0)
520 options.serveronly = TRUE;
522 else if (strncmp(option, "-verbose", option_len) == 0)
524 options.verbose = TRUE;
526 else if (strncmp(option, "-debug", option_len) == 0)
528 options.debug = TRUE;
530 else if (*option == '-')
532 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
534 else if (options.server_host == NULL)
536 options.server_host = *options_left;
538 else if (options.server_port == 0)
540 options.server_port = atoi(*options_left);
541 if (options.server_port < 1024)
542 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
545 Error(ERR_EXIT_HELP, "too many arguments");
551 void Error(int mode, char *format, ...)
553 char *process_name = "";
554 FILE *error = stderr;
555 char *newline = "\n";
557 /* display warnings only when running in verbose mode */
558 if (mode & ERR_WARN && !options.verbose)
561 #if !defined(PLATFORM_UNIX)
564 if ((error = openErrorFile()) == NULL)
566 printf("Cannot write to error output file!%s", newline);
567 program.exit_function(1);
571 if (mode & ERR_SOUND_SERVER)
572 process_name = " sound server";
573 else if (mode & ERR_NETWORK_SERVER)
574 process_name = " network server";
575 else if (mode & ERR_NETWORK_CLIENT)
576 process_name = " network client **";
582 fprintf(error, "%s%s: ", program.command_basename, process_name);
585 fprintf(error, "warning: ");
587 va_start(ap, format);
588 vfprintf(error, format, ap);
591 fprintf(error, "%s", newline);
595 fprintf(error, "%s: Try option '--help' for more information.%s",
596 program.command_basename, newline);
599 fprintf(error, "%s%s: aborting%s",
600 program.command_basename, process_name, newline);
607 if (mode & ERR_FROM_SERVER)
608 exit(1); /* child process: normal exit */
610 program.exit_function(1); /* main process: clean up stuff */
614 void *checked_malloc(unsigned long size)
621 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
626 void *checked_calloc(unsigned long size)
630 ptr = calloc(1, size);
633 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
638 void *checked_realloc(void *ptr, unsigned long size)
640 ptr = realloc(ptr, size);
643 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
648 short getFile16BitInteger(FILE *file, int byte_order)
650 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
651 return ((fgetc(file) << 8) |
653 else /* BYTE_ORDER_LITTLE_ENDIAN */
654 return ((fgetc(file) << 0) |
658 void putFile16BitInteger(FILE *file, short value, int byte_order)
660 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
662 fputc((value >> 8) & 0xff, file);
663 fputc((value >> 0) & 0xff, file);
665 else /* BYTE_ORDER_LITTLE_ENDIAN */
667 fputc((value >> 0) & 0xff, file);
668 fputc((value >> 8) & 0xff, file);
672 int getFile32BitInteger(FILE *file, int byte_order)
674 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
675 return ((fgetc(file) << 24) |
676 (fgetc(file) << 16) |
679 else /* BYTE_ORDER_LITTLE_ENDIAN */
680 return ((fgetc(file) << 0) |
682 (fgetc(file) << 16) |
683 (fgetc(file) << 24));
686 void putFile32BitInteger(FILE *file, int value, int byte_order)
688 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
690 fputc((value >> 24) & 0xff, file);
691 fputc((value >> 16) & 0xff, file);
692 fputc((value >> 8) & 0xff, file);
693 fputc((value >> 0) & 0xff, file);
695 else /* BYTE_ORDER_LITTLE_ENDIAN */
697 fputc((value >> 0) & 0xff, file);
698 fputc((value >> 8) & 0xff, file);
699 fputc((value >> 16) & 0xff, file);
700 fputc((value >> 24) & 0xff, file);
704 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
707 const int chunk_name_length = 4;
709 /* read chunk name */
710 fgets(chunk_name, chunk_name_length + 1, file);
712 if (chunk_size != NULL)
714 /* read chunk size */
715 *chunk_size = getFile32BitInteger(file, byte_order);
718 return (feof(file) || ferror(file) ? FALSE : TRUE);
721 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
724 /* write chunk name */
725 fputs(chunk_name, file);
729 /* write chunk size */
730 putFile32BitInteger(file, chunk_size, byte_order);
734 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
740 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
746 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
747 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
748 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 2
750 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
759 /* normal cursor keys */
760 { KSYM_Left, "XK_Left", "cursor left" },
761 { KSYM_Right, "XK_Right", "cursor right" },
762 { KSYM_Up, "XK_Up", "cursor up" },
763 { KSYM_Down, "XK_Down", "cursor down" },
765 /* keypad cursor keys */
767 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
768 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
769 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
770 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
773 /* other keypad keys */
775 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
776 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
777 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
778 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
779 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
780 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
784 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
785 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
786 { KSYM_Control_L, "XK_Control_L", "left control" },
787 { KSYM_Control_R, "XK_Control_R", "right control" },
788 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
789 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
790 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
791 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
792 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
793 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
794 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
795 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
797 /* some special keys */
798 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
799 { KSYM_Delete, "XK_Delete", "delete" },
800 { KSYM_Insert, "XK_Insert", "insert" },
801 { KSYM_Tab, "XK_Tab", "tab" },
802 { KSYM_Home, "XK_Home", "home" },
803 { KSYM_End, "XK_End", "end" },
804 { KSYM_Page_Up, "XK_Page_Up", "page up" },
805 { KSYM_Page_Down, "XK_Page_Down", "page down" },
806 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
808 /* ASCII 0x20 to 0x40 keys (except numbers) */
809 { KSYM_space, "XK_space", "space" },
810 { KSYM_exclam, "XK_exclam", "!" },
811 { KSYM_quotedbl, "XK_quotedbl", "\"" },
812 { KSYM_numbersign, "XK_numbersign", "#" },
813 { KSYM_dollar, "XK_dollar", "$" },
814 { KSYM_percent, "XK_percent", "%" },
815 { KSYM_ampersand, "XK_ampersand", "&" },
816 { KSYM_apostrophe, "XK_apostrophe", "'" },
817 { KSYM_parenleft, "XK_parenleft", "(" },
818 { KSYM_parenright, "XK_parenright", ")" },
819 { KSYM_asterisk, "XK_asterisk", "*" },
820 { KSYM_plus, "XK_plus", "+" },
821 { KSYM_comma, "XK_comma", "," },
822 { KSYM_minus, "XK_minus", "-" },
823 { KSYM_period, "XK_period", "." },
824 { KSYM_slash, "XK_slash", "/" },
825 { KSYM_colon, "XK_colon", ":" },
826 { KSYM_semicolon, "XK_semicolon", ";" },
827 { KSYM_less, "XK_less", "<" },
828 { KSYM_equal, "XK_equal", "=" },
829 { KSYM_greater, "XK_greater", ">" },
830 { KSYM_question, "XK_question", "?" },
831 { KSYM_at, "XK_at", "@" },
833 /* more ASCII keys */
834 { KSYM_bracketleft, "XK_bracketleft", "[" },
835 { KSYM_backslash, "XK_backslash", "backslash" },
836 { KSYM_bracketright,"XK_bracketright", "]" },
837 { KSYM_asciicircum, "XK_asciicircum", "circumflex" },
838 { KSYM_underscore, "XK_underscore", "_" },
839 { KSYM_grave, "XK_grave", "grave" },
840 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
841 { KSYM_braceleft, "XK_braceleft", "brace left" },
842 { KSYM_bar, "XK_bar", "bar" },
843 { KSYM_braceright, "XK_braceright", "brace right" },
844 { KSYM_asciitilde, "XK_asciitilde", "ascii tilde" },
846 /* special (non-ASCII) keys */
847 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
848 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
849 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
850 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
851 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
852 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
853 { KSYM_ssharp, "XK_ssharp", "sharp s" },
855 /* end-of-array identifier */
861 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
863 static char name_buffer[30];
866 if (key >= KSYM_A && key <= KSYM_Z)
867 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
868 else if (key >= KSYM_a && key <= KSYM_z)
869 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
870 else if (key >= KSYM_0 && key <= KSYM_9)
871 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
872 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
873 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
874 else if (key >= KSYM_F1 && key <= KSYM_F24)
875 sprintf(name_buffer, "function F%d", (int)(key - KSYM_F1 + 1));
876 else if (key == KSYM_UNDEFINED)
877 strcpy(name_buffer, "(undefined)");
884 if (key == translate_key[i].key)
886 strcpy(name_buffer, translate_key[i].name);
890 while (translate_key[++i].name);
892 if (!translate_key[i].name)
893 strcpy(name_buffer, "(unknown)");
898 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
900 static char name_buffer[30];
903 if (key >= KSYM_A && key <= KSYM_Z)
904 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
905 else if (key >= KSYM_a && key <= KSYM_z)
906 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
907 else if (key >= KSYM_0 && key <= KSYM_9)
908 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
909 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
910 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
911 else if (key >= KSYM_F1 && key <= KSYM_F24)
912 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_F1 + 1));
913 else if (key == KSYM_UNDEFINED)
914 strcpy(name_buffer, "[undefined]");
921 if (key == translate_key[i].key)
923 strcpy(name_buffer, translate_key[i].x11name);
927 while (translate_key[++i].x11name);
929 if (!translate_key[i].x11name)
930 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
933 *x11name = name_buffer;
935 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
937 Key key = KSYM_UNDEFINED;
938 char *name_ptr = *x11name;
940 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
942 char c = name_ptr[3];
944 if (c >= 'A' && c <= 'Z')
945 key = KSYM_A + (Key)(c - 'A');
946 else if (c >= 'a' && c <= 'z')
947 key = KSYM_a + (Key)(c - 'a');
948 else if (c >= '0' && c <= '9')
949 key = KSYM_0 + (Key)(c - '0');
951 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
953 char c = name_ptr[6];
955 if (c >= '0' && c <= '9')
956 key = KSYM_0 + (Key)(c - '0');
958 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
960 char c1 = name_ptr[4];
961 char c2 = name_ptr[5];
964 if ((c1 >= '0' && c1 <= '9') &&
965 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
966 d = atoi(&name_ptr[4]);
968 if (d >=1 && d <= 24)
969 key = KSYM_F1 + (Key)(d - 1);
971 else if (strncmp(name_ptr, "XK_", 3) == 0)
977 if (strcmp(name_ptr, translate_key[i].x11name) == 0)
979 key = translate_key[i].key;
983 while (translate_key[++i].x11name);
985 else if (strncmp(name_ptr, "0x", 2) == 0)
987 unsigned long value = 0;
993 char c = *name_ptr++;
996 if (c >= '0' && c <= '9')
998 else if (c >= 'a' && c <= 'f')
999 d = (int)(c - 'a' + 10);
1000 else if (c >= 'A' && c <= 'F')
1001 d = (int)(c - 'A' + 10);
1009 value = value * 16 + d;
1020 char *getKeyNameFromKey(Key key)
1024 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1028 char *getX11KeyNameFromKey(Key key)
1032 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1036 Key getKeyFromX11KeyName(char *x11name)
1040 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1044 char getCharFromKey(Key key)
1046 char *keyname = getKeyNameFromKey(key);
1049 if (strlen(keyname) == 1)
1050 letter = keyname[0];
1051 else if (strcmp(keyname, "space") == 0)
1053 else if (strcmp(keyname, "circumflex") == 0)
1059 /* ------------------------------------------------------------------------- */
1060 /* some functions to handle lists of level directories */
1061 /* ------------------------------------------------------------------------- */
1063 struct LevelDirInfo *newLevelDirInfo()
1065 return checked_calloc(sizeof(struct LevelDirInfo));
1068 void pushLevelDirInfo(struct LevelDirInfo **node_first,
1069 struct LevelDirInfo *node_new)
1071 node_new->next = *node_first;
1072 *node_first = node_new;
1075 int numLevelDirInfo(struct LevelDirInfo *node)
1088 boolean validLevelSeries(struct LevelDirInfo *node)
1090 return (node != NULL && !node->node_group && !node->parent_link);
1093 struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *node)
1097 if (leveldir_first) /* start with first level directory entry */
1098 return getFirstValidLevelSeries(leveldir_first);
1102 else if (node->node_group) /* enter level group (step down into tree) */
1103 return getFirstValidLevelSeries(node->node_group);
1104 else if (node->parent_link) /* skip start entry of level group */
1106 if (node->next) /* get first real level series entry */
1107 return getFirstValidLevelSeries(node->next);
1108 else /* leave empty level group and go on */
1109 return getFirstValidLevelSeries(node->node_parent->next);
1111 else /* this seems to be a regular level series */
1115 struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *node)
1120 if (node->node_parent == NULL) /* top level group */
1121 return leveldir_first;
1122 else /* sub level group */
1123 return node->node_parent->node_group;
1126 int numLevelDirInfoInGroup(struct LevelDirInfo *node)
1128 return numLevelDirInfo(getLevelDirInfoFirstGroupEntry(node));
1131 int posLevelDirInfo(struct LevelDirInfo *node)
1133 struct LevelDirInfo *node_cmp = getLevelDirInfoFirstGroupEntry(node);
1138 if (node_cmp == node)
1142 node_cmp = node_cmp->next;
1148 struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos)
1150 struct LevelDirInfo *node_default = node;
1162 return node_default;
1165 struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node,
1168 if (filename == NULL)
1173 if (node->node_group)
1175 struct LevelDirInfo *node_group;
1177 node_group = getLevelDirInfoFromFilenameExt(node->node_group, filename);
1182 else if (!node->parent_link)
1184 if (strcmp(filename, node->filename) == 0)
1194 struct LevelDirInfo *getLevelDirInfoFromFilename(char *filename)
1196 return getLevelDirInfoFromFilenameExt(leveldir_first, filename);
1199 void dumpLevelDirInfo(struct LevelDirInfo *node, int depth)
1205 for (i=0; i<depth * 3; i++)
1208 printf("filename == '%s'\n", node->filename);
1210 if (node->node_group != NULL)
1211 dumpLevelDirInfo(node->node_group, depth + 1);
1217 void sortLevelDirInfo(struct LevelDirInfo **node_first,
1218 int (*compare_function)(const void *, const void *))
1220 int num_nodes = numLevelDirInfo(*node_first);
1221 struct LevelDirInfo **sort_array;
1222 struct LevelDirInfo *node = *node_first;
1228 /* allocate array for sorting structure pointers */
1229 sort_array = checked_calloc(num_nodes * sizeof(struct LevelDirInfo *));
1231 /* writing structure pointers to sorting array */
1232 while (i < num_nodes && node) /* double boundary check... */
1234 sort_array[i] = node;
1240 /* sorting the structure pointers in the sorting array */
1241 qsort(sort_array, num_nodes, sizeof(struct LevelDirInfo *),
1244 /* update the linkage of list elements with the sorted node array */
1245 for (i=0; i<num_nodes - 1; i++)
1246 sort_array[i]->next = sort_array[i + 1];
1247 sort_array[num_nodes - 1]->next = NULL;
1249 /* update the linkage of the main list anchor pointer */
1250 *node_first = sort_array[0];
1254 /* now recursively sort the level group structures */
1258 if (node->node_group != NULL)
1259 sortLevelDirInfo(&node->node_group, compare_function);
1265 inline void swap_numbers(int *i1, int *i2)
1273 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1286 /* ========================================================================= */
1287 /* some stuff from "files.c" */
1288 /* ========================================================================= */
1290 #if defined(PLATFORM_WIN32)
1292 #define S_IRGRP S_IRUSR
1295 #define S_IROTH S_IRUSR
1298 #define S_IWGRP S_IWUSR
1301 #define S_IWOTH S_IWUSR
1304 #define S_IXGRP S_IXUSR
1307 #define S_IXOTH S_IXUSR
1310 #define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP)
1315 #endif /* PLATFORM_WIN32 */
1317 /* file permissions for newly written files */
1318 #define MODE_R_ALL (S_IRUSR | S_IRGRP | S_IROTH)
1319 #define MODE_W_ALL (S_IWUSR | S_IWGRP | S_IWOTH)
1320 #define MODE_X_ALL (S_IXUSR | S_IXGRP | S_IXOTH)
1322 #define MODE_W_PRIVATE (S_IWUSR)
1323 #define MODE_W_PUBLIC (S_IWUSR | S_IWGRP)
1324 #define MODE_W_PUBLIC_DIR (S_IWUSR | S_IWGRP | S_ISGID)
1326 #define DIR_PERMS_PRIVATE (MODE_R_ALL | MODE_X_ALL | MODE_W_PRIVATE)
1327 #define DIR_PERMS_PUBLIC (MODE_R_ALL | MODE_X_ALL | MODE_W_PUBLIC_DIR)
1329 #define FILE_PERMS_PRIVATE (MODE_R_ALL | MODE_W_PRIVATE)
1330 #define FILE_PERMS_PUBLIC (MODE_R_ALL | MODE_W_PUBLIC)
1332 char *getUserDataDir(void)
1334 static char *userdata_dir = NULL;
1338 char *home_dir = getHomeDir();
1339 char *data_dir = program.userdata_directory;
1341 userdata_dir = getPath2(home_dir, data_dir);
1344 return userdata_dir;
1349 return getUserDataDir();
1352 static mode_t posix_umask(mode_t mask)
1354 #if defined(PLATFORM_UNIX)
1361 static int posix_mkdir(const char *pathname, mode_t mode)
1363 #if defined(PLATFORM_WIN32)
1364 return mkdir(pathname);
1366 return mkdir(pathname, mode);
1370 void createDirectory(char *dir, char *text, int permission_class)
1372 /* leave "other" permissions in umask untouched, but ensure group parts
1373 of USERDATA_DIR_MODE are not masked */
1374 mode_t dir_mode = (permission_class == PERMS_PRIVATE ?
1375 DIR_PERMS_PRIVATE : DIR_PERMS_PUBLIC);
1376 mode_t normal_umask = posix_umask(0);
1377 mode_t group_umask = ~(dir_mode & S_IRWXG);
1378 posix_umask(normal_umask & group_umask);
1380 if (access(dir, F_OK) != 0)
1381 if (posix_mkdir(dir, dir_mode) != 0)
1382 Error(ERR_WARN, "cannot create %s directory '%s'", text, dir);
1384 posix_umask(normal_umask); /* reset normal umask */
1387 void InitUserDataDirectory()
1389 createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE);
1392 void SetFilePermissions(char *filename, int permission_class)
1394 chmod(filename, (permission_class == PERMS_PRIVATE ?
1395 FILE_PERMS_PRIVATE : FILE_PERMS_PUBLIC));
1398 int getFileVersionFromCookieString(const char *cookie)
1400 const char *ptr_cookie1, *ptr_cookie2;
1401 const char *pattern1 = "_FILE_VERSION_";
1402 const char *pattern2 = "?.?";
1403 const int len_cookie = strlen(cookie);
1404 const int len_pattern1 = strlen(pattern1);
1405 const int len_pattern2 = strlen(pattern2);
1406 const int len_pattern = len_pattern1 + len_pattern2;
1407 int version_major, version_minor;
1409 if (len_cookie <= len_pattern)
1412 ptr_cookie1 = &cookie[len_cookie - len_pattern];
1413 ptr_cookie2 = &cookie[len_cookie - len_pattern2];
1415 if (strncmp(ptr_cookie1, pattern1, len_pattern1) != 0)
1418 if (ptr_cookie2[0] < '0' || ptr_cookie2[0] > '9' ||
1419 ptr_cookie2[1] != '.' ||
1420 ptr_cookie2[2] < '0' || ptr_cookie2[2] > '9')
1423 version_major = ptr_cookie2[0] - '0';
1424 version_minor = ptr_cookie2[2] - '0';
1426 return VERSION_IDENT(version_major, version_minor, 0);
1429 boolean checkCookieString(const char *cookie, const char *template)
1431 const char *pattern = "_FILE_VERSION_?.?";
1432 const int len_cookie = strlen(cookie);
1433 const int len_template = strlen(template);
1434 const int len_pattern = strlen(pattern);
1436 if (len_cookie != len_template)
1439 if (strncmp(cookie, template, len_cookie - len_pattern) != 0)
1445 /* ------------------------------------------------------------------------- */
1446 /* setup file stuff */
1447 /* ------------------------------------------------------------------------- */
1449 static char *string_tolower(char *s)
1451 static char s_lower[100];
1454 if (strlen(s) >= 100)
1459 for (i=0; i<strlen(s_lower); i++)
1460 s_lower[i] = tolower(s_lower[i]);
1465 int get_string_integer_value(char *s)
1467 static char *number_text[][3] =
1469 { "0", "zero", "null", },
1470 { "1", "one", "first" },
1471 { "2", "two", "second" },
1472 { "3", "three", "third" },
1473 { "4", "four", "fourth" },
1474 { "5", "five", "fifth" },
1475 { "6", "six", "sixth" },
1476 { "7", "seven", "seventh" },
1477 { "8", "eight", "eighth" },
1478 { "9", "nine", "ninth" },
1479 { "10", "ten", "tenth" },
1480 { "11", "eleven", "eleventh" },
1481 { "12", "twelve", "twelfth" },
1486 for (i=0; i<13; i++)
1488 if (strcmp(string_tolower(s), number_text[i][j]) == 0)
1494 boolean get_string_boolean_value(char *s)
1496 if (strcmp(string_tolower(s), "true") == 0 ||
1497 strcmp(string_tolower(s), "yes") == 0 ||
1498 strcmp(string_tolower(s), "on") == 0 ||
1499 get_string_integer_value(s) == 1)
1505 char *getFormattedSetupEntry(char *token, char *value)
1508 static char entry[MAX_LINE_LEN];
1510 sprintf(entry, "%s:", token);
1511 for (i=strlen(entry); i<TOKEN_VALUE_POSITION; i++)
1515 strcat(entry, value);
1520 void freeSetupFileList(struct SetupFileList *setup_file_list)
1522 if (!setup_file_list)
1525 if (setup_file_list->token)
1526 free(setup_file_list->token);
1527 if (setup_file_list->value)
1528 free(setup_file_list->value);
1529 if (setup_file_list->next)
1530 freeSetupFileList(setup_file_list->next);
1531 free(setup_file_list);
1534 static struct SetupFileList *newSetupFileList(char *token, char *value)
1536 struct SetupFileList *new = checked_malloc(sizeof(struct SetupFileList));
1538 new->token = checked_malloc(strlen(token) + 1);
1539 strcpy(new->token, token);
1541 new->value = checked_malloc(strlen(value) + 1);
1542 strcpy(new->value, value);
1549 char *getTokenValue(struct SetupFileList *setup_file_list, char *token)
1551 if (!setup_file_list)
1554 if (strcmp(setup_file_list->token, token) == 0)
1555 return setup_file_list->value;
1557 return getTokenValue(setup_file_list->next, token);
1560 static void setTokenValue(struct SetupFileList *setup_file_list,
1561 char *token, char *value)
1563 if (!setup_file_list)
1566 if (strcmp(setup_file_list->token, token) == 0)
1568 free(setup_file_list->value);
1569 setup_file_list->value = checked_malloc(strlen(value) + 1);
1570 strcpy(setup_file_list->value, value);
1572 else if (setup_file_list->next == NULL)
1573 setup_file_list->next = newSetupFileList(token, value);
1575 setTokenValue(setup_file_list->next, token, value);
1579 static void printSetupFileList(struct SetupFileList *setup_file_list)
1581 if (!setup_file_list)
1584 printf("token: '%s'\n", setup_file_list->token);
1585 printf("value: '%s'\n", setup_file_list->value);
1587 printSetupFileList(setup_file_list->next);
1591 struct SetupFileList *loadSetupFileList(char *filename)
1594 char line[MAX_LINE_LEN];
1595 char *token, *value, *line_ptr;
1596 struct SetupFileList *setup_file_list = newSetupFileList("", "");
1597 struct SetupFileList *first_valid_list_entry;
1601 if (!(file = fopen(filename, MODE_READ)))
1603 Error(ERR_WARN, "cannot open configuration file '%s'", filename);
1609 /* read next line of input file */
1610 if (!fgets(line, MAX_LINE_LEN, file))
1613 /* cut trailing comment or whitespace from input line */
1614 for (line_ptr = line; *line_ptr; line_ptr++)
1616 if (*line_ptr == '#' || *line_ptr == '\n' || *line_ptr == '\r')
1623 /* cut trailing whitespaces from input line */
1624 for (line_ptr = &line[strlen(line)]; line_ptr > line; line_ptr--)
1625 if ((*line_ptr == ' ' || *line_ptr == '\t') && line_ptr[1] == '\0')
1628 /* ignore empty lines */
1632 line_len = strlen(line);
1634 /* cut leading whitespaces from token */
1635 for (token = line; *token; token++)
1636 if (*token != ' ' && *token != '\t')
1639 /* find end of token */
1640 for (line_ptr = token; *line_ptr; line_ptr++)
1642 if (*line_ptr == ' ' || *line_ptr == '\t' || *line_ptr == ':')
1649 if (line_ptr < line + line_len)
1650 value = line_ptr + 1;
1654 /* cut leading whitespaces from value */
1655 for (; *value; value++)
1656 if (*value != ' ' && *value != '\t')
1659 if (*token && *value)
1660 setTokenValue(setup_file_list, token, value);
1665 first_valid_list_entry = setup_file_list->next;
1667 /* free empty list header */
1668 setup_file_list->next = NULL;
1669 freeSetupFileList(setup_file_list);
1671 if (first_valid_list_entry == NULL)
1672 Error(ERR_WARN, "configuration file '%s' is empty", filename);
1674 return first_valid_list_entry;
1677 void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list,
1680 if (!setup_file_list)
1683 if (strcmp(setup_file_list->token, TOKEN_STR_FILE_IDENTIFIER) == 0)
1685 if (strcmp(setup_file_list->value, identifier) != 0)
1687 Error(ERR_WARN, "configuration file has wrong version");
1694 if (setup_file_list->next)
1695 checkSetupFileListIdentifier(setup_file_list->next, identifier);
1698 Error(ERR_WARN, "configuration file has no version information");
1704 /* ========================================================================= */
1705 /* functions only needed for non-Unix (non-command-line) systems */
1706 /* ========================================================================= */
1708 #if !defined(PLATFORM_UNIX)
1710 #define ERROR_FILENAME "error.out"
1712 void initErrorFile()
1716 InitUserDataDirectory();
1718 filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1723 FILE *openErrorFile()
1728 filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1729 error_file = fopen(filename, MODE_APPEND);
1735 void dumpErrorFile()
1740 filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1741 error_file = fopen(filename, MODE_READ);
1744 if (error_file != NULL)
1746 while (!feof(error_file))
1747 fputc(fgetc(error_file), stderr);
1755 /* ========================================================================= */
1756 /* the following is only for debugging purpose and normally not used */
1757 /* ========================================================================= */
1759 #define DEBUG_NUM_TIMESTAMPS 3
1761 void debug_print_timestamp(int counter_nr, char *message)
1763 static long counter[DEBUG_NUM_TIMESTAMPS][2];
1765 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
1766 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
1768 counter[counter_nr][0] = Counter();
1771 printf("%s %.2f seconds\n", message,
1772 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
1774 counter[counter_nr][1] = Counter();