799f66b15fde6d7778ccdf285de6a057d5f3f85f
[wimlib] / include / wimlib.h
1 /**
2  * @file wimlib.h
3  * @brief External header for wimlib.
4  *
5  * This file contains extensive comments for generating documentation with
6  * Doxygen.  The built HTML documentation can be viewed at
7  * http://wimlib.sourceforge.net.  Make sure to see the <a
8  * href="modules.html">Modules page</a> to make more sense of the declarations
9  * in this header.
10  */
11
12 /*
13  * Copyright (C) 2012, 2013, 2014 Eric Biggers
14  *
15  * This file is part of wimlib, a library for working with WIM files.
16  *
17  * wimlib is free software; you can redistribute it and/or modify it under the
18  * terms of the GNU General Public License as published by the Free
19  * Software Foundation; either version 3 of the License, or (at your option)
20  * any later version.
21  *
22  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
23  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
24  * A PARTICULAR PURPOSE. See the GNU General Public License for more
25  * details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with wimlib; if not, see http://www.gnu.org/licenses/.
29  */
30
31 /**
32  * @mainpage
33  *
34  * @section sec_intro Introduction
35  *
36  * This is the documentation for the library interface of wimlib 1.6.2, a C
37  * library for creating, modifying, extracting, and mounting files in the
38  * Windows Imaging Format.  This documentation is intended for developers only.
39  * If you have installed wimlib and want to know how to use the @b wimlib-imagex
40  * program, please see the README file or manual pages.
41  *
42  * @section sec_installing_and_compiling Installing and Compiling
43  *
44  * wimlib uses the GNU autotools, so, on UNIX-like systems, it should be easy to
45  * install with <code>configure && make && sudo make install</code>; however,
46  * please see the README for more information about installing it.
47  *
48  * To use wimlib in your program after installing it, include wimlib.h and link
49  * your program with @c -lwim.
50  *
51  * As of wimlib 1.5.0, wimlib.h is also compatible with C++.
52  *
53  * Note: before calling any other function declared in wimlib.h,
54  * wimlib_global_init() can (and in some cases, must) be called.  See its
55  * documentation for more details.
56  *
57  * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
58  *
59  * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.   There are
60  * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
61  * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
62  * which creates a new ::WIMStruct that initially contains no images and does
63  * not yet have a backing on-disk file.  See @ref G_creating_and_opening_wims
64  * for more details.
65  *
66  * A WIM file, represented by a ::WIMStruct, contains zero or more images.
67  * Images can be extracted (or "applied") using wimlib_extract_image(), added
68  * (or "captured" or "appended") using wimlib_add_image(), deleted using
69  * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
70  * modified using wimlib_update_image().  However, changes made to a WIM
71  * represented by a ::WIMStruct have no persistent effect until the WIM is
72  * actually written to an on-disk file.  This can be done using wimlib_write(),
73  * but if the WIM was originally opened using wimlib_open_wim(), then
74  * wimlib_overwrite() can be used instead.  See @ref G_extracting_wims, @ref
75  * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
76  *
77  * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
78  * files is a multi-step process.  For example, to add, or "append" an image to
79  * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
80  * append</b>, you must call the following functions:
81  *
82  * 1. wimlib_open_wim()
83  * 2. wimlib_add_image()
84  * 3. wimlib_overwrite()
85  *
86  * This design is very much on purpose as it makes the library more useful in
87  * general by allowing functions to be composed in different ways.  For example,
88  * you can make multiple changes to a WIM and commit them all to the underlying
89  * file in only one overwrite operation, which is more efficient.
90  *
91  * @section sec_cleaning_up Cleaning up
92  *
93  * After you are done with any ::WIMStruct, you can call wimlib_free() to free
94  * all resources associated with it.  Also, when you are completely done with
95  * using wimlib in your program, you can call wimlib_global_cleanup() to free
96  * any other resources allocated by the library.
97  *
98  * @section sec_error_handling Error Handling
99  *
100  * Most functions in wimlib return 0 on success and a positive error code on
101  * failure.  Use wimlib_get_error_string() to get a string that describes an
102  * error code.  wimlib also can print error messages to standard error itself
103  * when an error happens, and these may be more informative than the error code;
104  * to enable this, call wimlib_set_print_errors().  Please note that this is for
105  * convenience only, and some errors can occur without a message being printed.
106  * Currently, error messages and strings (as well as all documentation, for that
107  * matter) are only available in English.
108  *
109  * @section sec_encodings Locales and character encodings
110  *
111  * To support Windows as well as UNIX-like systems, wimlib's API typically takes
112  * and returns strings of ::wimlib_tchar, which are in a platform-dependent
113  * encoding.
114  *
115  * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
116  * and the encoding is UTF-16LE.
117  *
118  * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
119  * and the encoding is the locale-dependent multibyte encoding.  I recommend you
120  * set your locale to a UTF-8 capable locale to avoid any issues.  Also, by
121  * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
122  * call wimlib_global_init() after having set your desired locale.
123  *
124  * @section sec_advanced Additional information and features
125  *
126  *
127  * @subsection subsec_mounting_wim_images Mounting WIM images
128  *
129  * See @ref G_mounting_wim_images.
130  *
131  * @subsection subsec_progress_functions Progress Messages
132  *
133  * See @ref G_progress.
134  *
135  * @subsection subsec_non_standalone_wims Non-standalone WIMs
136  *
137  * See @ref G_nonstandalone_wims.
138  *
139  * @subsection subsec_pipable_wims Pipable WIMs
140  *
141  * wimlib supports a special "pipable" WIM format which unfortunately is @b not
142  * compatible with Microsoft's software.  To create a pipable WIM, call
143  * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
144  * ::WIMLIB_WRITE_FLAG_PIPABLE specified.  Pipable WIMs are pipable in both
145  * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
146  * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
147  * a pipable WIM.  wimlib can also transparently open and operate on pipable WIM
148  * s using a seekable file descriptor using the regular function calls (e.g.
149  * wimlib_open_wim(), wimlib_extract_image()).
150  *
151  * See the documentation for the <b>--pipable</b> flag of <b>wimlib-imagex
152  * capture</b> for more information about pipable WIMs.
153  *
154  * @subsection subsec_thread_safety Thread Safety
155  *
156  * wimlib is thread-safe, with the following exceptions:
157  * - Different threads cannot operate on the same ::WIMStruct at the same time;
158  *   they must use different ::WIMStruct's.
159  * - You must call wimlib_global_init() in one thread before calling any other
160  *   functions.
161  * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
162  * - wimlib_mount_image(), while it can be used to mount multiple WIMs
163  *   concurrently in the same process, will daemonize the entire process when it
164  *   does so for the first time.  This includes changing the working directory
165  *   to the root directory.
166  *
167  * @subsection subsec_limitations Limitations
168  *
169  * This section documents some technical limitations of wimlib not already
170  * documented in the man page for @b wimlib-imagex.
171  *
172  * - The old WIM format from Vista pre-releases is not supported.
173  * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
174  *   functionality other than that already present in @b ImageX, that allows you
175  *   to make certain Windows-specific modifications to a Windows PE image, such
176  *   as adding a driver or Windows component.  Such a tool could be implemented
177  *   on top of wimlib.
178  *
179  * @subsection more_info More information
180  *
181  * You are advised to read the README as well as the manual pages for
182  * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
183  * the API documentation.
184  */
185
186 /** @defgroup G_general General
187  *
188  * @brief Declarations and structures shared across the library.
189  */
190
191 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
192  *
193  * @brief Create new WIMs and open existing WIMs.
194  */
195
196 /** @defgroup G_wim_information Retrieving WIM information and directory listings
197  *
198  * @brief Retrieve information about a WIM or WIM image.
199  */
200
201 /** @defgroup G_modifying_wims Modifying WIMs
202  *
203  * @brief Make changes to a WIM.
204  *
205  * @section sec_adding_images Capturing and adding WIM images
206  *
207  * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
208  * appending an image to an existing WIM is a multi-step process, but at its
209  * core is wimlib_add_image() or an equivalent function.  Normally,
210  * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
211  * ::WIMStruct as a new image.  However, when supported by the build of the
212  * library, there is also a special NTFS volume capture mode (entered when
213  * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
214  * from an unmounted NTFS volume.
215  *
216  * Another function, wimlib_add_image_multisource() is also provided.  It
217  * generalizes wimlib_add_image() to allow combining multiple files or directory
218  * trees into a single WIM image in a configurable way.
219  *
220  * For maximum customization of WIM image creation, it is also possible to add a
221  * completely empty WIM image with wimlib_add_empty_image(), then update it with
222  * wimlib_update_image().  (This is in fact what wimlib_add_image() and
223  * wimlib_add_image_multisource() do internally.)
224  *
225  * Note that some details of how image addition/capture works are documented
226  * more fully in the manual page for <b>wimlib-imagex capture</b>.
227  *
228  * @section sec_deleting_images Deleting WIM images
229  *
230  * wimlib_delete_image() can delete an image from a ::WIMStruct.  But as usual,
231  * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
232  * be made persistent in an on-disk WIM file.
233  *
234  * @section sec_exporting_images Exporting WIM images
235  *
236  * wimlib_export_image() can copy, or "export", an image from one WIM to
237  * another.
238  *
239  * @section sec_other_modifications Other modifications
240  *
241  * wimlib_update_image() can add, delete, and rename files in a WIM image.
242  *
243  * wimlib_set_image_name(), wimlib_set_image_descripton(), and
244  * wimlib_set_image_flags() can change other image metadata.
245  *
246  * wimlib_set_wim_info() can change information about the WIM file itself, such
247  * as the boot index.
248  */
249
250 /** @defgroup G_extracting_wims Extracting WIMs
251  *
252  * @brief Extract files, directories, and images from a WIM.
253  *
254  * wimlib_extract_image() extracts, or "applies", an image from a WIM,
255  * represented by a ::WIMStruct.  This normally extracts the image to a
256  * directory, but when supported by the build of the library there is also a
257  * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
258  * is specified) that allows extracting a WIM image directly to an unmounted
259  * NTFS volume.  Various other flags allow further customization of image
260  * extraction.
261  *
262  * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
263  * of (possibly wildcard) paths from a WIM image.
264  *
265  * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
266  * over a pipe; see @ref subsec_pipable_wims.
267  *
268  * Some details of how WIM extraction works are documented more fully in the
269  * manual pages for <b>wimlib-imagex apply</b> and <b>wimlib-imagex extract</b>.
270  */
271
272 /** @defgroup G_mounting_wim_images Mounting WIM images
273  *
274  * @brief Mount and unmount WIM images.
275  *
276  * On UNIX-like systems supporting FUSE (such as Linux), wimlib supports
277  * mounting images from WIM files either read-only or read-write.  To mount an
278  * image, call wimlib_mount_image().  To unmount an image, call
279  * wimlib_unmount_image().  Mounting can be done without root privileges because
280  * it is implemented using FUSE (Filesystem in Userspace).  If wimlib is
281  * compiled with the <code>--without-fuse</code> flag, these functions will be
282  * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.  Note that mounting an
283  * image read-write is an alternative to calling wimlib_update_image().
284  */
285
286 /** @defgroup G_progress Progress Messages
287  *
288  * @brief Track the progress of long WIM operations.
289  *
290  * When operating on large archives, operations such as extraction will
291  * naturally take a while to complete.  Because of this and to improve the
292  * potential user-friendliness of library clients, a number of functions take a
293  * pointer to a progress function of type ::wimlib_progress_func_t.  This
294  * function will be called periodically during the WIM operation(s) to report on
295  * the progress of the operation (for example, how many bytes have been written
296  * so far).
297  */
298
299 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
300  *
301  * @brief Write and overwrite on-disk WIM files.
302  *
303  * As described in @ref sec_basic_wim_handling_concepts, these functions are
304  * critical to the design of the library as they allow new or modified WIMs to
305  * actually be written to on-disk files.  Generally, wimlib_write() is the
306  * function you need to call to write a new WIM file, and wimlib_overwrite() is
307  * the function you need to call to persistently update an existing WIM file.
308  */
309
310 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
311  *
312  * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
313  *
314  * Normally, ::WIMStruct represents a WIM file, but there's a bit more to it
315  * than that.  Normally, WIM files are "standalone".  However, WIM files can
316  * also be arranged in non-standalone ways, such as a set of on-disk files that
317  * together form a single "split WIM" or "delta WIM".  Such arrangements are
318  * fully supported by wimlib.  However, as a result, in such cases a ::WIMStruct
319  * created from one of these on-disk files initially only partially represents
320  * the full WIM and needs to, in effect, be logically combined with other
321  * ::WIMStruct's before performing certain operations, such as extracting files
322  * with wimlib_extract_image() or wimlib_extract_files().  This is done by
323  * calling wimlib_reference_resource_files() or wimlib_reference_resources().
324  *
325  * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
326  * specialized function (wimlib_split()) is needed to create a split WIM.
327  */
328
329 #ifndef _WIMLIB_H
330 #define _WIMLIB_H
331
332 #include <stdio.h>
333 #include <stddef.h>
334 #include <stdbool.h>
335 #include <inttypes.h>
336 #include <time.h>
337
338 /** @ingroup G_general
339  * @{ */
340
341 /** Major version of the library (for example, the 1 in 1.2.5).  */
342 #define WIMLIB_MAJOR_VERSION 1
343
344 /** Minor version of the library (for example, the 2 in 1.2.5). */
345 #define WIMLIB_MINOR_VERSION 6
346
347 /** Patch version of the library (for example, the 5 in 1.2.5). */
348 #define WIMLIB_PATCH_VERSION 2
349
350 #ifdef __cplusplus
351 extern "C" {
352 #endif
353
354 /** @} */
355 /** @ingroup G_general
356  * @{ */
357
358 /**
359  * Opaque structure that represents a WIM file.  This is an in-memory structure
360  * and need not correspond to a specific on-disk file.  However, a ::WIMStruct
361  * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
362  * continuing to exist so that data can be read from it as needed.
363  *
364  * Most functions in this library will work the same way regardless of whether a
365  * given ::WIMStruct was obtained through wimlib_open_wim() or
366  * wimlib_create_new_wim().  Exceptions are documented.
367  *
368  * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
369  * file from a ::WIMStruct.
370  *
371  * See @ref sec_basic_wim_handling_concepts for more information.
372  */
373 #ifndef WIMLIB_WIMSTRUCT_DECLARED
374 typedef struct WIMStruct WIMStruct;
375 #define WIMLIB_WIMSTRUCT_DECLARED
376 #endif
377
378 #ifdef __WIN32__
379 typedef wchar_t wimlib_tchar;
380 #else
381 /** See @ref sec_encodings */
382 typedef char wimlib_tchar;
383 #endif
384
385 #ifdef __WIN32__
386 /** Path separator for WIM paths passed back to progress callbacks. */
387 #  define WIMLIB_WIM_PATH_SEPARATOR '\\'
388 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
389 #else
390 /** Path separator for WIM paths passed back to progress callbacks. */
391 #  define WIMLIB_WIM_PATH_SEPARATOR '/'
392 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
393 #endif
394
395 #ifdef __GNUC__
396 #  define _wimlib_deprecated __attribute__((deprecated))
397 #else
398 #  define _wimlib_deprecated
399 #endif
400
401 #define WIMLIB_GUID_LEN 16
402
403 /**
404  * Specifies the compression type of a WIM file.
405  */
406 enum wimlib_compression_type {
407         /** An invalid compression type. */
408         WIMLIB_COMPRESSION_TYPE_INVALID = -1,
409
410         /** The WIM does not include any compressed resources. */
411         WIMLIB_COMPRESSION_TYPE_NONE = 0,
412
413         /** Compressed resources in the WIM use LZX compression. */
414         WIMLIB_COMPRESSION_TYPE_LZX = 1,
415
416         /** Compressed resources in the WIM use XPRESS compression. */
417         WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
418
419         /** Compressed resources in the WIM use LZMS compression.  Note: LZMS
420          * compression is only compatible with wimlib v1.6.0 and later and with
421          * WIMGAPI Windows 8 and later (and some restrictions apply on the
422          * latter).  */
423         WIMLIB_COMPRESSION_TYPE_LZMS = 3,
424 };
425
426 /** @} */
427 /** @ingroup G_progress
428  * @{ */
429
430 /** Possible values of the first parameter to the user-supplied
431  * ::wimlib_progress_func_t progress function */
432 enum wimlib_progress_msg {
433
434         /** A WIM image is about to be extracted.  @p info will point to
435          * ::wimlib_progress_info.extract.  This message is received once per
436          * image for calls to wimlib_extract_image() and
437          * wimlib_extract_image_from_pipe().  */
438         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
439
440         /** One or more file or directory trees within a WIM image is about to
441          * be extracted.  @p info will point to ::wimlib_progress_info.extract.
442          * This message is received once per extraction command for
443          * wimlib_extract_files(), but only once for wimlib_extract_paths() and
444          * wimlib_extract_pathlist().  (In the latter cases, wimlib combines all
445          * paths into a single extraction operation for optimization purposes.)
446          */
447         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
448
449         /** The directory structure and other preliminary metadata is about to
450          * be extracted.  @p info will point to ::wimlib_progress_info.extract.
451          * This message is received once after either
452          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN or
453          * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN.  */
454         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
455
456         /** Confirms that the directory structure and other preliminary metadata
457          * has been successfully extracted.  @p info will point to
458          * ::wimlib_progress_info.extract.  This message is paired with a
459          * preceding ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN message.
460          */
461         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
462
463         /** File data is currently being extracted.  @p info will point to
464          * ::wimlib_progress_info.extract.  This is the main message to track
465          * the progress of an extraction operation.  */
466         WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
467
468         /** Starting to read a new part of a split pipable WIM over the pipe.
469          * @p info will point to ::wimlib_progress_info.extract.  */
470         WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
471
472         /** All data for WIM files and directories have been extracted, and
473          * final metadata such as timestamps is about to be extracted.  @p info
474          * will point to ::wimlib_progress_info.extract.  This message is
475          * received once before ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END or
476          * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END.  */
477         WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
478
479         /** Confirms that the image has been successfully extracted.  @p info
480          * will point to ::wimlib_progress_info.extract.  This is paired with
481          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN.  */
482         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
483
484         /** Confirms that the files or directory trees have been successfully
485          * extracted.  @p info will point to ::wimlib_progress_info.extract.
486          * This is paired with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN.  */
487         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
488
489         /** The directory or NTFS volume is about to be scanned for metadata.
490          * @p info will point to ::wimlib_progress_info.scan.  This message is
491          * received once per call to wimlib_add_image(), or once per capture
492          * source passed to wimlib_add_image_multisource(), or once per add
493          * command passed to wimlib_update_image().  */
494         WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
495
496         /** A directory or file has been scanned.  @p info will point to
497          * ::wimlib_progress_info.scan, and its @p cur_path member will be
498          * valid.  This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
499          * been specified.  */
500         WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
501
502         /** Confirms that the directory or NTFS volume has been successfully
503          * scanned.  @p info will point to ::wimlib_progress_info.scan.  This is
504          * paired with a previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message,
505          * possibly with many intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY
506          * messages.  */
507         WIMLIB_PROGRESS_MSG_SCAN_END,
508
509         /** File resources ("streams") are currently being written to the WIM.
510          * @p info will point to ::wimlib_progress_info.write_streams.  This
511          * message may be received many times while the WIM file is being
512          * written or appended to with wimlib_write(), wimlib_overwrite(), or
513          * wimlib_write_to_fd().  */
514         WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
515
516         /** Per-image metadata is about to be written to the WIM file.  @p info
517          * will not be valid. */
518         WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
519
520         /** Confirms that per-image metadata has been successfully been written
521          * to the WIM file.  @p info will not be valid.  This message is paired
522          * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
523          */
524         WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
525
526         /** wimlib_overwrite() has successfully renamed the temporary file to
527          * the original WIM file, thereby committing the update.  @p info will
528          * point to ::wimlib_progress_info.rename.  Note: this message is not
529          * received if wimlib_overwrite() chose to append to the WIM file
530          * in-place.  */
531         WIMLIB_PROGRESS_MSG_RENAME,
532
533         /** The contents of the WIM file are being checked against the integrity
534          * table.  @p info will point to ::wimlib_progress_info.integrity.  This
535          * message is only received (and may be received many times) when
536          * wimlib_open_wim() is called with the
537          * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag.  */
538         WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
539
540         /** An integrity table is being calculated for the WIM being written.
541          * @p info will point to ::wimlib_progress_info.integrity.  This message
542          * is only received (and may be received many times) when a WIM file is
543          * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.  */
544         WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
545
546         /** Reserved.  */
547         WIMLIB_PROGRESS_MSG_RESERVED,
548
549         /** A wimlib_split() operation is in progress, and a new split part is
550          * about to be started.  @p info will point to
551          * ::wimlib_progress_info.split.  */
552         WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
553
554         /** A wimlib_split() operation is in progress, and a split part has been
555          * finished. @p info will point to ::wimlib_progress_info.split.  */
556         WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
557
558         /** A WIM update command is just about to be executed. @p info will
559          * point to ::wimlib_progress_info.update.  This message is received
560          * once per update command when wimlib_update_image() is called with the
561          * flag ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS.  */
562         WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
563
564         /** A WIM update command has just been executed. @p info will point to
565          * ::wimlib_progress_info.update.  This message is received once per
566          * update command when wimlib_update_image() is called with the flag
567          * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS.  */
568         WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
569
570 };
571
572 /** A pointer to this union is passed to the user-supplied
573  * ::wimlib_progress_func_t progress function.  One (or none) of the structures
574  * contained in this union will be applicable for the operation
575  * (::wimlib_progress_msg) indicated in the first argument to the progress
576  * function. */
577 union wimlib_progress_info {
578
579         /* N.B. I wanted these to be anonymous structs, but Doxygen won't
580          * document them if they aren't given a name... */
581
582         /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.  This is
583          * the primary message for tracking the progress of writing a WIM file.
584          */
585         struct wimlib_progress_info_write_streams {
586                 /** Total number of uncompressed bytes of stream data being
587                  * written.  This can be thought of as the total uncompressed
588                  * size of the files being archived, with some caveats.  WIM
589                  * files use single-instance streams, so the size provided here
590                  * only counts distinct streams, except for the following
591                  * exception: the size provided here may include the sizes of
592                  * all newly added (e.g. with wimlib_add_image() streams,
593                  * pending automatic de-duplication during the write operation
594                  * itself.  When each such stream de-duplication occurs, this
595                  * number will be decreased by the size of the duplicate stream
596                  * that need not be written.
597                  *
598                  * In the case of a wimlib_overwrite() that the library opted to
599                  * perform in-place, both @p total_streams and @p total_bytes
600                  * will only count the streams actually being written and not
601                  * pre-existing streams in the WIM file.  */
602                 uint64_t total_bytes;
603
604                 /** Total number of streams being written.  This can be thought
605                  * of as the total number of files being archived, with some
606                  * caveats.  In general, a single file or directory may contain
607                  * multiple data streams, each of which will be represented
608                  * separately in this number.  Furthermore, WIM files use
609                  * single-instance streams, so the stream count provided here
610                  * only counts distinct streams, except for the following
611                  * exception: the stream count provided here may include newly
612                  * added (e.g. with wimlib_add_image() streams, pending
613                  * automatic de-duplication during the write operation itself.
614                  * When each such stream de-duplication occurs, this number will
615                  * be decreased by 1 to account for the duplicate stream that
616                  * need not be written.  */
617                 uint64_t total_streams;
618
619                 /** Number of uncompressed bytes of stream data that have been
620                  * written so far.  This number be 0 initially, and will be
621                  * equal to @p total_bytes at the end of the write operation.
622                  * Note that @p total_bytes (but not @p completed_bytes) may
623                  * decrease throughout the write operation due to the discovery
624                  * of stream duplications.  */
625                 uint64_t completed_bytes;
626
627                 /** Number of streams that have been written so far.  This
628                  * number will be 0 initially, and will be equal to @p
629                  * total_streams at the end of the write operation.  Note that
630                  * @p total_streams (but not @p completed_streams) may decrease
631                  * throughout the write operation due to the discovery of stream
632                  * duplications.
633                  *
634                  * For applications that wish to calculate a simple "percent
635                  * complete" for the write operation, it will likely be more
636                  * accurate to calculate the percentage from @p completed_bytes
637                  * and @p total_bytes rather than @p completed_streams and
638                  * @p total_streams because the time for the operation to
639                  * complete is mainly determined by the number of bytes that
640                  * need to be read, compressed, and written, not just the number
641                  * of files being archived.  */
642                 uint64_t completed_streams;
643
644                 /** Number of threads that are being used to compress streams,
645                  * or 1 if streams are being written uncompressed.  */
646                 uint32_t num_threads;
647
648                 /** The compression type being used to write the streams, as one
649                  * of the ::wimlib_compression_type constants.  */
650                 int32_t  compression_type;
651
652                 /** Number of split WIM parts from which streams are being
653                  * written (may be 0 if irrelevant).  */
654                 uint32_t total_parts;
655
656                 /** Number of split WIM parts from which streams have been
657                  * written (may be 0 if irrelevant).  */
658                 uint32_t completed_parts;
659         } write_streams;
660
661         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
662          * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
663          * ::WIMLIB_PROGRESS_MSG_SCAN_END.  */
664         struct wimlib_progress_info_scan {
665                 /** Top-level directory being scanned; or, when capturing a NTFS
666                  * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
667                  * to the file or block device that contains the NTFS volume
668                  * being scanned.  */
669                 const wimlib_tchar *source;
670
671                 /** Path to the file (or directory) that has been scanned, valid
672                  * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.  When capturing a NTFS
673                  * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
674                  * relative to the root of the NTFS volume.  */
675                 const wimlib_tchar *cur_path;
676
677                 /** Dentry scan status, valid on
678                  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.  */
679                 enum {
680                         /** The file looks okay and will be captured.  */
681                         WIMLIB_SCAN_DENTRY_OK = 0,
682
683                         /** File is being excluded from capture due to the
684                          * capture configuration.  */
685                         WIMLIB_SCAN_DENTRY_EXCLUDED,
686
687                         /** File is being excluded from capture due to being
688                          * unsupported (e.g. an encrypted or device file).  */
689                         WIMLIB_SCAN_DENTRY_UNSUPPORTED,
690
691                         /** The file is an absolute symbolic link or junction
692                          * point and it is being excluded from capture because
693                          * it points outside of the capture directory and
694                          * reparse-point fixups are enabled.  (Reparse point
695                          * fixups can be disabled by using the flag
696                          * ::WIMLIB_ADD_FLAG_NORPFIX.)  */
697                         WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK,
698                 } status;
699
700                 union {
701                         /** Target path in the WIM image.  Only valid on
702                          * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
703                          * ::WIMLIB_PROGRESS_MSG_SCAN_END.  If capturing a full
704                          * image, this will be the empty string; otherwise it
705                          * will name the place in the WIM image at which the
706                          * directory tree is being added.  */
707                         const wimlib_tchar *wim_target_path;
708
709                         /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
710                          * of @p WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK, this is
711                          * the target of the absolute symbolic link or junction
712                          * point.  */
713                         const wimlib_tchar *symlink_target;
714                 };
715
716                 /** Number of directories scanned so far, including the root
717                  * directory but excluding any unsupported/excluded directories.
718                  *
719                  * Details: On Windows and in NTFS capture mode, a reparse point
720                  * counts as a directory if and only if it has
721                  * FILE_ATTRIBUTE_DIRECTORY set.  Otherwise, a symbolic link
722                  * counts as a directory if and only if when fully dereferenced
723                  * it points to an accessible directory.  If a file has multiple
724                  * names (hard links), it is only counted one time.  */
725                 uint64_t num_dirs_scanned;
726
727                 /** Number of non-directories scanned so far, excluding any
728                  * unsupported/excluded files.
729                  *
730                  * Details: On Windows and in NTFS capture mode, a reparse point
731                  * counts as a non-directory if and only if it does not have
732                  * FILE_ATTRIBUTE_DIRECTORY set.  Otherwise, a symbolic link
733                  * counts as a non-directory if and only if when fully
734                  * dereferenced it points to a non-directory or its target is
735                  * inaccessible.  If a file has multiple names (hard links), it
736                  * is only counted one time.  */
737                 uint64_t num_nondirs_scanned;
738
739                 /** Number of bytes of file data that have been detected so far.
740                  *
741                  * Details: This data may not actually have been read yet, and
742                  * it will not actually be written to the WIM file until
743                  * wimlib_write() or wimlib_overwrite() has been called.  Data
744                  * from excluded files is not counted.  This number includes
745                  * default file contents as well as named data streams and
746                  * reparse point data.  The size of reparse point data is
747                  * tallied after any reparse-point fixups, and in the case of
748                  * capturing a symbolic link on a UNIX-like system, the creation
749                  * of the reparse point data itself.  If a file has multiple
750                  * names (hard links), its size(s) are only counted one time.
751                  * On Windows, encrypted files have their encrypted size
752                  * counted, not their unencrypted size; however, compressed
753                  * files have their uncompressed size counted.  */
754                 uint64_t num_bytes_scanned;
755         } scan;
756
757         /** Valid on messages
758          * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
759          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
760          * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
761          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
762          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
763          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
764          * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
765          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END, and
766          * ::WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS.
767          *
768          * Note: most of the time of an extraction operation will be spent
769          * extracting streams, and the application will receive
770          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time.  Using @p
771          * completed_bytes and @p total_bytes, the application can calculate a
772          * percentage complete.  However, note that this message does not, in
773          * general, actually provide information about which "file" is currently
774          * being extracted.  This is because wimlib, by default, extracts the
775          * individual data streams in whichever order it determines to be the
776          * most efficient.
777          *
778          * An additional caveat: wimlib_extract_files() will perform a separate
779          * logical extraction operation, with separate byte counts, for each
780          * extraction command (file or directory tree).  On the other hand,
781          * wimlib_extract_paths() and wimlib_extract_pathlist() combine all the
782          * paths to extract into a single logical extraction operation.
783          */
784         struct wimlib_progress_info_extract {
785                 /** Number of the image from which files are being extracted
786                  * (1-based).  */
787                 uint32_t image;
788
789                 /** Extraction flags being used.  */
790                 uint32_t extract_flags;
791
792                 /** Full path to the WIM file from which files are being
793                  * extracted, or @c NULL if the WIMStruct has no associated
794                  * on-disk file.  */
795                 const wimlib_tchar *wimfile_name;
796
797                 /** Name of the image from which files are being extracted, or
798                  * the empty string if the image is unnamed.  */
799                 const wimlib_tchar *image_name;
800
801                 /** Path to the directory or NTFS volume to which the files are
802                  * being extracted.  */
803                 const wimlib_tchar *target;
804
805                 /** Reserved.  */
806                 const wimlib_tchar *reserved;
807
808                 /** Number of bytes of uncompressed data that will be extracted.
809                  * If a file has multiple names (hard links), its size (or
810                  * sizes, in the case of named data streams) is only counted one
811                  * time.  For "reparse points" and symbolic links, the size to
812                  * be extracted is the size of the reparse data buffer.
813                  *
814                  * This number will stay constant throughout the extraction.  */
815                 uint64_t total_bytes;
816
817                 /** Number of bytes of uncompressed data that have been
818                  * extracted so far.  This initially be 0 and will equal to @p
819                  * total_bytes at the end of the extraction.  */
820                 uint64_t completed_bytes;
821
822                 /** Number of (not necessarily unique) streams that will be
823                  * extracted.  This may be more or less than the number of
824                  * "files" to be extracted due to hard links as well as
825                  * potentially multiple streams per file (named data streams).
826                  * A "stream" may be the default contents of a file, a named
827                  * data stream, or a reparse data buffer.  */
828                 uint64_t num_streams;
829
830                 /** When extracting files using wimlib_extract_files(), this
831                  * will be the path within the WIM image to the file or
832                  * directory tree currently being extracted.  Otherwise, this
833                  * will be the empty string.  */
834                 const wimlib_tchar *extract_root_wim_source_path;
835
836                 /** Currently only used for
837                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
838                 uint32_t part_number;
839
840                 /** Currently only used for
841                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
842                 uint32_t total_parts;
843
844                 /** Currently only used for
845                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
846                 uint8_t guid[WIMLIB_GUID_LEN];
847         } extract;
848
849         /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
850         struct wimlib_progress_info_rename {
851                 /** Name of the temporary file that the WIM was written to. */
852                 const wimlib_tchar *from;
853
854                 /** Name of the original WIM file to which the temporary file is
855                  * being renamed. */
856                 const wimlib_tchar *to;
857         } rename;
858
859         /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
860          * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
861         struct wimlib_progress_info_update {
862                 /** Pointer to the update command that will be executed or has
863                  * just been executed. */
864                 const struct wimlib_update_command *command;
865
866                 /** Number of update commands that have been completed so far.
867                  */
868                 size_t completed_commands;
869
870                 /** Number of update commands that are being executed as part of
871                  * this call to wimlib_update_image(). */
872                 size_t total_commands;
873         } update;
874
875         /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
876          * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
877         struct wimlib_progress_info_integrity {
878                 /** Number of bytes from the end of the WIM header to the end of
879                  * the lookup table (the area that is covered by the SHA1
880                  * integrity checks.) */
881                 uint64_t total_bytes;
882
883                 /** Number of bytes that have been SHA1-summed so far.  Will be
884                  * 0 initially, and equal @p total_bytes at the end. */
885                 uint64_t completed_bytes;
886
887                 /** Number of chunks that the checksummed region is divided
888                  * into. */
889                 uint32_t total_chunks;
890
891                 /** Number of chunks that have been SHA1-summed so far.   Will
892                  * be 0 initially, and equal to @p total_chunks at the end. */
893                 uint32_t completed_chunks;
894
895                 /** Size of the chunks used for the integrity calculation. */
896                 uint32_t chunk_size;
897
898                 /** Filename of the WIM (only valid if the message is
899                  * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
900                 const wimlib_tchar *filename;
901         } integrity;
902
903         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
904          * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
905         struct wimlib_progress_info_split {
906                 /** Total size of the original WIM's file and metadata resources
907                  * (compressed). */
908                 uint64_t total_bytes;
909
910                 /** Number of bytes of file and metadata resources that have
911                  * been copied out of the original WIM so far.  Will be 0
912                  * initially, and equal to @p total_bytes at the end. */
913                 uint64_t completed_bytes;
914
915                 /** Number of the split WIM part that is about to be started
916                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
917                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
918                 unsigned cur_part_number;
919
920                 /** Total number of split WIM parts that are being written.  */
921                 unsigned total_parts;
922
923                 /** Name of the split WIM part that is about to be started
924                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
925                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
926                 const wimlib_tchar *part_name;
927         } split;
928 };
929
930 /** A user-supplied function that will be called periodically during certain WIM
931  * operations.  The first argument will be the type of operation that is being
932  * performed or is about to be started or has been completed.  The second
933  * argument will be a pointer to one of a number of structures depending on the
934  * first argument.  It may be @c NULL for some message types.
935  *
936  * The return value of the progress function is currently ignored, but it may do
937  * something in the future.  (Set it to 0 for now.)
938  */
939 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
940                                       const union wimlib_progress_info *info);
941
942 /** @} */
943 /** @ingroup G_modifying_wims
944  * @{ */
945
946 /** An array of these structures is passed to wimlib_add_image_multisource() to
947  * specify the sources from which to create a WIM image. */
948 struct wimlib_capture_source {
949         /** Absolute or relative path to a file or directory on the external
950          * filesystem to be included in the WIM image. */
951         wimlib_tchar *fs_source_path;
952
953         /** Destination path in the WIM image.  Leading and trailing slashes are
954          * ignored.  The empty string or @c NULL means the root directory of the
955          * WIM image. */
956         wimlib_tchar *wim_target_path;
957
958         /** Reserved; set to 0. */
959         long reserved;
960 };
961
962 /** Structure that specifies a list of path patterns. */
963 struct wimlib_pattern_list {
964         /** Array of patterns.  The patterns may be modified by library code,
965          * but the @p pats pointer itself will not.  See the man page for
966          * <b>wimlib-imagex capture</b> for more information about allowed
967          * patterns. */
968         wimlib_tchar **pats;
969
970         /** Number of patterns in the @p pats array. */
971         size_t num_pats;
972
973         /** Ignored; may be used by the calling code. */
974         size_t num_allocated_pats;
975 };
976
977 /** A structure that contains lists of wildcards that match paths to treat
978  * specially when capturing a WIM image. */
979 struct wimlib_capture_config {
980         /** Paths matching any pattern this list are excluded from being
981          * captured, except if the same path appears in @p
982          * exclusion_exception_pats. */
983         struct wimlib_pattern_list exclusion_pats;
984
985         /** Paths matching any pattern in this list are never excluded from
986          * being captured. */
987         struct wimlib_pattern_list exclusion_exception_pats;
988
989         /** Reserved for future capture configuration options. */
990         struct wimlib_pattern_list reserved1;
991
992         /** Reserved for future capture configuration options. */
993         struct wimlib_pattern_list reserved2;
994
995         /** Library internal use only. */
996         wimlib_tchar *_prefix;
997
998         /** Library internal use only. */
999         size_t _prefix_num_tchars;
1000 };
1001
1002 /** Set or unset the WIM header flag that marks it read-only
1003  * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
1004  * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter.  This
1005  * is distinct from basic file permissions; this flag can be set on a WIM file
1006  * that is physically writable.  If this flag is set, all further operations to
1007  * modify the WIM will fail, except calling wimlib_overwrite() with
1008  * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
1009  * allows you to set this flag persistently on the underlying WIM file.
1010  */
1011 #define WIMLIB_CHANGE_READONLY_FLAG             0x00000001
1012
1013 /** Set the GUID (globally unique identifier) of the WIM file to the value
1014  * specified in ::wimlib_wim_info.guid of the @p info parameter. */
1015 #define WIMLIB_CHANGE_GUID                      0x00000002
1016
1017 /** Change the bootable image of the WIM to the value specified in
1018  * ::wimlib_wim_info.boot_index of the @p info parameter.  */
1019 #define WIMLIB_CHANGE_BOOT_INDEX                0x00000004
1020
1021 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
1022  * in ::wimlib_wim_info.has_rpfix of the @p info parameter.  This flag generally
1023  * indicates whether an image in the WIM has been captured with reparse-point
1024  * fixups enabled.  wimlib also treats this flag as specifying whether to do
1025  * reparse-point fixups by default when capturing or applying WIM images.  */
1026 #define WIMLIB_CHANGE_RPFIX_FLAG                0x00000008
1027
1028 /** @} */
1029 /** @ingroup G_wim_information
1030  * @{ */
1031
1032 /** General information about a WIM file. */
1033 struct wimlib_wim_info {
1034
1035         /** Globally unique identifier for the WIM file.  Note: all parts of a
1036          * split WIM should have an identical value in this field.  */
1037         uint8_t  guid[WIMLIB_GUID_LEN];
1038
1039         /** Number of images in the WIM.  */
1040         uint32_t image_count;
1041
1042         /** 1-based index of the bootable image in the WIM, or 0 if no image is
1043          * bootable.  */
1044         uint32_t boot_index;
1045
1046         /** Version of the WIM file.  */
1047         uint32_t wim_version;
1048
1049         /** Chunk size used for compression.  */
1050         uint32_t chunk_size;
1051
1052         /** For split WIMs, the 1-based index of this part within the split WIM;
1053          * otherwise 1.  */
1054         uint16_t part_number;
1055
1056         /** For split WIMs, the total number of parts in the split WIM;
1057          * otherwise 1.  */
1058         uint16_t total_parts;
1059
1060         /** One of the ::wimlib_compression_type values that specifies the
1061          * method used to compress resources in the WIM.  */
1062         int32_t  compression_type;
1063
1064         /** Size of the WIM file in bytes, excluding the XML data and integrity
1065          * table.  */
1066         uint64_t total_bytes;
1067
1068         /** 1 if the WIM has an integrity table.  Note: if the ::WIMStruct was
1069          * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
1070          * this will always be 0, even if the ::WIMStruct was written to
1071          * somewhere by calling wimlib_write() with the
1072          * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
1073         uint32_t has_integrity_table : 1;
1074
1075         /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
1076          * wimlib_create_new_wim(). */
1077         uint32_t opened_from_file : 1;
1078
1079         /** 1 if the WIM is considered readonly for any reason. */
1080         uint32_t is_readonly : 1;
1081
1082         /** 1 if reparse-point fixups are supposedly enabled for one or more
1083          * images in the WIM.  */
1084         uint32_t has_rpfix : 1;
1085
1086         /** 1 if the WIM is marked as read-only.  */
1087         uint32_t is_marked_readonly : 1;
1088
1089         /** 1 if the WIM is part of a spanned set.  */
1090         uint32_t spanned : 1;
1091
1092         uint32_t write_in_progress : 1;
1093         uint32_t metadata_only : 1;
1094         uint32_t resource_only : 1;
1095
1096         /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE).  */
1097         uint32_t pipable : 1;
1098         uint32_t reserved_flags : 22;
1099         uint32_t reserved[9];
1100 };
1101
1102 /** Information about a unique stream in the WIM file.  (A stream is the same
1103  * thing as a "resource", except in the case of packed resources.)  */
1104 struct wimlib_resource_entry {
1105         /** Uncompressed size of the stream in bytes. */
1106         uint64_t uncompressed_size;
1107
1108         /** Compressed size of the stream in bytes.  This will be the same as @p
1109          * uncompressed_size if the stream is uncompressed.  Or, if @p
1110          * is_packed_streams is 1, this will be 0.  */
1111         uint64_t compressed_size;
1112
1113         /** Offset, in bytes, of this stream from the start of the WIM file.  Or
1114          * if @p packed is 1, then this is actually the offset at which this
1115          * stream begins in the uncompressed contents of the packed resource.
1116          */
1117         uint64_t offset;
1118
1119         /** SHA1 message digest of the stream's uncompressed contents.  */
1120         uint8_t sha1_hash[20];
1121
1122         /** Which part number of the split WIM this stream is in.  This should
1123          * be the same as the part number provided by wimlib_get_wim_info().  */
1124         uint32_t part_number;
1125
1126         /** Number of times this stream is referenced over all WIM images.  */
1127         uint32_t reference_count;
1128
1129         /** 1 if this stream is compressed.  */
1130         uint32_t is_compressed : 1;
1131
1132         /** 1 if this stream is a metadata resource rather than a file resource.
1133          * */
1134         uint32_t is_metadata : 1;
1135
1136         uint32_t is_free : 1;
1137         uint32_t is_spanned : 1;
1138
1139         /** 1 if this stream was not found in the lookup table of the
1140          * ::WIMStruct.  This normally implies a missing call to
1141          * wimlib_reference_resource_files() or wimlib_reference_resources().
1142          * */
1143         uint32_t is_missing : 1;
1144
1145         /** 1 if this stream is located in a packed resource which may contain
1146          * other streams (all compressed together) as well.  */
1147         uint32_t packed : 1;
1148
1149         uint32_t reserved_flags : 26;
1150
1151         /** If @p packed is 1, then this will specify the offset of the packed
1152          * resource in the WIM.  */
1153         uint64_t raw_resource_offset_in_wim;
1154
1155         /** If @p is_packed_streams is 1, then this will specify the compressed
1156          * size of the packed resource in the WIM.  */
1157         uint64_t raw_resource_compressed_size;
1158
1159         uint64_t reserved[2];
1160 };
1161
1162 /** A stream of a file in the WIM.  */
1163 struct wimlib_stream_entry {
1164         /** Name of the stream, or NULL if the stream is unnamed. */
1165         const wimlib_tchar *stream_name;
1166         /** Location, size, etc. of the stream within the WIM file.  */
1167         struct wimlib_resource_entry resource;
1168         uint64_t reserved[4];
1169 };
1170
1171 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1172  * Roughly, the information about a "file" in the WIM--- but really a directory
1173  * entry ("dentry") because hard links are allowed.  The hard_link_group_id
1174  * field can be used to distinguish actual file inodes.  */
1175 struct wimlib_dir_entry {
1176         /** Name of the file, or NULL if this file is unnamed (only possible for
1177          * the root directory) */
1178         const wimlib_tchar *filename;
1179
1180         /** 8.3 DOS name of this file, or NULL if this file has no such name.
1181          * */
1182         const wimlib_tchar *dos_name;
1183
1184         /** Full path to this file within the WIM image.  */
1185         const wimlib_tchar *full_path;
1186
1187         /** Depth of this directory entry, where 0 is the root, 1 is the root's
1188          * children, ..., etc. */
1189         size_t depth;
1190
1191         /** Pointer to the security descriptor for this file, in Windows
1192          * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1193          * security descriptor.  */
1194         const char *security_descriptor;
1195
1196         /** Length of the above security descriptor.  */
1197         size_t security_descriptor_size;
1198
1199 #define WIMLIB_FILE_ATTRIBUTE_READONLY            0x00000001
1200 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN              0x00000002
1201 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM              0x00000004
1202 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY           0x00000010
1203 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE             0x00000020
1204 #define WIMLIB_FILE_ATTRIBUTE_DEVICE              0x00000040
1205 #define WIMLIB_FILE_ATTRIBUTE_NORMAL              0x00000080
1206 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY           0x00000100
1207 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
1208 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
1209 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED          0x00000800
1210 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE             0x00001000
1211 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1212 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED           0x00004000
1213 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL             0x00010000
1214         /** File attributes, such as whether the file is a directory or not.
1215          * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1216          * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1217          * on other platforms.  */
1218         uint32_t attributes;
1219
1220 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO        0x00000000
1221 #define WIMLIB_REPARSE_TAG_RESERVED_ONE         0x00000001
1222 #define WIMLIB_REPARSE_TAG_MOUNT_POINT          0xA0000003
1223 #define WIMLIB_REPARSE_TAG_HSM                  0xC0000004
1224 #define WIMLIB_REPARSE_TAG_HSM2                 0x80000006
1225 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
1226 #define WIMLIB_REPARSE_TAG_SIS                  0x80000007
1227 #define WIMLIB_REPARSE_TAG_DFS                  0x8000000A
1228 #define WIMLIB_REPARSE_TAG_DFSR                 0x80000012
1229 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER       0x8000000B
1230 #define WIMLIB_REPARSE_TAG_SYMLINK              0xA000000C
1231         /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
1232          * attributes), this will give the reparse tag.  This tells you whether
1233          * the reparse point is a symbolic link, junction point, or some other,
1234          * more unusual kind of reparse point.  */
1235         uint32_t reparse_tag;
1236
1237         /*  Number of (hard) links to this file.  */
1238         uint32_t num_links;
1239
1240         /** Number of named data streams that this file has.  Normally 0.  */
1241         uint32_t num_named_streams;
1242
1243         /** Roughly, the inode number of this file.  However, it may be 0 if
1244          * @p num_links == 1.  */
1245         uint64_t hard_link_group_id;
1246
1247         /** Time this file was created.  */
1248         struct timespec creation_time;
1249
1250         /** Time this file was last written to.  */
1251         struct timespec last_write_time;
1252
1253         /** Time this file was last accessed.  */
1254         struct timespec last_access_time;
1255         uint64_t reserved[16];
1256
1257         /** Array of streams that make up this file.  The first entry will
1258          * always exist and will correspond to the unnamed data stream (default
1259          * file contents), so it will have @p stream_name == @c NULL.  There
1260          * will then be @p num_named_streams additional entries that specify the
1261          * named data streams, if any, each of which will have @p stream_name !=
1262          * @c NULL.  */
1263         struct wimlib_stream_entry streams[];
1264 };
1265
1266 /**
1267  * Type of a callback function to wimlib_iterate_dir_tree().  Must return 0 on
1268  * success.
1269  */
1270 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1271                                                   void *user_ctx);
1272
1273 /**
1274  * Type of a callback function to wimlib_iterate_lookup_table().  Must return 0
1275  * on success.
1276  */
1277 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1278                                                       void *user_ctx);
1279
1280 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1281  * just on the specified path. */
1282 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1283
1284 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1285  * itself; only its children (in the case of a non-empty directory) */
1286 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN  0x00000002
1287
1288 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1289  * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1290  * table of the ::WIMStruct.  The default behavior without this flag is to fill
1291  * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1292  * wimlib_resource_entry::is_missing "is_missing" flag.  */
1293 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED  0x00000004
1294
1295
1296 /** @} */
1297 /** @ingroup G_modifying_wims
1298  * @{ */
1299
1300 /** Directly capture a NTFS volume rather than a generic directory.  This flag
1301  * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1302  * ::WIMLIB_ADD_FLAG_UNIX_DATA.   */
1303 #define WIMLIB_ADD_FLAG_NTFS                    0x00000001
1304
1305 /** Follow symlinks; archive and dump the files they point to.  Cannot be used
1306  * with ::WIMLIB_ADD_FLAG_NTFS. */
1307 #define WIMLIB_ADD_FLAG_DEREFERENCE             0x00000002
1308
1309 /** Call the progress function with the message
1310  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1311  * scanned.  */
1312 #define WIMLIB_ADD_FLAG_VERBOSE                 0x00000004
1313
1314 /** Mark the image being added as the bootable image of the WIM.  Not valid for
1315  * wimlib_update_image().  */
1316 #define WIMLIB_ADD_FLAG_BOOT                    0x00000008
1317
1318 /** Store the UNIX owner, group, and mode.  This is done by adding a special
1319  * alternate data stream to each regular file, symbolic link, and directory to
1320  * contain this information.  Please note that this flag is for convenience
1321  * only; Microsoft's implementation will not understand this special
1322  * information.  This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS.  */
1323 #define WIMLIB_ADD_FLAG_UNIX_DATA               0x00000010
1324
1325 /** Do not capture security descriptors.  Only has an effect in NTFS capture
1326  * mode, or in Windows native builds. */
1327 #define WIMLIB_ADD_FLAG_NO_ACLS                 0x00000020
1328
1329 /** Fail immediately if the full security descriptor of any file or directory
1330  * cannot be accessed.  Only has an effect in Windows native builds.  The
1331  * default behavior without this flag is to first try omitting the SACL from the
1332  * security descriptor, then to try omitting the security descriptor entirely.
1333  * */
1334 #define WIMLIB_ADD_FLAG_STRICT_ACLS             0x00000040
1335
1336 /** Call the progress function with the message
1337  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1338  * capture.  This is a subset of the messages provided by
1339  * ::WIMLIB_ADD_FLAG_VERBOSE. */
1340 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE         0x00000080
1341
1342 /** Reparse-point fixups:  Modify absolute symbolic links (or junction points,
1343  * in the case of Windows) that point inside the directory being captured to
1344  * instead be absolute relative to the directory being captured, rather than the
1345  * current root; also exclude absolute symbolic links that point outside the
1346  * directory tree being captured.
1347  *
1348  * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
1349  * the WIM header or if this is the first image being added.
1350  * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
1351  * reparse point fixups enabled and currently cannot be unset. */
1352 #define WIMLIB_ADD_FLAG_RPFIX                   0x00000100
1353
1354 /** Don't do reparse point fixups.  The default behavior is described in the
1355  * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
1356 #define WIMLIB_ADD_FLAG_NORPFIX                 0x00000200
1357
1358 /** Do not automatically exclude unsupported files or directories from capture;
1359  * e.g. encrypted directories in NTFS-3g capture mode, or device files and FIFOs
1360  * on UNIX-like systems.  Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when
1361  * such a file is encountered.  */
1362 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE  0x00000400
1363
1364 /** Automatically select a capture configuration appropriate for capturing
1365  * filesystems containing Windows operating systems.  When this flag is
1366  * specified, the corresponding @p config parameter or member must be @c NULL.
1367  *
1368  * Currently, selecting this capture configuration will cause the following
1369  * files and directories to be excluded from capture:
1370  *
1371  * - "\$ntfs.log"
1372  * - "\hiberfil.sys"
1373  * - "\pagefile.sys"
1374  * - "\System Volume Information"
1375  * - "\RECYCLER"
1376  * - "\Windows\CSC"
1377  *
1378  * Note that the default behavior--- that is, when this flag is not specified
1379  * and @p config is @c NULL--- is to use no capture configuration, meaning that
1380  * no files are excluded from capture.
1381  */
1382 #define WIMLIB_ADD_FLAG_WINCONFIG               0x00000800
1383
1384 /** Capture image as WIMBoot compatible.  */
1385 #define WIMLIB_ADD_FLAG_WIMBOOT                 0x00001000
1386
1387 #define WIMLIB_ADD_IMAGE_FLAG_NTFS              WIMLIB_ADD_FLAG_NTFS
1388 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       WIMLIB_ADD_FLAG_DEREFERENCE
1389 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           WIMLIB_ADD_FLAG_VERBOSE
1390 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              WIMLIB_ADD_FLAG_BOOT
1391 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA         WIMLIB_ADD_FLAG_UNIX_DATA
1392 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS           WIMLIB_ADD_FLAG_NO_ACLS
1393 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS       WIMLIB_ADD_FLAG_STRICT_ACLS
1394 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE   WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1395 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX             WIMLIB_ADD_FLAG_RPFIX
1396 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX           WIMLIB_ADD_FLAG_NORPFIX
1397 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1398                                                 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1399 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG         WIMLIB_ADD_FLAG_WINCONFIG
1400 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT           WIMLIB_ADD_FLAG_WIMBOOT
1401
1402
1403 /** @} */
1404 /** @ingroup G_modifying_wims
1405  * @{ */
1406
1407 /** Do not issue an error if the path to delete does not exist. */
1408 #define WIMLIB_DELETE_FLAG_FORCE                        0x00000001
1409
1410 /** Delete the file or directory tree recursively; if not specified, an error is
1411  * issued if the path to delete is a directory. */
1412 #define WIMLIB_DELETE_FLAG_RECURSIVE                    0x00000002
1413
1414 /** @} */
1415 /** @ingroup G_modifying_wims
1416  * @{ */
1417
1418 /**
1419  * If a single image is being exported, mark it bootable in the destination WIM.
1420  * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1421  * the image in the source WIM (if any) that is marked as bootable is also
1422  * marked as bootable in the destination WIM.
1423  */
1424 #define WIMLIB_EXPORT_FLAG_BOOT                         0x00000001
1425
1426 /** Give the exported image(s) no names.  Avoids problems with image name
1427  * collisions.
1428  */
1429 #define WIMLIB_EXPORT_FLAG_NO_NAMES                     0x00000002
1430
1431 /** Give the exported image(s) no descriptions.  */
1432 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS              0x00000004
1433
1434 /** @} */
1435 /** @ingroup G_extracting_wims
1436  * @{ */
1437
1438 /** Extract the image directly to a NTFS volume rather than a generic directory.
1439  * This mode is only available if wimlib was compiled with libntfs-3g support;
1440  * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned.  In this mode, the
1441  * extraction target will be interpreted as the path to a NTFS volume image (as
1442  * a regular file or block device) rather than a directory.  It will be opened
1443  * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1444  * root directory.  Note: this flag cannot be used when wimlib_extract_image()
1445  * is called with ::WIMLIB_ALL_IMAGES as the @p image.  */
1446 #define WIMLIB_EXTRACT_FLAG_NTFS                        0x00000001
1447
1448 /** When identical files are extracted from the WIM, always hard link them
1449  * together.  This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_SYMLINK.
1450  */
1451 #define WIMLIB_EXTRACT_FLAG_HARDLINK                    0x00000002
1452
1453 /** When identical files are extracted from the WIM, always symlink them
1454  * together.  This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_HARDLINK.
1455  */
1456 #define WIMLIB_EXTRACT_FLAG_SYMLINK                     0x00000004
1457
1458 /** This flag no longer does anything but is reserved for future use.  */
1459 #define WIMLIB_EXTRACT_FLAG_VERBOSE                     0x00000008
1460
1461 /** Read the WIM file sequentially while extracting the image.  As of wimlib
1462  * v1.6.0 this is the default behavior, and this flag no longer does anything.
1463  */
1464 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL                  0x00000010
1465
1466 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.  Only
1467  * valid on UNIX-like platforms, and when ::WIMLIB_EXTRACT_FLAG_NTFS was not
1468  * specified.  */
1469 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA                   0x00000020
1470
1471 /** Do not extract security descriptors.  This flag cannot be combined with
1472  * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS.  */
1473 #define WIMLIB_EXTRACT_FLAG_NO_ACLS                     0x00000040
1474
1475 /** Fail immediately if the full security descriptor of any file or directory
1476  * cannot be set exactly as specified in the WIM file.  On Windows, the default
1477  * behavior without this flag when wimlib does not have permission to set the
1478  * correct security descriptor is to fall back to setting the security
1479  * descriptor with the SACL omitted, then with the DACL omitted, then with the
1480  * owner omitted, then not at all.  This flag cannot be combined with
1481  * ::WIMLIB_EXTRACT_FLAG_NO_ACLS.  */
1482 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS                 0x00000080
1483
1484 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX.  This forces
1485  * reparse-point fixups on, so absolute symbolic links or junction points will
1486  * be fixed to be absolute relative to the actual extraction root.  Reparse-
1487  * point fixups are done by default for wimlib_extract_image() and
1488  * wimlib_extract_image_from_pipe() if WIM_HDR_FLAG_RP_FIX is set in the WIM
1489  * header.  This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX.  */
1490 #define WIMLIB_EXTRACT_FLAG_RPFIX                       0x00000100
1491
1492 /** Force reparse-point fixups on extraction off, regardless of the state of the
1493  * WIM_HDR_FLAG_RP_FIX flag in the WIM header.  This flag cannot be combined
1494  * with ::WIMLIB_EXTRACT_FLAG_RPFIX.  */
1495 #define WIMLIB_EXTRACT_FLAG_NORPFIX                     0x00000200
1496
1497 /** Extract the paths, each of which must name a regular file, to standard
1498  * output.  Not valid for wimlib_extract_image() and
1499  * wimlib_extract_image_from_pipe().  */
1500 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT                   0x00000400
1501
1502 /** Instead of ignoring files and directories with names that cannot be
1503  * represented on the current platform (note: Windows has more restrictions on
1504  * filenames than POSIX-compliant systems), try to replace characters or append
1505  * junk to the names so that they can be extracted in some form.  */
1506 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES   0x00000800
1507
1508 /** On Windows, when there exist two or more files with the same case
1509  * insensitive name but different case sensitive names, try to extract them all
1510  * by appending junk to the end of them, rather than arbitrarily extracting only
1511  * one.  */
1512 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS          0x00001000
1513
1514 /** Do not ignore failure to set timestamps on extracted files.  */
1515 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS           0x00002000
1516
1517 /** Do not ignore failure to set short names on extracted files.  */
1518 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES          0x00004000
1519
1520 /** Do not ignore failure to extract symbolic links (and junction points, on
1521  * Windows) due to permissions problems.  By default, such failures are ignored
1522  * since the default configuration of Windows only allows the Administrator to
1523  * create symbolic links.  */
1524 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS             0x00008000
1525
1526 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1527  * behavior is currently less than satisfactory.  Do not use (yet).  */
1528 #define WIMLIB_EXTRACT_FLAG_RESUME                      0x00010000
1529
1530 /** Perform the extraction ordered by the tree of files to extract rather than
1531  * how the underlying streams are arranged in the WIM file.  For regular WIM
1532  * files this may decrease or increase performance, depending on various
1533  * factors.  For WIM files containing packed streams this will decrease
1534  * performance.  */
1535 #define WIMLIB_EXTRACT_FLAG_FILE_ORDER                  0x00020000
1536
1537 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only:  Treat the
1538  * paths to extract as wildcard patterns ("globs") which may contain the
1539  * wildcard characters @c ? and @c *.  The @c ? character matches any
1540  * non-path-separator character, whereas the @c * character matches zero or more
1541  * non-path-separator characters.  Consequently, each glob may match zero or
1542  * more actual paths in the WIM image.  By default, if a glob does not match any
1543  * files, a warning but not an error will be issued, even if the glob did not
1544  * actually contain wildcard characters.  Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
1545  * to get an error instead.  */
1546 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS                  0x00040000
1547
1548 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1549  * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1550  * one of the provided globs did not match a file.  */
1551 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB                 0x00080000
1552
1553 /** Do not extract Windows file attributes such as readonly, hidden, etc.  */
1554 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES               0x00100000
1555
1556 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only:  Do not
1557  * preserve the directory structure of the archive when extracting --- that is,
1558  * place each extracted file or directory tree directly in the target directory.
1559  */
1560 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE   0x00200000
1561
1562 /** @} */
1563 /** @ingroup G_mounting_wim_images
1564  * @{ */
1565
1566 /** Mount the WIM image read-write rather than the default of read-only. */
1567 #define WIMLIB_MOUNT_FLAG_READWRITE                     0x00000001
1568
1569 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1570 #define WIMLIB_MOUNT_FLAG_DEBUG                         0x00000002
1571
1572 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1573 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000004
1574
1575 /** Access alternate data streams in the mounted WIM image through extended file
1576  * attributes.  This is the default mode. */
1577 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000008
1578
1579 /** Access alternate data streams in the mounted WIM image by specifying the
1580  * file name, a colon, then the alternate file stream name. */
1581 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000010
1582
1583 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1584  * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1585 #define WIMLIB_MOUNT_FLAG_UNIX_DATA                     0x00000020
1586
1587 /** Allow other users to see the mounted filesystem.  (this passes the @c
1588  * allow_other option to FUSE mount) */
1589 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER                   0x00000040
1590
1591 /** @} */
1592 /** @ingroup G_creating_and_opening_wims
1593  * @{ */
1594
1595 /** Verify the WIM contents against the WIM's integrity table, if present.  This
1596  * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1597  * checksummed and checked against the SHA1 message digests specified in the
1598  * integrity table.  ::WIMLIB_ERR_INTEGRITY is returned if there are any
1599  * mismatches (or, ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE is returned if the
1600  * integrity table is invalid).  */
1601 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY                0x00000001
1602
1603 /** Issue an error if the WIM is part of a split WIM.  Software can provide
1604  * this flag for convenience if it explicitly does not want to support split
1605  * WIMs.  */
1606 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT                 0x00000002
1607
1608 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1609  * is not.  A WIM is considered writable only if it is writable at the
1610  * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1611  * header, and is not part of a spanned set.  It is not required to provide this
1612  * flag before attempting to make changes to the WIM, but with this flag you get
1613  * an error sooner rather than later. */
1614 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS                   0x00000004
1615
1616 /** @} */
1617 /** @ingroup G_mounting_wim_images
1618  * @{ */
1619
1620 /** See ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.  */
1621 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY             0x00000001
1622
1623 /** Unless this flag is given, changes to a read-write mounted WIM are
1624  * discarded.  Ignored for read-only mounts.  */
1625 #define WIMLIB_UNMOUNT_FLAG_COMMIT                      0x00000002
1626
1627 /** See ::WIMLIB_WRITE_FLAG_REBUILD.  */
1628 #define WIMLIB_UNMOUNT_FLAG_REBUILD                     0x00000004
1629
1630 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1631 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS                  0x00000008
1632
1633 /** Do a "lazy" unmount (detach filesystem immediately, even if busy).  */
1634 #define WIMLIB_UNMOUNT_FLAG_LAZY                        0x00000010
1635
1636 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
1637  * image, causes the modified image to be committed as a new, unnamed image
1638  * appended to the archive.  The original image will be unmodified.  */
1639 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE                   0x00000020
1640
1641 /** @} */
1642 /** @ingroup G_modifying_wims
1643  * @{ */
1644
1645 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1646  * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages.  */
1647 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS                0x00000001
1648
1649 /** @} */
1650 /** @ingroup G_writing_and_overwriting_wims
1651  * @{ */
1652
1653 /** Include an integrity table in the WIM.
1654  *
1655  * For WIMs created with wimlib_open_wim(), the default behavior is to include
1656  * an integrity table if and only if one was present before.  For WIMs created
1657  * with wimlib_create_new_wim(), the default behavior is to not include an
1658  * integrity table.  */
1659 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY               0x00000001
1660
1661 /** Do not include an integrity table in the new WIM file.  This is the default
1662  * behavior, unless the WIM already included an integrity table.  */
1663 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY            0x00000002
1664
1665 /** Write the WIM as "pipable".  After writing a WIM with this flag specified,
1666  * images from it can be applied directly from a pipe using
1667  * wimlib_extract_image_from_pipe().  See the documentation for the --pipable
1668  * flag of `wimlib-imagex capture' for more information.  Beware: WIMs written
1669  * with this flag will not be compatible with Microsoft's software.
1670  *
1671  * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1672  * WIM as pipable if and only if it was pipable before.  For WIMs created with
1673  * wimlib_create_new_wim(), the default behavior is to write the WIM as
1674  * non-pipable.  */
1675 #define WIMLIB_WRITE_FLAG_PIPABLE                       0x00000004
1676
1677 /** Do not write the WIM as "pipable".  This is the default behavior, unless the
1678  * WIM was pipable already.  */
1679 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE                   0x00000008
1680
1681 /** Recompress all resources, even if they could otherwise be copied from a
1682  * different WIM with the same compression type (in the case of
1683  * wimlib_export_image() being called previously).  This flag is also valid in
1684  * the @p wim_write_flags of wimlib_join(), in which case all resources included
1685  * in the joined WIM file will be recompressed.  */
1686 #define WIMLIB_WRITE_FLAG_RECOMPRESS                    0x00000010
1687
1688 /** Call fsync() just before the WIM file is closed.  */
1689 #define WIMLIB_WRITE_FLAG_FSYNC                         0x00000020
1690
1691 /** wimlib_overwrite() only:  Re-build the entire WIM file rather than appending
1692  * data to it if possible.  */
1693 #define WIMLIB_WRITE_FLAG_REBUILD                       0x00000040
1694
1695 /** wimlib_overwrite() only:  Specifying this flag overrides the default
1696  * behavior of wimlib_overwrite() after one or more calls to
1697  * wimlib_delete_image(), which is to rebuild the entire WIM.  With this flag,
1698  * only minimal changes to correctly remove the image from the WIM will be
1699  * taken.  In particular, all streams will be left alone, even if they are no
1700  * longer referenced.  This is probably not what you want, because almost no
1701  * space will be saved by deleting an image in this way.  */
1702 #define WIMLIB_WRITE_FLAG_SOFT_DELETE                   0x00000080
1703
1704 /** wimlib_overwrite() only:  Allow overwriting the WIM even if the readonly
1705  * flag is set in the WIM header.  This can be used in combination with
1706  * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1707  * set the readonly flag on the on-disk WIM file.  */
1708 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG          0x00000100
1709
1710 /** Do not include non-metadata resources already present in other WIMs.  This
1711  * flag can be used to write a "delta" WIM after resources from the WIM on which
1712  * the delta is to be based were referenced with
1713  * wimlib_reference_resource_files() or wimlib_reference_resources().  */
1714 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS            0x00000200
1715
1716 /** Asserts that for writes of all WIM images, all streams needed for the WIM
1717  * are already present (not in external resource WIMs) and their reference
1718  * counts are correct, so the code does not need to recalculate which streams
1719  * are referenced.  This is for optimization purposes only, since with this flag
1720  * specified, the metadata resources may not need to be decompressed and parsed.
1721  *
1722  * This flag can be passed to wimlib_write() and wimlib_write_to_fd(), but is
1723  * already implied for wimlib_overwrite().  */
1724 #define WIMLIB_WRITE_FLAG_STREAMS_OK                    0x00000400
1725
1726 #define WIMLIB_WRITE_FLAG_RESERVED                      0x00000800
1727
1728 /**
1729  * When writing streams in the resulting WIM file, pack multiple streams into a
1730  * single WIM resource instead of compressing them independently.  This tends to
1731  * produce a better compression ratio at the cost of less random access.
1732  * However, WIMs created with this flag are only compatible with wimlib v1.6.0
1733  * or later and WIMGAPI Windows 8 or later, seemingly for Windows Setup only and
1734  * <b>not including ImageX and Dism</b>.  WIMs created with this flag must use
1735  * version number 3584 in their header instead of 68864.
1736  *
1737  * If this flag is passed to wimlib_overwrite() and the WIM did not previously
1738  * contain packed streams, the WIM's version number will be changed to 3584 and
1739  * the new streams will be written packed.  Use ::WIMLIB_WRITE_FLAG_REBUILD to
1740  * force the WIM to be fully rebuilt.  */
1741 #define WIMLIB_WRITE_FLAG_PACK_STREAMS                  0x00001000
1742
1743 /** @} */
1744 /** @ingroup G_general
1745  * @{ */
1746
1747 /** Assume that strings are represented in UTF-8, even if this is not the
1748  * locale's character encoding.  This flag is ignored on Windows, where wimlib
1749  * always uses UTF-16LE.  */
1750 #define WIMLIB_INIT_FLAG_ASSUME_UTF8                    0x00000001
1751
1752 /** Windows-only: do not attempt to acquire additional privileges (currently
1753  * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1754  * SeTakeOwnershipPrivilege) when initializing the library.  This is intended
1755  * for the case where the calling program manages these privileges itself.
1756  * Note: no error is issued if privileges cannot be acquired, although related
1757  * errors may be reported later, depending on if the operations performed
1758  * actually require additional privileges or not.  */
1759 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES        0x00000002
1760
1761 /** Windows only:  If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1762  * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1763  * to read all possible data and metadata for a capture operation could not be
1764  * acquired.  Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
1765  */
1766 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES      0x00000004
1767
1768 /** Windows only:  If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1769  * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1770  * to restore all possible data and metadata for an apply operation could not be
1771  * acquired.  Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
1772  */
1773 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES        0x00000008
1774
1775 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
1776  * systems).  */
1777 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE         0x00000010
1778
1779 /** Default to interpreting WIM paths case insensitively (default on Windows).
1780  * This does not apply to mounted images.  */
1781 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE       0x00000020
1782
1783 /** @} */
1784 /** @ingroup G_nonstandalone_wims
1785  * @{ */
1786
1787 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
1788  * Ignored by wimlib_reference_resources().  */
1789 #define WIMLIB_REF_FLAG_GLOB_ENABLE             0x00000001
1790
1791 /** For wimlib_reference_resource_files(), issue an error
1792  * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files.  The
1793  * default behavior without this flag is to issue no error at that point, but
1794  * then attempt to open the glob as a literal path, which of course will fail
1795  * anyway if no file exists at that path.  No effect if
1796  * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified.  Ignored by
1797  * wimlib_reference_resources().  */
1798 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH     0x00000002
1799
1800 /** @} */
1801 /** @ingroup G_modifying_wims
1802  * @{ */
1803
1804 /** The specific type of update to perform. */
1805 enum wimlib_update_op {
1806         /** Add a new file or directory tree to the WIM image in a
1807          * certain location. */
1808         WIMLIB_UPDATE_OP_ADD = 0,
1809
1810         /** Delete a file or directory tree from the WIM image. */
1811         WIMLIB_UPDATE_OP_DELETE,
1812
1813         /** Rename a file or directory tree in the WIM image. */
1814         WIMLIB_UPDATE_OP_RENAME,
1815 };
1816
1817 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1818 struct wimlib_add_command {
1819         /** Filesystem path to the file or directory tree to
1820          * add. */
1821         wimlib_tchar *fs_source_path;
1822         /** Path, specified from the root of the WIM image, at
1823          * which to add the file or directory tree within the
1824          * WIM image. */
1825         wimlib_tchar *wim_target_path;
1826
1827         /** Configuration for excluded files.  @c NULL means
1828          * exclude no files (use no configuration), unless
1829          * ::WIMLIB_ADD_FLAG_WINCONFIG is specified in @p
1830          * add_flags.  */
1831         struct wimlib_capture_config *config;
1832
1833         /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1834         int add_flags;
1835 };
1836
1837 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1838 struct wimlib_delete_command {
1839         /** Path, specified from the root of the WIM image, for
1840          * the file or directory tree within the WIM image to be
1841          * deleted. */
1842         wimlib_tchar *wim_path;
1843         /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1844         int delete_flags;
1845 };
1846
1847 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1848 struct wimlib_rename_command {
1849         /** Path, specified from the root of the WIM image, for
1850          * the source file or directory tree within the WIM
1851          * image. */
1852         wimlib_tchar *wim_source_path;
1853         /** Path, specified from the root of the WIM image, for
1854          * the destination file or directory tree within the WIM
1855          * image. */
1856         wimlib_tchar *wim_target_path;
1857         /** Reserved; set to 0. */
1858         int rename_flags;
1859 };
1860
1861 /** Specification of an update to perform on a WIM image. */
1862 struct wimlib_update_command {
1863
1864         enum wimlib_update_op op;
1865
1866         union {
1867                 struct wimlib_add_command add;
1868                 struct wimlib_delete_command delete_; /* Underscore is for C++
1869                                                          compatibility.  */
1870                 struct wimlib_rename_command rename;
1871         };
1872 };
1873
1874 /** @} */
1875 /** @ingroup G_extracting_wims
1876  * @{ */
1877
1878 /** DEPRECATED:  Specification of extracting a file or directory tree from a WIM
1879  * image.  This is only used for calls to wimlib_extract_files(), which has been
1880  * deprecated in favor of the easier-to-use wimlib_extract_paths().  */
1881 struct wimlib_extract_command {
1882         /** Path to file or directory tree within the WIM image to extract.  It
1883          * must be provided as an absolute path from the root of the WIM image.
1884          * The path separators may be either forward slashes or backslashes. */
1885         wimlib_tchar *wim_source_path;
1886
1887         /** Filesystem path to extract the file or directory tree to. */
1888         wimlib_tchar *fs_dest_path;
1889
1890         /** Bitwise OR of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
1891         int extract_flags;
1892 };
1893
1894
1895 /** @} */
1896 /** @ingroup G_general
1897  * @{ */
1898
1899 /**
1900  * Possible values of the error code returned by many functions in wimlib.
1901  *
1902  * See the documentation for each wimlib function to see specifically what error
1903  * codes can be returned by a given function, and what they mean.
1904  */
1905 enum wimlib_error_code {
1906         WIMLIB_ERR_SUCCESS = 0,
1907         WIMLIB_ERR_ALREADY_LOCKED,
1908         WIMLIB_ERR_DECOMPRESSION,
1909         WIMLIB_ERR_DELETE_STAGING_DIR,
1910         WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1911         WIMLIB_ERR_FORK,
1912         WIMLIB_ERR_FUSE,
1913         WIMLIB_ERR_FUSERMOUNT,
1914         WIMLIB_ERR_GLOB_HAD_NO_MATCHES,
1915         WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1916         WIMLIB_ERR_IMAGE_COUNT,
1917         WIMLIB_ERR_IMAGE_NAME_COLLISION,
1918         WIMLIB_ERR_INSUFFICIENT_PRIVILEGES,
1919         WIMLIB_ERR_INTEGRITY,
1920         WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1921         WIMLIB_ERR_INVALID_CHUNK_SIZE,
1922         WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1923         WIMLIB_ERR_INVALID_HEADER,
1924         WIMLIB_ERR_INVALID_IMAGE,
1925         WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1926         WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1927         WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1928         WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1929         WIMLIB_ERR_INVALID_OVERLAY,
1930         WIMLIB_ERR_INVALID_PARAM,
1931         WIMLIB_ERR_INVALID_PART_NUMBER,
1932         WIMLIB_ERR_INVALID_PIPABLE_WIM,
1933         WIMLIB_ERR_INVALID_REPARSE_DATA,
1934         WIMLIB_ERR_INVALID_RESOURCE_HASH,
1935         WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1936         WIMLIB_ERR_INVALID_UTF16_STRING,
1937         WIMLIB_ERR_INVALID_UTF8_STRING,
1938         WIMLIB_ERR_IS_DIRECTORY,
1939         WIMLIB_ERR_IS_SPLIT_WIM,
1940         WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1941         WIMLIB_ERR_LINK,
1942         WIMLIB_ERR_METADATA_NOT_FOUND,
1943         WIMLIB_ERR_MKDIR,
1944         WIMLIB_ERR_MQUEUE,
1945         WIMLIB_ERR_NOMEM,
1946         WIMLIB_ERR_NOTDIR,
1947         WIMLIB_ERR_NOTEMPTY,
1948         WIMLIB_ERR_NOT_A_REGULAR_FILE,
1949         WIMLIB_ERR_NOT_A_WIM_FILE,
1950         WIMLIB_ERR_NOT_PIPABLE,
1951         WIMLIB_ERR_NO_FILENAME,
1952         WIMLIB_ERR_NTFS_3G,
1953         WIMLIB_ERR_OPEN,
1954         WIMLIB_ERR_OPENDIR,
1955         WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1956         WIMLIB_ERR_READ,
1957         WIMLIB_ERR_READLINK,
1958         WIMLIB_ERR_RENAME,
1959         WIMLIB_ERR_REOPEN,
1960         WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1961         WIMLIB_ERR_RESOURCE_NOT_FOUND,
1962         WIMLIB_ERR_RESOURCE_ORDER,
1963         WIMLIB_ERR_SET_ATTRIBUTES,
1964         WIMLIB_ERR_SET_REPARSE_DATA,
1965         WIMLIB_ERR_SET_SECURITY,
1966         WIMLIB_ERR_SET_SHORT_NAME,
1967         WIMLIB_ERR_SET_TIMESTAMPS,
1968         WIMLIB_ERR_SPLIT_INVALID,
1969         WIMLIB_ERR_STAT,
1970         WIMLIB_ERR_TIMEOUT,
1971         WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1972         WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1973         WIMLIB_ERR_UNKNOWN_VERSION,
1974         WIMLIB_ERR_UNSUPPORTED,
1975         WIMLIB_ERR_UNSUPPORTED_FILE,
1976         WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1977         WIMLIB_ERR_WIM_IS_READONLY,
1978         WIMLIB_ERR_WRITE,
1979         WIMLIB_ERR_XML,
1980         WIMLIB_ERR_WIM_IS_ENCRYPTED,
1981 };
1982
1983
1984 /** Used to indicate no WIM image or an invalid WIM image. */
1985 #define WIMLIB_NO_IMAGE         0
1986
1987 /** Used to specify all images in the WIM. */
1988 #define WIMLIB_ALL_IMAGES       (-1)
1989
1990 /** @}  */
1991
1992 /**
1993  * @ingroup G_modifying_wims
1994  *
1995  * Appends an empty image to a WIM file.  This empty image will initially
1996  * contain no files or directories, although if written without further
1997  * modifications, a root directory will be created automatically for it.  After
1998  * calling this function, you can use wimlib_update_image() to add files to the
1999  * new WIM image.  This gives you slightly more control over making the new
2000  * image compared to calling wimlib_add_image() or
2001  * wimlib_add_image_multisource() directly.
2002  *
2003  * @param wim
2004  *      Pointer to the ::WIMStruct for the WIM file to which the image is to be
2005  *      added.
2006  * @param name
2007  *      Name to give the new image.  If @c NULL or empty, the new image is given
2008  *      no name.  If nonempty, it must specify a name that does not already
2009  *      exist in @p wim.
2010  * @param new_idx_ret
2011  *      If non-<code>NULL</code>, the index of the newly added image is returned
2012  *      in this location.
2013  *
2014  * @return 0 on success; nonzero on failure.  The possible error codes are:
2015  *
2016  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2017  *      There is already an image in @p wim named @p name.
2018  * @retval ::WIMLIB_ERR_NOMEM
2019  *      Failed to allocate the memory needed to add the new image.
2020  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2021  *      The WIM file is considered read-only because of any of the reasons
2022  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2023  *      flag.
2024  */
2025 extern int
2026 wimlib_add_empty_image(WIMStruct *wim,
2027                        const wimlib_tchar *name,
2028                        int *new_idx_ret);
2029
2030 /**
2031  * @ingroup G_modifying_wims
2032  *
2033  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
2034  *
2035  * The directory tree or NTFS volume is scanned immediately to load the dentry
2036  * tree into memory, and file attributes and symbolic links are read.  However,
2037  * actual file data is not read until wimlib_write() or wimlib_overwrite() is
2038  * called.
2039  *
2040  * See the manual page for the @b wimlib-imagex program for more information
2041  * about the "normal" capture mode versus the NTFS capture mode (entered by
2042  * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2043  *
2044  * Note that @b no changes are committed to the underlying WIM file (if
2045  * any) until wimlib_write() or wimlib_overwrite() is called.
2046  *
2047  * @param wim
2048  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
2049  *      added.
2050  * @param source
2051  *      A path to a directory or unmounted NTFS volume that will be captured as
2052  *      a WIM image.
2053  * @param name
2054  *      Name to give the new image.  If @c NULL or empty, the new image is given
2055  *      no name.  If nonempty, it must specify a name that does not already
2056  *      exist in @p wim.
2057  * @param config
2058  *      Capture configuration that specifies files, directories, or path globs
2059  *      to exclude from being captured.  If @c NULL, a dummy configuration where
2060  *      no paths are treated specially is used.
2061  * @param add_flags
2062  *      Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2063  * @param progress_func
2064  *      If non-NULL, a function that will be called periodically with the
2065  *      progress of the current operation.  The progress messages that will be
2066  *      received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
2067  *      ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
2068  *      included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2069  *
2070  * @return 0 on success; nonzero on error.  On error, changes to @p wim are
2071  * discarded so that it appears to be in the same state as when this function
2072  * was called.
2073  *
2074  * This function is implemented by calling wimlib_add_empty_image(), then
2075  * calling wimlib_update_image() with a single "add" command, so any error code
2076  * returned by wimlib_add_empty_image() may be returned, as well as any error
2077  * codes returned by wimlib_update_image() other than ones documented as only
2078  * being returned specifically by an update involving delete or rename commands.
2079  */
2080 extern int
2081 wimlib_add_image(WIMStruct *wim,
2082                  const wimlib_tchar *source,
2083                  const wimlib_tchar *name,
2084                  const struct wimlib_capture_config *config,
2085                  int add_flags,
2086                  wimlib_progress_func_t progress_func);
2087
2088 /**
2089  * @ingroup G_modifying_wims
2090  *
2091  * This function is equivalent to wimlib_add_image() except it allows for
2092  * multiple sources to be combined into a single WIM image.  This is done by
2093  * specifying the @p sources and @p num_sources parameters instead of the @p
2094  * source parameter of wimlib_add_image().  The rest of the parameters are the
2095  * same as wimlib_add_image().  See the documentation for <b>wimlib-imagex
2096  * capture</b> for full details on how this mode works.
2097  *
2098  * In addition to the error codes that wimlib_add_image() can return,
2099  * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2100  * when trying to overlay a non-directory on a directory or when otherwise
2101  * trying to overlay multiple conflicting files to the same location in the WIM
2102  * image.  It will also return ::WIMLIB_ERR_INVALID_PARAM if
2103  * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2104  * was not exactly one capture source with the target being the root directory.
2105  * (In this respect, there is no advantage to using
2106  * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2107  * NTFS mode.) */
2108 extern int
2109 wimlib_add_image_multisource(WIMStruct *wim,
2110                              const struct wimlib_capture_source *sources,
2111                              size_t num_sources,
2112                              const wimlib_tchar *name,
2113                              const struct wimlib_capture_config *config,
2114                              int add_flags,
2115                              wimlib_progress_func_t progress_func);
2116
2117 /**
2118  * @ingroup G_creating_and_opening_wims
2119  *
2120  * Creates a ::WIMStruct for a new WIM file.
2121  *
2122  * This only creates an in-memory structure for a WIM that initially contains no
2123  * images.  No on-disk file is created until wimlib_write() is called.
2124  *
2125  * @param ctype
2126  *      The type of compression to be used in the new WIM file, as one of the
2127  *      ::wimlib_compression_type constants.
2128  * @param wim_ret
2129  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2130  *      written to the memory location pointed to by this paramater.  The
2131  *      ::WIMStruct must be freed using using wimlib_free() when finished with
2132  *      it.
2133  * @return 0 on success; nonzero on error.
2134  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2135  *      @p ctype was not a supported compression type.
2136  * @retval ::WIMLIB_ERR_NOMEM
2137  *      Failed to allocate needed memory.
2138  */
2139 extern int
2140 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2141
2142 /**
2143  * @ingroup G_modifying_wims
2144  *
2145  * Deletes an image, or all images, from a WIM file.
2146  *
2147  * All streams referenced by the image(s) being deleted are removed from the
2148  * lookup table of the WIM if they are not referenced by any other images in the
2149  * WIM.
2150  *
2151  * Please note that @b no changes are committed to the underlying WIM file (if
2152  * any) until wimlib_write() or wimlib_overwrite() is called.
2153  *
2154  * @param wim
2155  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2156  *      being deleted.
2157  * @param image
2158  *      The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2159  *      images.
2160  * @return 0 on success; nonzero on failure.  On failure, @p wim is guaranteed
2161  * to be left unmodified only if @p image specified a single image.  If instead
2162  * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2163  * possible for some but not all of the images to have been deleted when a
2164  * failure status is returned.
2165  *
2166  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2167  *      @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2168  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2169  *      The WIM file is considered read-only because of any of the reasons
2170  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2171  *      flag.
2172  *
2173  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2174  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2175  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2176  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2177  * different reasons) to read the metadata resource for an image that needed to
2178  * be deleted.
2179  */
2180 extern int
2181 wimlib_delete_image(WIMStruct *wim, int image);
2182
2183 /**
2184  * @ingroup G_modifying_wims
2185  *
2186  * Exports an image, or all the images, from a WIM file, into another WIM file.
2187  *
2188  * The destination image is made to share the same dentry tree and security data
2189  * structure as the source image.  This places some restrictions on additional
2190  * functions that may be called.  wimlib_mount_image() may not be called on
2191  * either the source image or the destination image without an intervening call
2192  * to a function that un-shares the images, such as wimlib_free() on @p
2193  * dest_wim, or wimlib_delete_image() on either the source or destination image.
2194  * Furthermore, you may not call wimlib_free() on @p src_wim before calling
2195  * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
2196  * have references back to @p src_wim.
2197  *
2198  * If this function fails, all changes to @p dest_wim are rolled back.
2199  *
2200  * Please note that no changes are committed to the underlying WIM file of @p
2201  * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2202  *
2203  * @param src_wim
2204  *      The WIM from which to export the images, specified as a pointer to the
2205  *      ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2206  *      split WIM.  In the case of a WIM file that is not standalone, this
2207  *      ::WIMStruct must have had any needed external resources previously
2208  *      referenced using wimlib_reference_resources() or
2209  *      wimlib_reference_resource_files().
2210  * @param src_image
2211  *      The image to export from @p src_wim, as either a 1-based image index to
2212  *      export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2213  * @param dest_wim
2214  *      Pointer to the ::WIMStruct for a WIM that will receive the images being
2215  *      exported.
2216  * @param dest_name
2217  *      For single-image exports, the name to give the exported image in @p
2218  *      dest_wim.  If left @c NULL, the name from @p src_wim is used.  For
2219  *      ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2220  *      that case, the names are all taken from @p src_wim.  This parameter is
2221  *      overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2222  * @param dest_description
2223  *      For single-image exports, the description to give the exported image in
2224  *      the new WIM file.  If left @c NULL, the description from @p src_wim is
2225  *      used.  For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2226  *      NULL; in that case, the description are all taken from @p src_wim.  This
2227  *      parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2228  * @param export_flags
2229  *      Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2230  * @param progress_func
2231  *      Currently ignored, but reserved for a function that will be called with
2232  *      information about the operation.  Use NULL if no additional information
2233  *      is desired.
2234  *
2235  * @return 0 on success; nonzero on error.
2236  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2237  *      One or more of the names being given to an exported image was already in
2238  *      use in the destination WIM.
2239  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2240  *      @p src_image does not exist in @p src_wim and was not
2241  *      ::WIMLIB_ALL_IMAGES.
2242  * @retval ::WIMLIB_ERR_INVALID_PARAM
2243  *      @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2244  *      ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2245  *      @c NULL.
2246  * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2247  *      Either @p src_wim or @p dest_wim did not contain metadata resources; for
2248  *      example, one of them was a non-first part of a split WIM.
2249  * @retval ::WIMLIB_ERR_NOMEM
2250  *      Failed to allocate needed memory.
2251  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2252  *      A resource that needed to be exported could not be found in either the
2253  *      source or destination WIMs.  This error can occur if, for example, @p
2254  *      src_wim is part of a split WIM but needed resources from the other split
2255  *      WIM parts were not referenced with wimlib_reference_resources() or
2256  *      wimlib_reference_resource_files() before the call to
2257  *      wimlib_export_image().
2258  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2259  *      @p dest_wim is considered read-only because of any of the reasons
2260  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2261  *      flag.
2262  *
2263  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2264  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2265  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2266  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2267  * different reasons) to read the metadata resource for an image in @p src_wim
2268  * that needed to be exported.
2269  */
2270 extern int
2271 wimlib_export_image(WIMStruct *src_wim, int src_image,
2272                     WIMStruct *dest_wim,
2273                     const wimlib_tchar *dest_name,
2274                     const wimlib_tchar *dest_description,
2275                     int export_flags,
2276                     wimlib_progress_func_t progress_func);
2277
2278 /**
2279  * @ingroup G_extracting_wims
2280  *
2281  * Extract zero or more files or directory trees from a WIM image.
2282  *
2283  * As of wimlib v1.6.1, this function is deprecated in favor of
2284  * wimlib_extract_paths() because wimlib_extract_paths() is easier to use and
2285  * more efficient.
2286  *
2287  * Notes: wimlib_extract_files() does not support the
2288  * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS flag, and
2289  * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE is always implied.  The same
2290  * hardlink/symlink extraction mode must be set on all extraction commands.  An
2291  * independent extraction operation (like a separate call to
2292  * wimlib_extract_paths()) is done for each extraction command.  Otherwise, the
2293  * documentation for wimlib_extract_paths() applies.
2294  */
2295 extern int
2296 wimlib_extract_files(WIMStruct *wim,
2297                      int image,
2298                      const struct wimlib_extract_command *cmds,
2299                      size_t num_cmds,
2300                      int default_extract_flags,
2301                      wimlib_progress_func_t progress_func) _wimlib_deprecated;
2302
2303 /**
2304  * @ingroup G_extracting_wims
2305  *
2306  * Extracts an image, or all images, from a WIM to a directory or NTFS volume
2307  * image.
2308  *
2309  * The exact behavior of how wimlib extracts files from a WIM image is
2310  * controllable by the @p extract_flags parameter, but there also are
2311  * differences depending on the platform (UNIX-like vs Windows).  See the manual
2312  * page for <b>wimlib-imagex apply</b> for more information, including about the
2313  * special "NTFS volume extraction mode" entered by providing
2314  * ::WIMLIB_EXTRACT_FLAG_NTFS.
2315  *
2316  * @param wim
2317  *      The WIM from which to extract the image(s), specified as a pointer to
2318  *      the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2319  *      of a split WIM.  In the case of a WIM file that is not standalone, this
2320  *      ::WIMStruct must have had any needed external resources previously
2321  *      referenced using wimlib_reference_resources() or
2322  *      wimlib_reference_resource_files().
2323  * @param image
2324  *      The image to extract, specified as either the 1-based index of a single
2325  *      image to extract, or ::WIMLIB_ALL_IMAGES to specify that all images are
2326  *      to be extracted.  ::WIMLIB_ALL_IMAGES cannot be used if
2327  *      ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2328  * @param target
2329  *      Directory to extract the WIM image(s) to; or, with
2330  *      ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to
2331  *      the unmounted NTFS volume to which to extract the image.
2332  * @param extract_flags
2333  *      Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2334  * @param progress_func
2335  *      If non-NULL, a function that will be called periodically with the
2336  *      progress of the current operation.  The main message to look for is
2337  *      ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS; however, there are others as
2338  *      well.
2339  *
2340  * @return 0 on success; nonzero on error.
2341  * @retval ::WIMLIB_ERR_DECOMPRESSION
2342  *      Failed to decompress data contained in the WIM.
2343  * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2344  *      The metadata for one of the images to extract was invalid.
2345  * @retval ::WIMLIB_ERR_INVALID_PARAM
2346  *      The extraction flags were invalid; more details may be found in the
2347  *      documentation for the specific extraction flags that were specified.  Or
2348  *      @p target was @c NULL or the empty string, or @p wim was @c NULL.
2349  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2350  *      The SHA1 message digest of an extracted stream did not match the SHA1
2351  *      message digest given in the WIM.
2352  * @retval ::WIMLIB_ERR_LINK
2353  *      Failed to create a symbolic link or a hard link.
2354  * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2355  *      The metadata resource for one of the images to extract was not found.
2356  *      This can happen if @p wim represents a non-first part of a split WIM.
2357  * @retval ::WIMLIB_ERR_MKDIR
2358  *      Failed create a directory.
2359  * @retval ::WIMLIB_ERR_NOMEM
2360  *      Failed to allocate needed memory.
2361  * @retval ::WIMLIB_ERR_OPEN
2362  *      Could not create a file, or failed to open an already-extracted file.
2363  * @retval ::WIMLIB_ERR_READ
2364  *      Failed to read data from the WIM.
2365  * @retval ::WIMLIB_ERR_READLINK
2366  *      Failed to determine the target of a symbolic link in the WIM.
2367  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2368  *      Failed to fix the target of an absolute symbolic link (e.g. if the
2369  *      target would have exceeded the maximum allowed length).  (Only if
2370  *      reparse data was supported by the extraction mode and
2371  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2372  *      extract_flags.)
2373  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2374  *      One of the files or directories that needed to be extracted referenced a
2375  *      stream not present in the WIM's lookup table (or in any of the lookup
2376  *      tables of the split WIM parts).
2377  * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2378  *      Failed to set attributes on a file.
2379  * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2380  *      Failed to set reparse data on a file (only if reparse data was supported
2381  *      by the extraction mode).
2382  * @retval ::WIMLIB_ERR_SET_SECURITY
2383  *      Failed to set security descriptor on a file
2384  *      (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
2385  *      extract_flags).
2386  * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2387  *      Failed to set the short name of a file (only if
2388  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
2389  * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2390  *      Failed to set timestamps on a file (only if
2391  *      ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
2392  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2393  *      Unexpected end-of-file occurred when reading data from the WIM.
2394  * @retval ::WIMLIB_ERR_UNSUPPORTED
2395  *      A requested extraction flag, or the data or metadata that must be
2396  *      extracted to support it, is unsupported in the build and configuration
2397  *      of wimlib, or on the current platform or extraction mode or target
2398  *      volume.  Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2399  *      ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2400  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2401  *      ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS,
2402  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS, ::WIMLIB_EXTRACT_FLAG_SYMLINK,
2403  *      and ::WIMLIB_EXTRACT_FLAG_HARDLINK.  For example, if
2404  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2405  *      extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2406  *      image contains one or more files with short names, but extracting short
2407  *      names is not supported --- on Windows, this occurs if the target volume
2408  *      does not support short names, while on non-Windows, this occurs if
2409  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2410  * @retval ::WIMLIB_ERR_WRITE
2411  *      Failed to write data to a file being extracted.
2412  */
2413 extern int
2414 wimlib_extract_image(WIMStruct *wim, int image,
2415                      const wimlib_tchar *target,
2416                      int extract_flags,
2417                      wimlib_progress_func_t progress_func);
2418
2419 /**
2420  * @ingroup G_extracting_wims
2421  *
2422  * Since wimlib v1.5.0:  Extract one image from a pipe on which a pipable WIM is
2423  * being sent.
2424  *
2425  * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2426  * about pipable WIMs.
2427  *
2428  * This function operates in a special way to read the WIM fully sequentially.
2429  * As a result, there is no ::WIMStruct is made visible to library users, and
2430  * you cannot call wimlib_open_wim() on the pipe.  (You can, however, use
2431  * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2432  * seekable file, not a pipe.)
2433  *
2434  * @param pipe_fd
2435  *      File descriptor, which may be a pipe, opened for reading and positioned
2436  *      at the start of the pipable WIM.
2437  * @param image_num_or_name
2438  *      String that specifies the 1-based index or name of the image to extract.
2439  *      It is translated to an image index using the same rules that
2440  *      wimlib_resolve_image() uses.  However, unlike wimlib_extract_image(),
2441  *      only a single image (not all images) can be specified.  Alternatively,
2442  *      specify @p NULL here to use the first image in the WIM if it contains
2443  *      exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2444  * @param target
2445  *      Same as the corresponding parameter to wimlib_extract_image().
2446  * @param extract_flags
2447  *      Same as the corresponding parameter to wimlib_extract_image(), except
2448  *      that ::WIMLIB_EXTRACT_FLAG_FILE_ORDER cannot be specified and will
2449  *      result in ::WIMLIB_ERR_INVALID_PARAM being returned.
2450  * @param progress_func
2451  *      Same as the corresponding parameter to wimlib_extract_image(), except
2452  *      ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
2453  *      received by the progress function.
2454  *
2455  * @return 0 on success; nonzero on error.  The possible error codes include
2456  * those returned by wimlib_extract_image() and wimlib_open_wim() as well as the
2457  * following:
2458  *
2459  * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2460  *      Data read from the pipable WIM was invalid.
2461  * @retval ::WIMLIB_ERR_NOT_PIPABLE
2462  *      The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2463  */
2464 extern int
2465 wimlib_extract_image_from_pipe(int pipe_fd,
2466                                const wimlib_tchar *image_num_or_name,
2467                                const wimlib_tchar *target, int extract_flags,
2468                                wimlib_progress_func_t progress_func);
2469
2470 /**
2471  * @ingroup G_extracting_wims
2472  *
2473  * Since wimlib v1.6.0:  Similar to wimlib_extract_paths(), but the paths to
2474  * extract from the WIM image are specified in the UTF-8 text file named by @p
2475  * path_list_file which itself contains the list of paths to use, one per line.
2476  * Leading and trailing whitespace, and otherwise empty lines and lines
2477  * beginning with the ';' character are ignored.  No quotes are needed as paths
2478  * are otherwise delimited by the newline character.
2479  *
2480  * The error codes are the same as those returned by wimlib_extract_paths(),
2481  * except that wimlib_extract_pathlist() returns an appropriate error code if it
2482  * cannot read the path list file (::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2483  * ::WIMLIB_ERR_READ, ::WIMLIB_ERR_NOMEM, or ::WIMLIB_ERR_INVALID_UTF8_STRING).
2484  */
2485 extern int
2486 wimlib_extract_pathlist(WIMStruct *wim, int image,
2487                         const wimlib_tchar *target,
2488                         const wimlib_tchar *path_list_file,
2489                         int extract_flags,
2490                         wimlib_progress_func_t progress_func);
2491
2492 /**
2493  * @ingroup G_extracting_wims
2494  *
2495  * Since wimlib v1.6.0:  Extract zero or more paths (files or directory trees)
2496  * from the specified WIM image.
2497  *
2498  * By default, each path will be extracted to a corresponding subdirectory of
2499  * the target based on its location in the WIM image.  For example, if one of
2500  * the paths to extract is "/Windows/explorer.exe" and the target is "outdir",
2501  * the file will be extracted to "outdir/Windows/explorer.exe".  This behavior
2502  * can be changed by providing the flag
2503  * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which will cause each file
2504  * or directory tree to be placed directly in the target directory --- so the
2505  * same example would extract "/Windows/explorer.exe" to "outdir/explorer.exe".
2506  *
2507  * Symbolic links will not be dereferenced when paths in the WIM image are
2508  * interpreted.
2509  *
2510  * @param wim
2511  *      WIM from which to extract the paths, specified as a pointer to the
2512  *      ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2513  *      split WIM.  In the case of a WIM file that is not standalone, this
2514  *      ::WIMStruct must have had any needed external resources previously
2515  *      referenced using wimlib_reference_resources() or
2516  *      wimlib_reference_resource_files().
2517  * @param image
2518  *      1-based index of the WIM image from which to extract the paths.
2519  * @param paths
2520  *      Array of paths to extract.  Each element must be the absolute path to a
2521  *      file or directory within the WIM image.  Separators may be either
2522  *      forwards or backwards slashes, and leading path separators are optional.
2523  *      The paths will be interpreted either case-sensitively (UNIX default) or
2524  *      case-insensitively (Windows default); this can be changed by
2525  *      wimlib_global_init().
2526  *      <br/>
2527  *      By default, the characters @c * and @c ? are interpreted literally.
2528  *      This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
2529  *      extract_flags.
2530  *      <br/>
2531  *      By default, if any paths to extract do not exist, the error code
2532  *      ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned.  This behavior changes if
2533  *      ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
2534  * @param num_paths
2535  *      Number of paths specified in @p paths.
2536  * @param target
2537  *      Directory to which to extract the paths; or with
2538  *      ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
2539  *      unmounted NTFS volume to which to extract the paths.  Unlike the @p
2540  *      paths being extracted, the @p target must be native path.  On UNIX-like
2541  *      systems it may not contain backslashes, for example.
2542  * @param extract_flags
2543  *      Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2544  * @param progress_func
2545  *      If non-NULL, a function that will be called periodically with the
2546  *      progress of the current operation.  The main message to look for is
2547  *      ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS; however, there are others as
2548  *      well.  Note: because the extraction code is stream-based and not
2549  *      file-based, there is no way to get information about which path is
2550  *      currently being extracted, but based on byte count you can still
2551  *      calculate an approximate percentage complete for the extraction overall
2552  *      which may be all you really need anyway.
2553  *
2554  * @return 0 on success; nonzero on error.  Most of the error codes are the same
2555  * as those returned by wimlib_extract_image().  Below, some of the error codes
2556  * returned in situations specific to path-mode extraction are documented:
2557  *
2558  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2559  *      @p image was ::WIMLIB_ALL_IMAGES or was otherwise not a valid single
2560  *      image in the WIM.
2561  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2562  *      One of the paths to extract did not exist in the WIM image.  This error
2563  *      code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
2564  *      specified in @p extract_flags, or if both
2565  *      ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
2566  *      were specified in @p extract_flags.
2567  * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2568  *      ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
2569  *      one of the paths to extract did not name a regular file.
2570  */
2571 extern int
2572 wimlib_extract_paths(WIMStruct *wim,
2573                      int image,
2574                      const wimlib_tchar *target,
2575                      const wimlib_tchar * const *paths,
2576                      size_t num_paths,
2577                      int extract_flags,
2578                      wimlib_progress_func_t progress_func);
2579
2580 /**
2581  * @ingroup G_wim_information
2582  *
2583  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
2584  * includes a string of XML that describes the images contained in the WIM.
2585  *
2586  * See wimlib_get_xml_data() to read the XML data into memory instead.
2587  *
2588  * @param wim
2589  *      Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2590  *      have to be standalone (e.g. it could be part of a split WIM).
2591  * @param fp
2592  *      @c stdout, or a FILE* opened for writing, to extract the data to.
2593  *
2594  * @return 0 on success; nonzero on error.
2595  * @retval ::WIMLIB_ERR_INVALID_PARAM
2596  *      @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2597  * @retval ::WIMLIB_ERR_NOMEM
2598  * @retval ::WIMLIB_ERR_READ
2599  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2600  *      Failed to read the XML data from the WIM.
2601  * @retval ::WIMLIB_ERR_WRITE
2602  *      Failed to completely write the XML data to @p fp.
2603  */
2604 extern int
2605 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2606
2607 /**
2608  * @ingroup G_general
2609  *
2610  * Frees all memory allocated for a WIMStruct and closes all files associated
2611  * with it.
2612  *
2613  * @param wim
2614  *      Pointer to the ::WIMStruct for a WIM file.
2615  *
2616  * @return This function has no return value.
2617  */
2618 extern void
2619 wimlib_free(WIMStruct *wim);
2620
2621 /**
2622  * @ingroup G_general
2623  *
2624  * Converts a ::wimlib_compression_type value into a string.
2625  *
2626  * @param ctype
2627  *      The ::wimlib_compression_type value to convert.
2628  *
2629  * @return
2630  *      A statically allocated string naming the compression algorithm,
2631  *      such as "None", "LZX", "XPRESS", or "Invalid".
2632  */
2633 extern const wimlib_tchar *
2634 wimlib_get_compression_type_string(int ctype);
2635
2636 /**
2637  * @ingroup G_general
2638  *
2639  * Converts an error code into a string describing it.
2640  *
2641  * @param code
2642  *      The error code returned by one of wimlib's functions.
2643  *
2644  * @return
2645  *      Pointer to a statically allocated string describing the error code,
2646  *      or @c NULL if the error code is not valid.
2647  */
2648 extern const wimlib_tchar *
2649 wimlib_get_error_string(enum wimlib_error_code code);
2650
2651 /**
2652  * @ingroup G_wim_information
2653  *
2654  * Returns the description of the specified image.
2655  *
2656  * @param wim
2657  *      Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2658  *      to be standalone (e.g. it could be part of a split WIM).
2659  * @param image
2660  *      The number of the image, numbered starting at 1.
2661  *
2662  * @return
2663  *      The description of the image, or @c NULL if there is no such image, or
2664  *      @c NULL if the specified image has no description.  The description
2665  *      string is in library-internal memory and may not be modified or freed;
2666  *      in addition, the string will become invalid if the description of the
2667  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2668  */
2669 extern const wimlib_tchar *
2670 wimlib_get_image_description(const WIMStruct *wim, int image);
2671
2672 /**
2673  * @ingroup G_wim_information
2674  *
2675  * Returns the name of the specified image.
2676  *
2677  * @param wim
2678  *      Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2679  *      to be standalone (e.g. it could be part of a split WIM).
2680  * @param image
2681  *      The number of the image, numbered starting at 1.
2682  *
2683  * @return
2684  *      The name of the image, or @c NULL if there is no such image, or an empty
2685  *      string if the image is unnamed.  The name string is in
2686  *      library-internal memory and may not be modified or freed; in addition,
2687  *      the string will become invalid if the name of the image is changed, the
2688  *      image is deleted, or the ::WIMStruct is destroyed.
2689  */
2690 extern const wimlib_tchar *
2691 wimlib_get_image_name(const WIMStruct *wim, int image);
2692
2693 /**
2694  * @ingroup G_general
2695  *
2696  * Returns the version of wimlib as a 32-bit number whose top 12 bits contain
2697  * the major version, the next 10 bits contain the minor version, and the low 10
2698  * bits contain the patch version.
2699  *
2700  * In other words, the returned value is equal to <code>((WIMLIB_MAJOR_VERSION
2701  * << 22) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</code> for the
2702  * corresponding header file.
2703  */
2704 extern uint32_t
2705 wimlib_get_version(void);
2706
2707 /**
2708  * @ingroup G_wim_information
2709  *
2710  * Get basic information about a WIM file.
2711  *
2712  * @param wim
2713  *      Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2714  *      to be standalone (e.g. it could be part of a split WIM).
2715  * @param info
2716  *      A ::wimlib_wim_info structure that will be filled in with information
2717  *      about the WIM file.
2718  * @return
2719  *      0
2720  */
2721 extern int
2722 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2723
2724 /**
2725  * @ingroup G_wim_information
2726  *
2727  * Read the XML data of a WIM file into an in-memory buffer.  Every WIM file
2728  * includes a string of XML that describes the images contained in the WIM.
2729  *
2730  * See wimlib_extract_xml_data() to extract the XML data to a file stream
2731  * instead.
2732  *
2733  * @param wim
2734  *      Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2735  *      have to be standalone (e.g. it could be part of a split WIM).
2736  * @param buf_ret
2737  *      On success, a pointer to an allocated buffer containing the raw UTF16-LE
2738  *      XML data is written to this location.
2739  * @param bufsize_ret
2740  *      The size of the XML data in bytes is written to this location.
2741  *
2742  * @return 0 on success; nonzero on error.
2743  * @retval ::WIMLIB_ERR_INVALID_PARAM
2744  *      @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
2745  *      @p buf_ret or @p bufsize_ret was @c NULL.
2746  * @retval ::WIMLIB_ERR_NOMEM
2747  * @retval ::WIMLIB_ERR_READ
2748  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2749  *      Failed to read the XML data from the WIM.
2750  */
2751 extern int
2752 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
2753
2754 /**
2755  * @ingroup G_general
2756  *
2757  * Initialization function for wimlib.  Call before using any other wimlib
2758  * function except wimlib_set_print_errors().  If not done manually, this
2759  * function will be called automatically with @p init_flags set to
2760  * ::WIMLIB_INIT_FLAG_ASSUME_UTF8.  This function does nothing if called again
2761  * after it has already successfully run.
2762  *
2763  * @param init_flags
2764  *      Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
2765  *
2766  * @return 0 on success; nonzero on failure.  Currently, only the following
2767  * error code is defined:
2768  *
2769  * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
2770  *      ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
2771  *      ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
2772  *      init_flags, but the corresponding privileges could not be acquired.
2773  */
2774 extern int
2775 wimlib_global_init(int init_flags);
2776
2777 /**
2778  * @ingroup G_general
2779  *
2780  * Cleanup function for wimlib.  You are not required to call this function, but
2781  * it will release any global resources allocated by the library.
2782  */
2783 extern void
2784 wimlib_global_cleanup(void);
2785
2786 /**
2787  * @ingroup G_wim_information
2788  *
2789  * Determines if an image name is already used by some image in the WIM.
2790  *
2791  * @param wim
2792  *      Pointer to the ::WIMStruct for a WIM file.
2793  * @param name
2794  *      The name to check.
2795  *
2796  * @return
2797  *      @c true if there is already an image in @p wim named @p name; @c false
2798  *      if there is no image named @p name in @p wim.  If @p name is @c NULL or
2799  *      the empty string, @c false is returned.
2800  */
2801 extern bool
2802 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2803
2804 /**
2805  * @ingroup G_wim_information
2806  *
2807  * Iterate through a file or directory tree in the WIM image.  By specifying
2808  * appropriate flags and a callback function, you can get the attributes of a
2809  * file in the WIM, get a directory listing, or even get a listing of the entire
2810  * WIM image.
2811  *
2812  * @param wim
2813  *      The WIM containing the image(s) over which to iterate, specified as a
2814  *      pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
2815  *      or part 1 of a split WIM.  In the case of a WIM file that is not
2816  *      standalone, this ::WIMStruct should have had any needed external
2817  *      resources previously referenced using wimlib_reference_resources() or
2818  *      wimlib_reference_resource_files().  If not, see
2819  *      ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
2820  *      the behavior when resources are missing.
2821  *
2822  * @param image
2823  *      The 1-based number of the image in @p wim that contains the files or
2824  *      directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2825  *      iteration on all images in the WIM.
2826  *
2827  * @param path
2828  *      Path in the WIM image at which to do the iteration.
2829  *
2830  * @param flags
2831  *      Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
2832  *
2833  * @param cb
2834  *      A callback function that will receive each directory entry.
2835  *
2836  * @param user_ctx
2837  *      An extra parameter that will always be passed to the callback function
2838  *      @p cb.
2839  *
2840  * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2841  * first nonzero value that was returned from @p cb.  However, additional error
2842  * codes may be returned, including the following:
2843  *
2844  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2845  *      @p path did not exist in the WIM image.
2846  * @retval ::WIMLIB_ERR_NOMEM
2847  *      Failed to allocate memory needed to create a ::wimlib_dir_entry.
2848  *
2849  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2850  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2851  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2852  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2853  * different reasons) to read the metadata resource for an image over which
2854  * iteration needed to be done.
2855  */
2856 extern int
2857 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2858                         int flags,
2859                         wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2860
2861 /**
2862  * @ingroup G_wim_information
2863  *
2864  * Iterate through the lookup table of a WIM file.  This can be used to directly
2865  * get a listing of the unique resources contained in a WIM file over all
2866  * images.  Both file resources and metadata resources are included.  However,
2867  * only resources actually included in the file represented by @a wim, plus
2868  * explicitly referenced external resources (via wimlib_reference_resources() or
2869  * wimlib_reference_resource_files()) are included in the iteration.  For
2870  * example, if @p wim represents just one part of a split WIM, then only
2871  * resources in that part will be included, unless other resources were
2872  * explicitly referenced.
2873  *
2874  * @param wim
2875  *      Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2876  *      to be standalone (e.g. it could be part of a split WIM).
2877  *
2878  * @param flags
2879  *      Reserved; set to 0.
2880  *
2881  * @param cb
2882  *      A callback function that will receive each resource.
2883  *
2884  * @param user_ctx
2885  *      An extra parameter that will always be passed to the callback function
2886  *      @p cb.
2887  *
2888  * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2889  * that was returned from @p cb.
2890  */
2891 extern int
2892 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2893                             wimlib_iterate_lookup_table_callback_t cb,
2894                             void *user_ctx);
2895
2896 /**
2897  * @ingroup G_nonstandalone_wims
2898  *
2899  * Joins a split WIM into a stand-alone one-part WIM.
2900  *
2901  * @param swms
2902  *      An array of strings that gives the filenames of all parts of the split
2903  *      WIM.  No specific order is required, but all parts must be included with
2904  *      no duplicates.
2905  * @param num_swms
2906  *      Number of filenames in @p swms.
2907  * @param swm_open_flags
2908  *      Open flags for the split WIM parts (e.g.
2909  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
2910  * @param wim_write_flags
2911  *      Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2912  *      be used to write the joined WIM.
2913  * @param output_path
2914  *      The path to write the joined WIM file to.
2915  * @param progress_func
2916  *      If non-NULL, a function that will be called periodically with the
2917  *      progress of the current operation.
2918  *
2919  * @return 0 on success; nonzero on error.  This function may return most error
2920  * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2921  * as the following error code:
2922  *
2923  * @retval ::WIMLIB_ERR_SPLIT_INVALID
2924  *      The split WIMs do not form a valid WIM because they do not include all
2925  *      the parts of the original WIM, there are duplicate parts, or not all the
2926  *      parts have the same GUID and compression type.
2927  *
2928  * Note: wimlib is generalized enough that this function is not actually needed
2929  * to join a split WIM; instead, you could open the first part of the split WIM,
2930  * then reference the other parts with wimlib_reference_resource_files(), then
2931  * write the joined WIM using wimlib_write().  However, wimlib_join() provides
2932  * an easy-to-use wrapper around this that has some advantages (e.g.  extra
2933  * sanity checks).
2934  */
2935 extern int
2936 wimlib_join(const wimlib_tchar * const *swms,
2937             unsigned num_swms,
2938             const wimlib_tchar *output_path,
2939             int swm_open_flags,
2940             int wim_write_flags,
2941             wimlib_progress_func_t progress_func);
2942
2943
2944 /**
2945  * @ingroup G_mounting_wim_images
2946  *
2947  * Mounts an image in a WIM file on a directory read-only or read-write.
2948  *
2949  * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2950  * supported if wimlib was configured with @c --without-fuse.  This includes
2951  * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2952  * cases.
2953  *
2954  * Calling this function daemonizes the process, unless
2955  * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs.  If the
2956  * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2957  * to the WIM are staged in a temporary directory.
2958  *
2959  * It is safe to mount multiple images from the same underlying WIM file
2960  * read-only at the same time, but only if different ::WIMStruct's are used.  It
2961  * is @b not safe to mount multiple images from the same WIM file read-write at
2962  * the same time.
2963  *
2964  * wimlib_mount_image() cannot be used on an image that was exported with
2965  * wimlib_export_image() while the dentry trees for both images are still in
2966  * memory.  In addition, wimlib_mount_image() may not be used to mount an image
2967  * that already has modifications pending (e.g. an image added with
2968  * wimlib_add_image()).
2969  *
2970  * @param wim
2971  *      Pointer to the ::WIMStruct containing the image to be mounted.
2972  * @param image
2973  *      The number of the image to mount, indexed starting from it.  It must be
2974  *      an existing, single image.
2975  * @param dir
2976  *      The path to an existing empty directory to mount the image on.
2977  * @param mount_flags
2978  *      Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG.
2979  * @param staging_dir
2980  *      If non-NULL, the name of a directory in which the staging directory will
2981  *      be created.  Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
2982  *      in @p mount_flags.  If left @c NULL, the staging directory is created in
2983  *      the same directory as the WIM file that @p wim was originally read from.
2984  *
2985  * @return 0 on success; nonzero on error.
2986  *
2987  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2988  *      A read-write mount was requested, but an an exclusive advisory lock on
2989  *      the on-disk WIM file could not be acquired because another thread or
2990  *      process has mounted an image from the WIM read-write or is currently
2991  *      modifying the WIM in-place.
2992  * @retval ::WIMLIB_ERR_FUSE
2993  *      A non-zero status was returned by @c fuse_main().
2994  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2995  *      @p image does not specify an existing, single image in @p wim.
2996  * @retval ::WIMLIB_ERR_INVALID_PARAM
2997  *      @p image is shared among multiple ::WIMStruct's as a result of a call to
2998  *      wimlib_export_image(), or @p image has been added with
2999  *      wimlib_add_image().
3000  * @retval ::WIMLIB_ERR_MKDIR
3001  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3002  *      staging directory could not be created.
3003  * @retval ::WIMLIB_ERR_NOTDIR
3004  *      Could not determine the current working directory.
3005  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3006  *      One of the dentries in the image referenced a stream not present in the
3007  *      WIM's lookup table (or in any of the lookup tables of the split WIM
3008  *      parts).
3009  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3010  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
3011  *      wim is considered read-only because of any of the reasons mentioned in
3012  *      the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3013  * @retval ::WIMLIB_ERR_UNSUPPORTED
3014  *      Mounting is not supported, either because the platform is Windows, or
3015  *      because the platform is UNIX-like and wimlib was compiled with @c
3016  *      --without-fuse.
3017  *
3018  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3019  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3020  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3021  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3022  * different reasons) to read the metadata resource for the image to mount.
3023  */
3024 extern int
3025 wimlib_mount_image(WIMStruct *wim,
3026                    int image,
3027                    const wimlib_tchar *dir,
3028                    int mount_flags,
3029                    const wimlib_tchar *staging_dir);
3030
3031 /**
3032  * @ingroup G_creating_and_opening_wims
3033  *
3034  * Opens a WIM file and creates a ::WIMStruct for it.
3035  *
3036  * @param wim_file
3037  *      The path to the WIM file to open.
3038  *
3039  * @param open_flags
3040  *      Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3041  *
3042  * @param progress_func
3043  *      If non-NULL, a function that will be called periodically with the
3044  *      progress of the current operation.  Currently, the only messages sent
3045  *      will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
3046  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
3047  *
3048  * @param wim_ret
3049  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
3050  *      is written to the memory location pointed to by this parameter.  The
3051  *      ::WIMStruct can be freed using using wimlib_free() when finished with
3052  *      it.
3053  *
3054  * @return 0 on success; nonzero on error.
3055  * @retval ::WIMLIB_ERR_IMAGE_COUNT
3056  *      The WIM is not the non-first part of a split WIM, and the number of
3057  *      metadata resources found in the WIM did not match the image count given
3058  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
3059  *      data for the WIM did not match the image count given in the WIM header.
3060  * @retval ::WIMLIB_ERR_INTEGRITY
3061  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
3062  *      wim_file contains an integrity table, but the SHA1 message digest for a
3063  *      chunk of the WIM does not match the corresponding message digest given
3064  *      in the integrity table.
3065  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3066  *      Resources in @p wim_file are compressed, but the chunk size was invalid
3067  *      for the WIM's compression type.
3068  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3069  *      The header of @p wim_file says that resources in the WIM are compressed,
3070  *      but the header flag for a recognized compression type is not set.
3071  * @retval ::WIMLIB_ERR_INVALID_HEADER
3072  *      The header of @p wim_file was otherwise invalid.
3073  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3074  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
3075  *      wim_file contains an integrity table, but the integrity table is
3076  *      invalid.
3077  * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3078  *      The lookup table for the WIM was invalid.
3079  * @retval ::WIMLIB_ERR_INVALID_PARAM
3080  *      @p wim_ret was @c NULL.
3081  * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3082  *      @p wim_file is a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3083  *      specified in @p open_flags.
3084  * @retval ::WIMLIB_ERR_NOMEM
3085  *      Failed to allocated needed memory.
3086  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3087  *      @p wim_file does not begin with the expected magic characters.
3088  * @retval ::WIMLIB_ERR_OPEN
3089  *      Failed to open the file @p wim_file for reading.
3090  * @retval ::WIMLIB_ERR_READ
3091  *      Failed to read data from @p wim_file.
3092  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3093  *      Unexpected end-of-file while reading data from @p wim_file.
3094  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3095  *      The WIM version number was not recognized. (May be a pre-Vista WIM.)
3096  * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3097  *      The WIM cannot be opened because it contains encrypted segments.  (It
3098  *      may be a Windows 8 "ESD" file).
3099  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3100  *      ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3101  *      considered read-only because of any of the reasons mentioned in the
3102  *      documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3103  * @retval ::WIMLIB_ERR_XML
3104  *      The XML data for @p wim_file is invalid.
3105  */
3106 extern int
3107 wimlib_open_wim(const wimlib_tchar *wim_file,
3108                 int open_flags,
3109                 WIMStruct **wim_ret,
3110                 wimlib_progress_func_t progress_func);
3111
3112 /**
3113  * @ingroup G_writing_and_overwriting_wims
3114  *
3115  * Overwrites the file that the WIM was originally read from, with changes made.
3116  * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3117  * rather than wimlib_create_new_wim().
3118  *
3119  * There are two ways that a WIM may be overwritten.  The first is to do a full
3120  * rebuild.  In this mode, the new WIM is written to a temporary file and then
3121  * renamed to the original file after it is has been completely written.  The
3122  * temporary file is made in the same directory as the original WIM file.  A
3123  * full rebuild may take a while, but can be used even if images have been
3124  * modified or deleted, will produce a WIM with no holes, and has little chance
3125  * of unintentional data loss because the temporary WIM is fsync()ed before
3126  * being renamed to the original WIM.
3127  *
3128  * The second way to overwrite a WIM is by appending to the end of it and
3129  * overwriting the header.  This can be much faster than a full rebuild, but the
3130  * disadvantage is that some space will be wasted.  Writing a WIM in this mode
3131  * begins with writing any new file resources *after* everything in the old WIM,
3132  * even though this will leave a hole where the old lookup table, XML data, and
3133  * integrity were.  This is done so that the WIM remains valid even if the
3134  * operation is aborted mid-write.  The WIM header is only overwritten at the
3135  * very last moment, and up until that point the WIM will be seen as the old
3136  * version.
3137  *
3138  * By default, wimlib_overwrite() does the append-style overwrite described
3139  * above, unless resources in the WIM are arranged in an unusual way or if
3140  * images have been deleted from the WIM.  Use the flag
3141  * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3142  * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3143  * images have been deleted from the WIM.
3144  *
3145  * In the temporary-file overwrite mode, no changes are made to the WIM on
3146  * failure, and the temporary file is deleted if possible.  Abnormal termination
3147  * of the program will result in the temporary file being orphaned.  In the
3148  * direct append mode, the WIM is truncated to the original length on failure;
3149  * and while abnormal termination of the program will result in extra data
3150  * appended to the original WIM, it should still be a valid WIM.
3151  *
3152  * If this function completes successfully, no more functions should be called
3153  * on @p wim other than wimlib_free().  You must use wimlib_open_wim() to read
3154  * the WIM file anew.
3155  *
3156  * @param wim
3157  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
3158  *      been in-memory changes made to it, which are then reflected in the
3159  *      output file.
3160  * @param write_flags
3161  *      Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3162  * @param num_threads
3163  *      Number of threads to use for compression (see wimlib_write()).
3164  * @param progress_func
3165  *      If non-NULL, a function that will be called periodically with the
3166  *      progress of the current operation.
3167  *
3168  * @return 0 on success; nonzero on error.  This function may return most error
3169  * codes returned by wimlib_write() as well as the following error codes:
3170  *
3171  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3172  *      The WIM was going to be modified in-place (with no temporary file), but
3173  *      an exclusive advisory lock on the on-disk WIM file could not be acquired
3174  *      because another thread or process has mounted an image from the WIM
3175  *      read-write or is currently modifying the WIM in-place.
3176  * @retval ::WIMLIB_ERR_NO_FILENAME
3177  *      @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
3178  *      than a WIM read with wimlib_open_wim().
3179  * @retval ::WIMLIB_ERR_RENAME
3180  *      The temporary file that the WIM was written to could not be renamed to
3181  *      the original filename of @p wim.
3182  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3183  *      The WIM file is considered read-only because of any of the reasons
3184  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3185  *      flag.
3186  */
3187 extern int
3188 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
3189                  wimlib_progress_func_t progress_func);
3190
3191 /**
3192  * @ingroup G_wim_information
3193  *
3194  * Prints information about one image, or all images, contained in a WIM.
3195  *
3196  * @param wim
3197  *      Pointer to the ::WIMStruct for a WIM file.
3198  * @param image
3199  *      The image about which to print information.  Can be the number of an
3200  *      image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3201  *      WIM.
3202  *
3203  * @return This function has no return value.  No error checking is done when
3204  * printing the information.  If @p image is invalid, an error message is
3205  * printed.
3206  */
3207 extern void
3208 wimlib_print_available_images(const WIMStruct *wim, int image);
3209
3210 /**
3211  * @ingroup G_wim_information
3212  *
3213  * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3214  * in a way that can be accessed programatically.
3215  */
3216 extern void
3217 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3218
3219 /**
3220  * @ingroup G_nonstandalone_wims
3221  *
3222  * Reference resources from other WIM files or split WIM parts.  This function
3223  * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3224  * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3225  * from other files, before calling a function such as wimlib_extract_image()
3226  * that requires the resources to be present.
3227  *
3228  * @param wim
3229  *      The ::WIMStruct for a WIM that contains metadata resources, but is not
3230  *      necessarily "standalone".  In the case of split WIMs, this should be the
3231  *      first part, since only the first part contains the metadata resources.
3232  *      In the case of delta WIMs, this should be the delta WIM rather than the
3233  *      WIM on which it is based.
3234  * @param resource_wimfiles_or_globs
3235  *      Array of paths to WIM files and/or split WIM parts to reference.
3236  *      Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3237  *      ref_flags, these are treated as globs rather than literal paths.  That
3238  *      is, using this function you can specify zero or more globs, each of
3239  *      which expands to one or more literal paths.
3240  * @param count
3241  *      Number of entries in @p resource_wimfiles_or_globs.
3242  * @param ref_flags
3243  *      Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3244  *      ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3245  * @param open_flags
3246  *      Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3247  *      pass to internal calls to wimlib_open_wim() on the reference files.
3248  * @param progress_func
3249  *      Passed to internal calls to wimlib_open_wim() on the reference files.
3250  *
3251  * @return 0 on success; nonzero on error.
3252  *
3253  * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3254  *      One of the specified globs did not match any paths (only with both
3255  *      ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3256  *      specified in @p ref_flags).
3257  * @retval ::WIMLIB_ERR_NOMEM
3258  *      Failed to allocate memory.
3259  * @retval ::WIMLIB_ERR_READ
3260  *      I/O or permissions error while processing a file glob.
3261  *
3262  * This function can additionally return most values that can be returned by
3263  * wimlib_open_wim().
3264  */
3265 extern int
3266 wimlib_reference_resource_files(WIMStruct *wim,
3267                                 const wimlib_tchar * const *resource_wimfiles_or_globs,
3268                                 unsigned count,
3269                                 int ref_flags,
3270                                 int open_flags,
3271                                 wimlib_progress_func_t progress_func);
3272
3273 /**
3274  * @ingroup G_nonstandalone_wims
3275  *
3276  * Similar to wimlib_reference_resource_files(), but operates at a lower level
3277  * where the caller must open the ::WIMStruct for each referenced file itself.
3278  *
3279  * @param wim
3280  *      The ::WIMStruct for a WIM that contains metadata resources, but is not
3281  *      necessarily "standalone".  In the case of split WIMs, this should be the
3282  *      first part, since only the first part contains the metadata resources.
3283  * @param resource_wims
3284  *      Array of pointers to the ::WIMStruct's for additional resource WIMs or
3285  *      split WIM parts to reference.
3286  * @param num_resource_wims
3287  *      Number of entries in @p resource_wims.
3288  * @param ref_flags
3289  *      Currently ignored (set to 0).
3290  *
3291  * @return 0 on success; nonzero on error.  On success, the ::WIMStruct's of the
3292  * @p resource_wims are referenced internally by @p wim and must not be freed
3293  * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3294  * been freed with wimlib_free(), or immediately before freeing @p wim with
3295  * wimlib_free().
3296  *
3297  * @retval ::WIMLIB_ERR_INVALID_PARAM
3298  *      @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3299  *      resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3300  * @retval ::WIMLIB_ERR_NOMEM
3301  *      Failed to allocate memory.
3302  */
3303 extern int
3304 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3305                            unsigned num_resource_wims, int ref_flags);
3306
3307 /**
3308  * @ingroup G_modifying_wims
3309  *
3310  * Declares that a newly added image is mostly the same as a prior image, but
3311  * captured at a later point in time, possibly with some modifications in the
3312  * intervening time.  This is designed to be used in incremental backups of the
3313  * same filesystem or directory tree.
3314  *
3315  * This function compares the metadata of the directory tree of the newly added
3316  * image against that of the old image.  Any files that are present in both the
3317  * newly added image and the old image and have timestamps that indicate they
3318  * haven't been modified are deemed not to have been modified and have their
3319  * SHA1 message digest copied from the old image.  Because of this and because
3320  * WIM uses single-instance streams, such files need not be read from the
3321  * filesystem when the WIM is being written or overwritten.  Note that these
3322  * unchanged files will still be "archived" and will be logically present in the
3323  * new image; the optimization is that they don't need to actually be read from
3324  * the filesystem because the WIM already contains them.
3325  *
3326  * This function is provided to optimize incremental backups.  The resulting WIM
3327  * file will still be the same regardless of whether this function is called.
3328  * (This is, however, assuming that timestamps have not been manipulated or
3329  * unmaintained as to trick this function into thinking a file has not been
3330  * modified when really it has.  To partly guard against such cases, other
3331  * metadata such as file sizes will be checked as well.)
3332  *
3333  * This function must be called after adding the new image (e.g. with
3334  * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3335  * wimlib_overwrite()).
3336  *
3337  * @param wim
3338  *      Pointer to the ::WIMStruct for a WIM.
3339  * @param new_image
3340  *      1-based index in the WIM of the newly added image.  This image can have
3341  *      been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3342  *      wimlib_add_empty_image() followed by wimlib_update_image().
3343  * @param template_wim
3344  *      The ::WIMStruct for the WIM containing the template image.  This can be
3345  *      the same as @p wim, or it can be a different ::WIMStruct.
3346  * @param template_image
3347  *      1-based index in the WIM of a template image that reflects a prior state
3348  *      of the directory tree being captured.
3349  * @param flags
3350  *      Reserved; must be 0.
3351  * @param progress_func
3352  *      Currently ignored, but reserved for a function that will be called with
3353  *      information about the operation.  Use NULL if no additional information
3354  *      is desired.
3355  *
3356  * @return 0 on success; nonzero on error.
3357  *
3358  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3359  *      @p new_image and/or @p template_image were not a valid image indices in
3360  *      the WIM.
3361  * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3362  *      The specified ::WIMStruct did not actually contain the metadata resource
3363  *      for the new or template image; for example, it was a non-first part of a
3364  *      split WIM.
3365  * @retval ::WIMLIB_ERR_NOMEM
3366  *      Failed to allocate needed memory.
3367  * @retval ::WIMLIB_ERR_INVALID_PARAM
3368  *      @p new_image was equal to @p template_image, or @p new_image specified
3369  *      an image that had not been modified since opening the WIM.
3370  *
3371  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3372  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3373  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3374  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3375  * different reasons) to read the metadata resource for the template image.
3376  */
3377 extern int
3378 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3379                                 WIMStruct *template_wim, int template_image,
3380                                 int flags, wimlib_progress_func_t progress_func);
3381
3382 /**
3383  * @ingroup G_wim_information
3384  *
3385  * Translates a string specifying the name or number of an image in the WIM into
3386  * the number of the image.  The images are numbered starting at 1.
3387  *
3388  * @param wim
3389  *      Pointer to the ::WIMStruct for a WIM.
3390  * @param image_name_or_num
3391  *      A string specifying the name or number of an image in the WIM.  If it
3392  *      parses to a positive integer, this integer is taken to specify the
3393  *      number of the image, indexed starting at 1.  Otherwise, it is taken to
3394  *      be the name of an image, as given in the XML data for the WIM file.  It
3395  *      also may be the keyword "all" or the string "*", both of which will
3396  *      resolve to ::WIMLIB_ALL_IMAGES.
3397  *      <br/> <br/>
3398  *      There is no way to search for an image actually named "all", "*", or an
3399  *      integer number, or an image that has no name.  However, you can use
3400  *      wimlib_get_image_name() to get the name of any image.
3401  *
3402  * @return
3403  *      If the string resolved to a single existing image, the number of that
3404  *      image, indexed starting at 1, is returned.  If the keyword "all" or "*"
3405  *      was specified, ::WIMLIB_ALL_IMAGES is returned.  Otherwise,
3406  *      ::WIMLIB_NO_IMAGE is returned.  If @p image_name_or_num was @c NULL or
3407  *      the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3408  *      images in @p wim has no name.
3409  */
3410 extern int
3411 wimlib_resolve_image(WIMStruct *wim,
3412                      const wimlib_tchar *image_name_or_num);
3413
3414 /**
3415  * @ingroup G_modifying_wims
3416  *
3417  * Changes the description of an image in the WIM.
3418  *
3419  * @param wim
3420  *      Pointer to the ::WIMStruct for a WIM.
3421  * @param image
3422  *      The number of the image for which to change the description.
3423  * @param description
3424  *      The new description to give the image.  It may be @c NULL, which
3425  *      indicates that the image is to be given no description.
3426  *
3427  * @return 0 on success; nonzero on error.
3428  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3429  *      @p image does not specify a single existing image in @p wim.
3430  * @retval ::WIMLIB_ERR_NOMEM
3431  *      Failed to allocate the memory needed to duplicate the @p description
3432  *      string.
3433  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3434  *      @p wim is considered read-only because of any of the reasons mentioned
3435  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3436  */
3437 extern int
3438 wimlib_set_image_descripton(WIMStruct *wim, int image,
3439                             const wimlib_tchar *description);
3440
3441 /**
3442  * @ingroup G_writing_and_overwriting_wims
3443  *
3444  * Set the compression chunk size of a WIM to use in subsequent calls to
3445  * wimlib_write() or wimlib_overwrite().
3446  *
3447  * For compatibility reasons, using this function is not generally recommended.
3448  * See the documentation for the @c --chunk-size option of <b>wimlib-imagex
3449  * capture</b> for more information.
3450  *
3451  * A larger compression chunk size will likely result in a better compression
3452  * ratio, but the speed of random access to the WIM will be reduced.
3453  * Furthermore, the effect of a larger compression chunk size is limited by the
3454  * size of each stream ("file") being compressed.
3455  *
3456  * @param wim
3457  *      ::WIMStruct for a WIM.
3458  * @param chunk_size
3459  *      The chunk size (in bytes) to set.  The valid chunk sizes are dependent
3460  *      on the compression format; see the documentation for the @c --chunk-size
3461  *      option of <b>wimlib-imagex capture</b> for more information.  As a
3462  *      special case, if @p chunk_size is specified as 0, the chunk size is set
3463  *      to the default for the currently selected output compression type.
3464  *
3465  * @return 0 on success; nonzero on error.
3466  *
3467  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3468  *      @p chunk_size is not a supported chunk size for the currently selected
3469  *      output compression type.
3470  */
3471 extern int
3472 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3473
3474 /**
3475  * @ingroup G_writing_and_overwriting_wims
3476  *
3477  * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
3478  * packed streams.
3479  */
3480 extern int
3481 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3482
3483 /**
3484  * @ingroup G_writing_and_overwriting_wims
3485  *
3486  * Set the compression type of a WIM to use in subsequent calls to
3487  * wimlib_write() or wimlib_overwrite().
3488  *
3489  * @param wim
3490  *      ::WIMStruct for a WIM.
3491  * @param ctype
3492  *      The compression type to set (one of ::wimlib_compression_type).  If this
3493  *      compression type is incompatible with the current output chunk size
3494  *      (either the default or as set with wimlib_set_output_chunk_size()), the
3495  *      output chunk size is reset to the default for that compression type.
3496  *
3497  * @return 0 on success; nonzero on error.
3498  *
3499  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3500  *      @p ctype did not specify a valid compression type.
3501  */
3502 extern int
3503 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
3504
3505 /**
3506  * @ingroup G_writing_and_overwriting_wims
3507  *
3508  * Similar to wimlib_set_output_compression_type(), but set the compression type
3509  * for writing packed streams (solid blocks).
3510  *
3511  * Note: based on testing, WIMGAPI is seemingly only compatible with LZMS
3512  * compression in packed streams.  Therefore the use of this function is not
3513  * recommended.  Also, with large chunk sizes, LZMS gives the best compression
3514  * ratio among the alternatives anyway.
3515  */
3516 extern int
3517 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
3518
3519 /**
3520  * @ingroup G_modifying_wims
3521  *
3522  * Set basic information about a WIM.
3523  *
3524  * @param wim
3525  *      Pointer to the ::WIMStruct for a WIM.
3526  * @param info
3527  *      A struct ::wimlib_wim_info that contains the information to set.  Only
3528  *      the information explicitly specified in the @p which flags need be
3529  *      valid.
3530  * @param which
3531  *      Flags that specify which information to set.  This is a bitwise OR of
3532  *      ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
3533  *      ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
3534  *
3535  * @return 0 on success; nonzero on failure.
3536  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3537  *      The WIM file is considered read-only because of any of the reasons
3538  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3539  *      flag.  However, as a special case, if you are using
3540  *      ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
3541  *      function will not fail due to the readonly flag being previously set.
3542  * @retval ::WIMLIB_ERR_IMAGE_COUNT
3543  *      ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
3544  *      ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
3545  *      index in the WIM.
3546  */
3547 extern int
3548 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
3549                     int which);
3550
3551 /**
3552  * @ingroup G_modifying_wims
3553  *
3554  * Changes what is written in the \<FLAGS\> element in the WIM XML data
3555  * (something like "Core" or "Ultimate")
3556  *
3557  * @param wim
3558  *      Pointer to the ::WIMStruct for a WIM.
3559  * @param image
3560  *      The number of the image for which to change the description.
3561  * @param flags
3562  *      The new \<FLAGS\> element to give the image.  It may be @c NULL, which
3563  *      indicates that the image is to be given no \<FLAGS\> element.
3564  *
3565  * @return 0 on success; nonzero on error.
3566  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3567  *      @p image does not specify a single existing image in @p wim.
3568  * @retval ::WIMLIB_ERR_NOMEM
3569  *      Failed to allocate the memory needed to duplicate the @p flags string.
3570  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3571  *      @p wim is considered read-only because of any of the reasons mentioned
3572  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3573  */
3574 extern int
3575 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3576
3577 /**
3578  * @ingroup G_modifying_wims
3579  *
3580  * Changes the name of an image in the WIM.
3581  *
3582  * @param wim
3583  *      Pointer to the ::WIMStruct for a WIM.
3584  * @param image
3585  *      The number of the image for which to change the name.
3586  * @param name
3587  *      New name to give the new image.  If @c NULL or empty, the new image is
3588  *      given no name.  If nonempty, it must specify a name that does not
3589  *      already exist in @p wim.
3590  *
3591  * @return 0 on success; nonzero on error.
3592  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3593  *      There is already an image named @p name in @p wim.
3594  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3595  *      @p image does not specify a single existing image in @p wim.
3596  * @retval ::WIMLIB_ERR_NOMEM
3597  *      Failed to allocate the memory needed to duplicate the @p name string.
3598  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3599  *      @p wim is considered read-only because of any of the reasons mentioned
3600  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3601  */
3602 extern int
3603 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3604
3605 /**
3606  * @ingroup G_general
3607  *
3608  * Set the functions that wimlib uses to allocate and free memory.
3609  *
3610  * These settings are global and not per-WIM.
3611  *
3612  * The default is to use the default @c malloc() and @c free() from the C
3613  * library.
3614  *
3615  * Please note that some external functions, such as those in @c libntfs-3g, may
3616  * use the standard memory allocation functions.
3617  *
3618  * @param malloc_func
3619  *      A function equivalent to @c malloc() that wimlib will use to allocate
3620  *      memory.  If @c NULL, the allocator function is set back to the default
3621  *      @c malloc() from the C library.
3622  * @param free_func
3623  *      A function equivalent to @c free() that wimlib will use to free memory.
3624  *      If @c NULL, the free function is set back to the default @c free() from
3625  *      the C library.
3626  * @param realloc_func
3627  *      A function equivalent to @c realloc() that wimlib will use to reallocate
3628  *      memory.  If @c NULL, the free function is set back to the default @c
3629  *      realloc() from the C library.
3630  * @return 0
3631  */
3632 extern int
3633 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3634                             void (*free_func)(void *),
3635                             void *(*realloc_func)(void *, size_t));
3636
3637 /**
3638  * @ingroup G_general
3639  *
3640  * Sets whether wimlib is to print error messages to @c stderr when a function
3641  * fails.  These error messages may provide information that cannot be
3642  * determined only from the error code that is returned.  Not every error will
3643  * result in an error message being printed.
3644  *
3645  * This setting is global and not per-WIM.
3646  *
3647  * By default, error messages are not printed.
3648  *
3649  * This can be called before wimlib_global_init().
3650  *
3651  * @param show_messages
3652  *      @c true if error messages are to be printed; @c false if error messages
3653  *      are not to be printed.
3654  *
3655  * @return 0 on success; nonzero on error.
3656  * @retval ::WIMLIB_ERR_UNSUPPORTED
3657  *      @p show_messages was @c true, but wimlib was compiled with the @c
3658  *      --without-error-messages option.   Therefore, error messages cannot be
3659  *      shown.
3660  */
3661 extern int
3662 wimlib_set_print_errors(bool show_messages);
3663
3664 /**
3665  * @ingroup G_nonstandalone_wims
3666  *
3667  * Splits a WIM into multiple parts.
3668  *
3669  * @param wim
3670  *      The ::WIMStruct for the WIM to split.
3671  * @param swm_name
3672  *      Name of the SWM file to create.  This will be the name of the first
3673  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
3674  *      appended before the suffix.
3675  * @param part_size
3676  *      The maximum size per part, in bytes.  Unfortunately, it is not
3677  *      guaranteed that this will really be the maximum size per part, because
3678  *      some file resources in the WIM may be larger than this size, and the WIM
3679  *      file format provides no way to split up file resources among multiple
3680  *      WIMs.
3681  * @param write_flags
3682  *      Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG.  These
3683  *      flags will be used to write each split WIM part.  Specify 0 here to get
3684  *      the default behavior.
3685  * @param progress_func
3686  *      If non-NULL, a function that will be called periodically with the
3687  *      progress of the current operation
3688  *      (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
3689  *      ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
3690  *
3691  * @return 0 on success; nonzero on error.  This function may return most error
3692  * codes that can be returned by wimlib_write() as well as the following error
3693  * codes:
3694  *
3695  * @retval ::WIMLIB_ERR_INVALID_PARAM
3696  *      @p swm_name was not a nonempty string, or @p part_size was 0.
3697  *
3698  * Note: the WIM's uncompressed and compressed resources are not checksummed
3699  * when they are copied from the joined WIM to the split WIM parts, nor are
3700  * compressed resources re-compressed (unless explicitly requested with
3701  * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
3702  */
3703 extern int
3704 wimlib_split(WIMStruct *wim,
3705              const wimlib_tchar *swm_name,
3706              uint64_t part_size,
3707              int write_flags,
3708              wimlib_progress_func_t progress_func);
3709
3710 /**
3711  * @ingroup G_mounting_wim_images
3712  *
3713  * Unmounts a WIM image that was mounted using wimlib_mount_image().
3714  *
3715  * The image to unmount is specified by the path to the mountpoint, not the
3716  * original ::WIMStruct passed to wimlib_mount_image(), which should not be
3717  * touched and also may have been allocated in a different process.
3718  *
3719  * To unmount the image, the process calling this function communicates with the
3720  * process that is managing the mounted WIM image.  This function blocks until it
3721  * is known whether the unmount succeeded or failed.  In the case of a
3722  * read-write mounted WIM, the unmount is not considered to have succeeded until
3723  * all changes have been saved to the underlying WIM file.
3724  *
3725  * @param dir
3726  *      The directory that the WIM image was mounted on.
3727  * @param unmount_flags
3728  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
3729  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
3730  *      ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS.  None of these flags affect read-only
3731  *      mounts.
3732  * @param progress_func
3733  *      If non-NULL, a function that will be called periodically with the
3734  *      progress of the current operation.  Currently, only
3735  *      ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
3736  *
3737  * @return 0 on success; nonzero on error.
3738  *
3739  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
3740  *      The filesystem daemon was unable to remove the staging directory and the
3741  *      temporary files that it contains.
3742  * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
3743  *      The filesystem daemon appears to have terminated before sending an exit
3744  *      status.
3745  * @retval ::WIMLIB_ERR_FORK
3746  *      Could not @c fork() the process.
3747  * @retval ::WIMLIB_ERR_FUSERMOUNT
3748  *      The @b fusermount program could not be executed or exited with a failure
3749  *      status.
3750  * @retval ::WIMLIB_ERR_MQUEUE
3751  *      Could not open a POSIX message queue to communicate with the filesystem
3752  *      daemon servicing the mounted filesystem, could not send a message
3753  *      through the queue, or could not receive a message through the queue.
3754  * @retval ::WIMLIB_ERR_NOMEM
3755  *      Failed to allocate needed memory.
3756  * @retval ::WIMLIB_ERR_OPEN
3757  *      The filesystem daemon could not open a temporary file for writing the
3758  *      new WIM.
3759  * @retval ::WIMLIB_ERR_READ
3760  *      A read error occurred when the filesystem daemon tried to a file from
3761  *      the staging directory
3762  * @retval ::WIMLIB_ERR_RENAME
3763  *      The filesystem daemon failed to rename the newly written WIM file to the
3764  *      original WIM file.
3765  * @retval ::WIMLIB_ERR_UNSUPPORTED
3766  *      Mounting is not supported, either because the platform is Windows, or
3767  *      because the platform is UNIX-like and wimlib was compiled with @c
3768  *      --without-fuse.
3769  * @retval ::WIMLIB_ERR_WRITE
3770  *      A write error occurred when the filesystem daemon was writing to the new
3771  *      WIM file, or the filesystem daemon was unable to flush changes that had
3772  *      been made to files in the staging directory.
3773  */
3774 extern int
3775 wimlib_unmount_image(const wimlib_tchar *dir,
3776                      int unmount_flags,
3777                      wimlib_progress_func_t progress_func);
3778
3779 /**
3780  * @ingroup G_modifying_wims
3781  *
3782  * Update a WIM image by adding, deleting, and/or renaming files or directories.
3783  *
3784  * @param wim
3785  *      Pointer to the ::WIMStruct for the WIM file to update.
3786  * @param image
3787  *      The 1-based index of the image in the WIM to update.  It cannot be
3788  *      ::WIMLIB_ALL_IMAGES.
3789  * @param cmds
3790  *      An array of ::wimlib_update_command's that specify the update operations
3791  *      to perform.
3792  * @param num_cmds
3793  *      Number of commands in @p cmds.
3794  * @param update_flags
3795  *      ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
3796  * @param progress_func
3797  *      If non-NULL, a function that will be called periodically with the
3798  *      progress of the current operation.
3799  *
3800  * @return 0 on success; nonzero on error.  On failure, some but not all of the
3801  * update commands may have been executed.  No individual update command will
3802  * have been partially executed.  Possible error codes include:
3803  *
3804  * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
3805  *      The capture configuration structure specified for an add command was
3806  *      invalid.
3807  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3808  *      @p image did not specify a single, existing image in @p wim.
3809  * @retval ::WIMLIB_ERR_INVALID_OVERLAY
3810  *      Attempted to perform an add command that conflicted with previously
3811  *      existing files in the WIM when an overlay was attempted.
3812  * @retval ::WIMLIB_ERR_INVALID_PARAM
3813  *      An unknown operation type was specified in the update commands; or,
3814  *      attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
3815  *      in the @p add_flags, but the same image had previously already been
3816  *      added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
3817  *      ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
3818  *      command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
3819  *      specified in the @p add_flags for an add command in which @p
3820  *      wim_target_path was not the root directory of the WIM image.
3821  * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
3822  *      (Windows only):  While executing an add command, tried to capture a
3823  *      reparse point with invalid data.
3824  * @retval ::WIMLIB_ERR_IS_DIRECTORY
3825  *      A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
3826  *      for a WIM path that corresponded to a directory; or, a rename command
3827  *      attempted to rename a directory to a non-directory.
3828  * @retval ::WIMLIB_ERR_NOMEM
3829  *      Failed to allocate needed memory.
3830  * @retval ::WIMLIB_ERR_NOTDIR
3831  *      A rename command attempted to rename a directory to a non-directory; or,
3832  *      an add command was executed that attempted to set the root of the WIM
3833  *      image as a non-directory; or, a path component used as a directory in a
3834  *      rename command was not, in fact, a directory.
3835  * @retval ::WIMLIB_ERR_NOTEMPTY
3836  *      A rename command attempted to rename a directory to a non-empty
3837  *      directory.
3838  * @retval ::WIMLIB_ERR_NTFS_3G
3839  *      While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
3840  *      error occurred while reading data from the NTFS volume using libntfs-3g.
3841  * @retval ::WIMLIB_ERR_OPEN
3842  *      Failed to open a file to be captured while executing an add command.
3843  * @retval ::WIMLIB_ERR_OPENDIR
3844  *      Failed to open a directory to be captured while executing an add command.
3845  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3846  *      A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
3847  *      WIM path that did not exist; or, a rename command attempted to rename a
3848  *      file that does not exist.
3849  * @retval ::WIMLIB_ERR_READ
3850  *      While executing an add command, failed to read data from a file or
3851  *      directory to be captured.
3852  * @retval ::WIMLIB_ERR_READLINK
3853  *      While executing an add command, failed to read the target of a symbolic
3854  *      link or junction point.
3855  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
3856  *      (Windows only) Failed to perform a reparse point fixup because of
3857  *      problems with the data of a reparse point.
3858  * @retval ::WIMLIB_ERR_STAT
3859  *      While executing an add command, failed to get attributes for a file or
3860  *      directory.
3861  * @retval ::WIMLIB_ERR_UNSUPPORTED
3862  *      ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
3863  *      command, but wimlib was configured with the @c --without-ntfs-3g flag;
3864  *      or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3865  *      or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
3866  *      add_flags for an update command.
3867  * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
3868  *      While executing an add command, attempted to capture a file that was not
3869  *      a supported file type (e.g. a device file).  Only if
3870  *      ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
3871  *      for an update command.
3872  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3873  *      The WIM file is considered read-only because of any of the reasons
3874  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3875  *      flag.
3876  *
3877  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3878  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3879  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3880  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3881  * different reasons) to read the metadata resource for an image that needed to
3882  * be updated.
3883  */
3884 extern int
3885 wimlib_update_image(WIMStruct *wim,
3886                     int image,
3887                     const struct wimlib_update_command *cmds,
3888                     size_t num_cmds,
3889                     int update_flags,
3890                     wimlib_progress_func_t progress_func);
3891
3892 /**
3893  * @ingroup G_writing_and_overwriting_wims
3894  *
3895  * Writes a WIM to a file.
3896  *
3897  * This brings in resources from any external locations, such as directory trees
3898  * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3899  * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3900  *
3901  * By default, the new WIM file is written as stand-alone.  Using the
3902  * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
3903  * instead.  However, this function cannot directly write a "split" WIM; use
3904  * wimlib_split() for that.
3905  *
3906  * @param wim
3907  *      Pointer to the ::WIMStruct for a WIM.  There may have been in-memory
3908  *      changes made to it, which are then reflected in the output file.
3909  * @param path
3910  *      The path to the file to write the WIM to.
3911  * @param image
3912  *      Normally, specify ::WIMLIB_ALL_IMAGES here.  This indicates that all
3913  *      images are to be included in the new on-disk WIM file.  If for some
3914  *      reason you only want to include a single image, specify the index of
3915  *      that image instead.
3916  * @param write_flags
3917  *      Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3918  * @param num_threads
3919  *      Number of threads to use for compressing data.  If 0, the number of
3920  *      threads is taken to be the number of online processors.  Note: if no
3921  *      data compression needs to be done, no additional threads will be created
3922  *      regardless of this parameter (e.g. if writing an uncompressed WIM, or
3923  *      exporting an image from a compressed WIM to another WIM of the same
3924  *      compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3925  *      write_flags).
3926  * @param progress_func
3927  *      If non-NULL, a function that will be called periodically with the
3928  *      progress of the current operation.  The possible messages are
3929  *      ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3930  *      ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3931  *      ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3932  *
3933  * @return 0 on success; nonzero on error.
3934  *
3935  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3936  *      @p image does not specify a single existing image in @p wim, and is not
3937  *      ::WIMLIB_ALL_IMAGES.
3938  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3939  *      A file that had previously been scanned for inclusion in the WIM by
3940  *      wimlib_add_image() was concurrently modified, so it failed the SHA1
3941  *      message digest check.
3942  * @retval ::WIMLIB_ERR_INVALID_PARAM
3943  *      @p path was @c NULL.
3944  * @retval ::WIMLIB_ERR_NOMEM
3945  *      Failed to allocate needed memory.
3946  * @retval ::WIMLIB_ERR_OPEN
3947  *      Failed to open @p path for writing, or some file resources in @p wim
3948  *      refer to files in the outside filesystem, and one of these files could
3949  *      not be opened for reading.
3950  * @retval ::WIMLIB_ERR_READ
3951  *      An error occurred when trying to read data from the WIM file associated
3952  *      with @p wim, or some file resources in @p wim refer to files in the
3953  *      outside filesystem, and a read error occurred when reading one of these
3954  *      files.
3955  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3956  *      A stream that needed to be written could not be found in the stream
3957  *      lookup table of @p wim.  This error can occur if, for example, @p wim is
3958  *      part of a split WIM but needed resources from the other split WIM parts
3959  *      were not referenced with wimlib_reference_resources() or
3960  *      wimlib_reference_resource_files() before the call to wimlib_write().
3961  * @retval ::WIMLIB_ERR_WRITE
3962  *      An error occurred when trying to write data to the new WIM file.
3963  *
3964  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3965  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3966  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3967  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3968  * different reasons) to read the metadata resource for an image that needed to
3969  * be written.
3970  */
3971 extern int
3972 wimlib_write(WIMStruct *wim,
3973              const wimlib_tchar *path,
3974              int image,
3975              int write_flags,
3976              unsigned num_threads,
3977              wimlib_progress_func_t progress_func);
3978
3979 /**
3980  * @ingroup G_writing_and_overwriting_wims
3981  *
3982  * Since wimlib v1.5.0:  Same as wimlib_write(), but write the WIM directly to a
3983  * file descriptor, which need not be seekable if the write is done in a special
3984  * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3985  * write_flags.  This can, for example, allow capturing a WIM image and
3986  * streaming it over the network.  See the documentation for
3987  * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3988  *
3989  * The file descriptor @p fd will @b not be closed when the write is complete;
3990  * the calling code is responsible for this.
3991  *
3992  * Returns 0 on success; nonzero on failure.  The possible error codes include
3993  * those that can be returned by wimlib_write() as well as the following:
3994  *
3995  * @retval ::WIMLIB_ERR_INVALID_PARAM
3996  *      @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
3997  *      specified in @p write_flags.
3998  */
3999 extern int
4000 wimlib_write_to_fd(WIMStruct *wim,
4001                    int fd,
4002                    int image,
4003                    int write_flags,
4004                    unsigned num_threads,
4005                    wimlib_progress_func_t progress_func);
4006
4007 /**
4008  * @defgroup G_compression Compression and decompression functions
4009  *
4010  * @brief Functions for LZX, XPRESS, and LZMS compression and decompression,
4011  * exported for convenience only, as they are already used by wimlib internally
4012  * when appropriate.
4013  *
4014  * These functions can be used for general-purpose lossless data compression,
4015  * but some limitations apply; for example, none of the compressors or
4016  * decompressors currently support sliding windows, and there also exist
4017  * slightly different variants of these formats that are not supported
4018  * unmodified.
4019  *
4020  * @{
4021  */
4022
4023 /** Header for compression parameters to pass to wimlib_create_compressor() or
4024  * wimlib_set_default_compressor_params().  */
4025 struct wimlib_compressor_params_header {
4026         /** Size of the parameters, in bytes.  */
4027         uint32_t size;
4028 };
4029
4030 /** Header for decompression parameters to pass to wimlib_create_decompressor()
4031  * or wimlib_set_default_decompressor_params() */
4032 struct wimlib_decompressor_params_header {
4033         /** Size of the parameters, in bytes.  */
4034         uint32_t size;
4035 };
4036
4037 /** LZX compression parameters that can optionally be passed to
4038  * wimlib_create_compressor() with the compression type
4039  * ::WIMLIB_COMPRESSION_TYPE_LZX.  */
4040 struct wimlib_lzx_compressor_params {
4041         /** hdr.size Must be set to the size of this structure, in bytes.  */
4042         struct wimlib_compressor_params_header hdr;
4043
4044         /** Relatively fast LZX compression algorithm with a decent compression
4045          * ratio; the suggested default.  */
4046 #define WIMLIB_LZX_ALGORITHM_FAST 0
4047
4048         /** Slower LZX compression algorithm that provides a better compression
4049          * ratio.  */
4050 #define WIMLIB_LZX_ALGORITHM_SLOW 1
4051
4052         /** Algorithm to use to perform the compression: either
4053          * ::WIMLIB_LZX_ALGORITHM_FAST or ::WIMLIB_LZX_ALGORITHM_SLOW.  The
4054          * format is still LZX; this refers to the method the code will use to
4055          * perform LZX-compatible compression.  */
4056         uint32_t algorithm : 3;
4057
4058         /** If set to 1, the default parameters for the specified algorithm are
4059          * used rather than the ones specified in the following union.  */
4060         uint32_t use_defaults : 1;
4061
4062         union {
4063                 /** Parameters for the fast algorithm.  */
4064                 struct wimlib_lzx_fast_params {
4065                         uint32_t fast_reserved1[10];
4066                 } fast;
4067
4068                 /** Parameters for the slow algorithm.  */
4069                 struct wimlib_lzx_slow_params {
4070                         /** If set to 1, the compressor can output length 2
4071                          * matches.  If set 0, the compressor only outputs
4072                          * matches of length 3 or greater.  Suggested value: 1
4073                          */
4074                         uint32_t use_len2_matches : 1;
4075
4076                         uint32_t slow_reserved1 : 31;
4077
4078                         /** Matches with length (in bytes) greater than or equal
4079                          * to this value are immediately taken without spending
4080                          * time on minimum-cost measurements.  Suggested value:
4081                          * 32.  */
4082                         uint32_t nice_match_length;
4083
4084                         /** Number of passes to compute a match/literal sequence
4085                          * for each LZX block.  This is for an iterative
4086                          * algorithm that attempts to minimize the cost of the
4087                          * match/literal sequence by using a cost model provided
4088                          * by the previous iteration.  Must be at least 1.
4089                          * Suggested value: 2.  */
4090                         uint32_t num_optim_passes;
4091
4092                         /** Reserved; set to 0.  */
4093                         uint32_t slow_reserved_blocksplit;
4094
4095                         /** Maximum depth to search for matches at each
4096                          * position.  Suggested value: 50.  */
4097                         uint32_t max_search_depth;
4098
4099                         /** Maximum number of potentially good matches to
4100                          * consider for each position.  Suggested value: 3.  */
4101                         uint32_t max_matches_per_pos;
4102
4103                         uint32_t slow_reserved2[2];
4104
4105                         /** Assumed cost of a main symbol with zero frequency.
4106                          * Must be at least 1 and no more than 16.  Suggested
4107                          * value: 15.  */
4108                         uint8_t main_nostat_cost;
4109
4110                         /** Assumed cost of a length symbol with zero frequency.
4111                          * Must be at least 1 and no more than 16.  Suggested
4112                          * value: 15.  */
4113                         uint8_t len_nostat_cost;
4114
4115                         /** Assumed cost of an aligned symbol with zero
4116                          * frequency.  Must be at least 1 and no more than 8.
4117                          * Suggested value: 7.  */
4118                         uint8_t aligned_nostat_cost;
4119
4120                         uint8_t slow_reserved3[5];
4121                 } slow;
4122         } alg_params;
4123 };
4124
4125 /** LZMS compression parameters that can optionally be passed to
4126  * wimlib_create_compressor() with the compression type
4127  * ::WIMLIB_COMPRESSION_TYPE_LZMS.  */
4128 struct wimlib_lzms_compressor_params {
4129         /** hdr.size Must be set to the size of this structure, in bytes.  */
4130         struct wimlib_compressor_params_header hdr;
4131
4132         /** Minimum match length to output.  This must be at least 2.  Suggested
4133          * value: 2  */
4134         uint32_t min_match_length;
4135
4136         /** Maximum match length to output.  This must be at least @p
4137          * min_match_length.  Suggested value: @p UINT32_MAX.  */
4138         uint32_t max_match_length;