70b1781facef4367a17b4390eba73830314f6ac9
[wimlib] / include / wimlib.h
1 /**
2  * @file wimlib.h
3  * @brief External header for wimlib.
4  *
5  * This file contains extensive comments for generating documentation with
6  * Doxygen.  The built HTML documentation can be viewed at
7  * http://wimlib.sourceforge.net.  Make sure to see the <a
8  * href="modules.html">Modules page</a> to make more sense of the declarations
9  * in this header.
10  */
11
12 /**
13  * @mainpage
14  *
15  * This is the documentation for the library interface of wimlib 1.7.4, a C
16  * library for creating, modifying, extracting, and mounting files in the
17  * Windows Imaging Format.  This documentation is intended for developers only.
18  * If you have installed wimlib and want to know how to use the @b wimlib-imagex
19  * program, please see the manual pages and also the <a
20  * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/README">README
21  * file</a>.
22  *
23  * @section sec_installing Installing
24  *
25  * @subsection UNIX
26  *
27  * Download the source code from <a
28  * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
29  * Install the library by running <c>configure && make && sudo make install</c>.
30  * See the README for information about configuration options.  To use wimlib in
31  * your program after installing it, include wimlib.h and link your program with
32  * <c>-lwim</c>.
33  *
34  * @subsection Windows
35  *
36  * Download the Windows binary distribution with the appropriate architecture
37  * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from <a
38  * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
39  * Link your program with the libwim-15.dll file.  Make sure to also download
40  * the source code so you can get wimlib.h, as it is not included in the binary
41  * distribution.  If you need to access the DLL from other programming
42  * languages, note that the calling convention is "cdecl".
43  *
44  * @section sec_examples Examples
45  *
46  * Several examples are located in the <a
47  * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/examples">examples</a>
48  * directory of the source distribution.
49  *
50  * There is also the <a
51  * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/programs/imagex.c">
52  * source code of <b>wimlib-imagex</b></a>, which is complicated but uses most
53  * capabilities of wimlib.
54  *
55  * @section backwards_compatibility Backwards Compatibility
56  *
57  * New releases of wimlib are intended to be API/ABI compatible with old
58  * releases, except when the libtool "age" is reset.  This most recently
59  * occurred for the v1.4.0 (libwim7), v1.5.0 (libwim9), and v1.7.0 (libwim15)
60  * releases.  However, the library is becoming increasingly stable, and the goal
61  * is to maintain the current API/ABI for as long as possible unless there is a
62  * strong reason not to.  Even for the v1.7.0 release (libwim15), the changes
63  * were fairly limited.
64  *
65  * As with any other library, applications should not rely on internal
66  * implementation details that may be subject to change.
67  *
68  * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
69  *
70  * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.   There are
71  * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
72  * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
73  * which creates a new ::WIMStruct that initially contains no images and does
74  * not yet have a backing on-disk file.  See @ref G_creating_and_opening_wims
75  * for more details.
76  *
77  * A WIM file, represented by a ::WIMStruct, contains zero or more images.
78  * Images can be extracted (or "applied") using wimlib_extract_image(), added
79  * (or "captured" or "appended") using wimlib_add_image(), deleted using
80  * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
81  * modified using wimlib_update_image().  However, changes made to a WIM
82  * represented by a ::WIMStruct have no persistent effect until the WIM is
83  * actually written to an on-disk file.  This can be done using wimlib_write(),
84  * but if the WIM was originally opened using wimlib_open_wim(), then
85  * wimlib_overwrite() can be used instead.  See @ref G_extracting_wims, @ref
86  * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
87  *
88  * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
89  * files is a multi-step process.  For example, to add, or "append" an image to
90  * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
91  * append</b>, you must call the following functions:
92  *
93  * 1. wimlib_open_wim()
94  * 2. wimlib_add_image()
95  * 3. wimlib_overwrite()
96  *
97  * This design is very much on purpose as it makes the library more useful in
98  * general by allowing functions to be composed in different ways.  For example,
99  * you can make multiple changes to a WIM and commit them all to the underlying
100  * file in only one overwrite operation, which is more efficient.
101  *
102  * Note: before calling any other function declared in wimlib.h,
103  * wimlib_global_init() can (and in some cases, must) be called.  See its
104  * documentation for more details.
105  *
106  * @section sec_cleaning_up Cleaning up
107  *
108  * After you are done with any ::WIMStruct, you can call wimlib_free() to free
109  * all resources associated with it.  Also, when you are completely done with
110  * using wimlib in your program, you can call wimlib_global_cleanup() to free
111  * any other resources allocated by the library.
112  *
113  * @section sec_error_handling Error Handling
114  *
115  * Most functions in wimlib return 0 on success and a positive error code on
116  * failure.  Use wimlib_get_error_string() to get a string that describes an
117  * error code.  wimlib also can print error messages to standard error itself
118  * when an error happens, and these may be more informative than the error code;
119  * to enable this, call wimlib_set_print_errors().  Please note that this is for
120  * convenience only, and some errors can occur without a message being printed.
121  * Currently, error messages and strings (as well as all documentation, for that
122  * matter) are only available in English.
123  *
124  * @section sec_encodings Locales and character encodings
125  *
126  * To support Windows as well as UNIX-like systems, wimlib's API typically takes
127  * and returns strings of ::wimlib_tchar, which are in a platform-dependent
128  * encoding.
129  *
130  * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
131  * and the encoding is UTF-16LE.
132  *
133  * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
134  * and the encoding is the locale-dependent multibyte encoding.  I recommend you
135  * set your locale to a UTF-8 capable locale to avoid any issues.  Also, by
136  * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
137  * call wimlib_global_init() after having set your desired locale.
138  *
139  * @section sec_advanced Additional information and features
140  *
141  *
142  * @subsection subsec_mounting_wim_images Mounting WIM images
143  *
144  * See @ref G_mounting_wim_images.
145  *
146  * @subsection subsec_progress_functions Progress Messages
147  *
148  * See @ref G_progress.
149  *
150  * @subsection subsec_non_standalone_wims Non-standalone WIMs
151  *
152  * See @ref G_nonstandalone_wims.
153  *
154  * @subsection subsec_pipable_wims Pipable WIMs
155  *
156  * wimlib supports a special "pipable" WIM format which unfortunately is @b not
157  * compatible with Microsoft's software.  To create a pipable WIM, call
158  * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
159  * ::WIMLIB_WRITE_FLAG_PIPABLE specified.  Pipable WIMs are pipable in both
160  * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
161  * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
162  * a pipable WIM.  wimlib can also transparently open and operate on pipable WIM
163  * s using a seekable file descriptor using the regular function calls (e.g.
164  * wimlib_open_wim(), wimlib_extract_image()).
165  *
166  * See the documentation for the <b>--pipable</b> flag of <b>wimlib-imagex
167  * capture</b> for more information about pipable WIMs.
168  *
169  * @subsection subsec_thread_safety Thread Safety
170  *
171  * wimlib is thread-safe, with the following exceptions:
172  * - Different threads cannot operate on the same ::WIMStruct at the same time;
173  *   they must use different ::WIMStruct's.
174  * - You must call wimlib_global_init() in one thread before calling any other
175  *   functions.
176  * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
177  * - wimlib_mount_image(), while it can be used to mount multiple WIMs
178  *   concurrently in the same process, will daemonize the entire process when it
179  *   does so for the first time.  This includes changing the working directory
180  *   to the root directory.
181  *
182  * @subsection subsec_limitations Limitations
183  *
184  * This section documents some technical limitations of wimlib not already
185  * documented in the man page for @b wimlib-imagex.
186  *
187  * - The old WIM format from Vista pre-releases is not supported.
188  * - wimlib does not provide a clone of the @b PEImg tool, or the @b DISM
189  *   functionality other than that already present in @b ImageX, that allows you
190  *   to make certain Windows-specific modifications to a Windows PE image, such
191  *   as adding a driver or Windows component.  Such a tool could be implemented
192  *   on top of wimlib.
193  *
194  * @subsection more_info More information
195  *
196  * You are advised to read the README as well as the manual pages for
197  * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
198  * the API documentation.
199  */
200
201 /** @defgroup G_general General
202  *
203  * @brief Declarations and structures shared across the library.
204  */
205
206 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
207  *
208  * @brief Create new WIMs and open existing WIMs.
209  */
210
211 /** @defgroup G_wim_information Retrieving WIM information and directory listings
212  *
213  * @brief Retrieve information about a WIM or WIM image.
214  */
215
216 /** @defgroup G_modifying_wims Modifying WIMs
217  *
218  * @brief Make changes to a WIM.
219  *
220  * @section sec_adding_images Capturing and adding WIM images
221  *
222  * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
223  * appending an image to an existing WIM is a multi-step process, but at its
224  * core is wimlib_add_image() or an equivalent function.  Normally,
225  * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
226  * ::WIMStruct as a new image.  However, when supported by the build of the
227  * library, there is also a special NTFS volume capture mode (entered when
228  * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
229  * from an unmounted NTFS volume.
230  *
231  * Another function, wimlib_add_image_multisource() is also provided.  It
232  * generalizes wimlib_add_image() to allow combining multiple files or directory
233  * trees into a single WIM image in a configurable way.
234  *
235  * For maximum customization of WIM image creation, it is also possible to add a
236  * completely empty WIM image with wimlib_add_empty_image(), then update it with
237  * wimlib_update_image().  (This is in fact what wimlib_add_image() and
238  * wimlib_add_image_multisource() do internally.)
239  *
240  * Note that some details of how image addition/capture works are documented
241  * more fully in the manual page for <b>wimlib-imagex capture</b>.
242  *
243  * @section sec_deleting_images Deleting WIM images
244  *
245  * wimlib_delete_image() can delete an image from a ::WIMStruct.  But as usual,
246  * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
247  * be made persistent in an on-disk WIM file.
248  *
249  * @section sec_exporting_images Exporting WIM images
250  *
251  * wimlib_export_image() can copy, or "export", an image from one WIM to
252  * another.
253  *
254  * @section sec_other_modifications Other modifications
255  *
256  * wimlib_update_image() can add, delete, and rename files in a WIM image.
257  *
258  * wimlib_set_image_name(), wimlib_set_image_descripton(), and
259  * wimlib_set_image_flags() can change other image metadata.
260  *
261  * wimlib_set_wim_info() can change information about the WIM file itself, such
262  * as the boot index.
263  */
264
265 /** @defgroup G_extracting_wims Extracting WIMs
266  *
267  * @brief Extract files, directories, and images from a WIM.
268  *
269  * wimlib_extract_image() extracts, or "applies", an image from a WIM,
270  * represented by a ::WIMStruct.  This normally extracts the image to a
271  * directory, but when supported by the build of the library there is also a
272  * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
273  * is specified) that allows extracting a WIM image directly to an unmounted
274  * NTFS volume.  Various other flags allow further customization of image
275  * extraction.
276  *
277  * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
278  * of (possibly wildcard) paths from a WIM image.
279  *
280  * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
281  * over a pipe; see @ref subsec_pipable_wims.
282  *
283  * Some details of how WIM extraction works are documented more fully in the
284  * manual pages for <b>wimlib-imagex apply</b> and <b>wimlib-imagex extract</b>.
285  */
286
287 /** @defgroup G_mounting_wim_images Mounting WIM images
288  *
289  * @brief Mount and unmount WIM images.
290  *
291  * On Linux, wimlib supports mounting images from WIM files either read-only or
292  * read-write.  To mount an image, call wimlib_mount_image().  To unmount an
293  * image, call wimlib_unmount_image().  Mounting can be done without root
294  * privileges because it is implemented using FUSE (Filesystem in Userspace).
295  *
296  * If wimlib is compiled using the <code>--without-fuse</code> flag, these
297  * functions will be available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
298  *
299  * Note: if mounting is unsupported, wimlib still provides another way to modify
300  * a WIM image (wimlib_update_image()).
301  */
302
303 /**
304  * @defgroup G_progress Progress Messages
305  *
306  * @brief Track the progress of long WIM operations.
307  *
308  * Library users can provide a progress function which will be called
309  * periodically during operations such as extracting a WIM image or writing a
310  * WIM image.  A ::WIMStruct can have a progress function of type
311  * ::wimlib_progress_func_t associated with it by calling
312  * wimlib_register_progress_function() or by opening the ::WIMStruct using
313  * wimlib_open_wim_with_progress().  Once this is done, the progress function
314  * will be called automatically during many operations, such as
315  * wimlib_extract_image() and wimlib_write().
316  *
317  * Some functions that do not operate directly on a user-provided ::WIMStruct,
318  * such as wimlib_join(), also take the progress function directly using an
319  * extended version of the function, such as wimlib_join_with_progress().
320  *
321  * In wimlib v1.7.0 and later, progress functions are no longer just
322  * unidirectional.  You can now return ::WIMLIB_PROGRESS_STATUS_ABORT to cause
323  * the current operation to be aborted.  wimlib v1.7.0 also added the third
324  * argument to ::wimlib_progress_func_t, which is a user-supplied context.
325  */
326
327 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
328  *
329  * @brief Write and overwrite on-disk WIM files.
330  *
331  * As described in @ref sec_basic_wim_handling_concepts, these functions are
332  * fundamental to the design of the library as they allow new or modified
333  * ::WIMStruct's to actually be written to on-disk files.  Call wimlib_write()
334  * to write a new WIM file, or wimlib_overwrite() to persistently update an
335  * existing WIM file.
336  */
337
338 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
339  *
340  * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
341  *
342  * Normally, a ::WIMStruct represents a WIM file, but there's a bit more to it
343  * than that.  Normally, WIM files are "standalone".  However, WIM files can
344  * also be arranged in non-standalone ways, such as a set of on-disk files that
345  * together form a single "split WIM" or "delta WIM".  Such arrangements are
346  * fully supported by wimlib.  However, as a result, in such cases a ::WIMStruct
347  * created from one of these on-disk files initially only partially represents
348  * the full WIM and needs to, in effect, be logically combined with other
349  * ::WIMStruct's before performing certain operations, such as extracting files
350  * with wimlib_extract_image() or wimlib_extract_paths().  This is done by
351  * calling wimlib_reference_resource_files() or wimlib_reference_resources().
352  *
353  * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
354  * specialized function (wimlib_split()) is needed to create a split WIM.
355  */
356
357 #ifndef _WIMLIB_H
358 #define _WIMLIB_H
359
360 #include <stdio.h>
361 #include <stddef.h>
362 #include <stdbool.h>
363 #include <inttypes.h>
364 #include <time.h>
365
366 #ifdef __GNUC__
367 #  define _wimlib_deprecated __attribute__((deprecated))
368 #else
369 #  define _wimlib_deprecated
370 #endif
371
372 /** @addtogroup G_general
373  * @{ */
374
375 /** Major version of the library (for example, the 1 in 1.2.5).  */
376 #define WIMLIB_MAJOR_VERSION 1
377
378 /** Minor version of the library (for example, the 2 in 1.2.5). */
379 #define WIMLIB_MINOR_VERSION 7
380
381 /** Patch version of the library (for example, the 5 in 1.2.5). */
382 #define WIMLIB_PATCH_VERSION 4
383
384 #ifdef __cplusplus
385 extern "C" {
386 #endif
387
388 /**
389  * Opaque structure that represents a WIM file.  This is an in-memory structure
390  * and need not correspond to a specific on-disk file.  However, a ::WIMStruct
391  * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
392  * continuing to exist so that data can be read from it as needed.
393  *
394  * Most functions in this library will work the same way regardless of whether a
395  * given ::WIMStruct was obtained through wimlib_open_wim() or
396  * wimlib_create_new_wim().  Exceptions are documented.
397  *
398  * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
399  * file from a ::WIMStruct.
400  *
401  * See @ref sec_basic_wim_handling_concepts for more information.
402  */
403 #ifndef WIMLIB_WIMSTRUCT_DECLARED
404 typedef struct WIMStruct WIMStruct;
405 #define WIMLIB_WIMSTRUCT_DECLARED
406 #endif
407
408 #ifdef __WIN32__
409 typedef wchar_t wimlib_tchar;
410 #else
411 /** See @ref sec_encodings */
412 typedef char wimlib_tchar;
413 #endif
414
415 #ifdef __WIN32__
416 /** Path separator for WIM paths passed back to progress callbacks.
417  * This is forward slash on UNIX and backslash on Windows.  */
418 #  define WIMLIB_WIM_PATH_SEPARATOR '\\'
419 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
420 #else
421 /** Path separator for WIM paths passed back to progress callbacks.
422  * This is forward slash on UNIX and backslash on Windows.  */
423 #  define WIMLIB_WIM_PATH_SEPARATOR '/'
424 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
425 #endif
426
427 /** Use this to specify the root directory of the WIM image.  */
428 #define WIMLIB_WIM_ROOT_PATH WIMLIB_WIM_PATH_SEPARATOR_STRING
429
430 /** Use this to test if the specified path refers to the root directory of the
431  * WIM image.  */
432 #define WIMLIB_IS_WIM_ROOT_PATH(path) \
433                 ((path)[0] == WIMLIB_WIM_PATH_SEPARATOR &&      \
434                  (path)[1] == 0)
435
436 /** Length of a Globally Unique Identifier (GUID)  */
437 #define WIMLIB_GUID_LEN 16
438
439 /**
440  * Specifies a compression format.  Pass one of these values to
441  * wimlib_create_new_wim(), wimlib_set_output_compression_type(),
442  * wimlib_create_compressor(), or wimlib_create_decompressor().
443  *
444  * A WIM file has one default compression type and chunk size.  Normally, each
445  * resource in the WIM file is compressed with this compression type.  However,
446  * resources may be stored as uncompressed; for example, wimlib will do so if a
447  * resource does not compress to less than its original size.  In addition, a
448  * WIM with the new version number of 3584, or "ESD file", might contain solid
449  * blocks with different compression types.
450  */
451 enum wimlib_compression_type {
452         /**
453          * No compression.
454          *
455          * This is a valid argument to wimlib_create_new_wim() and
456          * wimlib_set_output_compression_type(), but not to the functions in the
457          * compression API such as wimlib_create_compressor().
458          */
459         WIMLIB_COMPRESSION_TYPE_NONE = 0,
460
461         /**
462          * The XPRESS compression format.  This format combines Lempel-Ziv
463          * factorization with Huffman encoding.  Compression and decompression
464          * are both fast.  This format supports chunk sizes that are powers of 2
465          * between <c>2^12</c> and <c>2^16</c>, inclusively.
466          *
467          * wimlib's XPRESS compressor will, with the default settings, usually
468          * produce a better compression ratio, and work more quickly, than the
469          * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
470          * Non-default compression levels are also supported.  For example,
471          * level 80 will enable two-pass optimal parsing, which is significantly
472          * slower but usually improves compression by several percent over the
473          * default level of 50.
474          *
475          * If using wimlib_create_compressor() to create an XPRESS compressor
476          * directly, the @p max_block_size parameter may be any positive value
477          * up to and including <c>2^16</c>.
478          */
479         WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
480
481         /**
482          * The LZX compression format.  This format combines Lempel-Ziv
483          * factorization with Huffman encoding, but with more features and
484          * complexity than XPRESS.  Compression is slow to somewhat fast,
485          * depending on the settings.  Decompression is fast but slower than
486          * XPRESS.  This format supports chunk sizes that are powers of 2
487          * between <c>2^15</c> and <c>2^21</c>, inclusively.  Note: chunk sizes
488          * other than <c>2^15</c> are not compatible with the Microsoft
489          * implementation.
490          *
491          * wimlib's LZX compressor will, with the default settings, usually
492          * produce a better compression ratio, and work more quickly, than the
493          * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
494          * Non-default compression levels are also supported.  For example,
495          * level 20 will provide fast compression, almost as fast as XPRESS.
496          *
497          * If using wimlib_create_compressor() to create an LZX compressor
498          * directly, the @p max_block_size parameter may be any positive value
499          * up to and including <c>2^21</c>.
500          */
501         WIMLIB_COMPRESSION_TYPE_LZX = 2,
502
503         /**
504          * The LZMS compression format.  This format combines Lempel-Ziv
505          * factorization with adaptive Huffman encoding and range coding.
506          * Compression and decompression are both fairly slow.  This format
507          * supports chunk sizes that are powers of 2 between <c>2^15</c> and
508          * <c>2^30</c>, inclusively.  This format is best used for large chunk
509          * sizes.  Note: LZMS compression is only compatible with wimlib v1.6.0
510          * and later, WIMGAPI Windows 8 and later, and DISM Windows 8.1 and
511          * later.  Also, chunk sizes larger than <c>2^26</c> are not compatible
512          * with the Microsoft implementation.
513          *
514          * wimlib's LZMS compressor will, with the default settings, usually
515          * produce a better compression ratio, and work more quickly, than the
516          * implementation in Microsoft's WIMGAPI (as of Windows 8.1).  There is
517          * limited support for non-default compression levels, but compression
518          * will be noticably faster if you choose a level < 35.
519          *
520          * If using wimlib_create_compressor() to create an LZMS compressor
521          * directly, the @p max_block_size parameter may be any positive value
522          * up to and including <c>2^30</c>.
523          */
524         WIMLIB_COMPRESSION_TYPE_LZMS = 3,
525 };
526
527 /** @} */
528 /** @addtogroup G_progress
529  * @{ */
530
531 /** Possible values of the first parameter to the user-supplied
532  * ::wimlib_progress_func_t progress function */
533 enum wimlib_progress_msg {
534
535         /** A WIM image is about to be extracted.  @p info will point to
536          * ::wimlib_progress_info.extract.  This message is received once per
537          * image for calls to wimlib_extract_image() and
538          * wimlib_extract_image_from_pipe().  */
539         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
540
541         /** One or more file or directory trees within a WIM image is about to
542          * be extracted.  @p info will point to ::wimlib_progress_info.extract.
543          * This message is received only once per wimlib_extract_paths() and
544          * wimlib_extract_pathlist(), since wimlib combines all paths into a
545          * single extraction operation for optimization purposes.  */
546         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN = 1,
547
548         /** This message may be sent periodically (not for every file) while
549          * files or directories are being created, prior to data stream
550          * extraction.  @p info will point to ::wimlib_progress_info.extract.
551          * In particular, the @p current_file_count and @p end_file_count
552          * members may be used to track the progress of this phase of
553          * extraction.  */
554         WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE = 3,
555
556         /** File data is currently being extracted.  @p info will point to
557          * ::wimlib_progress_info.extract.  This is the main message to track
558          * the progress of an extraction operation.  */
559         WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS = 4,
560
561         /** Starting to read a new part of a split pipable WIM over the pipe.
562          * @p info will point to ::wimlib_progress_info.extract.  */
563         WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN = 5,
564
565         /** This message may be sent periodically (not for every file) while
566          * file and directory metadata is being applied, following data stream
567          * extraction.  @p info will point to ::wimlib_progress_info.extract.
568          * In particular, the @p current_file_count and @p end_file_count
569          * members may be used to track the progress of this phase of
570          * extraction.  */
571         WIMLIB_PROGRESS_MSG_EXTRACT_METADATA = 6,
572
573         /** Confirms that the image has been successfully extracted.  @p info
574          * will point to ::wimlib_progress_info.extract.  This is paired with
575          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN.  */
576         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END = 7,
577
578         /** Confirms that the files or directory trees have been successfully
579          * extracted.  @p info will point to ::wimlib_progress_info.extract.
580          * This is paired with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN.  */
581         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END = 8,
582
583         /** The directory or NTFS volume is about to be scanned for metadata.
584          * @p info will point to ::wimlib_progress_info.scan.  This message is
585          * received once per call to wimlib_add_image(), or once per capture
586          * source passed to wimlib_add_image_multisource(), or once per add
587          * command passed to wimlib_update_image().  */
588         WIMLIB_PROGRESS_MSG_SCAN_BEGIN = 9,
589
590         /** A directory or file has been scanned.  @p info will point to
591          * ::wimlib_progress_info.scan, and its @p cur_path member will be
592          * valid.  This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
593          * been specified.  */
594         WIMLIB_PROGRESS_MSG_SCAN_DENTRY = 10,
595
596         /** Confirms that the directory or NTFS volume has been successfully
597          * scanned.  @p info will point to ::wimlib_progress_info.scan.  This is
598          * paired with a previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message,
599          * possibly with many intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY
600          * messages.  */
601         WIMLIB_PROGRESS_MSG_SCAN_END = 11,
602
603         /** File resources ("streams") are currently being written to the WIM.
604          * @p info will point to ::wimlib_progress_info.write_streams.  This
605          * message may be received many times while the WIM file is being
606          * written or appended to with wimlib_write(), wimlib_overwrite(), or
607          * wimlib_write_to_fd().  */
608         WIMLIB_PROGRESS_MSG_WRITE_STREAMS = 12,
609
610         /** Per-image metadata is about to be written to the WIM file.  @p info
611          * will not be valid. */
612         WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN = 13,
613
614         /** Confirms that per-image metadata has been successfully been written
615          * to the WIM file.  @p info will not be valid.  This message is paired
616          * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
617          */
618         WIMLIB_PROGRESS_MSG_WRITE_METADATA_END = 14,
619
620         /** wimlib_overwrite() has successfully renamed the temporary file to
621          * the original WIM file, thereby committing the update.  @p info will
622          * point to ::wimlib_progress_info.rename.  Note: this message is not
623          * received if wimlib_overwrite() chose to append to the WIM file
624          * in-place.  */
625         WIMLIB_PROGRESS_MSG_RENAME = 15,
626
627         /** The contents of the WIM file are being checked against the integrity
628          * table.  @p info will point to ::wimlib_progress_info.integrity.  This
629          * message is only received (and may be received many times) when
630          * wimlib_open_wim_with_progress() is called with the
631          * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag.  */
632         WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY = 16,
633
634         /** An integrity table is being calculated for the WIM being written.
635          * @p info will point to ::wimlib_progress_info.integrity.  This message
636          * is only received (and may be received many times) when a WIM file is
637          * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.  */
638         WIMLIB_PROGRESS_MSG_CALC_INTEGRITY = 17,
639
640         /** A wimlib_split() operation is in progress, and a new split part is
641          * about to be started.  @p info will point to
642          * ::wimlib_progress_info.split.  */
643         WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART = 19,
644
645         /** A wimlib_split() operation is in progress, and a split part has been
646          * finished. @p info will point to ::wimlib_progress_info.split.  */
647         WIMLIB_PROGRESS_MSG_SPLIT_END_PART = 20,
648
649         /** A WIM update command is just about to be executed. @p info will
650          * point to ::wimlib_progress_info.update.  This message is received
651          * once per update command when wimlib_update_image() is called with the
652          * flag ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS.  */
653         WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND = 21,
654
655         /** A WIM update command has just been executed. @p info will point to
656          * ::wimlib_progress_info.update.  This message is received once per
657          * update command when wimlib_update_image() is called with the flag
658          * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS.  */
659         WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND = 22,
660
661         /** A file in the WIM image is being replaced as a result of a
662          * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
663          * @p info will point to ::wimlib_progress_info.replace.  This is only
664          * received when ::WIMLIB_ADD_FLAG_VERBOSE is also specified in the add
665          * command.  */
666         WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM = 23,
667
668         /** A WIM image is being applied with ::WIMLIB_EXTRACT_FLAG_WIMBOOT, and
669          * a file is being extracted normally (not as a WIMBoot "pointer file")
670          * due to it matching a pattern in the [PrepopulateList] section of the
671          * configuration file @c \\Windows\\System32\\WimBootCompress.ini in the
672          * WIM image.  @p info will point to
673          * ::wimlib_progress_info.wimboot_exclude.
674          */
675         WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24,
676
677         /** Starting to unmount a WIM image.  @p info will point to
678          * ::wimlib_progress_info.unmount.  */
679         WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN = 25,
680
681         /** wimlib has used a file's data for the last time (including all data
682          * streams, if it has multiple).  @p info will point to
683          * ::wimlib_progress_info.done_with_file.  This message is only received
684          * if ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES was provided.  */
685         WIMLIB_PROGRESS_MSG_DONE_WITH_FILE = 26,
686
687         /** wimlib_verify_wim() is starting to verify the metadata for an image.
688          * @p info will point to ::wimlib_progress_info.verify_image.  */
689         WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE = 27,
690
691         /** wimlib_verify_wim() has finished verifying the metadata for an
692          * image.  @p info will point to ::wimlib_progress_info.verify_image.
693          */
694         WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE = 28,
695
696         /** wimlib_verify_wim() is verifying stream integrity.  @p info will
697          * point to ::wimlib_progress_info.verify_streams.  */
698         WIMLIB_PROGRESS_MSG_VERIFY_STREAMS = 29,
699
700         /**
701          * The progress function is being asked whether a file should be
702          * excluded from capture or not.  @p info will point to
703          * ::wimlib_progress_info.test_file_exclusion.  This is a bidirectional
704          * message that allows the progress function to set a flag if the file
705          * should be excluded.
706          *
707          * This message is only received if the flag
708          * ::WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION is used.  This method for file
709          * exclusions is independent of the "capture configuration file"
710          * mechanism.
711          */
712         WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION = 30,
713
714         /**
715          * An error has occurred and the progress function is being asked
716          * whether to ignore the error or not.  @p info will point to
717          * ::wimlib_progress_info.handle_error.  This is a bidirectional
718          * message.
719          *
720          * This message provides a limited capability for applications to
721          * recover from "unexpected" errors (i.e. those with no in-library
722          * handling policy) arising from the underlying operating system.
723          * Normally, any such error will cause the library to abort the current
724          * operation.  By implementing a handler for this message, the
725          * application can instead choose to ignore a given error.
726          *
727          * Currently, only the following types of errors will result in this
728          * progress message being sent:
729          *
730          *      - Directory tree scan errors, e.g. from wimlib_add_image()
731          *      - Most extraction errors; currently restricted to the Windows
732          *        build of the library only.
733          */
734         WIMLIB_PROGRESS_MSG_HANDLE_ERROR = 31,
735 };
736
737 /** Valid return values from user-provided progress functions
738  * (::wimlib_progress_func_t).
739  *
740  * (Note: if an invalid value is returned, ::WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS
741  * will be issued.)
742  */
743 enum wimlib_progress_status {
744
745         /** The operation should be continued.  This is the normal return value.
746          */
747         WIMLIB_PROGRESS_STATUS_CONTINUE = 0,
748
749         /** The operation should be aborted.  This will cause the current
750          * operation to fail with ::WIMLIB_ERR_ABORTED_BY_PROGRESS.  */
751         WIMLIB_PROGRESS_STATUS_ABORT    = 1,
752 };
753
754 /**
755  * A pointer to this union is passed to the user-supplied
756  * ::wimlib_progress_func_t progress function.  One (or none) of the structures
757  * contained in this union will be applicable for the operation
758  * (::wimlib_progress_msg) indicated in the first argument to the progress
759  * function. */
760 union wimlib_progress_info {
761
762         /* N.B. I wanted these to be anonymous structs, but Doxygen won't
763          * document them if they aren't given a name... */
764
765         /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.  This is
766          * the primary message for tracking the progress of writing a WIM file.
767          */
768         struct wimlib_progress_info_write_streams {
769                 /** Total number of uncompressed bytes of stream data being
770                  * written.  This can be thought of as the total uncompressed
771                  * size of the files being archived, with some caveats.  WIM
772                  * files use single-instance streams, so the size provided here
773                  * only counts distinct streams, except for the following
774                  * exception: the size provided here may include the sizes of
775                  * all newly added (e.g. with wimlib_add_image() streams,
776                  * pending automatic de-duplication during the write operation
777                  * itself.  When each such stream de-duplication occurs, this
778                  * number will be decreased by the size of the duplicate stream
779                  * that need not be written.
780                  *
781                  * In the case of a wimlib_overwrite() that the library opted to
782                  * perform in-place, both @p total_streams and @p total_bytes
783                  * will only count the streams actually being written and not
784                  * pre-existing streams in the WIM file.  */
785                 uint64_t total_bytes;
786
787                 /** Total number of streams being written.  This can be thought
788                  * of as the total number of files being archived, with some
789                  * caveats.  In general, a single file or directory may contain
790                  * multiple data streams, each of which will be represented
791                  * separately in this number.  Furthermore, WIM files use
792                  * single-instance streams, so the stream count provided here
793                  * only counts distinct streams, except for the following
794                  * exception: the stream count provided here may include newly
795                  * added (e.g. with wimlib_add_image() streams, pending
796                  * automatic de-duplication during the write operation itself.
797                  * When each such stream de-duplication occurs, this number will
798                  * be decreased by 1 to account for the duplicate stream that
799                  * need not be written.  */
800                 uint64_t total_streams;
801
802                 /** Number of uncompressed bytes of stream data that have been
803                  * written so far.  This number be 0 initially, and will be
804                  * equal to @p total_bytes at the end of the write operation.
805                  * Note that @p total_bytes (but not @p completed_bytes) may
806                  * decrease throughout the write operation due to the discovery
807                  * of stream duplications.  */
808                 uint64_t completed_bytes;
809
810                 /** Number of streams that have been written so far.  This
811                  * number will be 0 initially, and will be equal to @p
812                  * total_streams at the end of the write operation.  Note that
813                  * @p total_streams (but not @p completed_streams) may decrease
814                  * throughout the write operation due to the discovery of stream
815                  * duplications.
816                  *
817                  * For applications that wish to calculate a simple "percent
818                  * complete" for the write operation, it will likely be more
819                  * accurate to calculate the percentage from @p completed_bytes
820                  * and @p total_bytes rather than @p completed_streams and
821                  * @p total_streams because the time for the operation to
822                  * complete is mainly determined by the number of bytes that
823                  * need to be read, compressed, and written, not just the number
824                  * of files being archived.  */
825                 uint64_t completed_streams;
826
827                 /** Number of threads that are being used to compress streams,
828                  * or 1 if streams are being written uncompressed.  */
829                 uint32_t num_threads;
830
831                 /** The compression type being used to write the streams, as one
832                  * of the ::wimlib_compression_type constants.  */
833                 int32_t  compression_type;
834
835                 /** Number of split WIM parts from which streams are being
836                  * written (may be 0 if irrelevant).   */
837                 uint32_t total_parts;
838
839                 /** This is currently broken and will always be 0.  */
840                 uint32_t completed_parts;
841         } write_streams;
842
843         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
844          * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
845          * ::WIMLIB_PROGRESS_MSG_SCAN_END.  */
846         struct wimlib_progress_info_scan {
847                 /** Top-level directory being scanned; or, when capturing an NTFS
848                  * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
849                  * to the file or block device that contains the NTFS volume
850                  * being scanned.  */
851                 const wimlib_tchar *source;
852
853                 /** Path to the file (or directory) that has been scanned, valid
854                  * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.  When capturing an NTFS
855                  * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
856                  * relative to the root of the NTFS volume.  */
857                 const wimlib_tchar *cur_path;
858
859                 /** Dentry scan status, valid on
860                  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.  */
861                 enum {
862                         /** The file looks okay and will be captured.  */
863                         WIMLIB_SCAN_DENTRY_OK = 0,
864
865                         /** File is being excluded from capture due to the
866                          * capture configuration.  */
867                         WIMLIB_SCAN_DENTRY_EXCLUDED,
868
869                         /** File is being excluded from capture due to being
870                          * unsupported (e.g. an encrypted or device file).  */
871                         WIMLIB_SCAN_DENTRY_UNSUPPORTED,
872
873                         /** The file is an absolute symbolic link or junction
874                          * that points into the capture directory, and
875                          * reparse-point fixups are enabled, so its target is
876                          * being adjusted.  (Reparse point fixups can be
877                          * disabled with the flag ::WIMLIB_ADD_FLAG_NORPFIX.)
878                          */
879                         WIMLIB_SCAN_DENTRY_FIXED_SYMLINK,
880
881                         /** Reparse-point fixups are enabled, but the file is an
882                          * absolute symbolic link or junction that does
883                          * <b>not</b> point into the capture directory, so its
884                          * target is <b>not</b> being adjusted.  */
885                         WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK,
886                 } status;
887
888                 union {
889                         /** Target path in the WIM image.  Only valid on
890                          * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
891                          * ::WIMLIB_PROGRESS_MSG_SCAN_END.  */
892                         const wimlib_tchar *wim_target_path;
893
894                         /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
895                          * of @p WIMLIB_SCAN_DENTRY_FIXED_SYMLINK or @p
896                          * WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, this is the
897                          * target of the absolute symbolic link or junction.  */
898                         const wimlib_tchar *symlink_target;
899                 };
900
901                 /** Number of directories scanned so far, including the root
902                  * directory but excluding any unsupported/excluded directories.
903                  *
904                  * Details: On Windows and in NTFS capture mode, a reparse point
905                  * counts as a directory if and only if it has
906                  * FILE_ATTRIBUTE_DIRECTORY set.  Otherwise, a symbolic link
907                  * counts as a directory if and only if when fully dereferenced
908                  * it points to an accessible directory.  If a file has multiple
909                  * names (hard links), it is only counted one time.  */
910                 uint64_t num_dirs_scanned;
911
912                 /** Number of non-directories scanned so far, excluding any
913                  * unsupported/excluded files.
914                  *
915                  * Details: On Windows and in NTFS capture mode, a reparse point
916                  * counts as a non-directory if and only if it does not have
917                  * FILE_ATTRIBUTE_DIRECTORY set.  Otherwise, a symbolic link
918                  * counts as a non-directory if and only if when fully
919                  * dereferenced it points to a non-directory or its target is
920                  * inaccessible.  If a file has multiple names (hard links), it
921                  * is only counted one time.  */
922                 uint64_t num_nondirs_scanned;
923
924                 /** Number of bytes of file data that have been detected so far.
925                  *
926                  * Details: This data may not actually have been read yet, and
927                  * it will not actually be written to the WIM file until
928                  * wimlib_write() or wimlib_overwrite() has been called.  Data
929                  * from excluded files is not counted.  This number includes
930                  * default file contents as well as named data streams and
931                  * reparse point data.  The size of reparse point data is
932                  * tallied after any reparse-point fixups, and in the case of
933                  * capturing a symbolic link on a UNIX-like system, the creation
934                  * of the reparse point data itself.  If a file has multiple
935                  * names (hard links), its size(s) are only counted one time.
936                  * On Windows, encrypted files have their encrypted size
937                  * counted, not their unencrypted size; however, compressed
938                  * files have their uncompressed size counted.  */
939                 uint64_t num_bytes_scanned;
940         } scan;
941
942         /** Valid on messages
943          * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
944          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
945          * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
946          * ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
947          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
948          * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA,
949          * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END, and
950          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
951          *
952          * Note: most of the time of an extraction operation will be spent
953          * extracting streams, and the application will receive
954          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time.  Using @p
955          * completed_bytes and @p total_bytes, the application can calculate a
956          * percentage complete.  However, note that this message does not, in
957          * general, actually provide information about which "file" is currently
958          * being extracted.  This is because wimlib, by default, extracts the
959          * individual data streams in whichever order it determines to be the
960          * most efficient.
961          */
962         struct wimlib_progress_info_extract {
963                 /** Number of the image from which files are being extracted
964                  * (1-based).  */
965                 uint32_t image;
966
967                 /** Extraction flags being used.  */
968                 uint32_t extract_flags;
969
970                 /** Full path to the WIM file from which files are being
971                  * extracted, or @c NULL if the WIMStruct has no associated
972                  * on-disk file.  */
973                 const wimlib_tchar *wimfile_name;
974
975                 /** Name of the image from which files are being extracted, or
976                  * the empty string if the image is unnamed.  */
977                 const wimlib_tchar *image_name;
978
979                 /** Path to the directory or NTFS volume to which the files are
980                  * being extracted.  */
981                 const wimlib_tchar *target;
982
983                 /** Reserved.  */
984                 const wimlib_tchar *reserved;
985
986                 /** Number of bytes of uncompressed data that will be extracted.
987                  * If a file has multiple names (hard links), its size (or
988                  * sizes, in the case of named data streams) is only counted one
989                  * time.  For "reparse points" and symbolic links, the size to
990                  * be extracted is the size of the reparse data buffer.
991                  *
992                  * This number will stay constant throughout the extraction.  */
993                 uint64_t total_bytes;
994
995                 /** Number of bytes of uncompressed data that have been
996                  * extracted so far.  This initially be 0 and will equal to @p
997                  * total_bytes at the end of the extraction.  */
998                 uint64_t completed_bytes;
999
1000                 /** Number of (not necessarily unique) streams that will be
1001                  * extracted.  This may be more or less than the number of
1002                  * "files" to be extracted due to hard links as well as
1003                  * potentially multiple streams per file (named data streams).
1004                  * A "stream" may be the default contents of a file, a named
1005                  * data stream, or a reparse data buffer.  */
1006                 uint64_t total_streams;
1007
1008                 /** Number of (not necessarily unique) streams that have been
1009                  * extracted so far.  */
1010                 uint64_t completed_streams;
1011
1012                 /** Currently only used for
1013                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
1014                 uint32_t part_number;
1015
1016                 /** Currently only used for
1017                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
1018                 uint32_t total_parts;
1019
1020                 /** Currently only used for
1021                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
1022                 uint8_t guid[WIMLIB_GUID_LEN];
1023
1024                 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
1025                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is the
1026                  * number of files that have been processed so far.  Once the
1027                  * corresponding phase of extraction is complete, this value
1028                  * will be equal to @c end_file_count.  */
1029                 uint64_t current_file_count;
1030
1031                 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
1032                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is
1033                  * total number of files that will be processed.
1034                  *
1035                  * This number is provided for informational purposes only.
1036                  * This number will not necessarily be equal to the number of
1037                  * files actually being extracted.  This is because extraction
1038                  * backends are free to implement an extraction algorithm that
1039                  * might be more efficient than processing every file in the
1040                  * "extract file structure" and "extract metadata" phases.  For
1041                  * example, the current implementation of the UNIX extraction
1042                  * backend will create files on-demand during the stream
1043                  * extraction phase. Therefore, when using that particular
1044                  * extraction backend, @p end_file_count will only include
1045                  * directories and empty files.  */
1046                 uint64_t end_file_count;
1047         } extract;
1048
1049         /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
1050         struct wimlib_progress_info_rename {
1051                 /** Name of the temporary file that the WIM was written to. */
1052                 const wimlib_tchar *from;
1053
1054                 /** Name of the original WIM file to which the temporary file is
1055                  * being renamed. */
1056                 const wimlib_tchar *to;
1057         } rename;
1058
1059         /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1060          * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
1061         struct wimlib_progress_info_update {
1062                 /** Pointer to the update command that will be executed or has
1063                  * just been executed. */
1064                 const struct wimlib_update_command *command;
1065
1066                 /** Number of update commands that have been completed so far.
1067                  */
1068                 size_t completed_commands;
1069
1070                 /** Number of update commands that are being executed as part of
1071                  * this call to wimlib_update_image(). */
1072                 size_t total_commands;
1073         } update;
1074
1075         /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
1076          * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
1077         struct wimlib_progress_info_integrity {
1078                 /** Number of bytes from the end of the WIM header to the end of
1079                  * the lookup table (the area that is covered by the SHA1
1080                  * integrity checks.) */
1081                 uint64_t total_bytes;
1082
1083                 /** Number of bytes that have been SHA1-summed so far.  Will be
1084                  * 0 initially, and equal @p total_bytes at the end. */
1085                 uint64_t completed_bytes;
1086
1087                 /** Number of chunks that the checksummed region is divided
1088                  * into. */
1089                 uint32_t total_chunks;
1090
1091                 /** Number of chunks that have been SHA1-summed so far.   Will
1092                  * be 0 initially, and equal to @p total_chunks at the end. */
1093                 uint32_t completed_chunks;
1094
1095                 /** Size of the chunks used for the integrity calculation. */
1096                 uint32_t chunk_size;
1097
1098                 /** Filename of the WIM (only valid if the message is
1099                  * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
1100                 const wimlib_tchar *filename;
1101         } integrity;
1102
1103         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
1104          * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
1105         struct wimlib_progress_info_split {
1106                 /** Total size of the original WIM's file and metadata resources
1107                  * (compressed). */
1108                 uint64_t total_bytes;
1109
1110                 /** Number of bytes of file and metadata resources that have
1111                  * been copied out of the original WIM so far.  Will be 0
1112                  * initially, and equal to @p total_bytes at the end. */
1113                 uint64_t completed_bytes;
1114
1115                 /** Number of the split WIM part that is about to be started
1116                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1117                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
1118                 unsigned cur_part_number;
1119
1120                 /** Total number of split WIM parts that are being written.  */
1121                 unsigned total_parts;
1122
1123                 /** Name of the split WIM part that is about to be started
1124                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1125                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
1126                  * As of wimlib v1.7.0, the library user may change this when
1127                  * receiving ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART in order to
1128                  * cause the next split WIM part to be written to a different
1129                  * location.  */
1130                 wimlib_tchar *part_name;
1131         } split;
1132
1133         /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM  */
1134         struct wimlib_progress_info_replace {
1135                 /** Path to the file in the WIM image that is being replaced  */
1136                 const wimlib_tchar *path_in_wim;
1137         } replace;
1138
1139         /** Valid on messages ::WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE  */
1140         struct wimlib_progress_info_wimboot_exclude {
1141                 /** Path to the file in the WIM image  */
1142                 const wimlib_tchar *path_in_wim;
1143
1144                 /** Path to which the file is being extracted  */
1145                 const wimlib_tchar *extraction_path;
1146         } wimboot_exclude;
1147
1148         /** Valid on messages ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN.  */
1149         struct wimlib_progress_info_unmount {
1150                 /** Path to directory being unmounted  */
1151                 const wimlib_tchar *mountpoint;
1152
1153                 /** Path to WIM file being unmounted  */
1154                 const wimlib_tchar *mounted_wim;
1155
1156                 /** 1-based index of image being unmounted.  */
1157                 uint32_t mounted_image;
1158
1159                 /** Flags that were passed to wimlib_mount_image() when the
1160                  * mountpoint was set up.  */
1161                 uint32_t mount_flags;
1162
1163                 /** Flags passed to wimlib_unmount_image().  */
1164                 uint32_t unmount_flags;
1165         } unmount;
1166
1167         /** Valid on messages ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE.  */
1168         struct wimlib_progress_info_done_with_file {
1169                 /* Path to the file whose data has been written to the WIM file,
1170                  * or is currently being asynchronously compressed in memory,
1171                  * and therefore is no longer needed by wimlib.
1172                  *
1173                  * WARNING: The file data will not actually be accessible in the
1174                  * WIM file until the WIM file has been completely written.
1175                  * Ordinarily you should <b>not</b> treat this message as a
1176                  * green light to go ahead and delete the specified file, since
1177                  * that would result in data loss if the WIM file cannot be
1178                  * successfully created for any reason.
1179                  *
1180                  * If a file has multiple names (hard links),
1181                  * ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE will only be received
1182                  * for one name.  Also, this message will not be received for
1183                  * empty files or reparse points (or symbolic links), unless
1184                  * they have nonempty named data streams.
1185                  */
1186                 const wimlib_tchar *path_to_file;
1187         } done_with_file;
1188
1189         /** Valid on messages ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE and
1190          * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE.  */
1191         struct wimlib_progress_info_verify_image {
1192                 const wimlib_tchar *wimfile;
1193                 uint32_t total_images;
1194                 uint32_t current_image;
1195         } verify_image;
1196
1197         /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS.  */
1198         struct wimlib_progress_info_verify_streams {
1199                 const wimlib_tchar *wimfile;
1200                 uint64_t total_streams;
1201                 uint64_t total_bytes;
1202                 uint64_t completed_streams;
1203                 uint64_t completed_bytes;
1204         } verify_streams;
1205
1206         /** Valid on messages ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION.  */
1207         struct wimlib_progress_info_test_file_exclusion {
1208
1209                 /**
1210                  * Path to the file for which exclusion is being tested.
1211                  *
1212                  * UNIX capture mode:  The path will be a standard relative or
1213                  * absolute UNIX filesystem path.
1214                  *
1215                  * NTFS-3g capture mode:  The path will be given relative to the
1216                  * root of the NTFS volume, with a leading slash.
1217                  *
1218                  * Windows capture mode:  The path will be a Win32 namespace
1219                  * path to the file.
1220                  */
1221                 const wimlib_tchar *path;
1222
1223                 /**
1224                  * Indicates whether the file or directory will be excluded from
1225                  * capture or not.  This will be <tt>false</tt> by default.  The
1226                  * progress function can set this to <tt>true</tt> if it decides
1227                  * that the file needs to be excluded.
1228                  */
1229                 bool will_exclude;
1230         } test_file_exclusion;
1231
1232         /** Valid on messages ::WIMLIB_PROGRESS_MSG_HANDLE_ERROR.  */
1233         struct wimlib_progress_info_handle_error {
1234
1235                 /** Path to the file for which the error occurred, or NULL if
1236                  * not relevant.  */
1237                 const wimlib_tchar *path;
1238
1239                 /** The wimlib error code associated with the error.  */
1240                 int error_code;
1241
1242                 /**
1243                  * Indicates whether the error will be ignored or not.  This
1244                  * will be <tt>false</tt> by default; the progress function may
1245                  * set it to <tt>true</tt>.
1246                  */
1247                 bool will_ignore;
1248         } handle_error;
1249 };
1250
1251 /**
1252  * A user-supplied function that will be called periodically during certain WIM
1253  * operations.
1254  *
1255  * The first argument will be the type of operation that is being performed or
1256  * is about to be started or has been completed.
1257  *
1258  * The second argument will be a pointer to one of a number of structures
1259  * depending on the first argument.  It may be @c NULL for some message types.
1260  * Note that although this argument is not @c const, users should not modify it
1261  * except in explicitly documented cases.
1262  *
1263  * The third argument will be a user-supplied value that was provided when
1264  * registering or specifying the progress function.
1265  *
1266  * This function must return one of the ::wimlib_progress_status values.  By
1267  * default, you should return ::WIMLIB_PROGRESS_STATUS_CONTINUE (0).
1268  */
1269 typedef enum wimlib_progress_status
1270         (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
1271                                   union wimlib_progress_info *info,
1272                                   void *progctx);
1273
1274 /** @} */
1275 /** @addtogroup G_modifying_wims
1276  * @{ */
1277
1278 /** An array of these structures is passed to wimlib_add_image_multisource() to
1279  * specify the sources from which to create a WIM image. */
1280 struct wimlib_capture_source {
1281         /** Absolute or relative path to a file or directory on the external
1282          * filesystem to be included in the WIM image. */
1283         wimlib_tchar *fs_source_path;
1284
1285         /** Destination path in the WIM image.  Use ::WIMLIB_WIM_ROOT_PATH to
1286          * specify the root directory of the WIM image.  */
1287         wimlib_tchar *wim_target_path;
1288
1289         /** Reserved; set to 0. */
1290         long reserved;
1291 };
1292
1293 /** Set or unset the "readonly" WIM header flag (WIM_HDR_FLAG_READONLY in
1294  * Microsoft's documentation), based on the ::wimlib_wim_info.is_marked_readonly
1295  * member of the @p info parameter.  This is distinct from basic file
1296  * permissions; this flag can be set on a WIM file that is physically writable.
1297  *
1298  * wimlib disallows modifying on-disk WIM files with the readonly flag set.
1299  * However, wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG
1300  * will override this --- and in fact, this is necessary to set the readonly
1301  * flag persistently on an existing WIM file.
1302  */
1303 #define WIMLIB_CHANGE_READONLY_FLAG             0x00000001
1304
1305 /** Set the GUID (globally unique identifier) of the WIM file to the value
1306  * specified in ::wimlib_wim_info.guid of the @p info parameter. */
1307 #define WIMLIB_CHANGE_GUID                      0x00000002
1308
1309 /** Change the bootable image of the WIM to the value specified in
1310  * ::wimlib_wim_info.boot_index of the @p info parameter.  */
1311 #define WIMLIB_CHANGE_BOOT_INDEX                0x00000004
1312
1313 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
1314  * in ::wimlib_wim_info.has_rpfix of the @p info parameter.  This flag generally
1315  * indicates whether an image in the WIM has been captured with reparse-point
1316  * fixups enabled.  wimlib also treats this flag as specifying whether to do
1317  * reparse-point fixups by default when capturing or applying WIM images.  */
1318 #define WIMLIB_CHANGE_RPFIX_FLAG                0x00000008
1319
1320 /** @} */
1321
1322 /** @addtogroup G_wim_information  */
1323
1324 /** @{ */
1325
1326 /** General information about a WIM file. */
1327 struct wimlib_wim_info {
1328
1329         /** Globally unique identifier for the WIM file.  Note: all parts of a
1330          * split WIM should have an identical value in this field.  */
1331         uint8_t  guid[WIMLIB_GUID_LEN];
1332
1333         /** Number of images in the WIM.  */
1334         uint32_t image_count;
1335
1336         /** 1-based index of the bootable image in the WIM, or 0 if no image is
1337          * bootable.  */
1338         uint32_t boot_index;
1339
1340         /** Version of the WIM file.  */
1341         uint32_t wim_version;
1342
1343         /** Chunk size used for compression.  */
1344         uint32_t chunk_size;
1345
1346         /** For split WIMs, the 1-based index of this part within the split WIM;
1347          * otherwise 1.  */
1348         uint16_t part_number;
1349
1350         /** For split WIMs, the total number of parts in the split WIM;
1351          * otherwise 1.  */
1352         uint16_t total_parts;
1353
1354         /** One of the ::wimlib_compression_type values that specifies the
1355          * method used to compress resources in the WIM.  */
1356         int32_t  compression_type;
1357
1358         /** Size of the WIM file in bytes, excluding the XML data and integrity
1359          * table.  */
1360         uint64_t total_bytes;
1361
1362         /** 1 if the WIM has an integrity table.  Note: if the ::WIMStruct was
1363          * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
1364          * this will always be 0, even if the ::WIMStruct was written to
1365          * somewhere by calling wimlib_write() with the
1366          * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
1367         uint32_t has_integrity_table : 1;
1368
1369         /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
1370          * wimlib_create_new_wim(). */
1371         uint32_t opened_from_file : 1;
1372
1373         /** 1 if the WIM is considered readonly for any reason. */
1374         uint32_t is_readonly : 1;
1375
1376         /** 1 if reparse-point fixups are enabled for one or more images in the
1377          * WIM.  */
1378         uint32_t has_rpfix : 1;
1379
1380         /** 1 if the WIM is marked read-only.  */
1381         uint32_t is_marked_readonly : 1;
1382
1383         /** 1 if the WIM is part of a spanned set.  */
1384         uint32_t spanned : 1;
1385
1386         uint32_t write_in_progress : 1;
1387         uint32_t metadata_only : 1;
1388         uint32_t resource_only : 1;
1389
1390         /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE).  */
1391         uint32_t pipable : 1;
1392         uint32_t reserved_flags : 22;
1393         uint32_t reserved[9];
1394 };
1395
1396 /** Information about a unique stream in the WIM file.  (A stream is the same
1397  * thing as a "resource", except in the case of solid resources.)  */
1398 struct wimlib_resource_entry {
1399         /** Uncompressed size of the stream in bytes. */
1400         uint64_t uncompressed_size;
1401
1402         /** Compressed size of the stream in bytes.  This will be the same as @p
1403          * uncompressed_size if the stream is uncompressed.  Or, if @p packed is
1404          * 1, this will be 0.  */
1405         uint64_t compressed_size;
1406
1407         /** Offset, in bytes, of this stream from the start of the WIM file.  Or
1408          * if @p packed is 1, then this is actually the offset at which this
1409          * stream begins in the uncompressed contents of the solid resource.
1410          */
1411         uint64_t offset;
1412
1413         /** SHA1 message digest of the stream's uncompressed contents.  */
1414         uint8_t sha1_hash[20];
1415
1416         /** Which part of WIM this stream is in.  */
1417         uint32_t part_number;
1418
1419         /** Number of times this stream is referenced over all WIM images.  */
1420         uint32_t reference_count;
1421
1422         /** 1 if this stream is compressed.  */
1423         uint32_t is_compressed : 1;
1424
1425         /** 1 if this stream is a metadata resource rather than a file resource.
1426          * */
1427         uint32_t is_metadata : 1;
1428
1429         uint32_t is_free : 1;
1430         uint32_t is_spanned : 1;
1431
1432         /** 1 if this stream was not found in the lookup table of the
1433          * ::WIMStruct.  This normally implies a missing call to
1434          * wimlib_reference_resource_files() or wimlib_reference_resources().
1435          * */
1436         uint32_t is_missing : 1;
1437
1438         /** 1 if this stream is located in a solid resource which may contain
1439          * other streams (all compressed together) as well.  */
1440         uint32_t packed : 1;
1441
1442         uint32_t reserved_flags : 26;
1443
1444         /** If @p packed is 1, then this will specify the offset of the solid
1445          * resource in the WIM.  */
1446         uint64_t raw_resource_offset_in_wim;
1447
1448         /** If @p packed is 1, then this will specify the compressed size of the
1449          * solid resource in the WIM.  */
1450         uint64_t raw_resource_compressed_size;
1451
1452         uint64_t reserved[2];
1453 };
1454
1455 /**
1456  * Information about a stream of a particular file in the WIM.
1457  *
1458  * Normally, only WIM images captured from NTFS filesystems will have multiple
1459  * streams per file.  In practice, this is a rarely used feature of the
1460  * filesystem.
1461  */
1462 struct wimlib_stream_entry {
1463         /** Name of the stream, or NULL if the stream is unnamed. */
1464         const wimlib_tchar *stream_name;
1465         /** Location, size, and other information about the stream's data as
1466          * stored in the WIM file.  */
1467         struct wimlib_resource_entry resource;
1468         uint64_t reserved[4];
1469 };
1470
1471 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1472  * Roughly, the information about a "file" in the WIM--- but really a directory
1473  * entry ("dentry") because hard links are allowed.  The hard_link_group_id
1474  * field can be used to distinguish actual file inodes.  */
1475 struct wimlib_dir_entry {
1476         /** Name of the file, or NULL if this file is unnamed.  Only the root
1477          * directory of an image will be unnamed.  */
1478         const wimlib_tchar *filename;
1479
1480         /** 8.3 name (or "DOS name", or "short name") of this file; or NULL if
1481          * this file has no such name.  */
1482         const wimlib_tchar *dos_name;
1483
1484         /** Full path to this file within the WIM image.  Path separators will
1485          * be ::WIMLIB_WIM_PATH_SEPARATOR.  */
1486         const wimlib_tchar *full_path;
1487
1488         /** Depth of this directory entry, where 0 is the root, 1 is the root's
1489          * children, ..., etc. */
1490         size_t depth;
1491
1492         /** Pointer to the security descriptor for this file, in Windows
1493          * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1494          * security descriptor.  */
1495         const char *security_descriptor;
1496
1497         /** Length of the above security descriptor.  */
1498         size_t security_descriptor_size;
1499
1500 #define WIMLIB_FILE_ATTRIBUTE_READONLY            0x00000001
1501 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN              0x00000002
1502 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM              0x00000004
1503 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY           0x00000010
1504 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE             0x00000020
1505 #define WIMLIB_FILE_ATTRIBUTE_DEVICE              0x00000040
1506 #define WIMLIB_FILE_ATTRIBUTE_NORMAL              0x00000080
1507 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY           0x00000100
1508 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
1509 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
1510 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED          0x00000800
1511 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE             0x00001000
1512 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1513 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED           0x00004000
1514 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL             0x00010000
1515         /** File attributes, such as whether the file is a directory or not.
1516          * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1517          * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1518          * on other platforms.  */
1519         uint32_t attributes;
1520
1521 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO        0x00000000
1522 #define WIMLIB_REPARSE_TAG_RESERVED_ONE         0x00000001
1523 #define WIMLIB_REPARSE_TAG_MOUNT_POINT          0xA0000003
1524 #define WIMLIB_REPARSE_TAG_HSM                  0xC0000004
1525 #define WIMLIB_REPARSE_TAG_HSM2                 0x80000006
1526 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
1527 #define WIMLIB_REPARSE_TAG_SIS                  0x80000007
1528 #define WIMLIB_REPARSE_TAG_DFS                  0x8000000A
1529 #define WIMLIB_REPARSE_TAG_DFSR                 0x80000012
1530 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER       0x8000000B
1531 #define WIMLIB_REPARSE_TAG_WOF                  0x80000017
1532 #define WIMLIB_REPARSE_TAG_SYMLINK              0xA000000C
1533         /** If the file is a reparse point (FILE_ATTRIBUTE_REPARSE_POINT set in
1534          * the attributes), this will give the reparse tag.  This tells you
1535          * whether the reparse point is a symbolic link, junction point, or some
1536          * other, more unusual kind of reparse point.  */
1537         uint32_t reparse_tag;
1538
1539         /** Number of links to this file's inode (hard links).
1540          *
1541          * Currently, this will always be 1 for directories.  However, it can be
1542          * greater than 1 for nondirectory files.  */
1543         uint32_t num_links;
1544
1545         /** Number of named data streams this file has.  Normally 0.  */
1546         uint32_t num_named_streams;
1547
1548         /** A unique identifier for this file's inode.  However, as a special
1549          * case, if the inode only has a single link (@p num_links == 1), this
1550          * value may be 0.
1551          *
1552          * Note: if a WIM image is captured from a filesystem, this value is not
1553          * guaranteed to be the same as the original number of the inode on the
1554          * filesystem.  */
1555         uint64_t hard_link_group_id;
1556
1557         /** Time this file was created.  */
1558         struct timespec creation_time;
1559
1560         /** Time this file was last written to.  */
1561         struct timespec last_write_time;
1562
1563         /** Time this file was last accessed.  */
1564         struct timespec last_access_time;
1565
1566         /** The UNIX user ID of this file.  This is a wimlib extension.
1567          *
1568          * This field is only valid if @p unix_mode != 0.  */
1569         uint32_t unix_uid;
1570
1571         /** The UNIX group ID of this file.  This is a wimlib extension.
1572          *
1573          * This field is only valid if @p unix_mode != 0.  */
1574         uint32_t unix_gid;
1575
1576         /** The UNIX mode of this file.  This is a wimlib extension.
1577          *
1578          * If this field is 0, then @p unix_uid, @p unix_gid, @p unix_mode, and
1579          * @p unix_rdev are all unknown (fields are not present in the WIM
1580          * image).  */
1581         uint32_t unix_mode;
1582
1583         /** The UNIX device ID (major and minor number) of this file.  This is a
1584          * wimlib extension.
1585          *
1586          * This field is only valid if @p unix_mode != 0.  */
1587         uint32_t unix_rdev;
1588
1589         uint64_t reserved[14];
1590
1591         /**
1592          * Array of streams that make up this file.
1593          *
1594          * The first entry will always exist and will correspond to the unnamed
1595          * data stream (default file contents), so it will have <c>stream_name
1596          * == NULL</c>.  Alternatively, for reparse point files, the first entry
1597          * will corresponding to the reparse data stream.
1598          *
1599          * Then, following the first entry, there be @p num_named_streams
1600          * additional entries that specify the named data streams, if any, each
1601          * of which will have <c>stream_name != NULL</c>.
1602          */
1603         struct wimlib_stream_entry streams[];
1604 };
1605
1606 /**
1607  * Type of a callback function to wimlib_iterate_dir_tree().  Must return 0 on
1608  * success.
1609  */
1610 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1611                                                   void *user_ctx);
1612
1613 /**
1614  * Type of a callback function to wimlib_iterate_lookup_table().  Must return 0
1615  * on success.
1616  */
1617 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1618                                                       void *user_ctx);
1619
1620 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1621  * just on the specified path. */
1622 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1623
1624 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1625  * itself; only its children (in the case of a non-empty directory) */
1626 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN  0x00000002
1627
1628 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1629  * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1630  * table of the ::WIMStruct.  The default behavior without this flag is to fill
1631  * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1632  * wimlib_resource_entry::is_missing "is_missing" flag.  */
1633 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED  0x00000004
1634
1635
1636 /** @} */
1637 /** @addtogroup G_modifying_wims
1638  * @{ */
1639
1640 /** UNIX-like systems only: Directly capture an NTFS volume rather than a
1641  * generic directory.  This requires that wimlib was compiled with support for
1642  * libntfs-3g.
1643  *
1644  * This flag cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1645  * ::WIMLIB_ADD_FLAG_UNIX_DATA.
1646  *
1647  * Do not use this flag on Windows, where wimlib already supports all
1648  * Windows-native filesystems, including NTFS, through the Windows APIs.  */
1649 #define WIMLIB_ADD_FLAG_NTFS                    0x00000001
1650
1651 /** Follow symbolic links when scanning the directory tree.  Currently only
1652  * supported on UNIX-like systems.  */
1653 #define WIMLIB_ADD_FLAG_DEREFERENCE             0x00000002
1654
1655 /** Call the progress function with the message
1656  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1657  * scanned.  */
1658 #define WIMLIB_ADD_FLAG_VERBOSE                 0x00000004
1659
1660 /** Mark the image being added as the bootable image of the WIM.  This flag is
1661  * valid only for wimlib_add_image() and wimlib_add_image_multisource().
1662  *
1663  * Note that you can also change the bootable image of a WIM using
1664  * wimlib_set_wim_info().
1665  *
1666  * Note: ::WIMLIB_ADD_FLAG_BOOT does something different from, and independent
1667  * from, ::WIMLIB_ADD_FLAG_WIMBOOT.  */
1668 #define WIMLIB_ADD_FLAG_BOOT                    0x00000008
1669
1670 /** UNIX-like systems only: Store the UNIX owner, group, mode, and device ID
1671  * (major and minor number) of each file.  Also allows capturing special files
1672  * such as device nodes and FIFOs.  See the documentation for the
1673  * <b>--unix-data</b> option to <b>wimlib-imagex capture</b> for more
1674  * information.  */
1675 #define WIMLIB_ADD_FLAG_UNIX_DATA               0x00000010
1676
1677 /** Do not capture security descriptors.  Only has an effect in NTFS capture
1678  * mode, or in Windows native builds.  */
1679 #define WIMLIB_ADD_FLAG_NO_ACLS                 0x00000020
1680
1681 /** Fail immediately if the full security descriptor of any file or directory
1682  * cannot be accessed.  Only has an effect in Windows native builds.  The
1683  * default behavior without this flag is to first try omitting the SACL from the
1684  * security descriptor, then to try omitting the security descriptor entirely.
1685  */
1686 #define WIMLIB_ADD_FLAG_STRICT_ACLS             0x00000040
1687
1688 /** Call the progress function with the message
1689  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1690  * capture.  This is a subset of the messages provided by
1691  * ::WIMLIB_ADD_FLAG_VERBOSE.  */
1692 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE         0x00000080
1693
1694 /** Reparse-point fixups:  Modify absolute symbolic links (and junctions, in the
1695  * case of Windows) that point inside the directory being captured to instead be
1696  * absolute relative to the directory being captured.
1697  *
1698  * Without this flag, the default is to do reparse-point fixups if
1699  * WIM_HDR_FLAG_RP_FIX is set in the WIM header or if this is the first image
1700  * being added.  WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is
1701  * captured with reparse point fixups enabled and currently cannot be unset. */
1702 #define WIMLIB_ADD_FLAG_RPFIX                   0x00000100
1703
1704 /** Don't do reparse point fixups.  See ::WIMLIB_ADD_FLAG_RPFIX.  */
1705 #define WIMLIB_ADD_FLAG_NORPFIX                 0x00000200
1706
1707 /** Do not automatically exclude unsupported files or directories from capture;
1708  * e.g. encrypted files in NTFS-3g capture mode, or device files and FIFOs on
1709  * UNIX-like systems when not also using ::WIMLIB_ADD_FLAG_UNIX_DATA.  Instead,
1710  * fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file is encountered.  */
1711 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE  0x00000400
1712
1713 /**
1714  * Automatically select a capture configuration appropriate for capturing
1715  * filesystems containing Windows operating systems.  For example,
1716  * "/pagefile.sys" and "System Volume Information" will be excluded.
1717  *
1718  * When this flag is specified, the corresponding @p config parameter (for
1719  * wimlib_add_image()) or member (for wimlib_update_image()) must be @c NULL.
1720  * Otherwise, ::WIMLIB_ERR_INVALID_PARAM will be returned.
1721  *
1722  * Note that the default behavior--- that is, when neither
1723  * ::WIMLIB_ADD_FLAG_WINCONFIG nor ::WIMLIB_ADD_FLAG_WIMBOOT is specified and @p
1724  * config is @c NULL--- is to use no capture configuration, meaning that no
1725  * files are excluded from capture.
1726  */
1727 #define WIMLIB_ADD_FLAG_WINCONFIG               0x00000800
1728
1729 /**
1730  * Capture image as WIMBoot compatible.  In addition, if no capture
1731  * configuration file is explicitly specified use the capture configuration file
1732  * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1733  * <c>$SOURCE</c> is the directory being captured; or, if a capture
1734  * configuration file is explicitly specified, use it and also place it at
1735  * /Windows/System32/WimBootCompress.ini in the WIM image.
1736  *
1737  * Note: this will not by itself change the compression type.  Before writing
1738  * the WIM file, it's recommended to also do:
1739  *
1740  * \code
1741  *      wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1742  *      wimlib_set_output_chunk_size(wim, 4096);
1743  * \endcode
1744  *
1745  * since that makes access to the data faster (at the cost of a worse
1746  * compression ratio compared to the 32768-byte LZX chunks usually used).
1747  *
1748  * Note: ::WIMLIB_ADD_FLAG_WIMBOOT does something different from, and
1749  * independent from, ::WIMLIB_ADD_FLAG_BOOT.
1750  */
1751 #define WIMLIB_ADD_FLAG_WIMBOOT                 0x00001000
1752
1753 /**
1754  * If the add command involves adding a non-directory file to a location at
1755  * which there already exists a nondirectory file in the WIM image, issue
1756  * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file.  This only has an
1757  * effect when updating an existing image with wimlib_update_image().
1758  * This was the default behavior in wimlib v1.6.2 and earlier.
1759  */
1760 #define WIMLIB_ADD_FLAG_NO_REPLACE              0x00002000
1761
1762 /**
1763  * Send ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION messages to the progress
1764  * function.
1765  *
1766  * Note: This method for file exclusions is independent from the capture
1767  * configuration file mechanism.
1768  */
1769 #define WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION     0x00004000
1770
1771 /* Note: the WIMLIB_ADD_IMAGE_FLAG names are retained for source compatibility.
1772  * Use the WIMLIB_ADD_FLAG names in new code.  */
1773 #define WIMLIB_ADD_IMAGE_FLAG_NTFS              WIMLIB_ADD_FLAG_NTFS
1774 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       WIMLIB_ADD_FLAG_DEREFERENCE
1775 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           WIMLIB_ADD_FLAG_VERBOSE
1776 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              WIMLIB_ADD_FLAG_BOOT
1777 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA         WIMLIB_ADD_FLAG_UNIX_DATA
1778 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS           WIMLIB_ADD_FLAG_NO_ACLS
1779 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS       WIMLIB_ADD_FLAG_STRICT_ACLS
1780 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE   WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1781 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX             WIMLIB_ADD_FLAG_RPFIX
1782 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX           WIMLIB_ADD_FLAG_NORPFIX
1783 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1784                                                 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1785 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG         WIMLIB_ADD_FLAG_WINCONFIG
1786 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT           WIMLIB_ADD_FLAG_WIMBOOT
1787
1788
1789 /** @} */
1790 /** @addtogroup G_modifying_wims
1791  * @{ */
1792
1793 /** Do not issue an error if the path to delete does not exist. */
1794 #define WIMLIB_DELETE_FLAG_FORCE                        0x00000001
1795
1796 /** Delete the file or directory tree recursively; if not specified, an error is
1797  * issued if the path to delete is a directory. */
1798 #define WIMLIB_DELETE_FLAG_RECURSIVE                    0x00000002
1799
1800 /** @} */
1801 /** @addtogroup G_modifying_wims
1802  * @{ */
1803
1804 /**
1805  * If a single image is being exported, mark it bootable in the destination WIM.
1806  * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1807  * the image in the source WIM (if any) that is marked as bootable is also
1808  * marked as bootable in the destination WIM.
1809  */
1810 #define WIMLIB_EXPORT_FLAG_BOOT                         0x00000001
1811
1812 /** Give the exported image(s) no names.  Avoids problems with image name
1813  * collisions.
1814  */
1815 #define WIMLIB_EXPORT_FLAG_NO_NAMES                     0x00000002
1816
1817 /** Give the exported image(s) no descriptions.  */
1818 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS              0x00000004
1819
1820 /** This advises the library that the program is finished with the source
1821  * WIMStruct and will not attempt to access it after the call to
1822  * wimlib_export_image(), with the exception of the call to wimlib_free().  */
1823 #define WIMLIB_EXPORT_FLAG_GIFT                         0x00000008
1824
1825 /**
1826  * Mark each exported image as WIMBoot-compatible.
1827  *
1828  * Note: by itself, this does change the destination WIM's compression type, nor
1829  * does it add the file @c \\Windows\\System32\\WimBootCompress.ini in the WIM
1830  * image.  Before writing the destination WIM, it's recommended to do something
1831  * like:
1832  *
1833  * \code
1834  *      wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1835  *      wimlib_set_output_chunk_size(wim, 4096);
1836  *      wimlib_add_tree(wim, image, L"myconfig.ini",
1837  *                      L"\\Windows\\System32\\WimBootCompress.ini", 0);
1838  * \endcode
1839  */
1840 #define WIMLIB_EXPORT_FLAG_WIMBOOT                      0x00000010
1841
1842 /** @} */
1843 /** @addtogroup G_extracting_wims
1844  * @{ */
1845
1846 /** Extract the image directly to an NTFS volume rather than a generic directory.
1847  * This mode is only available if wimlib was compiled with libntfs-3g support;
1848  * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned.  In this mode, the
1849  * extraction target will be interpreted as the path to an NTFS volume image (as
1850  * a regular file or block device) rather than a directory.  It will be opened
1851  * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1852  * root directory.  Note: this flag cannot be used when wimlib_extract_image()
1853  * is called with ::WIMLIB_ALL_IMAGES as the @p image, nor can it be used with
1854  * wimlib_extract_paths() when passed multiple paths.  */
1855 #define WIMLIB_EXTRACT_FLAG_NTFS                        0x00000001
1856
1857 /** UNIX-like systems only:  Extract special UNIX data captured with
1858  * ::WIMLIB_ADD_FLAG_UNIX_DATA.  This flag cannot be combined with
1859  * ::WIMLIB_EXTRACT_FLAG_NTFS.  */
1860 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA                   0x00000020
1861
1862 /** Do not extract security descriptors.  This flag cannot be combined with
1863  * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS.  */
1864 #define WIMLIB_EXTRACT_FLAG_NO_ACLS                     0x00000040
1865
1866 /** Fail immediately if the full security descriptor of any file or directory
1867  * cannot be set exactly as specified in the WIM file.  On Windows, the default
1868  * behavior without this flag when wimlib does not have permission to set the
1869  * correct security descriptor is to fall back to setting the security
1870  * descriptor with the SACL omitted, then with the DACL omitted, then with the
1871  * owner omitted, then not at all.  This flag cannot be combined with
1872  * ::WIMLIB_EXTRACT_FLAG_NO_ACLS.  */
1873 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS                 0x00000080
1874
1875 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX.  This forces
1876  * reparse-point fixups on, so absolute symbolic links or junction points will
1877  * be fixed to be absolute relative to the actual extraction root.  Reparse-
1878  * point fixups are done by default for wimlib_extract_image() and
1879  * wimlib_extract_image_from_pipe() if WIM_HDR_FLAG_RP_FIX is set in the WIM
1880  * header.  This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX.  */
1881 #define WIMLIB_EXTRACT_FLAG_RPFIX                       0x00000100
1882
1883 /** Force reparse-point fixups on extraction off, regardless of the state of the
1884  * WIM_HDR_FLAG_RP_FIX flag in the WIM header.  This flag cannot be combined
1885  * with ::WIMLIB_EXTRACT_FLAG_RPFIX.  */
1886 #define WIMLIB_EXTRACT_FLAG_NORPFIX                     0x00000200
1887
1888 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only:  Extract the
1889  * paths, each of which must name a regular file, to standard output.  */
1890 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT                   0x00000400
1891
1892 /** Instead of ignoring files and directories with names that cannot be
1893  * represented on the current platform (note: Windows has more restrictions on
1894  * filenames than POSIX-compliant systems), try to replace characters or append
1895  * junk to the names so that they can be extracted in some form.
1896  *
1897  * Note: this flag is unlikely to have any effect when extracting a WIM image
1898  * that was captured on Windows.
1899  */
1900 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES   0x00000800
1901
1902 /** On Windows, when there exist two or more files with the same case
1903  * insensitive name but different case sensitive names, try to extract them all
1904  * by appending junk to the end of them, rather than arbitrarily extracting only
1905  * one.
1906  *
1907  * Note: this flag is unlikely to have any effect when extracting a WIM image
1908  * that was captured on Windows.
1909  */
1910 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS          0x00001000
1911
1912 /** Do not ignore failure to set timestamps on extracted files.  This flag
1913  * currently only has an effect when extracting to a directory on UNIX-like
1914  * systems.  */
1915 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS           0x00002000
1916
1917 /** Do not ignore failure to set short names on extracted files.  This flag
1918  * currently only has an effect on Windows.  */
1919 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES          0x00004000
1920
1921 /** Do not ignore failure to extract symbolic links and junctions due to
1922  * permissions problems.  This flag currently only has an effect on Windows.  By
1923  * default, such failures are ignored since the default configuration of Windows
1924  * only allows the Administrator to create symbolic links.  */
1925 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS             0x00008000
1926
1927 /** Reserved for future use.  */
1928 #define WIMLIB_EXTRACT_FLAG_RESUME                      0x00010000
1929
1930 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only:  Treat the
1931  * paths to extract as wildcard patterns ("globs") which may contain the
1932  * wildcard characters @c ? and @c *.  The @c ? character matches any
1933  * non-path-separator character, whereas the @c * character matches zero or more
1934  * non-path-separator characters.  Consequently, each glob may match zero or
1935  * more actual paths in the WIM image.
1936  *
1937  * By default, if a glob does not match any files, a warning but not an error
1938  * will be issued.  This is the case even if the glob did not actually contain
1939  * wildcard characters.  Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB to get an error
1940  * instead.
1941  * */
1942 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS                  0x00040000
1943
1944 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1945  * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1946  * one of the provided globs did not match a file.  */
1947 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB                 0x00080000
1948
1949 /** Do not extract Windows file attributes such as readonly, hidden, etc.
1950  *
1951  * This flag has an effect on Windows as well as in the NTFS-3g extraction mode.
1952  */
1953 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES               0x00100000
1954
1955 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only:  Do not
1956  * preserve the directory structure of the archive when extracting --- that is,
1957  * place each extracted file or directory tree directly in the target directory.
1958  *
1959  * The target directory will still be created if it does not already exist.  */
1960 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE   0x00200000
1961
1962 /** Windows only: Extract files as "pointers" back to the WIM archive.
1963  *
1964  * The effects of this option are fairly complex.  See the documentation for the
1965  * <b>--wimboot</b> option of <b>wimlib-imagex apply</b> for more information.
1966  */
1967 #define WIMLIB_EXTRACT_FLAG_WIMBOOT                     0x00400000
1968
1969 /** @} */
1970 /** @addtogroup G_mounting_wim_images
1971  * @{ */
1972
1973 /** Mount the WIM image read-write rather than the default of read-only. */
1974 #define WIMLIB_MOUNT_FLAG_READWRITE                     0x00000001
1975
1976 /** Enable FUSE debugging by passing the @c -d option to @c fuse_main().  */
1977 #define WIMLIB_MOUNT_FLAG_DEBUG                         0x00000002
1978
1979 /** Do not allow accessing named data streams in the mounted WIM image.  */
1980 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000004
1981
1982 /** Access named data streams in the mounted WIM image through extended file
1983  * attributes named "user.X", where X is the name of a data stream.  This is the
1984  * default mode.  */
1985 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000008
1986
1987 /** Access named data streams in the mounted WIM image by specifying the file
1988  * name, a colon, then the name of the data stream.  */
1989 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000010
1990
1991 /** Use UNIX metadata if available in the WIM image.  See
1992  * ::WIMLIB_ADD_FLAG_UNIX_DATA.  */
1993 #define WIMLIB_MOUNT_FLAG_UNIX_DATA                     0x00000020
1994
1995 /** Allow other users to see the mounted filesystem.  This passes the @c
1996  * allow_other option to fuse_main().  */
1997 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER                   0x00000040
1998
1999 /** @} */
2000 /** @addtogroup G_creating_and_opening_wims
2001  * @{ */
2002
2003 /** Verify the WIM contents against the WIM's integrity table, if present.  This
2004  * causes the raw data of the WIM file, divided into 10 MB chunks, to be
2005  * checksummed and checked against the SHA1 message digests specified in the
2006  * integrity table.  If there are any mismatches, ::WIMLIB_ERR_INTEGRITY is
2007  * issued.  If the WIM file does not contain an integrity table, this flag has
2008  * no effect.  */
2009 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY                0x00000001
2010
2011 /** Issue an error (::WIMLIB_ERR_IS_SPLIT_WIM) if the WIM is part of a split
2012  * WIM.  Software can provide this flag for convenience if it explicitly does
2013  * not want to support split WIMs.  */
2014 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT                 0x00000002
2015
2016 /** Check if the WIM is writable and issue an error
2017  * (::WIMLIB_ERR_WIM_IS_READONLY) if it is not.  A WIM is considered writable
2018  * only if it is writable at the filesystem level, does not have the
2019  * WIM_HDR_FLAG_READONLY flag set in its header, and is not part of a spanned
2020  * set.  It is not required to provide this flag before attempting to make
2021  * changes to the WIM, but with this flag you get an error immediately rather
2022  * than potentially much later, when wimlib_overwrite() is finally called.  */
2023 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS                   0x00000004
2024
2025 /** @} */
2026 /** @addtogroup G_mounting_wim_images
2027  * @{ */
2028
2029 /** Provide ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY when committing the WIM image.
2030  * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified.  */
2031 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY             0x00000001
2032
2033 /** Commit changes to the read-write mounted WIM image.
2034  * If this flag is not specified, changes will be discarded.  */
2035 #define WIMLIB_UNMOUNT_FLAG_COMMIT                      0x00000002
2036
2037 /** Provide ::WIMLIB_WRITE_FLAG_REBUILD when committing the WIM image.
2038  * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified.  */
2039 #define WIMLIB_UNMOUNT_FLAG_REBUILD                     0x00000004
2040
2041 /** Provide ::WIMLIB_WRITE_FLAG_RECOMPRESS when committing the WIM image.
2042  * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified.  */
2043 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS                  0x00000008
2044
2045 /**
2046  * In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted WIM
2047  * image, forces all file descriptors to the open WIM image to be closed before
2048  * committing it.
2049  *
2050  * Without ::WIMLIB_UNMOUNT_FLAG_COMMIT or with a read-only mounted WIM image,
2051  * this flag has no effect.
2052  */
2053 #define WIMLIB_UNMOUNT_FLAG_FORCE                       0x00000010
2054
2055 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
2056  * WIM image, causes the modified image to be committed to the WIM file as a
2057  * new, unnamed image appended to the archive.  The original image in the WIM
2058  * file will be unmodified.  */
2059 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE                   0x00000020
2060
2061 /** @} */
2062 /** @addtogroup G_modifying_wims
2063  * @{ */
2064
2065 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
2066  * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages.  */
2067 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS                0x00000001
2068
2069 /** @} */
2070 /** @addtogroup G_writing_and_overwriting_wims
2071  * @{ */
2072
2073 /**
2074  * Include an integrity table in the resulting WIM file.
2075  *
2076  * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2077  * include an integrity table if and only if one was present before.  For
2078  * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2079  * to not include an integrity table.
2080  */
2081 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY               0x00000001
2082
2083 /**
2084  * Do not include an integrity table in the resulting WIM file.  This is the
2085  * default behavior, unless the ::WIMStruct was created by opening a WIM with an
2086  * integrity table.
2087  */
2088 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY            0x00000002
2089
2090 /**
2091  * Write the WIM as "pipable".  After writing a WIM with this flag specified,
2092  * images from it can be applied directly from a pipe using
2093  * wimlib_extract_image_from_pipe().  See the documentation for the
2094  * <b>--pipable</b> option of <b>wimlib-imagex capture</b> for more information.
2095  * Beware: WIMs written with this flag will not be compatible with Microsoft's
2096  * software.
2097  *
2098  * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2099  * write the WIM as pipable if and only if it was pipable before.  For
2100  * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2101  * to write the WIM as non-pipable.
2102  */
2103 #define WIMLIB_WRITE_FLAG_PIPABLE                       0x00000004
2104
2105 /**
2106  * Do not write the WIM as "pipable".  This is the default behavior, unless the
2107  * ::WIMStruct was created by opening a pipable WIM.
2108  */
2109 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE                   0x00000008
2110
2111 /**
2112  * When writing streams to the WIM file, recompress them, even if their data is
2113  * already available in the desired compressed form (for example, in a WIM file
2114  * from which an image has been exported using wimlib_export_image()).
2115  *
2116  * ::WIMLIB_WRITE_FLAG_RECOMPRESS can be used to recompress with a higher
2117  * compression ratio for the same compression type and chunk size.  Simply using
2118  * the default compression settings may suffice for this, especially if the WIM
2119  * file was created using another program/library that may not use as
2120  * sophisticated compression algorithms.  Or,
2121  * wimlib_set_default_compression_level() can be called beforehand to set an
2122  * even higher compression level than the default.
2123  *
2124  * If the WIM contains solid resources, then ::WIMLIB_WRITE_FLAG_RECOMPRESS can
2125  * be used in combination with ::WIMLIB_WRITE_FLAG_SOLID to prevent any solid
2126  * resources from being re-used.  Otherwise, solid resources are re-used
2127  * somewhat more liberally than normal compressed resources.
2128  *
2129  * ::WIMLIB_WRITE_FLAG_RECOMPRESS does <b>not</b> cause recompression of streams
2130  * that would not otherwise be written.  For example, a call to
2131  * wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_RECOMPRESS will not, by itself,
2132  * cause already-existing streams in the WIM file to be recompressed.  To force
2133  * the WIM file to be fully rebuilt and recompressed, combine
2134  * ::WIMLIB_WRITE_FLAG_RECOMPRESS with ::WIMLIB_WRITE_FLAG_REBUILD.
2135  */
2136 #define WIMLIB_WRITE_FLAG_RECOMPRESS                    0x00000010
2137
2138 /**
2139  * Immediately before closing the WIM file, sync its data to disk.
2140  *
2141  * This flag forces the function to wait until the data is safely on disk before
2142  * returning success.  Otherwise, modern operating systems tend to cache data
2143  * for some time (in some cases, 30+ seconds) before actually writing it to
2144  * disk, even after reporting to the application that the writes have succeeded.
2145  *
2146  * wimlib_overwrite() will set this flag automatically if it decides to
2147  * overwrite the WIM file via a temporary file instead of in-place.  This is
2148  * necessary on POSIX systems; it will, for example, avoid problems with delayed
2149  * allocation on ext4.
2150  */
2151 #define WIMLIB_WRITE_FLAG_FSYNC                         0x00000020
2152
2153 /**
2154  * For wimlib_overwrite(), rebuild the entire WIM file, even if it otherwise
2155  * could be updated in-place by appending to it.
2156  *
2157  * When rebuilding the WIM file, stream reference counts will be recomputed, and
2158  * any streams with 0 reference count (e.g. from deleted files or images) will
2159  * not be included in the resulting WIM file.  This can free up space that is
2160  * currently not being used.
2161  *
2162  * This flag can be combined with ::WIMLIB_WRITE_FLAG_RECOMPRESS to force all
2163  * data to be recompressed.  Otherwise, compressed data is re-used if possible.
2164  *
2165  * wimlib_write() ignores this flag.
2166  */
2167 #define WIMLIB_WRITE_FLAG_REBUILD                       0x00000040
2168
2169 /**
2170  * For wimlib_overwrite(), override the default behavior after one or more calls
2171  * to wimlib_delete_image(), which is to rebuild the entire WIM file.  With this
2172  * flag, only minimal changes to correctly remove the image from the WIM file
2173  * will be taken.  In particular, all streams will be retained, even if they are
2174  * no longer referenced.  This may not be what you want, because no space will
2175  * be saved by deleting an image in this way.
2176  *
2177  * wimlib_write() ignores this flag.
2178  */
2179 #define WIMLIB_WRITE_FLAG_SOFT_DELETE                   0x00000080
2180
2181 /**
2182  * For wimlib_overwrite(), allow overwriting the WIM file even if the readonly
2183  * flag (WIM_HDR_FLAG_READONLY) is set in the WIM header.  This can be used
2184  * following a call to wimlib_set_wim_info() with the
2185  * ::WIMLIB_CHANGE_READONLY_FLAG flag to actually set the readonly flag on the
2186  * on-disk WIM file.
2187  *
2188  * wimlib_write() ignores this flag.
2189  */
2190 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG          0x00000100
2191
2192 /**
2193  * Do not include streams already present in other WIMs.  This flag can be used
2194  * to write a "delta" WIM after resources from the WIM on which the delta is to
2195  * be based were referenced with wimlib_reference_resource_files() or
2196  * wimlib_reference_resources().
2197  */
2198 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS            0x00000200
2199
2200 /**
2201  * Advises the library that for writes of all WIM images, all streams needed for
2202  * the WIM are already present (not in external resource WIMs) and their
2203  * reference counts are correct, so the code does not need to recalculate which
2204  * streams are referenced.  This is for optimization purposes only, since with
2205  * this flag specified, the metadata resources may not need to be decompressed
2206  * and parsed.
2207  *
2208  * wimlib_overwrite() will set this flag automatically.
2209  */
2210 #define WIMLIB_WRITE_FLAG_STREAMS_OK                    0x00000400
2211
2212 /**
2213  * For wimlib_write(), retain the WIM's GUID instead of generating a new one.
2214  *
2215  * wimlib_overwrite() sets this by default, since the WIM remains, logically,
2216  * the same file.
2217  */
2218 #define WIMLIB_WRITE_FLAG_RETAIN_GUID                   0x00000800
2219
2220 /**
2221  * When writing streams in the resulting WIM file, combine multiple streams into
2222  * a single compressed resource instead of compressing them independently.  This
2223  * is also known as creating a "solid archive".  This tends to produce a better
2224  * compression ratio at the cost of much slower random access.
2225  *
2226  * WIM files created with this flag are only compatible with wimlib v1.6.0 or
2227  * later, WIMGAPI Windows 8 or later, and DISM Windows 8.1 or later.  WIM files
2228  * created with this flag use a different version number in their header (3584
2229  * instead of 68864) and are also called "ESD files".
2230  *
2231  * If this flag is passed to wimlib_overwrite(), any new data streams will be
2232  * written in solid mode.  Use both ::WIMLIB_WRITE_FLAG_REBUILD and
2233  * ::WIMLIB_WRITE_FLAG_RECOMPRESS to force the entire WIM file be rebuilt with
2234  * all streams recompressed in solid mode.
2235  *
2236  * Currently, new solid resources will, by default, be written using LZMS
2237  * compression with 64 MiB (67108864 byte) chunks.  Use
2238  * wimlib_set_output_pack_compression_type() and/or
2239  * wimlib_set_output_pack_chunk_size() to change this.  This is independent of
2240  * the WIM's main compression type and chunk size; you can have a WIM that
2241  * nominally uses LZX compression and 32768 byte chunks but actually contains
2242  * LZMS-compressed solid resources, for example.  However, if including solid
2243  * blocks, I suggest that you set the WIM's main compression type to LZMS as
2244  * well, either by creating the WIM with
2245  * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
2246  * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
2247  *
2248  * This flag will be set by default when writing or overwriting a WIM file that
2249  * either already contains solid resources, or has had solid resources exported
2250  * into it and the WIM's main compression type is LZMS.
2251  */
2252 #define WIMLIB_WRITE_FLAG_SOLID                         0x00001000
2253
2254 /**
2255  * Deprecated: this is the old name for ::WIMLIB_WRITE_FLAG_SOLID, retained for
2256  * source compatibility.
2257  */
2258 #define WIMLIB_WRITE_FLAG_PACK_STREAMS                  WIMLIB_WRITE_FLAG_SOLID
2259
2260 /**
2261  * Send ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE messages while writing the WIM
2262  * file.  This is only needed in the unusual case that the library user needs to
2263  * know exactly when wimlib has read each file for the last time.
2264  */
2265 #define WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES  0x00002000
2266
2267 /**
2268  * If using solid compression, do not sort the streams ("files") to compress by
2269  * estimated content similarily.  This flag only has an effect if
2270  * ::WIMLIB_WRITE_FLAG_SOLID is also specified.
2271  */
2272 #define WIMLIB_WRITE_FLAG_NO_SOLID_SORT                 0x00004000
2273
2274 /** @} */
2275 /** @addtogroup G_general
2276  * @{ */
2277
2278 /** Assume that strings are represented in UTF-8, even if this is not the
2279  * locale's character encoding.  This flag is ignored on Windows, where wimlib
2280  * always uses UTF-16LE.  */
2281 #define WIMLIB_INIT_FLAG_ASSUME_UTF8                    0x00000001
2282
2283 /** Windows-only: do not attempt to acquire additional privileges (currently
2284  * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
2285  * SeTakeOwnershipPrivilege) when initializing the library.  This is intended
2286  * for the case where the calling program manages these privileges itself.
2287  * Note: no error is issued if privileges cannot be acquired, although related
2288  * errors may be reported later, depending on if the operations performed
2289  * actually require additional privileges or not.  */
2290 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES        0x00000002
2291
2292 /** Windows only:  If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2293  * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2294  * to read all possible data and metadata for a capture operation could not be
2295  * acquired.  Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
2296  */
2297 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES      0x00000004
2298
2299 /** Windows only:  If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2300  * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2301  * to restore all possible data and metadata for an apply operation could not be
2302  * acquired.  Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
2303  */
2304 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES        0x00000008
2305
2306 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
2307  * systems).  */
2308 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE         0x00000010
2309
2310 /** Default to interpreting WIM paths case insensitively (default on Windows).
2311  * This does not apply to mounted images.  */
2312 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE       0x00000020
2313
2314 /** @} */
2315 /** @addtogroup G_nonstandalone_wims
2316  * @{ */
2317
2318 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
2319  * Ignored by wimlib_reference_resources().  */
2320 #define WIMLIB_REF_FLAG_GLOB_ENABLE             0x00000001
2321
2322 /** For wimlib_reference_resource_files(), issue an error
2323  * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files.  The
2324  * default behavior without this flag is to issue no error at that point, but
2325  * then attempt to open the glob as a literal path, which of course will fail
2326  * anyway if no file exists at that path.  No effect if
2327  * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified.  Ignored by
2328  * wimlib_reference_resources().  */
2329 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH     0x00000002
2330
2331 /** @} */
2332 /** @addtogroup G_modifying_wims
2333  * @{ */
2334
2335 /** The specific type of update to perform. */
2336 enum wimlib_update_op {
2337         /** Add a new file or directory tree to the WIM image in a
2338          * certain location. */
2339         WIMLIB_UPDATE_OP_ADD = 0,
2340
2341         /** Delete a file or directory tree from the WIM image. */
2342         WIMLIB_UPDATE_OP_DELETE,
2343
2344         /** Rename a file or directory tree in the WIM image. */
2345         WIMLIB_UPDATE_OP_RENAME,
2346 };
2347
2348 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
2349 struct wimlib_add_command {
2350         /** Filesystem path to the file or directory tree to add.  */
2351         wimlib_tchar *fs_source_path;
2352
2353         /** Destination path in the WIM image.  Use ::WIMLIB_WIM_ROOT_PATH to
2354          * specify the root directory of the WIM image.  */
2355         wimlib_tchar *wim_target_path;
2356
2357         /** Path to capture configuration file to use, or @c NULL for default.
2358          */
2359         wimlib_tchar *config_file;
2360
2361         /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
2362         int add_flags;
2363 };
2364
2365 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
2366 struct wimlib_delete_command {
2367
2368         /** Path, specified from the root of the WIM image, for the file or
2369          * directory tree within the WIM image to be deleted.  */
2370         wimlib_tchar *wim_path;
2371
2372         /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags.  */
2373         int delete_flags;
2374 };
2375
2376 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
2377 struct wimlib_rename_command {
2378
2379         /** Path, specified from the root of the WIM image, for the source file
2380          * or directory tree within the WIM image.  */
2381         wimlib_tchar *wim_source_path;
2382
2383         /** Path, specified from the root of the WIM image, for the destination
2384          * file or directory tree within the WIM image.  */
2385         wimlib_tchar *wim_target_path;
2386
2387         /** Reserved; set to 0.  */
2388         int rename_flags;
2389 };
2390
2391 /** Specification of an update to perform on a WIM image. */
2392 struct wimlib_update_command {
2393
2394         enum wimlib_update_op op;
2395
2396         union {
2397                 struct wimlib_add_command add;
2398                 struct wimlib_delete_command delete_; /* Underscore is for C++
2399                                                          compatibility.  */
2400                 struct wimlib_rename_command rename;
2401         };
2402 };
2403
2404 /** @} */
2405 /** @addtogroup G_general
2406  * @{ */
2407
2408 /**
2409  * Possible values of the error code returned by many functions in wimlib.
2410  *
2411  * See the documentation for each wimlib function to see specifically what error
2412  * codes can be returned by a given function, and what they mean.
2413  */
2414 enum wimlib_error_code {
2415         WIMLIB_ERR_SUCCESS                            = 0,
2416         WIMLIB_ERR_ALREADY_LOCKED                     = 1,
2417         WIMLIB_ERR_DECOMPRESSION                      = 2,
2418         WIMLIB_ERR_FUSE                               = 6,
2419         WIMLIB_ERR_GLOB_HAD_NO_MATCHES                = 8,
2420         WIMLIB_ERR_ICONV_NOT_AVAILABLE                = 9,
2421         WIMLIB_ERR_IMAGE_COUNT                        = 10,
2422         WIMLIB_ERR_IMAGE_NAME_COLLISION               = 11,
2423         WIMLIB_ERR_INSUFFICIENT_PRIVILEGES            = 12,
2424         WIMLIB_ERR_INTEGRITY                          = 13,
2425         WIMLIB_ERR_INVALID_CAPTURE_CONFIG             = 14,
2426         WIMLIB_ERR_INVALID_CHUNK_SIZE                 = 15,
2427         WIMLIB_ERR_INVALID_COMPRESSION_TYPE           = 16,
2428         WIMLIB_ERR_INVALID_HEADER                     = 17,
2429         WIMLIB_ERR_INVALID_IMAGE                      = 18,
2430         WIMLIB_ERR_INVALID_INTEGRITY_TABLE            = 19,
2431         WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY         = 20,
2432         WIMLIB_ERR_INVALID_METADATA_RESOURCE          = 21,
2433         WIMLIB_ERR_INVALID_MULTIBYTE_STRING           = 22,
2434         WIMLIB_ERR_INVALID_OVERLAY                    = 23,
2435         WIMLIB_ERR_INVALID_PARAM                      = 24,
2436         WIMLIB_ERR_INVALID_PART_NUMBER                = 25,
2437         WIMLIB_ERR_INVALID_PIPABLE_WIM                = 26,
2438         WIMLIB_ERR_INVALID_REPARSE_DATA               = 27,
2439         WIMLIB_ERR_INVALID_RESOURCE_HASH              = 28,
2440         WIMLIB_ERR_INVALID_UTF16_STRING               = 30,
2441         WIMLIB_ERR_INVALID_UTF8_STRING                = 31,
2442         WIMLIB_ERR_IS_DIRECTORY                       = 32,
2443         WIMLIB_ERR_IS_SPLIT_WIM                       = 33,
2444         WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE = 34,
2445         WIMLIB_ERR_LINK                               = 35,
2446         WIMLIB_ERR_METADATA_NOT_FOUND                 = 36,
2447         WIMLIB_ERR_MKDIR                              = 37,
2448         WIMLIB_ERR_MQUEUE                             = 38,
2449         WIMLIB_ERR_NOMEM                              = 39,
2450         WIMLIB_ERR_NOTDIR                             = 40,
2451         WIMLIB_ERR_NOTEMPTY                           = 41,
2452         WIMLIB_ERR_NOT_A_REGULAR_FILE                 = 42,
2453         WIMLIB_ERR_NOT_A_WIM_FILE                     = 43,
2454         WIMLIB_ERR_NOT_PIPABLE                        = 44,
2455         WIMLIB_ERR_NO_FILENAME                        = 45,
2456         WIMLIB_ERR_NTFS_3G                            = 46,
2457         WIMLIB_ERR_OPEN                               = 47,
2458         WIMLIB_ERR_OPENDIR                            = 48,
2459         WIMLIB_ERR_PATH_DOES_NOT_EXIST                = 49,
2460         WIMLIB_ERR_READ                               = 50,
2461         WIMLIB_ERR_READLINK                           = 51,
2462         WIMLIB_ERR_RENAME                             = 52,
2463         WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED         = 54,
2464         WIMLIB_ERR_RESOURCE_NOT_FOUND                 = 55,
2465         WIMLIB_ERR_RESOURCE_ORDER                     = 56,
2466         WIMLIB_ERR_SET_ATTRIBUTES                     = 57,
2467         WIMLIB_ERR_SET_REPARSE_DATA                   = 58,
2468         WIMLIB_ERR_SET_SECURITY                       = 59,
2469         WIMLIB_ERR_SET_SHORT_NAME                     = 60,
2470         WIMLIB_ERR_SET_TIMESTAMPS                     = 61,
2471         WIMLIB_ERR_SPLIT_INVALID                      = 62,
2472         WIMLIB_ERR_STAT                               = 63,
2473         WIMLIB_ERR_UNEXPECTED_END_OF_FILE             = 65,
2474         WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE   = 66,
2475         WIMLIB_ERR_UNKNOWN_VERSION                    = 67,
2476         WIMLIB_ERR_UNSUPPORTED                        = 68,
2477         WIMLIB_ERR_UNSUPPORTED_FILE                   = 69,
2478         WIMLIB_ERR_WIM_IS_READONLY                    = 71,
2479         WIMLIB_ERR_WRITE                              = 72,
2480         WIMLIB_ERR_XML                                = 73,
2481         WIMLIB_ERR_WIM_IS_ENCRYPTED                   = 74,
2482         WIMLIB_ERR_WIMBOOT                            = 75,
2483         WIMLIB_ERR_ABORTED_BY_PROGRESS                = 76,
2484         WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS            = 77,
2485         WIMLIB_ERR_MKNOD                              = 78,
2486         WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY              = 79,
2487         WIMLIB_ERR_NOT_A_MOUNTPOINT                   = 80,
2488         WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT           = 81,
2489         WIMLIB_ERR_FVE_LOCKED_VOLUME                  = 82,
2490 };
2491
2492
2493 /** Used to indicate no WIM image or an invalid WIM image. */
2494 #define WIMLIB_NO_IMAGE         0
2495
2496 /** Used to specify all images in the WIM. */
2497 #define WIMLIB_ALL_IMAGES       (-1)
2498
2499 /** @}  */
2500
2501 /**
2502  * @ingroup G_modifying_wims
2503  *
2504  * Appends an empty image to a WIM file.  This empty image will initially
2505  * contain no files or directories, although if written without further
2506  * modifications, a root directory will be created automatically for it.  After
2507  * calling this function, you can use wimlib_update_image() to add files to the
2508  * new WIM image.  This gives you slightly more control over making the new
2509  * image compared to calling wimlib_add_image() or
2510  * wimlib_add_image_multisource() directly.
2511  *
2512  * @param wim
2513  *      Pointer to the ::WIMStruct for the WIM file to which the image is to be
2514  *      added.
2515  * @param name
2516  *      Name to give the new image.  If @c NULL or empty, the new image is given
2517  *      no name.  If nonempty, it must specify a name that does not already
2518  *      exist in @p wim.
2519  * @param new_idx_ret
2520  *      If non-<code>NULL</code>, the index of the newly added image is returned
2521  *      in this location.
2522  *
2523  * @return 0 on success; nonzero on failure.  The possible error codes are:
2524  *
2525  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2526  *      There is already an image in @p wim named @p name.
2527  * @retval ::WIMLIB_ERR_NOMEM
2528  *      Failed to allocate the memory needed to add the new image.
2529  */
2530 extern int
2531 wimlib_add_empty_image(WIMStruct *wim,
2532                        const wimlib_tchar *name,
2533                        int *new_idx_ret);
2534
2535 /**
2536  * @ingroup G_modifying_wims
2537  *
2538  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
2539  *
2540  * The directory tree or NTFS volume is scanned immediately to load the dentry
2541  * tree into memory, and file attributes and symbolic links are read.  However,
2542  * actual file data is not read until wimlib_write() or wimlib_overwrite() is
2543  * called.
2544  *
2545  * See the manual page for the @b wimlib-imagex program for more information
2546  * about the "normal" capture mode versus the NTFS capture mode (entered by
2547  * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2548  *
2549  * Note that @b no changes are committed to the underlying WIM file (if
2550  * any) until wimlib_write() or wimlib_overwrite() is called.
2551  *
2552  * @param wim
2553  *      Pointer to the ::WIMStruct to which to add the image.
2554  * @param source
2555  *      A path to a directory or unmounted NTFS volume that will be captured as
2556  *      a WIM image.
2557  * @param name
2558  *      Name to give the new image.  If @c NULL or empty, the new image is given
2559  *      no name.  If nonempty, it must specify a name that does not already
2560  *      exist in @p wim.
2561  * @param config_file
2562  *      Path to capture configuration file, or @c NULL.  This file may specify,
2563  *      among other things, which files to exclude from capture.  See the man
2564  *      page for <b>wimlib-imagex capture</b> (<b>--config</b> option) for
2565  *      details of the file format.  If @c NULL, the default capture
2566  *      configuration shall be used.  Ordinarily, the default capture
2567  *      configuration will result in no files being excluded from capture purely
2568  *      based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2569  *      ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2570  * @param add_flags
2571  *      Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2572  *
2573  * @return 0 on success; nonzero on error.  On error, changes to @p wim are
2574  * discarded so that it appears to be in the same state as when this function
2575  * was called.
2576  *
2577  * This function is implemented by calling wimlib_add_empty_image(), then
2578  * calling wimlib_update_image() with a single "add" command, so any error code
2579  * returned by wimlib_add_empty_image() may be returned, as well as any error
2580  * codes returned by wimlib_update_image() other than ones documented as only
2581  * being returned specifically by an update involving delete or rename commands.
2582  *
2583  * If a progress function is registered with @p wim, it will receive the
2584  * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and ::WIMLIB_PROGRESS_MSG_SCAN_END.
2585  * In addition, if ::WIMLIB_ADD_FLAG_VERBOSE is specified in @p add_flags, it
2586  * will receive ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2587  */
2588 extern int
2589 wimlib_add_image(WIMStruct *wim,
2590                  const wimlib_tchar *source,
2591                  const wimlib_tchar *name,
2592                  const wimlib_tchar *config_file,
2593                  int add_flags);
2594
2595 /**
2596  * @ingroup G_modifying_wims
2597  *
2598  * This function is equivalent to wimlib_add_image() except it allows for
2599  * multiple sources to be combined into a single WIM image.  This is done by
2600  * specifying the @p sources and @p num_sources parameters instead of the @p
2601  * source parameter of wimlib_add_image().  The rest of the parameters are the
2602  * same as wimlib_add_image().  See the documentation for <b>wimlib-imagex
2603  * capture</b> for full details on how this mode works.
2604  *
2605  * In addition to the error codes that wimlib_add_image() can return,
2606  * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2607  * when trying to overlay a non-directory on a directory or when otherwise
2608  * trying to overlay multiple conflicting files to the same location in the WIM
2609  * image.  It will also return ::WIMLIB_ERR_INVALID_PARAM if
2610  * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2611  * was not exactly one capture source with the target being the root directory.
2612  * (In this respect, there is no advantage to using
2613  * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2614  * NTFS mode.) */
2615 extern int
2616 wimlib_add_image_multisource(WIMStruct *wim,
2617                              const struct wimlib_capture_source *sources,
2618                              size_t num_sources,
2619                              const wimlib_tchar *name,
2620                              const wimlib_tchar *config_file,
2621                              int add_flags);
2622
2623 /**
2624  * @ingroup G_modifying_wims
2625  *
2626  * Add the file or directory tree at @p fs_source_path on the filesystem to the
2627  * location @p wim_target_path within the specified @p image of the @p wim.
2628  *
2629  * This just builds an appropriate ::wimlib_add_command and passes it to
2630  * wimlib_update_image().
2631  */
2632 extern int
2633 wimlib_add_tree(WIMStruct *wim, int image,
2634                 const wimlib_tchar *fs_source_path,
2635                 const wimlib_tchar *wim_target_path, int add_flags);
2636
2637 /**
2638  * @ingroup G_creating_and_opening_wims
2639  *
2640  * Creates a ::WIMStruct for a new WIM file.
2641  *
2642  * This only creates an in-memory structure for a WIM that initially contains no
2643  * images.  No on-disk file is created until wimlib_write() is called.
2644  *
2645  * @param ctype
2646  *      The type of compression to be used in the new WIM file, as one of the
2647  *      ::wimlib_compression_type constants.
2648  *      <br/>
2649  *      This choice is not necessarily final; if desired, it can still be
2650  *      changed at any time before the WIM is written to disk, using
2651  *      wimlib_set_output_compression_type().  In addition, if you wish to use a
2652  *      non-default chunk size, you will need to call
2653  *      wimlib_set_output_chunk_size().
2654  * @param wim_ret
2655  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2656  *      written to the memory location pointed to by this parameter.  The
2657  *      ::WIMStruct must be freed using using wimlib_free() when finished with
2658  *      it.
2659  * @return 0 on success; nonzero on error.
2660  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2661  *      @p ctype was not a supported compression type.
2662  * @retval ::WIMLIB_ERR_NOMEM
2663  *      Failed to allocate needed memory.
2664  */
2665 extern int
2666 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2667
2668 /**
2669  * @ingroup G_modifying_wims
2670  *
2671  * Deletes an image, or all images, from a WIM file.
2672  *
2673  * Note: no changes are committed to the underlying WIM file (if any) until
2674  * wimlib_write() or wimlib_overwrite() is called.
2675  *
2676  * @param wim
2677  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2678  *      being deleted.
2679  * @param image
2680  *      The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2681  *      images.
2682  *
2683  * @return 0 on success; nonzero on failure.  On failure, @p wim is guaranteed
2684  * to be left unmodified only if @p image specified a single image.  If instead
2685  * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2686  * possible for some but not all of the images to have been deleted when a
2687  * failure status is returned.
2688  *
2689  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2690  *      @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2691  *
2692  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2693  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2694  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2695  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2696  * different reasons) to read the metadata resource for an image that needed to
2697  * be deleted.
2698  */
2699 extern int
2700 wimlib_delete_image(WIMStruct *wim, int image);
2701
2702 /**
2703  * @ingroup G_modifying_wims
2704  *
2705  * Delete the @p path from the specified @p image of the @p wim.
2706  *
2707  * This just builds an appropriate ::wimlib_delete_command and passes it to
2708  * wimlib_update_image().
2709  */
2710 extern int
2711 wimlib_delete_path(WIMStruct *wim, int image,
2712                    const wimlib_tchar *path, int delete_flags);
2713
2714 /**
2715  * @ingroup G_modifying_wims
2716  *
2717  * Exports an image, or all the images, from a WIM file, into another WIM file.
2718  *
2719  * The destination image is made to share the same dentry tree and security data
2720  * structure as the source image.  This places some restrictions on additional
2721  * functions that may be called.  For example, you may not call wimlib_free() on
2722  * @p src_wim before calling wimlib_write() or wimlib_overwrite() on @p dest_wim
2723  * because @p dest_wim will have references back to @p src_wim.
2724  *
2725  * If this function fails, all changes to @p dest_wim are rolled back.
2726  *
2727  * Please note that no changes are committed to the underlying WIM file of @p
2728  * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2729  *
2730  * @param src_wim
2731  *      The WIM from which to export the images, specified as a pointer to the
2732  *      ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2733  *      split WIM.  In the case of a WIM file that is not standalone, this
2734  *      ::WIMStruct must have had any needed external resources previously
2735  *      referenced using wimlib_reference_resources() or
2736  *      wimlib_reference_resource_files().
2737  * @param src_image
2738  *      The image to export from @p src_wim, as either a 1-based image index to
2739  *      export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2740  * @param dest_wim
2741  *      Pointer to the ::WIMStruct for a WIM that will receive the images being
2742  *      exported.
2743  * @param dest_name
2744  *      For single-image exports, the name to give the exported image in @p
2745  *      dest_wim.  If left @c NULL, the name from @p src_wim is used.  For
2746  *      ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2747  *      that case, the names are all taken from @p src_wim.  This parameter is
2748  *      overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2749  * @param dest_description
2750  *      For single-image exports, the description to give the exported image in
2751  *      the new WIM file.  If left @c NULL, the description from @p src_wim is
2752  *      used.  For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2753  *      NULL; in that case, the description are all taken from @p src_wim.  This
2754  *      parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2755  * @param export_flags
2756  *      Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2757  *
2758  * @return 0 on success; nonzero on error.
2759  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2760  *      One or more of the names being given to an exported image was already in
2761  *      use in the destination WIM.
2762  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2763  *      @p src_image does not exist in @p src_wim and was not
2764  *      ::WIMLIB_ALL_IMAGES.
2765  * @retval ::WIMLIB_ERR_INVALID_PARAM
2766  *      @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2767  *      ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2768  *      @c NULL.
2769  * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2770  *      Either @p src_wim or @p dest_wim did not contain metadata resources; for
2771  *      example, one of them was a non-first part of a split WIM.
2772  * @retval ::WIMLIB_ERR_NOMEM
2773  *      Failed to allocate needed memory.
2774  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2775  *      A resource that needed to be exported could not be found in either the
2776  *      source or destination WIMs.  This error can occur if, for example, @p
2777  *      src_wim is part of a split WIM but needed resources from the other split
2778  *      WIM parts were not referenced with wimlib_reference_resources() or
2779  *      wimlib_reference_resource_files() before the call to
2780  *      wimlib_export_image().
2781  *
2782  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2783  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2784  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2785  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2786  * different reasons) to read the metadata resource for an image in @p src_wim
2787  * that needed to be exported.
2788  */
2789 extern int
2790 wimlib_export_image(WIMStruct *src_wim, int src_image,
2791                     WIMStruct *dest_wim,
2792                     const wimlib_tchar *dest_name,
2793                     const wimlib_tchar *dest_description,
2794                     int export_flags);
2795
2796 /**
2797  * @ingroup G_extracting_wims
2798  *
2799  * Extracts an image, or all images, from a WIM to a directory or NTFS volume
2800  * image.
2801  *
2802  * The exact behavior of how wimlib extracts files from a WIM image is
2803  * controllable by the @p extract_flags parameter, but there also are
2804  * differences depending on the platform (UNIX-like vs Windows).  See the manual
2805  * page for <b>wimlib-imagex apply</b> for more information, including about the
2806  * NTFS-3g extraction mode.
2807  *
2808  * @param wim
2809  *      The WIM from which to extract the image(s), specified as a pointer to
2810  *      the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2811  *      of a split WIM.  In the case of a WIM file that is not standalone, this
2812  *      ::WIMStruct must have had any needed external resources previously
2813  *      referenced using wimlib_reference_resources() or
2814  *      wimlib_reference_resource_files().
2815  * @param image
2816  *      The image to extract, specified as either the 1-based index of a single
2817  *      image to extract, or ::WIMLIB_ALL_IMAGES to specify that all images are
2818  *      to be extracted.  However, ::WIMLIB_ALL_IMAGES cannot be used if
2819  *      ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2820  * @param target
2821  *      Directory to extract the WIM image(s) to; or, with
2822  *      ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to
2823  *      the unmounted NTFS volume to which to extract the image.
2824  * @param extract_flags
2825  *      Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2826  *
2827  * @return 0 on success; nonzero on error.
2828  * @retval ::WIMLIB_ERR_DECOMPRESSION
2829  *      Failed to decompress data contained in the WIM.
2830  * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2831  *      The metadata for one of the images to extract was invalid.
2832  * @retval ::WIMLIB_ERR_INVALID_PARAM
2833  *      The extraction flags were invalid; more details may be found in the
2834  *      documentation for the specific extraction flags that were specified.  Or
2835  *      @p target was @c NULL or an empty string, or @p wim was @c NULL.
2836  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2837  *      The SHA1 message digest of an extracted stream did not match the SHA1
2838  *      message digest given in the WIM.  In other words, the WIM file is
2839  *      corrupted, so the data cannot be extracted in its original form.
2840  * @retval ::WIMLIB_ERR_LINK
2841  *      Failed to create a symbolic link or a hard link.
2842  * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2843  *      The metadata resource for one of the images to extract was not found.
2844  *      This can happen if @p wim represents a non-first part of a split WIM.
2845  * @retval ::WIMLIB_ERR_MKDIR
2846  *      Failed create a directory.
2847  * @retval ::WIMLIB_ERR_NOMEM
2848  *      Failed to allocate needed memory.
2849  * @retval ::WIMLIB_ERR_OPEN
2850  *      Could not create a file, or failed to open an already-extracted file.
2851  * @retval ::WIMLIB_ERR_READ
2852  *      Failed to read data from the WIM.
2853  * @retval ::WIMLIB_ERR_READLINK
2854  *      Failed to determine the target of a symbolic link in the WIM.
2855  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2856  *      Failed to fix the target of an absolute symbolic link (e.g. if the
2857  *      target would have exceeded the maximum allowed length).  (Only if
2858  *      reparse data was supported by the extraction mode and
2859  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2860  *      extract_flags.)
2861  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2862  *      One of the files or directories that needed to be extracted referenced a
2863  *      stream not present in the WIM's lookup table (or in any of the lookup
2864  *      tables of the split WIM parts).  This can happen if the WIM is not
2865  *      standalone and the necessary resource WIMs, or split WIM parts, were not
2866  *      referenced with wimlib_reference_resource_files().
2867  * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2868  *      Failed to set attributes on a file.
2869  * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2870  *      Failed to set reparse data on a file (only if reparse data was supported
2871  *      by the extraction mode).
2872  * @retval ::WIMLIB_ERR_SET_SECURITY
2873  *      Failed to set security descriptor on a file.
2874  * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2875  *      Failed to set the short name of a file.
2876  * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2877  *      Failed to set timestamps on a file.
2878  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2879  *      Unexpected end-of-file occurred when reading data from the WIM.
2880  * @retval ::WIMLIB_ERR_UNSUPPORTED
2881  *      A requested extraction flag, or the data or metadata that must be
2882  *      extracted to support it, is unsupported in the build and configuration
2883  *      of wimlib, or on the current platform or extraction mode or target
2884  *      volume.  Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2885  *      ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2886  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2887  *      ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS, and
2888  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS.  For example, if
2889  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2890  *      extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2891  *      image contains one or more files with short names, but extracting short
2892  *      names is not supported --- on Windows, this occurs if the target volume
2893  *      does not support short names, while on non-Windows, this occurs if
2894  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2895  * @retval ::WIMLIB_ERR_WIMBOOT
2896  *      ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2897  *      there was a problem creating WIMBoot pointer files.
2898  * @retval ::WIMLIB_ERR_WRITE
2899  *      Failed to write data to a file being extracted.
2900  *
2901  * If a progress function is registered with @p wim, then as each image is
2902  * extracted it will receive ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, then
2903  * zero or more ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE messages, then zero
2904  * or more ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS messages, then zero or more
2905  * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, then
2906  * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2907  */
2908 extern int
2909 wimlib_extract_image(WIMStruct *wim, int image,
2910                      const wimlib_tchar *target, int extract_flags);
2911
2912 /**
2913  * @ingroup G_extracting_wims
2914  *
2915  * Extract one image from a pipe on which a pipable WIM is being sent.
2916  *
2917  * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE, and @ref
2918  * subsec_pipable_wims, for more information about pipable WIMs.
2919  *
2920  * This function operates in a special way to read the WIM fully sequentially.
2921  * As a result, there is no ::WIMStruct is made visible to library users, and
2922  * you cannot call wimlib_open_wim() on the pipe.  (You can, however, use
2923  * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2924  * seekable file, not a pipe.)
2925  *
2926  * @param pipe_fd
2927  *      File descriptor, which may be a pipe, opened for reading and positioned
2928  *      at the start of the pipable WIM.
2929  * @param image_num_or_name
2930  *      String that specifies the 1-based index or name of the image to extract.
2931  *      It is translated to an image index using the same rules that
2932  *      wimlib_resolve_image() uses.  However, unlike wimlib_extract_image(),
2933  *      only a single image (not all images) can be specified.  Alternatively,
2934  *      specify @p NULL here to use the first image in the WIM if it contains
2935  *      exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2936  * @param target
2937  *      Same as the corresponding parameter to wimlib_extract_image().
2938  * @param extract_flags
2939  *      Same as the corresponding parameter to wimlib_extract_image().
2940  *
2941  * @return 0 on success; nonzero on error.  The possible error codes include
2942  * those returned by wimlib_extract_image() and wimlib_open_wim() as well as the
2943  * following:
2944  *
2945  * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2946  *      Data read from the pipable WIM was invalid.
2947  * @retval ::WIMLIB_ERR_NOT_PIPABLE
2948  *      The WIM being piped over @p pipe_fd is a normal WIM, not a pipable WIM.
2949  */
2950 extern int
2951 wimlib_extract_image_from_pipe(int pipe_fd,
2952                                const wimlib_tchar *image_num_or_name,
2953                                const wimlib_tchar *target, int extract_flags);
2954
2955 /*
2956  * @ingroup G_extracting_wims
2957  *
2958  * Same as wimlib_extract_image_from_pipe(), but allows specifying a progress
2959  * function.  The progress function will be used while extracting the WIM image
2960  * and will receive the normal extraction progress messages, such as
2961  * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, in addition to
2962  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.
2963  */
2964 extern int
2965 wimlib_extract_image_from_pipe_with_progress(int pipe_fd,
2966                                              const wimlib_tchar *image_num_or_name,
2967                                              const wimlib_tchar *target,
2968                                              int extract_flags,
2969                                              wimlib_progress_func_t progfunc,
2970                                              void *progctx);
2971
2972 /**
2973  * @ingroup G_extracting_wims
2974  *
2975  * Similar to wimlib_extract_paths(), but the paths to extract from the WIM
2976  * image are specified in the ASCII, UTF-8, or UTF-16LE text file named by @p
2977  * path_list_file which itself contains the list of paths to use, one per line.
2978  * Leading and trailing whitespace is ignored.  Empty lines and lines beginning
2979  * with the ';' or '#' characters are ignored.  No quotes are needed, as paths
2980  * are otherwise delimited by the newline character.  However, quotes will be
2981  * stripped if present.
2982  *
2983  * The error codes are the same as those returned by wimlib_extract_paths(),
2984  * except that wimlib_extract_pathlist() returns an appropriate error code if it
2985  * cannot read the path list file (e.g. ::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2986  * ::WIMLIB_ERR_READ).
2987  */
2988 extern int
2989 wimlib_extract_pathlist(WIMStruct *wim, int image,
2990                         const wimlib_tchar *target,
2991                         const wimlib_tchar *path_list_file,
2992                         int extract_flags);
2993
2994 /**
2995  * @ingroup G_extracting_wims
2996  *
2997  * Extract zero or more paths (files or directory trees) from the specified WIM
2998  * image.
2999  *
3000  * By default, each path will be extracted to a corresponding subdirectory of
3001  * the target based on its location in the WIM image.  For example, if one of
3002  * the paths to extract is "/Windows/explorer.exe" and the target is "outdir",
3003  * the file will be extracted to "outdir/Windows/explorer.exe".  This behavior
3004  * can be changed by providing the flag
3005  * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which will cause each file
3006  * or directory tree to be placed directly in the target directory --- so the
3007  * same example would extract "/Windows/explorer.exe" to "outdir/explorer.exe".
3008  *
3009  * Symbolic links will not be dereferenced when paths in the WIM image are
3010  * interpreted.
3011  *
3012  * @param wim
3013  *      WIM from which to extract the paths, specified as a pointer to the
3014  *      ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
3015  *      split WIM.  In the case of a WIM file that is not standalone, this
3016  *      ::WIMStruct must have had any needed external resources previously
3017  *      referenced using wimlib_reference_resources() or
3018  *      wimlib_reference_resource_files().
3019  * @param image
3020  *      1-based index of the WIM image from which to extract the paths.
3021  * @param paths
3022  *      Array of paths to extract.  Each element must be the absolute path to a
3023  *      file or directory within the WIM image.  Separators may be either
3024  *      forwards or backwards slashes, and leading path separators are optional.
3025  *      The paths will be interpreted either case-sensitively (UNIX default) or
3026  *      case-insensitively (Windows default); however, the behavior can be
3027  *      configured explicitly at library initialization time by passing an
3028  *      appropriate flag to wimlib_global_init().
3029  *      <br/>
3030  *      By default, the characters @c * and @c ? are interpreted literally.
3031  *      This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
3032  *      extract_flags.
3033  *      <br/>
3034  *      By default, if any paths to extract do not exist, the error code
3035  *      ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned.  This behavior changes if
3036  *      ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
3037  * @param num_paths
3038  *      Number of paths specified in @p paths.
3039  * @param target
3040  *      Directory to which to extract the paths; or with
3041  *      ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
3042  *      unmounted NTFS volume to which to extract the paths.  Unlike the @p
3043  *      paths being extracted, the @p target must be native path.  On UNIX-like
3044  *      systems it may not contain backslashes, for example.
3045  * @param extract_flags
3046  *      Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
3047  *
3048  * @return 0 on success; nonzero on error.  Most of the error codes are the same
3049  * as those returned by wimlib_extract_image().  Below, some of the error codes
3050  * returned in situations specific to path-mode extraction are documented:
3051  *
3052  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3053  *      One of the paths to extract did not exist in the WIM image.  This error
3054  *      code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
3055  *      specified in @p extract_flags, or if both
3056  *      ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
3057  *      were specified in @p extract_flags.
3058  * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
3059  *      ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
3060  *      one of the paths to extract did not name a regular file.
3061  *
3062  * If a progress function is registered with @p wim, it will receive
3063  * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS.  Note that because the extraction code
3064  * is stream-based and not file-based, there is no way to get information about
3065  * which path is currently being extracted, but based on byte count you can
3066  * still calculate an approximate percentage complete for the extraction overall
3067  * which may be all you really need anyway.
3068  */
3069 extern int
3070 wimlib_extract_paths(WIMStruct *wim,
3071                      int image,
3072                      const wimlib_tchar *target,
3073                      const wimlib_tchar * const *paths,
3074                      size_t num_paths,
3075                      int extract_flags);
3076
3077 /**
3078  * @ingroup G_wim_information
3079  *
3080  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
3081  * includes a string of XML that describes the images contained in the WIM.
3082  *
3083  * See wimlib_get_xml_data() to read the XML data into memory instead.
3084  *
3085  * @param wim
3086  *      Pointer to the ::WIMStruct to query.  This need not represent a
3087  *      standalone WIM (e.g. it could represent part of a split WIM).
3088  * @param fp
3089  *      @c stdout, or a FILE* opened for writing, to extract the data to.
3090  *
3091  * @return 0 on success; nonzero on error.
3092  * @retval ::WIMLIB_ERR_INVALID_PARAM
3093  *      @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
3094  * @retval ::WIMLIB_ERR_NOMEM
3095  *      Failed to allocate needed memory.
3096  * @retval ::WIMLIB_ERR_READ
3097  *      Error reading the XML data from the WIM file.
3098  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3099  *      Error reading the XML data from the WIM file.
3100  * @retval ::WIMLIB_ERR_WRITE
3101  *      Failed to completely write the XML data to @p fp.
3102  */
3103 extern int
3104 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
3105
3106 /**
3107  * @ingroup G_general
3108  *
3109  * Frees all memory allocated for a WIMStruct and closes all files associated
3110  * with it.
3111  *
3112  * @param wim
3113  *      Pointer to the ::WIMStruct to free.
3114  *
3115  * @return This function has no return value.
3116  */
3117 extern void
3118 wimlib_free(WIMStruct *wim);
3119
3120 /**
3121  * @ingroup G_general
3122  *
3123  * Converts a ::wimlib_compression_type value into a string.
3124  *
3125  * @param ctype
3126  *      The ::wimlib_compression_type value to convert.
3127  *
3128  * @return
3129  *      A statically allocated string naming the compression algorithm,
3130  *      such as "None", "LZX", "XPRESS", or "Invalid".
3131  */
3132 extern const wimlib_tchar *
3133 wimlib_get_compression_type_string(int ctype);
3134
3135 /**
3136  * @ingroup G_general
3137  *
3138  * Converts an error code into a string describing it.
3139  *
3140  * @param code
3141  *      The error code returned by one of wimlib's functions.
3142  *
3143  * @return
3144  *      Pointer to a statically allocated string describing the error code.  If
3145  *      the error code is for some reason not recognized by the library, the
3146  *      string will be "Unknown error".
3147  */
3148 extern const wimlib_tchar *
3149 wimlib_get_error_string(enum wimlib_error_code code);
3150
3151 /**
3152  * @ingroup G_wim_information
3153  *
3154  * Returns the description of the specified image.
3155  *
3156  * @param wim
3157  *      Pointer to the ::WIMStruct to query.  This need not represent a
3158  *      standalone WIM (e.g. it could represent part of a split WIM).
3159  * @param image
3160  *      The number of the image, numbered starting at 1.
3161  *
3162  * @return
3163  *      The description of the image, or @c NULL if there is no such image, or
3164  *      @c NULL if the specified image has no description.  The description
3165  *      string is in library-internal memory and may not be modified or freed;
3166  *      in addition, the string will become invalid if the description of the
3167  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
3168  */
3169 extern const wimlib_tchar *
3170 wimlib_get_image_description(const WIMStruct *wim, int image);
3171
3172 /**
3173  * @ingroup G_wim_information
3174  *
3175  * Returns the name of the specified image.
3176  *
3177  * @param wim
3178  *      Pointer to the ::WIMStruct to query.  This need not represent a
3179  *      standalone WIM (e.g. it could represent part of a split WIM).
3180  * @param image
3181  *      The number of the image, numbered starting at 1.
3182  *
3183  * @return
3184  *      The name of the image, or @c NULL if there is no such image, or an empty
3185  *      string if the image is unnamed.  The name string is in
3186  *      library-internal memory and may not be modified or freed; in addition,
3187  *      the string will become invalid if the name of the image is changed, the
3188  *      image is deleted, or the ::WIMStruct is destroyed.
3189  */
3190 extern const wimlib_tchar *
3191 wimlib_get_image_name(const WIMStruct *wim, int image);
3192
3193 /**
3194  * @ingroup G_general
3195  *
3196  * Returns the version of wimlib as a 32-bit number whose top 12 bits contain
3197  * the major version, the next 10 bits contain the minor version, and the low 10
3198  * bits contain the patch version.
3199  *
3200  * In other words, the returned value is equal to <code>((WIMLIB_MAJOR_VERSION
3201  * << 20) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</code> for the
3202  * corresponding header file.
3203  */
3204 extern uint32_t
3205 wimlib_get_version(void);
3206
3207 /**
3208  * @ingroup G_wim_information
3209  *
3210  * Get basic information about a WIM file.
3211  *
3212  * @param wim
3213  *      Pointer to the ::WIMStruct to query.  This need not represent a
3214  *      standalone WIM (e.g. it could represent part of a split WIM).
3215  * @param info
3216  *      A ::wimlib_wim_info structure that will be filled in with information
3217  *      about the WIM file.
3218  * @return
3219  *      0
3220  */
3221 extern int
3222 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
3223
3224 /**
3225  * @ingroup G_wim_information
3226  *
3227  * Read the XML data of a WIM file into an in-memory buffer.  Every WIM file
3228  * includes a string of XML that describes the images contained in the WIM.
3229  *
3230  * See wimlib_extract_xml_data() to extract the XML data to a file stream
3231  * instead.
3232  *
3233  * @param wim
3234  *      Pointer to the ::WIMStruct to query.  This need not represent a
3235  *      standalone WIM (e.g. it could represent part of a split WIM).
3236  * @param buf_ret
3237  *      On success, a pointer to an allocated buffer containing the raw UTF16-LE
3238  *      XML data is written to this location.
3239  * @param bufsize_ret
3240  *      The size of the XML data in bytes is written to this location.
3241  *
3242  * @return 0 on success; nonzero on error.
3243  * @retval ::WIMLIB_ERR_INVALID_PARAM
3244  *      @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
3245  *      @p buf_ret or @p bufsize_ret was @c NULL.
3246  * @retval ::WIMLIB_ERR_NOMEM
3247  * @retval ::WIMLIB_ERR_READ
3248  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3249  *      Failed to read the XML data from the WIM.
3250  */
3251 extern int
3252 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
3253
3254 /**
3255  * @ingroup G_general
3256  *
3257  * Initialization function for wimlib.  Call before using any other wimlib
3258  * function except wimlib_set_print_errors().  If not done manually, this
3259  * function will be called automatically with @p init_flags set to
3260  * ::WIMLIB_INIT_FLAG_ASSUME_UTF8.  This function does nothing if called again
3261  * after it has already successfully run.
3262  *
3263  * @param init_flags
3264  *      Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
3265  *
3266  * @return 0 on success; nonzero on failure.  Currently, only the following
3267  * error code is defined:
3268  *
3269  * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
3270  *      ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
3271  *      ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
3272  *      init_flags, but the corresponding privileges could not be acquired.
3273  */
3274 extern int
3275 wimlib_global_init(int init_flags);
3276
3277 /**
3278  * @ingroup G_general
3279  *
3280  * Cleanup function for wimlib.  You are not required to call this function, but
3281  * it will release any global resources allocated by the library.
3282  */
3283 extern void
3284 wimlib_global_cleanup(void);
3285
3286 /**
3287  * @ingroup G_wim_information
3288  *
3289  * Determines if an image name is already used by some image in the WIM.
3290  *
3291  * @param wim
3292  *      Pointer to the ::WIMStruct to query.  This need not represent a
3293  *      standalone WIM (e.g. it could represent part of a split WIM).
3294  * @param name
3295  *      The name to check.
3296  *
3297  * @return
3298  *      @c true if there is already an image in @p wim named @p name; @c false
3299  *      if there is no image named @p name in @p wim.  If @p name is @c NULL or
3300  *      the empty string, @c false is returned.
3301  */
3302 extern bool
3303 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
3304
3305 /**
3306  * @ingroup G_wim_information
3307  *
3308  * Iterate through a file or directory tree in the WIM image.  By specifying
3309  * appropriate flags and a callback function, you can get the attributes of a
3310  * file in the WIM, get a directory listing, or even get a listing of the entire
3311  * WIM image.
3312  *
3313  * @param wim
3314  *      The WIM containing the image(s) over which to iterate, specified as a
3315  *      pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
3316  *      or part 1 of a split WIM.  In the case of a WIM file that is not
3317  *      standalone, this ::WIMStruct should have had any needed external
3318  *      resources previously referenced using wimlib_reference_resources() or
3319  *      wimlib_reference_resource_files().  If not, see
3320  *      ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
3321  *      the behavior when resources are missing.
3322  *
3323  * @param image
3324  *      The 1-based number of the image in @p wim that contains the files or
3325  *      directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
3326  *      iteration on all images in the WIM.
3327  *
3328  * @param path
3329  *      Path in the WIM image at which to do the iteration.
3330  *
3331  * @param flags
3332  *      Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
3333  *
3334  * @param cb
3335  *      A callback function that will receive each directory entry.
3336  *
3337  * @param user_ctx
3338  *      An extra parameter that will always be passed to the callback function
3339  *      @p cb.
3340  *
3341  * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
3342  * first nonzero value that was returned from @p cb.  However, additional error
3343  * codes may be returned, including the following:
3344  *
3345  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3346  *      @p path did not exist in the WIM image.
3347  * @retval ::WIMLIB_ERR_NOMEM
3348  *      Failed to allocate memory needed to create a ::wimlib_dir_entry.
3349  *
3350  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3351  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3352  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3353  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3354  * different reasons) to read the metadata resource for an image over which
3355  * iteration needed to be done.
3356  */
3357 extern int
3358 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
3359                         int flags,
3360                         wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
3361
3362 /**
3363  * @ingroup G_wim_information
3364  *
3365  * Iterate through the lookup table of a WIM file.  This can be used to directly
3366  * get a listing of the unique resources contained in a WIM file over all
3367  * images.  Both file resources and metadata resources are included.  However,
3368  * only resources actually included in the file represented by @a wim, plus
3369  * explicitly referenced external resources (via wimlib_reference_resources() or
3370  * wimlib_reference_resource_files()) are included in the iteration.  For
3371  * example, if @p wim represents just one part of a split WIM, then only
3372  * resources in that part will be included, unless other resources were
3373  * explicitly referenced.
3374  *
3375  * @param wim
3376  *      Pointer to the ::WIMStruct to query.  This need not represent a
3377  *      standalone WIM (e.g. it could represent part of a split WIM).
3378  *
3379  * @param flags
3380  *      Reserved; set to 0.
3381  *
3382  * @param cb
3383  *      A callback function that will receive each resource.
3384  *
3385  * @param user_ctx
3386  *      An extra parameter that will always be passed to the callback function
3387  *      @p cb.
3388  *
3389  * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
3390  * that was returned from @p cb.
3391  */
3392 extern int
3393 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
3394                             wimlib_iterate_lookup_table_callback_t cb,
3395                             void *user_ctx);
3396
3397 /**
3398  * @ingroup G_nonstandalone_wims
3399  *
3400  * Joins a split WIM into a stand-alone one-part WIM.
3401  *
3402  * @param swms
3403  *      An array of strings that gives the filenames of all parts of the split
3404  *      WIM.  No specific order is required, but all parts must be included with
3405  *      no duplicates.
3406  * @param num_swms
3407  *      Number of filenames in @p swms.
3408  * @param swm_open_flags
3409  *      Open flags for the split WIM parts (e.g.
3410  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
3411  * @param wim_write_flags
3412  *      Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
3413  *      be used to write the joined WIM.
3414  * @param output_path
3415  *      The path to write the joined WIM file to.
3416  *
3417  * @return 0 on success; nonzero on error.  This function may return most error
3418  * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
3419  * as the following error code:
3420  *
3421  * @retval ::WIMLIB_ERR_SPLIT_INVALID
3422  *      The split WIMs do not form a valid WIM because they do not include all
3423  *      the parts of the original WIM, there are duplicate parts, or not all the
3424  *      parts have the same GUID and compression type.
3425  *
3426  * Note: wimlib is generalized enough that this function is not actually needed
3427  * to join a split WIM; instead, you could open the first part of the split WIM,
3428  * then reference the other parts with wimlib_reference_resource_files(), then
3429  * write the joined WIM using wimlib_write().  However, wimlib_join() provides
3430  * an easy-to-use wrapper around this that has some advantages (e.g.  extra
3431  * sanity checks).
3432  */
3433 extern int
3434 wimlib_join(const wimlib_tchar * const *swms,
3435             unsigned num_swms,
3436             const wimlib_tchar *output_path,
3437             int swm_open_flags,
3438             int wim_write_flags);
3439
3440 /**
3441  * @ingroup G_nonstandalone_wims
3442  *
3443  * Same as wimlib_join(), but allows specifying a progress function.  The
3444  * progress function will receive the write progress messages, such as
3445  * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS, while writing the joined WIM.  In
3446  * addition, if ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p
3447  * swm_open_flags, the progress function will receive a series of
3448  * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages when each of the split WIM
3449  * parts is opened.
3450  */
3451 extern int
3452 wimlib_join_with_progress(const wimlib_tchar * const *swms,
3453                           unsigned num_swms,
3454                           const wimlib_tchar *output_path,
3455                           int swm_open_flags,
3456                           int wim_write_flags,
3457                           wimlib_progress_func_t progfunc,
3458                           void *progctx);
3459
3460
3461 /**
3462  * @ingroup G_mounting_wim_images
3463  *
3464  * Mounts an image from a WIM file on a directory read-only or read-write.
3465  *
3466  * @param wim
3467  *      Pointer to the ::WIMStruct containing the image to be mounted.
3468  * @param image
3469  *      The 1-based index of the image to mount.
3470  * @param dir
3471  *      The path to an existing empty directory on which to mount the WIM image.
3472  * @param mount_flags
3473  *      Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG.  Use
3474  *      ::WIMLIB_MOUNT_FLAG_READWRITE to request a read-write mount instead of a
3475  *      read-only mount.