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>
24 #if !defined(PLATFORM_WIN32)
26 #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);
115 #if defined(PLATFORM_MSDOS)
116 /* don't use select() to perform waiting operations under DOS
117 environment; always use a busy loop for waiting instead */
118 do_busy_waiting = TRUE;
124 /* we want to wait only a few ms -- if we assume that we have a
125 kernel timer resolution of 10 ms, we would wait far to long;
126 therefore it's better to do a short interval of busy waiting
127 to get our sleeping time more accurate */
129 unsigned long base_counter = Counter(), actual_counter = Counter();
131 while (actual_counter < base_counter + milliseconds_delay &&
132 actual_counter >= base_counter)
133 actual_counter = Counter();
137 #if defined(TARGET_SDL)
138 SDL_Delay(milliseconds_delay);
139 #elif defined(TARGET_ALLEGRO)
140 rest(milliseconds_delay);
142 struct timeval delay;
144 delay.tv_sec = milliseconds_delay / 1000;
145 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
147 if (select(0, NULL, NULL, NULL, &delay) != 0)
148 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
153 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
155 sleep_milliseconds(delay);
158 boolean FrameReached(unsigned long *frame_counter_var,
159 unsigned long frame_delay)
161 unsigned long actual_frame_counter = FrameCounter;
163 if (actual_frame_counter < *frame_counter_var + frame_delay &&
164 actual_frame_counter >= *frame_counter_var)
167 *frame_counter_var = actual_frame_counter;
172 boolean DelayReached(unsigned long *counter_var,
175 unsigned long actual_counter = Counter();
177 if (actual_counter < *counter_var + delay &&
178 actual_counter >= *counter_var)
181 *counter_var = actual_counter;
186 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
188 unsigned long actual_counter;
192 actual_counter = Counter();
194 if (actual_counter < *counter_var + delay &&
195 actual_counter >= *counter_var)
196 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
201 *counter_var = actual_counter;
204 /* int2str() returns a number converted to a string;
205 the used memory is static, but will be overwritten by later calls,
206 so if you want to save the result, copy it to a private string buffer;
207 there can be 10 local calls of int2str() without buffering the result --
208 the 11th call will then destroy the result from the first call and so on.
211 char *int2str(int number, int size)
213 static char shift_array[10][40];
214 static int shift_counter = 0;
215 char *s = shift_array[shift_counter];
217 shift_counter = (shift_counter + 1) % 10;
224 sprintf(s, " %09d", number);
225 return &s[strlen(s) - size];
229 sprintf(s, "%d", number);
234 unsigned int SimpleRND(unsigned int max)
236 #if defined(TARGET_SDL)
237 static unsigned long root = 654321;
238 unsigned long current_ms;
240 current_ms = SDL_GetTicks();
241 root = root * 4253261 + current_ms;
244 static unsigned long root = 654321;
245 struct timeval current_time;
247 gettimeofday(¤t_time, NULL);
248 root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
254 static unsigned int last_RND_value = 0;
256 unsigned int last_RND()
258 return last_RND_value;
262 unsigned int RND(unsigned int max)
265 return (last_RND_value = random_linux_libc() % max);
267 return (random_linux_libc() % max);
271 unsigned int InitRND(long seed)
273 #if defined(TARGET_SDL)
274 unsigned long current_ms;
276 if (seed == NEW_RANDOMIZE)
278 current_ms = SDL_GetTicks();
279 srandom_linux_libc((unsigned int) current_ms);
280 return (unsigned int) current_ms;
284 srandom_linux_libc((unsigned int) seed);
285 return (unsigned int) seed;
288 struct timeval current_time;
290 if (seed == NEW_RANDOMIZE)
292 gettimeofday(¤t_time, NULL);
293 srandom_linux_libc((unsigned int) current_time.tv_usec);
294 return (unsigned int) current_time.tv_usec;
298 srandom_linux_libc((unsigned int) seed);
299 return (unsigned int) seed;
306 #if defined(PLATFORM_WIN32)
307 return ANONYMOUS_NAME;
311 if ((pwd = getpwuid(getuid())) == NULL)
312 return ANONYMOUS_NAME;
320 #if defined(PLATFORM_UNIX)
323 if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0)
324 return ANONYMOUS_NAME;
327 static char real_name[1024];
328 char *from_ptr = pwd->pw_gecos, *to_ptr = real_name;
330 if (strchr(pwd->pw_gecos, 'ß') == NULL)
331 return pwd->pw_gecos;
333 /* the user's real name contains a 'ß' character (german sharp s),
334 which has no equivalent in upper case letters (which our fonts use) */
335 while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2)
337 if (*from_ptr != 'ß')
338 *to_ptr++ = *from_ptr++;
350 #else /* !PLATFORM_UNIX */
351 return ANONYMOUS_NAME;
357 #if defined(PLATFORM_UNIX)
358 static char *home_dir = NULL;
362 if (!(home_dir = getenv("HOME")))
366 if ((pwd = getpwuid(getuid())))
367 home_dir = pwd->pw_dir;
379 char *getPath2(char *path1, char *path2)
381 char *complete_path = checked_malloc(strlen(path1) + 1 +
384 sprintf(complete_path, "%s/%s", path1, path2);
385 return complete_path;
388 char *getPath3(char *path1, char *path2, char *path3)
390 char *complete_path = checked_malloc(strlen(path1) + 1 +
394 sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
395 return complete_path;
398 char *getStringCopy(char *s)
405 s_copy = checked_malloc(strlen(s) + 1);
411 char *getStringToLower(char *s)
413 char *s_copy = checked_malloc(strlen(s) + 1);
414 char *s_ptr = s_copy;
417 *s_ptr++ = tolower(*s++);
423 void GetOptions(char *argv[])
425 char **options_left = &argv[1];
427 /* initialize global program options */
428 options.display_name = NULL;
429 options.server_host = NULL;
430 options.server_port = 0;
431 options.ro_base_directory = RO_BASE_PATH;
432 options.rw_base_directory = RW_BASE_PATH;
433 options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
434 options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY;
435 options.sounds_directory = RO_BASE_PATH "/" SOUNDS_DIRECTORY;
436 options.music_directory = RO_BASE_PATH "/" MUSIC_DIRECTORY;
437 options.serveronly = FALSE;
438 options.network = FALSE;
439 options.verbose = FALSE;
440 options.debug = FALSE;
441 options.debug_command = NULL;
443 while (*options_left)
445 char option_str[MAX_OPTION_LEN];
446 char *option = options_left[0];
447 char *next_option = options_left[1];
448 char *option_arg = NULL;
449 int option_len = strlen(option);
451 if (option_len >= MAX_OPTION_LEN)
452 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
454 strcpy(option_str, option); /* copy argument into buffer */
457 if (strcmp(option, "--") == 0) /* stop scanning arguments */
460 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
463 option_arg = strchr(option, '=');
464 if (option_arg == NULL) /* no '=' in option */
465 option_arg = next_option;
468 *option_arg++ = '\0'; /* cut argument from option */
469 if (*option_arg == '\0') /* no argument after '=' */
470 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
473 option_len = strlen(option);
475 if (strcmp(option, "-") == 0)
476 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
477 else if (strncmp(option, "-help", option_len) == 0)
479 printf("Usage: %s [options] [<server host> [<server port>]]\n"
481 " -d, --display <host>[:<scr>] X server display\n"
482 " -b, --basepath <directory> alternative base directory\n"
483 " -l, --level <directory> alternative level directory\n"
484 " -g, --graphics <directory> alternative graphics directory\n"
485 " -s, --sounds <directory> alternative sounds directory\n"
486 " -m, --music <directory> alternative music directory\n"
487 " -n, --network network multiplayer game\n"
488 " --serveronly only start network server\n"
489 " -v, --verbose verbose mode\n"
490 " --debug display debugging information\n",
491 program.command_basename);
494 printf(" --debug-command <command> execute special command\n");
498 else if (strncmp(option, "-display", option_len) == 0)
500 if (option_arg == NULL)
501 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
503 options.display_name = option_arg;
504 if (option_arg == next_option)
507 else if (strncmp(option, "-basepath", option_len) == 0)
509 if (option_arg == NULL)
510 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
512 /* this should be extended to separate options for ro and rw data */
513 options.ro_base_directory = option_arg;
514 options.rw_base_directory = option_arg;
515 if (option_arg == next_option)
518 /* adjust path for level directory accordingly */
519 options.level_directory =
520 getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
522 else if (strncmp(option, "-levels", option_len) == 0)
524 if (option_arg == NULL)
525 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
527 options.level_directory = option_arg;
528 if (option_arg == next_option)
531 else if (strncmp(option, "-graphics", option_len) == 0)
533 if (option_arg == NULL)
534 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
536 options.graphics_directory = option_arg;
537 if (option_arg == next_option)
540 else if (strncmp(option, "-sounds", option_len) == 0)
542 if (option_arg == NULL)
543 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
545 options.sounds_directory = option_arg;
546 if (option_arg == next_option)
549 else if (strncmp(option, "-music", option_len) == 0)
551 if (option_arg == NULL)
552 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
554 options.music_directory = option_arg;
555 if (option_arg == next_option)
558 else if (strncmp(option, "-network", option_len) == 0)
560 options.network = TRUE;
562 else if (strncmp(option, "-serveronly", option_len) == 0)
564 options.serveronly = TRUE;
566 else if (strncmp(option, "-verbose", option_len) == 0)
568 options.verbose = TRUE;
570 else if (strncmp(option, "-debug", option_len) == 0)
572 options.debug = TRUE;
574 else if (strncmp(option, "-debug-command", option_len) == 0)
576 if (option_arg == NULL)
577 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
579 options.debug_command = option_arg;
580 if (option_arg == next_option)
583 else if (*option == '-')
585 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
587 else if (options.server_host == NULL)
589 options.server_host = *options_left;
591 else if (options.server_port == 0)
593 options.server_port = atoi(*options_left);
594 if (options.server_port < 1024)
595 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
598 Error(ERR_EXIT_HELP, "too many arguments");
604 /* used by SetError() and GetError() to store internal error messages */
605 static char internal_error[1024]; /* this is bad */
607 void SetError(char *format, ...)
611 va_start(ap, format);
612 vsprintf(internal_error, format, ap);
618 return internal_error;
621 void Error(int mode, char *format, ...)
623 char *process_name = "";
624 FILE *error = stderr;
625 char *newline = "\n";
627 /* display warnings only when running in verbose mode */
628 if (mode & ERR_WARN && !options.verbose)
631 #if !defined(PLATFORM_UNIX)
634 if ((error = openErrorFile()) == NULL)
636 printf("Cannot write to error output file!%s", newline);
637 program.exit_function(1);
641 if (mode & ERR_SOUND_SERVER)
642 process_name = " sound server";
643 else if (mode & ERR_NETWORK_SERVER)
644 process_name = " network server";
645 else if (mode & ERR_NETWORK_CLIENT)
646 process_name = " network client **";
652 fprintf(error, "%s%s: ", program.command_basename, process_name);
655 fprintf(error, "warning: ");
657 va_start(ap, format);
658 vfprintf(error, format, ap);
661 fprintf(error, "%s", newline);
665 fprintf(error, "%s: Try option '--help' for more information.%s",
666 program.command_basename, newline);
669 fprintf(error, "%s%s: aborting%s",
670 program.command_basename, process_name, newline);
677 if (mode & ERR_FROM_SERVER)
678 exit(1); /* child process: normal exit */
680 program.exit_function(1); /* main process: clean up stuff */
684 void *checked_malloc(unsigned long size)
691 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
696 void *checked_calloc(unsigned long size)
700 ptr = calloc(1, size);
703 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
708 void *checked_realloc(void *ptr, unsigned long size)
710 ptr = realloc(ptr, size);
713 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
718 inline void swap_numbers(int *i1, int *i2)
726 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
738 short getFile16BitInteger(FILE *file, int byte_order)
740 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
741 return ((fgetc(file) << 8) |
743 else /* BYTE_ORDER_LITTLE_ENDIAN */
744 return ((fgetc(file) << 0) |
748 void putFile16BitInteger(FILE *file, short value, int byte_order)
750 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
752 fputc((value >> 8) & 0xff, file);
753 fputc((value >> 0) & 0xff, file);
755 else /* BYTE_ORDER_LITTLE_ENDIAN */
757 fputc((value >> 0) & 0xff, file);
758 fputc((value >> 8) & 0xff, file);
762 int getFile32BitInteger(FILE *file, int byte_order)
764 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
765 return ((fgetc(file) << 24) |
766 (fgetc(file) << 16) |
769 else /* BYTE_ORDER_LITTLE_ENDIAN */
770 return ((fgetc(file) << 0) |
772 (fgetc(file) << 16) |
773 (fgetc(file) << 24));
776 void putFile32BitInteger(FILE *file, int value, int byte_order)
778 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
780 fputc((value >> 24) & 0xff, file);
781 fputc((value >> 16) & 0xff, file);
782 fputc((value >> 8) & 0xff, file);
783 fputc((value >> 0) & 0xff, file);
785 else /* BYTE_ORDER_LITTLE_ENDIAN */
787 fputc((value >> 0) & 0xff, file);
788 fputc((value >> 8) & 0xff, file);
789 fputc((value >> 16) & 0xff, file);
790 fputc((value >> 24) & 0xff, file);
794 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
797 const int chunk_name_length = 4;
799 /* read chunk name */
800 fgets(chunk_name, chunk_name_length + 1, file);
802 if (chunk_size != NULL)
804 /* read chunk size */
805 *chunk_size = getFile32BitInteger(file, byte_order);
808 return (feof(file) || ferror(file) ? FALSE : TRUE);
811 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
814 /* write chunk name */
815 fputs(chunk_name, file);
819 /* write chunk size */
820 putFile32BitInteger(file, chunk_size, byte_order);
824 int getFileVersion(FILE *file)
826 int version_major, version_minor, version_patch;
828 version_major = fgetc(file);
829 version_minor = fgetc(file);
830 version_patch = fgetc(file);
831 fgetc(file); /* not used */
833 return VERSION_IDENT(version_major, version_minor, version_patch);
836 void putFileVersion(FILE *file, int version)
838 int version_major = VERSION_MAJOR(version);
839 int version_minor = VERSION_MINOR(version);
840 int version_patch = VERSION_PATCH(version);
842 fputc(version_major, file);
843 fputc(version_minor, file);
844 fputc(version_patch, file);
845 fputc(0, file); /* not used */
848 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
850 while (bytes-- && !feof(file))
854 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
861 /* ------------------------------------------------------------------------- */
862 /* functions to translate key identifiers between different format */
863 /* ------------------------------------------------------------------------- */
865 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
866 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
867 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
868 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
870 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
879 /* normal cursor keys */
880 { KSYM_Left, "XK_Left", "cursor left" },
881 { KSYM_Right, "XK_Right", "cursor right" },
882 { KSYM_Up, "XK_Up", "cursor up" },
883 { KSYM_Down, "XK_Down", "cursor down" },
885 /* keypad cursor keys */
887 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
888 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
889 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
890 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
893 /* other keypad keys */
895 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
896 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
897 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
898 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
899 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
900 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
904 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
905 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
906 { KSYM_Control_L, "XK_Control_L", "left control" },
907 { KSYM_Control_R, "XK_Control_R", "right control" },
908 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
909 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
910 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
911 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
912 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
913 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
914 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
915 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
917 /* some special keys */
918 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
919 { KSYM_Delete, "XK_Delete", "delete" },
920 { KSYM_Insert, "XK_Insert", "insert" },
921 { KSYM_Tab, "XK_Tab", "tab" },
922 { KSYM_Home, "XK_Home", "home" },
923 { KSYM_End, "XK_End", "end" },
924 { KSYM_Page_Up, "XK_Page_Up", "page up" },
925 { KSYM_Page_Down, "XK_Page_Down", "page down" },
926 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
928 /* ASCII 0x20 to 0x40 keys (except numbers) */
929 { KSYM_space, "XK_space", "space" },
930 { KSYM_exclam, "XK_exclam", "!" },
931 { KSYM_quotedbl, "XK_quotedbl", "\"" },
932 { KSYM_numbersign, "XK_numbersign", "#" },
933 { KSYM_dollar, "XK_dollar", "$" },
934 { KSYM_percent, "XK_percent", "%" },
935 { KSYM_ampersand, "XK_ampersand", "&" },
936 { KSYM_apostrophe, "XK_apostrophe", "'" },
937 { KSYM_parenleft, "XK_parenleft", "(" },
938 { KSYM_parenright, "XK_parenright", ")" },
939 { KSYM_asterisk, "XK_asterisk", "*" },
940 { KSYM_plus, "XK_plus", "+" },
941 { KSYM_comma, "XK_comma", "," },
942 { KSYM_minus, "XK_minus", "-" },
943 { KSYM_period, "XK_period", "." },
944 { KSYM_slash, "XK_slash", "/" },
945 { KSYM_colon, "XK_colon", ":" },
946 { KSYM_semicolon, "XK_semicolon", ";" },
947 { KSYM_less, "XK_less", "<" },
948 { KSYM_equal, "XK_equal", "=" },
949 { KSYM_greater, "XK_greater", ">" },
950 { KSYM_question, "XK_question", "?" },
951 { KSYM_at, "XK_at", "@" },
953 /* more ASCII keys */
954 { KSYM_bracketleft, "XK_bracketleft", "[" },
955 { KSYM_backslash, "XK_backslash", "backslash" },
956 { KSYM_bracketright,"XK_bracketright", "]" },
957 { KSYM_asciicircum, "XK_asciicircum", "circumflex" },
958 { KSYM_underscore, "XK_underscore", "_" },
959 { KSYM_grave, "XK_grave", "grave" },
960 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
961 { KSYM_braceleft, "XK_braceleft", "brace left" },
962 { KSYM_bar, "XK_bar", "bar" },
963 { KSYM_braceright, "XK_braceright", "brace right" },
964 { KSYM_asciitilde, "XK_asciitilde", "ascii tilde" },
966 /* special (non-ASCII) keys */
967 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
968 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
969 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
970 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
971 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
972 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
973 { KSYM_ssharp, "XK_ssharp", "sharp s" },
975 /* end-of-array identifier */
981 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
983 static char name_buffer[30];
986 if (key >= KSYM_A && key <= KSYM_Z)
987 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
988 else if (key >= KSYM_a && key <= KSYM_z)
989 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
990 else if (key >= KSYM_0 && key <= KSYM_9)
991 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
992 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
993 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
994 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
995 sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
996 else if (key == KSYM_UNDEFINED)
997 strcpy(name_buffer, "(undefined)");
1004 if (key == translate_key[i].key)
1006 strcpy(name_buffer, translate_key[i].name);
1010 while (translate_key[++i].name);
1012 if (!translate_key[i].name)
1013 strcpy(name_buffer, "(unknown)");
1016 *name = name_buffer;
1018 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1020 static char name_buffer[30];
1023 if (key >= KSYM_A && key <= KSYM_Z)
1024 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1025 else if (key >= KSYM_a && key <= KSYM_z)
1026 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1027 else if (key >= KSYM_0 && key <= KSYM_9)
1028 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1029 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1030 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1031 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1032 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1033 else if (key == KSYM_UNDEFINED)
1034 strcpy(name_buffer, "[undefined]");
1041 if (key == translate_key[i].key)
1043 strcpy(name_buffer, translate_key[i].x11name);
1047 while (translate_key[++i].x11name);
1049 if (!translate_key[i].x11name)
1050 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1053 *x11name = name_buffer;
1055 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1057 Key key = KSYM_UNDEFINED;
1062 if (strcmp(translate_key[i].name, *name) == 0)
1064 key = translate_key[i].key;
1068 while (translate_key[++i].x11name);
1070 if (key == KSYM_UNDEFINED)
1071 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1075 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1077 Key key = KSYM_UNDEFINED;
1078 char *name_ptr = *x11name;
1080 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1082 char c = name_ptr[3];
1084 if (c >= 'A' && c <= 'Z')
1085 key = KSYM_A + (Key)(c - 'A');
1086 else if (c >= 'a' && c <= 'z')
1087 key = KSYM_a + (Key)(c - 'a');
1088 else if (c >= '0' && c <= '9')
1089 key = KSYM_0 + (Key)(c - '0');
1091 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1093 char c = name_ptr[6];
1095 if (c >= '0' && c <= '9')
1096 key = KSYM_0 + (Key)(c - '0');
1098 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1100 char c1 = name_ptr[4];
1101 char c2 = name_ptr[5];
1104 if ((c1 >= '0' && c1 <= '9') &&
1105 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1106 d = atoi(&name_ptr[4]);
1108 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1109 key = KSYM_F1 + (Key)(d - 1);
1111 else if (strncmp(name_ptr, "XK_", 3) == 0)
1117 if (strcmp(name_ptr, translate_key[i].x11name) == 0)
1119 key = translate_key[i].key;
1123 while (translate_key[++i].x11name);
1125 else if (strncmp(name_ptr, "0x", 2) == 0)
1127 unsigned long value = 0;
1133 char c = *name_ptr++;
1136 if (c >= '0' && c <= '9')
1138 else if (c >= 'a' && c <= 'f')
1139 d = (int)(c - 'a' + 10);
1140 else if (c >= 'A' && c <= 'F')
1141 d = (int)(c - 'A' + 10);
1149 value = value * 16 + d;
1160 char *getKeyNameFromKey(Key key)
1164 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1168 char *getX11KeyNameFromKey(Key key)
1172 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1176 Key getKeyFromKeyName(char *name)
1180 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1184 Key getKeyFromX11KeyName(char *x11name)
1188 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1192 char getCharFromKey(Key key)
1194 char *keyname = getKeyNameFromKey(key);
1197 if (strlen(keyname) == 1)
1198 letter = keyname[0];
1199 else if (strcmp(keyname, "space") == 0)
1201 else if (strcmp(keyname, "circumflex") == 0)
1208 /* ========================================================================= */
1209 /* functions for checking filenames */
1210 /* ========================================================================= */
1212 boolean FileIsGraphic(char *filename)
1214 if (strlen(filename) > 4 &&
1215 strcmp(&filename[strlen(filename) - 4], ".pcx") == 0)
1221 boolean FileIsSound(char *basename)
1223 if (strlen(basename) > 4 &&
1224 strcmp(&basename[strlen(basename) - 4], ".wav") == 0)
1230 boolean FileIsMusic(char *basename)
1232 /* "music" can be a WAV (loop) file or (if compiled with SDL) a MOD file */
1234 if (FileIsSound(basename))
1237 #if defined(TARGET_SDL)
1238 if (strlen(basename) > 4 &&
1239 (strcmp(&basename[strlen(basename) - 4], ".mod") == 0 ||
1240 strcmp(&basename[strlen(basename) - 4], ".MOD") == 0 ||
1241 strncmp(basename, "mod.", 4) == 0 ||
1242 strncmp(basename, "MOD.", 4) == 0))
1249 boolean FileIsArtworkType(char *basename, int type)
1251 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1252 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1253 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1260 /* ========================================================================= */
1261 /* functions only needed for non-Unix (non-command-line) systems */
1262 /* ========================================================================= */
1264 #if !defined(PLATFORM_UNIX)
1266 #define ERROR_FILENAME "error.out"
1268 void initErrorFile()
1272 InitUserDataDirectory();
1274 filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1279 FILE *openErrorFile()
1284 filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1285 error_file = fopen(filename, MODE_APPEND);
1291 void dumpErrorFile()
1296 filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1297 error_file = fopen(filename, MODE_READ);
1300 if (error_file != NULL)
1302 while (!feof(error_file))
1303 fputc(fgetc(error_file), stderr);
1311 /* ========================================================================= */
1312 /* the following is only for debugging purpose and normally not used */
1313 /* ========================================================================= */
1315 #define DEBUG_NUM_TIMESTAMPS 3
1317 void debug_print_timestamp(int counter_nr, char *message)
1319 static long counter[DEBUG_NUM_TIMESTAMPS][2];
1321 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
1322 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
1324 counter[counter_nr][0] = Counter();
1327 printf("%s %.2f seconds\n", message,
1328 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
1330 counter[counter_nr][1] = Counter();