]> wimlib.net Git - wimlib/blobdiff - src/util.h
Improve char encoding support (IN PROGRESS)
[wimlib] / src / util.h
index 08b15636acdcc66ae0c440755bfc45bf276ec13e..71590ffe2dde2d1674e7709c4b24f1765adeff54 100644 (file)
@@ -9,7 +9,11 @@
 #include "config.h"
 
 #ifdef __GNUC__
-#      define WIMLIBAPI __attribute__((visibility("default")))
+#      if defined(__CYGWIN__) || defined(__WIN32__)
+#              define WIMLIBAPI __declspec(dllexport)
+#      else
+#              define WIMLIBAPI __attribute__((visibility("default")))
+#      endif
 #      define ALWAYS_INLINE inline __attribute__((always_inline))
 #      define PACKED __attribute__((packed))
 #      define FORMAT(type, format_str, args_start) \
@@ -44,7 +48,24 @@ typedef uint16_t u16;
 typedef uint32_t u32;
 typedef uint64_t u64;
 #endif
-typedef unsigned uint;
+
+/* A pointer to 'mbchar' indicates a string of "multibyte characters" provided
+ * in the default encoding of the user's locale, which may be "UTF-8",
+ * "ISO-8859-1", "C", or any other ASCII-compatible encoding.
+ * "ASCII-compatible" here means any encoding where all ASCII characters have
+ * the same representation, and any non-ASCII character is represented as a
+ * sequence of one or more bytes not already used by any ASCII character. */
+typedef char mbchar;
+
+/* A pointer to 'utf8char' indicates a UTF-8 encoded string */
+typedef char utf8char;
+
+/* Note: in some places in the code, strings of plain old 'char' are still used.
+ * This means that the string is being operated on in an ASCII-compatible way,
+ * and may be either a multibyte or UTF-8 string.  */
+
+/* A pointer to 'utf16lechar' indicates a UTF-16LE encoded string */
+typedef u16 utf16lechar;
 
 #ifndef min
 #define min(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
@@ -86,21 +107,32 @@ typedef unsigned uint;
 /* Used for buffering FILE IO in a few places */
 #define BUFFER_SIZE 4096
 
+static inline void FORMAT(printf, 1, 2)
+dummy_printf(const char *format, ...)
+{
+}
+
 #ifdef ENABLE_ERROR_MESSAGES
-extern bool __wimlib_print_errors;
-extern void wimlib_error(const char *format, ...)
-               FORMAT(printf, 1, 2) COLD;
-extern void wimlib_error_with_errno(const char *format, ...)
-               FORMAT(printf, 1, 2) COLD;
-extern void wimlib_warning(const char *format, ...)
-               FORMAT(printf, 1, 2) COLD;
-#      define ERROR            wimlib_error
-#      define ERROR_WITH_ERRNO wimlib_error_with_errno
-#      define WARNING          wimlib_warning
+extern void
+wimlib_error(const char *format, ...) FORMAT(printf, 1, 2) COLD;
+
+extern void
+wimlib_error_with_errno(const char *format, ...) FORMAT(printf, 1, 2) COLD;
+
+extern void
+wimlib_warning(const char *format, ...) FORMAT(printf, 1, 2) COLD;
+
+extern void
+wimlib_warning_with_errno(const char *format, ...) FORMAT(printf, 1, 2) COLD;
+#      define ERROR                    wimlib_error
+#      define ERROR_WITH_ERRNO         wimlib_error_with_errno
+#      define WARNING                  wimlib_warning
+#      define WARNING_WITH_ERRNO       wimlib_warning
 #else
-#      define ERROR(format, ...)
-#      define ERROR_WITH_ERRNO(format, ...)
-#      define WARNING(format, ...)
+#      define ERROR(format, ...)               dummy_printf(format, ## __VA_ARGS__)
+#      define ERROR_WITH_ERRNO(format, ...)    dummy_printf(format, ## __VA_ARGS__)
+#      define WARNING(format, ...)             dummy_printf(format, ## __VA_ARGS__)
+#      define WARNING_WITH_ERRNO(format, ...)  dummy_printf(format, ## __VA_ARGS__)
 #endif /* ENABLE_ERROR_MESSAGES */
 
 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
