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