]> wimlib.net Git - wimlib/blobdiff - src/util.c
Win32 fixes
[wimlib] / src / util.c
index e8e3a37b50b636e0c73737a03fd8609272de4a00..20bff9590bf9578864a48ece46f941c120853a27 100644 (file)
@@ -3,7 +3,7 @@
  */
 
 /*
- * Copyright (C) 2012 Eric Biggers
+ * Copyright (C) 2012, 2013 Eric Biggers
  *
  * This file is part of wimlib, a library for working with WIM files.
  *
  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
+#include "config.h"
+
+#define MINGW_HAS_SECURE_API
+
+#undef _GNU_SOURCE
+/* Make sure the POSIX-compatible strerror_r() is declared, rather than the GNU
+ * version, which has a different return type. */
+#define _POSIX_C_SOURCE 200112
+#include <string.h>
+#define _GNU_SOURCE
+
 #include "wimlib_internal.h"
 #include "endianness.h"
 #include "timestamp.h"
 #include <ctype.h>
 #include <errno.h>
 #include <stdlib.h>
-#include <string.h>
+#include <stdarg.h>
+
 #include <unistd.h> /* for getpid() */
 
-/* True if wimlib is to print an informational message when an error occurs.
- * This can be turned off by calling wimlib_set_print_errors(false). */
-#ifdef ENABLE_ERROR_MESSAGES
-#include <stdarg.h>
-bool __wimlib_print_errors = false;
+/* Windoze compatibility */
+#ifdef __WIN32__
+#  define strerror_r(errnum, buf, bufsize) strerror_s(buf, bufsize, errnum)
+#endif
 
