X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwimlib.h;h=18417d19baf1041c3781ca0e14bf3117b4f1ea45;hp=57f9aa9722a3e83741571d04bf92c46a7c0cc88a;hb=34935d41624c903db230efbd5b0a1f37e7fdcc32;hpb=ebcb2402da0d554dcaafa46b8c1b9cc3362f6be3

diff --git a/src/wimlib.h b/src/wimlib.h
index 57f9aa97..18417d19 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,16 +31,19 @@
  *
  * \section intro Introduction
  *
- * This is the documentation for the library interface of wimlib 1.2.1.  If you
- * have installed wimlib and want to know how to use the @c imagex program,
- * please see the man pages instead.
+ * This is the documentation for the library interface of wimlib 1.3.1.  If you
+ * have installed wimlib and want to know how to use the @b wimlib-imagex
+ * program, 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
- * imagex.exe utility on Windows, but this library provides a free
- * implementetion of @c imagex for UNIX-based systems and an API to allow other
- * programs to read, write, and mount WIM files.  wimlib is comparable to
- * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
+ * Imaging Format (WIM files).  These files are normally created using the
+ * ImageX (@a imagex.exe) utility on Windows, but this library provides a free
+ * implementation of ImageX for UNIX-based systems (and, since v1.3.0, for
+ * Windows systems) and an API to allow other programs to read, write, and mount
+ * WIM files.  wimlib is comparable to Microsoft's WIMGAPI, but was designed
+ * independently and is not a clone of it.
  *
  * \section format WIM files
  *
@@ -79,6 +82,10 @@
  * Configuration Data.  In addition, a Windows installation can be captured (or
  * backed up) into a WIM file, and then re-applied later.
  *
+ * wimlib v1.3.0 and later also supports NTFS capture and apply in the native
+ * Windows build, which works slightly differently and relies on native Win32
+ * API calls rather than libntfs-3g.
+ *
  * \section winpe Windows PE
  *
  * A major use for this library is to create customized images of Windows PE, the
@@ -117,8 +124,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().
  *
@@ -162,22 +175,36 @@
  * the WIM operation(s) to report on the progress of the operation (for example,
  * how many bytes have been written so far).
  *
- * \section imagex imagex
+ * \section imagex wimlib-imagex
  *
- * wimlib comes with a command-line interface, the @b imagex program.  It is
- * documented with man pages.  See its source code (@c programs/imagex.c in
- * wimlib's source tree) for an example of how to use wimlib in your program.
+ * wimlib comes with a command-line interface, the @b wimlib-imagex program.  It
+ * is documented with man pages.  This program was originally just called @b
+ * imagex, but has been changed to @b wimlib-imagex to avoid confusion with
+ * Microsoft's @a imagex.exe (which would otherwise have exactly the same
+ * filename on Windows).
  *
  * \section mkwinpeimg mkwinpeimg
  *
  * 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 wimlib-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,12 +226,16 @@
  *   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 wimlib-imagex than here.)
  *
  * \section legal License
  *
  * The wimlib library, as well as the programs and scripts distributed with it
- * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
- * License version 3 or later.
+ * (@b wimlib-imagex and @b mkwinpeimg), is licensed under the GNU General
+ * Public License version 3 or later.
  */
 
 #ifndef _WIMLIB_H
@@ -215,8 +246,13 @@
 #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
+
+/** 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 1
 
 /**
@@ -234,6 +270,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 +435,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 +465,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 +498,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 +530,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 +572,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 +588,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 +626,17 @@ 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 @a 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
+
+/** Do not capture security descriptors.  Only has an effect in NTFS capture
+ * mode, or in Win32 native builds. */
+#define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS			0x00000020
+
 /******************************
  * WIMLIB_EXPORT_FLAG_* *
  ******************************/
@@ -593,6 +669,14 @@ 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
+
+/** Do not extract security descriptors.  Only has an effect in NTFS apply mode,
+ * or in Win32 native builds. */
+#define WIMLIB_EXTRACT_FLAG_NOACLS			0x00000040
+
 /******************************
  * WIMLIB_MOUNT_FLAG_*        *
  ******************************/
@@ -614,6 +698,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,10 +770,12 @@ 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,
-	WIMLIB_ERR_CHAR_CONVERSION,
 	WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
 	WIMLIB_ERR_DECOMPRESSION,
 	WIMLIB_ERR_DELETE_STAGING_DIR,
