]> wimlib.net Git - wimlib/blobdiff - include/wimlib.h
Merge branch 'lz_bt'
[wimlib] / include / wimlib.h
index ea48aaefb7cfdf050fdd75ef5419c179d5381765..7d39ba646c922230c6419045c515f0aecc8423ef 100644 (file)
@@ -1874,7 +1874,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour
  * all streams recompressed in solid mode.
  *
  * Currently, new solid blocks will, by default, be written using LZMS
- * compression with 32 MiB (33554432 byte) chunks.  Use
+ * compression with 64 MiB (67108864 byte) chunks.  Use
  * wimlib_set_output_pack_compression_type() and/or
  * wimlib_set_output_pack_chunk_size() to change this.  This is independent of
  * the WIM's main compression type and chunk size; you can have a WIM that
@@ -2032,88 +2032,80 @@ struct wimlib_update_command {
  * codes can be returned by a given function, and what they mean.
  */
 enum wimlib_error_code {
-       WIMLIB_ERR_SUCCESS = 0,
-       WIMLIB_ERR_ALREADY_LOCKED,
-       WIMLIB_ERR_DECOMPRESSION,
-       WIMLIB_ERR_DELETE_STAGING_DIR,
-       WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
-       WIMLIB_ERR_FORK,
-       WIMLIB_ERR_FUSE,
-       WIMLIB_ERR_FUSERMOUNT,
-       WIMLIB_ERR_GLOB_HAD_NO_MATCHES,
-       WIMLIB_ERR_ICONV_NOT_AVAILABLE,
-       WIMLIB_ERR_IMAGE_COUNT,
-       WIMLIB_ERR_IMAGE_NAME_COLLISION,
-       WIMLIB_ERR_INSUFFICIENT_PRIVILEGES,
-       WIMLIB_ERR_INTEGRITY,
-       WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
-       WIMLIB_ERR_INVALID_CHUNK_SIZE,
-       WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
-       WIMLIB_ERR_INVALID_HEADER,
-       WIMLIB_ERR_INVALID_IMAGE,
-       WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
-       WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
-       WIMLIB_ERR_INVALID_METADATA_RESOURCE,
-       WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
-       WIMLIB_ERR_INVALID_OVERLAY,
-       WIMLIB_ERR_INVALID_PARAM,
-       WIMLIB_ERR_INVALID_PART_NUMBER,
-       WIMLIB_ERR_INVALID_PIPABLE_WIM,
-       WIMLIB_ERR_INVALID_REPARSE_DATA,
-       WIMLIB_ERR_INVALID_RESOURCE_HASH,
-       WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
-       WIMLIB_ERR_INVALID_UTF16_STRING,
-       WIMLIB_ERR_INVALID_UTF8_STRING,
-       WIMLIB_ERR_IS_DIRECTORY,
-       WIMLIB_ERR_IS_SPLIT_WIM,
-       WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
-       WIMLIB_ERR_LINK,
-       WIMLIB_ERR_METADATA_NOT_FOUND,
-       WIMLIB_ERR_MKDIR,
-       WIMLIB_ERR_MQUEUE,
-       WIMLIB_ERR_NOMEM,
-       WIMLIB_ERR_NOTDIR,
-       WIMLIB_ERR_NOTEMPTY,
-       WIMLIB_ERR_NOT_A_REGULAR_FILE,
-       WIMLIB_ERR_NOT_A_WIM_FILE,
-       WIMLIB_ERR_NOT_PIPABLE,
-       WIMLIB_ERR_NO_FILENAME,
-       WIMLIB_ERR_NTFS_3G,
-       WIMLIB_ERR_OPEN,
-       WIMLIB_ERR_OPENDIR,
-       WIMLIB_ERR_PATH_DOES_NOT_EXIST,
-       WIMLIB_ERR_READ,
-       WIMLIB_ERR_READLINK,
-       WIMLIB_ERR_RENAME,
-       WIMLIB_ERR_REOPEN,
-       WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
-       WIMLIB_ERR_RESOURCE_NOT_FOUND,
-       WIMLIB_ERR_RESOURCE_ORDER,
-       WIMLIB_ERR_SET_ATTRIBUTES,
-       WIMLIB_ERR_SET_REPARSE_DATA,
-       WIMLIB_ERR_SET_SECURITY,
-       WIMLIB_ERR_SET_SHORT_NAME,
-       WIMLIB_ERR_SET_TIMESTAMPS,
-       WIMLIB_ERR_SPLIT_INVALID,
-       WIMLIB_ERR_STAT,
-       WIMLIB_ERR_TIMEOUT,
-       WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
-       WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
-       WIMLIB_ERR_UNKNOWN_VERSION,
-       WIMLIB_ERR_UNSUPPORTED,
-       WIMLIB_ERR_UNSUPPORTED_FILE,
-       WIMLIB_ERR_VOLUME_LACKS_FEATURES,
-       WIMLIB_ERR_WIM_IS_READONLY,
-       WIMLIB_ERR_WRITE,
-       WIMLIB_ERR_XML,
-       WIMLIB_ERR_WIM_IS_ENCRYPTED,
-       WIMLIB_ERR_WIMBOOT,
-       WIMLIB_ERR_ABORTED_BY_PROGRESS,
-       WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS,
-       WIMLIB_ERR_MKNOD,
-       WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY,
-       WIMLIB_ERR_NOT_A_MOUNTPOINT,
-       WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT,
+       WIMLIB_ERR_SUCCESS                            = 0,
+       WIMLIB_ERR_ALREADY_LOCKED                     = 1,
+       WIMLIB_ERR_DECOMPRESSION                      = 2,
+       WIMLIB_ERR_FUSE                               = 6,
+       WIMLIB_ERR_GLOB_HAD_NO_MATCHES                = 8,
+       WIMLIB_ERR_ICONV_NOT_AVAILABLE                = 9,
+       WIMLIB_ERR_IMAGE_COUNT                        = 10,
+       WIMLIB_ERR_IMAGE_NAME_COLLISION               = 11,
+       WIMLIB_ERR_INSUFFICIENT_PRIVILEGES            = 12,
+       WIMLIB_ERR_INTEGRITY                          = 13,
+       WIMLIB_ERR_INVALID_CAPTURE_CONFIG             = 14,
+       WIMLIB_ERR_INVALID_CHUNK_SIZE                 = 15,
+       WIMLIB_ERR_INVALID_COMPRESSION_TYPE           = 16,
+       WIMLIB_ERR_INVALID_HEADER                     = 17,
+       WIMLIB_ERR_INVALID_IMAGE                      = 18,
+       WIMLIB_ERR_INVALID_INTEGRITY_TABLE            = 19,
+       WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY         = 20,
+       WIMLIB_ERR_INVALID_METADATA_RESOURCE          = 21,
+       WIMLIB_ERR_INVALID_MULTIBYTE_STRING           = 22,
+       WIMLIB_ERR_INVALID_OVERLAY                    = 23,
+       WIMLIB_ERR_INVALID_PARAM                      = 24,
+       WIMLIB_ERR_INVALID_PART_NUMBER                = 25,
+       WIMLIB_ERR_INVALID_PIPABLE_WIM                = 26,
+       WIMLIB_ERR_INVALID_REPARSE_DATA               = 27,
+       WIMLIB_ERR_INVALID_RESOURCE_HASH              = 28,
+       WIMLIB_ERR_INVALID_UTF16_STRING               = 30,
+       WIMLIB_ERR_INVALID_UTF8_STRING                = 31,
+       WIMLIB_ERR_IS_DIRECTORY                       = 32,
+       WIMLIB_ERR_IS_SPLIT_WIM                       = 33,
+       WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE = 34,
+       WIMLIB_ERR_LINK                               = 35,
+       WIMLIB_ERR_METADATA_NOT_FOUND                 = 36,
+       WIMLIB_ERR_MKDIR                              = 37,
+       WIMLIB_ERR_MQUEUE                             = 38,
+       WIMLIB_ERR_NOMEM                              = 39,
+       WIMLIB_ERR_NOTDIR                             = 40,
+       WIMLIB_ERR_NOTEMPTY                           = 41,
+       WIMLIB_ERR_NOT_A_REGULAR_FILE                 = 42,
+       WIMLIB_ERR_NOT_A_WIM_FILE                     = 43,
+       WIMLIB_ERR_NOT_PIPABLE                        = 44,
+       WIMLIB_ERR_NO_FILENAME                        = 45,
+       WIMLIB_ERR_NTFS_3G                            = 46,
+       WIMLIB_ERR_OPEN                               = 47,
+       WIMLIB_ERR_OPENDIR                            = 48,
+       WIMLIB_ERR_PATH_DOES_NOT_EXIST                = 49,
+       WIMLIB_ERR_READ                               = 50,
+       WIMLIB_ERR_READLINK                           = 51,
+       WIMLIB_ERR_RENAME                             = 52,
+       WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED         = 54,
+       WIMLIB_ERR_RESOURCE_NOT_FOUND                 = 55,
+       WIMLIB_ERR_RESOURCE_ORDER                     = 56,
+       WIMLIB_ERR_SET_ATTRIBUTES                     = 57,
+       WIMLIB_ERR_SET_REPARSE_DATA                   = 58,
+       WIMLIB_ERR_SET_SECURITY                       = 59,
+       WIMLIB_ERR_SET_SHORT_NAME                     = 60,
+       WIMLIB_ERR_SET_TIMESTAMPS                     = 61,
+       WIMLIB_ERR_SPLIT_INVALID                      = 62,
+       WIMLIB_ERR_STAT                               = 63,
+       WIMLIB_ERR_UNEXPECTED_END_OF_FILE             = 65,
+       WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE   = 66,
+       WIMLIB_ERR_UNKNOWN_VERSION                    = 67,
+       WIMLIB_ERR_UNSUPPORTED                        = 68,
+       WIMLIB_ERR_UNSUPPORTED_FILE                   = 69,
+       WIMLIB_ERR_WIM_IS_READONLY                    = 71,
+       WIMLIB_ERR_WRITE                              = 72,
+       WIMLIB_ERR_XML                                = 73,
+       WIMLIB_ERR_WIM_IS_ENCRYPTED                   = 74,
+       WIMLIB_ERR_WIMBOOT                            = 75,
+       WIMLIB_ERR_ABORTED_BY_PROGRESS                = 76,
+       WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS            = 77,
+       WIMLIB_ERR_MKNOD                              = 78,
+       WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY              = 79,
+       WIMLIB_ERR_NOT_A_MOUNTPOINT                   = 80,
+       WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT           = 81,
 };
 
 
@@ -4197,11 +4189,11 @@ struct wimlib_lzx_compressor_params {
        struct wimlib_compressor_params_header hdr;
 
        /** Relatively fast LZX compression algorithm with a decent compression
-        * ratio; the suggested default.  */
+        * ratio.  */
 #define WIMLIB_LZX_ALGORITHM_FAST 0
 
        /** Slower LZX compression algorithm that provides a better compression
-        * ratio.  */
+        * ratio.  This is the default.  */
 #define WIMLIB_LZX_ALGORITHM_SLOW 1
 
        /** Algorithm to use to perform the compression: either
@@ -4220,10 +4212,10 @@ struct wimlib_lzx_compressor_params {
                        uint32_t fast_reserved1[10];
                } fast;
 
-               /** Parameters for the slow algorithm.  */
+               /** Parameters for the "slow" algorithm.  */
                struct wimlib_lzx_slow_params {
                        /** If set to 1, the compressor can output length 2
-                        * matches.  If set 0, the compressor only outputs
+                        * matches.  If set 0, the compressor can only output
                         * matches of length 3 or greater.  Suggested value: 1
                         */
                        uint32_t use_len2_matches : 1;
@@ -4251,11 +4243,10 @@ struct wimlib_lzx_compressor_params {
                         * position.  Suggested value: 50.  */
                        uint32_t max_search_depth;
 
-                       /** Maximum number of potentially good matches to
-                        * consider for each position.  Suggested value: 3.  */
-                       uint32_t max_matches_per_pos;
+                       /* Note: max_matches_per_pos has been removed and no
+                        * longer has any effect.  */
 
-                       uint32_t slow_reserved2[2];
+                       uint32_t slow_reserved2[3];
 
                        /** Assumed cost of a main symbol with zero frequency.
                         * Must be at least 1 and no more than 16.  Suggested
@@ -4302,9 +4293,10 @@ struct wimlib_lzms_compressor_params {
         * value: 50.  */
        uint32_t max_search_depth;
 
-       /** Maximum number of potentially good matches to consider at each
-        * position.  Suggested value: 3.  */
-       uint32_t max_matches_per_pos;
+       /* Note: max_matches_per_pos has been removed and no longer has any
+        * effect.  */
+
+       uint32_t reserved1;
 
        /** Length of the array for the near-optimal LZ parsing algorithm.  This
         * must be at least 1.  Suggested value: 1024.  */