X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=include%2Fwimlib%2Futil.h;h=40f6294e3d80e232832228e4968bc1e71ce948a2;hp=0aa40d1bbdfe9208bd24cbbd5376a0b02cec66d3;hb=f1c07e953597e3f6a809d35d7d5160af1ff67ed3;hpb=9df357d0ac3ac1f5386873dd20df2639cecd64b3

diff --git a/include/wimlib/util.h b/include/wimlib/util.h
index 0aa40d1b..40f6294e 100644
--- a/include/wimlib/util.h
+++ b/include/wimlib/util.h
@@ -1,60 +1,61 @@
+/*
+ * util.h - utility functions and macros
+ */
 #ifndef _WIMLIB_UTIL_H
 #define _WIMLIB_UTIL_H
 
-#include "wimlib/types.h"
 #include "wimlib/compiler.h"
+#include "wimlib/types.h"
 
-#include <stdio.h>
+/****************
+ * General macros
+ *****************/
 
-/**
- * container_of - cast a member of a structure out to the containing structure
- * @ptr:	the pointer to the member.
- * @type:	the type of the container struct this is embedded in.
- * @member:	the name of the member within the struct.
- *
- */
-#ifndef container_of
-#define container_of(ptr, type, member) ({			\
-	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
-	(type *)( (char *)__mptr - offsetof(type,member) );})
-#endif
+/* Cast a pointer to a struct member to a pointer to the containing struct.  */
+#define container_of(ptr, type, member) \
+	((type *)((char *)(ptr) - offsetof(type, member)))
 
-#define DIV_ROUND_UP(numerator, denominator) \
-	(((numerator) + (denominator) - 1) / (denominator))
+/* Calculate 'n / d', but round up instead of down.  */
+#define DIV_ROUND_UP(n, d)	(((n) + (d) - 1) / (d))
 
-#define MODULO_NONZERO(numerator, denominator) \
-	(((numerator) % (denominator)) ? ((numerator) % (denominator)) : (denominator))
+/* Calculate 'n % d', but return 'd' if the result would be 0.  */
+#define MODULO_NONZERO(n, d)	(((n) % (d)) ? ((n) % (d)) : (d))
 
-#define ARRAY_LEN(array) (sizeof(array) / sizeof((array)[0]))
+/* Get the number of elements of an array type.  */
+#define ARRAY_LEN(array)	(sizeof(array) / sizeof((array)[0]))
 
-#define ZERO_ARRAY(array) memset(array, 0, sizeof(array))
+/* Maximum number of bytes that can be allocated on the stack.
+ *
+ * Note: this isn't a hard bound on the stack space used, since this is just for
+ * individual arrays.  The full call stack could use more than this.  */
+#define STACK_MAX 32768
 
-/* Used for buffering FILE IO in a few places */
+/* Default size of file I/O buffer.  Currently assumed to be <= STACK_MAX.  */
 #define BUFFER_SIZE 32768
 
-/* Maximum number of array elements to allocate on the stack (used in various
- * places when large temporary buffers are needed).  */
-#define STACK_MAX 32768
+/*******************
+ * Memory allocation
+ *******************/
 
 extern void *
-wimlib_malloc(size_t) _malloc_attribute;
+wimlib_malloc(size_t size) _malloc_attribute;
 
 extern void
 wimlib_free_memory(void *p);
 
 extern void *
-wimlib_realloc(void *, size_t);
+wimlib_realloc(void *ptr, size_t size);
 
 extern void *
 wimlib_calloc(size_t nmemb, size_t size) _malloc_attribute;
 
+extern char *
+wimlib_strdup(const char *str) _malloc_attribute;
+
 #ifdef __WIN32__
 extern wchar_t *
 wimlib_wcsdup(const wchar_t *str) _malloc_attribute;
-
 #endif
-extern char *
-wimlib_strdup(const char *str) _malloc_attribute;
 
 extern void *
 wimlib_aligned_malloc(size_t size, size_t alignment) _malloc_attribute;
@@ -62,18 +63,22 @@ wimlib_aligned_malloc(size_t size, size_t alignment) _malloc_attribute;
 extern void
 wimlib_aligned_free(void *ptr);
 
-#define	MALLOC	wimlib_malloc
-#define	FREE	wimlib_free_memory
-#define	REALLOC	wimlib_realloc
-#define	CALLOC	wimlib_calloc
-#define	STRDUP	wimlib_strdup
-#define	WCSDUP  wimlib_wcsdup
-#define	ALIGNED_MALLOC	wimlib_aligned_malloc
-#define	ALIGNED_FREE	wimlib_aligned_free
-
 extern void *
 memdup(const void *mem, size_t size) _malloc_attribute;
 
+#define MALLOC		wimlib_malloc
+#define FREE		wimlib_free_memory
+#define REALLOC		wimlib_realloc
+#define CALLOC		wimlib_calloc
+#define STRDUP		wimlib_strdup
+#define WCSDUP		wimlib_wcsdup
+#define ALIGNED_MALLOC	wimlib_aligned_malloc
+#define ALIGNED_FREE	wimlib_aligned_free
+
+/*******************
+ * String utilities
+ *******************/
+
 #ifndef HAVE_MEMPCPY
 extern void *
 mempcpy(void *dst, const void *src, size_t n);
@@ -86,10 +91,11 @@ extern void
 randomize_byte_array(u8 *p, size_t n);
 
 extern void
-randomize_char_array_with_alnum(tchar p[], size_t n);
+randomize_char_array_with_alnum(tchar *p, size_t n);
 
-extern void
-print_byte_field(const u8 field[], size_t len, FILE *out);
+/************************
+ * Hashing and comparison
+ ************************/
 
 static inline bool
 is_power_of_2(unsigned long n)
@@ -109,33 +115,9 @@ cmp_u64(u64 n1, u64 n2)
 {
 	if (n1 < n2)
 		return -1;
-	else if (n1 > n2)
+	if (n1 > n2)
 		return 1;
-	else
-		return 0;
+	return 0;
 }
 
-/* is_any_path_separator() - characters treated as path separators in WIM path
- * specifications and capture configuration files (the former will be translated
- * to WIM_PATH_SEPARATOR; the latter will be translated to
- * OS_PREFERRED_PATH_SEPARATOR)
- *
- * OS_PREFERRED_PATH_SEPARATOR - preferred (or only) path separator on the
- * operating system.  Used when constructing filesystem paths to extract or
- * archive.
- *
- * WIM_PATH_SEPARATOR - character treated as path separator for WIM paths.
- * Currently needs to be '/' on UNIX for the WIM mounting code to work properly.
- */
-
-#ifdef __WIN32__
-#  define OS_PREFERRED_PATH_SEPARATOR L'\\'
-#  define is_any_path_separator(c) ((c) == L'/' || (c) == L'\\')
-#else
-#  define OS_PREFERRED_PATH_SEPARATOR '/'
-#  define is_any_path_separator(c) ((c) == '/' || (c) == '\\')
-#endif
-
-#define WIM_PATH_SEPARATOR WIMLIB_WIM_PATH_SEPARATOR
-
 #endif /* _WIMLIB_UTIL_H */