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