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