new internal image deletion helper
[wimlib] / include / wimlib / wim.h
1 #ifndef _WIMLIB_WIM_H
2 #define _WIMLIB_WIM_H
3
4 #include "wimlib.h"
5 #include "wimlib/header.h"
6 #include "wimlib/types.h"
7 #include "wimlib/file_io.h"
8 #include "wimlib/list.h"
9
10 struct wim_info;
11 struct wim_lookup_table;
12 struct wim_image_metadata;
13
14 /* The opaque structure exposed to the wimlib API. */
15 struct WIMStruct {
16
17         /* File descriptor for the WIM file, opened for reading.  in_fd.fd is -1
18          * if the WIM file has not been opened or there is no associated file
19          * backing it yet. */
20         struct filedes in_fd;
21
22         /* File descriptor, opened either for writing only or for
23          * reading+writing, for the WIM file (if any) currently being written.
24          * */
25         struct filedes out_fd;
26
27         /* The name of the WIM file (if any) that has been opened. */
28         tchar *filename;
29
30         /* The lookup table for the WIM file. */
31         struct wim_lookup_table *lookup_table;
32
33         /* Information retrieved from the XML data, arranged in an orderly
34          * manner. */
35         struct wim_info *wim_info;
36
37         /* Array of the image metadata, one for each image in the WIM. */
38         struct wim_image_metadata **image_metadata;
39
40         /* The header of the WIM file. */
41         struct wim_header hdr;
42
43         /* Temporary field */
44         void *private;
45
46         struct wimlib_decompressor *decompressor;
47         u8 decompressor_ctype;
48         u32 decompressor_max_block_size;
49
50         struct list_head subwims;
51
52         struct list_head subwim_node;
53
54         /* The currently selected image, indexed starting at 1.  If not 0,
55          * subtract 1 from this to get the index of the current image in the
56          * image_metadata array. */
57         int current_image;
58
59         /* Have any images been deleted? */
60         u8 image_deletion_occurred : 1;
61
62         /* Has the underlying WIM file been locked for appending?  */
63         u8 locked_for_append : 1;
64
65         /* One of WIMLIB_COMPRESSION_TYPE_*, cached from the header flags. */
66         u8 compression_type;
67
68         /* Overridden compression type for wimlib_overwrite() or wimlib_write().
69          * Can be changed by wimlib_set_output_compression_type(); otherwise is
70          * the same as compression_type.  */
71         u8 out_compression_type;
72
73         /* Compression type for writing packed streams; can be set with
74          * wimlib_set_output_pack_compression_type().  */
75         u8 out_pack_compression_type;
76
77         /* Uncompressed size of compressed chunks in this WIM (cached from
78          * header).  */
79         u32 chunk_size;
80
81         /* Overridden chunk size for wimlib_overwrite() or wimlib_write().  Can
82          * be changed by wimlib_set_output_chunk_size(); otherwise is the same
83          * as chunk_size.  */
84         u32 out_chunk_size;
85
86         /* Chunk size for writing packed streams; can be set with
87          * wimlib_set_output_pack_chunk_size().  */
88         u32 out_pack_chunk_size;
89
90         /* Currently registered progress function for this WIMStruct, or NULL if
91          * no progress function is currently registered for this WIMStruct.  */
92         wimlib_progress_func_t progfunc;
93         void *progctx;
94 };
95
96 static inline bool wim_is_pipable(const WIMStruct *wim)
97 {
98         return (wim->hdr.magic == PWM_MAGIC);
99 }
100
101 static inline bool wim_has_integrity_table(const WIMStruct *wim)
102 {
103         return (wim->hdr.integrity_table_reshdr.offset_in_wim != 0);
104 }
105
106 static inline bool wim_has_metadata(const WIMStruct *wim)
107 {
108         return (wim->image_metadata != NULL || wim->hdr.image_count == 0);
109 }
110
111 extern int
112 set_wim_hdr_cflags(int ctype, struct wim_header *hdr);
113
114 extern int
115 init_wim_header(struct wim_header *hdr, int ctype, u32 chunk_size);
116
117 extern int
118 read_wim_header(WIMStruct *wim, struct wim_header *hdr);
119
120 extern int
121 write_wim_header(const struct wim_header *hdr, struct filedes *out_fd);
122
123 extern int
124 write_wim_header_at_offset(const struct wim_header *hdr, struct filedes *out_fd,
125                            off_t offset);
126
127 extern int
128 write_wim_header_flags(u32 hdr_flags, struct filedes *out_fd);
129
130 extern int
131 select_wim_image(WIMStruct *wim, int image);
132
133 extern int
134 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *));
135
136 extern int
137 wim_checksum_unhashed_streams(WIMStruct *wim);
138
139 extern int
140 delete_wim_image(WIMStruct *wim, int image);
141
142 /* Internal open flags (pass to open_wim_as_WIMStruct(), not wimlib_open_wim())
143  */
144 #define WIMLIB_OPEN_FLAG_FROM_PIPE      0x80000000
145
146 extern int
147 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
148                       WIMStruct **wim_ret,
149                       wimlib_progress_func_t progfunc, void *progctx);
150
151 extern int
152 can_modify_wim(WIMStruct *wim);
153
154 #endif /* _WIMLIB_WIM_H */