X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwimlib.h;h=643438b28e7c474cf6faf7a43d10d833323e6126;hp=a249b8954a901c55a594534b3fb49156b8e8de12;hb=fa151ff40338619c7dbbdc06c227754b6b94c2e1;hpb=2beb22c748f33253876ca690cac7f7284c747106

diff --git a/src/wimlib.h b/src/wimlib.h
index a249b895..643438b2 100644
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -9,7 +9,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.
  *
@@ -31,9 +31,11 @@
  *
  * \section intro Introduction
  *
- * This is the documentation for the library interface of wimlib 1.2.5.  If you
+ * This is the documentation for the library interface of wimlib 1.3.0.  If you
  * have installed wimlib and want to know how to use the @c imagex program,
- * please see the man pages instead.
+ * please see the man pages instead.  Also: the actual project page where you
+ * can download the source code for the library is at <a
+ * href="https://sourceforge.net/projects/wimlib">https://sourceforge.net/projects/wimlib</a>.
  *
  * wimlib is a C library to read, write, and mount archive files in the Windows
  * Imaging Format (WIM files).  These files are normally created using the @c
@@ -117,8 +119,14 @@
  * message being printed.
  *
  * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
- * the fact that wimlib_set_print_errors() and wimlib_set_memory_allocator()
- * both apply globally.
+ * the following exceptions:
+ * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
+ * - You also must call wimlib_global_init() in the main thread to avoid any
+ *   race conditions with one-time allocations of memory.
+ * - wimlib_mount_image(), while it can be used to mount multiple WIMs
+ *   concurrently in the same process, will daemonize the entire process when it
+ *   does so for the first time.  This includes changing the working directory
+ *   to the root directory.
  *
  * To open an existing WIM, use wimlib_open_wim().
  *
@@ -173,11 +181,23 @@
  * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
  * man page.
  *
+ * \section encodings Locales and character encodings
+ *
+ * wimlib 1.3.0 has improved handling of different character encodings compared
+ * to previous versions.  Functions are explictly noted as taking
+ * ::wimlib_mbchar strings, which are encoded in the locale-dependent multibyte
+ * encoding (e.g.  ASCII, ISO-8859-1, or UTF-8), or ::wimlib_utf8char strings,
+ * which are encoded in UTF-8.  Generally, filenames and paths are in the
+ * locale-dependent multibyte encoding, while other types of data must be
+ * provided in UTF-8.  Please see the  man page for @b imagex for more
+ * information.  However, I strongly recommend that you use UTF-8 for your
+ * locale's encoding so that ::wimlib_mbchar strings will be encoded the same
+ * way as ::wimlib_utf8char strings.
+ *
  * \section Limitations
  *
  * While wimlib supports the main features of WIM files, wimlib currently has
  * the following limitations:
- * - wimlib cannot be used on MS-Windows.
  * - There is no way to add, remove, modify, or extract specific files in a WIM
  *   without mounting it, other than by adding, removing, or extracting an
  *   entire image.  The FUSE mount feature should be used for this purpose.
@@ -199,6 +219,10 @@
  *   script for a similar purpose, however.  With regards to adding drivers to
  *   Windows PE, you have the option of putting them anywhere in the Windows PE
  *   image, then loading them after boot using @b drvload.exe.
+ * - Although wimlib 1.3.0 and later can be used on Windows as well as UNIX, the
+ *   Windows build has some limitations compared to the UNIX build.
+ *   (The differences are documented better in the man pages for @b imagex than
+ *   here.)
  *
  * \section legal License
  *
@@ -215,9 +239,14 @@
 #include <stdbool.h>
 #include <inttypes.h>
 
+/** Major version of the library (for example, the 1 in 1.2.5). */
 #define WIMLIB_MAJOR_VERSION 1
-#define WIMLIB_MINOR_VERSION 2
-#define WIMLIB_PATCH_VERSION 5
+
+/** Minor version of the library (for example, the 2 in 1.2.5). */
+#define WIMLIB_MINOR_VERSION 3
+
+/** Patch version of the library (for example, the 5 in 1.2.5). */
+#define WIMLIB_PATCH_VERSION 0
 
 /**
  * Opaque structure that represents a WIM file.  This is an in-memory structure
@@ -234,6 +263,12 @@
  */
 typedef struct WIMStruct WIMStruct;
 
