NTFS mount(to be removed)
[wimlib] / src / wimlib.h
1 /*
2  * wimlib.h
3  *
4  * External header for wimlib.
5  */
6
7 /* 
8  * Copyright (C) 2012 Eric Biggers
9  *
10  * This file is part of wimlib, a library for working with WIM files.
11  *
12  * wimlib is free software; you can redistribute it and/or modify it under the
13  * terms of the GNU Lesser General Public License as published by the Free
14  * Software Foundation; either version 2.1 of the License, or (at your option)
15  * any later version.
16  *
17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19  * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
20  * details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
24  */
25
26 /** \mainpage
27  *
28  * \section intro Introduction
29  *
30  * wimlib is a C library to read, write, and mount archive files in the Windows
31  * Imaging Format (WIM files).  These files are normally created using the @c
32  * imagex.exe utility on Windows, but this library provides a free
33  * implementetion of @c imagex for UNIX-based systems and an API to allow other
34  * programs to read, write, and mount WIM files.  wimlib is comparable to
35  * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
36  * 
37  * The main intended use of wimlib is to create customized images of Windows PE,
38  * the Windows Preinstallation Environment, without having to rely on Windows.
39  * Windows PE, which is the operating system that runs when you boot from the
40  * Windows Vista or Windows 7 DVD, is a lightweight version of Windows that can
41  * run entirely from memory. It can be used to install Windows from local media
42  * or a network drive or perform maintenance. 
43  * 
44  * You can find Windows PE on the installation media for Windows Vista, Windows
45  * 7, and Windows 8.  The Windows PE image itself is a WIM file, @c
46  * sources/boot.wim, on the ISO filesystem.  Windows PE can also be found in the
47  * Windows Automated Installation Kit (WAIK) inside the @c WinPE.cab file, which
48  * you can extract if you install the @c cabextract program.
49  *
50  * \section format WIM files
51  *
52  * A <b>Windows Imaging (WIM)</b> file is an archive.  Like some other archive
53  * formats such as ZIP, files in WIM archives may be compressed.  WIM archives
54  * support two Microsoft-specific compression formats:  @b LZX and @b XPRESS.
55  * Both are based on LZ77 and Huffman encoding, and both are supported by
56  * wimlib.
57  *
58  * Unlike ZIP files, WIM files can contain multiple independent toplevel
59  * directory trees known as @a images.  While each image has its own metadata,
60  * files are not duplicated for each image; instead, each file is included only
61  * once in the entire WIM. Microsoft did this so that in one WIM file, they
62  * could do things like have 5 different versions of Windows that are almost
63  * exactly the same.
64  *
65  * WIM files may contain a integrity table.  The integrity table, if it exists,
66  * is located at the end of the WIM file and contains SHA1 message digests of
67  * 10MB chunks of the WIM.
68  *
69  * Microsoft provides documentation for the WIM file format, XPRESS compression
70  * format, and LZX compression format.  However, there are errors and omissions
71  * in some places in their documentation.
72  *
73  * \section starting Getting Started
74  *
75  * wimlib uses the GNU autotools, so it should be easy to install with
76  * <code>configure && make && sudo make install</code>, provided that you have
77  * @c libxml2 and @c libfuse installed.  To use wimlib in a program after
78  * installing it, include @c wimlib.h and link your program with @c -lwim.
79  *
80  * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.
81  *
82  * All functions in wimlib's public API are prefixed with @c wimlib.  Most
83  * return an integer error code on failure.  Use wimlib_get_error_string() to
84  * get a string that describes an error code.  wimlib also can print error
85  * messages itself when an error happens, and these may be more informative than
86  * the error code; to enable this, call wimlib_set_print_errors().
87  *
88  * wimlib is thread-safe as long as different ::WIMStruct's are used, with the
89  * following exceptions:  wimlib_set_print_errors() and
90  * wimlib_set_memory_allocator() apply globally, and wimlib_mount() can only be
91  * used by one ::WIMStruct at a time.
92  *
93  * To open an existing WIM, use wimlib_open_wim().
94  *
95  * To create a new WIM that initially contains no images, use
96  * wimlib_create_new_wim().
97  *
98  * To add an image to a WIM file from a directory tree on your filesystem, call
99  * wimlib_add_image().  This can be done with a ::WIMStruct gotten from
100  * wimlib_open_wim() or from wimlib_create_new_wim().
101  *
102  * To extract an image from a WIM file, call wimlib_set_output_dir() to set the
103  * output directory, then call wimlib_extract_image().
104  *
105  * wimlib supports mounting WIM files either read-only or read-write.  Mounting
106  * is done using wimlib_mount() and unmounting is done using wimlib_unmount().
107  * Mounting can be done without root privileges because it is implemented using
108  * FUSE (Filesystem in Userspace).  If wimlib is compiled with the
109  * <code>--without-fuse</code> flag, these functions will be available but will
110  * fail.
111  *
112  * After creating or modifying a WIM file, you can write it to a file using
113  * wimlib_write().  Alternatively,  if the WIM was originally read from a file,
114  * you can use wimlib_overwrite() to overwrite the original file.  In some
115  * cases, wimlib_overwrite_xml_and_header() can be used instead.
116  *
117  * After you are done with the WIM file, use wimlib_free() to free all memory
118  * associated with a ::WIMStruct and close all files associated with it.
119  *
120  * To see an example of how to use wimlib, see the file
121  * @c programs/imagex.c in wimlib's source tree.
122  *
123  * wimlib supports custom memory allocators; use wimlib_set_memory_allocator()
124  * for this.
125  *
126  * \section imagex imagex
127  *
128  * wimlib comes with the <b>imagex</b> program, which is documented in man pages.
129  *
130  * \section mkwinpeimg mkwinpeimg
131  * 
132  * wimlib comes with the <b>mkwinpeimg</b> script, which is documented in a man
133  * page.
134  *
135  * \section Limitations
136  *
137  * While wimlib supports the main features of WIM files, wimlib currently has
138  * the following limitations:
139  * - wimlib does not support modifying or creating "security data", which
140  *   describes the access rights of the files in the WIM.  This data is very
141  *   Windows-specific, and it would be difficult to do anything with it.
142  *   Microsoft's software can still read a WIM without security data, including
143  *   a boot.wim for Windows PE, but <b>do not expect to be able to use wimlib to
144  *   image a Windows installation and preserve file attributes</b>.  However, by
145  *   default, wimlib will preserve security data for existing WIMs.
146  * - There is no way to directly extract or mount split WIMs.
147  * - There is not yet any code to verify that there are no collisions between
148  *   different files that happen to have the same SHA1 message digest.
149  *   This is extremely unlikely, but could result in something bad such as a
150  *   file going missing.
151  * - Alternate stream entries for directory entries are ignored.
152  * - Different versions of the WIM file format, if they even exist, are
153  *   unsupported.  Let me know if you notice WIM files with a different version.
154  * - Chunk sizes other than 32768 are unsupported (except for uncompressed WIMs,
155  *   for which the chunk size field is ignored).  As far as I can tell, other
156  *   chunk sizes are not used in compressed WIMs.  Let me know if you find a WIM
157  *   file with a different chunk size.
158  * - wimlib does not provide a clone of the @b PEImg tool that allows you to
159  *   make certain Windows-specific modifications to a Windows PE image, such as
160  *   adding a driver or Windows component.  Such a tool could conceivably be
161  *   implemented on top of wimlib, although it likely would be hard to implement
162  *   because it would have to do very Windows-specific things such as
163  *   manipulating the driver store.  wimlib does provide the @b mkwinpeimg
164  *   script for a similar purpose, however.  With regards to adding drivers to
165  *   Windows PE, you have the option of putting them anywhere in the Windows PE
166  *   image, then loading them after boot using @b drvload.exe.
167  * - There is not yet a way to extract specific files or directories from a WIM
168  *   file without mounting it, or to add, remove, or modify files in a WIM
169  *   without mounting it, other than by adding or removing an entire image.  I
170  *   can implement this if requested, but I intend the FUSE mount feature to be
171  *   used for this purpose, as it is easy to do these things in whatever way you
172  *   want after the image is mounted.
173  *
174  * Currently, Microsoft's @a image.exe can create slightly smaller WIM files
175  * than wimlib when using maximum (LZX) compression because it knows how to
176  * split up LZX compressed blocks, which is not yet implemented in wimlib.
177  *
178  * wimlib is experimental and likely contains bugs; use Microsoft's @a
179  * imagex.exe if you want to make sure your WIM files are made "correctly".
180  *
181  * \section legal License
182  *
183  * The wimlib library is licensed under the GNU Lesser General Public License
184  * version 2.1 or later.
185  *
186  * @b imagex and @b mkwinpeiso are licensed under the GNU General Public License
187  * version 3 or later.
188  */
189
190 #ifndef _WIMLIB_H
191 #define _WIMLIB_H
192
193 #include <stdio.h>
194 #include <stddef.h>
195 #include <stdbool.h>
196
197 #ifndef _WIMLIB_INTERNAL_H
198 /** 
199  * Opaque structure that represents a WIM file. 
200  */
201 typedef struct WIMStruct WIMStruct;
202 #endif
203
204 /** 
205  * Specifies the way in which identical files are linked when extracting
206  * image(s) from the WIM. 
207  */
208 enum wim_link_type {
209 /** Hard link identical files when extracting files from the WIM. */
210         WIM_LINK_TYPE_HARD = 0,
211 /** Symbolic link identical files when extracting files from the WIM. */
212         WIM_LINK_TYPE_SYMBOLIC = 1,
213 /** Do not create links when extracting identical files from the WIM (default).
214  * */
215         WIM_LINK_TYPE_NONE = 2,
216 };
217
218 /**
219  * Specifies the compression type of a WIM file.
220  */
221
222 enum wim_compression_type {
223         /** An invalid compression type. */
224         WIM_COMPRESSION_TYPE_INVALID = -1,
225
226         /** The WIM does not include any compressed resources. */
227         WIM_COMPRESSION_TYPE_NONE = 0,
228
229         /** Compressed resources in the WIM use LZX compression. */
230         WIM_COMPRESSION_TYPE_LZX = 1,
231
232         /** Compressed resources in the WIM use XPRESS compression. */
233         WIM_COMPRESSION_TYPE_XPRESS = 2,
234 };
235
236 /** Mount the WIM read-write. */
237 #define WIMLIB_MOUNT_FLAG_READWRITE             0x00000001
238
239 /** For debugging only. (This passes the @c -d flag to @c fuse_main()).*/
240 #define WIMLIB_MOUNT_FLAG_DEBUG                 0x00000002
241
242 /** Do not allow accessing alternate data streams. */
243 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000010
244
245 /** Access alternate data streams through extended file attributes.  This is the
246  * default mode. */
247 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000020
248
249 /** Access alternate data streams by specifying the file name, a colon, then the
250  * alternate file stream name. */
251 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000040
252
253 /** Include an integrity table in the new WIM being written during the unmount. 
254  * Ignored for read-only mounts. */
255 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY     0x00000001
256
257 /** Unless this flag is given, changes to a mounted WIM are discarded.  Ignored
258  * for read-only mounts. */
259 #define WIMLIB_UNMOUNT_FLAG_COMMIT              0x00000002
260
261 /** Include an integrity table in the new WIM file. */
262 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY       0x00000001
263
264 /** Print progress information when writing the integrity table. */
265 #define WIMLIB_WRITE_FLAG_SHOW_PROGRESS         0x00000002
266
267 /** Mark the image being added as the bootable image of the WIM. */
268 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              0x00000001
269
270 /** Print the name of each file or directory as it is scanned to be included in
271  * the WIM image. */
272 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           0x00000002
273
274 /** Apply NTFS-specific information to the captured WIM image.  This flag can
275  * only be specified if the directory being captured is on a NTFS filesystem
276  * mounted with NTFS-3g, and wimlib was compiled with support for NTFS-3g  */
277 #define WIMLIB_ADD_IMAGE_FLAG_NTFS              0x00000004
278
279 /** Follow symlinks; archive and dump the files they point to. */
280 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       0x00000008
281
282 /** See documentation for wimlib_export_image(). */
283 #define WIMLIB_EXPORT_FLAG_BOOT                 0x00000001
284
285 /** Verify the integrity of the WIM if an integrity table is present. */
286 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY        0x00000001
287
288 /** Print progress information when verifying integrity table. */
289 #define WIMLIB_OPEN_FLAG_SHOW_PROGRESS          0x00000002
290
291 /** If this flag is not given, an error is issued if the WIM is part of a split
292  * WIM.  */
293 #define WIMLIB_OPEN_FLAG_SPLIT_OK               0x00000004
294
295
296 /** When identical files are extracted from the WIM, hard link them together. */
297 #define WIMLIB_EXTRACT_FLAG_HARDLINK            0x00000001
298
299 /** When identical files are extracted from the WIM, symlink them together. */
300 #define WIMLIB_EXTRACT_FLAG_SYMLINK             0x00000002
301
302 /** Apply NTFS-specific information when applying the WIM image.  This flag can
303  * only be specified if the output directory is on a NTFS filesystem mounted
304  * with NTFS-3g, and wimlib was compiled with support for NTFS-3g  */
305 #define WIMLIB_EXTRACT_FLAG_NTFS                0x00000004
306
307 /** Print the name of each file as it is extracted from the WIM image. */
308 #define WIMLIB_EXTRACT_FLAG_VERBOSE             0x00000008
309
310 /**
311  * Possible values of the error code returned by many functions in wimlib.
312  *
313  * See the documentation for each wimlib function to see specifically what error
314  * codes can be returned by a given function, and what they mean.
315  */
316 enum wimlib_error_code {
317         WIMLIB_ERR_SUCCESS = 0,
318         WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
319         WIMLIB_ERR_DECOMPRESSION,
320         WIMLIB_ERR_DELETE_STAGING_DIR,
321         WIMLIB_ERR_FORK,
322         WIMLIB_ERR_FUSE,
323         WIMLIB_ERR_FUSERMOUNT,
324         WIMLIB_ERR_IMAGE_COUNT,
325         WIMLIB_ERR_IMAGE_NAME_COLLISION,
326         WIMLIB_ERR_INTEGRITY,
327         WIMLIB_ERR_INVALID_CHUNK_SIZE,
328         WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
329         WIMLIB_ERR_INVALID_DENTRY,
330         WIMLIB_ERR_INVALID_HEADER_SIZE,
331         WIMLIB_ERR_INVALID_IMAGE,
332         WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
333         WIMLIB_ERR_INVALID_PARAM,
334         WIMLIB_ERR_INVALID_RESOURCE_SIZE,
335         WIMLIB_ERR_INVALID_SECURITY_DATA,
336         WIMLIB_ERR_LINK,
337         WIMLIB_ERR_MKDIR,
338         WIMLIB_ERR_MQUEUE,
339         WIMLIB_ERR_NOMEM,
340         WIMLIB_ERR_NOTDIR,
341         WIMLIB_ERR_NOT_A_WIM_FILE,
342         WIMLIB_ERR_NOT_ROOT,
343         WIMLIB_ERR_NO_FILENAME,
344         WIMLIB_ERR_NTFS_3G,
345         WIMLIB_ERR_OPEN,
346         WIMLIB_ERR_OPENDIR,
347         WIMLIB_ERR_READLINK,
348         WIMLIB_ERR_READ,
349         WIMLIB_ERR_RENAME,
350         WIMLIB_ERR_SPECIAL_FILE,
351         WIMLIB_ERR_SPLIT_INVALID,
352         WIMLIB_ERR_SPLIT_UNSUPPORTED,
353         WIMLIB_ERR_STAT,
354         WIMLIB_ERR_TIMEOUT,
355         WIMLIB_ERR_UNKNOWN_VERSION,
356         WIMLIB_ERR_UNSUPPORTED,
357         WIMLIB_ERR_WRITE,
358         WIMLIB_ERR_XML,
359 };
360
361
362 /** Used to indicate that no WIM image is currently selected. */
363 #define WIM_NO_IMAGE    0
364
365 /** Used to specify all images in the WIM. */
366 #define WIM_ALL_IMAGES  (-1)
367
368
369 /**
370  * Adds an image to a WIM file from a directory tree on disk.
371  *
372  * The directory tree is read immediately for the purpose of constructing a
373  * directory entry tree in-memory.  Also, all files are read to calculate their
374  * SHA1 message digests.  However, because the directory tree may contain a very
375  * large amount of data, the files themselves are not read into memory
376  * permanently, and instead references to their paths saved.  This means that
377  * the directory tree must not be modified, other than by adding entirely new
378  * files or directories, before executing a call to wimlib_write() or
379  * wimlib_overwrite(). Otherwise, wimlib_write() may fail or incorrect files may
380  * be included in the WIM written by wimlib_write().
381  *
382  * @param wim
383  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
384  *      added.
385  * @param dir
386  *      A path to a directory in the outside filesystem.  It will become the
387  *      root directory for the WIM image.
388  * @param name
389  *      The name to give the image.  This must be non-@c NULL.
390  * @param description
391  *      The description to give the image.  This parameter may be left @c
392  *      NULL, in which case no description is given to the image.
393  * @param flags_element
394  *      What to put in the &lt;FLAGS&gt; element for the image's XML data.  This
395  *      parameter may be left @c NULL, in which case no &lt;FLAGS&gt; element is
396  *      given to the image.
397  * @param flags
398  *      If set to ::WIMLIB_ADD_IMAGE_FLAG_BOOT, change the image in @a wim
399  *      marked as bootable to the one being added. Otherwise, leave the boot
400  *      index unchanged.
401  *
402  * @return 0 on success; nonzero on error.  On error, changes to @a wim are
403  * discarded so that it appears to be in the same state as when this function
404  * was called.
405  *
406  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION 
407  *      There is already an image named @a name in @a w.
408  * @retval ::WIMLIB_ERR_INVALID_PARAM 
409  *      @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
410  * @retval ::WIMLIB_ERR_NOMEM
411  *      Failed to allocate needed memory.
412  * @retval ::WIMLIB_ERR_NOTDIR
413  *      @a dir is not a directory.
414  * @retval ::WIMLIB_ERR_OPEN
415  *      Failed to open a file or directory in the directory tree rooted at @a
416  *      dir.
417  * @retval ::WIMLIB_ERR_READ
418  *      Failed to read a file in the directory tree rooted at @a dir.
419  * @retval ::WIMLIB_ERR_STAT
420  *      Failed obtain the metadata for a file or directory in the directory tree
421  *      rooted at @a dir.
422  *
423  */
424 extern int wimlib_add_image(WIMStruct *wim, const char *dir, 
425                             const char *name, const char *description, 
426                             const char *flags_element, int flags);
427
428 extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *w, int image,
429                                              const char *device, int flags);
430
431 /** 
432  * Creates a WIMStruct for a new WIM file.
433  *
434  * @param ctype 
435  *      The type of compression to be used in the new WIM file.  Must be
436  *      ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
437  *      ::WIM_COMPRESSION_TYPE_XPRESS.
438  * @param wim_ret
439  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
440  *      written to the memory location pointed to by this paramater.  The
441  *      ::WIMStruct must be freed using using wimlib_free() when finished with
442  *      it.
443  * @return 0 on success; nonzero on error.
444  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
445  *      @a ctype was not ::WIM_COMPRESSION_TYPE_NONE,
446  *      ::WIM_COMPRESSION_TYPE_LZX, or ::WIM_COMPRESSION_TYPE_XPRESS.
447  * @retval ::WIMLIB_ERR_NOMEM
448  *      Failed to allocate needed memory.
449  */
450 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
451
452 /**
453  * Deletes an image, or all images, from a WIM file.
454  *
455  * All file resources referenced by the image(s) being deleted are removed from
456  * the WIM if they are not referenced by any other images in the WIM.
457  *
458  * @param wim
459  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
460  *      being deleted.
461  * @param image
462  *      The number of the image to delete, or ::WIM_ALL_IMAGES to delete all
463  *      images.
464  * @return 0 on success; nonzero on error.  On error, @a wim is left in an
465  * indeterminate state and should be freed with wimlib_free().
466  * @retval ::WIMLIB_ERR_DECOMPRESSION
467  *      Could not decompress the metadata resource for @a image.
468  * @retval ::WIMLIB_ERR_INVALID_DENTRY
469  *      A directory entry in the metadata resource for @a image in the WIM is
470  *      invalid.
471  * @retval ::WIMLIB_ERR_INVALID_IMAGE
472  *      @a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
473  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
474  *      The metadata resource for @a image in the WIM is invalid.       
475  * @retval ::WIMLIB_ERR_NOMEM Failed to allocate needed memory.
476  * @retval ::WIMLIB_ERR_READ
477  *      Could not read the metadata resource for @a image from the WIM.
478  */
479 extern int wimlib_delete_image(WIMStruct *wim, int image);
480
481 /**
482  * Copies an image, or all the images, from a WIM file, into another WIM file.
483  *
484  * @param src_wim
485  *      Pointer to the ::WIMStruct for a WIM file that contains the image(s)
486  *      being exported.
487  * @param src_image
488  *      The image to export from @a src_wim.  Can be the number of an image, or
489  *      ::WIM_ALL_IMAGES to export all images.
490  * @param dest_wim
491  *      Pointer to the ::WIMStruct for a WIM filethat will receive the images being
492  *      exported.
493  * @param dest_name
494  *      The name to give the exported image in the new WIM file.  If left @c NULL,
495  *      the name from @a src_wim is used.  This parameter must be left @c NULL
496  *      if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains more than one
497  *      image; in that case, the names are all taken from the @a src_wim.
498  * @param dest_description
499  *      The description to give the exported image in the new WIM file.  If left
500  *      @c NULL, the description from the @a src_wim is used.  This parameter must
501  *      be left @c NULL if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains
502  *      more than one image; in that case, the descriptions are all taken from
503  *      @a src_wim.
504  * @param flags
505  *      ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
506  *      bootable, or 0 if which image is marked as bootable in the destination
507  *      WIM is to be left unchanged.  If @a src_image is ::WIM_ALL_IMAGES and
508  *      there are multiple images in @a src_wim, specifying
509  *      ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
510  *      currently marked as bootable in @a src_wim; if that is the case, then
511  *      that image is marked as bootable in the destination WIM.
512  *
513  * @return 0 on success; nonzero on error.  On error, @dest_wim is left in an
514  * indeterminate state and should be freed with wimlib_free().
515  * @retval ::WIMLIB_ERR_DECOMPRESSION
516  *      Could not decompress the metadata resource for @a src_image
517  *      in @a src_wim
518  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
519  *      One or more of the names being given to an exported image was already in
520  *      use in the destination WIM.
521  * @retval ::WIMLIB_ERR_INVALID_DENTRY 
522  *      A directory entry in the metadata resource for @a src_image in @a
523  *      src_wim is invalid.
524  * @retval ::WIMLIB_ERR_INVALID_IMAGE
525  *      @a src_image does not exist in @a src_wim.
526  * @retval ::WIMLIB_ERR_INVALID_PARAM
527  *      ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
528  *      ::WIM_ALL_IMAGES, @a src_wim contains multiple images, and no images in
529  *      @a src_wim are marked as bootable; or @a dest_name and/or @a
530  *      dest_description were non-<code>NULL</code>, @a src_image was
531  *      ::WIM_ALL_IMAGES, and @a src_wim contains multiple images.
532  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
533  *      The metadata resource for @a src_image in @a src_wim is invalid.        
534  * @retval ::WIMLIB_ERR_NOMEM 
535  *      Failed to allocate needed memory.
536  * @retval ::WIMLIB_ERR_READ
537  *      Could not read the metadata resource for @a src_image from @a src_wim.
538  */
539 extern int wimlib_export_image(WIMStruct *src_wim, int src_image, 
540                                WIMStruct *dest_wim, const char *dest_name, 
541                                const char *dest_description, int flags);
542
543 /**
544  * Extracts an image, or all images, from a WIM file.
545  *
546  * The output directory must have been previously set with
547  * wimlib_set_output_dir().
548  *
549  * The link type used for extracted files is that specified by a previous call
550  * to wimlib_set_link_type(), or ::WIM_LINK_TYPE_NONE by default.
551  *
552  * @param wim
553  *      Pointer to the ::WIMStruct for a WIM file.
554  * @param image
555  *      The image to extract.  Can be the number of an image, or ::WIM_ALL_IMAGES
556  *      to specify that all images are to be extracted.
557  *
558  * @return 0 on success; nonzero on error.
559  * @retval ::WIMLIB_ERR_DECOMPRESSION
560  *      Could not decompress a resource (file or metadata) for @a image in @a
561  *      wim.
562  * @retval ::WIMLIB_ERR_INVALID_DENTRY 
563  *      A directory entry in the metadata resource for @a image in @a wim is
564  *      invalid.
565  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
566  *      A resource (file or metadata) for @a image in @a wim is invalid.        
567  * @retval ::WIMLIB_ERR_LINK
568  *      Failed to create a symbolic link or a hard link.
569  * @retval ::WIMLIB_ERR_MKDIR
570  *      Failed create a needed directory.
571  * @retval ::WIMLIB_ERR_NOMEM
572  *      Failed to allocate needed memory.
573  * @retval ::WIMLIB_ERR_NOTDIR
574  *      wimlib_set_output_dir() has not been successfully called on @a wim.
575  * @retval ::WIMLIB_ERR_OPEN
576  *      Could not open one of the files being extracted for writing.
577  * @retval ::WIMLIB_ERR_READ
578  *      A unexpected end-of-file or read error occurred when trying to read data
579  *      from the WIM file associated with @a wim.
580  * @retval ::WIMLIB_ERR_WRITE
581  *      Failed to write a file being extracted.
582  */
583 extern int wimlib_extract_image(WIMStruct *wim, int image,
584                                 const char *output_dir, int flags);
585
586 /**
587  * Extracts the XML data for a WIM file to a file stream.  Every WIM file
588  * includes a string of XML that describes the images contained in the WIM.
589  *
590  * @param wim
591  *      Pointer to the ::WIMStruct for a WIM file.
592  * @param fp 
593  *      @c stdout, or a FILE* opened for writing, to extract the data to.  
594  *
595  * @return 0 on success; nonzero on error.
596  * @retval ::WIMLIB_ERR_WRITE
597  *      Failed to completely write the XML data to @a fp.
598  */
599 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
600
601 /**
602  * Frees all memory allocated for a WIMStruct and closes all files associated
603  * with it. 
604  *
605  * @param wim
606  *      Pointer to the ::WIMStruct for a WIM file.
607  *
608  * @return This function has no return value.
609  */
610 extern void wimlib_free(WIMStruct *wim);
611
612 /**
613  * Finds which image in a WIM is bootable.
614  *
615  * @param wim
616  *      Pointer to the ::WIMStruct for a WIM file.
617  * 
618  * @return
619  *      0 if no image is marked as bootable, or the number of the image marked
620  *      as bootable (numbered starting at 1).
621  */
622 extern int wimlib_get_boot_idx(const WIMStruct *wim);
623
624 /**
625  * Gets the compression type used in the WIM.
626  *
627  * @param wim
628  *      Pointer to the ::WIMStruct for a WIM file
629  * 
630  * @return
631  *      ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
632  *      ::WIM_COMPRESSION_TYPE_XPRESS.
633  */
634 extern int wimlib_get_compression_type(const WIMStruct *wim);
635
636 /**
637  * Converts a compression type enumeration value into a string.
638  *
639  * @param ctype
640  *      ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX,
641  *      ::WIM_COMPRESSION_TYPE_XPRESS, or another value.
642  *
643  * @return
644  *      A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
645  *      respectively.
646  */
647 extern const char *wimlib_get_compression_type_string(int ctype);
648
649 /**
650  * Converts an error code into a string describing it.
651  *
652  * @param code
653  *      The error code returned by one of wimlib's functions.
654  *
655  * @return
656  *      Pointer to a statically allocated string describing the error code,
657  *      or @c NULL if the error code is not valid.
658  */
659 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
660
661 /**
662  * Returns the description of the specified image.
663  *
664  * @param wim
665  *      Pointer to the ::WIMStruct for a WIM file.
666  * @param image
667  *      The number of the image, numbered starting at 1.
668  *
669  * @return
670  *      The description of the image, or @c NULL if there is no such image, or @c NULL
671  *      if the specified image has no description.
672  */
673 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
674
675 /**
676  * Returns the name of the specified image.
677  *
678  * @param wim
679  *      Pointer to the ::WIMStruct for a WIM file.
680  * @param image
681  *      The number of the image, numbered starting at 1.
682  *
683  * @return
684  *      The name of the image, or @c NULL if there is no such image.
685  */
686 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
687
688
689 /**
690  * Gets the number of images contained in the WIM.
691  *
692  * @param wim
693  *      Pointer to the ::WIMStruct for a WIM file.
694  * 
695  * @return
696  *      The number of images contained in the WIM file.
697  */
698 extern int wimlib_get_num_images(const WIMStruct *wim);
699
700 /**
701  * Gets the part number of the wim (in a split WIM).
702  *
703  * @param wim
704  *      Pointer to the ::WIMStruct for a WIM file.
705  * @param total_parts_ret
706  *      If non-@c NULL, the total number of parts in the split WIM (1 for
707  *      non-split WIMs) is written to this location.
708  *
709  * @return 
710  *      The part number of the WIM (1 for non-split WIMs)
711  */
712 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
713
714 /**
715  * Returns true if the WIM has an integrity table.
716  *
717  * @param wim
718  *      Pointer to the ::WIMStruct for a WIM file.
719  * @return
720  *      @c true if the WIM has an integrity table; false otherwise.
721  */
722 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
723
724
725 /**
726  * Determines if an image name is already used by some image in the WIM.
727  *
728  * @param wim
729  *      Pointer to the ::WIMStruct for a WIM file.
730  * @param name
731  *      The name to check.
732  *
733  * @return
734  *      @c true if there is already an image in @a wim named @a name; @c
735  *      false if there is no image named @a name in @a wim.
736  */
737 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
738
739 /**
740  * Joins a set of split WIMs into a one-part WIM.
741  *
742  * @param swms
743  *      An array of strings that give the filenames of all parts of the split
744  *      WIM.
745  * @param num_swms
746  *      Number of filenames in @a swms.
747  * @param output_path
748  *      The path to write the one-part WIM to.
749  * @param flags
750  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY to check the split WIMs' integrity
751  *      tables (if present) when opening them, and include an integrity table in
752  *      the output WIM.
753  *
754  * @return 0 on success; nonzero on error.  This function may return any value
755  * returned by wimlib_open_wim() except ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well
756  * as the following error codes:
757  *
758  * @retval ::WIMLIB_ERR_SPLIT_INVALID
759  *      The split WIMs do not form a valid WIM because they do not include all
760  *      the parts of the original WIM, there are duplicate parts, or not all the
761  *      parts have the same GUID and compression type.
762  * @retval ::WIMLIB_ERR_WRITE
763  *      An error occurred when trying to write data to the new WIM at @a output_path.
764  *
765  * Note that this function merely copies the resources, so it will not check to
766  * see if the resources, including the metadata resource, are valid or not.
767  */
768 extern int wimlib_join(const char **swms, int num_swms,
769                        const char *output_path, int flags);
770
771 /**
772  * Mounts an image in a WIM file on a directory read-only or read-write.
773  *
774  * A daemon will be forked to service the filesystem.
775  *
776  * If the mount is read-write, modifications to the WIM are staged in a staging
777  * directory.
778  *
779  * wimlib_mount() currently cannot be used with multiple ::WIMStruct's without
780  * intervening wimlib_unmount()s.  If there was a way to have libfuse pass a
781  * pointer to user data to each FUSE callback, then this would be possible, but
782  * there doesn't seem to be a way to do this currently.
783  *
784  * @param wim
785  *      Pointer to the ::WIMStruct for the WIM file to be mounted.
786  * @param image
787  *      The number of the image to mount, numbered from 1.  It must be an
788  *      existing, single image.
789  * @param dir
790  *      The path to an existing directory to mount the image on.
791  * @param flags
792  *      Bitwise OR of the flags ::WIMLIB_MOUNT_FLAG_READWRITE or
793  *      ::WIMLIB_MOUNT_FLAG_DEBUG.  If ::WIMLIB_MOUNT_FLAG_READWRITE is not
794  *      given, the WIM is mounted read-only.
795  *
796  * @return 0 on success; nonzero on error.
797  * @retval ::WIMLIB_ERR_DECOMPRESSION
798  *      Could not decompress the metadata resource for @a image in @a wim.
799  * @retval ::WIMLIB_ERR_FUSE
800  *      A non-zero status was returned by @c fuse_main().
801  * @retval ::WIMLIB_ERR_INVALID_DENTRY 
802  *      A directory entry in the metadata resource for @a image in @a wim is
803  *      invalid.
804  * @retval ::WIMLIB_ERR_INVALID_IMAGE
805  *      @a image does not specify an existing, single image in @a wim.
806  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
807  *      The metadata resource for @a image in @a wim is invalid.        
808  * @retval ::WIMLIB_ERR_MKDIR
809  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
810  *      directory could not be created.
811  * @retval ::WIMLIB_ERR_NOMEM
812  *      Failed to allocate needed memory.
813  * @retval ::WIMLIB_ERR_NOTDIR
814  *      Could not determine the current working directory.
815  * @retval ::WIMLIB_ERR_READ
816  *      An unexpected end-of-file or read error occurred when trying to read
817  *      data from the WIM file associated with @a wim.
818  *
819  */
820 extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags);
821
822 /**
823  * Opens a WIM file and creates a ::WIMStruct for it.
824  *
825  * @param wim_file 
826  *      The path to the WIM file to open.
827  * @param flags
828  *      Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
829  *      ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
830  *      If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table
831  *      of the WIM, if it exists, is checked, and the function will fail with an
832  *      ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
833  *      digests of the WIM do not exactly match the corresponding message
834  *      digests given in the integrity table.
835  *      If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
836  *      be shown if the integrity of the WIM is checked.
837  *      If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
838  *      WIM is part of a split WIM.  However, wimlib does not fully support
839  *      split WIMs, so not all functions will work correctly after opening a
840  *      split WIM.  For example, you cannot use wimlib_mount() or
841  *      wimlib_extract_image() on a split WIM.
842  *
843  * @param wim_ret
844  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
845  *      is written to the memory location pointed to by this parameter.  The
846  *      ::WIMStruct must be freed using using wimlib_free() when finished with
847  *      it.
848  *
849  * @return 0 on success; nonzero on error.
850  * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
851  *      The lookup table of @a wim_file is compressed.  Support for this can be
852  *      added to wimlib if needed, but it appears to be the case that the lookup
853  *      table is never compressed.
854  * @retval ::WIMLIB_ERR_IMAGE_COUNT
855  *      The WIM is not the non-first part of a split WIM, and the number of
856  *      metadata resources found in the WIM did not match the image count given
857  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
858  *      data for the WIM did not match the image count given in the WIM header.
859  * @retval ::WIMLIB_ERR_INTEGRITY
860  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
861  *      wim_file contains an integrity table, but the SHA1 message digest for a
862  *      chunk of the WIM does not match the corresponding message digest given
863  *      in the integrity table.
864  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
865  *      Resources in @a wim_file are compressed, but the chunk size is not 32768.
866  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
867  *      The header of @a wim_file says that resources in the WIM are compressed,
868  *      but the header flag indicating LZX or XPRESS compression is not set.
869  * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
870  *      The length field of the WIM header is not 208.
871  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
872  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
873  *      wim_file contains an integrity table, but the integrity table is
874  *      invalid.
875  * @retval ::WIMLIB_ERR_NOMEM
876  *      Failed to allocated needed memory.
877  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
878  *      @a wim_file does not begin with the expected magic characters.
879  * @retval ::WIMLIB_ERR_OPEN
880  *      Failed to open the file @a wim_file for reading.
881  * @retval ::WIMLIB_ERR_READ
882  *      An unexpected end-of-file or read error occurred when trying to read
883  *      data from @a wim_file.
884  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
885  *      @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
886  *      givin in @a flags.
887  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
888  *      A number other than 0x10d00 is written in the version field of the WIM
889  *      header of @a wim_file.
890  * @retval ::WIMLIB_ERR_XML
891  *      The XML data for @a wim_file is invalid.
892  */
893 extern int wimlib_open_wim(const char *wim_file, int flags, 
894                            WIMStruct **wim_ret);
895
896 /**
897  * Overwrites the file that the WIM was originally read from, with changes made.
898  *
899  * The new WIM is written to a temporary file and then renamed to the original
900  * file after it is has been completely written.  The temporary file currently
901  * is made in the same directory as the original WIM file.
902  *
903  * Note that it is not possible for this function to delete the original file
904  * before having written the new file because it is very likely that file
905  * resources in the new WIM file need to be retrieved from the old WIM file.
906  *
907  * After this function returns, @a wim must be freed using wimlib_free().  Any
908  * further actions on @a wim before doing this are undefined.
909  *
910  * @param wim
911  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
912  *      been in-memory changes made to it, which are then reflected in the
913  *      output file.
914  * @param flags 
915  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
916  *      ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
917  *
918  * @return 0 on success; nonzero on error.  This function may return any value
919  * returned by wimlib_write() as well as the following error codes:
920  * @retval ::WIMLIB_ERR_NO_FILENAME
921  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
922  *      than a WIM read with wimlib_open_wim().
923  * @retval ::WIMLIB_ERR_RENAME
924  *      The temporary file that the WIM was written to could not be renamed to
925  *      the original filename of @a wim.
926  */
927 extern int wimlib_overwrite(WIMStruct *wim, int flags);
928
929 /**
930  * Updates the header and XML data of the WIM file, without the need to write
931  * out the entire WIM to a temporary file as in wimlib_write().
932  *
933  * This function must only be used if no files, directories, or images have been
934  * added, removed, or changed in the WIM.  It must be used when only the boot
935  * index or the name or description of image(s) has been changed.
936  *
937  * After this function returns, @a wim must be freed using wimlib_free().  Any
938  * further actions on @a wim before doing this are undefined.
939  *
940  * @param wim
941  *      Pointer to the ::WIMStruct for the WIM file to overwrite.
942  * @param flags 
943  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
944  *      ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
945  *
946  * @return 0 on success; nonzero on error.
947  *
948  * @retval ::WIMLIB_ERR_NO_FILENAME
949  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
950  *      than a WIM read with wimlib_open_wim().
951  * @retval ::WIMLIB_ERR_NOMEM
952  *      Failed to allocate needed memory.
953  * @retval ::WIMLIB_ERR_OPEN
954  *      The WIM file associated with @a wim could not be re-opened read-write.
955  * @retval ::WIMLIB_ERR_READ
956  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY was specified in @a flags, but data
957  *      from the WIM file associated with @a wim could not be read to compute
958  *      the SHA1 message digests, or the old integrity table (if it existed)
959  *      could not be read.
960  * @retval ::WIMLIB_ERR_WRITE
961  *      Failed to write the WIM header, the XML data, or the integrity table to
962  *      the WIM file associated with @a wim.
963  */
964 extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int flags);
965
966 /**
967  * Prints information about one image, or all images, contained in a WIM.
968  *
969  * @param wim
970  *      Pointer to the ::WIMStruct for a WIM file.
971  * @param image 
972  *      The image about which to print information.  Can be the number of an
973  *      image, or ::WIM_ALL_IMAGES to print information about all images in the
974  *      WIM.
975  * 
976  * @return This function has no return value.
977  */
978 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
979
980 /**
981  * Prints the full paths to all files contained in an image, or all images, in a
982  * WIM file.
983  *
984  * @param wim
985  *      Pointer to the ::WIMStruct for a WIM file.
986  * @param image 
987  *      Which image to print files for.  Can be the number of an image, or
988  *      ::WIM_ALL_IMAGES to print the files contained in all images.  
989  *
990  * @return 0 on success; nonzero on error.
991  * @retval ::WIMLIB_ERR_DECOMPRESSION
992  *      The metadata resource for one of the specified images could not be
993  *      decompressed.
994  * @retval ::WIMLIB_ERR_INVALID_DENTRY
995  *      A directory entry in the metadata resource for one of the specified
996  *      images is invaled.
997  * @retval ::WIMLIB_ERR_INVALID_IMAGE
998  *      @a image does not specify a valid image in @a wim, and is not
999  *      ::WIM_ALL_IMAGES.
1000  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1001  *      The metadata resource for one of the specified images is invalid.
1002  * @retval ::WIMLIB_ERR_NOMEM
1003  *      Failed to allocate needed memory.
1004  * @retval ::WIMLIB_ERR_READ
1005  *      An unexpected read error or end-of-file occurred when reading the
1006  *      metadata resource for one of the specified images.
1007  */
1008 extern int wimlib_print_files(WIMStruct *wim, int image);
1009
1010 /**
1011  * Prints detailed information from the header of a WIM file.
1012  *
1013  * @param wim
1014  *      Pointer to the ::WIMStruct for a WIM file.
1015  *
1016  * @return This function has no return value.
1017  *
1018  */
1019 extern void wimlib_print_header(const WIMStruct *wim);
1020
1021 /** 
1022  * Prints the lookup table of a WIM file.  The lookup table maps SHA1 message
1023  * digests, as found in the directory entry tree in the WIM file, to file
1024  * resources in the WIM file.  This table includes one entry for each unique
1025  * file in the WIM, so it can be quite long.  There is only one lookup table per
1026  * WIM.
1027  *
1028  * @param wim
1029  *      Pointer to the ::WIMStruct for a WIM file.
1030  *
1031  * @return This function has no return value.
1032  */
1033 extern void wimlib_print_lookup_table(WIMStruct *wim);
1034
1035 /**
1036  * Prints the metadata of the specified image in a WIM file.  The metadata
1037  * consists of the security data as well as the directory entry tree, and each
1038  * image has its own metadata.  
1039  *
1040  * @param wim
1041  *      Pointer to the ::WIMStruct for a WIM file.
1042  * @param image 
1043  *      Which image to print the metadata for.  Can be the number of an image,
1044  *      or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
1045  *
1046  * @return 0 on success; nonzero on error.
1047  * @retval ::WIMLIB_ERR_DECOMPRESSION
1048  *      The metadata resource for one of the specified images could not be
1049  *      decompressed.
1050  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1051  *      A directory entry in the metadata resource for one of the specified
1052  *      images is invaled.
1053  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1054  *      @a image does not specify a valid image in @a wim, and is not
1055  *      ::WIM_ALL_IMAGES.
1056  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1057  *      The metadata resource for one of the specified images is invalid.
1058  * @retval ::WIMLIB_ERR_NOMEM
1059  *      Failed to allocate needed memory.
1060  * @retval ::WIMLIB_ERR_READ
1061  *      An unexpected read error or end-of-file occurred when reading the
1062  *      metadata resource for one of the specified images.
1063  */
1064 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1065
1066 /**
1067  * Prints some basic information about a WIM file.  All information printed by
1068  * this function is also printed by wimlib_print_header(), but
1069  * wimlib_print_wim_information() prints some of this information more concisely
1070  * and in a more readable form.
1071  *
1072  * @param wim
1073  *      Pointer to the ::WIMStruct for a WIM file.
1074  *
1075  * @return This function has no return value.  
1076  */
1077 extern void wimlib_print_wim_information(const WIMStruct *wim);
1078
1079 /**
1080  * Translates a string specifying the name or number of an image in the WIM into
1081  * the number of the image.  The images are numbered starting at 1.
1082  *
1083  * @param wim
1084  *      Pointer to the ::WIMStruct for a WIM file.
1085  * @param image_name_or_num  
1086  *      A string specifying which image.  If it begins with a number, it is
1087  *      taken to be a string specifying the image number.  Otherwise, it is
1088  *      taken to be the name of an image, as specified in the XML data for the
1089  *      WIM file.  It also may be the keyword "all", which will resolve to
1090  *      ::WIM_ALL_IMAGES.
1091  *
1092  * @return 
1093  *      If the string resolved to a single existing image, the number of that
1094  *      image, counting starting at 1, is returned.  If the keyword "all" was
1095  *      specified, ::WIM_ALL_IMAGES is returned.  Otherwise, ::WIM_NO_IMAGE is
1096  *      returned.
1097  */
1098 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1099
1100 /**
1101  * Sets which image in the WIM is marked as bootable.
1102  *
1103  * @param wim
1104  *      Pointer to the ::WIMStruct for a WIM file.
1105  * @param boot_idx
1106  *      The number of the image to mark as bootable, or 0 to mark no image as
1107  *      bootable.
1108  * @return 0 on success; nonzero on error.
1109  * @retval ::WIMLIB_ERR_INVALID_IMAGE 
1110  *      @a boot_idx does not specify an existing image in @a wim, and it was not
1111  *      0.
1112  */
1113 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1114
1115 /**
1116  * Changes the description of an image in the WIM.
1117  *
1118  * @param wim
1119  *      Pointer to the ::WIMStruct for a WIM file.
1120  * @param image
1121  *      The number of the image for which to change the description.
1122  * @param description
1123  *      The new description to give the image.  It may be @c NULL, which
1124  *      indicates that the image is to be given no description.
1125  *
1126  * @return 0 on success; nonzero on error.
1127  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1128  *      @a image does not specify a single existing image in @a wim.
1129  * @retval ::WIMLIB_ERR_NOMEM
1130  *      Failed to allocate the memory needed to duplicate the @a description
1131  *      string.
1132  */
1133 extern int wimlib_set_image_descripton(WIMStruct *wim, int image, 
1134                                        const char *description);
1135
1136 /**
1137  * Changes the name of an image in the WIM.
1138  *
1139  * @param wim
1140  *      Pointer to the ::WIMStruct for a WIM file.
1141  * @param image
1142  *      The number of the image for which to change the name.
1143  * @param name
1144  *      The new name to give the image.  It must not be @c NULL.
1145  *
1146  * @return 0 on success; nonzero on error.
1147  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1148  *      There is already an image named @a name in @a wim.
1149  * @retval ::WIMLIB_ERR_INVALID_PARAM
1150  *      @a name was @c NULL or the empty string.
1151  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1152  *      @a image does not specify a single existing image in @a wim.
1153  * @retval ::WIMLIB_ERR_NOMEM
1154  *      Failed to allocate the memory needed to duplicate the @a name string.
1155  */
1156 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1157
1158 /**
1159  * Sets the link type to use when extracting files from a WIM.  This applies
1160  * when extracting one image as well as when extracting all images.  Cross-image
1161  * links may save a lot of space because it is common for files to be referenced
1162  * multiple times in WIM files.  By default, the link type used for extraction
1163  * is ::WIM_LINK_TYPE_NONE, meaning that links are not created.
1164  *
1165  * @param wim
1166  *      Pointer to the ::WIMStruct for a WIM file
1167  * @param link_type
1168  *      ::WIM_LINK_TYPE_NONE, ::WIM_LINK_TYPE_SYMBOLIC, or ::WIM_LINK_TYPE_HARD.
1169  *
1170  * @return 0 on success; nonzero on error.
1171  * @retval ::WIMLIB_ERR_INVALID_PARAM
1172  *      @a link_type was not ::WIM_LINK_TYPE_NONE, ::WIM_LINK_TYPE_SYMBOLIC,
1173  *      or ::WIM_LINK_TYPE_HARD.
1174  */
1175 extern int wimlib_set_link_type(WIMStruct *wim, int link_type);
1176
1177 /**
1178  * Set the functions that wimlib uses to allocate and free memory.
1179  *
1180  * These settings are global and not per-WIM.
1181  *
1182  * The default is to use the default @c malloc() and @c free() from the C
1183  * library.
1184  *
1185  * @param malloc_func
1186  *      A function equivalent to @c malloc() that wimlib will use to allocate
1187  *      memory.  If @c NULL, the allocator function is set back to the default
1188  *      @c malloc() from the C library.
1189  * @param free_func
1190  *      A function equivalent to @c free() that wimlib will use to free memory.
1191  *      If @c NULL, the free function is set back to the default @c free() from
1192  *      the C library.
1193  * @param realloc_func
1194  *      A function equivalent to @c realloc() that wimlib will use to reallocate
1195  *      memory.  If @c NULL, the free function is set back to the default @c
1196  *      realloc() from the C library.
1197  * @return 0 on success; nonzero on error.
1198  * @retval ::WIMLIB_ERR_UNSUPPORTED
1199  *      wimlib was compiled with the @c --without-custom-memory-allocator flag,
1200  *      so custom memory allocators are unsupported.
1201  */
1202 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1203                                  void (*free_func)(void *),
1204                                  void *(*realloc_func)(void *, size_t));
1205
1206 /**
1207  * Sets whether wimlib is to print error messages to @c stderr when a function
1208  * fails or not.  These error messages may provide information that cannot be
1209  * determined only from the error code that is returned.
1210  *
1211  * This setting is global and not per-WIM.
1212  *
1213  * By default, error messages are not printed.
1214  *
1215  * @param show_messages
1216  *      @c true if error messages are to be printed; @c false if error messages
1217  *      are not to be printed.
1218  *
1219  * @return 0 on success; nonzero on error.
1220  * @retval ::WIMLIB_ERR_UNSUPPORTED
1221  *      @a show_messages was @c true, but wimlib was compiled with the @c
1222  *      --without-error-messages option.   Therefore, error messages cannot be
1223  *      shown.
1224  */
1225 extern int wimlib_set_print_errors(bool show_messages);
1226
1227 /**
1228  * Splits a WIM into multiple parts.
1229  *
1230  * @param wimfile
1231  *      Name of the WIM file to split.  It must be a standalone, one-part WIM.
1232  * @param swm_name
1233  *      Name of the SWM file to create.  This will be the name of the first
1234  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
1235  *      appended.
1236  * @param part_size
1237  *      The maximum size per part.  It is not guaranteed that this will really
1238  *      be the maximum size per part, because some file resources in the WIM may
1239  *      be larger than this size, and the WIM file format provides no way to
1240  *      split up file resources among multiple WIMs.
1241  * @param flags
1242  *      Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1243  *      ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1244  *
1245  * @return 0 on success; nonzero on error.  This function may return any value
1246  * returned by wimlib_open_wim() as well as the following error codes:
1247  *
1248  * @retval ::WIMLIB_ERR_WRITE
1249  *      An error occurred when trying to write data to one of the split WIMs.
1250  *
1251  */
1252 extern int wimlib_split(const char *wimfile, const char *swm_name, 
1253                         size_t part_size, int flags);
1254
1255 /**
1256  * Unmounts a WIM image that was mounted using wimlib_mount().
1257  *
1258  * Blocks until it is known whether the mount succeeded or failed.
1259  *
1260  * To perform this operation, the process calling wimlib_unmount() communicates
1261  * with the process that had called wimlib_mount().
1262  *
1263  * There is currently a design problem with this function because it is hard to
1264  * know whether the filesystem daemon is still working or whether it has
1265  * crashed, has been killed, or has reached an infinite loop. However, ideally
1266  * there should be no infinite loops or crashes in the code, so this wouldn't be
1267  * much of a problem.  Currently, a timeout of 600 seconds (so long because WIMs
1268  * can be very large) is implemented so that this function will not wait forever
1269  * before returning failure.  
1270  *
1271  * @param dir
1272  *      The directory that the WIM image was mounted on.
1273  * @param flags
1274  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY or
1275  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT.  Neither of these flags affect read-only
1276  *      mounts.
1277  *
1278  * @return 0 on success; nonzero on error.
1279  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1280  *      The filesystem daemon was unable to remove the staging directory and the
1281  *      temporary files that it contains.
1282  * @retval ::WIMLIB_ERR_FORK
1283  *      Could not @c fork() the process.
1284  * @retval ::WIMLIB_ERR_FUSERMOUNT
1285  *      The @b fusermount program could not be executed or exited with a failure
1286  *      status.
1287  * @retval ::WIMLIB_ERR_MQUEUE
1288  *      Could not open a POSIX message queue to communicate with the filesystem
1289  *      daemon servicing the mounted filesystem, could not send a message
1290  *      through the queue, or could not receive a message through the queue.
1291  * @retval ::WIMLIB_ERR_NOMEM
1292  *      Failed to allocate needed memory.
1293  * @retval ::WIMLIB_ERR_OPEN
1294  *      The filesystem daemon could not open a temporary file for writing the
1295  *      new WIM.
1296  * @retval ::WIMLIB_ERR_TIMEOUT
1297  *      600 seconds elapsed while waiting for the filesystem daemon to notify
1298  *      the process of its exit status, so the WIM file probably was not written
1299  *      successfully.
1300  * @retval ::WIMLIB_ERR_READ
1301  *      A read error occurred when the filesystem daemon tried to a file from
1302  *      the staging directory
1303  * @retval ::WIMLIB_ERR_RENAME
1304  *      The filesystem daemon failed to rename the newly written WIM file to the
1305  *      original WIM file.
1306  * @retval ::WIMLIB_ERR_WRITE
1307  *      A write error occurred when the filesystem daemon was writing to the new
1308  *      WIM file, or the filesystem daemon was unable to flush changes that had
1309  *      been made to files in the staging directory.
1310  */
1311 extern int wimlib_unmount(const char *dir, int flags);
1312
1313 /**
1314  * Writes the WIM to a file.
1315  *
1316  * @param wim
1317  *      Pointer to the ::WIMStruct for a WIM file.  There may have been
1318  *      in-memory changes made to it, which are then reflected in the output
1319  *      file.
1320  * @param path
1321  *      The path to the file to write the WIM to.
1322  * @param image
1323  *      The image inside the WIM to write.  Use ::WIM_ALL_IMAGES to include all
1324  *      images.
1325  * @param flags 
1326  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1327  *      ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.  If
1328  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
1329  *      included in the WIM being written.  If ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS
1330  *      is given, the progress of the calculation of the integrity table is
1331  *      shown.
1332  *
1333  * @return 0 on success; nonzero on error.
1334  * @retval ::WIMLIB_ERR_DECOMPRESSION
1335  *      Failed to decompress a metadata or file resource in @a wim.
1336  * @retval ::WIMLIB_ERR_INVALID_DENTRY 
1337  *      A directory entry in the metadata resource for @a image in @a wim is
1338  *      invalid.
1339  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1340  *      @a image does not specify a single existing image in @a wim, and is not
1341  *      ::WIM_ALL_IMAGES.
1342  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1343  *      The metadata resource for @a image in @a wim is invalid.        
1344  * @retval ::WIMLIB_ERR_NOMEM
1345  *      Failed to allocate needed memory.
1346  * @retval ::WIMLIB_ERR_OPEN
1347  *      Failed to open @a path for writing, or some file resources in @a
1348  *      wim refer to files in the outside filesystem, and one of these files
1349  *      could not be opened for reading.
1350  * @retval ::WIMLIB_ERR_READ
1351  *      An error occurred when trying to read data from the WIM file associated
1352  *      with @a wim, or some file resources in @a wim refer to files in the
1353  *      outside filesystem, and a read error occurred when reading one of these
1354  *      files.
1355  * @retval ::WIMLIB_ERR_WRITE
1356  *      An error occurred when trying to write data to the new WIM file at @a
1357  *      path.
1358  */
1359 extern int wimlib_write(WIMStruct *wim, const char *path, int image, int flags);
1360
1361
1362
1363 #endif /* _WIMLIB_H */
1364