#include "platform.h"
-#if !defined(PLATFORM_WIN32)
+#if defined(PLATFORM_UNIX)
#include <pwd.h>
#include <sys/param.h>
#endif
// ----------------------------------------------------------------------------
-// generic logging functions
+// generic logging and error handling functions
// ----------------------------------------------------------------------------
enum log_levels
printf_log_nonewline("[%s] ", log_token);
}
-static void Log(int log_level, char *mode, char *format, va_list ap)
+static void vLog(int log_level, char *mode, char *format, va_list ap)
{
if (log_level < 0 || log_level > LOG_FATAL)
return;
+ if (log_level == LOG_DEBUG)
+ {
+ // only show debug messages when in debug mode
+ if (!options.debug)
+ return;
+
+ // if optional debug mode specified, limit debug output accordingly
+ if (options.debug_mode != NULL &&
+ strstr(mode, options.debug_mode) == NULL)
+ return;
+ }
+ else if (log_level == LOG_WARN)
+ {
+ // only show warning messages when in verbose mode
+ if (!options.verbose)
+ return;
+ }
+
+#if defined(PLATFORM_ANDROID)
+ android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
+ log_level == LOG_INFO ? ANDROID_LOG_INFO :
+ log_level == LOG_WARN ? ANDROID_LOG_WARN :
+ log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
+ log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
+ ANDROID_LOG_UNKNOWN);
+#endif
+
static boolean last_line_was_separator = FALSE;
char *log_token = log_tokens[log_level];
vprintf_log(format, ap);
}
+static void Log(int log_level, char *mode, char *format, ...)
+{
+ va_list ap;
+
+ va_start(ap, format);
+ vLog(log_level, mode, format, ap);
+ va_end(ap);
+}
+
+void DebugContinued(char *mode, char *format, ...)
+{
+ static char message[MAX_LINE_LEN] = { 0 };
+
+ // initialize message (optional)
+ if (strEqual(format, ""))
+ {
+ message[0] = '\0';
+
+ return;
+ }
+
+ char *message_ptr = message + strlen(message);
+ int size_left = MAX_LINE_LEN - strlen(message);
+ va_list ap;
+
+ // append message
+ va_start(ap, format);
+ vsnprintf(message_ptr, size_left, format, ap);
+ va_end(ap);
+
+ // finalize message
+ if (strSuffix(format, "\n"))
+ {
+ message[strlen(message) - 1] = '\0';
+
+ Debug(mode, message);
+
+ message[0] = '\0';
+ }
+}
+
void Debug(char *mode, char *format, ...)
{
va_list ap;
va_start(ap, format);
- Log(LOG_DEBUG, mode, format, ap);
+ vLog(LOG_DEBUG, mode, format, ap);
va_end(ap);
}
va_list ap;
va_start(ap, format);
- Log(LOG_INFO, NULL, format, ap);
+ vLog(LOG_INFO, NULL, format, ap);
va_end(ap);
}
va_list ap;
va_start(ap, format);
- Log(LOG_WARN, NULL, format, ap);
+ vLog(LOG_WARN, NULL, format, ap);
va_end(ap);
}
+void Error(char *format, ...)
+{
+ va_list ap;
+
+ va_start(ap, format);
+ vLog(LOG_ERROR, NULL, format, ap);
+ va_end(ap);
+}
+
+void Fail(char *format, ...)
+{
+ va_list ap;
+
+ va_start(ap, format);
+ vLog(LOG_FATAL, NULL, format, ap);
+ va_end(ap);
+
+ if (!network.is_server_thread)
+ {
+ va_start(ap, format);
+ program.exit_message_function(format, ap);
+ va_end(ap);
+ }
+
+ Log(LOG_FATAL, NULL, "aborting");
+
+ // network server thread: normal exit
+ if (network.is_server_thread)
+ exit(1);
+
+ // main process: clean up stuff
+ program.exit_function(1);
+}
+
+void FailWithHelp(char *format, ...)
+{
+ va_list ap;
+
+ va_start(ap, format);
+ vLog(LOG_FATAL, NULL, format, ap);
+ va_end(ap);
+
+ Log(LOG_FATAL, NULL, "try option '--help' for more information");
+ Log(LOG_FATAL, NULL, "aborting");
+
+ // main process: clean up stuff
+ program.exit_function(1);
+}
+
// ----------------------------------------------------------------------------
// string functions
#if 0
#if DEBUG
- printf("::: %d: %d ms", *loop_var, delay);
if (skip_frames)
- printf(" -> SKIP %d FRAME(S) [%d ms]", skip_frames, skip_frames * delay);
- printf("\n");
+ Debug("internal:SkipUntilDelayReached",
+ "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
+ *loop_var, delay,
+ skip_frames, skip_frames * delay);
+ else
+ Debug("internal:SkipUntilDelayReached",
+ "%d: %d ms",
+ *loop_var, delay);
#endif
#endif
}
#endif
+#if defined(PLATFORM_UNIX)
+static struct passwd *getPasswdEntry(void)
+{
+#if defined(PLATFORM_EMSCRIPTEN)
+ // currently not fully supported; force fallback to default values
+ return NULL;
+#else
+ return getpwuid(getuid());
+#endif
+}
+
+char *getUnixLoginName(void)
+{
+ struct passwd *pwd = getPasswdEntry();
+
+ if (pwd != NULL && strlen(pwd->pw_name) != 0)
+ return pwd->pw_name;
+
+ return NULL;
+}
+
+char *getUnixRealName(void)
+{
+ struct passwd *pwd = getPasswdEntry();
+
+ if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
+ return pwd->pw_gecos;
+
+ return NULL;
+}
+
+char *getUnixHomeDir(void)
+{
+ struct passwd *pwd = getPasswdEntry();
+
+ if (pwd != NULL && strlen(pwd->pw_dir) != 0)
+ return pwd->pw_dir;
+
+ return NULL;
+}
+#endif
+
char *getLoginName(void)
{
static char *login_name = NULL;
if (login_name == NULL)
{
unsigned long buffer_size = MAX_USERNAME_LEN + 1;
+
login_name = checked_malloc(buffer_size);
if (GetUserName(login_name, &buffer_size) == 0)
#elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
if (login_name == NULL)
{
- struct passwd *pwd;
+ char *name = getUnixLoginName();
- if ((pwd = getpwuid(getuid())) == NULL)
- login_name = ANONYMOUS_NAME;
+ if (name != NULL)
+ login_name = getStringCopy(name);
else
- login_name = getStringCopy(pwd->pw_name);
+ login_name = ANONYMOUS_NAME;
}
#else
login_name = ANONYMOUS_NAME;
#elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
if (real_name == NULL)
{
- struct passwd *pwd;
+ char *name = getUnixRealName();
- if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
- real_name = get_corrected_real_name(pwd->pw_gecos);
+ if (name != NULL)
+ real_name = get_corrected_real_name(name);
else
real_name = ANONYMOUS_NAME;
}
return real_name;
}
+char *getFixedUserName(char *name)
+{
+ // needed because player name must be a fixed length string
+ char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
+
+ strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
+ name_new[MAX_PLAYER_NAME_LEN] = '\0';
+
+ if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
+ if (strchr(name_new, ' '))
+ *strchr(name_new, ' ') = '\0';
+
+ return name_new;
+}
+
time_t getFileTimestampEpochSeconds(char *filename)
{
struct stat file_status;
options.execute_command = NULL;
options.special_flags = NULL;
+ options.debug_mode = NULL;
options.mytapes = FALSE;
options.serveronly = FALSE;
int option_len = strlen(option);
if (option_len >= MAX_OPTION_LEN)
- Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
+ FailWithHelp("unrecognized option '%s'", option);
strcpy(option_str, option); // copy argument into buffer
option = option_str;
{
*option_arg++ = '\0'; // cut argument from option
if (*option_arg == '\0') // no argument after '='
- Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
+ FailWithHelp("option '%s' has invalid argument", option_str);
}
option_len = strlen(option);
if (strEqual(option, "-"))
{
- Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
+ FailWithHelp("unrecognized option '%s'", option);
}
else if (strncmp(option, "-help", option_len) == 0)
{
else if (strncmp(option, "-basepath", option_len) == 0)
{
if (option_arg == NULL)
- Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
+ FailWithHelp("option '%s' requires an argument", option_str);
// this should be extended to separate options for ro and rw data
options.ro_base_directory = ro_base_path = getStringCopy(option_arg);
else if (strncmp(option, "-levels", option_len) == 0)
{
if (option_arg == NULL)
- Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
+ FailWithHelp("option '%s' requires an argument", option_str);
options.level_directory = getStringCopy(option_arg);
if (option_arg == next_option)
else if (strncmp(option, "-graphics", option_len) == 0)
{
if (option_arg == NULL)
- Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
+ FailWithHelp("option '%s' requires an argument", option_str);
options.graphics_directory = getStringCopy(option_arg);
if (option_arg == next_option)
else if (strncmp(option, "-sounds", option_len) == 0)
{
if (option_arg == NULL)
- Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
+ FailWithHelp("option '%s' requires an argument", option_str);
options.sounds_directory = getStringCopy(option_arg);
if (option_arg == next_option)
else if (strncmp(option, "-music", option_len) == 0)
{
if (option_arg == NULL)
- Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
+ FailWithHelp("option '%s' requires an argument", option_str);
options.music_directory = getStringCopy(option_arg);
if (option_arg == next_option)
else if (strncmp(option, "-debug", option_len) == 0)
{
options.debug = TRUE;
+
+ // optionally, debug output can be limited to a specific debug mode
+ if (option_arg != next_option)
+ options.debug_mode = getStringCopy(option_arg);
}
else if (strncmp(option, "-verbose", option_len) == 0)
{
else if (strncmp(option, "-execute", option_len) == 0)
{
if (option_arg == NULL)
- Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
+ FailWithHelp("option '%s' requires an argument", option_str);
options.execute_command = getStringCopy(option_arg);
if (option_arg == next_option)
#endif
else if (*option == '-')
{
- Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
+ FailWithHelp("unrecognized option '%s'", option_str);
}
else if (options.server_host == NULL)
{
{
options.server_port = atoi(*options_left);
if (options.server_port < 1024)
- Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
+ FailWithHelp("bad port number '%d'", options.server_port);
}
else
- Error(ERR_EXIT_HELP, "too many arguments");
+ FailWithHelp("too many arguments");
options_left++;
}
}
-// ----------------------------------------------------------------------------
-// error handling functions
-// ----------------------------------------------------------------------------
-
-#define MAX_INTERNAL_ERROR_SIZE 1024
-
-// used by SetError() and GetError() to store internal error messages
-static char internal_error[MAX_INTERNAL_ERROR_SIZE];
-
-void SetError(char *format, ...)
-{
- va_list ap;
-
- va_start(ap, format);
- vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
- va_end(ap);
-}
-
-char *GetError(void)
-{
- return internal_error;
-}
-
-void Error(int mode, char *format, ...)
-{
- static boolean last_line_was_separator = FALSE;
- char *process_name = "";
-
- if (program.log_file[LOG_ERR_ID] == NULL)
- return;
-
-#if defined(PLATFORM_ANDROID)
- android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
- mode & ERR_INFO ? ANDROID_LOG_INFO :
- mode & ERR_WARN ? ANDROID_LOG_WARN :
- mode & ERR_EXIT ? ANDROID_LOG_FATAL :
- ANDROID_LOG_UNKNOWN);
-#endif
-
- // display debug messages only when running in debug mode
- if (mode & ERR_DEBUG && !options.debug)
- return;
-
- // display warnings only when running in verbose mode
- if (mode & ERR_WARN && !options.verbose)
- return;
-
- if (mode == ERR_INFO_LINE)
- {
- if (!last_line_was_separator)
- printf_log_line(format, 79);
-
- last_line_was_separator = TRUE;
-
- return;
- }
-
- last_line_was_separator = FALSE;
-
- if (mode & ERR_SOUND_SERVER)
- process_name = " sound server";
- else if (mode & ERR_NETWORK_SERVER)
- process_name = " network server";
- else if (mode & ERR_NETWORK_CLIENT)
- process_name = " network client **";
-
- if (format)
- {
-#if !defined(PLATFORM_ANDROID)
- printf_log_nonewline("%s%s: ", program.command_basename, process_name);
-#endif
-
- if (mode & ERR_WARN)
- printf_log_nonewline("warning: ");
-
- if (mode & ERR_EXIT)
- printf_log_nonewline("fatal error: ");
-
- va_list ap;
-
- va_start(ap, format);
- vprintf_log(format, ap);
- va_end(ap);
-
- if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
- {
- va_start(ap, format);
- program.exit_message_function(format, ap);
- va_end(ap);
- }
- }
-
- if (mode & ERR_HELP)
- printf_log("%s: Try option '--help' for more information.",
- program.command_basename);
-
- if (mode & ERR_EXIT)
- printf_log("%s%s: aborting", program.command_basename, process_name);
-
- if (mode & ERR_EXIT)
- {
- if (mode & ERR_FROM_SERVER)
- exit(1); // child process: normal exit
- else
- program.exit_function(1); // main process: clean up stuff
- }
-}
-
-
// ----------------------------------------------------------------------------
// checked memory allocation and freeing functions
// ----------------------------------------------------------------------------
ptr = malloc(size);
if (ptr == NULL)
- Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
+ Fail("cannot allocate %d bytes -- out of memory", size);
return ptr;
}
ptr = calloc(1, size);
if (ptr == NULL)
- Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
+ Fail("cannot allocate %d bytes -- out of memory", size);
return ptr;
}
ptr = realloc(ptr, size);
if (ptr == NULL)
- Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
+ Fail("cannot allocate %d bytes -- out of memory", size);
return ptr;
}
}
if (key == KSYM_UNDEFINED)
- Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
+ Warn("getKeyFromKeyName(): not completely implemented");
*keysym = key;
}
while (node)
{
- printf("['%s' (%d)]\n", node->key,
- ((struct ListNodeInfo *)node->content)->num_references);
+ Debug("internal:dumpList", "['%s' (%d)]", node->key,
+ ((struct ListNodeInfo *)node->content)->num_references);
node = node->next;
}
- printf("[%d nodes]\n", getNumNodes(node_first));
+ Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
}
#endif
num_file_list_entries_found = list_pos + 1;
if (num_file_list_entries_found != num_file_list_entries)
{
- Error(ERR_INFO_LINE, "-");
- Error(ERR_INFO, "inconsistant config list information:");
- Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
+ Error("---");
+ Error("inconsistant config list information:");
+ Error("- should be: %d (according to 'src/conf_xxx.h')",
num_file_list_entries);
- Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
+ Error("- found to be: %d (according to 'src/conf_xxx.c')",
num_file_list_entries_found);
- Error(ERR_EXIT, "please fix");
+
+ Fail("please fix");
}
freeSetupFileHash(ignore_tokens_hash);
if (options.debug && dynamic_tokens_found)
{
- Error(ERR_INFO_LINE, "-");
- Error(ERR_INFO, "dynamic token(s) found in config file:");
- Error(ERR_INFO, "- config file: '%s'", filename);
+ Debug("config", "---");
+ Debug("config", "dynamic token(s) found in config file:");
+ Debug("config", "- config file: '%s'", filename);
for (list = setup_file_list; list != NULL; list = list->next)
{
char *value = getHashEntry(extra_file_hash, list->token);
if (value != NULL && strEqual(value, known_token_value))
- Error(ERR_INFO, "- dynamic token: '%s'", list->token);
+ Debug("config", "- dynamic token: '%s'", list->token);
}
- Error(ERR_INFO_LINE, "-");
+ Debug("config", "---");
}
if (unknown_tokens_found)
{
- Error(ERR_INFO_LINE, "-");
- Error(ERR_INFO, "warning: unknown token(s) found in config file:");
- Error(ERR_INFO, "- config file: '%s'", filename);
+ Warn("---");
+ Warn("unknown token(s) found in config file:");
+ Warn("- config file: '%s'", filename);
for (list = setup_file_list; list != NULL; list = list->next)
{
char *value = getHashEntry(extra_file_hash, list->token);
if (value != NULL && !strEqual(value, known_token_value))
- Error(ERR_INFO, "- dynamic token: '%s'", list->token);
+ Warn("- dynamic token: '%s'", list->token);
}
- Error(ERR_INFO_LINE, "-");
+ Warn("---");
}
if (undefined_values_found)
{
- Error(ERR_INFO_LINE, "-");
- Error(ERR_INFO, "warning: undefined values found in config file:");
- Error(ERR_INFO, "- config file: '%s'", filename);
+ Warn("---");
+ Warn("undefined values found in config file:");
+ Warn("- config file: '%s'", filename);
for (list = setup_file_list; list != NULL; list = list->next)
{
char *value = getHashEntry(empty_file_hash, list->token);
if (value != NULL)
- Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
+ Warn("- undefined value for token: '%s'", list->token);
}
- Error(ERR_INFO_LINE, "-");
+ Warn("---");
}
freeSetupFileList(setup_file_list);
if (filename == NULL)
{
- Error(ERR_WARN, "cannot find artwork file '%s'", basename);
+ Warn("cannot find artwork file '%s'", basename);
basename = file_list_entry->default_filename;
if (file_list_entry->default_is_cloned &&
strEqual(basename, UNDEFINED_FILENAME))
{
- int error_mode = ERR_WARN;
+ void (*error_func)(char *, ...) = Warn;
// we can get away without sounds and music, but not without graphics
if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
- error_mode = ERR_EXIT;
+ error_func = Fail;
- Error(error_mode, "token '%s' was cloned and has no default filename",
- file_list_entry->token);
+ error_func("token '%s' was cloned and has no default filename",
+ file_list_entry->token);
return;
}
file_list_entry->fallback_to_default = TRUE;
- Error(ERR_WARN, "trying default artwork file '%s'", basename);
+ Warn("trying default artwork file '%s'", basename);
filename = getCustomArtworkFilename(basename, artwork_info->type);
if (filename == NULL)
{
- int error_mode = ERR_WARN;
+ void (*error_func)(char *, ...) = Warn;
// we can get away without sounds and music, but not without graphics
if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
- error_mode = ERR_EXIT;
+ error_func = Fail;
- Error(error_mode, "cannot find default artwork file '%s'", basename);
+ error_func("cannot find default artwork file '%s'", basename);
return;
}
}
else
{
- int error_mode = ERR_WARN;
+ void (*error_func)(char *, ...) = Warn;
// we can get away without sounds and music, but not without graphics
if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
- error_mode = ERR_EXIT;
+ error_func = Fail;
- Error(error_mode, "cannot load artwork file '%s'", basename);
+ error_func("cannot load artwork file '%s'", basename);
return;
}
char *getLogFilename(char *basename)
{
- return getPath2(getUserGameDataDir(), basename);
+ return getPath2(getMainUserGameDataDir(), basename);
}
void OpenLogFiles(void)
{
int i;
- InitUserDataDirectory();
+ InitMainUserDataDirectory();
for (i = 0; i < NUM_LOGS; i++)
{
{
program.log_file[i] = program.log_file_default[i]; // reset to default
- Error(ERR_WARN, "cannot open file '%s' for writing: %s",
- program.log_filename[i], strerror(errno));
+ Warn("cannot open file '%s' for writing: %s",
+ program.log_filename[i], strerror(errno));
}
// output should be unbuffered so it is not truncated in a crash
#if DEBUG
-#define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
+#define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
#define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
#define DEBUG_NUM_TIMESTAMPS 10
float timestamp_interval;
if (counter_nr < 0)
- Error(ERR_EXIT, "debugging: invalid negative counter");
+ Fail("debugging: invalid negative counter");
else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
- Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
+ Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
#if DEBUG_TIME_IN_MICROSECONDS
static double counter[DEBUG_NUM_TIMESTAMPS][2];
counter[counter_nr][1] = counter[counter_nr][0];
if (message)
- Error(ERR_DEBUG, "%s%s%s %.3f %s",
- debug_print_timestamp_get_padding(counter_nr * indent_size),
- message,
- debug_print_timestamp_get_padding(padding_size - strlen(message)),
- timestamp_interval / 1000,
- unit);
+ Debug("time:init", "%s%s%s %.3f %s",
+ debug_print_timestamp_get_padding(counter_nr * indent_size),
+ message,
+ debug_print_timestamp_get_padding(padding_size - strlen(message)),
+ timestamp_interval / 1000,
+ unit);
}
#if 0
projects / rocksndiamonds.git / blobdiff