+/** Byte of a string encoded in the locale-dependent encoding */
+typedef char wimlib_mbchar;
+
+/** Byte of a string encoded in UTF-8 */
+typedef char wimlib_utf8char;
+
 /**
  * Specifies the compression type of a WIM file.
  */
@@ -393,16 +428,21 @@ union wimlib_progress_info {
 	 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
 	struct wimlib_progress_info_scan {
 		/** Directory or NTFS volume that is being scanned. */
-		const char *source;
+		const wimlib_mbchar *source;
 
 		/** Path to the file or directory that is about to be scanned,
 		 * relative to the root of the image capture or the NTFS volume.
 		 * */
-		const char *cur_path;
+		const wimlib_mbchar *cur_path;
 
 		/** True iff @a cur_path is being excluded from the image
 		 * capture due to the capture configuration file. */
 		bool excluded;
+
+		/** Target path in the WIM.  Only valid on messages
+		 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
+		 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
+		const wimlib_mbchar *wim_target_path;
 	} scan;
 
 	/** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
@@ -418,18 +458,18 @@ union wimlib_progress_info {
 		int extract_flags;
 
 		/** Full path to the WIM file being extracted. */
-		const char *wimfile_name;
+		const wimlib_mbchar *wimfile_name;
 
 		/** Name of the image being extracted. */
-		const char *image_name;
+		const wimlib_utf8char *image_name;
 
 		/** Directory or NTFS volume to which the image is being
 		 * extracted. */
-		const char *target;
+		const wimlib_mbchar *target;
 
 		/** Current dentry being extracted.  (Valid only if message is
 		 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
-		const char *cur_path;
+		const wimlib_mbchar *cur_path;
 
 		/** Number of bytes of uncompressed data that will be extracted.
 		 * Takes into account hard links (they are not counted for each
@@ -451,11 +491,11 @@ union wimlib_progress_info {
 	/** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
 	struct wimlib_progress_info_rename {
 		/** Name of the temporary file that the WIM was written to. */
-		const char *from;
+		const wimlib_mbchar *from;
 
 		/** Name of the original WIM file to which the temporary file is
 		 * being renamed. */
-		const char *to;
+		const wimlib_mbchar *to;
 	} rename;
 
 	/** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
@@ -483,7 +523,7 @@ union wimlib_progress_info {
 
 		/** Filename of the WIM (only valid if the message is
 		 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
-		const char *filename;
+		const wimlib_mbchar *filename;
 	} integrity;
 
 	/** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
@@ -525,7 +565,7 @@ union wimlib_progress_info {
 		/** Name of the split WIM part that is about to be started
 		 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
 		 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
-		const char *part_name;
+		const wimlib_mbchar *part_name;
 	} split;
 };
 
@@ -541,12 +581,30 @@ union wimlib_progress_info {
 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
 				      const union wimlib_progress_info *info);
 
+/** An array of these structures is passed to wimlib_add_image_multisource() to
+ * specify the sources from which to create a WIM image. */
+struct wimlib_capture_source {
+	/** Absolute or relative path to a file or directory on the external
+	 * filesystem to be included in the WIM image. */
+	wimlib_mbchar *fs_source_path;
+
+	/** Destination path in the WIM image.  Leading and trailing slashes are
+	 * ignored.  The empty string or @c NULL means the root directory of the
+	 * WIM image. */
+	wimlib_mbchar *wim_target_path;
+
+	/** Reserved; set to 0. */
+	long reserved;
+};
+
 
 /*****************************
  * WIMLIB_ADD_IMAGE_FLAG_*   *
  *****************************/
 
-/** Directly capture a NTFS volume rather than a generic directory */
+/** Directly capture a NTFS volume rather than a generic directory.  This flag
+ * cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE or
+ * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.   */
 #define WIMLIB_ADD_IMAGE_FLAG_NTFS			0x00000001
 
 /** Follow symlinks; archive and dump the files they point to.  Cannot be used
@@ -561,6 +619,14 @@ typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
 /** Mark the image being added as the bootable image of the WIM. */
 #define WIMLIB_ADD_IMAGE_FLAG_BOOT			0x00000008
 
+/** Store the UNIX owner, group, and mode.  This is done by adding a special
+ * alternate data stream to each regular file, symbolic link, and directory to
+ * contain this information.  Please note that this flag is for convenience
+ * only; Microsoft's version of imagex.exe will not understand this special
+ * information.  This flag cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_NTFS.
+ * */
+#define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA			0x00000010
+
 /******************************
  * WIMLIB_EXPORT_FLAG_* *
  ******************************/
@@ -593,6 +659,10 @@ typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
 /** Read the WIM file sequentially while extracting the image. */
 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL			0x00000010
 
+/** Extract special UNIX data captured with ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.
+ * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
+#define WIMLIB_EXTRACT_FLAG_UNIX_DATA			0x00000020
+
 /******************************
  * WIMLIB_MOUNT_FLAG_*        *
  ******************************/
@@ -614,6 +684,14 @@ typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
  * file name, a colon, then the alternate file stream name. */
 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS	0x00000010
 
+/** Use UNIX file owners, groups, and modes if available in the WIM (see
+ * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA). */
+#define WIMLIB_MOUNT_FLAG_UNIX_DATA			0x00000020
+
+/** Allow other users to see the mounted filesystem.  (this passes the @c
+ * allow_other option to FUSE mount) */
+#define WIMLIB_MOUNT_FLAG_ALLOW_OTHER			0x00000040
+
 /******************************
  * WIMLIB_OPEN_FLAG_*         *
  ******************************/
@@ -678,6 +756,9 @@ typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
  * See the documentation for each wimlib function to see specifically what error
  * codes can be returned by a given function, and what they mean.
  */
+/* Note: these are currently in alphabetic order, but new error codes should be
+ * added at the end to maintain a compatible ABI, except when it's being broken
+ * anyway. */
 enum wimlib_error_code {
 	WIMLIB_ERR_SUCCESS = 0,
 	WIMLIB_ERR_ALREADY_LOCKED,
@@ -733,6 +814,9 @@ enum wimlib_error_code {
 	WIMLIB_ERR_UNSUPPORTED,
 	WIMLIB_ERR_WRITE,
 	WIMLIB_ERR_XML,
+	WIMLIB_ERR_INVALID_OVERLAY,
+	WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
+	WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
 };
 
 
@@ -773,8 +857,8 @@ enum wimlib_error_code {
  * 	NULL, a default string is used.  Please see the manual page for
  * 	<b>imagex capture</b> for more information.
  * @param config_len
- * 	Length of the string @a config in bytes.  Ignored if @a config is @c
- * 	NULL.
+ * 	Length of the string @a config in bytes, not including an optional
+ * 	null-terminator.  Ignored if @a config is @c NULL.
  * @param add_image_flags
  * 	Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
  * @param progress_func
@@ -825,10 +909,44 @@ enum wimlib_error_code {
  * 	::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
  * 	wimlib was configured with the @c --without-ntfs-3g flag.
  */
-extern int wimlib_add_image(WIMStruct *wim, const char *source,
-			    const char *name, const char *config,
-			    size_t config_len, int add_image_flags,
-			    wimlib_progress_func_t progress_func);
+extern int
+wimlib_add_image(WIMStruct *wim, const wimlib_mbchar *source,
+		 const wimlib_utf8char *name,
+		 const wimlib_mbchar *config,
+		 size_t config_len, int add_image_flags,
+		 wimlib_progress_func_t progress_func);
+
+/** This function is equivalent to wimlib_add_image() except it allows for
+ * multiple sources to be combined into a single WIM image.  This is done by
+ * specifying the @a sources and @a num_sources parameters instead of the @a
+ * source parameter of wimlib_add_image().  The rest of the parameters are the
+ * same as wimlib_add_image().  See the documentation for <b>imagex capture</b>
+ * for full details on how this mode works.
+ *
+ * Additional note:  @a sources is not a @c const parameter and you cannot
+ * assume that its contents are valid after this function returns.  You must
+ * save pointers to the strings in these structures if you need to free them
+ * later, and/or save copies if needed.
+ *
+ * In addition to the error codes that wimlib_add_image() can return,
+ * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
+ * when trying to overlay a non-directory on a directory or when otherwise
+ * trying to overlay multiple conflicting files to the same location in the WIM
+ * image.  It will also return ::WIMLIB_ERR_INVALID_PARAM if
+ * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags but there
+ * was not exactly one capture source with the target being the root directory.
+ * (In this respect, there is no advantage to using
+ * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
+ * NTFS mode.) */
+extern int
+wimlib_add_image_multisource(WIMStruct *w,
+			     struct wimlib_capture_source *sources,
+			     size_t num_sources,
+			     const wimlib_utf8char *name,
+			     const wimlib_mbchar *config_str,
+			     size_t config_len,
+			     int add_image_flags,
+			     wimlib_progress_func_t progress_func);
 
 /**
  * Creates a ::WIMStruct for a new WIM file.
@@ -852,7 +970,8 @@ extern int wimlib_add_image(WIMStruct *wim, const char *source,
  * @retval ::WIMLIB_ERR_NOMEM
  * 	Failed to allocate needed memory.
  */
-extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
+extern int
+wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
 
 /**
  * Deletes an image, or all images, from a WIM file.
@@ -895,7 +1014,8 @@ extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
  * 	@a wim is part of a split WIM.  Deleting an image from a split WIM is
  * 	unsupported.
  */
-extern int wimlib_delete_image(WIMStruct *wim, int image);
+extern int
+wimlib_delete_image(WIMStruct *wim, int image);
 
 /**
  * Exports an image, or all the images, from a WIM file, into another WIM file.
@@ -1004,12 +1124,15 @@ extern int wimlib_delete_image(WIMStruct *wim, int image);
  * 	@a dest_wim is part of a split WIM.  Exporting an image to a split WIM
  * 	is unsupported.
  */
-extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
-			       WIMStruct *dest_wim, const char *dest_name,
-			       const char *dest_description, int export_flags,
-			       WIMStruct **additional_swms,
-			       unsigned num_additional_swms,
-			       wimlib_progress_func_t progress_func);
+extern int
+wimlib_export_image(WIMStruct *src_wim, int src_image,
+		    WIMStruct *dest_wim,
+		    const wimlib_utf8char *dest_name,
+		    const wimlib_utf8char *dest_description,
+		    int export_flags,
+		    WIMStruct **additional_swms,
+		    unsigned num_additional_swms,
+		    wimlib_progress_func_t progress_func);
 
 /**
  * Extracts an image, or all images, from a standalone or split WIM file to a
@@ -1089,11 +1212,13 @@ extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
  * 	invalid.
  * @retval ::WIMLIB_ERR_INVALID_PARAM
  * 	@a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
- * 	::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags, or
+ * 	::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
  * 	both ::WIMLIB_EXTRACT_FLAG_NTFS and either
  * 	::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
- * 	specified in @a extract_flags, or ::WIMLIB_EXTRACT_FLAG_NTFS was
- * 	specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES.
+ * 	specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
+ * 	specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
+ * 	both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
+ * 	specified in @a extract_flag.
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
  * 	The SHA1 message digest of an extracted stream did not match the SHA1
  * 	message digest given in the WIM file.
@@ -1131,11 +1256,13 @@ extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
  * 	Failed to write a file being extracted (only if
  * 	::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
  */
-extern int wimlib_extract_image(WIMStruct *wim, int image,
-				const char *target, int extract_flags,
-				WIMStruct **additional_swms,
-				unsigned num_additional_swms,
-				wimlib_progress_func_t progress_func);
+extern int
+wimlib_extract_image(WIMStruct *wim, int image,
+		     const wimlib_mbchar *target,
+		     int extract_flags,
+		     WIMStruct **additional_swms,
+		     unsigned num_additional_swms,
+		     wimlib_progress_func_t progress_func);
 
 /**
  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
@@ -1153,7 +1280,8 @@ extern int wimlib_extract_image(WIMStruct *wim, int image,
  * @retval ::WIMLIB_ERR_INVALID_PARAM
  * 	@a wim is not a ::WIMStruct that was created by wimlib_open_wim().
  */
-extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
+extern int
+wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
 
 /**
  * Frees all memory allocated for a WIMStruct and closes all files associated
@@ -1164,7 +1292,8 @@ extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
  *
  * @return This function has no return value.
  */
-extern void wimlib_free(WIMStruct *wim);
+extern void
+wimlib_free(WIMStruct *wim);
 
 /**
  * Returns the index of the bootable image of the WIM.
@@ -1176,7 +1305,8 @@ extern void wimlib_free(WIMStruct *wim);
  * 	0 if no image is marked as bootable, or the number of the image marked
  * 	as bootable (numbered starting at 1).
  */
-extern int wimlib_get_boot_idx(const WIMStruct *wim);
+extern int
+wimlib_get_boot_idx(const WIMStruct *wim);
 
 /**
  * Returns the compression type used in the WIM.
@@ -1188,7 +1318,8 @@ extern int wimlib_get_boot_idx(const WIMStruct *wim);
  * 	::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
  * 	::WIMLIB_COMPRESSION_TYPE_XPRESS.
  */
-extern int wimlib_get_compression_type(const WIMStruct *wim);
+extern int
+wimlib_get_compression_type(const WIMStruct *wim);
 
 /**
  * Converts a ::wimlib_compression_type value into a string.
@@ -1201,7 +1332,8 @@ extern int wimlib_get_compression_type(const WIMStruct *wim);
  * 	A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
  * 	respectively.
  */
-extern const char *wimlib_get_compression_type_string(int ctype);
+extern const wimlib_mbchar *
+wimlib_get_compression_type_string(int ctype);
 
 /**
  * Converts an error code into a string describing it.
@@ -1213,7 +1345,8 @@ extern const char *wimlib_get_compression_type_string(int ctype);
  * 	Pointer to a statically allocated string describing the error code,
  * 	or @c NULL if the error code is not valid.
  */
-extern const char *wimlib_get_error_string(enum wimlib_error_code code);
+extern const wimlib_mbchar *
+wimlib_get_error_string(enum wimlib_error_code code);
 
 /**
  * Returns the description of the specified image.
@@ -1231,7 +1364,8 @@ extern const char *wimlib_get_error_string(enum wimlib_error_code code);
  * 	in addition, the string will become invalid if the description of the
  * 	image is changed, the image is deleted, or the ::WIMStruct is destroyed.
  */
-extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
+extern const wimlib_utf8char *
+wimlib_get_image_description(const WIMStruct *wim, int image);
 
 /**
  * Returns the name of the specified image.
@@ -1252,7 +1386,8 @@ extern const char *wimlib_get_image_description(const WIMStruct *wim, int image)
  * 	the WIM to be unnamed, in which case an empty string will be returned
  * 	when the corresponding name is requested.
  */
-extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
+extern const wimlib_utf8char *
+wimlib_get_image_name(const WIMStruct *wim, int image);
 
 
 /**
@@ -1265,7 +1400,8 @@ extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
  * @return
  * 	The number of images contained in the WIM file.
  */
-extern int wimlib_get_num_images(const WIMStruct *wim);
+extern int
+wimlib_get_num_images(const WIMStruct *wim);
 
 /**
  * Returns the part number of a WIM in a split WIM and the total number of parts
@@ -1280,7 +1416,29 @@ extern int wimlib_get_num_images(const WIMStruct *wim);
  * @return
  * 	The part number of the WIM (1 for non-split WIMs)
  */
-extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
+extern int
+wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
+
+/**
+ * Since wimlib 1.2.6:  Initialization function for wimlib.  This is not
+ * re-entrant.  If you are calling wimlib functions concurrently in different
+ * threads, then you must call this function serially first.  Also, since wimlib
+ * 1.3.0, you must call this function if the character encoding of the current
+ * locale is not UTF-8.  Otherwise, calling this function this function is not
+ * required.
+ *
+ * This function always returns 0.
+ */
+extern int
+wimlib_global_init();
+
+/**
+ * Since wimlib 1.2.6:  Cleanup function for wimlib.  This is not re-entrant.
+ * You are not required to call this function, but it will release any global
+ * memory allocated by the library.
+ */
+extern void
+wimlib_global_cleanup();
 
 /**
  * Returns true if the WIM has an integrity table.
@@ -1293,8 +1451,8 @@ extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
  * 	wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
  * 	been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
  */
-extern bool wimlib_has_integrity_table(const WIMStruct *wim);
-
+extern bool
+wimlib_has_integrity_table(const WIMStruct *wim);
 
 /**
  * Determines if an image name is already used by some image in the WIM.
@@ -1309,7 +1467,8 @@ extern bool wimlib_has_integrity_table(const WIMStruct *wim);
  * 	if there is no image named @a name in @a wim.  If @a name is @c NULL or
  * 	the empty string, @c false is returned.
  */
-extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
+extern bool
+wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_utf8char *name);
 
 /**
  * Joins a split WIM into a stand-alone one-part WIM.
@@ -1348,17 +1507,19 @@ extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
  * Note: wimlib_export_image() can provide similar functionality to
  * wimlib_join(), since it is possible to export all images from a split WIM.
  */
-extern int wimlib_join(const char **swms, unsigned num_swms,
-		       const char *output_path, int swm_open_flags,
-		       int wim_write_flags,
-		       wimlib_progress_func_t progress_func);
+extern int
+wimlib_join(const wimlib_mbchar * const *swms,
+	    unsigned num_swms,
+	    const wimlib_mbchar *output_path,
+	    int swm_open_flags,
+	    int wim_write_flags,
+	    wimlib_progress_func_t progress_func);
 
 /**
  * Mounts an image in a WIM file on a directory read-only or read-write.
  *
- * The calling thread will be daemonized to service the filesystem, and this
- * function will not return until the image is unmounted, unless an error occurs
- * before the filesystem is successfully mounted.
+ * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
+ * process shall be daemonized.
  *
  * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
  * modifications to the WIM are staged in a temporary directory.
@@ -1428,7 +1589,7 @@ extern int wimlib_join(const char **swms, unsigned num_swms,
  * @retval ::WIMLIB_ERR_INVALID_PARAM
  * 	@a image is shared among multiple ::WIMStruct's as a result of a call to
  * 	wimlib_export_image(), or @a image has been added with
- * 	wimlib_add_image() or wimlib_add_image_from_ntfs_volume().
+ * 	wimlib_add_image().
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
  *	The metadata resource for @a image in @a wim is invalid.
  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
@@ -1452,10 +1613,11 @@ extern int wimlib_join(const char **swms, unsigned num_swms,
  * 	The WIM is a split WIM and a read-write mount was requested.  We only
  * 	support mounting a split WIM read-only.
  */
-extern int wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
-			      int mount_flags, WIMStruct **additional_swms,
-			      unsigned num_additional_swms,
-			      const char *staging_dir);
+extern int
+wimlib_mount_image(WIMStruct *wim, int image, const wimlib_mbchar *dir,
+		   int mount_flags, WIMStruct **additional_swms,
+		   unsigned num_additional_swms,
+		   const wimlib_mbchar *staging_dir);
 
 /**
  * Opens a WIM file and creates a ::WIMStruct for it.
@@ -1535,9 +1697,9 @@ extern int wimlib_mount_image(WIMStruct *wim, int image, const char *dir,
  * @retval ::WIMLIB_ERR_XML
  * 	The XML data for @a wim_file is invalid.
  */
-extern int wimlib_open_wim(const char *wim_file, int open_flags,
-			   WIMStruct **wim_ret,
-			   wimlib_progress_func_t progress_func);
+extern int
+wimlib_open_wim(const wimlib_mbchar *wim_file, int open_flags,
+		WIMStruct **wim_ret, wimlib_progress_func_t progress_func);
 
 /**
  * Overwrites the file that the WIM was originally read from, with changes made.
@@ -1610,9 +1772,9 @@ extern int wimlib_open_wim(const char *wim_file, int open_flags,
  * 	accessed, so this limits the functions that can be called on @a wim
  * 	before calling wimlib_free().
  */
-extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
-			    unsigned num_threads,
-			    wimlib_progress_func_t progress_func);
+extern int
+wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
+		 wimlib_progress_func_t progress_func);
 
 /**
  * Prints information about one image, or all images, contained in a WIM.
@@ -1628,7 +1790,8 @@ extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
  * printing the information.  If @a image is invalid, an error message is
  * printed.
  */
