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