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