wimlib.h

Go to the documentation of this file.

/*
 * wimlib.h
 *
 * External header for wimlib.
 *
 * Copyright (C) 2012 Eric Biggers
 *
 * wimlib - Library for working with WIM files 
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option) any
 * later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along
 * with this library; if not, write to the Free Software Foundation, Inc., 59
 * Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 */

#ifndef _WIMLIB_H
#define _WIMLIB_H

#include <stdio.h>
#include <stddef.h>
#include <stdbool.h>

#ifndef _WIMLIB_INTERNAL_H

typedef struct WIMStruct WIMStruct;
#endif

enum wim_link_type {
        WIM_LINK_TYPE_HARD = 0,
        WIM_LINK_TYPE_SYMBOLIC = 1,
        WIM_LINK_TYPE_NONE = 2,
};

enum wim_compression_type {
        WIM_COMPRESSION_TYPE_INVALID = -1,

        WIM_COMPRESSION_TYPE_NONE = 0,

        WIM_COMPRESSION_TYPE_LZX = 1,

        WIM_COMPRESSION_TYPE_XPRESS = 2,
};

#define WIMLIB_MOUNT_FLAG_READWRITE             0x1

#define WIMLIB_MOUNT_FLAG_DEBUG                 0x2

#define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY     0x1

#define WIMLIB_UNMOUNT_FLAG_COMMIT              0x2

#define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY       0x1

#define WIMLIB_WRITE_FLAG_SHOW_PROGRESS         0x2

#define WIMLIB_ADD_IMAGE_FLAG_BOOT              0x1

#define WIMLIB_EXPORT_FLAG_BOOT                 0x1

#define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY        0x1

#define WIMLIB_OPEN_FLAG_SHOW_PROGRESS          0x2

enum wimlib_error_code {
        WIMLIB_ERR_SUCCESS = 0,
        WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
        WIMLIB_ERR_DECOMPRESSION,
        WIMLIB_ERR_DELETE_STAGING_DIR,
        WIMLIB_ERR_FORK,
        WIMLIB_ERR_FUSE,
        WIMLIB_ERR_FUSERMOUNT,
        WIMLIB_ERR_IMAGE_COUNT,
        WIMLIB_ERR_IMAGE_NAME_COLLISION,
        WIMLIB_ERR_INTEGRITY,
        WIMLIB_ERR_INVALID_CHUNK_SIZE,
        WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
        WIMLIB_ERR_INVALID_DENTRY,
        WIMLIB_ERR_INVALID_HEADER_SIZE,
        WIMLIB_ERR_INVALID_IMAGE,
        WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
        WIMLIB_ERR_INVALID_PARAM,
        WIMLIB_ERR_INVALID_RESOURCE_SIZE,
        WIMLIB_ERR_LINK,
        WIMLIB_ERR_MKDIR,
        WIMLIB_ERR_MQUEUE,
        WIMLIB_ERR_NOMEM,
        WIMLIB_ERR_NOTDIR,
        WIMLIB_ERR_NOT_A_WIM_FILE,
        WIMLIB_ERR_NO_FILENAME,
        WIMLIB_ERR_OPEN,
        WIMLIB_ERR_OPENDIR,
        WIMLIB_ERR_READ,
        WIMLIB_ERR_RENAME,
        WIMLIB_ERR_SPLIT,
        WIMLIB_ERR_STAT,
        WIMLIB_ERR_TIMEOUT,
        WIMLIB_ERR_UNKNOWN_VERSION,
        WIMLIB_ERR_UNSUPPORTED,
        WIMLIB_ERR_WRITE,
        WIMLIB_ERR_XML,
};


#define WIM_NO_IMAGE    0

#define WIM_ALL_IMAGES  (-1)


extern int wimlib_add_image(WIMStruct *wim, const char *dir, 
                            const char *name, const char *description, 
                            const char *flags_element, int flags);

extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);

extern int wimlib_delete_image(WIMStruct *wim, int image);

extern int wimlib_export_image(WIMStruct *src_wim, int src_image, 
                        WIMStruct *dest_wim, const char *dest_name, 
                        const char *dest_description, int flags);

extern int wimlib_extract_image(WIMStruct *wim, int image);

extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);

extern void wimlib_free(WIMStruct *wim);

extern int wimlib_get_boot_idx(const WIMStruct *wim);

extern int wimlib_get_compression_type(const WIMStruct *wim);

extern const char *wimlib_get_compression_type_string(int ctype);

extern const char *wimlib_get_error_string(enum wimlib_error_code code);

extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);

extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);


extern int wimlib_get_num_images(const WIMStruct *wim);

bool wimlib_has_integrity_table(const WIMStruct *wim);


extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);

extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags);

extern int wimlib_open_wim(const char *wim_file, int flags, 
                           WIMStruct **wim_ret);

extern int wimlib_overwrite(WIMStruct *wim, int flags);

extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int flags);

extern void wimlib_print_available_images(const WIMStruct *wim, int image);

extern int wimlib_print_files(WIMStruct *wim, int image);

extern void wimlib_print_header(const WIMStruct *wim);

extern void wimlib_print_lookup_table(WIMStruct *wim);

extern int wimlib_print_metadata(WIMStruct *wim, int image);

extern void wimlib_print_wim_information(const WIMStruct *wim);

extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);

extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);

extern int wimlib_set_image_descripton(WIMStruct *wim, int image, 
                                       const char *description);

extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);

extern int wimlib_set_link_type(WIMStruct *wim, int link_type);

int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
                                 void (*free_func)(void *),
                                 void *(*realloc_func)(void *, size_t));

extern int wimlib_set_print_errors(bool show_messages);

extern void wimlib_set_verbose(WIMStruct *wim, bool verbose);

extern int wimlib_set_output_dir(WIMStruct *wim, const char *dir);

extern int wimlib_unmount(const char *dir, int flags);

extern int wimlib_write(WIMStruct *wim, const char *path, int image, int flags);



#endif /* _WIMLIB_H */