-extern void wimlib_print_available_images(const WIMStruct *wim, int image);
+extern void
+wimlib_print_available_images(const WIMStruct *wim, int image);
 
 /**
  * Prints the full paths to all files contained in an image, or all images, in a
@@ -1663,7 +1826,8 @@ extern void wimlib_print_available_images(const WIMStruct *wim, int image);
  * 	@a wim was not a standalone WIM and was not the first part of a split
  * 	WIM.
  */
-extern int wimlib_print_files(WIMStruct *wim, int image);
+extern int
+wimlib_print_files(WIMStruct *wim, int image);
 
 /**
  * Prints detailed information from the header of a WIM file.
@@ -1675,7 +1839,8 @@ extern int wimlib_print_files(WIMStruct *wim, int image);
  * @return This function has no return value.
  *
  */
-extern void wimlib_print_header(const WIMStruct *wim);
+extern void
+wimlib_print_header(const WIMStruct *wim);
 
 /**
  * Prints the lookup table of a WIM file.  The lookup table maps SHA1 message
@@ -1689,7 +1854,8 @@ extern void wimlib_print_header(const WIMStruct *wim);
  *
  * @return This function has no return value.
  */
-extern void wimlib_print_lookup_table(WIMStruct *wim);
+extern void
+wimlib_print_lookup_table(WIMStruct *wim);
 
 /**
  * Prints the metadata of the specified image in a WIM file.  The metadata
@@ -1725,7 +1891,8 @@ extern void wimlib_print_lookup_table(WIMStruct *wim);
  * 	@a wim was not a standalone WIM and was not the first part of a split
  * 	WIM.
  */
