/**
* @file log.c
- * @purpose Implement logging and error handling functions
+ * @brief Implement logging and error handling functions
*/
#include <unistd.h>
+#include <stdarg.h>
// --- Custom headers --- //
+#include "common.h"
#include "log.h"
#include "options.h"
// --- Static variables --- //
-static char * unspecified_funct = (char*)"???";
+static const char * unspecified_funct = "???";
// --- Function implementations --- //
+//TODO: Migrate to syslog (shouldn't be too hard; these functions basically do what syslog does)
+// Note that we will want to have a seperate log as well as syslog; give the user the option to view the log using the GUI
+
/**
- * @funct Log
- * @purpose Print a message to stderr
+ * Print a message to stderr
* @param level - Specify how severe the message is.
If level is higher (less urgent) than the program's verbosity (see options.h) no message will be printed
* @param funct - String indicating the function name from which this function was called.
* @param fmt - A format string
* @param ... - Arguments to be printed according to the format string
*/
-void Log(int level, char * funct, char * fmt, ...)
+void LogEx(int level, const char * funct, ...)
{
+ const char *fmt;
+ va_list va;
+ va_start(va, funct);
+ fmt = va_arg(va, const char*);
+
if (fmt == NULL) // sanity check
- Fatal("Log", "Format string is NULL");
+ FatalEx("Log", "Format string is NULL");
// Don't print the message unless we need to
- if (level > g_options.verbosity)
+ if (level > g_options.verbosity)
return;
if (funct == NULL)
funct = unspecified_funct;
// Make a human readable severity string
- char severity[BUFSIZ];
+ const char *severity;
switch (level)
{
case LOGERR:
- sprintf(severity, "ERROR");
+ severity = "ERROR";
break;
case LOGWARN:
- sprintf(severity, "WARNING");
+ severity = "WARNING";
break;
case LOGNOTE:
- sprintf(severity, "NOTICE");
+ severity = "NOTICE";
break;
case LOGINFO:
- sprintf(severity, "INFO");
+ severity = "INFO";
break;
default:
- sprintf(severity, "DEBUG");
+ severity = "DEBUG";
break;
}
fprintf(stderr, "%s [%d] : %s : %s - ", g_options.program, getpid(), severity, funct);
// Then pass additional arguments with the format string to vfprintf for printing
- va_list va;
- va_start(va, fmt);
vfprintf(stderr, fmt, va);
va_end(va);
}
/**
- * @funct Fatal
- * @purpose Handle a Fatal error in the program by printing a message and exiting the program
- CALLING THIS FUNCTION WILL CAUSE THE PROGAM TO EXIT
+ * Handle a Fatal error in the program by printing a message and exiting the program
+ * CALLING THIS FUNCTION WILL CAUSE THE PROGAM TO EXIT
* @param funct - Name of the calling function
* @param fmt - A format string
* @param ... - Arguments to be printed according to the format string
*/
-void Fatal(char * funct, char * fmt, ...)
+void FatalEx(const char * funct, ...)
{
+ const char *fmt;
+ va_list va;
+ va_start(va, funct);
+ fmt = va_arg(va, const char*);
if (fmt == NULL)
{
// Fatal error in the Fatal function.
// (This really shouldn't happen unless someone does something insanely stupid)
- Fatal("Fatal", "Format string is NULL");
+ FatalEx("Fatal", "Format string is NULL");
return; // Should never get here
}
fprintf(stderr, "%s [%d] : %s : FATAL - ", g_options.program, getpid(), funct);
- va_list va;
- va_start(va, fmt);
vfprintf(stderr, fmt, va);
va_end(va);
fprintf(stderr, "\n");