*
* \section intro Introduction
*
- * This is the documentation for the library interface of wimlib 1.3.1. If you
+ * This is the documentation for the library interface of wimlib 1.3.3. If you
* have installed wimlib and want to know how to use the @b wimlib-imagex
* program, please see the man pages instead. Also: the actual project page
* where you can download the source code for the library is at <a
*
* \section encodings Locales and character encodings
*
- * wimlib 1.3.0 has improved handling of different character encodings compared
- * to previous versions. Functions are explictly noted as taking
- * ::wimlib_mbchar strings, which are encoded in the locale-dependent multibyte
- * encoding (e.g. ASCII, ISO-8859-1, or UTF-8), or ::wimlib_utf8char strings,
- * which are encoded in UTF-8. Generally, filenames and paths are in the
- * locale-dependent multibyte encoding, while other types of data must be
- * provided in UTF-8. Please see the man page for @b wimlib-imagex for more
- * information. However, I strongly recommend that you use UTF-8 for your
- * locale's encoding so that ::wimlib_mbchar strings will be encoded the same
- * way as ::wimlib_utf8char strings.
+ * To support Windows as well as UNIX, wimlib's API typically takes and returns
+ * strings of ::wimlib_tchar, which are in a platform-dependent encoding.
+ *
+ * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
+ * and the encoding is UTF-16LE.
+ *
+ * On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the
+* encoding is the locale-dependent multibyte encoding. I recommend you set your
+* locale to a UTF-8 capable locale to avoid any issues. Also, by default,
+ * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
+* wimlib_global_init() after having set your desired locale.
*
* \section Limitations
*
* without mounting it, other than by adding, removing, or extracting an
* entire image. The FUSE mount feature should be used for this purpose.
* - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
- * than wimlib when using maximum (LZX) compression because it knows how to
- * split up LZX compressed blocks, which is not yet implemented in wimlib.
+ * than wimlib (~2% or 3% smaller) when using maximum (LZX) compression.
* - wimlib is experimental and likely contains bugs; use Microsoft's @a
* imagex.exe if you want to make sure your WIM files are made "correctly".
* - The old WIM format from Vista pre-releases is not supported.
#define WIMLIB_MINOR_VERSION 3
/** Patch version of the library (for example, the 5 in 1.2.5). */
-#define WIMLIB_PATCH_VERSION 1
+#define WIMLIB_PATCH_VERSION 3
/**
* Opaque structure that represents a WIM file. This is an in-memory structure
*/
typedef struct WIMStruct WIMStruct;
-/** Byte of a string encoded in the locale-dependent encoding */
-typedef char wimlib_mbchar;
-
-/** Byte of a string encoded in UTF-8 */
-typedef char wimlib_utf8char;
+#ifdef __WIN32__
+typedef wchar_t wimlib_tchar;
+#else
+/** See \ref encodings */
+typedef char wimlib_tchar;
+#endif
/**
* Specifies the compression type of a WIM file.
* ::wimlib_progress_info.extract. */
WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
+ /** A file or directory tree within a WIM image (not the full image) is
+ * about to be extracted. @a info will point to
+ * ::wimlib_progress_info.extract. */
+ WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
+
/** The directory structure of the WIM image is about to be extracted.
* @a info will point to ::wimlib_progress_info.extract. */
WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
* ::wimlib_progress_info.extract. */
WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
+ /** A file or directory tree within a WIM image (not the full image) has
+ * been successfully extracted. @a info will point to
+ * ::wimlib_progress_info.extract. */
+ WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
+
/** The directory or NTFS volume is about to be scanned to build a tree
* of WIM dentries in-memory. @a info will point to
* ::wimlib_progress_info.scan. */
* ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
* ::WIMLIB_COMPRESSION_TYPE_LZX. */
int compression_type;
+
+ /** Library internal use only. */
+ uint64_t _private;
} write_streams;
/** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
* ::WIMLIB_PROGRESS_MSG_SCAN_END. */
struct wimlib_progress_info_scan {
/** Directory or NTFS volume that is being scanned. */
- const wimlib_mbchar *source;
+ const wimlib_tchar *source;
/** Path to the file or directory that is about to be scanned,
* relative to the root of the image capture or the NTFS volume.
* */
- const wimlib_mbchar *cur_path;
+ const wimlib_tchar *cur_path;
/** True iff @a cur_path is being excluded from the image
* capture due to the capture configuration file. */
/** Target path in the WIM. Only valid on messages
* ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
* ::WIMLIB_PROGRESS_MSG_SCAN_END. */
- const wimlib_mbchar *wim_target_path;
+ const wimlib_tchar *wim_target_path;
} scan;
/** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
int extract_flags;
/** Full path to the WIM file being extracted. */
- const wimlib_mbchar *wimfile_name;
+ const wimlib_tchar *wimfile_name;
/** Name of the image being extracted. */
- const wimlib_utf8char *image_name;
+ const wimlib_tchar *image_name;
/** Directory or NTFS volume to which the image is being
* extracted. */
- const wimlib_mbchar *target;
+ const wimlib_tchar *target;
/** Current dentry being extracted. (Valid only if message is
* ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
- const wimlib_mbchar *cur_path;
+ const wimlib_tchar *cur_path;
/** Number of bytes of uncompressed data that will be extracted.
* Takes into account hard links (they are not counted for each
* special cases (hard links, symbolic links, and alternate data
* streams.) */
uint64_t num_streams;
+
+ /** Path to the root dentry within the WIM for the tree that is
+ * being extracted. Will be the empty string when extracting a
+ * full image. */
+ const wimlib_tchar *extract_root_wim_source_path;
} extract;
/** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
struct wimlib_progress_info_rename {
/** Name of the temporary file that the WIM was written to. */
- const wimlib_mbchar *from;
+ const wimlib_tchar *from;
/** Name of the original WIM file to which the temporary file is
* being renamed. */
- const wimlib_mbchar *to;
+ const wimlib_tchar *to;
} rename;
/** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
/** Filename of the WIM (only valid if the message is
* ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
- const wimlib_mbchar *filename;
+ const wimlib_tchar *filename;
} integrity;
/** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
/** Name of the split WIM part that is about to be started
* (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
* finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
- const wimlib_mbchar *part_name;
+ const wimlib_tchar *part_name;
} split;
};
struct wimlib_capture_source {
/** Absolute or relative path to a file or directory on the external
* filesystem to be included in the WIM image. */
- wimlib_mbchar *fs_source_path;
+ wimlib_tchar *fs_source_path;
/** Destination path in the WIM image. Leading and trailing slashes are
* ignored. The empty string or @c NULL means the root directory of the
* WIM image. */
- wimlib_mbchar *wim_target_path;
+ wimlib_tchar *wim_target_path;
/** Reserved; set to 0. */
long reserved;
};
+/** Structure that specifies a list of path patterns. */
+struct wimlib_pattern_list {
+ /** Array of patterns. The patterns may be modified by library code,
+ * but the @a pats pointer itself will not. See the man page for
+ * <b>wimlib-imagex capture</b> for more information about allowed
+ * patterns. */
+ wimlib_tchar **pats;
+
+ /** Number of patterns in the @a pats array. */
+ size_t num_pats;
+
+ /** Ignored; may be used by the calling code. */
+ size_t num_allocated_pats;
+};
+
+/** A structure that contains lists of wildcards that match paths to treat
+ * specially when capturing a WIM image. */
+struct wimlib_capture_config {
+ /** Paths matching any pattern this list are excluded from being
+ * captured, except if the same path appears in @a
+ * exclusion_exception_pats. */
+ struct wimlib_pattern_list exclusion_pats;
+
+ /** Paths matching any pattern in this list are never excluded from
+ * being captured. */
+ struct wimlib_pattern_list exclusion_exception_pats;
+
+ /** Reserved for future capture configuration options. */
+ struct wimlib_pattern_list reserved1;
+
+ /** Reserved for future capture configuration options. */
+ struct wimlib_pattern_list reserved2;
+
+ /** Library internal use only. */
+ const wimlib_tchar *_prefix;
+
+ /** Library internal use only. */
+ size_t _prefix_num_tchars;
+};
+
/*****************************
* WIMLIB_ADD_IMAGE_FLAG_* *
* mode, or in Win32 native builds. */
#define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS 0x00000020
+/** Fail immediately if the full security descriptor of any file or directory
+ * cannot be accessed. Only has an effect in Win32 native builds. The default
+ * behavior without this flag is to first try omitting the SACL from the
+ * security descriptor, then to try omitting the security descriptor entirely.
+ * */
+#define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS 0x00000040
+
+/** Call the progress function with the message
+ * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
+ * capture. This is a subset of the messages provided by
+ * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE. */
+#define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE 0x00000080
+
+/** Reparse-point fixups: Modify absolute symbolic links (or junction points,
+ * in the case of Windows) that point inside the directory being captured to
+ * instead be absolute relative to the directory being captured, rather than the
+ * current root; also exclude absolute symbolic links that point outside the
+ * directory tree being captured.
+ *
+ * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
+ * the WIM header or if this is the first image being added.
+ * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
+ * reparse point fixups enabled and currently cannot be unset. */
+#define WIMLIB_ADD_IMAGE_FLAG_RPFIX 0x00000100
+
+/** Don't do reparse point fixups. The default behavior is described in the
+ * documentation for ::WIMLIB_ADD_IMAGE_FLAG_RPFIX. */
+#define WIMLIB_ADD_IMAGE_FLAG_NORPFIX 0x00000200
+
+/** Do not issue an error if the path to delete does not exist. */
+#define WIMLIB_DELETE_FLAG_FORCE 0x00000001
+
+/** Delete a file or directory tree recursively; if not specified, an error is
+ * issued if the path to delete is a directory. */
+#define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
+
/******************************
* WIMLIB_EXPORT_FLAG_* *
******************************/
/** Do not extract security descriptors. Only has an effect in NTFS apply mode,
* or in Win32 native builds. */
-#define WIMLIB_EXTRACT_FLAG_NOACLS 0x00000040
+#define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
+
+/** Fail immediately if the full security descriptor of any file or directory
+ * cannot be set exactly as specified in the WIM file. The default behavior
+ * without this flag is to fall back to setting the security descriptor with the
+ * SACL omitted, then only the default inherited security descriptor, if we do
+ * not have permission to set the desired one. */
+#define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
+
+/* Extract equivalent to ::WIMLIB_ADD_IMAGE_FLAG_RPFIX; force reparse-point
+ * fixups on, so absolute symbolic links or junction points will be fixed to be
+ * absolute relative to the actual extraction root. Done by default if
+ * WIM_HDR_FLAG_RP_FIX is set in the WIM header. This flag may only be
+ * specified when extracting a full image. */
+#define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
+
+/** Force reparse-point fixups on extraction off, regardless of the state of the
+ * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
+#define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
+
+/** Extract files to standard output rather than to the filesystem. */
+#define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
/******************************
* WIMLIB_MOUNT_FLAG_* *
* deleting an image in this way. */
#define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
+/** Assume that strings are represented in UTF-8, even if this is not the
+ * locale's character encoding. */
+#define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
+
+/** XXX */
+struct wimlib_update_command {
+ enum {
+ WIMLIB_UPDATE_OP_ADD = 0,
+ WIMLIB_UPDATE_OP_DELETE,
+ WIMLIB_UPDATE_OP_RENAME,
+ } op;
+ union {
+ struct {
+ wimlib_tchar *fs_source_path;
+ wimlib_tchar *wim_target_path;
+ struct wimlib_capture_config *config;
+ int add_flags;
+ } add;
+ struct {
+ wimlib_tchar *wim_path;
+ int delete_flags;
+ } delete;
+ struct {
+ wimlib_tchar *wim_source_path;
+ wimlib_tchar *wim_target_path;
+ int rename_flags;
+ } rename;
+ };
+};
+
+/** Specification of a file or directory tree to extract from a WIM image. */
+struct wimlib_extract_command {
+ /** Path to file or directory tree within the WIM image to extract. It
+ * must be provided as an absolute path from the root of the WIM image.
+ * The path separators may be either forward slashes or backslashes. */
+ wimlib_tchar *wim_source_path;
+
+ /** Filesystem path to extract the file or directory tree to. */
+ wimlib_tchar *fs_dest_path;
+
+ /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
+ int extract_flags;
+};
+
/**
* Possible values of the error code returned by many functions in wimlib.
*
WIMLIB_ERR_ICONV_NOT_AVAILABLE,
WIMLIB_ERR_IMAGE_COUNT,
WIMLIB_ERR_IMAGE_NAME_COLLISION,
+ WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT,
WIMLIB_ERR_INTEGRITY,
WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
WIMLIB_ERR_INVALID_CHUNK_SIZE,
WIMLIB_ERR_INVALID_IMAGE,
WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
+ WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
+ WIMLIB_ERR_INVALID_OVERLAY,
WIMLIB_ERR_INVALID_PARAM,
WIMLIB_ERR_INVALID_PART_NUMBER,
+ WIMLIB_ERR_INVALID_REPARSE_DATA,
WIMLIB_ERR_INVALID_RESOURCE_HASH,
WIMLIB_ERR_INVALID_RESOURCE_SIZE,
WIMLIB_ERR_INVALID_SECURITY_DATA,
WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
- WIMLIB_ERR_INVALID_UTF8_STRING,
WIMLIB_ERR_INVALID_UTF16_STRING,
+ WIMLIB_ERR_INVALID_UTF8_STRING,
WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
WIMLIB_ERR_LINK,
WIMLIB_ERR_MKDIR,
WIMLIB_ERR_NTFS_3G,
WIMLIB_ERR_OPEN,
WIMLIB_ERR_OPENDIR,
- WIMLIB_ERR_READLINK,
WIMLIB_ERR_READ,
+ WIMLIB_ERR_READLINK,
WIMLIB_ERR_RENAME,
WIMLIB_ERR_REOPEN,
+ WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
WIMLIB_ERR_RESOURCE_ORDER,
WIMLIB_ERR_SPECIAL_FILE,
WIMLIB_ERR_SPLIT_INVALID,
WIMLIB_ERR_SPLIT_UNSUPPORTED,
WIMLIB_ERR_STAT,
WIMLIB_ERR_TIMEOUT,
+ WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
WIMLIB_ERR_UNKNOWN_VERSION,
WIMLIB_ERR_UNSUPPORTED,
+ WIMLIB_ERR_VOLUME_LACKS_FEATURES,
WIMLIB_ERR_WRITE,
WIMLIB_ERR_XML,
- WIMLIB_ERR_INVALID_OVERLAY,
- WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
- WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
+ WIMLIB_ERR_PATH_DOES_NOT_EXIST,
+ WIMLIB_ERR_NOT_A_REGULAR_FILE,
+ WIMLIB_ERR_IS_DIRECTORY,
};
-/** Used to indicate that no WIM image or an invalid WIM image. */
+/** Used to indicate no WIM image or an invalid WIM image. */
#define WIMLIB_NO_IMAGE 0
/** Used to specify all images in the WIM. */
#define WIMLIB_ALL_IMAGES (-1)
+/**
+ * Appends an empty image to a WIM file. This empty image will initially
+ * contain no files or directories, although if written without further
+ * modifications, a root directory will be created automatically for it.
+ *
+ * @param wim
+ * Pointer to the ::WIMStruct for the WIM file to which the image is to be
+ * added.
+ * @param name
+ * Name to give the new image.
+ * @param new_idx_ret
+ * If non-<code>NULL</code>, the index of the newly added image is returned
+ * in this location.
+ *
+ * @return 0 on success; nonzero on failure. The possible error codes are:
+ *
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * @a name was @c NULL or an empty string.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * @a wim is part of a split WIM.
+ * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
+ * There is already an image in @a wim named @a name.
+ * @retval ::WIMLIB_ERR_NOMEM
+ * Failed to allocate the memory needed to add the new image.
+ */
+extern int
+wimlib_add_empty_image(WIMStruct *wim,
+ const wimlib_tchar *name,
+ int *new_idx_ret);
+
/**
* Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
*
- * The directory tree of NTFS volume is read immediately for the purpose of
- * constructing a directory entry tree in-memory. Also, all files are read to
- * calculate their SHA1 message digests. However, because the directory tree
- * may contain a very large amount of data, the files themselves are not read
- * into memory permanently, and instead references to their paths saved. The
- * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
+ * The directory tree or NTFS volume is scanned immediately to load the dentry
+ * tree into memory, and file attributes and symbolic links are read. However,
+ * actual file data is not read until wimlib_write() or wimlib_overwrite() is
* called.
*
* See the manual page for the @b wimlib-imagex program for more information
* @param name
* The name to give the image. This must be non-@c NULL.
* @param config
- * Pointer to the contents of an image capture configuration file. If @c
- * NULL, a default string is used. Please see the manual page for
- * <b>wimlib-imagex capture</b> for more information.
- * @param config_len
- * Length of the string @a config in bytes, not including an optional
- * null-terminator. Ignored if @a config is @c NULL.
+ * Capture configuration that specifies files, directories, or path globs
+ * to exclude from being captured. If @c NULL, a dummy configuration where
+ * no paths are treated specially is used.
* @param add_image_flags
* Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
* @param progress_func
* wimlib was configured with the @c --without-ntfs-3g flag.
*/
extern int
-wimlib_add_image(WIMStruct *wim, const wimlib_mbchar *source,
- const wimlib_utf8char *name,
- const wimlib_mbchar *config,
- size_t config_len, int add_image_flags,
+wimlib_add_image(WIMStruct *wim,
+ const wimlib_tchar *source,
+ const wimlib_tchar *name,
+ const struct wimlib_capture_config *config,
+ int add_image_flags,
wimlib_progress_func_t progress_func);
/** This function is equivalent to wimlib_add_image() except it allows for
* same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
* capture</b> for full details on how this mode works.
*
- * Additional note: @a sources is not a @c const parameter and you cannot
- * assume that its contents are valid after this function returns. You must
- * save pointers to the strings in these structures if you need to free them
- * later, and/or save copies if needed.
- *
* In addition to the error codes that wimlib_add_image() can return,
* wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
* when trying to overlay a non-directory on a directory or when otherwise
* NTFS mode.) */
extern int
wimlib_add_image_multisource(WIMStruct *w,
- struct wimlib_capture_source *sources,
+ const struct wimlib_capture_source *sources,
size_t num_sources,
- const wimlib_utf8char *name,
- const wimlib_mbchar *config_str,
- size_t config_len,
+ const wimlib_tchar *name,
+ const struct wimlib_capture_config *config,
int add_image_flags,
wimlib_progress_func_t progress_func);
extern int
wimlib_export_image(WIMStruct *src_wim, int src_image,
WIMStruct *dest_wim,
- const wimlib_utf8char *dest_name,
- const wimlib_utf8char *dest_description,
+ const wimlib_tchar *dest_name,
+ const wimlib_tchar *dest_description,
int export_flags,
WIMStruct **additional_swms,
unsigned num_additional_swms,
wimlib_progress_func_t progress_func);
+/**
+ * Extract zero or more files or directory trees from a WIM image.
+ *
+ * This generalizes the single-image extraction functionality of
+ * wimlib_extract_image() to allow extracting only the specified subsets of the
+ * image.
+ *
+ * @param wim
+ * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
+ * split WIM.
+ *
+ * @param image
+ * The 1-based number of the image in @a wim from which the files or
+ * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
+ *
+ * @param default_extract_flags
+ * Default extraction flags; the behavior shall be as if these flags had
+ * been specified in the ::wimlib_extract_command.extract_flags member in
+ * each extraction command, in combination with any flags already present.
+ *
+ * @param cmds
+ * An array of ::wimlib_extract_command structures that specifies the
+ * extractions to perform.
+ *
+ * @param num_cmds
+ * Number of commands in the @a cmds array.
+ *
+ * @param additional_swms
+ * Array of pointers to the ::WIMStruct for each additional part in the
+ * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
+ * need to be in any particular order, but they must include all parts of
+ * the split WIM other than the first part, which must be provided in the
+ * @a wim parameter.
+ *
+ * @param num_additional_swms
+ * Number of additional WIM parts provided in the @a additional_swms array.
+ * This number should be one less than the total number of parts in the
+ * split WIM. Set to 0 if the WIM is a standalone WIM.
+ *
+ * @param progress_func
+ * If non-NULL, a function that will be called periodically with the
+ * progress of the current operation.
+ *
+ * @return 0 on success; nonzero on error. The possible error codes include
+ * those documented as returned by wimlib_extract_image() as well as the
+ * following additional error codes:
+ *
+ * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
+ * The ::wimlib_extract_command.wim_source_path member in one of the
+ * extract commands did not exist in the WIM.
+ * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
+ * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
+ * in which ::wimlib_extract_command.wim_source_path existed but was not a
+ * regular file or directory.
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
+ * specified for some commands but not all; or
+ * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
+ * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
+ * for a command in which ::wimlib_extract_command.wim_source_path did not
+ * specify the root directory of the WIM image.
+ */
+extern int
+wimlib_extract_files(WIMStruct *wim,
+ int image,
+ int default_extract_flags,
+ const struct wimlib_extract_command *cmds,
+ size_t num_cmds,
+ WIMStruct **additional_swms,
+ unsigned num_additional_swms,
+ wimlib_progress_func_t progress_func);
+
/**
* Extracts an image, or all images, from a standalone or split WIM file to a
* directory or a NTFS volume.
*/
extern int
wimlib_extract_image(WIMStruct *wim, int image,
- const wimlib_mbchar *target,
+ const wimlib_tchar *target,
int extract_flags,
WIMStruct **additional_swms,
unsigned num_additional_swms,
* A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
* respectively.
*/
-extern const wimlib_mbchar *
+extern const wimlib_tchar *
wimlib_get_compression_type_string(int ctype);
/**
* Pointer to a statically allocated string describing the error code,
* or @c NULL if the error code is not valid.
*/
-extern const wimlib_mbchar *
+extern const wimlib_tchar *
wimlib_get_error_string(enum wimlib_error_code code);
/**
* in addition, the string will become invalid if the description of the
* image is changed, the image is deleted, or the ::WIMStruct is destroyed.
*/
-extern const wimlib_utf8char *
+extern const wimlib_tchar *
wimlib_get_image_description(const WIMStruct *wim, int image);
/**
* the WIM to be unnamed, in which case an empty string will be returned
* when the corresponding name is requested.
*/
-extern const wimlib_utf8char *
+extern const wimlib_tchar *
wimlib_get_image_name(const WIMStruct *wim, int image);
/**
* Since wimlib 1.2.6: Initialization function for wimlib. This is not
* re-entrant. If you are calling wimlib functions concurrently in different
- * threads, then you must call this function serially first. Also, since wimlib
- * 1.3.0, you must call this function if the character encoding of the current
- * locale is not UTF-8. Otherwise, calling this function this function is not
- * required.
+ * threads, then you must call this function serially first.
+ *
+ * Since wimlib 1.3.0, you must call this function if the character encoding of
+ * the current locale is not UTF-8 and you do not want wimlib to assume a UTF-8
+ * encoding.
*
- * This function always returns 0.
+ * Since wimlib 1.3.2, you must call this function if using the Windows-native
+ * build of the library so that certain functions can be dynamically loaded from
+ * system DLLs.
+ *
+ * Since wimlib 1.3.3, this function takes the @a init_flags parameter.
+ *
+ * @param init_flags
+ * ::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume that all input
+ * data, including filenames, are in UTF-8, and that UTF-8 data can be
+ * directly printed to the console.
+ *
+ * @return 0; other error codes may be returned in future releases.
*/
extern int
-wimlib_global_init();
+wimlib_global_init(int init_flags);
/**
* Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
* the empty string, @c false is returned.
*/
extern bool
-wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_utf8char *name);
+wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
/**
* Joins a split WIM into a stand-alone one-part WIM.
* wimlib_join(), since it is possible to export all images from a split WIM.
*/
extern int
-wimlib_join(const wimlib_mbchar * const *swms,
+wimlib_join(const wimlib_tchar * const *swms,
unsigned num_swms,
- const wimlib_mbchar *output_path,
+ const wimlib_tchar *output_path,
int swm_open_flags,
int wim_write_flags,
wimlib_progress_func_t progress_func);
+/**
+ * Compress a chunk of a WIM resource using LZX compression.
+ *
+ * This function is exported for convenience only and need not be used.
+ *
+ * @param chunk
+ * Uncompressed data of the chunk.
+ * @param chunk_size
+ * Size of the uncompressed chunk, in bytes.
+ * @param out
+ * Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
+ *
+ * @return
+ * The size of the compressed data written to @a out in bytes, or 0 if the
+ * data could not be compressed to (@a chunk_size - 1) bytes or fewer.
+ *
+ * As a special requirement, the compression code is optimized for the WIM
+ * format and therefore requires (@a chunk_size <= 32768).
+ */
+extern unsigned
+wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
+
+/**
+ * Decompresses a block of LZX-compressed data as used in the WIM file format.
+ *
+ * Note that this will NOT work unmodified for LZX as used in the cabinet
+ * format, which is not the same as in the WIM format!
+ *
+ * This function is exported for convenience only and need not be used.
+ *
+ * @param compressed_data
+ * Pointer to the compressed data.
+ *
+ * @param compressed_len
+ * Length of the compressed data, in bytes.
+ *
+ * @param uncompressed_data
+ * Pointer to the buffer into which to write the uncompressed data.
+ *
+ * @param uncompressed_len
+ * Length of the uncompressed data. It must be 32768 bytes or less.
+ *
+ * @return
+ * 0 on success; non-zero on failure.
+ */
+extern int
+wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
+ void *uncompressed_data, unsigned uncompressed_len);
+
+
/**
* Mounts an image in a WIM file on a directory read-only or read-write.
*
* support mounting a split WIM read-only.
*/
extern int
-wimlib_mount_image(WIMStruct *wim, int image, const wimlib_mbchar *dir,
- int mount_flags, WIMStruct **additional_swms,
+wimlib_mount_image(WIMStruct *wim,
+ int image,
+ const wimlib_tchar *dir,
+ int mount_flags,
+ WIMStruct **additional_swms,
unsigned num_additional_swms,
- const wimlib_mbchar *staging_dir);
+ const wimlib_tchar *staging_dir);
/**
* Opens a WIM file and creates a ::WIMStruct for it.
* The XML data for @a wim_file is invalid.
*/
extern int
-wimlib_open_wim(const wimlib_mbchar *wim_file, int open_flags,
- WIMStruct **wim_ret, wimlib_progress_func_t progress_func);
+wimlib_open_wim(const wimlib_tchar *wim_file,
+ int open_flags,
+ WIMStruct **wim_ret,
+ wimlib_progress_func_t progress_func);
/**
* Overwrites the file that the WIM was originally read from, with changes made.
* and while abnormal termination of the program will result in extra data
* appended to the original WIM, it should still be a valid WIM.
*
+ * If this function completes successfully, no functions should be called on @a
+ * wim other than wimlib_free(). You must use wimlib_open_wim() to read the WIM
+ * file anew.
+ *
* @param wim
* Pointer to the ::WIMStruct for the WIM file to write. There may have
* been in-memory changes made to it, which are then reflected in the
* @retval ::WIMLIB_ERR_RENAME
* The temporary file that the WIM was written to could not be renamed to
* the original filename of @a wim.
- * @retval ::WIMLIB_ERR_REOPEN
- * The WIM was overwritten successfully, but it could not be re-opened
- * read-only. Therefore, the resources in the WIM can no longer be
- * accessed, so this limits the functions that can be called on @a wim
- * before calling wimlib_free().
*/
extern int
wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
*/
extern int
wimlib_resolve_image(WIMStruct *wim,
- const wimlib_utf8char *image_name_or_num);
+ const wimlib_tchar *image_name_or_num);
/**
* Sets which image in the WIM is marked as bootable.
*/
extern int
wimlib_set_image_descripton(WIMStruct *wim, int image,
- const wimlib_utf8char *description);
+ const wimlib_tchar *description);
/**
* Changes what is written in the \<FLAGS\> element in the WIM XML data
* Failed to allocate the memory needed to duplicate the @a flags string.
*/
extern int wimlib_set_image_flags(WIMStruct *wim, int image,
- const wimlib_utf8char *flags);
+ const wimlib_tchar *flags);
/**
* Changes the name of an image in the WIM.
* Failed to allocate the memory needed to duplicate the @a name string.
*/
extern int wimlib_set_image_name(WIMStruct *wim, int image,
- const wimlib_utf8char *name);
+ const wimlib_tchar *name);
/**
* Set the functions that wimlib uses to allocate and free memory.
* compressed resources re-compressed.
*/
extern int
-wimlib_split(WIMStruct *wim, const wimlib_mbchar *swm_name,
- size_t part_size, int write_flags,
+wimlib_split(WIMStruct *wim,
+ const wimlib_tchar *swm_name,
+ size_t part_size,
+ int write_flags,
wimlib_progress_func_t progress_func);
/**
* been made to files in the staging directory.
*/
extern int
-wimlib_unmount_image(const wimlib_mbchar *dir, int unmount_flags,
+wimlib_unmount_image(const wimlib_tchar *dir,
+ int unmount_flags,
wimlib_progress_func_t progress_func);
+/** XXX */
+extern int
+wimlib_update_image(WIMStruct *wim,
+ int image,
+ const struct wimlib_update_command *cmds,
+ size_t num_cmds,
+ int update_flags,
+ wimlib_progress_func_t progress_func);
+
/**
* Writes a standalone WIM to a file.
*
* path.
*/
extern int
-wimlib_write(WIMStruct *wim, const wimlib_mbchar *path, int image,
- int write_flags, unsigned num_threads,
+wimlib_write(WIMStruct *wim,
+ const wimlib_tchar *path,
+ int image,
+ int write_flags,
+ unsigned num_threads,
wimlib_progress_func_t progress_func);
+/**
+ * This function is equivalent to wimlib_lzx_compress(), but instead compresses
+ * the data using "XPRESS" compression.
+ */
+extern unsigned
+wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
+
+/**
+ * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
+ * the data is compressed using "XPRESS" compression.
+ */
+extern int
+wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
+ void *uncompressed_data, unsigned uncompressed_len);
+
#endif /* _WIMLIB_H */
git://wimlib.net / wimlib / blobdiff