-extern int wimlib_print_metadata(WIMStruct *wim, int image);
+extern int
+wimlib_print_metadata(WIMStruct *wim, int image);
 
 /**
  * Prints some basic information about a WIM file.  All information printed by
@@ -1738,7 +1905,8 @@ extern int wimlib_print_metadata(WIMStruct *wim, int image);
  *
  * @return This function has no return value.
  */
-extern void wimlib_print_wim_information(const WIMStruct *wim);
+extern void
+wimlib_print_wim_information(const WIMStruct *wim);
 
 /**
  * Translates a string specifying the name or number of an image in the WIM into
@@ -1766,7 +1934,9 @@ extern void wimlib_print_wim_information(const WIMStruct *wim);
  * 	the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
  * 	images in @a wim has no name.
  */
-extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
+extern int
+wimlib_resolve_image(WIMStruct *wim,
+		     const wimlib_utf8char *image_name_or_num);
 
 /**
  * Sets which image in the WIM is marked as bootable.
@@ -1784,7 +1954,8 @@ extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
  * 	@a wim is part of a split WIM.  We do not support changing the boot
  * 	index of a split WIM.
  */
-extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
+extern int
+wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
 
 /**
  * Changes the description of an image in the WIM.
@@ -1806,8 +1977,9 @@ extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
  * 	Failed to allocate the memory needed to duplicate the @a description
  * 	string.
  */
-extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
-				       const char *description);
+extern int
+wimlib_set_image_descripton(WIMStruct *wim, int image,
+			    const wimlib_utf8char *description);
 
 /**
  * Changes what is written in the \<FLAGS\> element in the WIM XML data
@@ -1829,7 +2001,8 @@ extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
  * @retval ::WIMLIB_ERR_NOMEM
  * 	Failed to allocate the memory needed to duplicate the @a flags string.
  */
-extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
+extern int wimlib_set_image_flags(WIMStruct *wim, int image,
+				  const wimlib_utf8char *flags);
 
 /**
  * Changes the name of an image in the WIM.
@@ -1853,7 +2026,8 @@ extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
  * @retval ::WIMLIB_ERR_NOMEM
  * 	Failed to allocate the memory needed to duplicate the @a name string.
  */
-extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
+extern int wimlib_set_image_name(WIMStruct *wim, int image,
+				 const wimlib_utf8char *name);
 
 /**
  * Set the functions that wimlib uses to allocate and free memory.
@@ -1883,9 +2057,10 @@ extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
  * 	wimlib was compiled with the @c --without-custom-memory-allocator flag,
  * 	so custom memory allocators are unsupported.
  */
-int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
-			         void (*free_func)(void *),
-			         void *(*realloc_func)(void *, size_t));
+extern int
+wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
+			    void (*free_func)(void *),
+			    void *(*realloc_func)(void *, size_t));
 
 /**
  * Sets whether wimlib is to print error messages to @c stderr when a function
@@ -1907,7 +2082,8 @@ int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
  * 	--without-error-messages option.   Therefore, error messages cannot be
  * 	shown.
  */