-void wimlib_error(const char *format, ...)
+size_t
+utf16le_strlen(const utf16lechar *s)
 {
-       if (__wimlib_print_errors) {
-               va_list va;
-               int errno_save;
-
-               va_start(va, format);
-               errno_save = errno;
-               fputs("[ERROR] ", stderr);
-               vfprintf(stderr, format, va);
-               putc('\n', stderr);
-               errno = errno_save;
-               va_end(va);
+       const utf16lechar *p = s;
+       while (*p)
+               p++;
+       return (p - s) * sizeof(utf16lechar);
+}
+
+/* Handle %W for UTF16-LE printing and %U for UTF-8 printing.
+ *
+ * TODO: this is not yet done properly--- it's assumed that if the format string
+ * contains %W and/or %U, then it contains no other format specifiers.
+ */
+static int
+wimlib_vfprintf(FILE *fp, const char *format, va_list va)
+{
+       const char *p;
+
+       for (p = format; *p; p++)
+               if (*p == '%' && (*(p + 1) == 'W' || *(p + 1) == 'U'))
+                       goto special;
+       return vfprintf(fp, format, va);
+special:
+       ;
+       int n = 0;
+       for (p = format; *p; p++) {
+               if (*p == '%' && (*(p + 1) == 'W' || *(p + 1) == 'U')) {
+                       int ret;
+                       mbchar *mbs;
+                       size_t mbs_nbytes;
+
+                       if (*(p + 1) == 'W') {
+                               utf16lechar *ucs = va_arg(va, utf16lechar*);
+                               size_t ucs_nbytes = utf16le_strlen(ucs);
+                               ret = utf16le_to_mbs(ucs, ucs_nbytes,
+                                                    &mbs, &mbs_nbytes);
+                       } else {
+                               utf8char *ucs = va_arg(va, utf8char*);
+                               size_t ucs_nbytes = strlen(ucs);
+                               ret = utf8_to_mbs(ucs, ucs_nbytes,
+                                                 &mbs, &mbs_nbytes);
+                       }
+                       if (ret) {
+                               ret = fprintf(fp, "???CONVERSION FAILURE???");
+                       } else {
+                               ret = fprintf(fp, "%s", mbs);
+                               FREE(mbs);
+                       }
+                       if (ret < 0)
+                               return -1;
+                       else
+                               n += ret;
+                       p++;
+               } else {
+                       if (putc(*p, fp) == EOF)
+                               return -1;
+                       n++;
+               }
        }
+       return n;
 }
 
-void wimlib_error_with_errno(const char *format, ...)
+int
+wimlib_printf(const char *format, ...)
 {
-       if (__wimlib_print_errors) {
-               va_list va;
-               int errno_save;
+       int ret;
+       va_list va;
 
-               va_start(va, format);
-               errno_save = errno;
-               fflush(stdout);
-               fputs("[ERROR] ", stderr);
-               vfprintf(stderr, format, va);
-               if (errno_save != 0)
-                       fprintf(stderr, ": %s", strerror(errno_save));
-               putc('\n', stderr);
-               errno = errno_save;
-               va_end(va);
-       }
+       va_start(va, format);
+       ret = wimlib_vfprintf(stdout, format, va);
+       va_end(va);
+       return ret;
 }
 
-void wimlib_warning(const char *format, ...)
+int
+wimlib_fprintf(FILE *fp, const char *format, ...)
 {
-       if (__wimlib_print_errors) {
-               va_list va;
-               int errno_save;
+       int ret;
+       va_list va;
+
+       va_start(va, format);
+       ret = wimlib_vfprintf(fp, format, va);
+       va_end(va);
+       return ret;
+}
 
-               va_start(va, format);
-               errno_save = errno;
+#if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG)
+static void
+wimlib_vmsg(const char *tag, const char *format,
+           va_list va, bool perror)
+{
+#ifndef DEBUG
+       if (wimlib_print_errors) {
+#endif
+               int errno_save = errno;
                fflush(stdout);
-               fputs("[WARNING] ", stderr);
-               vfprintf(stderr, format, va);
+               fputs(tag, stderr);
+               wimlib_vfprintf(stderr, format, va);
+               if (perror && errno_save != 0) {
+                       char buf[50];
+                       int res;
+                       res = strerror_r(errno_save, buf, sizeof(buf));
+                       if (res) {
+                               snprintf(buf, sizeof(buf),
+                                        "unknown error (errno=%d)", errno_save);
+                       }
+                       fprintf(stderr, ": %s", buf);
+               }
                putc('\n', stderr);
                errno = errno_save;
-               va_end(va);
+#ifndef DEBUG
        }
+#endif
+}
+#endif
+
+/* True if wimlib is to print an informational message when an error occurs.
+ * This can be turned off by calling wimlib_set_print_errors(false). */
+#ifdef ENABLE_ERROR_MESSAGES
+static bool wimlib_print_errors = false;
+
+
+void
+wimlib_error(const char *format, ...)
+{
+       va_list va;
+
+       va_start(va, format);
+       wimlib_vmsg("[ERROR] ", format, va, false);
+       va_end(va);
+}
+
+void
+wimlib_error_with_errno(const char *format, ...)
+{
+       va_list va;
+
+       va_start(va, format);
+       wimlib_vmsg("[ERROR] ", format, va, true);
+       va_end(va);
+}
+
+void
+wimlib_warning(const char *format, ...)
+{
+       va_list va;
+
+       va_start(va, format);
+       wimlib_vmsg("[WARNING] ", format, va, false);
+       va_end(va);
 }
 
+void
+wimlib_warning_with_errno(const char *format, ...)
+{
+       va_list va;
+
+       va_start(va, format);
+       wimlib_vmsg("[WARNING] ", format, va, true);
+       va_end(va);
+}
+
+#endif
+
+#ifdef ENABLE_DEBUG
+void wimlib_debug(const char *file, int line, const char *func,
+                 const char *format, ...)
+{
+
+       va_list va;
+       char buf[strlen(file) + strlen(func) + 30];
+
+       sprintf(buf, "[%s %d] %s(): ", file, line, func);
+       va_start(va, format);
+       wimlib_vmsg(buf, format, va, false);
+       va_end(va);
+}
 #endif
 
-WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages)
+WIMLIBAPI int
+wimlib_set_print_errors(bool show_error_messages)
 {
 #ifdef ENABLE_ERROR_MESSAGES
-       __wimlib_print_errors = show_error_messages;
+       wimlib_print_errors = show_error_messages;
        return 0;
 #else
        if (show_error_messages)
@@ -104,7 +242,7 @@ WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages)
 #endif
 }
 
