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