]> wimlib.net Git - wimlib/blobdiff - src/wim.c
Update docs
[wimlib] / src / wim.c
index 72b03c0e483af0fa65e6f177f1846529c2b23f4a..667d076b6859ecca519828f36ef79aa8e8b5dc83 100644 (file)
--- a/src/wim.c
+++ b/src/wim.c
@@ -1,9 +1,9 @@
 /*
- * wim.c
+ * wim.c - Stuff that doesn't fit into any other file
  */
 
 /*
- * Copyright (C) 2012 Eric Biggers
+ * Copyright (C) 2012, 2013 Eric Biggers
  *
  * wimlib - Library for working with WIM files
  *
  */
 
 #include "config.h"
+
+#include <errno.h>
+#include <fcntl.h>
 #include <limits.h>
-#include <stdlib.h>
 #include <stdarg.h>
-#include <errno.h>
-
-#include "dentry.h"
+#include <stdlib.h>
 #include <unistd.h>
-#include <fcntl.h>
 
 #ifdef WITH_NTFS_3G
-#include <time.h>
-#include <ntfs-3g/volume.h>
+#  include <time.h>
+#  include <ntfs-3g/volume.h>
+#endif
+
+#ifdef __WIN32__
+#  include "win32.h"
+#else
+#  include <langinfo.h>
 #endif
 
-#include "wimlib_internal.h"
 #include "buffer_io.h"
+#include "dentry.h"
 #include "lookup_table.h"
+#include "wimlib_internal.h"
 #include "xml.h"
 
-static int image_print_metadata(WIMStruct *w)
+static int
+image_print_metadata(WIMStruct *w)
 {
        DEBUG("Printing metadata for image %d", w->current_image);
        print_security_data(wim_security_data(w));
@@ -52,13 +59,15 @@ static int image_print_metadata(WIMStruct *w)
 }
 
 
-static int image_print_files(WIMStruct *w)
+static int
+image_print_files(WIMStruct *w)
 {
        return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
                                  NULL);
 }
 
