c1c00e42dc66d70104128d6e4c441b1cc2c313dd
[wimlib] / include / wimlib.h
1 /*
2  * wimlib.h
3  *
4  * External header for wimlib.
5  *
6  * This file contains extensive comments for generating documentation with
7  * Doxygen.  The built HTML documentation can be viewed at
8  * http://wimlib.sourceforge.net.
9  */
10
11 /*
12  * Copyright (C) 2012, 2013 Eric Biggers
13  *
14  * This file is part of wimlib, a library for working with WIM files.
15  *
16  * wimlib is free software; you can redistribute it and/or modify it under the
17  * terms of the GNU General Public License as published by the Free
18  * Software Foundation; either version 3 of the License, or (at your option)
19  * any later version.
20  *
21  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
22  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
23  * A PARTICULAR PURPOSE. See the GNU General Public License for more
24  * details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with wimlib; if not, see http://www.gnu.org/licenses/.
28  */
29
30 /** \mainpage
31  *
32  * \section intro Introduction
33  *
34  * This is the documentation for the library interface of wimlib 1.4.1, a C
35  * library for creating, modifying, extracting, and mounting files in the
36  * Windows Imaging Format.  This documentation is intended for developers only.
37  * If you have installed wimlib and want to know how to use the @b wimlib-imagex
38  * program, please see the README file.
39  *
40  * \section starting Getting Started
41  *
42  * wimlib uses the GNU autotools, so, on UNIX systems, it should be easy to
43  * install with <code>configure && make && sudo make install</code>; however,
44  * please see the README for more information about installing it.  To use
45  * wimlib in a program after installing it, include @c wimlib.h and link your
46  * program with @c -lwim.
47  *
48  * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.  A ::WIMStruct
49  * may represent either a stand-alone WIM or one part of a split WIM.
50  *
51  * All functions in wimlib's public API are prefixed with @c wimlib.  Most
52  * return 0 on success and a positive error code on failure.  Use
53  * wimlib_get_error_string() to get a string that describes an error code.
54  * wimlib also can print error messages itself when an error happens, and these
55  * may be more informative than the error code; to enable this, call
56  * wimlib_set_print_errors().  Please note that this is for convenience only,
57  * and some errors can occur without a message being printed.
58  *
59  * First before calling any other functions, you should call
60  * wimlib_global_init() to initialize the library.
61  *
62  * To open an existing WIM, use wimlib_open_wim().
63  *
64  * To create a new WIM that initially contains no images, use
65  * wimlib_create_new_wim().
66  *
67  * To add an image to a WIM file from a directory tree on your filesystem, call
68  * wimlib_add_image().  This can be done with a ::WIMStruct gotten from
69  * wimlib_open_wim() or from wimlib_create_new_wim().  On UNIX,
70  * wimlib_add_image() can also capture a WIM image directly from a block device
71  * containing a NTFS filesystem.
72  *
73  * To extract an image from a WIM file, call wimlib_extract_image().  This can
74  * be done either to a directory, or, on UNIX, directly to a block device
75  * containing a NTFS filesystem.
76  *
77  * To extract individual files or directories from a WIM image, rather than a
78  * full image, call wimlib_extract_files().
79  *
80  * To programatically make changes to a WIM image without mounting it, call
81  * wimlib_update_image().
82  *
83  * On UNIX, wimlib supports mounting WIM files either read-only or read-write.
84  * Mounting is done using wimlib_mount_image() and unmounting is done using
85  * wimlib_unmount_image().  Mounting can be done without root privileges because
86  * it is implemented using FUSE (Filesystem in Userspace).  If wimlib is
87  * compiled with the <code>--without-fuse</code> flag, these functions will be
88  * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
89  *
90  * After creating or modifying a WIM file, you can write it to a file using
91  * wimlib_write().  Alternatively,  if the WIM was originally read from a file
92  * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
93  * wimlib_overwrite() to overwrite the original file.
94  *
95  * Please note: merely by calling wimlib_add_image() or many of the other
96  * functions in this library that operate on ::WIMStruct's, you are @b not
97  * modifying the WIM file on disk.  Changes are not saved until you explicitly
98  * call wimlib_write() or wimlib_overwrite().
99  *
100  * After you are done with the WIM file, use wimlib_free() to free all memory
101  * associated with a ::WIMStruct and close all files associated with it.
102  *
103  * When you are completely done with using wimlib in your program, you should
104  * call wimlib_global_cleanup().
105  *
106  * A number of functions take a pointer to a progress function of type
107  * ::wimlib_progress_func_t.  This function will be called periodically during
108  * the WIM operation(s) to report on the progress of the operation (for example,
109  * how many bytes have been written so far).
110  *
111  * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
112  * the following exceptions:
113  * - You must call wimlib_global_init() in one thread before calling any other
114  *   functions.
115  * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
116  *   race conditions with one-time allocations of memory.
117  * - wimlib_mount_image(), while it can be used to mount multiple WIMs
118  *   concurrently in the same process, will daemonize the entire process when it
119  *   does so for the first time.  This includes changing the working directory
120  *   to the root directory.
121  *
122  * \section encodings Locales and character encodings
123  *
124  * To support Windows as well as UNIX, wimlib's API typically takes and returns
125  * strings of ::wimlib_tchar, which are in a platform-dependent encoding.
126  *
127  * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
128  * and the encoding is UTF-16LE.
129  *
130  * On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the
131  * encoding is the locale-dependent multibyte encoding.  I recommend you set
132  * your locale to a UTF-8 capable locale to avoid any issues.  Also, by default,
133  * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
134  * wimlib_global_init() after having set your desired locale.
135  *
136  * \section Limitations
137  *
138  * This section documents some technical limitations of wimlib not already
139  * documented in the man page for @b wimlib-imagex.
140  *
141  * - The old WIM format from Vista pre-releases is not supported.
142  * - Compressed resource chunk sizes other than 32768 are not supported.  This
143  *   doesn't seem to be a real problem because the chunk size always seems to be
144  *   this value.
145  * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
146  *   functionality other than that already present in @b ImageX, that allows you
147  *   to make certain Windows-specific modifications to a Windows PE image, such
148  *   as adding a driver or Windows component.  Such a tool possibly could be
149  *   implemented on top of wimlib.
150  */
151
152 #ifndef _WIMLIB_H
153 #define _WIMLIB_H
154
155 #include <stdio.h>
156 #include <stddef.h>
157 #include <stdbool.h>
158 #include <inttypes.h>
159
160 /** Major version of the library (for example, the 1 in 1.2.5). */
161 #define WIMLIB_MAJOR_VERSION 1
162
163 /** Minor version of the library (for example, the 2 in 1.2.5). */
164 #define WIMLIB_MINOR_VERSION 4
165
166 /** Patch version of the library (for example, the 5 in 1.2.5). */
167 #define WIMLIB_PATCH_VERSION 1
168
169 /**
170  * Opaque structure that represents a WIM file.  This is an in-memory structure
171  * and need not correspond to a specific on-disk file.  However, a ::WIMStruct
172  * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
173  * continuing to exist so that data can be read from it as needed.
174  *
175  * Most functions in this library will work the same way regardless of whether a
176  * given ::WIMStruct was obtained through wimlib_open_wim() or
177  * wimlib_create_new_wim().  Exceptions are documented.
178  *
179  * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
180  * file from a ::WIMStruct.
181  */
182 #ifndef WIMLIB_WIMSTRUCT_DECLARED
183 typedef struct WIMStruct WIMStruct;
184 #define WIMLIB_WIMSTRUCT_DECLARED
185 #endif
186
187 #ifdef __WIN32__
188 typedef wchar_t wimlib_tchar;
189 #else
190 /** See \ref encodings */
191 typedef char wimlib_tchar;
192 #endif
193
194 #ifdef __WIN32__
195 /** Path separator for WIM paths passed back to progress callbacks. */
196 #  define WIMLIB_WIM_PATH_SEPARATOR '\\'
197 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
198 #else
199 /** Path separator for WIM paths passed back to progress callbacks. */
200 #  define WIMLIB_WIM_PATH_SEPARATOR '/'
201 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
202 #endif
203 /**
204  * Specifies the compression type of a WIM file.
205  */
206 enum wimlib_compression_type {
207         /** An invalid compression type. */
208         WIMLIB_COMPRESSION_TYPE_INVALID = -1,
209
210         /** The WIM does not include any compressed resources. */
211         WIMLIB_COMPRESSION_TYPE_NONE = 0,
212
213         /** Compressed resources in the WIM use LZX compression. */
214         WIMLIB_COMPRESSION_TYPE_LZX = 1,
215
216         /** Compressed resources in the WIM use XPRESS compression. */
217         WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
218 };
219
220 /** Possible values of the first parameter to the user-supplied
221  * ::wimlib_progress_func_t progress function */
222 enum wimlib_progress_msg {
223
224         /** A WIM image is about to be extracted.  @a info will point to
225          * ::wimlib_progress_info.extract. */
226         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
227
228         /** A file or directory tree within a WIM image (not the full image) is
229          * about to be extracted.  @a info will point to
230          * ::wimlib_progress_info.extract. */
231         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
232
233         /** The directory structure of the WIM image is about to be extracted.
234          * @a info will point to ::wimlib_progress_info.extract. */
235         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
236
237         /** The directory structure of the WIM image has been successfully
238          * extracted.  @a info will point to ::wimlib_progress_info.extract. */
239         WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
240
241         /** The WIM image's files resources are currently being extracted.  @a
242          * info will point to ::wimlib_progress_info.extract. */
243         WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
244
245         /** A file or directory is being extracted.  @a info will point to
246          * ::wimlib_progress_info.extract, and the @a cur_path member will be
247          * valid. */
248         WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
249
250         /** All the WIM files and directories have been extracted, and
251          * timestamps are about to be applied.  @a info will point to
252          * ::wimlib_progress_info.extract. */
253         WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
254
255         /** A WIM image has been successfully extracted.  @a info will point to
256          * ::wimlib_progress_info.extract. */
257         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
258
259         /** A file or directory tree within a WIM image (not the full image) has
260          * been successfully extracted.  @a info will point to
261          * ::wimlib_progress_info.extract. */
262         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
263
264         /** The directory or NTFS volume is about to be scanned to build a tree
265          * of WIM dentries in-memory.  @a info will point to
266          * ::wimlib_progress_info.scan. */
267         WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
268
269         /** A directory or file is being scanned.  @a info will point to
270          * ::wimlib_progress_info.scan, and its @a cur_path member will be
271          * valid.  This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
272          * is passed to wimlib_add_image(). */
273         WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
274
275         /** The directory or NTFS volume has been successfully scanned, and a
276          * tree of WIM dentries has been built in-memory. @a info will point to
277          * ::wimlib_progress_info.scan. */
278         WIMLIB_PROGRESS_MSG_SCAN_END,
279
280         /**
281          * File resources are currently being written to the WIM.
282          * @a info will point to ::wimlib_progress_info.write_streams. */
283         WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
284
285         /**
286          * The metadata resource for each image is about to be written to the
287          * WIM. @a info will not be valid. */
288         WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
289
290         /**
291          * The metadata resource for each image has successfully been writen to
292          * the WIM.  @a info will not be valid. */
293         WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
294
295         /**
296          * The temporary file has successfully been renamed to the original WIM
297          * file.  Only happens when wimlib_overwrite() is called and the
298          * overwrite is not done in-place.
299          * @a info will point to ::wimlib_progress_info.rename. */
300         WIMLIB_PROGRESS_MSG_RENAME,
301
302         /** The contents of the WIM are being checked against the integrity
303          * table.  Only happens when wimlib_open_wim() is called with the
304          * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag.  @a info will point to
305          * ::wimlib_progress_info.integrity. */
306         WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
307
308         /** An integrity table is being calculated for the WIM being written.
309          * Only happens when wimlib_write() or wimlib_overwrite() is called with
310          * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag.  @a info will point to
311          * ::wimlib_progress_info.integrity. */
312         WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
313
314         /** A wimlib_join() operation is in progress.  @a info will point to
315          * ::wimlib_progress_info.join. */
316         WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
317
318         /** A wimlib_split() operation is in progress, and a new split part is
319          * about to be started.  @a info will point to
320          * ::wimlib_progress_info.split. */
321         WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
322
323         /** A wimlib_split() operation is in progress, and a split part has been
324          * finished. @a info will point to ::wimlib_progress_info.split. */
325         WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
326
327         /**
328          * A WIM update command is just about to be executed; @a info will point
329          * to ::wimlib_progress_info.update.
330          */
331         WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
332
333         /**
334          * A WIM update command has just been executed; @a info will point to
335          * ::wimlib_progress_info.update.
336          */
337         WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
338
339 };
340
341 /** A pointer to this union is passed to the user-supplied
342  * ::wimlib_progress_func_t progress function.  One (or none) of the structures
343  * contained in this union will be applicable for the operation
344  * (::wimlib_progress_msg) indicated in the first argument to the progress
345  * function. */
346 union wimlib_progress_info {
347
348         /* N.B. I wanted these to be anonymous structs, but Doxygen won't
349          * document them if they aren't given a name... */
350
351         /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
352         struct wimlib_progress_info_write_streams {
353                 /** Number of bytes that are going to be written for all the
354                  * streams combined.  This is the amount in uncompressed data.
355                  * (The actual number of bytes will be less if the data is being
356                  * written compressed.) */
357                 uint64_t total_bytes;
358                 /** Number of streams that are going to be written. */
359                 uint64_t total_streams;
360
361                 /** Number of uncompressed bytes that have been written so far.
362                  * Will be 0 initially, and equal to @a total_bytes at the end.
363                  * */
364                 uint64_t completed_bytes;
365
366                 /** Number of streams that have been written.  Will be 0
367                  * initially, and equal to @a total_streams at the end. */
368                 uint64_t completed_streams;
369
370                 /** Number of threads that are being used to compress resources
371                  * (if applicable). */
372                 unsigned num_threads;
373
374                 /** The compression type being used to write the streams; either
375                  * ::WIMLIB_COMPRESSION_TYPE_NONE,
376                  * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
377                  * ::WIMLIB_COMPRESSION_TYPE_LZX. */
378                 int      compression_type;
379
380                 /** Library internal use only. */
381                 uint64_t _private;
382         } write_streams;
383
384         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
385          * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
386         struct wimlib_progress_info_scan {
387                 /** Directory or NTFS volume that is being scanned. */
388                 const wimlib_tchar *source;
389
390                 /** Path to the file or directory that is about to be scanned,
391                  * relative to the root of the image capture or the NTFS volume.
392                  * */
393                 const wimlib_tchar *cur_path;
394
395                 /** True iff @a cur_path is being excluded from the image
396                  * capture due to the capture configuration file. */
397                 bool excluded;
398
399                 /** Target path in the WIM.  Only valid on messages
400                  * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
401                  * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
402                 const wimlib_tchar *wim_target_path;
403         } scan;
404
405         /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
406          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
407          * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
408          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
409          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
410         struct wimlib_progress_info_extract {
411                 /** Number of the image being extracted (1-based). */
412                 int image;
413
414                 /** Flags passed to to wimlib_extract_image() */
415                 int extract_flags;
416
417                 /** Full path to the WIM file being extracted. */
418                 const wimlib_tchar *wimfile_name;
419
420                 /** Name of the image being extracted. */
421                 const wimlib_tchar *image_name;
422
423                 /** Directory or NTFS volume to which the image is being
424                  * extracted. */
425                 const wimlib_tchar *target;
426
427                 /** Current dentry being extracted.  (Valid only if message is
428                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
429                 const wimlib_tchar *cur_path;
430
431                 /** Number of bytes of uncompressed data that will be extracted.
432                  * Takes into account hard links (they are not counted for each
433                  * link.)
434                  * */
435                 uint64_t total_bytes;
436
437                 /** Number of bytes that have been written so far.  Will be 0
438                  * initially, and equal to @a total_bytes at the end. */
439                 uint64_t completed_bytes;
440
441                 /** Number of streams that will be extracted.  This may more or
442                  * less than the number of "files" to be extracted due to
443                  * special cases (hard links, symbolic links, and alternate data
444                  * streams.) */
445                 uint64_t num_streams;
446
447                 /** Path to the root dentry within the WIM for the tree that is
448                  * being extracted.  Will be the empty string when extracting a
449                  * full image. */
450                 const wimlib_tchar *extract_root_wim_source_path;
451         } extract;
452
453         /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
454         struct wimlib_progress_info_rename {
455                 /** Name of the temporary file that the WIM was written to. */
456                 const wimlib_tchar *from;
457
458                 /** Name of the original WIM file to which the temporary file is
459                  * being renamed. */
460                 const wimlib_tchar *to;
461         } rename;
462
463         /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
464          * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
465         struct wimlib_progress_info_update {
466                 /** Pointer to the update command that will be executed or has
467                  * just been executed. */
468                 const struct wimlib_update_command *command;
469
470                 /** Number of update commands that have been completed so far.
471                  */
472                 size_t completed_commands;
473
474                 /** Number of update commands that are being executed as part of
475                  * this call to wimlib_update_image(). */
476                 size_t total_commands;
477         } update;
478
479         /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
480          * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
481         struct wimlib_progress_info_integrity {
482                 /** Number of bytes from the end of the WIM header to the end of
483                  * the lookup table (the area that is covered by the SHA1
484                  * integrity checks.) */
485                 uint64_t total_bytes;
486
487                 /** Number of bytes that have been SHA1-summed so far.  Will be
488                  * 0 initially, and equal @a total_bytes at the end. */
489                 uint64_t completed_bytes;
490
491                 /** Number of chunks that the checksummed region is divided
492                  * into. */
493                 uint32_t total_chunks;
494
495                 /** Number of chunks that have been SHA1-summed so far.   Will
496                  * be 0 initially, and equal to @a total_chunks at the end. */
497                 uint32_t completed_chunks;
498
499                 /** Size of the chunks used for the integrity calculation. */
500                 uint32_t chunk_size;
501
502                 /** Filename of the WIM (only valid if the message is
503                  * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
504                 const wimlib_tchar *filename;
505         } integrity;
506
507         /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
508         struct wimlib_progress_info_join {
509                 /** Total number of bytes of compressed data contained in all
510                  * the split WIM part's file and metadata resources. */
511                 uint64_t total_bytes;
512
513                 /** Number of bytes that have been copied to the joined WIM so
514                  * far.  Will be 0 initially, and equal to @a total_bytes at the
515                  * end. */
516                 uint64_t completed_bytes;
517
518                 /** Number of split WIM parts that have had all their file and
519                  * metadata resources copied over to the joined WIM so far. */
520                 unsigned completed_parts;
521
522                 /** Number of split WIM parts. */
523                 unsigned total_parts;
524         } join;
525
526         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
527          * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
528         struct wimlib_progress_info_split {
529                 /** Total size of the original WIM's file and metadata resources
530                  * (compressed). */
531                 uint64_t total_bytes;
532
533                 /** Number of bytes of file and metadata resources that have
534                  * been copied out of the original WIM so far.  Will be 0
535                  * initially, and equal to @a total_bytes at the end. */
536                 uint64_t completed_bytes;
537
538                 /** Number of the split WIM part that is about to be started
539                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
540                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
541                 unsigned cur_part_number;
542
543                 /** Name of the split WIM part that is about to be started
544                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
545                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
546                 const wimlib_tchar *part_name;
547         } split;
548 };
549
550 /** A user-supplied function that will be called periodically during certain WIM
551  * operations.  The first argument will be the type of operation that is being
552  * performed or is about to be started or has been completed.  The second
553  * argument will be a pointer to one of a number of structures depending on the
554  * first argument.  It may be @c NULL for some message types.
555  *
556  * The return value of the progress function is currently ignored, but it may do
557  * something in the future.  (Set it to 0 for now.)
558  */
559 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
560                                       const union wimlib_progress_info *info);
561
562 /** An array of these structures is passed to wimlib_add_image_multisource() to
563  * specify the sources from which to create a WIM image. */
564 struct wimlib_capture_source {
565         /** Absolute or relative path to a file or directory on the external
566          * filesystem to be included in the WIM image. */
567         wimlib_tchar *fs_source_path;
568
569         /** Destination path in the WIM image.  Leading and trailing slashes are
570          * ignored.  The empty string or @c NULL means the root directory of the
571          * WIM image. */
572         wimlib_tchar *wim_target_path;
573
574         /** Reserved; set to 0. */
575         long reserved;
576 };
577
578 /** Structure that specifies a list of path patterns. */
579 struct wimlib_pattern_list {
580         /** Array of patterns.  The patterns may be modified by library code,
581          * but the @a pats pointer itself will not.  See the man page for
582          * <b>wimlib-imagex capture</b> for more information about allowed
583          * patterns. */
584         wimlib_tchar **pats;
585
586         /** Number of patterns in the @a pats array. */
587         size_t num_pats;
588
589         /** Ignored; may be used by the calling code. */
590         size_t num_allocated_pats;
591 };
592
593 /** A structure that contains lists of wildcards that match paths to treat
594  * specially when capturing a WIM image. */
595 struct wimlib_capture_config {
596         /** Paths matching any pattern this list are excluded from being
597          * captured, except if the same path appears in @a
598          * exclusion_exception_pats. */
599         struct wimlib_pattern_list exclusion_pats;
600
601         /** Paths matching any pattern in this list are never excluded from
602          * being captured. */
603         struct wimlib_pattern_list exclusion_exception_pats;
604
605         /** Reserved for future capture configuration options. */
606         struct wimlib_pattern_list reserved1;
607
608         /** Reserved for future capture configuration options. */
609         struct wimlib_pattern_list reserved2;
610
611         /** Library internal use only. */
612         const wimlib_tchar *_prefix;
613
614         /** Library internal use only. */
615         size_t _prefix_num_tchars;
616 };
617
618
619 /*****************************
620  * WIMLIB_ADD_FLAG_*
621  *****************************/
622
623 /** Directly capture a NTFS volume rather than a generic directory.  This flag
624  * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
625  * ::WIMLIB_ADD_FLAG_UNIX_DATA.   */
626 #define WIMLIB_ADD_FLAG_NTFS                    0x00000001
627
628 /** Follow symlinks; archive and dump the files they point to.  Cannot be used
629  * with ::WIMLIB_ADD_FLAG_NTFS. */
630 #define WIMLIB_ADD_FLAG_DEREFERENCE             0x00000002
631
632 /** Call the progress function with the message
633  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
634  * be scanned. */
635 #define WIMLIB_ADD_FLAG_VERBOSE                 0x00000004
636
637 /** Mark the image being added as the bootable image of the WIM. */
638 #define WIMLIB_ADD_FLAG_BOOT                    0x00000008
639
640 /** Store the UNIX owner, group, and mode.  This is done by adding a special
641  * alternate data stream to each regular file, symbolic link, and directory to
642  * contain this information.  Please note that this flag is for convenience
643  * only; Microsoft's @a imagex.exe will not understand this special information.
644  * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS.  */
645 #define WIMLIB_ADD_FLAG_UNIX_DATA                       0x00000010
646
647 /** Do not capture security descriptors.  Only has an effect in NTFS capture
648  * mode, or in Win32 native builds. */
649 #define WIMLIB_ADD_FLAG_NO_ACLS                 0x00000020
650
651 /** Fail immediately if the full security descriptor of any file or directory
652  * cannot be accessed.  Only has an effect in Win32 native builds.  The default
653  * behavior without this flag is to first try omitting the SACL from the
654  * security descriptor, then to try omitting the security descriptor entirely.
655  * */
656 #define WIMLIB_ADD_FLAG_STRICT_ACLS             0x00000040
657
658 /** Call the progress function with the message
659  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
660  * capture.  This is a subset of the messages provided by
661  * ::WIMLIB_ADD_FLAG_VERBOSE. */
662 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE         0x00000080
663
664 /** Reparse-point fixups:  Modify absolute symbolic links (or junction points,
665  * in the case of Windows) that point inside the directory being captured to
666  * instead be absolute relative to the directory being captured, rather than the
667  * current root; also exclude absolute symbolic links that point outside the
668  * directory tree being captured.
669  *
670  * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
671  * the WIM header or if this is the first image being added.
672  * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
673  * reparse point fixups enabled and currently cannot be unset. */
674 #define WIMLIB_ADD_FLAG_RPFIX                   0x00000100
675
676 /** Don't do reparse point fixups.  The default behavior is described in the
677  * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
678 #define WIMLIB_ADD_FLAG_NORPFIX                 0x00000200
679
680 #define WIMLIB_ADD_IMAGE_FLAG_NTFS              WIMLIB_ADD_FLAG_NTFS
681 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       WIMLIB_ADD_FLAG_DEREFERENCE
682 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           WIMLIB_ADD_FLAG_VERBOSE
683 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              WIMLIB_ADD_FLAG_BOOT
684 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA         WIMLIB_ADD_FLAG_UNIX_DATA
685 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS           WIMLIB_ADD_FLAG_NO_ACLS
686 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS       WIMLIB_ADD_FLAG_STRICT_ACLS
687 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE   WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
688 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX             WIMLIB_ADD_FLAG_RPFIX
689 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX           WIMLIB_ADD_FLAG_NORPFIX
690
691 /******************************
692  * WIMLIB_DELETE_FLAG_*
693  ******************************/
694
695 /** Do not issue an error if the path to delete does not exist. */
696 #define WIMLIB_DELETE_FLAG_FORCE                        0x00000001
697
698 /** Delete the file or directory tree recursively; if not specified, an error is
699  * issued if the path to delete is a directory. */
700 #define WIMLIB_DELETE_FLAG_RECURSIVE                    0x00000002
701
702 /******************************
703  * WIMLIB_EXPORT_FLAG_*
704  ******************************/
705
706 /** See documentation for wimlib_export_image(). */
707 #define WIMLIB_EXPORT_FLAG_BOOT                         0x00000001
708
709 /******************************
710  * WIMLIB_EXTRACT_FLAG_*
711  ******************************/
712
713 /** Extract the image directly to a NTFS volume rather than a generic directory.
714  * */
715 #define WIMLIB_EXTRACT_FLAG_NTFS                        0x00000001
716
717 /** When identical files are extracted from the WIM, always hard link them
718  * together.  Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
719 #define WIMLIB_EXTRACT_FLAG_HARDLINK                    0x00000002
720
721 /** When identical files are extracted from the WIM, always symlink them
722  * together.  Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
723 #define WIMLIB_EXTRACT_FLAG_SYMLINK                     0x00000004
724
725 /** Call the progress function with the argument
726  * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
727  * extracted.  Note: these calls will be interspersed with calls for the message
728  * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
729 #define WIMLIB_EXTRACT_FLAG_VERBOSE                     0x00000008
730
731 /** Read the WIM file sequentially while extracting the image. */
732 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL                  0x00000010
733
734 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
735  * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
736 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA                   0x00000020
737
738 /** Do not extract security descriptors.  Only has an effect in NTFS apply mode,
739  * or in Win32 native builds. */
740 #define WIMLIB_EXTRACT_FLAG_NO_ACLS                     0x00000040
741
742 /** Fail immediately if the full security descriptor of any file or directory
743  * cannot be set exactly as specified in the WIM file.  The default behavior
744  * without this flag is to fall back to setting the security descriptor with the
745  * SACL omitted, then only the default inherited security descriptor, if we do
746  * not have permission to set the desired one. */
747 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS                 0x00000080
748
749 /* Extract equivalent to ::WIMLIB_ADD_FLAG_RPFIX; force reparse-point
750  * fixups on, so absolute symbolic links or junction points will be fixed to be
751  * absolute relative to the actual extraction root.  Done by default if
752  * WIM_HDR_FLAG_RP_FIX is set in the WIM header.  This flag may only be
753  * specified when extracting a full image. */
754 #define WIMLIB_EXTRACT_FLAG_RPFIX                       0x00000100
755
756 /** Force reparse-point fixups on extraction off, regardless of the state of the
757  * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
758 #define WIMLIB_EXTRACT_FLAG_NORPFIX                     0x00000200
759
760 /** Extract files to standard output rather than to the filesystem. */
761 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT                   0x00000400
762
763 /** Instead of ignoring files and directories with names that cannot be
764  * represented on the current platform (note: Windows has more restrictions on
765  * filenames than UNIX), try to replace characters or append junk to the names
766  * so that they can be extracted in some form. */
767 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES   0x00000800
768
769 /** On Windows, when there exist two or more files with the same case
770  * insensitive name but different case sensitive names, try to extract them all
771  * by appending junk to the end of them, rather than arbitrarily extracting only
772  * one. */
773 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS          0x00001000
774
775 /******************************
776  * WIMLIB_MOUNT_FLAG_*
777  ******************************/
778
779 /** Mount the WIM image read-write rather than the default of read-only. */
780 #define WIMLIB_MOUNT_FLAG_READWRITE                     0x00000001
781
782 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
783 #define WIMLIB_MOUNT_FLAG_DEBUG                         0x00000002
784
785 /** Do not allow accessing alternate data streams in the mounted WIM image. */
786 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000004
787
788 /** Access alternate data streams in the mounted WIM image through extended file
789  * attributes.  This is the default mode. */
790 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000008
791
792 /** Access alternate data streams in the mounted WIM image by specifying the
793  * file name, a colon, then the alternate file stream name. */
794 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000010
795
796 /** Use UNIX file owners, groups, and modes if available in the WIM (see
797  * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
798 #define WIMLIB_MOUNT_FLAG_UNIX_DATA                     0x00000020
799
800 /** Allow other users to see the mounted filesystem.  (this passes the @c
801  * allow_other option to FUSE mount) */
802 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER                   0x00000040
803
804 /******************************
805  * WIMLIB_OPEN_FLAG_*
806  ******************************/
807
808 /** Verify the WIM contents against the WIM's integrity table, if present. */
809 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY                0x00000001
810
811 /** Do not issue an error if the WIM is part of a split WIM. */
812 #define WIMLIB_OPEN_FLAG_SPLIT_OK                       0x00000002
813
814 /******************************
815  * WIMLIB_UNMOUNT_FLAG_*
816  ******************************/
817
818 /** Include an integrity table in the WIM after it's been unmounted.  Ignored
819  * for read-only mounts. */
820 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY             0x00000001
821
822 /** Unless this flag is given, changes to a read-write mounted WIM are
823  * discarded.  Ignored for read-only mounts. */
824 #define WIMLIB_UNMOUNT_FLAG_COMMIT                      0x00000002
825
826 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
827 #define WIMLIB_UNMOUNT_FLAG_REBUILD                     0x00000004
828
829 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
830 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS                  0x00000008
831
832 /** Do a "lazy" unmount (detach filesystem immediately, even if busy) */
833 #define WIMLIB_UNMOUNT_FLAG_LAZY                        0x00000010
834
835 /******************************
836  * WIMLIB_UPDATE_FLAG_*
837  ******************************/
838
839 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
840  * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
841 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS                0x00000001
842
843 /******************************
844  * WIMLIB_WRITE_FLAG_*
845  ******************************/
846
847 /** Include an integrity table in the new WIM file. */
848 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY               0x00000001
849
850 /** Re-build the entire WIM file rather than appending data to it, if possible.
851  * (Applies to wimlib_overwrite(), not wimlib_write()). */
852 #define WIMLIB_WRITE_FLAG_REBUILD                       0x00000002
853
854 /** Recompress all resources, even if they could otherwise be copied from a
855  * different WIM with the same compression type (in the case of
856  * wimlib_export_image() being called previously). */
857 #define WIMLIB_WRITE_FLAG_RECOMPRESS                    0x00000004
858
859 /** Call fsync() when the WIM file is closed */
860 #define WIMLIB_WRITE_FLAG_FSYNC                         0x00000008
861
862 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
863  * after one or more calls to wimlib_delete_image(), which is to rebuild the
864  * entire WIM.
865  *
866  * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
867  * correctly remove the image from the WIM will be taken.  In particular, all
868  * streams will be left alone, even if they are no longer referenced.  This is
869  * probably not what you want, because almost no space will be spaced by
870  * deleting an image in this way. */
871 #define WIMLIB_WRITE_FLAG_SOFT_DELETE                   0x00000010
872
873 /******************************
874  * WIMLIB_INIT_FLAG_*
875  ******************************/
876
877 /** Assume that strings are represented in UTF-8, even if this is not the
878  * locale's character encoding. */
879 #define WIMLIB_INIT_FLAG_ASSUME_UTF8                    0x00000001
880
881 /** Specification of an update to perform on a WIM image. */
882 struct wimlib_update_command {
883
884         /** The specific type of update to perform. */
885         enum wimlib_update_op {
886                 /** Add a new file or directory tree to the WIM image in a
887                  * certain location. */
888                 WIMLIB_UPDATE_OP_ADD = 0,
889
890                 /** Delete a file or directory tree from the WIM image. */
891                 WIMLIB_UPDATE_OP_DELETE,
892
893                 /** Rename a file or directory tree in the WIM image. */
894                 WIMLIB_UPDATE_OP_RENAME,
895         } op;
896         union {
897                 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
898                 struct wimlib_add_command {
899                         /** Filesystem path to the file or directory tree to
900                          * add. */
901                         wimlib_tchar *fs_source_path;
902                         /** Path, specified from the root of the WIM image, at
903                          * which to add the file or directory tree within the
904                          * WIM image. */
905                         wimlib_tchar *wim_target_path;
906
907                         /** Configuration for excluded files.  @c NULL means
908                          * exclude no files. */
909                         struct wimlib_capture_config *config;
910
911                         /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
912                         int add_flags;
913                 } add;
914                 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
915                 struct wimlib_delete_command {
916                         /** Path, specified from the root of the WIM image, for
917                          * the file or directory tree within the WIM image to be
918                          * deleted. */
919                         wimlib_tchar *wim_path;
920                         /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
921                         int delete_flags;
922                 } delete;
923                 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
924                 struct wimlib_rename_command {
925                         /** Path, specified from the root of the WIM image, for
926                          * the source file or directory tree within the WIM
927                          * image. */
928                         wimlib_tchar *wim_source_path;
929                         /** Path, specified from the root of the WIM image, for
930                          * the destination file or directory tree within the WIM
931                          * image. */
932                         wimlib_tchar *wim_target_path;
933                         /** Reserved; set to 0. */
934                         int rename_flags;
935                 } rename;
936         };
937 };
938
939 /** Specification of a file or directory tree to extract from a WIM image. */
940 struct wimlib_extract_command {
941         /** Path to file or directory tree within the WIM image to extract.  It
942          * must be provided as an absolute path from the root of the WIM image.
943          * The path separators may be either forward slashes or backslashes. */
944         wimlib_tchar *wim_source_path;
945
946         /** Filesystem path to extract the file or directory tree to. */
947         wimlib_tchar *fs_dest_path;
948
949         /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
950         int extract_flags;
951 };
952
953 /**
954  * Possible values of the error code returned by many functions in wimlib.
955  *
956  * See the documentation for each wimlib function to see specifically what error
957  * codes can be returned by a given function, and what they mean.
958  */
959 enum wimlib_error_code {
960         WIMLIB_ERR_SUCCESS = 0,
961         WIMLIB_ERR_ALREADY_LOCKED,
962         WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
963         WIMLIB_ERR_DECOMPRESSION,
964         WIMLIB_ERR_DELETE_STAGING_DIR,
965         WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
966         WIMLIB_ERR_FORK,
967         WIMLIB_ERR_FUSE,
968         WIMLIB_ERR_FUSERMOUNT,
969         WIMLIB_ERR_ICONV_NOT_AVAILABLE,
970         WIMLIB_ERR_IMAGE_COUNT,
971         WIMLIB_ERR_IMAGE_NAME_COLLISION,
972         WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT,
973         WIMLIB_ERR_INTEGRITY,
974         WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
975         WIMLIB_ERR_INVALID_CHUNK_SIZE,
976         WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
977         WIMLIB_ERR_INVALID_DENTRY,
978         WIMLIB_ERR_INVALID_HEADER_SIZE,
979         WIMLIB_ERR_INVALID_IMAGE,
980         WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
981         WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
982         WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
983         WIMLIB_ERR_INVALID_OVERLAY,
984         WIMLIB_ERR_INVALID_PARAM,
985         WIMLIB_ERR_INVALID_PART_NUMBER,
986         WIMLIB_ERR_INVALID_REPARSE_DATA,
987         WIMLIB_ERR_INVALID_RESOURCE_HASH,
988         WIMLIB_ERR_INVALID_RESOURCE_SIZE,
989         WIMLIB_ERR_INVALID_SECURITY_DATA,
990         WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
991         WIMLIB_ERR_INVALID_UTF16_STRING,
992         WIMLIB_ERR_INVALID_UTF8_STRING,
993         WIMLIB_ERR_IS_DIRECTORY,
994         WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
995         WIMLIB_ERR_LINK,
996         WIMLIB_ERR_MKDIR,
997         WIMLIB_ERR_MQUEUE,
998         WIMLIB_ERR_NOMEM,
999         WIMLIB_ERR_NOTDIR,
1000         WIMLIB_ERR_NOTEMPTY,
1001         WIMLIB_ERR_NOT_A_REGULAR_FILE,
1002         WIMLIB_ERR_NOT_A_WIM_FILE,
1003         WIMLIB_ERR_NO_FILENAME,
1004         WIMLIB_ERR_NTFS_3G,
1005         WIMLIB_ERR_OPEN,
1006         WIMLIB_ERR_OPENDIR,
1007         WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1008         WIMLIB_ERR_READ,
1009         WIMLIB_ERR_READLINK,
1010         WIMLIB_ERR_RENAME,
1011         WIMLIB_ERR_REOPEN,
1012         WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1013         WIMLIB_ERR_RESOURCE_ORDER,
1014         WIMLIB_ERR_SPECIAL_FILE,
1015         WIMLIB_ERR_SPLIT_INVALID,
1016         WIMLIB_ERR_SPLIT_UNSUPPORTED,
1017         WIMLIB_ERR_STAT,
1018         WIMLIB_ERR_TIMEOUT,
1019         WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1020         WIMLIB_ERR_UNKNOWN_VERSION,
1021         WIMLIB_ERR_UNSUPPORTED,
1022         WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1023         WIMLIB_ERR_WRITE,
1024         WIMLIB_ERR_XML,
1025 };
1026
1027
1028 /** Used to indicate no WIM image or an invalid WIM image. */
1029 #define WIMLIB_NO_IMAGE         0
1030
1031 /** Used to specify all images in the WIM. */
1032 #define WIMLIB_ALL_IMAGES       (-1)
1033
1034 /**
1035  * Appends an empty image to a WIM file.  This empty image will initially
1036  * contain no files or directories, although if written without further
1037  * modifications, a root directory will be created automatically for it.
1038  *
1039  * @param wim
1040  *      Pointer to the ::WIMStruct for the WIM file to which the image is to be
1041  *      added.
1042  * @param name
1043  *      Name to give the new image.  If @c NULL or empty, the new image is given
1044  *      no name.  If nonempty, it must specify a name that does not already
1045  *      exist in @a wim.
1046  * @param new_idx_ret
1047  *      If non-<code>NULL</code>, the index of the newly added image is returned
1048  *      in this location.
1049  *
1050  * @return 0 on success; nonzero on failure.  The possible error codes are:
1051  *
1052  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1053  *      @a wim is part of a split WIM.
1054  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1055  *      There is already an image in @a wim named @a name.
1056  * @retval ::WIMLIB_ERR_NOMEM
1057  *      Failed to allocate the memory needed to add the new image.
1058  */
1059 extern int
1060 wimlib_add_empty_image(WIMStruct *wim,
1061                        const wimlib_tchar *name,
1062                        int *new_idx_ret);
1063
1064 /**
1065  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1066  *
1067  * The directory tree or NTFS volume is scanned immediately to load the dentry
1068  * tree into memory, and file attributes and symbolic links are read.  However,
1069  * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1070  * called.
1071  *
1072  * See the manual page for the @b wimlib-imagex program for more information
1073  * about the "normal" capture mode versus the NTFS capture mode (entered by
1074  * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1075  *
1076  * Note that @b no changes are committed to the underlying WIM file (if
1077  * any) until wimlib_write() or wimlib_overwrite() is called.
1078  *
1079  * @param wim
1080  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
1081  *      added.
1082  * @param source
1083  *      A path to a directory or unmounted NTFS volume that will be captured as
1084  *      a WIM image.
1085  * @param name
1086  *      Name to give the new image.  If @c NULL or empty, the new image is given
1087  *      no name.  If nonempty, it must specify a name that does not already
1088  *      exist in @a wim.
1089  * @param config
1090  *      Capture configuration that specifies files, directories, or path globs
1091  *      to exclude from being captured.  If @c NULL, a dummy configuration where
1092  *      no paths are treated specially is used.
1093  * @param add_flags
1094  *      Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1095  * @param progress_func
1096  *      If non-NULL, a function that will be called periodically with the
1097  *      progress of the current operation.
1098  *
1099  * @return 0 on success; nonzero on error.  On error, changes to @a wim are
1100  * discarded so that it appears to be in the same state as when this function
1101  * was called.
1102  *
1103  * This function is implemented by calling wimlib_add_empty_image(), then
1104  * calling wimlib_update_image() with a single "add" command, so any error code
1105  * returned by wimlib_add_empty_image() may be returned, as well as any error
1106  * codes returned by wimlib_update_image() other than ones documented as only
1107  * being returned specifically by an update involving delete or rename commands.
1108  */
1109 extern int
1110 wimlib_add_image(WIMStruct *wim,
1111                  const wimlib_tchar *source,
1112                  const wimlib_tchar *name,
1113                  const struct wimlib_capture_config *config,
1114                  int add_flags,
1115                  wimlib_progress_func_t progress_func);
1116
1117 /** This function is equivalent to wimlib_add_image() except it allows for
1118  * multiple sources to be combined into a single WIM image.  This is done by
1119  * specifying the @a sources and @a num_sources parameters instead of the @a
1120  * source parameter of wimlib_add_image().  The rest of the parameters are the
1121  * same as wimlib_add_image().  See the documentation for <b>wimlib-imagex
1122  * capture</b> for full details on how this mode works.
1123  *
1124  * In addition to the error codes that wimlib_add_image() can return,
1125  * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1126  * when trying to overlay a non-directory on a directory or when otherwise
1127  * trying to overlay multiple conflicting files to the same location in the WIM
1128  * image.  It will also return ::WIMLIB_ERR_INVALID_PARAM if
1129  * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags but there
1130  * was not exactly one capture source with the target being the root directory.
1131  * (In this respect, there is no advantage to using
1132  * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1133  * NTFS mode.) */
1134 extern int
1135 wimlib_add_image_multisource(WIMStruct *wim,
1136                              const struct wimlib_capture_source *sources,
1137                              size_t num_sources,
1138                              const wimlib_tchar *name,
1139                              const struct wimlib_capture_config *config,
1140                              int add_flags,
1141                              wimlib_progress_func_t progress_func);
1142
1143 /**
1144  * Creates a ::WIMStruct for a new WIM file.
1145  *
1146  * This only creates an in-memory structure for a WIM that initially contains no
1147  * images.  No on-disk file is created until wimlib_write() is called.
1148  *
1149  * @param ctype
1150  *      The type of compression to be used in the new WIM file.  Must be
1151  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1152  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1153  * @param wim_ret
1154  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1155  *      written to the memory location pointed to by this paramater.  The
1156  *      ::WIMStruct must be freed using using wimlib_free() when finished with
1157  *      it.
1158  * @return 0 on success; nonzero on error.
1159  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1160  *      @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1161  *      ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1162  * @retval ::WIMLIB_ERR_NOMEM
1163  *      Failed to allocate needed memory.
1164  */
1165 extern int
1166 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1167
1168 /**
1169  * Deletes an image, or all images, from a WIM file.
1170  *
1171  * All streams referenced by the image(s) being deleted are removed from the
1172  * lookup table of the WIM if they are not referenced by any other images in the
1173  * WIM.
1174  *
1175  * Please note that @b no changes are committed to the underlying WIM file (if
1176  * any) until wimlib_write() or wimlib_overwrite() is called.
1177  *
1178  * @param wim
1179  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1180  *      being deleted.
1181  * @param image
1182  *      The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1183  *      images.
1184  * @return 0 on success; nonzero on failure.  On failure, @a wim is guaranteed
1185  * to be left unmodified only if @a image specified a single image.  If instead
1186  * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1187  * possible for some but not all of the images to have been deleted when a
1188  * failure status is returned.
1189  *
1190  * @retval ::WIMLIB_ERR_DECOMPRESSION
1191  *      Could not decompress the metadata resource for @a image.
1192  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1193  *      A directory entry in the metadata resource for @a image in the WIM is
1194  *      invalid.
1195  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1196  *      @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1197  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1198  *      The metadata resource for @a image in the WIM is invalid.
1199  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1200  *      The security data for @a image in the WIM is invalid.
1201  * @retval ::WIMLIB_ERR_NOMEM
1202  *      Failed to allocate needed memory.
1203  * @retval ::WIMLIB_ERR_READ
1204  *      Could not read the metadata resource for @a image from the WIM.
1205  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1206  *      @a wim is part of a split WIM.  Deleting an image from a split WIM is
1207  *      unsupported.
1208  */
1209 extern int
1210 wimlib_delete_image(WIMStruct *wim, int image);
1211
1212 /**
1213  * Exports an image, or all the images, from a WIM file, into another WIM file.
1214  *
1215  * The destination image is made to share the same dentry tree and security data
1216  * structure as the source image.  This places some restrictions on additional
1217  * functions that may be called.  wimlib_mount_image() may not be called on
1218  * either the source image or the destination image without an intervening call
1219  * to a function that un-shares the images, such as wimlib_free() on @a
1220  * dest_wim, or wimlib_delete_image() on either the source or destination image.
1221  * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1222  * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1223  * have references back to @a src_wim.
1224  *
1225  * If this function fails, all changes to @a dest_wim are rolled back.
1226  *
1227  * No changes shall be made to @a src_wim by this function.
1228  *
1229  * Please note that no changes are committed to the underlying WIM file of @a
1230  * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1231  *
1232  * @param src_wim
1233  *      Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1234  *      WIM that contains the image(s) being exported.
1235  * @param src_image
1236  *      The image to export from @a src_wim.  Can be the number of an image, or
1237  *      ::WIMLIB_ALL_IMAGES to export all images.
1238  * @param dest_wim
1239  *      Pointer to the ::WIMStruct for a WIM file that will receive the images
1240  *      being exported.
1241  * @param dest_name
1242  *      The name to give the exported image in the new WIM file.  If left @c
1243  *      NULL, the name from @a src_wim is used.  This parameter must be left @c
1244  *      NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1245  *      than one image; in that case, the names are all taken from the @a
1246  *      src_wim.  (This is allowed even if one or more images being exported has
1247  *      no name.)
1248  * @param dest_description
1249  *      The description to give the exported image in the new WIM file.  If left
1250  *      @c NULL, the description from the @a src_wim is used.  This parameter must
1251  *      be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1252  *      more than one image; in that case, the descriptions are all taken from
1253  *      @a src_wim.  (This is allowed even if one or more images being exported
1254  *      has no description.)
1255  * @param export_flags
1256  *      ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1257  *      bootable, or 0 if which image is marked as bootable in the destination
1258  *      WIM is to be left unchanged.  If @a src_image is ::WIMLIB_ALL_IMAGES and
1259  *      there are multiple images in @a src_wim, specifying
1260  *      ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1261  *      currently marked as bootable in @a src_wim; if that is the case, then
1262  *      that image is marked as bootable in the destination WIM.
1263  * @param additional_swms
1264  *      Array of pointers to the ::WIMStruct for each additional part in the
1265  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1266  *      need to be in any particular order, but they must include all parts of
1267  *      the split WIM other than the first part, which must be provided in the
1268  *      @a wim parameter.
1269  * @param num_additional_swms
1270  *      Number of additional WIM parts provided in the @a additional_swms array.
1271  *      This number should be one less than the total number of parts in the
1272  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1273  * @param progress_func
1274  *      If non-NULL, a function that will be called periodically with the
1275  *      progress of the current operation.
1276  *
1277  * @return 0 on success; nonzero on error.
1278  * @retval ::WIMLIB_ERR_DECOMPRESSION
1279  *      Could not decompress the metadata resource for @a src_image
1280  *      in @a src_wim
1281  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1282  *      One or more of the names being given to an exported image was already in
1283  *      use in the destination WIM.
1284  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1285  *      A directory entry in the metadata resource for @a src_image in @a
1286  *      src_wim is invalid.
1287  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1288  *      @a src_image does not exist in @a src_wim.
1289  * @retval ::WIMLIB_ERR_INVALID_PARAM
1290  *      ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1291  *      ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1292  *      @a src_wim are marked as bootable; or @a dest_name and/or @a
1293  *      dest_description were non-<code>NULL</code>, @a src_image was
1294  *      ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1295  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1296  *      The metadata resource for @a src_image in @a src_wim is invalid.
1297  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1298  *      The security data for @a src_image in @a src_wim is invalid.
1299  * @retval ::WIMLIB_ERR_NOMEM
1300  *      Failed to allocate needed memory.
1301  * @retval ::WIMLIB_ERR_READ
1302  *      Could not read the metadata resource for @a src_image from @a src_wim.
1303  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1304  *      The source WIM is a split WIM, but the parts specified do not form a
1305  *      complete split WIM because they do not include all the parts of the
1306  *      original WIM, there are duplicate parts, or not all the parts have the
1307  *      same GUID and compression type.
1308  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1309  *      @a dest_wim is part of a split WIM.  Exporting an image to a split WIM
1310  *      is unsupported.
1311  */
1312 extern int
1313 wimlib_export_image(WIMStruct *src_wim, int src_image,
1314                     WIMStruct *dest_wim,
1315                     const wimlib_tchar *dest_name,
1316                     const wimlib_tchar *dest_description,
1317                     int export_flags,
1318                     WIMStruct **additional_swms,
1319                     unsigned num_additional_swms,
1320                     wimlib_progress_func_t progress_func);
1321
1322 /**
1323  * Extract zero or more files or directory trees from a WIM image.
1324  *
1325  * This generalizes the single-image extraction functionality of
1326  * wimlib_extract_image() to allow extracting only the specified subsets of the
1327  * image.
1328  *
1329  * @param wim
1330  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1331  *      split WIM.
1332  *
1333  * @param image
1334  *      The 1-based number of the image in @a wim from which the files or
1335  *      directory trees are to be extracted.  It cannot be ::WIMLIB_ALL_IMAGES.
1336  *
1337  * @param cmds
1338  *      An array of ::wimlib_extract_command structures that specifies the
1339  *      extractions to perform.
1340  *
1341  * @param num_cmds
1342  *      Number of commands in the @a cmds array.
1343  *
1344  * @param default_extract_flags
1345  *      Default extraction flags; the behavior shall be as if these flags had
1346  *      been specified in the ::wimlib_extract_command.extract_flags member in
1347  *      each extraction command, in combination with any flags already present.
1348  *
1349  * @param additional_swms
1350  *      Array of pointers to the ::WIMStruct for each additional part in the
1351  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1352  *      need to be in any particular order, but they must include all parts of
1353  *      the split WIM other than the first part, which must be provided in the
1354  *      @a wim parameter.
1355  *
1356  * @param num_additional_swms
1357  *      Number of additional WIM parts provided in the @a additional_swms array.
1358  *      This number should be one less than the total number of parts in the
1359  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1360  *
1361  * @param progress_func
1362  *      If non-NULL, a function that will be called periodically with the
1363  *      progress of the current operation.
1364  *
1365  * @return 0 on success; nonzero on error.  The possible error codes include
1366  * those documented as returned by wimlib_extract_image() as well as the
1367  * following additional error codes:
1368  *
1369  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1370  *      The ::wimlib_extract_command.wim_source_path member in one of the
1371  *      extract commands did not exist in the WIM.
1372  * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1373  *      ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1374  *      in which ::wimlib_extract_command.wim_source_path existed but was not a
1375  *      regular file or directory.
1376  * @retval ::WIMLIB_ERR_INVALID_PARAM
1377  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1378  *      specified for some commands but not all; or
1379  *      ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1380  *      for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1381  *      for a command in which ::wimlib_extract_command.wim_source_path did not
1382  *      specify the root directory of the WIM image.
1383  */
1384 extern int
1385 wimlib_extract_files(WIMStruct *wim,
1386                      int image,
1387                      const struct wimlib_extract_command *cmds,
1388                      size_t num_cmds,
1389                      int default_extract_flags,
1390                      WIMStruct **additional_swms,
1391                      unsigned num_additional_swms,
1392                      wimlib_progress_func_t progress_func);
1393
1394 /**
1395  * Extracts an image, or all images, from a standalone or split WIM file to a
1396  * directory or a NTFS volume.
1397  *
1398  * Please see the manual page for the @c wimlib-imagex program for more
1399  * information about the "normal" extraction mode versus the NTFS extraction
1400  * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1401  *
1402  * Extraction is done with one thread.
1403  *
1404  * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1405  * returned if any resulting SHA1 message digests do not match the values
1406  * provided in the WIM file.  Therefore, if this function is successful, you can
1407  * be fairly sure that any compressed data in the WIM was uncompressed
1408  * correctly.
1409  *
1410  * @param wim
1411  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1412  *      split WIM.
1413  * @param image
1414  *      The image to extract.  Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1415  *      to specify that all images are to be extracted.  ::WIMLIB_ALL_IMAGES cannot
1416  *      be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1417  * @param target
1418  *      Directory to extract the WIM image(s) to (created if it does not already
1419  *      exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1420  *      path to the unmounted NTFS volume to extract the image to.
1421  * @param extract_flags
1422  *      Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1423  *      <br/> <br/>
1424  *      If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1425  *      a NTFS volume to extract the image to.  The volume will be opened using
1426  *      NTFS-3g and the image will be extracted to the root of the NTFS volume.
1427  *      Otherwise, @a target is interpreted as a directory to extract the
1428  *      image(s) to.
1429  *      <br/> <br/>
1430  *      If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1431  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1432  *      specified.  These flags cause extracted files that are identical to be
1433  *      hardlinked or symlinked together, depending on the flag.  These flags
1434  *      override the hard link groups that are specified in the WIM file itself.
1435  *      If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1436  *      hardlinked or symlinked across images if a file is found to occur in
1437  *      more than one image.
1438  *      <br/> <br/>
1439  *      You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1440  *      name of each file or directory as it is extracted.
1441  *      <br/> <br/>
1442  *      If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1443  *      WIM sequentially, if possible.  If ::WIMLIB_ALL_IMAGES is specified,
1444  *      each image is considered separately with regards to the sequential
1445  *      order.  It is also possible for alternate data streams to break the
1446  *      sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1447  *      specified).
1448  * @param additional_swms
1449  *      Array of pointers to the ::WIMStruct for each additional part in the
1450  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1451  *      need to be in any particular order, but they must include all parts of
1452  *      the split WIM other than the first part, which must be provided in the
1453  *      @a wim parameter.
1454  * @param num_additional_swms
1455  *      Number of additional WIM parts provided in the @a additional_swms array.
1456  *      This number should be one less than the total number of parts in the
1457  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1458  *
1459  * @param progress_func
1460  *      If non-NULL, a function that will be called periodically with the
1461  *      progress of the current operation.
1462  *
1463  * @return 0 on success; nonzero on error.
1464  * @retval ::WIMLIB_ERR_DECOMPRESSION
1465  *      Could not decompress a resource (file or metadata) for @a image in @a
1466  *      wim.
1467  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1468  *      A directory entry in the metadata resource for @a image in @a wim is
1469  *      invalid.
1470  * @retval ::WIMLIB_ERR_INVALID_PARAM
1471  *      @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1472  *      ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1473  *      both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1474  *      ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1475  *      specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1476  *      specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1477  *      both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1478  *      specified in @a extract_flag.
1479  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1480  *      The SHA1 message digest of an extracted stream did not match the SHA1
1481  *      message digest given in the WIM file.
1482  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1483  *      A resource (file or metadata) for @a image in @a wim is invalid.
1484  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1485  *      The security data for @a image in @a wim is invalid.
1486  * @retval ::WIMLIB_ERR_LINK
1487 *       Failed to create a symbolic link or a hard link (only if
1488  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1489  * @retval ::WIMLIB_ERR_MKDIR
1490  *      Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1491  *      not specified in @a extract_flags).
1492  * @retval ::WIMLIB_ERR_NOMEM
1493  *      Failed to allocate needed memory.
1494  * @retval ::WIMLIB_ERR_NTFS_3G
1495  *      An error was returned from a libntfs-3g function while the WIM image was
1496  *      being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1497  *      was specified in @a extract_flags).
1498  * @retval ::WIMLIB_ERR_OPEN
1499  *      Could not open one of the files being extracted for writing (only if
1500  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1501  * @retval ::WIMLIB_ERR_READ
1502  *      A unexpected end-of-file or read error occurred when trying to read data
1503  *      from the WIM file associated with @a wim.
1504  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1505  *      The WIM is a split WIM, but the parts specified do not form a complete
1506  *      split WIM because they do not include all the parts of the original WIM,
1507  *      there are duplicate parts, or not all the parts have the same GUID and
1508  *      compression type.
1509  * @retval ::WIMLIB_ERR_UNSUPPORTED
1510  *      ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1511  *      was configured with the @c --without-ntfs-3g flag.
1512  * @retval ::WIMLIB_ERR_WRITE
1513  *      Failed to write a file being extracted (only if
1514  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1515  */
1516 extern int
1517 wimlib_extract_image(WIMStruct *wim, int image,
1518                      const wimlib_tchar *target,
1519                      int extract_flags,
1520                      WIMStruct **additional_swms,
1521                      unsigned num_additional_swms,
1522                      wimlib_progress_func_t progress_func);
1523
1524 /**
1525  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
1526  * includes a string of XML that describes the images contained in the WIM.
1527  * This function works on standalone WIMs as well as split WIM parts.
1528  *
1529  * @param wim
1530  *      Pointer to the ::WIMStruct for a WIM file.
1531  * @param fp
1532  *      @c stdout, or a FILE* opened for writing, to extract the data to.
1533  *
1534  * @return 0 on success; nonzero on error.
1535  * @retval ::WIMLIB_ERR_INVALID_PARAM
1536  *      @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1537  * @retval ::WIMLIB_ERR_NOMEM
1538  *      Failed to allocate needed memory.
1539  * @retval ::WIMLIB_ERR_READ
1540  *      Failed to read the XML data from the WIM.
1541  * @retval ::WIMLIB_ERR_WRITE
1542  *      Failed to completely write the XML data to @a fp.
1543  */
1544 extern int
1545 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1546
1547 /**
1548  * Frees all memory allocated for a WIMStruct and closes all files associated
1549  * with it.
1550  *
1551  * @param wim
1552  *      Pointer to the ::WIMStruct for a WIM file.
1553  *
1554  * @return This function has no return value.
1555  */
1556 extern void
1557 wimlib_free(WIMStruct *wim);
1558
1559 /**
1560  * Returns the index of the bootable image of the WIM.
1561  *
1562  * @param wim
1563  *      Pointer to the ::WIMStruct for a WIM file.
1564  *
1565  * @return
1566  *      0 if no image is marked as bootable, or the number of the image marked
1567  *      as bootable (numbered starting at 1).
1568  */
1569 extern int
1570 wimlib_get_boot_idx(const WIMStruct *wim);
1571
1572 /**
1573  * Returns the compression type used in the WIM.
1574  *
1575  * @param wim
1576  *      Pointer to the ::WIMStruct for a WIM file
1577  *
1578  * @return
1579  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1580  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1581  */
1582 extern int
1583 wimlib_get_compression_type(const WIMStruct *wim);
1584
1585 /**
1586  * Converts a ::wimlib_compression_type value into a string.
1587  *
1588  * @param ctype
1589  *      ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1590  *      ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1591  *
1592  * @return
1593  *      A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1594  *      respectively.
1595  */
1596 extern const wimlib_tchar *
1597 wimlib_get_compression_type_string(int ctype);
1598
1599 /**
1600  * Converts an error code into a string describing it.
1601  *
1602  * @param code
1603  *      The error code returned by one of wimlib's functions.
1604  *
1605  * @return
1606  *      Pointer to a statically allocated string describing the error code,
1607  *      or @c NULL if the error code is not valid.
1608  */
1609 extern const wimlib_tchar *
1610 wimlib_get_error_string(enum wimlib_error_code code);
1611
1612 /**
1613  * Returns the description of the specified image.
1614  *
1615  * @param wim
1616  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1617  *      standalone WIM or a split WIM part.
1618  * @param image
1619  *      The number of the image, numbered starting at 1.
1620  *
1621  * @return
1622  *      The description of the image, or @c NULL if there is no such image, or
1623  *      @c NULL if the specified image has no description.  The description
1624  *      string is in library-internal memory and may not be modified or freed;
1625  *      in addition, the string will become invalid if the description of the
1626  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1627  */
1628 extern const wimlib_tchar *
1629 wimlib_get_image_description(const WIMStruct *wim, int image);
1630
1631 /**
1632  * Returns the name of the specified image.
1633  *
1634  * @param wim
1635  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1636  *      standalone WIM or a split WIM part.
1637  * @param image
1638  *      The number of the image, numbered starting at 1.
1639  *
1640  * @return
1641  *      The name of the image, or @c NULL if there is no such image.  The name
1642  *      string is in library-internal memory and may not be modified or freed;
1643  *      in addition, the string will become invalid if the name of the image is
1644  *      changed, the image is deleted, or the ::WIMStruct is destroyed.
1645  *
1646  *      If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1647  *      the WIM to be unnamed, in which case an empty string will be returned
1648  *      when the corresponding name is requested.
1649  */
1650 extern const wimlib_tchar *
1651 wimlib_get_image_name(const WIMStruct *wim, int image);
1652
1653
1654 /**
1655  * Returns the number of images contained in a WIM.
1656  *
1657  * @param wim
1658  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1659  *      standalone WIM or a split WIM part.
1660  *
1661  * @return
1662  *      The number of images contained in the WIM file.
1663  */
1664 extern int
1665 wimlib_get_num_images(const WIMStruct *wim);
1666
1667 /**
1668  * Returns the part number of a WIM in a split WIM and the total number of parts
1669  * of the split WIM.
1670  *
1671  * @param wim
1672  *      Pointer to the ::WIMStruct for a WIM file.
1673  * @param total_parts_ret
1674  *      If non-@c NULL, the total number of parts in the split WIM (1 for
1675  *      non-split WIMs) is written to this location.
1676  *
1677  * @return
1678  *      The part number of the WIM (1 for non-split WIMs)
1679  */
1680 extern int
1681 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1682
1683 /**
1684  * Initialization function for wimlib.  Call before using any other wimlib
1685  * function.
1686  *
1687  * @param init_flags
1688  *      On UNIX, specify ::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume
1689  *      that all input data, including filenames, are in UTF-8 rather than the
1690  *      locale-dependent character encoding which may or may not be UTF-8, and
1691  *      that UTF-8 data can be directly printed to the console.  On Windows, use
1692  *      0 for this parameter.
1693  *
1694  * @return 0; other error codes may be returned in future releases.
1695  */
1696 extern int
1697 wimlib_global_init(int init_flags);
1698
1699 /**
1700  * Since wimlib 1.2.6:  Cleanup function for wimlib.  This is not re-entrant.
1701  * You are not required to call this function, but it will release any global
1702  * memory allocated by the library.
1703  */
1704 extern void
1705 wimlib_global_cleanup(void);
1706
1707 /**
1708  * Returns true if the WIM has an integrity table.
1709  *
1710  * @param wim
1711  *      Pointer to the ::WIMStruct for a WIM file.
1712  * @return
1713  *      @c true if the WIM has an integrity table; @c false otherwise.  If @a
1714  *      wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1715  *      wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1716  *      been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1717  */
1718 extern bool
1719 wimlib_has_integrity_table(const WIMStruct *wim);
1720
1721 /**
1722  * Determines if an image name is already used by some image in the WIM.
1723  *
1724  * @param wim
1725  *      Pointer to the ::WIMStruct for a WIM file.
1726  * @param name
1727  *      The name to check.
1728  *
1729  * @return
1730  *      @c true if there is already an image in @a wim named @a name; @c false
1731  *      if there is no image named @a name in @a wim.  If @a name is @c NULL or
1732  *      the empty string, @c false is returned.
1733  */
1734 extern bool
1735 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
1736
1737 /**
1738  * Joins a split WIM into a stand-alone one-part WIM.
1739  *
1740  * @param swms
1741  *      An array of strings that gives the filenames of all parts of the split
1742  *      WIM.  No specific order is required, but all parts must be included with
1743  *      no duplicates.
1744  * @param num_swms
1745  *      Number of filenames in @a swms.
1746  * @param swm_open_flags
1747  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1748  *      part should be verified, if integrity tables are present.  Otherwise,
1749  *      set to 0.
1750  * @param wim_write_flags
1751  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1752  * @param output_path
1753  *      The path to write the one-part WIM to.
1754  * @param progress_func
1755  *      If non-NULL, a function that will be called periodically with the
1756  *      progress of the current operation.
1757  *
1758  * @return 0 on success; nonzero on error.  This function may return any value
1759  * returned by wimlib_open_wim() and wimlib_write() except
1760  * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1761  *
1762  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1763  *      The split WIMs do not form a valid WIM because they do not include all
1764  *      the parts of the original WIM, there are duplicate parts, or not all the
1765  *      parts have the same GUID and compression type.
1766  *
1767  * Note: the WIM's uncompressed and compressed resources are not checksummed
1768  * when they are copied from the split WIM parts to the joined WIM, nor are
1769  * compressed resources re-compressed.
1770  *
1771  * Note: wimlib_export_image() can provide similar functionality to
1772  * wimlib_join(), since it is possible to export all images from a split WIM.
1773  */
1774 extern int
1775 wimlib_join(const wimlib_tchar * const *swms,
1776             unsigned num_swms,
1777             const wimlib_tchar *output_path,
1778             int swm_open_flags,
1779             int wim_write_flags,
1780             wimlib_progress_func_t progress_func);
1781
1782 /**
1783  * Compress a chunk of a WIM resource using LZX compression.
1784  *
1785  * This function is exported for convenience only and need not be used.
1786  *
1787  * @param chunk
1788  *      Uncompressed data of the chunk.
1789  * @param chunk_size
1790  *      Size of the uncompressed chunk, in bytes.
1791  * @param out
1792  *      Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
1793  *
1794  * @return
1795  *      The size of the compressed data written to @a out in bytes, or 0 if the
1796  *      data could not be compressed to (@a chunk_size - 1) bytes or fewer.
1797  *
1798  * As a special requirement, the compression code is optimized for the WIM
1799  * format and therefore requires (@a chunk_size <= 32768).
1800  */
1801 extern unsigned
1802 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
1803
1804 /**
1805  * Decompresses a block of LZX-compressed data as used in the WIM file format.
1806  *
1807  * Note that this will NOT work unmodified for LZX as used in the cabinet
1808  * format, which is not the same as in the WIM format!
1809  *
1810  * This function is exported for convenience only and need not be used.
1811  *
1812  * @param compressed_data
1813  *      Pointer to the compressed data.
1814  *
1815  * @param compressed_len
1816  *      Length of the compressed data, in bytes.
1817  *
1818  * @param uncompressed_data
1819  *      Pointer to the buffer into which to write the uncompressed data.
1820  *
1821  * @param uncompressed_len
1822  *      Length of the uncompressed data.  It must be 32768 bytes or less.
1823  *
1824  * @return
1825  *      0 on success; non-zero on failure.
1826  */
1827 extern int
1828 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
1829                       void *uncompressed_data, unsigned uncompressed_len);
1830
1831
1832 /**
1833  * Mounts an image in a WIM file on a directory read-only or read-write.
1834  *
1835  * This is not supported on Windows.
1836  *
1837  * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1838  * process will be daemonized.
1839  *
1840  * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1841  * modifications to the WIM are staged in a temporary directory.
1842  *
1843  * It is safe to mount multiple images from the same WIM file read-only at the
1844  * same time, but only if different ::WIMStruct's are used.  It is @b not safe
1845  * to mount multiple images from the same WIM file read-write at the same time.
1846  *
1847  * wimlib_mount_image() cannot be used on an image that was exported with
1848  * wimlib_export_image() while the dentry trees for both images are still in
1849  * memory.  In addition, wimlib_mount_image() may not be used to mount an image
1850  * that has just been added with wimlib_add_image(), unless the WIM has been
1851  * written and read into a new ::WIMStruct.
1852  *
1853  * @param wim
1854  *      Pointer to the ::WIMStruct containing the image to be mounted.
1855  * @param image
1856  *      The number of the image to mount, indexed starting from it.  It must be
1857  *      an existing, single image.
1858  * @param dir
1859  *      The path to an existing empty directory to mount the image on.
1860  * @param mount_flags
1861  *      Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1862  *      <br/><br/>
1863  *      If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1864  *      rather than the default of read-only.
1865  *      <br/> <br/>
1866  *      WIMs may contain named (alternate) data streams, which are a somewhat
1867  *      obscure NTFS feature.  They can be read and written on a mounted WIM
1868  *      through one of several interfaces.  The interface to use if specified by
1869  *      exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1870  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1871  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS.  The default interface is
1872  *      the XATTR interface.
1873  * @param additional_swms
1874  *      Array of pointers to the ::WIMStruct for each additional part in the
1875  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
1876  *      need to be in any particular order, but they must include all parts of
1877  *      the split WIM other than the first part, which must be provided in the
1878  *      @a wim parameter.
1879  * @param num_additional_swms
1880  *      Number of additional WIM parts provided in the @a additional_swms array.
1881  *      This number should be one less than the total number of parts in the
1882  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
1883  * @param staging_dir
1884  *      If non-NULL, the name of a directory in which the staging directory will
1885  *      be created.  Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1886  *      in @a mount_flags.  If left @c NULL, the staging directory is created in
1887  *      the same directory as the WIM file that @a wim was originally read from.
1888  *
1889  * @return 0 on success; nonzero on error.
1890  *
1891  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1892  *      A read-write mount was requested, but an an exclusive advisory lock on
1893  *      the on-disk WIM file could not be acquired because another thread or
1894  *      process has mounted an image from the WIM read-write or is currently
1895  *      modifying the WIM in-place.
1896  * @retval ::WIMLIB_ERR_DECOMPRESSION
1897  *      Could not decompress the metadata resource for @a image in @a wim.
1898  * @retval ::WIMLIB_ERR_FUSE
1899  *      A non-zero status was returned by @c fuse_main().
1900  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1901  *      A directory entry in the metadata resource for @a image in @a wim is
1902  *      invalid.
1903  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1904  *      @a image does not specify an existing, single image in @a wim.
1905  * @retval ::WIMLIB_ERR_INVALID_PARAM
1906  *      @a image is shared among multiple ::WIMStruct's as a result of a call to
1907  *      wimlib_export_image(), or @a image has been added with
1908  *      wimlib_add_image().
1909  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1910  *      The metadata resource for @a image in @a wim is invalid.
1911  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1912  *      The security data for @a image in @a wim is invalid.
1913  * @retval ::WIMLIB_ERR_MKDIR
1914  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1915  *      staging directory could not be created.
1916  * @retval ::WIMLIB_ERR_NOMEM
1917  *      Failed to allocate needed memory.
1918  * @retval ::WIMLIB_ERR_NOTDIR
1919  *      Could not determine the current working directory.
1920  * @retval ::WIMLIB_ERR_READ
1921  *      An unexpected end-of-file or read error occurred when trying to read
1922  *      data from the WIM file associated with @a wim.
1923  * @retval ::WIMLIB_ERR_SPLIT_INVALID
1924  *      The WIM is a split WIM, but the parts specified do not form a complete
1925  *      split WIM because they do not include all the parts of the original WIM,
1926  *      there are duplicate parts, or not all the parts have the same GUID and
1927  *      compression type.
1928  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1929  *      The WIM is a split WIM and a read-write mount was requested.  We only
1930  *      support mounting a split WIM read-only.
1931  * @retval ::WIMLIB_ERR_UNSUPPORTED
1932  *      Mounting is not supported, either because the platform is Windows, or
1933  *      because the platform is UNIX and wimlib was compiled with @c
1934  *      --without-fuse.
1935  */
1936 extern int
1937 wimlib_mount_image(WIMStruct *wim,
1938                    int image,
1939                    const wimlib_tchar *dir,
1940                    int mount_flags,
1941                    WIMStruct **additional_swms,
1942                    unsigned num_additional_swms,
1943                    const wimlib_tchar *staging_dir);
1944
1945 /**
1946  * Opens a WIM file and creates a ::WIMStruct for it.
1947  *
1948  * @param wim_file
1949  *      The path to the WIM file to open.
1950  * @param open_flags
1951  *      Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1952  *      ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1953  *      <br/> <br/>
1954  *      If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1955  *      the WIM, if it exists, is checked, and this function will fail with an
1956  *      ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1957  *      digests of the WIM do not exactly match the corresponding message
1958  *      digests given in the integrity table.
1959  *      <br/> <br/>
1960  *      If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1961  *      WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1962  *      returned.  (This flag may be removed in the future, in which case no
1963  *      error will be issued when opening a split WIM.)
1964  *
1965  * @param progress_func
1966  *      If non-NULL, a function that will be called periodically with the
1967  *      progress of the current operation.
1968  *
1969  * @param wim_ret
1970  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1971  *      is written to the memory location pointed to by this parameter.  The
1972  *      ::WIMStruct must be freed using using wimlib_free() when finished with
1973  *      it.
1974  *
1975  * @return 0 on success; nonzero on error.
1976  * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1977  *      The lookup table of @a wim_file is compressed.  Support for this can be
1978  *      added to wimlib if needed, but it appears to be the case that the lookup
1979  *      table is never compressed.
1980  * @retval ::WIMLIB_ERR_IMAGE_COUNT
1981  *      The WIM is not the non-first part of a split WIM, and the number of
1982  *      metadata resources found in the WIM did not match the image count given
1983  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
1984  *      data for the WIM did not match the image count given in the WIM header.
1985  * @retval ::WIMLIB_ERR_INTEGRITY
1986  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1987  *      wim_file contains an integrity table, but the SHA1 message digest for a
1988  *      chunk of the WIM does not match the corresponding message digest given
1989  *      in the integrity table.
1990  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1991  *      Resources in @a wim_file are compressed, but the chunk size is not 32768.
1992  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1993  *      The header of @a wim_file says that resources in the WIM are compressed,
1994  *      but the header flag indicating LZX or XPRESS compression is not set.
1995  * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1996  *      The length field of the WIM header is not 208.
1997  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1998  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1999  *      wim_file contains an integrity table, but the integrity table is
2000  *      invalid.
2001  * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
2002  *      The lookup table for the WIM contained duplicate entries that are not
2003  *      for metadata resources, or it contained an entry with a SHA1 message
2004  *      digest of all 0's.
2005  * @retval ::WIMLIB_ERR_NOMEM
2006  *      Failed to allocated needed memory.
2007  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
2008  *      @a wim_file does not begin with the expected magic characters.
2009  * @retval ::WIMLIB_ERR_OPEN
2010  *      Failed to open the file @a wim_file for reading.
2011  * @retval ::WIMLIB_ERR_READ
2012  *      An unexpected end-of-file or read error occurred when trying to read
2013  *      data from @a wim_file.
2014  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2015  *      @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
2016  *      specified in @a open_flags.
2017  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
2018  *      A number other than 0x10d00 is written in the version field of the WIM
2019  *      header of @a wim_file.  (Probably a pre-Vista WIM).
2020  * @retval ::WIMLIB_ERR_XML
2021  *      The XML data for @a wim_file is invalid.
2022  */
2023 extern int
2024 wimlib_open_wim(const wimlib_tchar *wim_file,
2025                 int open_flags,
2026                 WIMStruct **wim_ret,
2027                 wimlib_progress_func_t progress_func);
2028
2029 /**
2030  * Overwrites the file that the WIM was originally read from, with changes made.
2031  * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
2032  * rather than wimlib_create_new_wim().
2033  *
2034  * There are two ways that a WIM may be overwritten.  The first is to do a full
2035  * rebuild.  In this mode, the new WIM is written to a temporary file and then
2036  * renamed to the original file after it is has been completely written.  The
2037  * temporary file is made in the same directory as the original WIM file.  A
2038  * full rebuild may take a while, but can be used even if images have been
2039  * modified or deleted, will produce a WIM with no holes, and has little chance
2040  * of unintentional data loss because the temporary WIM is fsync()ed before
2041  * being renamed to the original WIM.
2042  *
2043  * The second way to overwrite a WIM is by appending to the end of it and
2044  * overwriting the header.  This can be much faster than a full rebuild, but the
2045  * disadvantage is that some space will be wasted.  Writing a WIM in this mode
2046  * begins with writing any new file resources *after* everything in the old WIM,
2047  * even though this will leave a hole where the old lookup table, XML data, and
2048  * integrity were.  This is done so that the WIM remains valid even if the
2049  * operation is aborted mid-write.  The WIM header is only overwritten at the
2050  * very last moment, and up until that point the WIM will be seen as the old
2051  * version.
2052  *
2053  * By default, wimlib_overwrite() does the append-style overwrite described
2054  * above, unless resources in the WIM are arranged in an unusual way or if
2055  * images have been deleted from the WIM.  Use the flag
2056  * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2057  * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2058  * images have been deleted from the WIM.
2059  *
2060  * In the temporary-file overwrite mode, no changes are made to the WIM on
2061  * failure, and the temporary file is deleted if possible.  Abnormal termination
2062  * of the program will result in the temporary file being orphaned.  In the
2063  * direct append mode, the WIM is truncated to the original length on failure;
2064  * and while abnormal termination of the program will result in extra data
2065  * appended to the original WIM, it should still be a valid WIM.
2066  *
2067  * If this function completes successfully, no more functions should be called
2068  * on @a wim other than wimlib_free().  You must use wimlib_open_wim() to read
2069  * the WIM file anew.
2070  *
2071  * @param wim
2072  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
2073  *      been in-memory changes made to it, which are then reflected in the
2074  *      output file.
2075  * @param write_flags
2076  *      Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2077  *      ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
2078  *      ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2079  * @param num_threads
2080  *      Number of threads to use for compression (see wimlib_write()).
2081  * @param progress_func
2082  *      If non-NULL, a function that will be called periodically with the
2083  *      progress of the current operation.
2084  *
2085  * @return 0 on success; nonzero on error.  This function may return any value
2086  * returned by wimlib_write() as well as the following error codes:
2087  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2088  *      The WIM was going to be modifien in-place (with no temporary file), but
2089  *      an exclusive advisory lock on the on-disk WIM file could not be acquired
2090  *      because another thread or process has mounted an image from the WIM
2091  *      read-write or is currently modifying the WIM in-place.
2092  * @retval ::WIMLIB_ERR_NO_FILENAME
2093  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
2094  *      than a WIM read with wimlib_open_wim().
2095  * @retval ::WIMLIB_ERR_RENAME
2096  *      The temporary file that the WIM was written to could not be renamed to
2097  *      the original filename of @a wim.
2098  */
2099 extern int
2100 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2101                  wimlib_progress_func_t progress_func);
2102
2103 /**
2104  * Prints information about one image, or all images, contained in a WIM.
2105  *
2106  * @param wim
2107  *      Pointer to the ::WIMStruct for a WIM file.
2108  * @param image
2109  *      The image about which to print information.  Can be the number of an
2110  *      image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2111  *      WIM.
2112  *
2113  * @return This function has no return value.  No error checking is done when
2114  * printing the information.  If @a image is invalid, an error message is
2115  * printed.
2116  */
2117 extern void
2118 wimlib_print_available_images(const WIMStruct *wim, int image);
2119
2120 /**
2121  * Prints the full paths to all files contained in an image, or all images, in a
2122  * WIM file.
2123  *
2124  * @param wim
2125  *      Pointer to the ::WIMStruct for a WIM file.
2126  * @param image
2127  *      Which image to print files for.  Can be the number of an image, or
2128  *      ::WIMLIB_ALL_IMAGES to print the files contained in all images.
2129  *
2130  * @return 0 on success; nonzero on error.
2131  * @retval ::WIMLIB_ERR_DECOMPRESSION
2132  *      The metadata resource for one of the specified images could not be
2133  *      decompressed.
2134  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2135  *      A directory entry in the metadata resource for one of the specified
2136  *      images is invaled.
2137  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2138  *      @a image does not specify a valid image in @a wim, and is not
2139  *      ::WIMLIB_ALL_IMAGES.
2140  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2141  *      The metadata resource for one of the specified images is invalid.
2142  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2143  *      The security data for one of the specified images is invalid.
2144  * @retval ::WIMLIB_ERR_NOMEM
2145  *      Failed to allocate needed memory.
2146  * @retval ::WIMLIB_ERR_READ
2147  *      An unexpected read error or end-of-file occurred when reading the
2148  *      metadata resource for one of the specified images.
2149  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2150  *      @a wim was not a standalone WIM and was not the first part of a split
2151  *      WIM.
2152  */
2153 extern int
2154 wimlib_print_files(WIMStruct *wim, int image);
2155
2156 /**
2157  * Prints detailed information from the header of a WIM file.
2158  *
2159  * @param wim
2160  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2161  *      standalone WIM or part of a split WIM.
2162  *
2163  * @return This function has no return value.
2164  *
2165  */
2166 extern void
2167 wimlib_print_header(const WIMStruct *wim);
2168
2169 /**
2170  * Prints the lookup table of a WIM file.  The lookup table maps SHA1 message
2171  * digests, as found in the directory entry tree in the WIM file, to file
2172  * resources in the WIM file.  This table includes one entry for each unique
2173  * file in the WIM, so it can be quite long.  There is only one lookup table per
2174  * WIM file, but each split WIM part has its own lookup table.
2175  *
2176  * @param wim
2177  *      Pointer to the ::WIMStruct for a WIM file.
2178  *
2179  * @return This function has no return value.
2180  */
2181 extern void
2182 wimlib_print_lookup_table(WIMStruct *wim);
2183
2184 /**
2185  * Prints the metadata of the specified image in a WIM file.  The metadata
2186  * consists of the security data as well as the directory entry tree.  Each
2187  * image has its own metadata.
2188  *
2189  * @param wim
2190  *      Pointer to the ::WIMStruct for a WIM file.
2191  * @param image
2192  *      Which image to print the metadata for.  Can be the number of an image,
2193  *      or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
2194  *
2195  * @return 0 on success; nonzero on error.
2196  * @retval ::WIMLIB_ERR_DECOMPRESSION
2197  *      The metadata resource for one of the specified images could not be
2198  *      decompressed.
2199  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2200  *      A directory entry in the metadata resource for one of the specified
2201  *      images is invaled.
2202  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2203  *      @a image does not specify a valid image in @a wim, and is not
2204  *      ::WIMLIB_ALL_IMAGES.
2205  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2206  *      The metadata resource for one of the specified images is invalid.
2207  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2208  *      The security data for one of the specified images is invalid.
2209  * @retval ::WIMLIB_ERR_NOMEM
2210  *      Failed to allocate needed memory.
2211  * @retval ::WIMLIB_ERR_READ
2212  *      An unexpected read error or end-of-file occurred when reading the
2213  *      metadata resource for one of the specified images.
2214  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2215  *      @a wim was not a standalone WIM and was not the first part of a split
2216  *      WIM.
2217  */
2218 extern int
2219 wimlib_print_metadata(WIMStruct *wim, int image);
2220
2221 /**
2222  * Prints some basic information about a WIM file.  All information printed by
2223  * this function is also printed by wimlib_print_header(), but
2224  * wimlib_print_wim_information() prints some of this information more concisely
2225  * and in a more readable form.
2226  *
2227  * @param wim
2228  *      Pointer to the ::WIMStruct for a WIM file.
2229  *
2230  * @return This function has no return value.
2231  */
2232 extern void
2233 wimlib_print_wim_information(const WIMStruct *wim);
2234
2235 /**
2236  * Translates a string specifying the name or number of an image in the WIM into
2237  * the number of the image.  The images are numbered starting at 1.
2238  *
2239  * @param wim
2240  *      Pointer to the ::WIMStruct for a WIM file.
2241  * @param image_name_or_num
2242  *      A string specifying the name or number of an image in the WIM.  If it
2243  *      parses to a positive integer, this integer is taken to specify the
2244  *      number of the image, indexed starting at 1.  Otherwise, it is taken to
2245  *      be the name of an image, as given in the XML data for the WIM file.  It
2246  *      also may be the keyword "all" or the string "*", both of which will
2247  *      resolve to ::WIMLIB_ALL_IMAGES.
2248  *      <br/> <br/>
2249  *      There is no way to search for an image actually named "all", "*", or an
2250  *      integer number, or an image that has no name.  However, you can use
2251  *      wimlib_get_image_name() to get the name of any image.
2252  *
2253  * @return
2254  *      If the string resolved to a single existing image, the number of that
2255  *      image, indexed starting at 1, is returned.  If the keyword "all" or "*"
2256  *      was specified, ::WIMLIB_ALL_IMAGES is returned.  Otherwise,
2257  *      ::WIMLIB_NO_IMAGE is returned.  If @a image_name_or_num was @c NULL or
2258  *      the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2259  *      images in @a wim has no name.
2260  */
2261 extern int
2262 wimlib_resolve_image(WIMStruct *wim,
2263                      const wimlib_tchar *image_name_or_num);
2264
2265 /**
2266  * Sets which image in the WIM is marked as bootable.
2267  *
2268  * @param wim
2269  *      Pointer to the ::WIMStruct for a WIM file.
2270  * @param boot_idx
2271  *      The number of the image to mark as bootable, or 0 to mark no image as
2272  *      bootable.
2273  * @return 0 on success; nonzero on error.
2274  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2275  *      @a boot_idx does not specify an existing image in @a wim, and it was not
2276  *      0.
2277  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2278  *      @a wim is part of a split WIM.
2279  */
2280 extern int
2281 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
2282
2283 /**
2284  * Changes the description of an image in the WIM.
2285  *
2286  * @param wim
2287  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2288  *      standalone WIM or part of a split WIM; however, you should set the same
2289  *      description on all parts of a split WIM.
2290  * @param image
2291  *      The number of the image for which to change the description.
2292  * @param description
2293  *      The new description to give the image.  It may be @c NULL, which
2294  *      indicates that the image is to be given no description.
2295  *
2296  * @return 0 on success; nonzero on error.
2297  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2298  *      @a image does not specify a single existing image in @a wim.
2299  * @retval ::WIMLIB_ERR_NOMEM
2300  *      Failed to allocate the memory needed to duplicate the @a description
2301  *      string.
2302  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2303  *      @a wim is part of a split WIM.
2304  */
2305 extern int
2306 wimlib_set_image_descripton(WIMStruct *wim, int image,
2307                             const wimlib_tchar *description);
2308
2309 /**
2310  * Changes what is written in the \<FLAGS\> element in the WIM XML data
2311  * (something like "Core" or "Ultimate")
2312  *
2313  * @param wim
2314  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2315  *      standalone WIM or part of a split WIM; however, you should set the same
2316  *      \<FLAGS\> element on all parts of a split WIM.
2317  * @param image
2318  *      The number of the image for which to change the description.
2319  * @param flags
2320  *      The new \<FLAGS\> element to give the image.  It may be @c NULL, which
2321  *      indicates that the image is to be given no \<FLAGS\> element.
2322  *
2323  * @return 0 on success; nonzero on error.
2324  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2325  *      @a image does not specify a single existing image in @a wim.
2326  * @retval ::WIMLIB_ERR_NOMEM
2327  *      Failed to allocate the memory needed to duplicate the @a flags string.
2328  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2329  *      @a wim is part of a split WIM.
2330  */
2331 extern int wimlib_set_image_flags(WIMStruct *wim, int image,
2332                                   const wimlib_tchar *flags);
2333
2334 /**
2335  * Changes the name of an image in the WIM.
2336  *
2337  * @param wim
2338  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
2339  *      standalone WIM or part of a split WIM; however, you should set the same
2340  *      name on all parts of a split WIM.
2341  * @param image
2342  *      The number of the image for which to change the name.
2343  * @param name
2344  *      New name to give the new image.  If @c NULL or empty, the new image is
2345  *      given no name.  If nonempty, it must specify a name that does not
2346  *      already exist in @a wim.
2347  *
2348  * @return 0 on success; nonzero on error.
2349  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2350  *      There is already an image named @a name in @a wim.
2351  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2352  *      @a image does not specify a single existing image in @a wim.
2353  * @retval ::WIMLIB_ERR_NOMEM
2354  *      Failed to allocate the memory needed to duplicate the @a name string.
2355  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2356  *      @a wim is part of a split WIM.
2357  */
2358 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2359                                  const wimlib_tchar *name);
2360
2361 /**
2362  * Set the functions that wimlib uses to allocate and free memory.
2363  *
2364  * These settings are global and not per-WIM.
2365  *
2366  * The default is to use the default @c malloc() and @c free() from the C
2367  * library.
2368  *
2369  * Please note that some external functions, such as those in @c libntfs-3g, may
2370  * use the standard memory allocation functions.
2371  *
2372  * @param malloc_func
2373  *      A function equivalent to @c malloc() that wimlib will use to allocate
2374  *      memory.  If @c NULL, the allocator function is set back to the default
2375  *      @c malloc() from the C library.
2376  * @param free_func
2377  *      A function equivalent to @c free() that wimlib will use to free memory.
2378  *      If @c NULL, the free function is set back to the default @c free() from
2379  *      the C library.
2380  * @param realloc_func
2381  *      A function equivalent to @c realloc() that wimlib will use to reallocate
2382  *      memory.  If @c NULL, the free function is set back to the default @c
2383  *      realloc() from the C library.
2384  * @return 0 on success; nonzero on error.
2385  * @retval ::WIMLIB_ERR_UNSUPPORTED
2386  *      wimlib was compiled with the @c --without-custom-memory-allocator flag,
2387  *      so custom memory allocators are unsupported.
2388  */
2389 extern int
2390 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2391                             void (*free_func)(void *),
2392                             void *(*realloc_func)(void *, size_t));
2393
2394 /**
2395  * Sets whether wimlib is to print error messages to @c stderr when a function
2396  * fails.  These error messages may provide information that cannot be
2397  * determined only from the error code that is returned.  Not every error will
2398  * result in an error message being printed.
2399  *
2400  * This setting is global and not per-WIM.
2401  *
2402  * By default, error messages are not printed.
2403  *
2404  * @param show_messages
2405  *      @c true if error messages are to be printed; @c false if error messages
2406  *      are not to be printed.
2407  *
2408  * @return 0 on success; nonzero on error.
2409  * @retval ::WIMLIB_ERR_UNSUPPORTED
2410  *      @a show_messages was @c true, but wimlib was compiled with the @c
2411  *      --without-error-messages option.   Therefore, error messages cannot be
2412  *      shown.
2413  */
2414 extern int
2415 wimlib_set_print_errors(bool show_messages);
2416
2417 /**
2418  * Splits a WIM into multiple parts.
2419  *
2420  * @param wim
2421  *      The ::WIMStruct for the WIM to split.  It must be a standalone, one-part
2422  *      WIM.
2423  * @param swm_name
2424  *      Name of the SWM file to create.  This will be the name of the first
2425  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
2426  *      appended before the suffix.
2427  * @param part_size
2428  *      The maximum size per part, in bytes.  It is not guaranteed that this
2429  *      will really be the maximum size per part, because some file resources in
2430  *      the WIM may be larger than this size, and the WIM file format provides
2431  *      no way to split up file resources among multiple WIMs.
2432  * @param write_flags
2433  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2434  *      included in the split WIM parts.
2435  * @param progress_func
2436  *      If non-NULL, a function that will be called periodically with the
2437  *      progress of the current operation.
2438  *
2439  * @return 0 on success; nonzero on error.  This function may return any value
2440  * returned by wimlib_write() as well as the following error codes:
2441  *
2442  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2443  *      @a wim is not part 1 of a stand-alone WIM.
2444  * @retval ::WIMLIB_ERR_INVALID_PARAM
2445  *      @a swm_name was @c NULL, or @a part_size was 0.
2446  *
2447  * Note: the WIM's uncompressed and compressed resources are not checksummed
2448  * when they are copied from the joined WIM to the split WIM parts, nor are
2449  * compressed resources re-compressed.
2450  */
2451 extern int
2452 wimlib_split(WIMStruct *wim,
2453              const wimlib_tchar *swm_name,
2454              size_t part_size,
2455              int write_flags,
2456              wimlib_progress_func_t progress_func);
2457
2458 /**
2459  * Unmounts a WIM image that was mounted using wimlib_mount_image().
2460  *
2461  * The image to unmount is specified by the path to the mountpoint, not the
2462  * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2463  * touched and also may have been allocated in a different process.
2464  *
2465  * To unmount the image, the thread calling this function communicates with the
2466  * thread that is managing the mounted WIM image.  This function blocks until it
2467  * is known whether the unmount succeeded or failed.  In the case of a
2468  * read-write mounted WIM, the unmount is not considered to have succeeded until
2469  * all changes have been saved to the underlying WIM file.
2470  *
2471  * @param dir
2472  *      The directory that the WIM image was mounted on.
2473  * @param unmount_flags
2474  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2475  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2476  *      ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS.  None of these flags affect read-only
2477  *      mounts.
2478  * @param progress_func
2479  *      If non-NULL, a function that will be called periodically with the
2480  *      progress of the current operation.
2481  *
2482  * @return 0 on success; nonzero on error.
2483  *
2484  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2485  *      The filesystem daemon was unable to remove the staging directory and the
2486  *      temporary files that it contains.
2487  * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2488  *      The filesystem daemon appears to have terminated before sending an exit
2489  *      status.
2490  * @retval ::WIMLIB_ERR_FORK
2491  *      Could not @c fork() the process.
2492  * @retval ::WIMLIB_ERR_FUSERMOUNT
2493  *      The @b fusermount program could not be executed or exited with a failure
2494  *      status.
2495  * @retval ::WIMLIB_ERR_MQUEUE
2496  *      Could not open a POSIX message queue to communicate with the filesystem
2497  *      daemon servicing the mounted filesystem, could not send a message
2498  *      through the queue, or could not receive a message through the queue.
2499  * @retval ::WIMLIB_ERR_NOMEM
2500  *      Failed to allocate needed memory.
2501  * @retval ::WIMLIB_ERR_OPEN
2502  *      The filesystem daemon could not open a temporary file for writing the
2503  *      new WIM.
2504  * @retval ::WIMLIB_ERR_READ
2505  *      A read error occurred when the filesystem daemon tried to a file from
2506  *      the staging directory
2507  * @retval ::WIMLIB_ERR_RENAME
2508  *      The filesystem daemon failed to rename the newly written WIM file to the
2509  *      original WIM file.
2510  * @retval ::WIMLIB_ERR_UNSUPPORTED
2511  *      Mounting is not supported, either because the platform is Windows, or
2512  *      because the platform is UNIX and wimlib was compiled with @c
2513  *      --without-fuse.
2514  * @retval ::WIMLIB_ERR_WRITE
2515  *      A write error occurred when the filesystem daemon was writing to the new
2516  *      WIM file, or the filesystem daemon was unable to flush changes that had
2517  *      been made to files in the staging directory.
2518  */
2519 extern int
2520 wimlib_unmount_image(const wimlib_tchar *dir,
2521                      int unmount_flags,
2522                      wimlib_progress_func_t progress_func);
2523
2524 /**
2525  * Update a WIM image by adding, deleting, and/or renaming files or directories.
2526  *
2527  * @param wim
2528  *      Pointer to the ::WIMStruct for the WIM file to update.
2529  * @param image
2530  *      The 1-based index of the image in the WIM to update.  It cannot be
2531  *      ::WIMLIB_ALL_IMAGES.
2532  * @param cmds
2533  *      An array of ::wimlib_update_command's that specify the update operations
2534  *      to perform.
2535  * @param num_cmds
2536  *      Number of commands in @a cmds.
2537  * @param update_flags
2538  *      ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
2539  * @param progress_func
2540  *      If non-NULL, a function that will be called periodically with the
2541  *      progress of the current operation.
2542  *
2543  * @return 0 on success; nonzero on error.  On failure, some but not all of the
2544  * update commands may have been executed.  No individual update command will
2545  * have been partially executed.  Possible error codes include:
2546  *
2547  * @retval ::WIMLIB_ERR_DECOMPRESSION
2548  *      Failed to decompress the metadata resource from @a image in @a wim.
2549  * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
2550  *      The capture configuration structure specified for an add command was
2551  *      invalid.
2552  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2553  *      A directory entry for @a image in @a wim is invalid.
2554  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2555  *      @a image did not specify a single, existing image in @a wim.
2556  * @retval ::WIMLIB_ERR_INVALID_OVERLAY
2557  *      Attempted to perform an add command that conflicted with previously
2558  *      existing files in the WIM when an overlay was attempted.
2559  * @retval ::WIMLIB_ERR_INVALID_PARAM
2560  *      An unknown operation type was specified in the update commands; or,
2561  *      attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
2562  *      in the @a add_flags, but the same image had previously already been
2563  *      added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
2564  *      ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add
2565  *      command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
2566  *      specified in the @a add_flags for an add command in which @a
2567  *      wim_target_path was not the root directory of the WIM image.
2568  * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
2569  *      (Windows only):  While executing an add command, tried to capture a
2570  *      reparse point with invalid data.
2571  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2572  *      The metadata resource for @a image in @a wim is invalid.
2573  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2574  *      The security data for image @a image in @a wim is invalid.
2575  * @retval ::WIMLIB_ERR_IS_DIRECTORY
2576  *      A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
2577  *      for a WIM path that corresponded to a directory; or, a rename command
2578  *      attempted to rename a directory to a non-directory.
2579  * @retval ::WIMLIB_ERR_NOMEM
2580  *      Failed to allocate needed memory.
2581  * @retval ::WIMLIB_ERR_NOTDIR
2582  *      A rename command attempted to rename a directory to a non-directory; or,
2583  *      an add command was executed that attempted to set the root of the WIM
2584  *      image as a non-directory; or, a path component used as a directory in a
2585  *      rename command was not, in fact, a directory.
2586  * @retval ::WIMLIB_ERR_NOTEMPTY
2587  *      A rename command attempted to rename a directory to a non-empty
2588  *      directory.
2589  * @retval ::WIMLIB_ERR_NTFS_3G
2590  *      While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
2591  *      error occurred while reading data from the NTFS volume using libntfs-3g.
2592  * @retval ::WIMLIB_ERR_OPEN
2593  *      Failed to open a file to be captured while executing an add command.
2594  * @retval ::WIMLIB_ERR_OPENDIR
2595  *      Failed to open a directory to be captured while executing an add command.
2596  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2597  *      A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
2598  *      WIM path that did not exist; or, a rename command attempted to rename a
2599  *      file that does not exist.
2600  * @retval ::WIMLIB_ERR_READ
2601  *      Failed to read the metadata resource for @a image in @a wim; or, while
2602  *      executing an add command, failed to read data from a file or directory
2603  *      to be captured.
2604  * @retval ::WIMLIB_ERR_READLINK
2605  *      While executing an add command, failed to read the target of a symbolic
2606  *      link or junction point.
2607  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2608  *      (Windows only) Failed to perform a reparse point fixup because of
2609  *      problems with the data of a reparse point.
2610  * @retval ::WIMLIB_ERR_SPECIAL_FILE
2611  *      While executing an add command, attempted to capture a file that was not
2612  *      a supported file type, such as a regular file, directory, symbolic link,
2613  *      or (on Windows) a reparse point.
2614  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2615  *      @a wim is part of a split WIM.  Updating a split WIM is unsupported.
2616  * @retval ::WIMLIB_ERR_STAT
2617  *      While executing an add command, failed to get attributes for a file or
2618  *      directory.
2619  * @retval ::WIMLIB_ERR_UNSUPPORTED
2620  *      ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update
2621  *      command, but wimlib was configured with the @c --without-ntfs-3g flag;
2622  *      or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
2623  *      or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a
2624  *      add_flags for an update command.
2625  */
2626 extern int
2627 wimlib_update_image(WIMStruct *wim,
2628                     int image,
2629                     const struct wimlib_update_command *cmds,
2630                     size_t num_cmds,
2631                     int update_flags,
2632                     wimlib_progress_func_t progress_func);
2633
2634 /**
2635  * Writes a standalone WIM to a file.
2636  *
2637  * This brings in resources from any external locations, such as directory trees
2638  * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2639  * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2640  *
2641  * @param wim
2642  *      Pointer to the ::WIMStruct for a WIM.  There may have been in-memory
2643  *      changes made to it, which are then reflected in the output file.
2644  * @param path
2645  *      The path to the file to write the WIM to.
2646  * @param image
2647  *      The image inside the WIM to write.  Use ::WIMLIB_ALL_IMAGES to include all
2648  *      images.
2649  * @param write_flags
2650  *      Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2651  *      ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2652  *      ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2653  * @param num_threads
2654  *      Number of threads to use for compressing data.  If 0, the number of
2655  *      threads is taken to be the number of online processors.  Note: if no
2656  *      data compression needs to be done, no additional threads will be created
2657  *      regardless of this parameter (e.g. if writing an uncompressed WIM, or
2658  *      exporting an image from a compressed WIM to another WIM of the same
2659  *      compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2660  *      write_flags).
2661  * @param progress_func
2662  *      If non-NULL, a function that will be called periodically with the
2663  *      progress of the current operation.
2664  *
2665  * @return 0 on success; nonzero on error.
2666  * @retval ::WIMLIB_ERR_DECOMPRESSION
2667  *      Failed to decompress a metadata or file resource in @a wim.
2668  * @retval ::WIMLIB_ERR_INVALID_DENTRY
2669  *      A directory entry in the metadata resource for @a image in @a wim is
2670  *      invalid.
2671  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2672  *      @a image does not specify a single existing image in @a wim, and is not
2673  *      ::WIMLIB_ALL_IMAGES.
2674  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2675  *      A file that had previously been scanned for inclusion in the WIM by
2676  *      wimlib_add_image() was concurrently modified, so it failed the SHA1
2677  *      message digest check.
2678  * @retval ::WIMLIB_ERR_INVALID_PARAM
2679  *      @a path was @c NULL.
2680  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2681  *      The metadata resource for @a image in @a wim is invalid.
2682  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2683  *      The security data for @a image in @a wim is invalid.
2684  * @retval ::WIMLIB_ERR_NOMEM
2685  *      Failed to allocate needed memory.
2686  * @retval ::WIMLIB_ERR_OPEN
2687  *      Failed to open @a path for writing, or some file resources in @a
2688  *      wim refer to files in the outside filesystem, and one of these files
2689  *      could not be opened for reading.
2690  * @retval ::WIMLIB_ERR_READ
2691  *      An error occurred when trying to read data from the WIM file associated
2692  *      with @a wim, or some file resources in @a wim refer to files in the
2693  *      outside filesystem, and a read error occurred when reading one of these
2694  *      files.
2695  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2696  *      @a wim is part of a split WIM.  You may not call this function on a
2697  *      split WIM.
2698  * @retval ::WIMLIB_ERR_WRITE
2699  *      An error occurred when trying to write data to the new WIM file at @a
2700  *      path.
2701  */
2702 extern int
2703 wimlib_write(WIMStruct *wim,
2704              const wimlib_tchar *path,
2705              int image,
2706              int write_flags,
2707              unsigned num_threads,
2708              wimlib_progress_func_t progress_func);
2709
2710 /**
2711  * This function is equivalent to wimlib_lzx_compress(), but instead compresses
2712  * the data using "XPRESS" compression.
2713  */
2714 extern unsigned
2715 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
2716
2717 /**
2718  * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
2719  * the data is compressed using "XPRESS" compression.
2720  */
2721 extern int
2722 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
2723                          void *uncompressed_data, unsigned uncompressed_len);
2724
2725 #endif /* _WIMLIB_H */