-static const char *error_strings[] = {
+static const mbchar *error_strings[] = {
        [WIMLIB_ERR_SUCCESS]
                = "Success",
        [WIMLIB_ERR_ALREADY_LOCKED]
@@ -124,6 +262,9 @@ static const char *error_strings[] = {
        [WIMLIB_ERR_FUSERMOUNT]
                = "Could not execute the `fusermount' program, or it exited "
                        "with a failure status",
+       [WIMLIB_ERR_ICONV_NOT_AVAILABLE]
+               = "The iconv() function does not seem to work. "
+                 "Maybe check to make sure the directory /usr/lib/gconv exists",
        [WIMLIB_ERR_IMAGE_COUNT]
                = "Inconsistent image count among the metadata "
                        "resources, the WIM header, and/or the XML data",
@@ -149,17 +290,20 @@ static const char *error_strings[] = {
                = "The WIM's integrity table is invalid",
        [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
                = "An entry in the WIM's lookup table is invalid",
+       [WIMLIB_ERR_INVALID_MULTIBYTE_STRING]
+               = "A string was not valid in the current locale's character encoding",
+       [WIMLIB_ERR_INVALID_OVERLAY]
+               = "Conflicting files in overlay when creating a WIM image",
        [WIMLIB_ERR_INVALID_PARAM]
                = "An invalid parameter was given",
        [WIMLIB_ERR_INVALID_PART_NUMBER]
                = "The part number or total parts of the WIM is invalid",
        [WIMLIB_ERR_INVALID_RESOURCE_HASH]
                = "The SHA1 message digest of a WIM resource did not match the expected value",
-       [WIMLIB_ERR_ICONV_NOT_AVAILABLE]
-               = "The iconv() function does not seem to work. "
-                 "Maybe check to make sure the directory /usr/lib/gconv exists",
        [WIMLIB_ERR_INVALID_RESOURCE_SIZE]
                = "A resource entry in the WIM has an invalid size",
+       [WIMLIB_ERR_INVALID_SECURITY_DATA]
+               = "The table of security descriptors in the WIM is invalid",
        [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE]
                = "The version of wimlib that has mounted a WIM image is incompatible with the "
                  "version being used to unmount it",
@@ -210,6 +354,10 @@ static const char *error_strings[] = {
                = "The WIM is part of a split WIM, which is not supported for this operation",
        [WIMLIB_ERR_STAT]
                = "Could not read the metadata for a file or directory",
+       [WIMLIB_ERR_TIMEOUT]
+               = "Timed out while waiting for a message to arrive from another process",
+       [WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE]
+               = "A Unicode string could not be represented in the current locale's encoding",
        [WIMLIB_ERR_UNKNOWN_VERSION]
                = "The WIM file is marked with an unknown version number",
        [WIMLIB_ERR_UNSUPPORTED]
@@ -220,9 +368,10 @@ static const char *error_strings[] = {
                = "The XML data of the WIM is invalid",
 };
 
-WIMLIBAPI const char *wimlib_get_error_string(enum wimlib_error_code code)
+WIMLIBAPI const mbchar *
+wimlib_get_error_string(enum wimlib_error_code code)
 {
-       if (code < WIMLIB_ERR_SUCCESS || code > WIMLIB_ERR_XML)
+       if (code < 0 || code >= ARRAY_LEN(error_strings))
                return NULL;
        else
                return error_strings[code];
@@ -235,7 +384,8 @@ void *(*wimlib_malloc_func) (size_t)             = malloc;
 void  (*wimlib_free_func)   (void *)        = free;
 void *(*wimlib_realloc_func)(void *, size_t) = realloc;
 
-void *wimlib_calloc(size_t nmemb, size_t size)
+void *
+wimlib_calloc(size_t nmemb, size_t size)
 {
        size_t total_size = nmemb * size;
        void *p = MALLOC(total_size);
@@ -244,7 +394,8 @@ void *wimlib_calloc(size_t nmemb, size_t size)
        return p;
 }
 
-char *wimlib_strdup(const char *str)
+char *
+wimlib_strdup(const char *str)
 {
        size_t size;
        char *p;
@@ -256,14 +407,16 @@ char *wimlib_strdup(const char *str)
        return p;
 }
 
-extern void xml_set_memory_allocator(void *(*malloc_func)(size_t),
-                                  void (*free_func)(void *),
-                                  void *(*realloc_func)(void *, size_t));
+extern void
+xml_set_memory_allocator(void *(*malloc_func)(size_t),
+                        void (*free_func)(void *),
+                        void *(*realloc_func)(void *, size_t));
 #endif
 
-WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
-                                          void (*free_func)(void *),
-                                          void *(*realloc_func)(void *, size_t))
+WIMLIBAPI int
+wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
+                           void (*free_func)(void *),
+                           void *(*realloc_func)(void *, size_t))
 {
 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
        wimlib_malloc_func  = malloc_func  ? malloc_func  : malloc;
@@ -283,14 +436,16 @@ WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
 
 static bool seeded = false;
 
-static void seed_random()
+static void
+seed_random()
 {
        srand(time(NULL) * getpid());
        seeded = true;
 }
 
 /* Fills @n bytes pointed to by @p with random alphanumeric characters. */
-void randomize_char_array_with_alnum(char p[], size_t n)
+void
+randomize_char_array_with_alnum(char p[], size_t n)
 {
        if (!seeded)
                seed_random();
@@ -306,7 +461,8 @@ void randomize_char_array_with_alnum(char p[], size_t n)
 }
 
 /* Fills @n bytes pointer to by @p with random numbers. */
-void randomize_byte_array(u8 *p, size_t n)
+void
+randomize_byte_array(u8 *p, size_t n)
 {
        if (!seeded)
                seed_random();
@@ -316,7 +472,8 @@ void randomize_byte_array(u8 *p, size_t n)
 
 /* Takes in a path of length @len in @buf, and transforms it into a string for
  * the path of its parent directory. */
-void to_parent_name(char buf[], size_t len)
+void
+to_parent_name(char buf[], size_t len)
 {
        ssize_t i = (ssize_t)len - 1;
        while (i >= 0 && buf[i] == '/')
@@ -330,7 +487,8 @@ void to_parent_name(char buf[], size_t len)
 
 /* Like the basename() function, but does not modify @path; it just returns a
  * pointer to it. */
-const char *path_basename(const char *path)
+const char *
+path_basename(const char *path)
 {
        const char *p = path;
        while (*p)
@@ -356,7 +514,8 @@ const char *path_basename(const char *path)
  * Returns a pointer to the part of @path following the first colon in the last
  * path component, or NULL if the last path component does not contain a colon.
  */
-const char *path_stream_name(const char *path)
+const char *
+path_stream_name(const char *path)
 {
        const char *base = path_basename(path);
        const char *stream_name = strchr(base, ':');
@@ -377,7 +536,8 @@ const char *path_stream_name(const char *path)
  *                             sequence of '/', or a pointer to the terminating
  *                             null byte in the case of a path without any '/'.
  */
-const char *path_next_part(const char *path, size_t *first_part_len_ret)
+const char *
+path_next_part(const char *path, size_t *first_part_len_ret)
 {
        size_t i;
        const char *next_part;
@@ -394,7 +554,8 @@ const char *path_next_part(const char *path, size_t *first_part_len_ret)
 }
 
 /* Returns the number of components of @path.  */
-int get_num_path_components(const char *path)
+int
+get_num_path_components(const char *path)
 {
        int num_components = 0;
        while (*path) {
@@ -413,7 +574,8 @@ int get_num_path_components(const char *path)
  * Prints a string.  Printable characters are printed as-is, while unprintable
  * characters are printed as their octal escape codes.
  */
-void print_string(const void *string, size_t len)
+void
+print_string(const void *string, size_t len)
 {
        const u8 *p = string;
 
@@ -426,14 +588,16 @@ void print_string(const void *string, size_t len)
        }
 }
 
-u64 get_wim_timestamp()
+u64
+get_wim_timestamp()
 {
        struct timeval tv;
        gettimeofday(&tv, NULL);
-       return timeval_to_wim_timestamp(&tv);
+       return timeval_to_wim_timestamp(tv);
 }
 
-void wim_timestamp_to_str(u64 timestamp, char *buf, size_t len)
+void
+wim_timestamp_to_str(u64 timestamp, char *buf, size_t len)
 {
        struct tm tm;
        time_t t = wim_timestamp_to_unix(timestamp);