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