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