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