-static WIMStruct *new_wim_struct()
+static WIMStruct *
+new_wim_struct()
 {
        WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
 #ifdef WITH_FUSE
@@ -78,7 +87,8 @@ static WIMStruct *new_wim_struct()
  * current image in turn.  If @image is a certain image, @visitor is called on
  * the WIM only once, with that image selected.
  */
-int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
+int
+for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
 {
        int ret;
        int start;
@@ -105,10 +115,11 @@ int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
        return 0;
 }
 
-static int sort_image_metadata_by_position(const void *p1, const void *p2)
+static int
+sort_image_metadata_by_position(const void *p1, const void *p2)
 {
-       const struct image_metadata *imd1 = p1;
-       const struct image_metadata *imd2 = p2;
+       const struct wim_image_metadata *imd1 = p1;
+       const struct wim_image_metadata *imd2 = p2;
        u64 offset1 = imd1->metadata_lte->resource_entry.offset;
        u64 offset2 = imd2->metadata_lte->resource_entry.offset;
        if (offset1 < offset2)
@@ -123,8 +134,8 @@ static int sort_image_metadata_by_position(const void *p1, const void *p2)
  * If @lte points to a metadata resource, append it to the list of metadata
  * resources in the WIMStruct.  Otherwise, do nothing.
  */
-static int append_metadata_resource_entry(struct lookup_table_entry *lte,
-                                         void *wim_p)
+static int
+append_metadata_resource_entry(struct wim_lookup_table_entry *lte, void *wim_p)
 {
        WIMStruct *w = wim_p;
        int ret = 0;
@@ -148,7 +159,8 @@ static int append_metadata_resource_entry(struct lookup_table_entry *lte,
 }
 
 /* Returns the compression type given in the flags of a WIM header. */
-static int wim_hdr_flags_compression_type(int wim_hdr_flags)
+static int
+wim_hdr_flags_compression_type(int wim_hdr_flags)
 {
        if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
                if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
@@ -165,10 +177,11 @@ static int wim_hdr_flags_compression_type(int wim_hdr_flags)
 /*
  * Creates a WIMStruct for a new WIM file.
  */
-WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
+WIMLIBAPI int
+wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
 {
        WIMStruct *w;
-       struct lookup_table *table;
+       struct wim_lookup_table *table;
        int ret;
 
        DEBUG("Creating new WIM with %s compression.",
@@ -196,14 +209,17 @@ out_free:
        return ret;
 }
 
-WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
+WIMLIBAPI int
+wimlib_get_num_images(const WIMStruct *w)
 {
        return w->hdr.image_count;
 }
 
-int select_wim_image(WIMStruct *w, int image)
+int
+select_wim_image(WIMStruct *w, int image)
 {
-       struct image_metadata *imd;
+       struct wim_image_metadata *imd;
+       int ret;
 
        DEBUG("Selecting image %d", image);
 
@@ -233,30 +249,33 @@ int select_wim_image(WIMStruct *w, int image)
                        INIT_HLIST_HEAD(&imd->inode_list);
                }
        }
-
        w->current_image = image;
-       imd = wim_get_current_image_metadata(w);
-
+       imd = &w->image_metadata[image - 1];
        if (imd->root_dentry) {
-               return 0;
+               ret = 0;
        } else {
                #ifdef ENABLE_DEBUG
                DEBUG("Reading metadata resource specified by the following "
                      "lookup table entry:");
-               print_lookup_table_entry(imd->metadata_lte);
+               print_lookup_table_entry(imd->metadata_lte, stdout);
                #endif
-               return read_metadata_resource(w, imd);
+               ret = read_metadata_resource(w, imd);
+               if (ret)
+                       w->current_image = WIMLIB_NO_IMAGE;
        }
+       return ret;
 }
 
 
 /* Returns the compression type of the WIM file. */
-WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
+WIMLIBAPI int
+wimlib_get_compression_type(const WIMStruct *w)
 {
        return wim_hdr_flags_compression_type(w->hdr.flags);
 }
 
-WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
+WIMLIBAPI const char *
+wimlib_get_compression_type_string(int ctype)
 {
        switch (ctype) {
                case WIMLIB_COMPRESSION_TYPE_NONE:
@@ -275,7 +294,8 @@ WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
  * the number of the image, or the name of the image.  The images are numbered
  * starting at 1.
  */
-WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
+WIMLIBAPI int
+wimlib_resolve_image(WIMStruct *w, const utf8char *image_name_or_num)
 {
        char *p;
        int image;
@@ -304,7 +324,8 @@ WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
 
 
 /* Prints some basic information about a WIM file. */
-WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
+WIMLIBAPI void
+wimlib_print_wim_information(const WIMStruct *w)
 {
        const struct wim_header *hdr;
 
@@ -326,12 +347,14 @@ WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
        putchar('\n');
 }
 
-WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
+WIMLIBAPI bool
+wimlib_has_integrity_table(const WIMStruct *w)
 {
        return w->hdr.integrity.size != 0;
 }
 
-WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
+WIMLIBAPI void
+wimlib_print_available_images(const WIMStruct *w, int image)
 {
        int first;
        int last;
@@ -360,7 +383,8 @@ WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
 
 /* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
  * not WIMLIB_NO_IMAGE. */
-WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
+WIMLIBAPI int
+wimlib_print_metadata(WIMStruct *w, int image)
 {
        if (w->hdr.part_number != 1) {
                ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
@@ -371,7 +395,8 @@ WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
        return for_image(w, image, image_print_metadata);
 }
 
-WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
+WIMLIBAPI int
+wimlib_print_files(WIMStruct *w, int image)
 {
        if (w->hdr.part_number != 1) {
                ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
@@ -383,7 +408,8 @@ WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
 }
 
 /* Sets the index of the bootable image. */
-WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
+WIMLIBAPI int
+wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
 {
        if (w->hdr.total_parts != 1) {
                ERROR("Cannot modify the boot index of a split WIM!");
@@ -406,7 +432,8 @@ WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
        return 0;
 }
 
-WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
+WIMLIBAPI int
+wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
 {
        if (total_parts_ret)
                *total_parts_ret = w->hdr.total_parts;
@@ -414,7 +441,8 @@ WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
 }
 
 
-WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
+WIMLIBAPI int
+wimlib_get_boot_idx(const WIMStruct *w)
 {
        return w->hdr.boot_idx;
 }
@@ -423,8 +451,9 @@ WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
  * Begins the reading of a WIM file; opens the file and reads its header and
  * lookup table, and optionally checks the integrity.
  */
-static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
-                     wimlib_progress_func_t progress_func)
+static int
+begin_read(WIMStruct *w, const mbchar *in_wim_path, int open_flags,
+          wimlib_progress_func_t progress_func)
 {
        int ret;
        int xml_num_images;
@@ -446,6 +475,9 @@ static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
         *
         * This will break if the full path to the WIM changes in the
         * intervening time...
+        *
+        * Warning: in Windows native builds, realpath() calls the replacement
+        * function in win32.c.
         */
        w->filename = realpath(in_wim_path, NULL);
        if (!w->filename) {
@@ -495,7 +527,7 @@ static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
 
        if (w->hdr.image_count != 0) {
                w->image_metadata = CALLOC(w->hdr.image_count,
-                                          sizeof(struct image_metadata));
+                                          sizeof(struct wim_image_metadata));
 
                if (!w->image_metadata) {
                        ERROR("Failed to allocate memory for %u image metadata structures",
@@ -515,7 +547,7 @@ static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
                return ret;
 
        /* Make sure all the expected images were found.  (We already have
-        * returned false if *extra* images were found) */
+        * returned WIMLIB_ERR_IMAGE_COUNT if *extra* images were found) */
        if (w->current_image != w->hdr.image_count &&
            w->hdr.part_number == 1)
        {
@@ -529,7 +561,7 @@ static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
         * file, rather than their order in the lookup table, which is random
         * because of hashing. */
        qsort(w->image_metadata, w->current_image,
-             sizeof(struct image_metadata), sort_image_metadata_by_position);
+             sizeof(struct wim_image_metadata), sort_image_metadata_by_position);
 
        w->current_image = WIMLIB_NO_IMAGE;
 
@@ -553,13 +585,13 @@ static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
        return 0;
 }
 
-
 /*
  * Opens a WIM file and creates a WIMStruct for it.
  */
-WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
-                             WIMStruct **w_ret,
-                             wimlib_progress_func_t progress_func)
+WIMLIBAPI int
+wimlib_open_wim(const mbchar *wim_file, int open_flags,
+               WIMStruct **w_ret,
+               wimlib_progress_func_t progress_func)
 {
        WIMStruct *w;
        int ret;
@@ -579,8 +611,9 @@ WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
        return ret;
 }
 
-void destroy_image_metadata(struct image_metadata *imd,
-                           struct lookup_table *table)
+void
+destroy_image_metadata(struct wim_image_metadata *imd,
+                      struct wim_lookup_table *table)
 {
        free_dentry_tree(imd->root_dentry, table);
        free_security_data(imd->security_data);
@@ -595,9 +628,10 @@ void destroy_image_metadata(struct image_metadata *imd,
 
 /* Frees the memory for the WIMStruct, including all internal memory; also
  * closes all files associated with the WIMStruct.  */
-WIMLIBAPI void wimlib_free(WIMStruct *w)
+WIMLIBAPI void
+wimlib_free(WIMStruct *w)
 {
-       DEBUG2("Freeing WIMStruct");
+       DEBUG("Freeing WIMStruct");
 
        if (!w)
                return;
@@ -633,4 +667,38 @@ WIMLIBAPI void wimlib_free(WIMStruct *w)
        }
 #endif
        FREE(w);
+       DEBUG("Freed WIMStruct");
+}
+
+static bool
+test_locale_ctype_utf8()
+{
+       char *ctype = nl_langinfo(CODESET);
+
+       return (strstr(ctype, "UTF-8") == 0 ||
+               strstr(ctype, "UTF8") == 0 ||
+               strstr(ctype, "utf8") == 0 ||
+               strstr(ctype, "utf-8") == 0);
+}
+
+/* Get global memory allocations out of the way.  Not strictly necessary in
+ * single-threaded programs like 'imagex'. */
+WIMLIBAPI int
+wimlib_global_init()
+{
+       libxml_global_init();
+#ifdef WITH_NTFS_3G
+       libntfs3g_global_init();
+#endif
+       wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
+       return 0;
+}
+
+/* Free global memory allocations.  Not strictly necessary if the process using
+ * wimlib is just about to exit (as is the case for 'imagex'). */
+WIMLIBAPI void
+wimlib_global_cleanup()
+{
+       libxml_global_cleanup();
+       iconv_global_cleanup();
 }