X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwimlib.h;h=7a2fad7d8c3c87b595f848db31ba7876307fd39d;hp=ea5966ce9bc23c5060a07295dfe00b921b9fa687;hb=500d90055cae33925961076f4eda19bb2ec57d8c;hpb=13c6ce3160fce7c40008d1d182325c8b42450d1e

diff --git a/src/wimlib.h b/src/wimlib.h
index ea5966ce..7a2fad7d 100644
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -31,7 +31,7 @@
  *
  * \section intro Introduction
  *
- * This is the documentation for the library interface of wimlib 1.3.2.  If you
+ * This is the documentation for the library interface of wimlib 1.3.3.  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
@@ -253,7 +253,7 @@
 #define WIMLIB_MINOR_VERSION 3
 
 /** Patch version of the library (for example, the 5 in 1.2.5). */
-#define WIMLIB_PATCH_VERSION 2
+#define WIMLIB_PATCH_VERSION 3
 
 /**
  * Opaque structure that represents a WIM file.  This is an in-memory structure
@@ -431,6 +431,7 @@ union wimlib_progress_info {
 		 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
 		int	 compression_type;
 
+		/** Library internal use only. */
 		uint64_t _private;
 	} write_streams;
 
@@ -693,6 +694,22 @@ struct wimlib_capture_config {
  * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE. */
 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE		0x00000080
 
+/** Reparse-point fixups:  Modify absolute symbolic links (or junction points,
+ * in the case of Windows) that point inside the directory being captured to
+ * instead be absolute relative to the directory being captured, rather than the
+ * current root; also exclude absolute symbolic links that point outside the
+ * directory tree being captured.
+ *
+ * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
+ * the WIM header or if this is the first image being added.
+ * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
+ * reparse point fixups enabled and currently cannot be unset. */
+#define WIMLIB_ADD_IMAGE_FLAG_RPFIX			0x00000100
+
+/* Don't do reparse point fixups.  The default behavior is described in the
+ * documentation for ::WIMLIB_ADD_IMAGE_FLAG_RPFIX. */
+#define WIMLIB_ADD_IMAGE_FLAG_NORPFIX			0x00000200
+
 /******************************
  * WIMLIB_EXPORT_FLAG_* *
  ******************************/
@@ -740,6 +757,16 @@ struct wimlib_capture_config {
  * not have permission to set the desired one. */
 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS			0x00000080
 
+/* Extract equivalent to ::WIMLIB_ADD_IMAGE_FLAG_RPFIX; force reparse-point
+ * fixups on, so absolute symbolic links or junction points will be fixed to be
+ * absolute relative to the actual extraction root.  Done by default if
+ * WIM_HDR_FLAG_RP_FIX is set in the WIM header. */
+#define WIMLIB_EXTRACT_FLAG_RPFIX			0x00000100
+
+/** Force reparse-point fixups on extraction off, regardless of the state of the
+ * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
+#define WIMLIB_EXTRACT_FLAG_NORPFIX			0x00000200
+
 /******************************
  * WIMLIB_MOUNT_FLAG_*        *
  ******************************/
@@ -827,6 +854,10 @@ struct wimlib_capture_config {
  * deleting an image in this way. */
 #define WIMLIB_WRITE_FLAG_SOFT_DELETE			0x00000010
 
+/** Assume that strings are represented in UTF-8, even if this is not the
+ * locale's character encoding. */
+#define WIMLIB_INIT_FLAG_ASSUME_UTF8			0x00000001
+
 
 #if 0
 /****************************************************************
@@ -911,6 +942,7 @@ enum wimlib_error_code {
 	WIMLIB_ERR_ICONV_NOT_AVAILABLE,
 	WIMLIB_ERR_IMAGE_COUNT,
 	WIMLIB_ERR_IMAGE_NAME_COLLISION,
+	WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT,
 	WIMLIB_ERR_INTEGRITY,
 	WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
 	WIMLIB_ERR_INVALID_CHUNK_SIZE,
@@ -924,6 +956,7 @@ enum wimlib_error_code {
 	WIMLIB_ERR_INVALID_OVERLAY,
 	WIMLIB_ERR_INVALID_PARAM,
 	WIMLIB_ERR_INVALID_PART_NUMBER,
+	WIMLIB_ERR_INVALID_REPARSE_DATA,
 	WIMLIB_ERR_INVALID_RESOURCE_HASH,
 	WIMLIB_ERR_INVALID_RESOURCE_SIZE,
 	WIMLIB_ERR_INVALID_SECURITY_DATA,
@@ -945,6 +978,7 @@ enum wimlib_error_code {
 	WIMLIB_ERR_READLINK,
 	WIMLIB_ERR_RENAME,
 	WIMLIB_ERR_REOPEN,
+	WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
 	WIMLIB_ERR_RESOURCE_ORDER,
 	WIMLIB_ERR_SPECIAL_FILE,
 	WIMLIB_ERR_SPLIT_INVALID,
@@ -954,6 +988,7 @@ enum wimlib_error_code {
 	WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
 	WIMLIB_ERR_UNKNOWN_VERSION,
 	WIMLIB_ERR_UNSUPPORTED,
+	WIMLIB_ERR_VOLUME_LACKS_FEATURES,
 	WIMLIB_ERR_WRITE,
 	WIMLIB_ERR_XML,
 };
@@ -968,12 +1003,9 @@ enum wimlib_error_code {
 /**
  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
  *
- * 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
+ * The directory tree or NTFS volume is scanned immediately to load the dentry
+ * tree into memory, and file attributes and symbolic links are read.  However,
+ * actual file data is not read until wimlib_write() or wimlib_overwrite() is
  * called.
  *
  * See the manual page for the @b wimlib-imagex program for more information
@@ -1561,17 +1593,24 @@ wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
  * threads, then you must call this function serially first.
  *
  * Since wimlib 1.3.0, you must call this function if the character encoding of
- * the current locale is not UTF-8.
+ * the current locale is not UTF-8 and you do not want wimlib to assume a UTF-8
+ * encoding.
  *
  * Since wimlib 1.3.2, you must call this function if using the Windows-native
  * build of the library so that certain functions can be dynamically loaded from
  * system DLLs.
  *
- * This function currently always returns 0, but it may return other error codes
- * in future releases.
+ * Since wimlib 1.3.3, this function takes the @a init_flags parameter.
+ *
+ * @param init_flags
+ * 	::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume that all input
+ * 	data, including filenames, are in UTF-8, and that UTF-8 data can be
+ * 	directly printed to the console.
+ *
+ * @return 0; other error codes may be returned in future releases.
  */
 extern int
-wimlib_global_init();
+wimlib_global_init(int init_flags);
 
 /**
  * Since wimlib 1.2.6:  Cleanup function for wimlib.  This is not re-entrant.
@@ -1674,14 +1713,6 @@ wimlib_join(const wimlib_tchar * const *swms,
  *
  * As a special requirement, the compression code is optimized for the WIM
  * format and therefore requires (@a chunk_size <= 32768).
- *
- * As another special requirement, the compression code will read up to 8 bytes
- * off the end of the @a chunk array for performance reasons.  The values of
- * these bytes will not affect the output of the compression, but the calling
- * code must make sure that the buffer holding the uncompressed chunk is
- * actually at least (@a chunk_size + 8) bytes, or at least that these extra
- * bytes are in mapped memory that will not cause a memory access violation if
- * accessed.
  */
 extern unsigned
 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
@@ -1943,6 +1974,10 @@ wimlib_open_wim(const wimlib_tchar *wim_file,
  * and while abnormal termination of the program will result in extra data
  * appended to the original WIM, it should still be a valid WIM.
  *
+ * If this function completes successfully, no functions should be called on @a
+ * wim other than wimlib_free().  You must use wimlib_open_wim() to read the WIM
+ * file anew.
+ *
  * @param wim
  * 	Pointer to the ::WIMStruct for the WIM file to write.  There may have
  * 	been in-memory changes made to it, which are then reflected in the
@@ -1970,11 +2005,6 @@ wimlib_open_wim(const wimlib_tchar *wim_file,
  * @retval ::WIMLIB_ERR_RENAME
  * 	The temporary file that the WIM was written to could not be renamed to
  * 	the original filename of @a wim.
- * @retval ::WIMLIB_ERR_REOPEN
- * 	The WIM was overwritten successfully, but it could not be re-opened
- * 	read-only.  Therefore, the resources in the WIM can no longer be
- * 	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,