@@ -689,6 +783,7 @@ enum wimlib_error_code {
 	WIMLIB_ERR_FORK,
 	WIMLIB_ERR_FUSE,
 	WIMLIB_ERR_FUSERMOUNT,
+	WIMLIB_ERR_ICONV_NOT_AVAILABLE,
 	WIMLIB_ERR_IMAGE_COUNT,
 	WIMLIB_ERR_IMAGE_NAME_COLLISION,
 	WIMLIB_ERR_INTEGRITY,
@@ -706,6 +801,9 @@ enum wimlib_error_code {
 	WIMLIB_ERR_INVALID_RESOURCE_SIZE,
 	WIMLIB_ERR_INVALID_SECURITY_DATA,
 	WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
+	WIMLIB_ERR_INVALID_UTF8_STRING,
+	WIMLIB_ERR_INVALID_UTF16_STRING,
+	WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
 	WIMLIB_ERR_LINK,
 	WIMLIB_ERR_MKDIR,
 	WIMLIB_ERR_MQUEUE,
@@ -730,6 +828,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,
 };
 
 
@@ -742,14 +843,19 @@ enum wimlib_error_code {
 /**
  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
  *
- * The directory tree is read immediately for the purpose of constructing a
- * directory entry tree in-memory.  Also, all files are read to calculate their
- * SHA1 message digests.  However, because the directory tree may contain a very
- * large amount of data, the files themselves are not read into memory
- * permanently, and instead references to their paths saved.  The files are then
- * read on-demand if wimlib_write() or wimlib_overwrite() is called.
+ * The directory tree of NTFS volume is read immediately for the purpose of
+ * constructing a directory entry tree in-memory.  Also, all files are read to
+ * calculate their SHA1 message digests.  However, because the directory tree
+ * may contain a very large amount of data, the files themselves are not read
+ * into memory permanently, and instead references to their paths saved.  The
+ * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
+ * called.
  *
- * Please note that @b no changes are committed to the underlying WIM file (if
+ * See the manual page for the @b wimlib-imagex program for more information
+ * about the "normal" capture mode versus the NTFS capture mode (entered by
+ * providing the flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS).
+ *
+ * Note that @b no changes are committed to the underlying WIM file (if
  * any) until wimlib_write() or wimlib_overwrite() is called.
  *
  * @param wim
@@ -763,21 +869,12 @@ enum wimlib_error_code {
  * @param config
  * 	Pointer to the contents of an image capture configuration file.  If @c
  * 	NULL, a default string is used.  Please see the manual page for
- * 	<b>imagex capture</b> for more information.
+ * 	<b>wimlib-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.  If
- * 	::WIMLIB_ADD_IMAGE_FLAG_BOOT is specified, the image in @a wim that is
- * 	marked as bootable is changed to the one being added.  If
- * 	::WIMLIB_ADD_IMAGE_FLAG_VERBOSE is specified, the name of each file is
- * 	printed as it is scanned or captured.  If
- * 	::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE is specified, the files or
- * 	directories pointed to by symbolic links are archived rather than the
- * 	symbolic links themselves.
- *
+ * 	Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
  * @param progress_func
  * 	If non-NULL, a function that will be called periodically with the
  * 	progress of the current operation.
@@ -822,14 +919,48 @@ enum wimlib_error_code {
  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
  * 	@a wim is part of a split WIM.  Adding an image to a split WIM is
  * 	unsupported.
- * @retval ::WIMLIB_ERR_UNSUPPORTED:
+ * @retval ::WIMLIB_ERR_UNSUPPORTED
  * 	::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>wimlib-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.
@@ -853,7 +984,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.
@@ -896,7 +1028,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.
@@ -1005,20 +1138,23 @@ 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
  * directory or a NTFS volume.
  *
- * Please see the manual page for the @c imagex program for more information
- * about the "normal" extraction mode versus the NTFS extraction mode
- * (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
+ * Please see the manual page for the @c wimlib-imagex program for more
+ * information about the "normal" extraction mode versus the NTFS extraction
+ * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
  *
  * Extraction is done with one thread.
  *
@@ -1090,11 +1226,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.
@@ -1132,11 +1270,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
@@ -1154,7 +1294,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
@@ -1165,7 +1306,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.
@@ -1177,7 +1319,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.
@@ -1189,7 +1332,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.
@@ -1202,7 +1346,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.
@@ -1214,7 +1359,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.
@@ -1232,7 +1378,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.
@@ -1253,7 +1400,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);
 
 
 /**
@@ -1266,7 +1414,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
@@ -1281,7 +1430,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.
@@ -1294,8 +1465,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.
@@ -1310,7 +1481,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.
@@ -1349,17 +1521,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 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.
@@ -1429,7 +1603,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
@@ -1453,10 +1627,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.
@@ -1536,9 +1711,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.
@@ -1611,9 +1786,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.
@@ -1629,7 +1804,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
@@ -1664,7 +1840,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.
@@ -1676,7 +1853,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
@@ -1690,7 +1868,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
@@ -1726,7 +1905,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
@@ -1739,7 +1919,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
@@ -1767,7 +1948,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.
@@ -1785,7 +1968,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.
@@ -1807,8 +1991,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
@@ -1830,7 +2015,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.
@@ -1842,7 +2028,7 @@ extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
  * @param image
  * 	The number of the image for which to change the name.
  * @param name
- * 	The new name to give the image.  It must not a nonempty string.
+ * 	The new name to give the image.  It must be a nonempty string.
  *
  * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
@@ -1854,7 +2040,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.
@@ -1884,9 +2071,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
@@ -1908,7 +2096,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.
@@ -1935,7 +2124,7 @@ extern int wimlib_set_print_errors(bool show_messages);
  * @return 0 on success; nonzero on error.  This function may return any value
  * returned by wimlib_write() as well as the following error codes:
  *
- * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED:
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
  * 	@a wim is not part 1 of a stand-alone WIM.
  * @retval ::WIMLIB_ERR_INVALID_PARAM
  * 	@a swm_name was @c NULL, or @a part_size was 0.
@@ -1944,9 +2133,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().
@@ -1964,8 +2154,9 @@ extern int wimlib_split(WIMStruct *wim, const char *swm_name,
  * @param dir
  * 	The directory that the WIM image was mounted on.
  * @param unmount_flags
- * 	Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY and/or
- * 	::WIMLIB_UNMOUNT_FLAG_COMMIT.  Neither of these flags affect read-only
+ * 	Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
+ * 	::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
+ * 	::WIMLIB_UNMOUNT_FLAG_RECOMPRESS.  None of these flags affect read-only
  * 	mounts.
  * @param progress_func
  * 	If non-NULL, a function that will be called periodically with the
@@ -2004,8 +2195,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 +2240,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 +2267,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 */