This module provides the C level error handling functionality for
Imager.
-A few functions return or pass in a char **, this is a NULL terminated
-list of pointers to error messages (which are NUL terminated strings,
-just as it normal in C :). Even though these aren't passed as char
-const * const * pointers, don't modify the strings or the pointers.
+A few functions return or pass in an i_errmsg *, this is list of error
+structures, terminated by an entry with a NULL msg value, each of
+which contains a msg and an error code. Even though these aren't
+passed as i_errmsg const * pointers, don't modify the strings
+or the pointers.
The interface as currently defined isn't thread safe, unfortunately.
=cut
*/
-#include "image.h"
+#include "imager.h"
#include <stdio.h>
#include <stdlib.h>
/* we never actually use the last item - it's the NULL terminator */
#define ERRSTK 20
-char *error_stack[ERRSTK];
-int error_sp = ERRSTK - 1;
+static i_errmsg error_stack[ERRSTK];
+static int error_sp = ERRSTK - 1;
/* we track the amount of space used each string, so we don't reallocate
space unless we need to.
This also means that a memory tracking library may see the memory
allocated for this as a leak. */
-int error_space[ERRSTK];
+static int error_space[ERRSTK];
static i_error_cb error_cb;
static i_failed_cb failed_cb;
when your program starts.
*/
void i_set_argv0(char const *name) {
+ char *dupl;
if (!name)
return;
- char *dupl = mymalloc(strlen(name)+1);
+ /* if the user has an existing string of MAXINT length then
+ the system is broken anyway */
+ dupl = mymalloc(strlen(name)+1); /* check 17jul05 tonyc */
strcpy(dupl, name);
if (argv0)
myfree(argv0);
=cut
*/
-char **i_errors() {
+i_errmsg *i_errors() {
return error_stack + error_sp;
}
=over
=item i_clear_error()
+=synopsis i_clear_error();
+=category Error handling
-Called by any imager function before doing any other processing.
+Clears the error stack.
-=cut */
+Called by any Imager function before doing any other processing.
+
+=cut
+*/
void i_clear_error() {
+#ifdef IMAGER_DEBUG_MALLOC
+ int i;
+
+ for (i = 0; i < ERRSTK; ++i) {
+ if (error_space[i]) {
+ myfree(error_stack[i].msg);
+ error_stack[i].msg = NULL;
+ error_space[i] = 0;
+ }
+ }
+#endif
error_sp = ERRSTK-1;
}
/*
-=item i_push_error(char const *msg)
+=item i_push_error(int code, char const *msg)
+=synopsis i_push_error(0, "Yep, it's broken");
+=synopsis i_push_error(errno, "Error writing");
+=category Error handling
-Called by an imager function to push an error message onto the stack.
+Called by an Imager function to push an error message onto the stack.
No message is pushed if the stack is full (since this means someone
forgot to call i_clear_error(), or that a function that doesn't do
=cut
*/
-void i_push_error(char const *msg) {
- int size = strlen(msg)+1;
+void i_push_error(int code, char const *msg) {
+ size_t size = strlen(msg)+1;
if (error_sp <= 0)
/* bad, bad programmer */
--error_sp;
if (error_space[error_sp] < size) {
- if (error_stack[error_sp])
- myfree(error_stack[error_sp]);
- /* memory allocated on the following line is only ever release when
+ if (error_stack[error_sp].msg)
+ myfree(error_stack[error_sp].msg);
+ /* memory allocated on the following line is only ever released when
we need a bigger string */
- error_stack[error_sp] = mymalloc(size);
+ /* size is size (len+1) of an existing string, overflow would mean
+ the system is broken anyway */
+ error_stack[error_sp].msg = mymalloc(size); /* checked 17jul05 tonyc */
error_space[error_sp] = size;
}
- strcpy(error_stack[error_sp], msg);
+ strcpy(error_stack[error_sp].msg, msg);
+ error_stack[error_sp].code = code;
if (error_cb)
- error_cb(msg);
+ error_cb(code, msg);
+}
+
+/*
+=item i_push_errorvf(int C<code>, char const *C<fmt>, va_list C<ap>)
+
+=category Error handling
+
+Intended for use by higher level functions, takes a varargs pointer
+and a format to produce the finally pushed error message.
+
+Does not support perl specific format codes.
+
+=cut
+*/
+void i_push_errorvf(int code, char const *fmt, va_list ap) {
+ char buf[1024];
+#if defined(_MSC_VER)
+ _vsnprintf(buf, sizeof(buf), fmt, ap);
+#else
+ /* is there a way to detect vsnprintf()?
+ for this and other functions we need some mechanism to handle
+ detection (like perl's Configure, or autoconf)
+ */
+ vsprintf(buf, fmt, ap);
+#endif
+ i_push_error(code, buf);
}
+/*
+=item i_push_errorf(int code, char const *fmt, ...)
+=synopsis i_push_errorf(errno, "Cannot open file %s: %d", filename, errno);
+=category Error handling
+
+A version of i_push_error() that does printf() like formatting.
+
+Does not support perl specific format codes.
+
+=cut
+*/
+void i_push_errorf(int code, char const *fmt, ...) {
+ va_list ap;
+ va_start(ap, fmt);
+ i_push_errorvf(code, fmt, ap);
+ va_end(ap);
+}
+
+#ifdef IMAGER_I_FAILED
+#error "This isn't used and is untested"
+
/*
=item i_failed(char const *msg)
Called by Imager code to indicate that a top-level has failed.
-msg can be NULL.
+msg can be NULL, in which case no error is pushed.
Calls the current failed callback, if any.
=cut
*/
-int i_failed(char const *msg) {
+int i_failed(int code, char const *msg) {
if (msg)
- i_push_error(msg);
+ i_push_error(code, msg);
if (failed_cb)
failed_cb(error_stack + error_sp);
if (failures_fatal) {
+ int sp;
+ size_t total; /* total length of error messages */
+ char *full; /* full message for logging */
if (argv0)
fprintf(stderr, "%s: ", argv0);
fputs("error:\n", stderr);
- while (error_stack[error_sp]) {
- fprintf(stderr, " %s\n", error_stack[error_sp]);
- ++error_sp;
+ sp = error_sp;
+ while (error_stack[sp].msg) {
+ fprintf(stderr, " %s\n", error_stack[sp].msg);
+ ++sp;
}
- exit(EXIT_FAILURE);
+ /* we want to log the error too, build an error message to hand to
+ i_fatal() */
+ total = 1; /* remember the NUL */
+ for (sp = error_sp; error_stack[sp].msg; ++sp) {
+ size_t new_total += strlen(error_stack[sp].msg) + 2;
+ if (new_total < total) {
+ /* overflow, somehow */
+ break;
+ }
+ }
+ full = mymalloc(total);
+ if (!full) {
+ /* just quit, at least it's on stderr */
+ exit(EXIT_FAILURE);
+ }
+ *full = 0;
+ for (sp = error_sp; error_stack[sp].msg; ++sp) {
+ strcat(full, error_stack[sp].msg);
+ strcat(full, ": ");
+ }
+ /* lose the extra ": " */
+ full[strlen(full)-2] = '\0';
+ i_fatal(EXIT_FAILURE, "%s", full);
}
return 0;
}
+#endif
+
+/*
+=item im_assert_fail(file, line, message)
+
+Called when an im_assert() assertion fails.
+
+=cut
+*/
+
+void
+im_assert_fail(char const *file, int line, char const *message) {
+ fprintf(stderr, "Assertion failed line %d file %s: %s\n",
+ line, file, message);
+ exit(EXIT_FAILURE);
+}
+
/*
=back
projects / imager.git / blobdiff