]> wimlib.net Git - wimlib/blobdiff - include/wimlib/wim.h
Update progress functions
[wimlib] / include / wimlib / wim.h
index 9d01522a3bdeae1c9521182a66154dd55a063870..86926d8983232817d3f663814790f9477dfbdbd4 100644 (file)
@@ -1,8 +1,11 @@
 #ifndef _WIMLIB_WIM_H
 #define _WIMLIB_WIM_H
 
+#include "wimlib.h"
 #include "wimlib/header.h"
 #include "wimlib/types.h"
+#include "wimlib/file_io.h"
+#include "wimlib/list.h"
 
 struct wim_info;
 struct wim_lookup_table;
@@ -11,14 +14,15 @@ struct wim_image_metadata;
 /* The opaque structure exposed to the wimlib API. */
 struct WIMStruct {
 
-       /* File descriptor for the WIM file, opened for reading, or -1 if it has
-        * not been opened or there is no associated file backing it yet. */
-       int in_fd;
+       /* File descriptor for the WIM file, opened for reading.  in_fd.fd is -1
+        * if the WIM file has not been opened or there is no associated file
+        * backing it yet. */
+       struct filedes in_fd;
 
        /* File descriptor, opened either for writing only or for
         * reading+writing, for the WIM file (if any) currently being written.
         * */
-       int out_fd;
+       struct filedes out_fd;
 
        /* The name of the WIM file (if any) that has been opened. */
        tchar *filename;
@@ -39,6 +43,14 @@ struct WIMStruct {
        /* Temporary field */
        void *private;
 
+       struct wimlib_decompressor *decompressor;
+       u8 decompressor_ctype;
+       u32 decompressor_max_block_size;
+
+       struct list_head subwims;
+
+       struct list_head subwim_node;
+
        /* The currently selected image, indexed starting at 1.  If not 0,
         * subtract 1 from this to get the index of the current image in the
         * image_metadata array. */
@@ -47,40 +59,103 @@ struct WIMStruct {
        /* Have any images been deleted? */
        u8 deletion_occurred : 1;
 
-       u8 all_images_verified : 1;
+       /* Do we know that all the stream reference counts in the WIM are
+        * correct?  If so, this is set to 1 and deletions are safe; otherwise
+        * this is set to 0 and deletions are not safe until reference counts
+        * are recalculated.  (This is due to a bug in M$'s software that
+        * generates WIMs with invalid reference counts.)  */
+       u8 refcnts_ok : 1;
+
        u8 wim_locked : 1;
+
+       /* One of WIMLIB_COMPRESSION_TYPE_*, cached from the header flags. */
+       u8 compression_type;
+
+       /* Overridden compression type for wimlib_overwrite() or wimlib_write().
+        * Can be changed by wimlib_set_output_compression_type(); otherwise is
+        * the same as compression_type.  */
+       u8 out_compression_type;
+
+       /* Compression type for writing packed streams; can be set with
+        * wimlib_set_output_pack_compression_type().  */
+       u8 out_pack_compression_type;
+
+       /* Uncompressed size of compressed chunks in this WIM (cached from
+        * header).  */
+       u32 chunk_size;
+
+       /* Overridden chunk size for wimlib_overwrite() or wimlib_write().  Can
+        * be changed by wimlib_set_output_chunk_size(); otherwise is the same
+        * as chunk_size.  */
+       u32 out_chunk_size;
+
+       /* Chunk size for writing packed streams; can be set with
+        * wimlib_set_output_pack_chunk_size().  */
+       u32 out_pack_chunk_size;
+
+       /* Currently registered progress function for this WIMStruct, or NULL if
+        * no progress function is currently registered for this WIMStruct.  */
+       wimlib_progress_func_t progfunc;
+       void *progctx;
 };
 
+static inline bool wim_is_pipable(const WIMStruct *wim)
+{
+       return (wim->hdr.magic == PWM_MAGIC);
+}
+
+static inline bool wim_has_integrity_table(const WIMStruct *wim)
+{
+       return (wim->hdr.integrity_table_reshdr.offset_in_wim != 0);
+}
+
+static inline bool wim_has_metadata(const WIMStruct *wim)
+{
+       return (wim->image_metadata != NULL || wim->hdr.image_count == 0);
+}
+
 extern int
-wim_run_full_verifications(WIMStruct *w);
+wim_recalculate_refcnts(WIMStruct *wim);
 
 extern int
-read_header(const tchar *filename, int in_fd, struct wim_header *hdr);
+set_wim_hdr_cflags(int ctype, struct wim_header *hdr);
 
 extern int
-write_header(const struct wim_header *hdr, int out_fd);
+init_wim_header(struct wim_header *hdr, int ctype, u32 chunk_size);
 
 extern int
-init_header(struct wim_header *hdr, int ctype);
+read_wim_header(WIMStruct *wim, struct wim_header *hdr);
 
+extern int
+write_wim_header(const struct wim_header *hdr, struct filedes *out_fd);
+
+extern int
+write_wim_header_at_offset(const struct wim_header *hdr, struct filedes *out_fd,
+                          off_t offset);
 
 extern int
-rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to);
+write_wim_header_flags(u32 hdr_flags, struct filedes *out_fd);
 
 extern int
-select_wim_image(WIMStruct *w, int image);
+select_wim_image(WIMStruct *wim, int image);
 
 extern int
-for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
+for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *));
 
 extern int
-wim_checksum_unhashed_streams(WIMStruct *w);
+wim_checksum_unhashed_streams(WIMStruct *wim);
+
+/* Internal open flags (pass to open_wim_as_WIMStruct(), not wimlib_open_wim())
+ */
+#define WIMLIB_OPEN_FLAG_FROM_PIPE     0x80000000
 
 extern int
-reopen_wim(WIMStruct *w);
+open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
+                     WIMStruct **wim_ret,
+                     wimlib_progress_func_t progfunc, void *progctx);
 
 extern int
-close_wim(WIMStruct *w);
+close_wim(WIMStruct *wim);
 
 extern int
 can_modify_wim(WIMStruct *wim);