]> wimlib.net Git - wimlib/blobdiff - src/wimlib.h
Get imagex extract --to-stdout working
[wimlib] / src / wimlib.h
index e7f89faa4ab3eb5ed18d6928dd89621ec67863ba..b522c6877e883f33f02feb1ddb5cffe5c4f4e257 100644 (file)
@@ -302,6 +302,9 @@ enum wimlib_progress_msg {
         * ::wimlib_progress_info.extract. */
        WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
 
+       /** XXX */
+       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,
@@ -328,6 +331,9 @@ enum wimlib_progress_msg {
         * ::wimlib_progress_info.extract. */
        WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
 
+       /** XXX */
+       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. */
@@ -497,6 +503,11 @@ union wimlib_progress_info {
                 * 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. */
@@ -700,14 +711,14 @@ struct wimlib_capture_config {
  * current root; also exclude absolute symbolic links that point outside the
  * directory tree being captured.
  *
- * Without this flag, the default is to do this only if WIM_HDR_FLAG_RP_FIX is
- * set in the WIM header.  WIM_HDR_FLAG_RP_FIX is set if the first image in a
- * WIM is captured with WIMLIB_ADD_IMAGE_FLAG_RPFIX enabled and currently cannot
- * be changed. */
+ * 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.  Without this flag, the default is to do
- * reparse point fixes if WIM_HDR_FLAG_RP_FIX is set in the WIM header. */
+/* 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
 
 /******************************
@@ -758,7 +769,7 @@ struct wimlib_capture_config {
 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS                        0x00000080
 
 /* Extract equivalent to ::WIMLIB_ADD_IMAGE_FLAG_RPFIX; force reparse-point
- * fixups on, so absolute symbolic links are junction points will be fixed to be
+ * 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. */
 #define WIMLIB_EXTRACT_FLAG_RPFIX                      0x00000100
@@ -767,6 +778,9 @@ struct wimlib_capture_config {
  * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
 #define WIMLIB_EXTRACT_FLAG_NORPFIX                    0x00000200
 
+/** Ignore the target directory; only extract file data to standard output. */
+#define WIMLIB_EXTRACT_FLAG_TO_STDOUT                  0x00000400
+
 /******************************
  * WIMLIB_MOUNT_FLAG_*        *
  ******************************/
@@ -858,67 +872,38 @@ struct wimlib_capture_config {
  * locale's character encoding. */
 #define WIMLIB_INIT_FLAG_ASSUME_UTF8                   0x00000001
 
-
-#if 0
-/****************************************************************
- * Definition of struct wimlib_modify_command, with various flags
- ****************************************************************/
-
-enum {
-       WIMLIB_MOVE_TREE_FLAG_OVERWRITE_ALL                     = 0x1,
-       WIMLIB_MOVE_TREE_FLAG_OVERWRITE_NONDIRECTORIES          = 0x2,
-       WIMLIB_MOVE_TREE_FLAG_OVERWRITE_EMPTY_DIRECTORIES       = 0x4,
-       WIMLIB_MOVE_TREE_FLAG_OVERWRITE_DIRECTORIES             = 0x8,
-};
-
-enum {
-       WIMLIB_DELETE_TREE_FLAG_FORCE                   = 0x1,
-       WIMLIB_DELETE_TREE_FLAG_RECURSIVE               = 0x2,
-       WIMLIB_DELETE_TREE_FLAG_REMOVE_EMPTY_DIR        = 0x4,
-};
-
-enum {
-       WIMLIB_ADD_TREE_FLAG_DEREFERENCE                = 0x1,
-       WIMLIB_ADD_TREE_FLAG_VERBOSE                    = 0x2,
-       WIMLIB_ADD_TREE_FLAG_UNIX_DATA                  = 0x4,
-       WIMLIB_ADD_TREE_FLAG_NOACLS                     = 0x8,
-       WIMLIB_ADD_TREE_FLAG_NTFS_VOLUME                = 0x01,
-       WIMLIB_ADD_TREE_FLAG_OVERLAY                    = 0x02,
-       WIMLIB_ADD_TREE_FLAG_MAKE_NECESSARY_DIRS        = 0x04,
-};
-
-enum wimlib_modify_op {
-       WIMLIB_MODIFY_OP_DELETE_TREE,
-       WIMLIB_MODIFY_OP_ADD_TREE,
-       WIMLIB_MODIFY_OP_MOVE_TREE,
-};
-
-struct wimlib_modify_command {
-       enum wimlib_modify_op op;
+/** XXX */
+struct wimlib_update_command {
+       enum {
+               WIMLIB_UPDATE_OP_ADD,
+               WIMLIB_UPDATE_OP_DELETE,
+               WIMLIB_UPDATE_OP_MOVE,
+       } op;
        union {
-               struct wimlib_modify_command_delete_tree {
-                       int delete_tree_flags;
-                       const wimlib_tchar *tree_wim_path;
-                       unsigned long reserved;
-               } delete_tree;
-
-               struct wimlib_modify_command_add_tree {
-                       int add_tree_flags;
+               struct {
                        const wimlib_tchar *fs_source_path;
                        const wimlib_tchar *wim_target_path;
-                       unsigned long reserved;
-               } add_tree;
-
-               struct wimlib_modify_command_move_tree {
-                       int move_tree_flags;
+                       const struct wimlib_capture_config *config;
+                       int add_flags;
+               } add;
+               struct {
+                       const wimlib_tchar *path_in_wim;
+                       int delete_flags;
+               } delete;
+               struct {
                        const wimlib_tchar *wim_source_path;
                        const wimlib_tchar *wim_target_path;
-                       unsigned long reserved;
-               } move_tree;
+                       int rename_flags;
+               } rename;
        };
 };
-#endif
 
+/** XXX */
+struct wimlib_extract_command {
+       wimlib_tchar *wim_source_path;
+       wimlib_tchar *fs_dest_path;
+       int extract_flags;
+};
 
 /**
  * Possible values of the error code returned by many functions in wimlib.
@@ -942,6 +927,7 @@ enum wimlib_error_code {
        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,
@@ -955,6 +941,7 @@ enum wimlib_error_code {
        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,
@@ -976,6 +963,7 @@ enum wimlib_error_code {
        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,
@@ -988,6 +976,8 @@ enum wimlib_error_code {
        WIMLIB_ERR_VOLUME_LACKS_FEATURES,
        WIMLIB_ERR_WRITE,
        WIMLIB_ERR_XML,
+       WIMLIB_ERR_PATH_DOES_NOT_EXIST,
+       WIMLIB_ERR_NOT_A_REGULAR_FILE,
 };
 
 
@@ -1000,12 +990,9 @@ enum wimlib_error_code {
 /**
  * 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
@@ -1302,6 +1289,17 @@ wimlib_export_image(WIMStruct *src_wim, int src_image,
                    unsigned num_additional_swms,
                    wimlib_progress_func_t progress_func);
 
+/** XXX */
+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.
@@ -1974,6 +1972,10 @@ wimlib_open_wim(const wimlib_tchar *wim_file,
  * 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
@@ -2001,11 +2003,6 @@ wimlib_open_wim(const wimlib_tchar *wim_file,
  * @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,