1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2006 Artsoft Entertainment *
5 * Holger Schemel *
6 * Detmolder Strasse 189 *
7 * 33604 Bielefeld *
8 * Germany *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
11 * misc.c *
12 ***********************************************************/
13
14 #include <time.h>
15 #include <sys/time.h>
16 #include <sys/types.h>
17 #include <sys/stat.h>
18 #include <stdarg.h>
19 #include <ctype.h>
20 #include <string.h>
21 #include <unistd.h>
22
23 #include "platform.h"
24
25 #if !defined(PLATFORM_WIN32)
26 #include <pwd.h>
27 #include <sys/param.h>
28 #endif
29
30 #include "misc.h"
31 #include "setup.h"
32 #include "random.h"
33 #include "text.h"
34 #include "image.h"
35
36
37 /* ========================================================================= */
38 /* some generic helper functions */
39 /* ========================================================================= */
40
41 /* ------------------------------------------------------------------------- */
42 /* platform independent wrappers for printf() et al. (newline aware) */
43 /* ------------------------------------------------------------------------- */
44
vfprintf_newline(FILE * stream,char * format,va_list ap)45 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
46 {
47 char *newline = STRING_NEWLINE;
48
49 vfprintf(stream, format, ap);
50
51 fprintf(stream, "%s", newline);
52 }
53
fprintf_newline(FILE * stream,char * format,...)54 static void fprintf_newline(FILE *stream, char *format, ...)
55 {
56 if (format)
57 {
58 va_list ap;
59
60 va_start(ap, format);
61 vfprintf_newline(stream, format, ap);
62 va_end(ap);
63 }
64 }
65
fprintf_line(FILE * stream,char * line_chars,int line_length)66 void fprintf_line(FILE *stream, char *line_chars, int line_length)
67 {
68 int i;
69
70 for (i = 0; i < line_length; i++)
71 fprintf(stream, "%s", line_chars);
72
73 fprintf_newline(stream, "");
74 }
75
printf_line(char * line_chars,int line_length)76 void printf_line(char *line_chars, int line_length)
77 {
78 fprintf_line(stdout, line_chars, line_length);
79 }
80
printf_line_with_prefix(char * prefix,char * line_chars,int line_length)81 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
82 {
83 fprintf(stdout, "%s", prefix);
84 fprintf_line(stdout, line_chars, line_length);
85 }
86
87
88 /* ------------------------------------------------------------------------- */
89 /* string functions */
90 /* ------------------------------------------------------------------------- */
91
92 /* int2str() returns a number converted to a string;
93 the used memory is static, but will be overwritten by later calls,
94 so if you want to save the result, copy it to a private string buffer;
95 there can be 10 local calls of int2str() without buffering the result --
96 the 11th call will then destroy the result from the first call and so on.
97 */
98
int2str(int number,int size)99 char *int2str(int number, int size)
100 {
101 static char shift_array[10][40];
102 static int shift_counter = 0;
103 char *s = shift_array[shift_counter];
104
105 shift_counter = (shift_counter + 1) % 10;
106
107 if (size > 20)
108 size = 20;
109
110 if (size > 0)
111 {
112 sprintf(s, " %09d", number);
113 return &s[strlen(s) - size];
114 }
115 else
116 {
117 sprintf(s, "%d", number);
118 return s;
119 }
120 }
121
122
123 /* something similar to "int2str()" above, but allocates its own memory
124 and has a different interface; we cannot use "itoa()", because this
125 seems to be already defined when cross-compiling to the win32 target */
126
i_to_a(unsigned int i)127 char *i_to_a(unsigned int i)
128 {
129 static char *a = NULL;
130
131 checked_free(a);
132
133 if (i > 2147483647) /* yes, this is a kludge */
134 i = 2147483647;
135
136 a = checked_malloc(10 + 1);
137
138 sprintf(a, "%d", i);
139
140 return a;
141 }
142
143
144 /* calculate base-2 logarithm of argument (rounded down to integer;
145 this function returns the number of the highest bit set in argument) */
146
log_2(unsigned int x)147 int log_2(unsigned int x)
148 {
149 int e = 0;
150
151 while ((1 << e) < x)
152 {
153 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
154 e++;
155 }
156
157 return e;
158 }
159
getTokenValueFromString(char * string,char ** token,char ** value)160 boolean getTokenValueFromString(char *string, char **token, char **value)
161 {
162 return getTokenValueFromSetupLine(string, token, value);
163 }
164
165
166 /* ------------------------------------------------------------------------- */
167 /* counter functions */
168 /* ------------------------------------------------------------------------- */
169
170 #if defined(PLATFORM_MSDOS)
171 volatile unsigned int counter = 0;
172
increment_counter()173 void increment_counter()
174 {
175 counter++;
176 }
177
178 END_OF_FUNCTION(increment_counter);
179 #endif
180
181
182 /* maximal allowed length of a command line option */
183 #define MAX_OPTION_LEN 256
184
185 #if 1
186
187 #ifdef TARGET_SDL
getCurrentMS()188 static unsigned int getCurrentMS()
189 {
190 return SDL_GetTicks();
191 }
192
193 #else /* !TARGET_SDL */
194
195 #if defined(PLATFORM_UNIX)
getCurrentMS()196 static unsigned int getCurrentMS()
197 {
198 struct timeval current_time;
199
200 gettimeofday(¤t_time, NULL);
201
202 return current_time.tv_sec * 1000 + current_time.tv_usec / 1000;
203 }
204 #endif /* PLATFORM_UNIX */
205 #endif /* !TARGET_SDL */
206
mainCounter(int mode)207 static unsigned int mainCounter(int mode)
208 {
209 static unsigned int base_ms = 0;
210 unsigned int current_ms;
211
212 /* get current system milliseconds */
213 current_ms = getCurrentMS();
214
215 /* reset base timestamp in case of counter reset or wrap-around */
216 if (mode == INIT_COUNTER || current_ms < base_ms)
217 base_ms = current_ms;
218
219 /* return milliseconds since last counter reset */
220 return current_ms - base_ms;
221 }
222
223 #else
224
225 #ifdef TARGET_SDL
mainCounter(int mode)226 static unsigned int mainCounter(int mode)
227 {
228 static unsigned int base_ms = 0;
229 unsigned int current_ms;
230 unsigned int counter_ms;
231
232 current_ms = SDL_GetTicks();
233
234 /* reset base time in case of counter initializing or wrap-around */
235 if (mode == INIT_COUNTER || current_ms < base_ms)
236 base_ms = current_ms;
237
238 counter_ms = current_ms - base_ms;
239
240 return counter_ms; /* return milliseconds since last init */
241 }
242
243 #else /* !TARGET_SDL */
244
245 #if defined(PLATFORM_UNIX)
mainCounter(int mode)246 static unsigned int mainCounter(int mode)
247 {
248 static struct timeval base_time = { 0, 0 };
249 struct timeval current_time;
250 unsigned int counter_ms;
251
252 gettimeofday(¤t_time, NULL);
253
254 /* reset base time in case of counter initializing or wrap-around */
255 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
256 base_time = current_time;
257
258 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
259 + (current_time.tv_usec - base_time.tv_usec) / 1000;
260
261 return counter_ms; /* return milliseconds since last init */
262 }
263 #endif /* PLATFORM_UNIX */
264 #endif /* !TARGET_SDL */
265
266 #endif
267
InitCounter()268 void InitCounter() /* set counter back to zero */
269 {
270 #if !defined(PLATFORM_MSDOS)
271 mainCounter(INIT_COUNTER);
272 #else
273 LOCK_VARIABLE(counter);
274 LOCK_FUNCTION(increment_counter);
275 install_int_ex(increment_counter, BPS_TO_TIMER(100));
276 #endif
277 }
278
Counter()279 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
280 {
281 #if !defined(PLATFORM_MSDOS)
282 return mainCounter(READ_COUNTER);
283 #else
284 return (counter * 10);
285 #endif
286 }
287
sleep_milliseconds(unsigned int milliseconds_delay)288 static void sleep_milliseconds(unsigned int milliseconds_delay)
289 {
290 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
291
292 if (do_busy_waiting)
293 {
294 /* we want to wait only a few ms -- if we assume that we have a
295 kernel timer resolution of 10 ms, we would wait far to long;
296 therefore it's better to do a short interval of busy waiting
297 to get our sleeping time more accurate */
298
299 unsigned int base_counter = Counter(), actual_counter = Counter();
300
301 while (actual_counter < base_counter + milliseconds_delay &&
302 actual_counter >= base_counter)
303 actual_counter = Counter();
304 }
305 else
306 {
307 #if defined(TARGET_SDL)
308 SDL_Delay(milliseconds_delay);
309 #elif defined(TARGET_ALLEGRO)
310 rest(milliseconds_delay);
311 #else
312 struct timeval delay;
313
314 delay.tv_sec = milliseconds_delay / 1000;
315 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
316
317 if (select(0, NULL, NULL, NULL, &delay) != 0)
318 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
319 #endif
320 }
321 }
322
Delay(unsigned int delay)323 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
324 {
325 sleep_milliseconds(delay);
326 }
327
FrameReached(unsigned int * frame_counter_var,unsigned int frame_delay)328 boolean FrameReached(unsigned int *frame_counter_var,
329 unsigned int frame_delay)
330 {
331 unsigned int actual_frame_counter = FrameCounter;
332
333 if (actual_frame_counter >= *frame_counter_var &&
334 actual_frame_counter < *frame_counter_var + frame_delay)
335 return FALSE;
336
337 *frame_counter_var = actual_frame_counter;
338
339 return TRUE;
340 }
341
DelayReached(unsigned int * counter_var,unsigned int delay)342 boolean DelayReached(unsigned int *counter_var,
343 unsigned int delay)
344 {
345 unsigned int actual_counter = Counter();
346
347 if (actual_counter >= *counter_var &&
348 actual_counter < *counter_var + delay)
349 return FALSE;
350
351 *counter_var = actual_counter;
352
353 return TRUE;
354 }
355
WaitUntilDelayReached(unsigned int * counter_var,unsigned int delay)356 void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
357 {
358 unsigned int actual_counter;
359
360 while (1)
361 {
362 actual_counter = Counter();
363
364 if (actual_counter >= *counter_var &&
365 actual_counter < *counter_var + delay)
366 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
367 else
368 break;
369 }
370
371 *counter_var = actual_counter;
372 }
373
374
375 /* ------------------------------------------------------------------------- */
376 /* random generator functions */
377 /* ------------------------------------------------------------------------- */
378
init_random_number(int nr,int seed)379 unsigned int init_random_number(int nr, int seed)
380 {
381 if (seed == NEW_RANDOMIZE)
382 {
383 /* default random seed */
384 seed = (int)time(NULL); // seconds since the epoch
385
386 #if !defined(PLATFORM_WIN32)
387 /* add some more randomness */
388 struct timeval current_time;
389
390 gettimeofday(¤t_time, NULL);
391
392 seed += (int)current_time.tv_usec; // microseconds since the epoch
393 #endif
394
395 #if defined(TARGET_SDL)
396 /* add some more randomness */
397 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
398 #endif
399
400 #if 1
401 /* add some more randomness */
402 seed += GetSimpleRandom(1000000);
403 #endif
404 }
405
406 srandom_linux_libc(nr, (unsigned int) seed);
407
408 return (unsigned int) seed;
409 }
410
get_random_number(int nr,int max)411 unsigned int get_random_number(int nr, int max)
412 {
413 return (max > 0 ? random_linux_libc(nr) % max : 0);
414 }
415
416
417 /* ------------------------------------------------------------------------- */
418 /* system info functions */
419 /* ------------------------------------------------------------------------- */
420
421 #if !defined(PLATFORM_MSDOS)
get_corrected_real_name(char * real_name)422 static char *get_corrected_real_name(char *real_name)
423 {
424 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
425 char *from_ptr = real_name;
426 char *to_ptr = real_name_new;
427
428 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
429 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
430 {
431 /* the name field read from "passwd" file may also contain additional
432 user information, separated by commas, which will be removed here */
433 if (*from_ptr == ',')
434 break;
435
436 /* the user's real name may contain '�' characters (german sharp s),
437 which have no equivalent in upper case letters (used by our fonts) */
438 if (*from_ptr == '�')
439 {
440 from_ptr++;
441 *to_ptr++ = 's';
442 *to_ptr++ = 's';
443 }
444 else
445 *to_ptr++ = *from_ptr++;
446 }
447
448 *to_ptr = '\0';
449
450 return real_name_new;
451 }
452 #endif
453
getLoginName()454 char *getLoginName()
455 {
456 static char *login_name = NULL;
457
458 #if defined(PLATFORM_WIN32)
459 if (login_name == NULL)
460 {
461 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
462 login_name = checked_malloc(buffer_size);
463
464 if (GetUserName(login_name, &buffer_size) == 0)
465 strcpy(login_name, ANONYMOUS_NAME);
466 }
467 #else
468 if (login_name == NULL)
469 {
470 struct passwd *pwd;
471
472 if ((pwd = getpwuid(getuid())) == NULL)
473 login_name = ANONYMOUS_NAME;
474 else
475 login_name = getStringCopy(pwd->pw_name);
476 }
477 #endif
478
479 return login_name;
480 }
481
getRealName()482 char *getRealName()
483 {
484 static char *real_name = NULL;
485
486 #if defined(PLATFORM_WIN32)
487 if (real_name == NULL)
488 {
489 static char buffer[MAX_USERNAME_LEN + 1];
490 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
491
492 if (GetUserName(buffer, &buffer_size) != 0)
493 real_name = get_corrected_real_name(buffer);
494 else
495 real_name = ANONYMOUS_NAME;
496 }
497 #elif defined(PLATFORM_UNIX)
498 if (real_name == NULL)
499 {
500 struct passwd *pwd;
501
502 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
503 real_name = get_corrected_real_name(pwd->pw_gecos);
504 else
505 real_name = ANONYMOUS_NAME;
506 }
507 #else
508 real_name = ANONYMOUS_NAME;
509 #endif
510
511 return real_name;
512 }
513
getFileTimestampEpochSeconds(char * filename)514 time_t getFileTimestampEpochSeconds(char *filename)
515 {
516 struct stat file_status;
517
518 if (stat(filename, &file_status) != 0) /* cannot stat file */
519 return 0;
520
521 return file_status.st_mtime;
522 }
523
524
525 /* ------------------------------------------------------------------------- */
526 /* path manipulation functions */
527 /* ------------------------------------------------------------------------- */
528
getLastPathSeparatorPtr(char * filename)529 static char *getLastPathSeparatorPtr(char *filename)
530 {
531 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
532
533 if (last_separator == NULL) /* also try DOS/Windows variant */
534 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
535
536 return last_separator;
537 }
538
getBaseNamePtr(char * filename)539 char *getBaseNamePtr(char *filename)
540 {
541 char *last_separator = getLastPathSeparatorPtr(filename);
542
543 if (last_separator != NULL)
544 return last_separator + 1; /* separator found: strip base path */
545 else
546 return filename; /* no separator found: filename has no path */
547 }
548
getBaseName(char * filename)549 char *getBaseName(char *filename)
550 {
551 return getStringCopy(getBaseNamePtr(filename));
552 }
553
getBasePath(char * filename)554 char *getBasePath(char *filename)
555 {
556 char *basepath = getStringCopy(filename);
557 char *last_separator = getLastPathSeparatorPtr(basepath);
558
559 if (last_separator != NULL)
560 *last_separator = '\0'; /* separator found: strip basename */
561 else
562 basepath = "."; /* no separator found: use current path */
563
564 return basepath;
565 }
566
567
568 /* ------------------------------------------------------------------------- */
569 /* various string functions */
570 /* ------------------------------------------------------------------------- */
571
getStringCat2WithSeparator(char * s1,char * s2,char * sep)572 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
573 {
574 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
575 strlen(s2) + 1);
576
577 sprintf(complete_string, "%s%s%s", s1, sep, s2);
578
579 return complete_string;
580 }
581
getStringCat3WithSeparator(char * s1,char * s2,char * s3,char * sep)582 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
583 {
584 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
585 strlen(s2) + strlen(sep) +
586 strlen(s3) + 1);
587
588 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
589
590 return complete_string;
591 }
592
getStringCat2(char * s1,char * s2)593 char *getStringCat2(char *s1, char *s2)
594 {
595 return getStringCat2WithSeparator(s1, s2, "");
596 }
597
getStringCat3(char * s1,char * s2,char * s3)598 char *getStringCat3(char *s1, char *s2, char *s3)
599 {
600 return getStringCat3WithSeparator(s1, s2, s3, "");
601 }
602
getPath2(char * path1,char * path2)603 char *getPath2(char *path1, char *path2)
604 {
605 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
606 }
607
getPath3(char * path1,char * path2,char * path3)608 char *getPath3(char *path1, char *path2, char *path3)
609 {
610 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
611 }
612
getStringCopy(char * s)613 char *getStringCopy(char *s)
614 {
615 char *s_copy;
616
617 if (s == NULL)
618 return NULL;
619
620 s_copy = checked_malloc(strlen(s) + 1);
621 strcpy(s_copy, s);
622
623 return s_copy;
624 }
625
getStringCopyN(char * s,int n)626 char *getStringCopyN(char *s, int n)
627 {
628 char *s_copy;
629 int s_len = MAX(0, n);
630
631 if (s == NULL)
632 return NULL;
633
634 s_copy = checked_malloc(s_len + 1);
635 strncpy(s_copy, s, s_len);
636 s_copy[s_len] = '\0';
637
638 return s_copy;
639 }
640
getStringToLower(char * s)641 char *getStringToLower(char *s)
642 {
643 char *s_copy = checked_malloc(strlen(s) + 1);
644 char *s_ptr = s_copy;
645
646 while (*s)
647 *s_ptr++ = tolower(*s++);
648 *s_ptr = '\0';
649
650 return s_copy;
651 }
652
setString(char ** old_value,char * new_value)653 void setString(char **old_value, char *new_value)
654 {
655 checked_free(*old_value);
656
657 *old_value = getStringCopy(new_value);
658 }
659
strEqual(char * s1,char * s2)660 boolean strEqual(char *s1, char *s2)
661 {
662 return (s1 == NULL && s2 == NULL ? TRUE :
663 s1 == NULL && s2 != NULL ? FALSE :
664 s1 != NULL && s2 == NULL ? FALSE :
665 strcmp(s1, s2) == 0);
666 }
667
strEqualN(char * s1,char * s2,int n)668 boolean strEqualN(char *s1, char *s2, int n)
669 {
670 return (s1 == NULL && s2 == NULL ? TRUE :
671 s1 == NULL && s2 != NULL ? FALSE :
672 s1 != NULL && s2 == NULL ? FALSE :
673 strncmp(s1, s2, n) == 0);
674 }
675
strPrefix(char * s,char * prefix)676 boolean strPrefix(char *s, char *prefix)
677 {
678 return (s == NULL && prefix == NULL ? TRUE :
679 s == NULL && prefix != NULL ? FALSE :
680 s != NULL && prefix == NULL ? FALSE :
681 strncmp(s, prefix, strlen(prefix)) == 0);
682 }
683
strSuffix(char * s,char * suffix)684 boolean strSuffix(char *s, char *suffix)
685 {
686 return (s == NULL && suffix == NULL ? TRUE :
687 s == NULL && suffix != NULL ? FALSE :
688 s != NULL && suffix == NULL ? FALSE :
689 strlen(s) < strlen(suffix) ? FALSE :
690 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
691 }
692
strPrefixLower(char * s,char * prefix)693 boolean strPrefixLower(char *s, char *prefix)
694 {
695 char *s_lower = getStringToLower(s);
696 boolean match = strPrefix(s_lower, prefix);
697
698 free(s_lower);
699
700 return match;
701 }
702
strSuffixLower(char * s,char * suffix)703 boolean strSuffixLower(char *s, char *suffix)
704 {
705 char *s_lower = getStringToLower(s);
706 boolean match = strSuffix(s_lower, suffix);
707
708 free(s_lower);
709
710 return match;
711 }
712
713
714 /* ------------------------------------------------------------------------- */
715 /* command line option handling functions */
716 /* ------------------------------------------------------------------------- */
717
GetOptions(char * argv[],void (* print_usage_function)(void))718 void GetOptions(char *argv[], void (*print_usage_function)(void))
719 {
720 char *ro_base_path = RO_BASE_PATH;
721 char *rw_base_path = RW_BASE_PATH;
722 char **options_left = &argv[1];
723
724 #if !defined(PLATFORM_MACOSX)
725 /* if the program is configured to start from current directory (default),
726 determine program package directory (KDE/Konqueror does not do this by
727 itself and fails otherwise); on Mac OS X, the program binary is stored
728 in an application package directory -- do not try to use this directory
729 as the program data directory (Mac OS X handles this correctly anyway) */
730
731 if (strEqual(ro_base_path, "."))
732 ro_base_path = program.command_basepath;
733 if (strEqual(rw_base_path, "."))
734 rw_base_path = program.command_basepath;
735 #endif
736
737 /* initialize global program options */
738 options.display_name = NULL;
739 options.server_host = NULL;
740 options.server_port = 0;
741
742 options.ro_base_directory = ro_base_path;
743 options.rw_base_directory = rw_base_path;
744 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
745 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
746 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
747 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
748 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
749
750 options.execute_command = NULL;
751 options.special_flags = NULL;
752
753 options.serveronly = FALSE;
754 options.network = FALSE;
755 options.verbose = FALSE;
756 options.debug = FALSE;
757 options.debug_x11_sync = FALSE;
758
759 #if !defined(PLATFORM_UNIX)
760 if (*options_left == NULL) /* no options given -- enable verbose mode */
761 options.verbose = TRUE;
762 #endif
763
764 while (*options_left)
765 {
766 char option_str[MAX_OPTION_LEN];
767 char *option = options_left[0];
768 char *next_option = options_left[1];
769 char *option_arg = NULL;
770 int option_len = strlen(option);
771
772 if (option_len >= MAX_OPTION_LEN)
773 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
774
775 strcpy(option_str, option); /* copy argument into buffer */
776 option = option_str;
777
778 if (strEqual(option, "--")) /* stop scanning arguments */
779 break;
780
781 if (strPrefix(option, "--")) /* treat '--' like '-' */
782 option++;
783
784 option_arg = strchr(option, '=');
785 if (option_arg == NULL) /* no '=' in option */
786 option_arg = next_option;
787 else
788 {
789 *option_arg++ = '\0'; /* cut argument from option */
790 if (*option_arg == '\0') /* no argument after '=' */
791 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
792 }
793
794 option_len = strlen(option);
795
796 if (strEqual(option, "-"))
797 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
798 else if (strncmp(option, "-help", option_len) == 0)
799 {
800 print_usage_function();
801
802 exit(0);
803 }
804 else if (strncmp(option, "-display", option_len) == 0)
805 {
806 if (option_arg == NULL)
807 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
808
809 options.display_name = option_arg;
810 if (option_arg == next_option)
811 options_left++;
812 }
813 else if (strncmp(option, "-basepath", option_len) == 0)
814 {
815 if (option_arg == NULL)
816 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
817
818 /* this should be extended to separate options for ro and rw data */
819 options.ro_base_directory = ro_base_path = option_arg;
820 options.rw_base_directory = rw_base_path = option_arg;
821 if (option_arg == next_option)
822 options_left++;
823
824 /* adjust paths for sub-directories in base directory accordingly */
825 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
826 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
827 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
828 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
829 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
830 }
831 else if (strncmp(option, "-levels", option_len) == 0)
832 {
833 if (option_arg == NULL)
834 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
835
836 options.level_directory = option_arg;
837 if (option_arg == next_option)
838 options_left++;
839 }
840 else if (strncmp(option, "-graphics", option_len) == 0)
841 {
842 if (option_arg == NULL)
843 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
844
845 options.graphics_directory = option_arg;
846 if (option_arg == next_option)
847 options_left++;
848 }
849 else if (strncmp(option, "-sounds", option_len) == 0)
850 {
851 if (option_arg == NULL)
852 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
853
854 options.sounds_directory = option_arg;
855 if (option_arg == next_option)
856 options_left++;
857 }
858 else if (strncmp(option, "-music", option_len) == 0)
859 {
860 if (option_arg == NULL)
861 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
862
863 options.music_directory = option_arg;
864 if (option_arg == next_option)
865 options_left++;
866 }
867 else if (strncmp(option, "-network", option_len) == 0)
868 {
869 options.network = TRUE;
870 }
871 else if (strncmp(option, "-serveronly", option_len) == 0)
872 {
873 options.serveronly = TRUE;
874 }
875 else if (strncmp(option, "-verbose", option_len) == 0)
876 {
877 options.verbose = TRUE;
878 }
879 else if (strncmp(option, "-debug", option_len) == 0)
880 {
881 options.debug = TRUE;
882 }
883 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
884 {
885 options.debug_x11_sync = TRUE;
886 }
887 else if (strPrefix(option, "-D"))
888 {
889 #if 1
890 options.special_flags = getStringCopy(&option[2]);
891 #else
892 char *flags_string = &option[2];
893 unsigned int flags_value;
894
895 if (*flags_string == '\0')
896 Error(ERR_EXIT_HELP, "empty flag ignored");
897
898 flags_value = get_special_flags_function(flags_string);
899
900 if (flags_value == 0)
901 Error(ERR_EXIT_HELP, "unknown flag '%s'", flags_string);
902
903 options.special_flags |= flags_value;
904 #endif
905 }
906 else if (strncmp(option, "-execute", option_len) == 0)
907 {
908 if (option_arg == NULL)
909 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
910
911 options.execute_command = option_arg;
912 if (option_arg == next_option)
913 options_left++;
914
915 /* when doing batch processing, always enable verbose mode (warnings) */
916 options.verbose = TRUE;
917 }
918 else if (*option == '-')
919 {
920 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
921 }
922 else if (options.server_host == NULL)
923 {
924 options.server_host = *options_left;
925 }
926 else if (options.server_port == 0)
927 {
928 options.server_port = atoi(*options_left);
929 if (options.server_port < 1024)
930 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
931 }
932 else
933 Error(ERR_EXIT_HELP, "too many arguments");
934
935 options_left++;
936 }
937 }
938
939
940 /* ------------------------------------------------------------------------- */
941 /* error handling functions */
942 /* ------------------------------------------------------------------------- */
943
944 /* used by SetError() and GetError() to store internal error messages */
945 static char internal_error[1024]; /* this is bad */
946
SetError(char * format,...)947 void SetError(char *format, ...)
948 {
949 va_list ap;
950
951 va_start(ap, format);
952 vsprintf(internal_error, format, ap);
953 va_end(ap);
954 }
955
GetError()956 char *GetError()
957 {
958 return internal_error;
959 }
960
Error(int mode,char * format,...)961 void Error(int mode, char *format, ...)
962 {
963 static boolean last_line_was_separator = FALSE;
964 char *process_name = "";
965
966 /* display warnings only when running in verbose mode */
967 if (mode & ERR_WARN && !options.verbose)
968 return;
969
970 if (mode == ERR_INFO_LINE)
971 {
972 if (!last_line_was_separator)
973 fprintf_line(program.error_file, format, 79);
974
975 last_line_was_separator = TRUE;
976
977 return;
978 }
979
980 last_line_was_separator = FALSE;
981
982 if (mode & ERR_SOUND_SERVER)
983 process_name = " sound server";
984 else if (mode & ERR_NETWORK_SERVER)
985 process_name = " network server";
986 else if (mode & ERR_NETWORK_CLIENT)
987 process_name = " network client **";
988
989 if (format)
990 {
991 va_list ap;
992
993 fprintf(program.error_file, "%s%s: ", program.command_basename,
994 process_name);
995
996 if (mode & ERR_WARN)
997 fprintf(program.error_file, "warning: ");
998
999 va_start(ap, format);
1000 vfprintf_newline(program.error_file, format, ap);
1001 va_end(ap);
1002 }
1003
1004 if (mode & ERR_HELP)
1005 fprintf_newline(program.error_file,
1006 "%s: Try option '--help' for more information.",
1007 program.command_basename);
1008
1009 if (mode & ERR_EXIT)
1010 fprintf_newline(program.error_file, "%s%s: aborting",
1011 program.command_basename, process_name);
1012
1013 if (mode & ERR_EXIT)
1014 {
1015 if (mode & ERR_FROM_SERVER)
1016 exit(1); /* child process: normal exit */
1017 else
1018 program.exit_function(1); /* main process: clean up stuff */
1019 }
1020 }
1021
1022
1023 /* ------------------------------------------------------------------------- */
1024 /* checked memory allocation and freeing functions */
1025 /* ------------------------------------------------------------------------- */
1026
checked_malloc(unsigned int size)1027 void *checked_malloc(unsigned int size)
1028 {
1029 void *ptr;
1030
1031 ptr = malloc(size);
1032
1033 if (ptr == NULL)
1034 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1035
1036 return ptr;
1037 }
1038
checked_calloc(unsigned int size)1039 void *checked_calloc(unsigned int size)
1040 {
1041 void *ptr;
1042
1043 ptr = calloc(1, size);
1044
1045 if (ptr == NULL)
1046 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1047
1048 return ptr;
1049 }
1050
checked_realloc(void * ptr,unsigned int size)1051 void *checked_realloc(void *ptr, unsigned int size)
1052 {
1053 ptr = realloc(ptr, size);
1054
1055 if (ptr == NULL)
1056 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1057
1058 return ptr;
1059 }
1060
checked_free(void * ptr)1061 void checked_free(void *ptr)
1062 {
1063 if (ptr != NULL) /* this check should be done by free() anyway */
1064 free(ptr);
1065 }
1066
clear_mem(void * ptr,unsigned int size)1067 void clear_mem(void *ptr, unsigned int size)
1068 {
1069 #if defined(PLATFORM_WIN32)
1070 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1071 char *cptr = (char *)ptr;
1072
1073 while (size--)
1074 *cptr++ = 0;
1075 #else
1076 memset(ptr, 0, size);
1077 #endif
1078 }
1079
1080
1081 /* ------------------------------------------------------------------------- */
1082 /* various helper functions */
1083 /* ------------------------------------------------------------------------- */
1084
swap_numbers(int * i1,int * i2)1085 inline void swap_numbers(int *i1, int *i2)
1086 {
1087 int help = *i1;
1088
1089 *i1 = *i2;
1090 *i2 = help;
1091 }
1092
swap_number_pairs(int * x1,int * y1,int * x2,int * y2)1093 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1094 {
1095 int help_x = *x1;
1096 int help_y = *y1;
1097
1098 *x1 = *x2;
1099 *x2 = help_x;
1100
1101 *y1 = *y2;
1102 *y2 = help_y;
1103 }
1104
1105 /* the "put" variants of the following file access functions check for the file
1106 pointer being != NULL and return the number of bytes they have or would have
1107 written; this allows for chunk writing functions to first determine the size
1108 of the (not yet written) chunk, write the correct chunk size and finally
1109 write the chunk itself */
1110
getFile8BitInteger(FILE * file)1111 int getFile8BitInteger(FILE *file)
1112 {
1113 return fgetc(file);
1114 }
1115
putFile8BitInteger(FILE * file,int value)1116 int putFile8BitInteger(FILE *file, int value)
1117 {
1118 if (file != NULL)
1119 fputc(value, file);
1120
1121 return 1;
1122 }
1123
getFile16BitInteger(FILE * file,int byte_order)1124 int getFile16BitInteger(FILE *file, int byte_order)
1125 {
1126 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1127 return ((fgetc(file) << 8) |
1128 (fgetc(file) << 0));
1129 else /* BYTE_ORDER_LITTLE_ENDIAN */
1130 return ((fgetc(file) << 0) |
1131 (fgetc(file) << 8));
1132 }
1133
putFile16BitInteger(FILE * file,int value,int byte_order)1134 int putFile16BitInteger(FILE *file, int value, int byte_order)
1135 {
1136 if (file != NULL)
1137 {
1138 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1139 {
1140 fputc((value >> 8) & 0xff, file);
1141 fputc((value >> 0) & 0xff, file);
1142 }
1143 else /* BYTE_ORDER_LITTLE_ENDIAN */
1144 {
1145 fputc((value >> 0) & 0xff, file);
1146 fputc((value >> 8) & 0xff, file);
1147 }
1148 }
1149
1150 return 2;
1151 }
1152
getFile32BitInteger(FILE * file,int byte_order)1153 int getFile32BitInteger(FILE *file, int byte_order)
1154 {
1155 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1156 return ((fgetc(file) << 24) |
1157 (fgetc(file) << 16) |
1158 (fgetc(file) << 8) |
1159 (fgetc(file) << 0));
1160 else /* BYTE_ORDER_LITTLE_ENDIAN */
1161 return ((fgetc(file) << 0) |
1162 (fgetc(file) << 8) |
1163 (fgetc(file) << 16) |
1164 (fgetc(file) << 24));
1165 }
1166
putFile32BitInteger(FILE * file,int value,int byte_order)1167 int putFile32BitInteger(FILE *file, int value, int byte_order)
1168 {
1169 if (file != NULL)
1170 {
1171 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1172 {
1173 fputc((value >> 24) & 0xff, file);
1174 fputc((value >> 16) & 0xff, file);
1175 fputc((value >> 8) & 0xff, file);
1176 fputc((value >> 0) & 0xff, file);
1177 }
1178 else /* BYTE_ORDER_LITTLE_ENDIAN */
1179 {
1180 fputc((value >> 0) & 0xff, file);
1181 fputc((value >> 8) & 0xff, file);
1182 fputc((value >> 16) & 0xff, file);
1183 fputc((value >> 24) & 0xff, file);
1184 }
1185 }
1186
1187 return 4;
1188 }
1189
getFileChunk(FILE * file,char * chunk_name,int * chunk_size,int byte_order)1190 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1191 int byte_order)
1192 {
1193 const int chunk_name_length = 4;
1194
1195 /* read chunk name */
1196 if (fgets(chunk_name, chunk_name_length + 1, file) == NULL)
1197 return FALSE;
1198
1199 if (chunk_size != NULL)
1200 {
1201 /* read chunk size */
1202 *chunk_size = getFile32BitInteger(file, byte_order);
1203 }
1204
1205 return (feof(file) || ferror(file) ? FALSE : TRUE);
1206 }
1207
putFileChunk(FILE * file,char * chunk_name,int chunk_size,int byte_order)1208 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1209 int byte_order)
1210 {
1211 int num_bytes = 0;
1212
1213 /* write chunk name */
1214 if (file != NULL)
1215 fputs(chunk_name, file);
1216
1217 num_bytes += strlen(chunk_name);
1218
1219 if (chunk_size >= 0)
1220 {
1221 /* write chunk size */
1222 if (file != NULL)
1223 putFile32BitInteger(file, chunk_size, byte_order);
1224
1225 num_bytes += 4;
1226 }
1227
1228 return num_bytes;
1229 }
1230
getFileVersion(FILE * file)1231 int getFileVersion(FILE *file)
1232 {
1233 int version_major = fgetc(file);
1234 int version_minor = fgetc(file);
1235 int version_patch = fgetc(file);
1236 int version_build = fgetc(file);
1237
1238 return VERSION_IDENT(version_major, version_minor, version_patch,
1239 version_build);
1240 }
1241
putFileVersion(FILE * file,int version)1242 int putFileVersion(FILE *file, int version)
1243 {
1244 if (file != NULL)
1245 {
1246 int version_major = VERSION_MAJOR(version);
1247 int version_minor = VERSION_MINOR(version);
1248 int version_patch = VERSION_PATCH(version);
1249 int version_build = VERSION_BUILD(version);
1250
1251 fputc(version_major, file);
1252 fputc(version_minor, file);
1253 fputc(version_patch, file);
1254 fputc(version_build, file);
1255 }
1256
1257 return 4;
1258 }
1259
ReadBytesFromFile(FILE * file,byte * buffer,unsigned int bytes)1260 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned int bytes)
1261 {
1262 int i;
1263
1264 for(i = 0; i < bytes && !feof(file); i++)
1265 buffer[i] = fgetc(file);
1266 }
1267
WriteBytesToFile(FILE * file,byte * buffer,unsigned int bytes)1268 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1269 {
1270 int i;
1271
1272 for(i = 0; i < bytes; i++)
1273 fputc(buffer[i], file);
1274 }
1275
ReadUnusedBytesFromFile(FILE * file,unsigned int bytes)1276 void ReadUnusedBytesFromFile(FILE *file, unsigned int bytes)
1277 {
1278 while (bytes-- && !feof(file))
1279 fgetc(file);
1280 }
1281
WriteUnusedBytesToFile(FILE * file,unsigned int bytes)1282 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1283 {
1284 while (bytes--)
1285 fputc(0, file);
1286 }
1287
1288
1289 /* ------------------------------------------------------------------------- */
1290 /* functions to translate key identifiers between different format */
1291 /* ------------------------------------------------------------------------- */
1292
1293 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1294 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1295 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1296 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1297
translate_keyname(Key * keysym,char ** x11name,char ** name,int mode)1298 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1299 {
1300 static struct
1301 {
1302 Key key;
1303 char *x11name;
1304 char *name;
1305 } translate_key[] =
1306 {
1307 /* normal cursor keys */
1308 { KSYM_Left, "XK_Left", "cursor left" },
1309 { KSYM_Right, "XK_Right", "cursor right" },
1310 { KSYM_Up, "XK_Up", "cursor up" },
1311 { KSYM_Down, "XK_Down", "cursor down" },
1312
1313 /* keypad cursor keys */
1314 #ifdef KSYM_KP_Left
1315 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1316 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1317 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1318 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1319 #endif
1320
1321 /* other keypad keys */
1322 #ifdef KSYM_KP_Enter
1323 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1324 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1325 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1326 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1327 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1328 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1329 #endif
1330
1331 /* modifier keys */
1332 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1333 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1334 { KSYM_Control_L, "XK_Control_L", "left control" },
1335 { KSYM_Control_R, "XK_Control_R", "right control" },
1336 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1337 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1338 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1339 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1340 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1341 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1342 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1343 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1344
1345 /* some special keys */
1346 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1347 { KSYM_Delete, "XK_Delete", "delete" },
1348 { KSYM_Insert, "XK_Insert", "insert" },
1349 { KSYM_Tab, "XK_Tab", "tab" },
1350 { KSYM_Home, "XK_Home", "home" },
1351 { KSYM_End, "XK_End", "end" },
1352 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1353 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1354 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1355
1356 /* ASCII 0x20 to 0x40 keys (except numbers) */
1357 { KSYM_space, "XK_space", "space" },
1358 { KSYM_exclam, "XK_exclam", "!" },
1359 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1360 { KSYM_numbersign, "XK_numbersign", "#" },
1361 { KSYM_dollar, "XK_dollar", "$" },
1362 { KSYM_percent, "XK_percent", "%" },
1363 { KSYM_ampersand, "XK_ampersand", "&" },
1364 { KSYM_apostrophe, "XK_apostrophe", "'" },
1365 { KSYM_parenleft, "XK_parenleft", "(" },
1366 { KSYM_parenright, "XK_parenright", ")" },
1367 { KSYM_asterisk, "XK_asterisk", "*" },
1368 { KSYM_plus, "XK_plus", "+" },
1369 { KSYM_comma, "XK_comma", "," },
1370 { KSYM_minus, "XK_minus", "-" },
1371 { KSYM_period, "XK_period", "." },
1372 { KSYM_slash, "XK_slash", "/" },
1373 { KSYM_colon, "XK_colon", ":" },
1374 { KSYM_semicolon, "XK_semicolon", ";" },
1375 { KSYM_less, "XK_less", "<" },
1376 { KSYM_equal, "XK_equal", "=" },
1377 { KSYM_greater, "XK_greater", ">" },
1378 { KSYM_question, "XK_question", "?" },
1379 { KSYM_at, "XK_at", "@" },
1380
1381 /* more ASCII keys */
1382 { KSYM_bracketleft, "XK_bracketleft", "[" },
1383 { KSYM_backslash, "XK_backslash", "\\" },
1384 { KSYM_bracketright,"XK_bracketright", "]" },
1385 { KSYM_asciicircum, "XK_asciicircum", "^" },
1386 { KSYM_underscore, "XK_underscore", "_" },
1387 { KSYM_grave, "XK_grave", "grave" },
1388 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1389 { KSYM_braceleft, "XK_braceleft", "brace left" },
1390 { KSYM_bar, "XK_bar", "bar" },
1391 { KSYM_braceright, "XK_braceright", "brace right" },
1392 { KSYM_asciitilde, "XK_asciitilde", "~" },
1393
1394 /* special (non-ASCII) keys */
1395 { KSYM_degree, "XK_degree", "�" },
1396 { KSYM_Adiaeresis, "XK_Adiaeresis", "�" },
1397 { KSYM_Odiaeresis, "XK_Odiaeresis", "�" },
1398 { KSYM_Udiaeresis, "XK_Udiaeresis", "�" },
1399 { KSYM_adiaeresis, "XK_adiaeresis", "�" },
1400 { KSYM_odiaeresis, "XK_odiaeresis", "�" },
1401 { KSYM_udiaeresis, "XK_udiaeresis", "�" },
1402 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1403
1404 /* end-of-array identifier */
1405 { 0, NULL, NULL }
1406 };
1407
1408 int i;
1409
1410 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1411 {
1412 static char name_buffer[30];
1413 Key key = *keysym;
1414
1415 if (key >= KSYM_A && key <= KSYM_Z)
1416 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1417 else if (key >= KSYM_a && key <= KSYM_z)
1418 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1419 else if (key >= KSYM_0 && key <= KSYM_9)
1420 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1421 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1422 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1423 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1424 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1425 else if (key == KSYM_UNDEFINED)
1426 strcpy(name_buffer, "(undefined)");
1427 else
1428 {
1429 i = 0;
1430
1431 do
1432 {
1433 if (key == translate_key[i].key)
1434 {
1435 strcpy(name_buffer, translate_key[i].name);
1436 break;
1437 }
1438 }
1439 while (translate_key[++i].name);
1440
1441 if (!translate_key[i].name)
1442 strcpy(name_buffer, "(unknown)");
1443 }
1444
1445 *name = name_buffer;
1446 }
1447 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1448 {
1449 static char name_buffer[30];
1450 Key key = *keysym;
1451
1452 if (key >= KSYM_A && key <= KSYM_Z)
1453 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1454 else if (key >= KSYM_a && key <= KSYM_z)
1455 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1456 else if (key >= KSYM_0 && key <= KSYM_9)
1457 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1458 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1459 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1460 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1461 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1462 else if (key == KSYM_UNDEFINED)
1463 strcpy(name_buffer, "[undefined]");
1464 else
1465 {
1466 i = 0;
1467
1468 do
1469 {
1470 if (key == translate_key[i].key)
1471 {
1472 strcpy(name_buffer, translate_key[i].x11name);
1473 break;
1474 }
1475 }
1476 while (translate_key[++i].x11name);
1477
1478 if (!translate_key[i].x11name)
1479 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1480 }
1481
1482 *x11name = name_buffer;
1483 }
1484 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1485 {
1486 Key key = KSYM_UNDEFINED;
1487
1488 i = 0;
1489 do
1490 {
1491 if (strEqual(translate_key[i].name, *name))
1492 {
1493 key = translate_key[i].key;
1494 break;
1495 }
1496 }
1497 while (translate_key[++i].x11name);
1498
1499 if (key == KSYM_UNDEFINED)
1500 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1501
1502 *keysym = key;
1503 }
1504 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1505 {
1506 Key key = KSYM_UNDEFINED;
1507 char *name_ptr = *x11name;
1508
1509 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1510 {
1511 char c = name_ptr[3];
1512
1513 if (c >= 'A' && c <= 'Z')
1514 key = KSYM_A + (Key)(c - 'A');
1515 else if (c >= 'a' && c <= 'z')
1516 key = KSYM_a + (Key)(c - 'a');
1517 else if (c >= '0' && c <= '9')
1518 key = KSYM_0 + (Key)(c - '0');
1519 }
1520 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1521 {
1522 char c = name_ptr[6];
1523
1524 if (c >= '0' && c <= '9')
1525 key = KSYM_KP_0 + (Key)(c - '0');
1526 }
1527 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1528 {
1529 char c1 = name_ptr[4];
1530 char c2 = name_ptr[5];
1531 int d = 0;
1532
1533 if ((c1 >= '0' && c1 <= '9') &&
1534 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1535 d = atoi(&name_ptr[4]);
1536
1537 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1538 key = KSYM_F1 + (Key)(d - 1);
1539 }
1540 else if (strPrefix(name_ptr, "XK_"))
1541 {
1542 i = 0;
1543
1544 do
1545 {
1546 if (strEqual(name_ptr, translate_key[i].x11name))
1547 {
1548 key = translate_key[i].key;
1549 break;
1550 }
1551 }
1552 while (translate_key[++i].x11name);
1553 }
1554 else if (strPrefix(name_ptr, "0x"))
1555 {
1556 unsigned int value = 0;
1557
1558 name_ptr += 2;
1559
1560 while (name_ptr)
1561 {
1562 char c = *name_ptr++;
1563 int d = -1;
1564
1565 if (c >= '0' && c <= '9')
1566 d = (int)(c - '0');
1567 else if (c >= 'a' && c <= 'f')
1568 d = (int)(c - 'a' + 10);
1569 else if (c >= 'A' && c <= 'F')
1570 d = (int)(c - 'A' + 10);
1571
1572 if (d == -1)
1573 {
1574 value = -1;
1575 break;
1576 }
1577
1578 value = value * 16 + d;
1579 }
1580
1581 if (value != -1)
1582 key = (Key)value;
1583 }
1584
1585 *keysym = key;
1586 }
1587 }
1588
getKeyNameFromKey(Key key)1589 char *getKeyNameFromKey(Key key)
1590 {
1591 char *name;
1592
1593 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1594 return name;
1595 }
1596
getX11KeyNameFromKey(Key key)1597 char *getX11KeyNameFromKey(Key key)
1598 {
1599 char *x11name;
1600
1601 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1602 return x11name;
1603 }
1604
getKeyFromKeyName(char * name)1605 Key getKeyFromKeyName(char *name)
1606 {
1607 Key key;
1608
1609 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1610 return key;
1611 }
1612
getKeyFromX11KeyName(char * x11name)1613 Key getKeyFromX11KeyName(char *x11name)
1614 {
1615 Key key;
1616
1617 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1618 return key;
1619 }
1620
getCharFromKey(Key key)1621 char getCharFromKey(Key key)
1622 {
1623 char *keyname = getKeyNameFromKey(key);
1624 char c = 0;
1625
1626 if (strlen(keyname) == 1)
1627 c = keyname[0];
1628 else if (strEqual(keyname, "space"))
1629 c = ' ';
1630
1631 return c;
1632 }
1633
getValidConfigValueChar(char c)1634 char getValidConfigValueChar(char c)
1635 {
1636 if (c == '#' || /* used to mark comments */
1637 c == '\\') /* used to mark continued lines */
1638 c = 0;
1639
1640 return c;
1641 }
1642
1643
1644 /* ------------------------------------------------------------------------- */
1645 /* functions to translate string identifiers to integer or boolean value */
1646 /* ------------------------------------------------------------------------- */
1647
get_integer_from_string(char * s)1648 int get_integer_from_string(char *s)
1649 {
1650 static char *number_text[][3] =
1651 {
1652 { "0", "zero", "null", },
1653 { "1", "one", "first" },
1654 { "2", "two", "second" },
1655 { "3", "three", "third" },
1656 { "4", "four", "fourth" },
1657 { "5", "five", "fifth" },
1658 { "6", "six", "sixth" },
1659 { "7", "seven", "seventh" },
1660 { "8", "eight", "eighth" },
1661 { "9", "nine", "ninth" },
1662 { "10", "ten", "tenth" },
1663 { "11", "eleven", "eleventh" },
1664 { "12", "twelve", "twelfth" },
1665
1666 { NULL, NULL, NULL },
1667 };
1668
1669 int i, j;
1670 char *s_lower = getStringToLower(s);
1671 int result = -1;
1672
1673 for (i = 0; number_text[i][0] != NULL; i++)
1674 for (j = 0; j < 3; j++)
1675 if (strEqual(s_lower, number_text[i][j]))
1676 result = i;
1677
1678 if (result == -1)
1679 {
1680 if (strEqual(s_lower, "false") ||
1681 strEqual(s_lower, "no") ||
1682 strEqual(s_lower, "off"))
1683 result = 0;
1684 else if (strEqual(s_lower, "true") ||
1685 strEqual(s_lower, "yes") ||
1686 strEqual(s_lower, "on"))
1687 result = 1;
1688 else
1689 result = atoi(s);
1690 }
1691
1692 free(s_lower);
1693
1694 return result;
1695 }
1696
get_boolean_from_string(char * s)1697 boolean get_boolean_from_string(char *s)
1698 {
1699 char *s_lower = getStringToLower(s);
1700 boolean result = FALSE;
1701
1702 if (strEqual(s_lower, "true") ||
1703 strEqual(s_lower, "yes") ||
1704 strEqual(s_lower, "on") ||
1705 get_integer_from_string(s) == 1)
1706 result = TRUE;
1707
1708 free(s_lower);
1709
1710 return result;
1711 }
1712
get_switch3_from_string(char * s)1713 int get_switch3_from_string(char *s)
1714 {
1715 char *s_lower = getStringToLower(s);
1716 int result = FALSE;
1717
1718 if (strEqual(s_lower, "true") ||
1719 strEqual(s_lower, "yes") ||
1720 strEqual(s_lower, "on") ||
1721 get_integer_from_string(s) == 1)
1722 result = TRUE;
1723 else if (strEqual(s_lower, "auto"))
1724 result = AUTO;
1725
1726 free(s_lower);
1727
1728 return result;
1729 }
1730
1731
1732 /* ------------------------------------------------------------------------- */
1733 /* functions for generic lists */
1734 /* ------------------------------------------------------------------------- */
1735
newListNode()1736 ListNode *newListNode()
1737 {
1738 return checked_calloc(sizeof(ListNode));
1739 }
1740
addNodeToList(ListNode ** node_first,char * key,void * content)1741 void addNodeToList(ListNode **node_first, char *key, void *content)
1742 {
1743 ListNode *node_new = newListNode();
1744
1745 node_new->key = getStringCopy(key);
1746 node_new->content = content;
1747 node_new->next = *node_first;
1748 *node_first = node_new;
1749 }
1750
deleteNodeFromList(ListNode ** node_first,char * key,void (* destructor_function)(void *))1751 void deleteNodeFromList(ListNode **node_first, char *key,
1752 void (*destructor_function)(void *))
1753 {
1754 if (node_first == NULL || *node_first == NULL)
1755 return;
1756
1757 if (strEqual((*node_first)->key, key))
1758 {
1759 checked_free((*node_first)->key);
1760 if (destructor_function)
1761 destructor_function((*node_first)->content);
1762 *node_first = (*node_first)->next;
1763 }
1764 else
1765 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1766 }
1767
getNodeFromKey(ListNode * node_first,char * key)1768 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1769 {
1770 if (node_first == NULL)
1771 return NULL;
1772
1773 if (strEqual(node_first->key, key))
1774 return node_first;
1775 else
1776 return getNodeFromKey(node_first->next, key);
1777 }
1778
getNumNodes(ListNode * node_first)1779 int getNumNodes(ListNode *node_first)
1780 {
1781 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1782 }
1783
dumpList(ListNode * node_first)1784 void dumpList(ListNode *node_first)
1785 {
1786 ListNode *node = node_first;
1787
1788 while (node)
1789 {
1790 printf("['%s' (%d)]\n", node->key,
1791 ((struct ListNodeInfo *)node->content)->num_references);
1792 node = node->next;
1793 }
1794
1795 printf("[%d nodes]\n", getNumNodes(node_first));
1796 }
1797
1798
1799 /* ------------------------------------------------------------------------- */
1800 /* functions for checking files and filenames */
1801 /* ------------------------------------------------------------------------- */
1802
fileExists(char * filename)1803 boolean fileExists(char *filename)
1804 {
1805 if (filename == NULL)
1806 return FALSE;
1807
1808 return (access(filename, F_OK) == 0);
1809 }
1810
fileHasPrefix(char * basename,char * prefix)1811 boolean fileHasPrefix(char *basename, char *prefix)
1812 {
1813 static char *basename_lower = NULL;
1814 int basename_length, prefix_length;
1815
1816 checked_free(basename_lower);
1817
1818 if (basename == NULL || prefix == NULL)
1819 return FALSE;
1820
1821 basename_lower = getStringToLower(basename);
1822 basename_length = strlen(basename_lower);
1823 prefix_length = strlen(prefix);
1824
1825 if (basename_length > prefix_length + 1 &&
1826 basename_lower[prefix_length] == '.' &&
1827 strncmp(basename_lower, prefix, prefix_length) == 0)
1828 return TRUE;
1829
1830 return FALSE;
1831 }
1832
fileHasSuffix(char * basename,char * suffix)1833 boolean fileHasSuffix(char *basename, char *suffix)
1834 {
1835 static char *basename_lower = NULL;
1836 int basename_length, suffix_length;
1837
1838 checked_free(basename_lower);
1839
1840 if (basename == NULL || suffix == NULL)
1841 return FALSE;
1842
1843 basename_lower = getStringToLower(basename);
1844 basename_length = strlen(basename_lower);
1845 suffix_length = strlen(suffix);
1846
1847 if (basename_length > suffix_length + 1 &&
1848 basename_lower[basename_length - suffix_length - 1] == '.' &&
1849 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1850 return TRUE;
1851
1852 return FALSE;
1853 }
1854
FileIsGraphic(char * filename)1855 boolean FileIsGraphic(char *filename)
1856 {
1857 char *basename = getBaseNamePtr(filename);
1858
1859 return fileHasSuffix(basename, "pcx");
1860 }
1861
FileIsSound(char * filename)1862 boolean FileIsSound(char *filename)
1863 {
1864 char *basename = getBaseNamePtr(filename);
1865
1866 return fileHasSuffix(basename, "wav");
1867 }
1868
FileIsMusic(char * filename)1869 boolean FileIsMusic(char *filename)
1870 {
1871 char *basename = getBaseNamePtr(filename);
1872
1873 if (FileIsSound(basename))
1874 return TRUE;
1875
1876 #if defined(TARGET_SDL)
1877 if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
1878 fileHasSuffix(basename, "mod") ||
1879 fileHasSuffix(basename, "s3m") ||
1880 fileHasSuffix(basename, "it") ||
1881 fileHasSuffix(basename, "xm") ||
1882 fileHasSuffix(basename, "midi") ||
1883 fileHasSuffix(basename, "mid") ||
1884 fileHasSuffix(basename, "mp3") ||
1885 fileHasSuffix(basename, "ogg"))
1886 return TRUE;
1887 #endif
1888
1889 return FALSE;
1890 }
1891
FileIsArtworkType(char * basename,int type)1892 boolean FileIsArtworkType(char *basename, int type)
1893 {
1894 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1895 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1896 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1897 return TRUE;
1898
1899 return FALSE;
1900 }
1901
1902 /* ------------------------------------------------------------------------- */
1903 /* functions for loading artwork configuration information */
1904 /* ------------------------------------------------------------------------- */
1905
get_mapped_token(char * token)1906 char *get_mapped_token(char *token)
1907 {
1908 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1909 static char *map_token_prefix[][2] =
1910 {
1911 { "char_procent", "char_percent" },
1912 { NULL, }
1913 };
1914 int i;
1915
1916 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1917 {
1918 int len_token_prefix = strlen(map_token_prefix[i][0]);
1919
1920 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1921 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1922 }
1923
1924 return NULL;
1925 }
1926
1927 /* This function checks if a string <s> of the format "string1, string2, ..."
1928 exactly contains a string <s_contained>. */
1929
string_has_parameter(char * s,char * s_contained)1930 static boolean string_has_parameter(char *s, char *s_contained)
1931 {
1932 char *substring;
1933
1934 if (s == NULL || s_contained == NULL)
1935 return FALSE;
1936
1937 if (strlen(s_contained) > strlen(s))
1938 return FALSE;
1939
1940 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1941 {
1942 char next_char = s[strlen(s_contained)];
1943
1944 /* check if next character is delimiter or whitespace */
1945 return (next_char == ',' || next_char == '\0' ||
1946 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1947 }
1948
1949 /* check if string contains another parameter string after a comma */
1950 substring = strchr(s, ',');
1951 if (substring == NULL) /* string does not contain a comma */
1952 return FALSE;
1953
1954 /* advance string pointer to next character after the comma */
1955 substring++;
1956
1957 /* skip potential whitespaces after the comma */
1958 while (*substring == ' ' || *substring == '\t')
1959 substring++;
1960
1961 return string_has_parameter(substring, s_contained);
1962 }
1963
get_parameter_value(char * value_raw,char * suffix,int type)1964 int get_parameter_value(char *value_raw, char *suffix, int type)
1965 {
1966 char *value = getStringToLower(value_raw);
1967 int result = 0; /* probably a save default value */
1968
1969 if (strEqual(suffix, ".direction"))
1970 {
1971 result = (strEqual(value, "left") ? MV_LEFT :
1972 strEqual(value, "right") ? MV_RIGHT :
1973 strEqual(value, "up") ? MV_UP :
1974 strEqual(value, "down") ? MV_DOWN : MV_NONE);
1975 }
1976 else if (strEqual(suffix, ".align"))
1977 {
1978 result = (strEqual(value, "left") ? ALIGN_LEFT :
1979 strEqual(value, "right") ? ALIGN_RIGHT :
1980 strEqual(value, "center") ? ALIGN_CENTER :
1981 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
1982 }
1983 else if (strEqual(suffix, ".valign"))
1984 {
1985 result = (strEqual(value, "top") ? VALIGN_TOP :
1986 strEqual(value, "bottom") ? VALIGN_BOTTOM :
1987 strEqual(value, "middle") ? VALIGN_MIDDLE :
1988 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
1989 }
1990 else if (strEqual(suffix, ".anim_mode"))
1991 {
1992 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1993 string_has_parameter(value, "loop") ? ANIM_LOOP :
1994 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1995 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1996 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1997 string_has_parameter(value, "random") ? ANIM_RANDOM :
1998 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1999 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2000 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2001 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2002 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2003 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2004 ANIM_DEFAULT);
2005
2006 if (string_has_parameter(value, "reverse"))
2007 result |= ANIM_REVERSE;
2008
2009 if (string_has_parameter(value, "opaque_player"))
2010 result |= ANIM_OPAQUE_PLAYER;
2011
2012 if (string_has_parameter(value, "static_panel"))
2013 result |= ANIM_STATIC_PANEL;
2014 }
2015 else if (strEqual(suffix, ".class"))
2016 {
2017 result = get_hash_from_key(value);
2018 }
2019 else if (strEqual(suffix, ".style"))
2020 {
2021 result = STYLE_DEFAULT;
2022
2023 if (string_has_parameter(value, "accurate_borders"))
2024 result |= STYLE_ACCURATE_BORDERS;
2025
2026 if (string_has_parameter(value, "inner_corners"))
2027 result |= STYLE_INNER_CORNERS;
2028 }
2029 else if (strEqual(suffix, ".fade_mode"))
2030 {
2031 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2032 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2033 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2034 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2035 FADE_MODE_DEFAULT);
2036 }
2037 #if 1
2038 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2039 #else
2040 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
2041 #endif
2042 {
2043 result = gfx.get_font_from_token_function(value);
2044 }
2045 else /* generic parameter of type integer or boolean */
2046 {
2047 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2048 type == TYPE_INTEGER ? get_integer_from_string(value) :
2049 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2050 ARG_UNDEFINED_VALUE);
2051 }
2052
2053 free(value);
2054
2055 return result;
2056 }
2057
get_screen_mode_from_string(char * screen_mode_string)2058 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2059 {
2060 static struct ScreenModeInfo screen_mode;
2061 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2062 char *screen_mode_string_copy;
2063 char *screen_mode_string_pos_w;
2064 char *screen_mode_string_pos_h;
2065
2066 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2067 return NULL;
2068
2069 screen_mode_string_copy = getStringCopy(screen_mode_string);
2070
2071 screen_mode_string_pos_w = screen_mode_string_copy;
2072 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2073 *screen_mode_string_pos_h++ = '\0';
2074
2075 screen_mode.width = atoi(screen_mode_string_pos_w);
2076 screen_mode.height = atoi(screen_mode_string_pos_h);
2077
2078 return &screen_mode;
2079 }
2080
get_aspect_ratio_from_screen_mode(struct ScreenModeInfo * screen_mode,int * x,int * y)2081 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2082 int *x, int *y)
2083 {
2084 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2085 float aspect_ratio_new;
2086 int i = 1;
2087
2088 do
2089 {
2090 *x = i * aspect_ratio + 0.000001;
2091 *y = i;
2092
2093 aspect_ratio_new = (float)*x / (float)*y;
2094
2095 i++;
2096 }
2097 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2098 }
2099
2100 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2101 struct ListNodeInfo ***, int *);
2102
getFileListFromConfigList(struct ConfigInfo * config_list,struct ConfigTypeInfo * suffix_list,char ** ignore_tokens,int num_file_list_entries)2103 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2104 struct ConfigTypeInfo *suffix_list,
2105 char **ignore_tokens,
2106 int num_file_list_entries)
2107 {
2108 struct FileInfo *file_list;
2109 int num_file_list_entries_found = 0;
2110 int num_suffix_list_entries = 0;
2111 int list_pos;
2112 int i, j;
2113
2114 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2115
2116 for (i = 0; suffix_list[i].token != NULL; i++)
2117 num_suffix_list_entries++;
2118
2119 /* always start with reliable default values */
2120 for (i = 0; i < num_file_list_entries; i++)
2121 {
2122 file_list[i].token = NULL;
2123
2124 file_list[i].default_filename = NULL;
2125 file_list[i].filename = NULL;
2126
2127 if (num_suffix_list_entries > 0)
2128 {
2129 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2130
2131 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2132 file_list[i].parameter = checked_calloc(parameter_array_size);
2133
2134 for (j = 0; j < num_suffix_list_entries; j++)
2135 {
2136 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2137 setString(&file_list[i].parameter[j], suffix_list[j].value);
2138 }
2139
2140 file_list[i].redefined = FALSE;
2141 file_list[i].fallback_to_default = FALSE;
2142 file_list[i].default_is_cloned = FALSE;
2143 }
2144 }
2145
2146 list_pos = 0;
2147 for (i = 0; config_list[i].token != NULL; i++)
2148 {
2149 int len_config_token = strlen(config_list[i].token);
2150 int len_config_value = strlen(config_list[i].value);
2151 boolean is_file_entry = TRUE;
2152
2153 for (j = 0; suffix_list[j].token != NULL; j++)
2154 {
2155 int len_suffix = strlen(suffix_list[j].token);
2156
2157 if (len_suffix < len_config_token &&
2158 strEqual(&config_list[i].token[len_config_token - len_suffix],
2159 suffix_list[j].token))
2160 {
2161 setString(&file_list[list_pos].default_parameter[j],
2162 config_list[i].value);
2163
2164 is_file_entry = FALSE;
2165 break;
2166 }
2167 }
2168
2169 /* the following tokens are no file definitions, but other config tokens */
2170 for (j = 0; ignore_tokens[j] != NULL; j++)
2171 if (strEqual(config_list[i].token, ignore_tokens[j]))
2172 is_file_entry = FALSE;
2173
2174 if (is_file_entry)
2175 {
2176 if (i > 0)
2177 list_pos++;
2178
2179 if (list_pos >= num_file_list_entries)
2180 break;
2181
2182 /* simple sanity check if this is really a file definition */
2183 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2184 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2185 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2186 {
2187 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2188 config_list[i].token, config_list[i].value);
2189 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2190 }
2191
2192 file_list[list_pos].token = config_list[i].token;
2193 file_list[list_pos].default_filename = config_list[i].value;
2194
2195 #if 0
2196 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2197 #endif
2198 }
2199
2200 if (strSuffix(config_list[i].token, ".clone_from"))
2201 file_list[list_pos].default_is_cloned = TRUE;
2202 }
2203
2204 num_file_list_entries_found = list_pos + 1;
2205 if (num_file_list_entries_found != num_file_list_entries)
2206 {
2207 Error(ERR_INFO_LINE, "-");
2208 Error(ERR_INFO, "inconsistant config list information:");
2209 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2210 num_file_list_entries);
2211 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2212 num_file_list_entries_found);
2213 Error(ERR_EXIT, "please fix");
2214 }
2215
2216 #if 0
2217 printf("::: ---------- DONE ----------\n");
2218 #endif
2219
2220 return file_list;
2221 }
2222
token_suffix_match(char * token,char * suffix,int start_pos)2223 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2224 {
2225 int len_token = strlen(token);
2226 int len_suffix = strlen(suffix);
2227
2228 if (start_pos < 0) /* compare suffix from end of string */
2229 start_pos += len_token;
2230
2231 if (start_pos < 0 || start_pos + len_suffix > len_token)
2232 return FALSE;
2233
2234 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2235 return FALSE;
2236
2237 if (token[start_pos + len_suffix] == '\0')
2238 return TRUE;
2239
2240 if (token[start_pos + len_suffix] == '.')
2241 return TRUE;
2242
2243 return FALSE;
2244 }
2245
2246 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2247
read_token_parameters(SetupFileHash * setup_file_hash,struct ConfigTypeInfo * suffix_list,struct FileInfo * file_list_entry)2248 static void read_token_parameters(SetupFileHash *setup_file_hash,
2249 struct ConfigTypeInfo *suffix_list,
2250 struct FileInfo *file_list_entry)
2251 {
2252 /* check for config token that is the base token without any suffixes */
2253 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2254 char *known_token_value = KNOWN_TOKEN_VALUE;
2255 int i;
2256
2257 if (filename != NULL)
2258 {
2259 setString(&file_list_entry->filename, filename);
2260
2261 /* when file definition found, set all parameters to default values */
2262 for (i = 0; suffix_list[i].token != NULL; i++)
2263 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2264
2265 file_list_entry->redefined = TRUE;
2266
2267 /* mark config file token as well known from default config */
2268 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2269 }
2270
2271 /* check for config tokens that can be build by base token and suffixes */
2272 for (i = 0; suffix_list[i].token != NULL; i++)
2273 {
2274 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2275 char *value = getHashEntry(setup_file_hash, token);
2276
2277 if (value != NULL)
2278 {
2279 setString(&file_list_entry->parameter[i], value);
2280
2281 /* mark config file token as well known from default config */
2282 setHashEntry(setup_file_hash, token, known_token_value);
2283 }
2284
2285 free(token);
2286 }
2287 }
2288
add_dynamic_file_list_entry(struct FileInfo ** list,int * num_list_entries,SetupFileHash * extra_file_hash,struct ConfigTypeInfo * suffix_list,int num_suffix_list_entries,char * token)2289 static void add_dynamic_file_list_entry(struct FileInfo **list,
2290 int *num_list_entries,
2291 SetupFileHash *extra_file_hash,
2292 struct ConfigTypeInfo *suffix_list,
2293 int num_suffix_list_entries,
2294 char *token)
2295 {
2296 struct FileInfo *new_list_entry;
2297 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2298
2299 (*num_list_entries)++;
2300 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2301 new_list_entry = &(*list)[*num_list_entries - 1];
2302
2303 new_list_entry->token = getStringCopy(token);
2304 new_list_entry->default_filename = NULL;
2305 new_list_entry->filename = NULL;
2306 new_list_entry->parameter = checked_calloc(parameter_array_size);
2307
2308 new_list_entry->redefined = FALSE;
2309 new_list_entry->fallback_to_default = FALSE;
2310 new_list_entry->default_is_cloned = FALSE;
2311
2312 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2313 }
2314
add_property_mapping(struct PropertyMapping ** list,int * num_list_entries,int base_index,int ext1_index,int ext2_index,int ext3_index,int artwork_index)2315 static void add_property_mapping(struct PropertyMapping **list,
2316 int *num_list_entries,
2317 int base_index, int ext1_index,
2318 int ext2_index, int ext3_index,
2319 int artwork_index)
2320 {
2321 struct PropertyMapping *new_list_entry;
2322
2323 (*num_list_entries)++;
2324 *list = checked_realloc(*list,
2325 *num_list_entries * sizeof(struct PropertyMapping));
2326 new_list_entry = &(*list)[*num_list_entries - 1];
2327
2328 new_list_entry->base_index = base_index;
2329 new_list_entry->ext1_index = ext1_index;
2330 new_list_entry->ext2_index = ext2_index;
2331 new_list_entry->ext3_index = ext3_index;
2332
2333 new_list_entry->artwork_index = artwork_index;
2334 }
2335
LoadArtworkConfigFromFilename(struct ArtworkListInfo * artwork_info,char * filename)2336 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2337 char *filename)
2338 {
2339 struct FileInfo *file_list = artwork_info->file_list;
2340 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2341 char **base_prefixes = artwork_info->base_prefixes;
2342 char **ext1_suffixes = artwork_info->ext1_suffixes;
2343 char **ext2_suffixes = artwork_info->ext2_suffixes;
2344 char **ext3_suffixes = artwork_info->ext3_suffixes;
2345 char **ignore_tokens = artwork_info->ignore_tokens;
2346 int num_file_list_entries = artwork_info->num_file_list_entries;
2347 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2348 int num_base_prefixes = artwork_info->num_base_prefixes;
2349 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2350 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2351 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2352 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2353 SetupFileHash *setup_file_hash, *valid_file_hash;
2354 SetupFileHash *extra_file_hash, *empty_file_hash;
2355 char *known_token_value = KNOWN_TOKEN_VALUE;
2356 int i, j, k, l;
2357
2358 if (filename == NULL)
2359 return;
2360
2361 #if 0
2362 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2363 #endif
2364
2365 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2366 return;
2367
2368 /* separate valid (defined) from empty (undefined) config token values */
2369 valid_file_hash = newSetupFileHash();
2370 empty_file_hash = newSetupFileHash();
2371 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2372 {
2373 char *value = HASH_ITERATION_VALUE(itr);
2374
2375 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2376 HASH_ITERATION_TOKEN(itr), value);
2377 }
2378 END_HASH_ITERATION(setup_file_hash, itr)
2379
2380 /* at this point, we do not need the setup file hash anymore -- free it */
2381 freeSetupFileHash(setup_file_hash);
2382
2383 /* map deprecated to current tokens (using prefix match and replace) */
2384 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2385 {
2386 char *token = HASH_ITERATION_TOKEN(itr);
2387 char *mapped_token = get_mapped_token(token);
2388
2389 if (mapped_token != NULL)
2390 {
2391 char *value = HASH_ITERATION_VALUE(itr);
2392
2393 /* add mapped token */
2394 setHashEntry(valid_file_hash, mapped_token, value);
2395
2396 /* ignore old token (by setting it to "known" keyword) */
2397 setHashEntry(valid_file_hash, token, known_token_value);
2398
2399 free(mapped_token);
2400 }
2401 }
2402 END_HASH_ITERATION(valid_file_hash, itr)
2403
2404 /* read parameters for all known config file tokens */
2405 for (i = 0; i < num_file_list_entries; i++)
2406 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2407
2408 /* set all tokens that can be ignored here to "known" keyword */
2409 for (i = 0; i < num_ignore_tokens; i++)
2410 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2411
2412 /* copy all unknown config file tokens to extra config hash */
2413 extra_file_hash = newSetupFileHash();
2414 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2415 {
2416 char *value = HASH_ITERATION_VALUE(itr);
2417
2418 if (!strEqual(value, known_token_value))
2419 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2420 }
2421 END_HASH_ITERATION(valid_file_hash, itr)
2422
2423 /* at this point, we do not need the valid file hash anymore -- free it */
2424 freeSetupFileHash(valid_file_hash);
2425
2426 /* now try to determine valid, dynamically defined config tokens */
2427
2428 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2429 {
2430 struct FileInfo **dynamic_file_list =
2431 &artwork_info->dynamic_file_list;
2432 int *num_dynamic_file_list_entries =
2433 &artwork_info->num_dynamic_file_list_entries;
2434 struct PropertyMapping **property_mapping =
2435 &artwork_info->property_mapping;
2436 int *num_property_mapping_entries =
2437 &artwork_info->num_property_mapping_entries;
2438 int current_summarized_file_list_entry =
2439 artwork_info->num_file_list_entries +
2440 artwork_info->num_dynamic_file_list_entries;
2441 char *token = HASH_ITERATION_TOKEN(itr);
2442 int len_token = strlen(token);
2443 int start_pos;
2444 boolean base_prefix_found = FALSE;
2445 boolean parameter_suffix_found = FALSE;
2446
2447 #if 0
2448 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2449 #endif
2450
2451 /* skip all parameter definitions (handled by read_token_parameters()) */
2452 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2453 {
2454 int len_suffix = strlen(suffix_list[i].token);
2455
2456 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2457 parameter_suffix_found = TRUE;
2458 }
2459
2460 if (parameter_suffix_found)
2461 continue;
2462
2463 /* ---------- step 0: search for matching base prefix ---------- */
2464
2465 start_pos = 0;
2466 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2467 {
2468 char *base_prefix = base_prefixes[i];
2469 int len_base_prefix = strlen(base_prefix);
2470 boolean ext1_suffix_found = FALSE;
2471 boolean ext2_suffix_found = FALSE;
2472 boolean ext3_suffix_found = FALSE;
2473 boolean exact_match = FALSE;
2474 int base_index = -1;
2475 int ext1_index = -1;
2476 int ext2_index = -1;
2477 int ext3_index = -1;
2478
2479 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2480
2481 if (!base_prefix_found)
2482 continue;
2483
2484 base_index = i;
2485
2486 #if 0
2487 if (IS_PARENT_PROCESS())
2488 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2489 #endif
2490
2491 if (start_pos + len_base_prefix == len_token) /* exact match */
2492 {
2493 exact_match = TRUE;
2494
2495 #if 0
2496 if (IS_PARENT_PROCESS())
2497 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2498 #endif
2499
2500 add_dynamic_file_list_entry(dynamic_file_list,
2501 num_dynamic_file_list_entries,
2502 extra_file_hash,
2503 suffix_list,
2504 num_suffix_list_entries,
2505 token);
2506 add_property_mapping(property_mapping,
2507 num_property_mapping_entries,
2508 base_index, -1, -1, -1,
2509 current_summarized_file_list_entry);
2510 continue;
2511 }
2512
2513 #if 0
2514 if (IS_PARENT_PROCESS())
2515 printf("---> examining token '%s': search 1st suffix ...\n", token);
2516 #endif
2517
2518 /* ---------- step 1: search for matching first suffix ---------- */
2519
2520 start_pos += len_base_prefix;
2521 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2522 {
2523 char *ext1_suffix = ext1_suffixes[j];
2524 int len_ext1_suffix = strlen(ext1_suffix);
2525
2526 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2527
2528 if (!ext1_suffix_found)
2529 continue;
2530
2531 ext1_index = j;
2532
2533 #if 0
2534 if (IS_PARENT_PROCESS())
2535 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2536 #endif
2537
2538 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2539 {
2540 exact_match = TRUE;
2541
2542 #if 0
2543 if (IS_PARENT_PROCESS())
2544 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2545 #endif
2546
2547 add_dynamic_file_list_entry(dynamic_file_list,
2548 num_dynamic_file_list_entries,
2549 extra_file_hash,
2550 suffix_list,
2551 num_suffix_list_entries,
2552 token);
2553 add_property_mapping(property_mapping,
2554 num_property_mapping_entries,
2555 base_index, ext1_index, -1, -1,
2556 current_summarized_file_list_entry);
2557 continue;
2558 }
2559
2560 start_pos += len_ext1_suffix;
2561 }
2562
2563 if (exact_match)
2564 break;
2565
2566 #if 0
2567 if (IS_PARENT_PROCESS())
2568 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2569 #endif
2570
2571 /* ---------- step 2: search for matching second suffix ---------- */
2572
2573 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2574 {
2575 char *ext2_suffix = ext2_suffixes[k];
2576 int len_ext2_suffix = strlen(ext2_suffix);
2577
2578 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2579
2580 if (!ext2_suffix_found)
2581 continue;
2582
2583 ext2_index = k;
2584
2585 #if 0
2586 if (IS_PARENT_PROCESS())
2587 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2588 #endif
2589
2590 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2591 {
2592 exact_match = TRUE;
2593
2594 #if 0
2595 if (IS_PARENT_PROCESS())
2596 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2597 #endif
2598
2599 add_dynamic_file_list_entry(dynamic_file_list,
2600 num_dynamic_file_list_entries,
2601 extra_file_hash,
2602 suffix_list,
2603 num_suffix_list_entries,
2604 token);
2605 add_property_mapping(property_mapping,
2606 num_property_mapping_entries,
2607 base_index, ext1_index, ext2_index, -1,
2608 current_summarized_file_list_entry);
2609 continue;
2610 }
2611
2612 start_pos += len_ext2_suffix;
2613 }
2614
2615 if (exact_match)
2616 break;
2617
2618 #if 0
2619 if (IS_PARENT_PROCESS())
2620 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2621 #endif
2622
2623 /* ---------- step 3: search for matching third suffix ---------- */
2624
2625 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2626 {
2627 char *ext3_suffix = ext3_suffixes[l];
2628 int len_ext3_suffix = strlen(ext3_suffix);
2629
2630 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2631
2632 if (!ext3_suffix_found)
2633 continue;
2634
2635 ext3_index = l;
2636
2637 #if 0
2638 if (IS_PARENT_PROCESS())
2639 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2640 #endif
2641
2642 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2643 {
2644 exact_match = TRUE;
2645
2646 #if 0
2647 if (IS_PARENT_PROCESS())
2648 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2649 #endif
2650
2651 add_dynamic_file_list_entry(dynamic_file_list,
2652 num_dynamic_file_list_entries,
2653 extra_file_hash,
2654 suffix_list,
2655 num_suffix_list_entries,
2656 token);
2657 add_property_mapping(property_mapping,
2658 num_property_mapping_entries,
2659 base_index, ext1_index, ext2_index, ext3_index,
2660 current_summarized_file_list_entry);
2661 continue;
2662 }
2663 }
2664 }
2665 }
2666 END_HASH_ITERATION(extra_file_hash, itr)
2667
2668 if (artwork_info->num_dynamic_file_list_entries > 0)
2669 {
2670 artwork_info->dynamic_artwork_list =
2671 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2672 artwork_info->sizeof_artwork_list_entry);
2673 }
2674
2675 if (options.verbose && IS_PARENT_PROCESS())
2676 {
2677 SetupFileList *setup_file_list, *list;
2678 boolean dynamic_tokens_found = FALSE;
2679 boolean unknown_tokens_found = FALSE;
2680 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2681
2682 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2683 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2684
2685 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2686 {
2687 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2688 dynamic_tokens_found = TRUE;
2689 else
2690 unknown_tokens_found = TRUE;
2691 }
2692 END_HASH_ITERATION(extra_file_hash, itr)
2693
2694 if (options.debug && dynamic_tokens_found)
2695 {
2696 Error(ERR_INFO_LINE, "-");
2697 Error(ERR_INFO, "dynamic token(s) found in config file:");
2698 Error(ERR_INFO, "- config file: '%s'", filename);
2699
2700 for (list = setup_file_list; list != NULL; list = list->next)
2701 {
2702 char *value = getHashEntry(extra_file_hash, list->token);
2703
2704 if (value != NULL && strEqual(value, known_token_value))
2705 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2706 }
2707
2708 Error(ERR_INFO_LINE, "-");
2709 }
2710
2711 if (unknown_tokens_found)
2712 {
2713 Error(ERR_INFO_LINE, "-");
2714 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2715 Error(ERR_INFO, "- config file: '%s'", filename);
2716
2717 for (list = setup_file_list; list != NULL; list = list->next)
2718 {
2719 char *value = getHashEntry(extra_file_hash, list->token);
2720
2721 if (value != NULL && !strEqual(value, known_token_value))
2722 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2723 }
2724
2725 Error(ERR_INFO_LINE, "-");
2726 }
2727
2728 if (undefined_values_found)
2729 {
2730 Error(ERR_INFO_LINE, "-");
2731 Error(ERR_INFO, "warning: undefined values found in config file:");
2732 Error(ERR_INFO, "- config file: '%s'", filename);
2733
2734 for (list = setup_file_list; list != NULL; list = list->next)
2735 {
2736 char *value = getHashEntry(empty_file_hash, list->token);
2737
2738 if (value != NULL)
2739 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2740 }
2741
2742 Error(ERR_INFO_LINE, "-");
2743 }
2744
2745 freeSetupFileList(setup_file_list);
2746 }
2747
2748 freeSetupFileHash(extra_file_hash);
2749 freeSetupFileHash(empty_file_hash);
2750
2751 #if 0
2752 for (i = 0; i < num_file_list_entries; i++)
2753 {
2754 printf("'%s' ", file_list[i].token);
2755 if (file_list[i].filename)
2756 printf("-> '%s'\n", file_list[i].filename);
2757 else
2758 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2759 }
2760 #endif
2761 }
2762
LoadArtworkConfig(struct ArtworkListInfo * artwork_info)2763 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2764 {
2765 struct FileInfo *file_list = artwork_info->file_list;
2766 int num_file_list_entries = artwork_info->num_file_list_entries;
2767 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2768 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2769 int i, j;
2770
2771 DrawInitText("Loading artwork config", 120, FC_GREEN);
2772 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2773
2774 /* always start with reliable default values */
2775 for (i = 0; i < num_file_list_entries; i++)
2776 {
2777 setString(&file_list[i].filename, file_list[i].default_filename);
2778
2779 for (j = 0; j < num_suffix_list_entries; j++)
2780 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2781
2782 file_list[i].redefined = FALSE;
2783 file_list[i].fallback_to_default = FALSE;
2784 }
2785
2786 /* free previous dynamic artwork file array */
2787 if (artwork_info->dynamic_file_list != NULL)
2788 {
2789 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2790 {
2791 free(artwork_info->dynamic_file_list[i].token);
2792 free(artwork_info->dynamic_file_list[i].filename);
2793 free(artwork_info->dynamic_file_list[i].parameter);
2794 }
2795
2796 free(artwork_info->dynamic_file_list);
2797 artwork_info->dynamic_file_list = NULL;
2798
2799 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2800 &artwork_info->num_dynamic_file_list_entries);
2801 }
2802
2803 /* free previous property mapping */
2804 if (artwork_info->property_mapping != NULL)
2805 {
2806 free(artwork_info->property_mapping);
2807
2808 artwork_info->property_mapping = NULL;
2809 artwork_info->num_property_mapping_entries = 0;
2810 }
2811
2812 #if 1
2813 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
2814 #else
2815 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2816 #endif
2817 {
2818 /* first look for special artwork configured in level series config */
2819 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2820
2821 #if 0
2822 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
2823 leveldir_current->graphics_set,
2824 leveldir_current->graphics_path);
2825 #endif
2826
2827 if (fileExists(filename_base))
2828 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2829 }
2830
2831 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2832
2833 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2834 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2835 }
2836
deleteArtworkListEntry(struct ArtworkListInfo * artwork_info,struct ListNodeInfo ** listnode)2837 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2838 struct ListNodeInfo **listnode)
2839 {
2840 if (*listnode)
2841 {
2842 char *filename = (*listnode)->source_filename;
2843
2844 if (--(*listnode)->num_references <= 0)
2845 deleteNodeFromList(&artwork_info->content_list, filename,
2846 artwork_info->free_artwork);
2847
2848 *listnode = NULL;
2849 }
2850 }
2851
replaceArtworkListEntry(struct ArtworkListInfo * artwork_info,struct ListNodeInfo ** listnode,struct FileInfo * file_list_entry)2852 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2853 struct ListNodeInfo **listnode,
2854 struct FileInfo *file_list_entry)
2855 {
2856 char *init_text[] =
2857 {
2858 "Loading graphics",
2859 "Loading sounds",
2860 "Loading music"
2861 };
2862
2863 ListNode *node;
2864 char *basename = file_list_entry->filename;
2865 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2866
2867 if (filename == NULL)
2868 {
2869 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2870
2871 basename = file_list_entry->default_filename;
2872
2873 /* fail for cloned default artwork that has no default filename defined */
2874 if (file_list_entry->default_is_cloned &&
2875 strEqual(basename, UNDEFINED_FILENAME))
2876 {
2877 int error_mode = ERR_WARN;
2878
2879 /* we can get away without sounds and music, but not without graphics */
2880 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2881 error_mode = ERR_EXIT;
2882
2883 Error(error_mode, "token '%s' was cloned and has no default filename",
2884 file_list_entry->token);
2885
2886 return;
2887 }
2888
2889 /* dynamic artwork has no default filename / skip empty default artwork */
2890 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2891 return;
2892
2893 file_list_entry->fallback_to_default = TRUE;
2894
2895 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2896
2897 filename = getCustomArtworkFilename(basename, artwork_info->type);
2898
2899 if (filename == NULL)
2900 {
2901 int error_mode = ERR_WARN;
2902
2903 /* we can get away without sounds and music, but not without graphics */
2904 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2905 error_mode = ERR_EXIT;
2906
2907 Error(error_mode, "cannot find default artwork file '%s'", basename);
2908
2909 return;
2910 }
2911 }
2912
2913 /* check if the old and the new artwork file are the same */
2914 if (*listnode && strEqual((*listnode)->source_filename, filename))
2915 {
2916 /* The old and new artwork are the same (have the same filename and path).
2917 This usually means that this artwork does not exist in this artwork set
2918 and a fallback to the existing artwork is done. */
2919
2920 #if 0
2921 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2922 #endif
2923
2924 return;
2925 }
2926
2927 /* delete existing artwork file entry */
2928 deleteArtworkListEntry(artwork_info, listnode);
2929
2930 /* check if the new artwork file already exists in the list of artworks */
2931 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2932 {
2933 #if 0
2934 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2935 #endif
2936
2937 *listnode = (struct ListNodeInfo *)node->content;
2938 (*listnode)->num_references++;
2939
2940 return;
2941 }
2942
2943 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2944 DrawInitText(basename, 150, FC_YELLOW);
2945
2946 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2947 {
2948 #if 0
2949 printf("[adding new artwork '%s']\n", filename);
2950 #endif
2951
2952 (*listnode)->num_references = 1;
2953 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2954 *listnode);
2955 }
2956 else
2957 {
2958 int error_mode = ERR_WARN;
2959
2960 /* we can get away without sounds and music, but not without graphics */
2961 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2962 error_mode = ERR_EXIT;
2963
2964 Error(error_mode, "cannot load artwork file '%s'", basename);
2965
2966 return;
2967 }
2968 }
2969
LoadCustomArtwork(struct ArtworkListInfo * artwork_info,struct ListNodeInfo ** listnode,struct FileInfo * file_list_entry)2970 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2971 struct ListNodeInfo **listnode,
2972 struct FileInfo *file_list_entry)
2973 {
2974 #if 0
2975 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
2976 #endif
2977
2978 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2979 {
2980 deleteArtworkListEntry(artwork_info, listnode);
2981 return;
2982 }
2983
2984 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2985 }
2986
ReloadCustomArtworkList(struct ArtworkListInfo * artwork_info)2987 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2988 {
2989 struct FileInfo *file_list = artwork_info->file_list;
2990 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2991 int num_file_list_entries = artwork_info->num_file_list_entries;
2992 int num_dynamic_file_list_entries =
2993 artwork_info->num_dynamic_file_list_entries;
2994 int i;
2995
2996 for (i = 0; i < num_file_list_entries; i++)
2997 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2998 &file_list[i]);
2999
3000 for (i = 0; i < num_dynamic_file_list_entries; i++)
3001 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3002 &dynamic_file_list[i]);
3003
3004 #if 0
3005 dumpList(artwork_info->content_list);
3006 #endif
3007 }
3008
FreeCustomArtworkList(struct ArtworkListInfo * artwork_info,struct ListNodeInfo *** list,int * num_list_entries)3009 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3010 struct ListNodeInfo ***list,
3011 int *num_list_entries)
3012 {
3013 int i;
3014
3015 if (*list == NULL)
3016 return;
3017
3018 for (i = 0; i < *num_list_entries; i++)
3019 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3020 free(*list);
3021
3022 *list = NULL;
3023 *num_list_entries = 0;
3024 }
3025
FreeCustomArtworkLists(struct ArtworkListInfo * artwork_info)3026 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3027 {
3028 if (artwork_info == NULL)
3029 return;
3030
3031 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3032 &artwork_info->num_file_list_entries);
3033
3034 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3035 &artwork_info->num_dynamic_file_list_entries);
3036 }
3037
3038
3039 /* ------------------------------------------------------------------------- */
3040 /* functions only needed for non-Unix (non-command-line) systems */
3041 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3042 /* (now also added for Windows, to create files in user data directory) */
3043 /* ------------------------------------------------------------------------- */
3044
getErrorFilename(char * basename)3045 char *getErrorFilename(char *basename)
3046 {
3047 return getPath2(getUserGameDataDir(), basename);
3048 }
3049
openErrorFile()3050 void openErrorFile()
3051 {
3052 InitUserDataDirectory();
3053
3054 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3055 fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
3056 program.error_filename);
3057 }
3058
closeErrorFile()3059 void closeErrorFile()
3060 {
3061 if (program.error_file != stderr) /* do not close stream 'stderr' */
3062 fclose(program.error_file);
3063 }
3064
dumpErrorFile()3065 void dumpErrorFile()
3066 {
3067 FILE *error_file = fopen(program.error_filename, MODE_READ);
3068
3069 if (error_file != NULL)
3070 {
3071 while (!feof(error_file))
3072 fputc(fgetc(error_file), stderr);
3073
3074 fclose(error_file);
3075 }
3076 }
3077
NotifyUserAboutErrorFile()3078 void NotifyUserAboutErrorFile()
3079 {
3080 #if defined(PLATFORM_WIN32)
3081 char *title_text = getStringCat2(program.program_title, " Error Message");
3082 char *error_text = getStringCat2("The program was aborted due to an error; "
3083 "for details, see the following error file:"
3084 STRING_NEWLINE, program.error_filename);
3085
3086 MessageBox(NULL, error_text, title_text, MB_OK);
3087 #endif
3088 }
3089
3090
3091 /* ------------------------------------------------------------------------- */
3092 /* the following is only for debugging purpose and normally not used */
3093 /* ------------------------------------------------------------------------- */
3094
3095 #if DEBUG
3096
3097 #define DEBUG_NUM_TIMESTAMPS 5
3098 #define DEBUG_TIME_IN_MICROSECONDS 0
3099
3100 #if DEBUG_TIME_IN_MICROSECONDS
Counter_Microseconds()3101 static double Counter_Microseconds()
3102 {
3103 static struct timeval base_time = { 0, 0 };
3104 struct timeval current_time;
3105 double counter;
3106
3107 gettimeofday(¤t_time, NULL);
3108
3109 /* reset base time in case of wrap-around */
3110 if (current_time.tv_sec < base_time.tv_sec)
3111 base_time = current_time;
3112
3113 counter =
3114 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3115 ((double)(current_time.tv_usec - base_time.tv_usec));
3116
3117 return counter; /* return microseconds since last init */
3118 }
3119 #endif
3120
debug_print_timestamp_get_padding(int padding_size)3121 char *debug_print_timestamp_get_padding(int padding_size)
3122 {
3123 static char *padding = NULL;
3124 int max_padding_size = 100;
3125
3126 if (padding == NULL)
3127 {
3128 padding = checked_calloc(max_padding_size + 1);
3129 memset(padding, ' ', max_padding_size);
3130 }
3131
3132 return &padding[MAX(0, max_padding_size - padding_size)];
3133 }
3134
debug_print_timestamp(int counter_nr,char * message)3135 void debug_print_timestamp(int counter_nr, char *message)
3136 {
3137 int indent_size = 8;
3138 int padding_size = 40;
3139 float timestamp_interval;
3140
3141 if (counter_nr < 0)
3142 Error(ERR_EXIT, "debugging: invalid negative counter");
3143 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3144 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3145
3146 #if DEBUG_TIME_IN_MICROSECONDS
3147 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3148 char *unit = "ms";
3149
3150 counter[counter_nr][0] = Counter_Microseconds();
3151 #else
3152 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3153 char *unit = "s";
3154
3155 counter[counter_nr][0] = Counter();
3156 #endif
3157
3158 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3159 counter[counter_nr][1] = counter[counter_nr][0];
3160
3161 if (message)
3162 printf("%s%s%s %.3f %s\n",
3163 debug_print_timestamp_get_padding(counter_nr * indent_size),
3164 message,
3165 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3166 timestamp_interval / 1000,
3167 unit);
3168 }
3169
debug_print_parent_only(char * format,...)3170 void debug_print_parent_only(char *format, ...)
3171 {
3172 if (!IS_PARENT_PROCESS())
3173 return;
3174
3175 if (format)
3176 {
3177 va_list ap;
3178
3179 va_start(ap, format);
3180 vprintf(format, ap);
3181 va_end(ap);
3182
3183 printf("\n");
3184 }
3185 }
3186 #endif
3187