@@ -108,7 +140,7 @@ extern void wimlib_warning(const char *format, ...)
 #      define DEBUG(format, ...)                                       \
        ({                                                              \
                int __errno_save = errno;                               \
-               fprintf(stdout, "[%s %d] %s(): " format,                \
+               wimlib_fprintf(stdout, "[%s %d] %s(): " format,         \
                        __FILE__, __LINE__, __func__, ## __VA_ARGS__);  \
                putchar('\n');                                          \
                fflush(stdout);                                         \
@@ -116,13 +148,13 @@ extern void wimlib_warning(const char *format, ...)
        })
 
 #else
-#      define DEBUG(format, ...)
+#      define DEBUG(format, ...) dummy_printf(format, ## __VA_ARGS__)
 #endif /* ENABLE_DEBUG || ENABLE_MORE_DEBUG */
 
 #ifdef ENABLE_MORE_DEBUG
 #      define DEBUG2(format, ...) DEBUG(format, ## __VA_ARGS__)
 #else
-#      define DEBUG2(format, ...)
+#      define DEBUG2(format, ...) dummy_printf(format, ## __VA_ARGS__)
 #endif /* ENABLE_DEBUG */
 
 #ifdef ENABLE_ASSERTIONS
@@ -132,6 +164,13 @@ extern void wimlib_warning(const char *format, ...)
 #      define wimlib_assert(expr)
 #endif
 
+#ifdef ENABLE_MORE_ASSERTIONS
+#define wimlib_assert2(expr) wimlib_assert(expr)
+#else
+#define wimlib_assert2(expr)
+#endif
+
+#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
 
 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
 extern void *(*wimlib_malloc_func)(size_t);
@@ -155,38 +194,40 @@ extern char *wimlib_strdup(const char *str);
 #endif /* ENABLE_CUSTOM_MEMORY_ALLOCATOR */
 
 
-/* encoding.c */
-extern int utf16_to_utf8(const char *utf16_str, size_t utf16_nbytes,
-                        char **utf8_str_ret, size_t *utf8_nbytes_ret);
-
-extern int utf8_to_utf16(const char *utf8_str, size_t utf8_nbytes,
-                        char **utf16_str_ret, size_t *utf16_nbytes_ret);
-
 /* util.c */
-extern void randomize_byte_array(u8 *p, size_t n);
+extern void
+randomize_byte_array(u8 *p, size_t n);
 
-extern void randomize_char_array_with_alnum(char p[], size_t n);
+extern void
+randomize_char_array_with_alnum(char p[], size_t n);
 
-extern const char *path_next_part(const char *path,
-                                 size_t *first_part_len_ret);
+extern const char *
+path_next_part(const char *path, size_t *first_part_len_ret);
 
-extern const char *path_basename(const char *path);
+extern const char *
+path_basename(const char *path);
 
-extern const char *path_stream_name(const char *path);
+extern const char *
+path_stream_name(const char *path);
 
-extern void to_parent_name(char buf[], size_t len);
+extern void
+to_parent_name(char buf[], size_t len);
 
-extern void print_string(const void *string, size_t len);
+extern void
+print_string(const void *string, size_t len);
 
-extern int get_num_path_components(const char *path);
+extern int
+get_num_path_components(const char *path);
 
-static inline void print_byte_field(const u8 field[], size_t len)
+static inline void
+print_byte_field(const u8 field[], size_t len)
 {
        while (len--)
                printf("%02hhx", *field++);
 }
 
-static inline u32 bsr32(u32 n)
+static inline u32
+bsr32(u32 n)
 {
 #if defined(__x86__) || defined(__x86_64__)
        asm("bsrl %0, %0;"
@@ -201,4 +242,10 @@ static inline u32 bsr32(u32 n)
 #endif
 }
 
+extern int
+wimlib_fprintf(FILE *fp, const char *format, ...) FORMAT(printf, 2, 3);
+
+extern int
+wimlib_printf(const char *format, ...) FORMAT(printf, 1, 2);
+
 #endif /* _WIMLIB_UTIL_H */