-extern int wimlib_set_print_errors(bool show_messages);
+extern int
+wimlib_set_print_errors(bool show_messages);
 
 /**
  * Splits a WIM into multiple parts.
@@ -1943,9 +2119,10 @@ extern int wimlib_set_print_errors(bool show_messages);
  * when they are copied from the joined WIM to the split WIM parts, nor are
  * compressed resources re-compressed.
  */
-extern int wimlib_split(WIMStruct *wim, const char *swm_name,
-			size_t part_size, int write_flags,
-			wimlib_progress_func_t progress_func);
+extern int
+wimlib_split(WIMStruct *wim, const wimlib_mbchar *swm_name,
+	     size_t part_size, int write_flags,
+	     wimlib_progress_func_t progress_func);
 
 /**
  * Unmounts a WIM image that was mounted using wimlib_mount_image().
@@ -2004,8 +2181,9 @@ extern int wimlib_split(WIMStruct *wim, const char *swm_name,
  * 	WIM file, or the filesystem daemon was unable to flush changes that had
  * 	been made to files in the staging directory.
  */
-extern int wimlib_unmount_image(const char *dir, int unmount_flags,
-				wimlib_progress_func_t progress_func);
+extern int
+wimlib_unmount_image(const wimlib_mbchar *dir, int unmount_flags,
+		     wimlib_progress_func_t progress_func);
 
 /**
  * Writes a standalone WIM to a file.
@@ -2048,9 +2226,9 @@ extern int wimlib_unmount_image(const char *dir, int unmount_flags,
  * 	@a image does not specify a single existing image in @a wim, and is not
  * 	::WIMLIB_ALL_IMAGES.
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
- * 	A file that had previously been scanned for inclusion in the WIM by the
- * 	wimlib_add_image() or wimlib_add_image_from_ntfs_volume() functions was
- * 	concurrently modified, so it failed the SHA1 message digest check.
+ * 	A file that had previously been scanned for inclusion in the WIM by
+ * 	wimlib_add_image() was concurrently modified, so it failed the SHA1
+ * 	message digest check.
  * @retval ::WIMLIB_ERR_INVALID_PARAM
  * 	@a path was @c NULL.
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
@@ -2075,8 +2253,9 @@ extern int wimlib_unmount_image(const char *dir, int unmount_flags,
  * 	An error occurred when trying to write data to the new WIM file at @a
  * 	path.
  */
-extern int wimlib_write(WIMStruct *wim, const char *path, int image,
-			int write_flags, unsigned num_threads,
-			wimlib_progress_func_t progress_func);
+extern int
+wimlib_write(WIMStruct *wim, const wimlib_mbchar *path, int image,
+	     int write_flags, unsigned num_threads,
+	     wimlib_progress_func_t progress_func);
 
 #endif /* _WIMLIB_H */