wows-depack.h

Go to the documentation of this file.

 
#include <stdint.h>
#include <stdbool.h>
 
/* Error codes  */
 
#define WOWS_ERROR_CORRUPTED_FILE 1             
#define WOWS_ERROR_BAD_MAGIC 2                  
#define WOWS_ERROR_MISSING_METADATA_ENTRY 3     
#define WOWS_ERROR_MAX_LEVEL_REACHED 4          
#define WOWS_ERROR_NON_ZERO_TERMINATED_STRING 5 
#define WOWS_ERROR_PATH_TOO_LONG 6              
#define WOWS_ERROR_UNKNOWN 7                    
#define WOWS_ERROR_ID_COLLISION_FILE_DIR 8      
#define WOWS_ERROR_FILE_OPEN_FAILURE 9          
#define WOWS_ERROR_DECOMPOSE_PATH 10            
#define WOWS_ERROR_INVALID_SEARCH_PATTERN 11    
#define WOWS_ERROR_NOT_A_FILE 12                
#define WOWS_ERROR_NOT_A_DIR 13                 
#define WOWS_ERROR_NOT_FOUND 14                 
#define WOWS_ERROR_FILE_WRITE 15                
#define WOWS_ERROR_MAX_FILE 16                  
/* ---------- */
 
/* Debug levels */
 
#define WOWS_NO_DEBUG 0                  
#define WOWS_DEBUG_RAW_RECORD (1 << 0)   
#define WOWS_DEBUG_FILE_LISTING (1 << 1) 
/* ---------- */
 
/*  Search Modes */
 
#define WOWS_SEARCH_FILE_ONLY 0     
#define WOWS_SEARCH_DIR_ONLY 1      
#define WOWS_SEARCH_FILE_PLUS_DIR 2 
#define WOWS_SEARCH_FULL_PATH 3     
/* ---------- */
 
/*
 * @brief WoWs resource extractor context.
 *
 * This structure is used to hold the context for the WoWs extractor.
 *
 * This structure is not meant to be manipulated directly.
 * Internal fields are private and could be subject to changes.
 */
typedef struct {
    uint8_t debug_level;  // Debug level for logging
    void *root;           // Root Inode (WOWS_DIR_INODE * root;)
    void *metadata_map;   // Global Metadata hashmap (struct hashmap *metadata_map;)
    void *file_map;       // Global File hashmap (struct hashmap *file_map;)
    void *current_dir;    // Current directory (WOWS_DIR_INODE *current_dir;)
    void **indexes;       // Array of structures representing each index file (WOWS_INDEX
                          // **indexes;)
    uint32_t index_count; // Size of the array
    bool is_le;           // Flag for endianess (true if LE, false if BE)
    char *err_msg;        // Last error message
} WOWS_CONTEXT;
 
/* ---------- */
 
/* Context init/destruction */
 
WOWS_CONTEXT *wows_init_context(uint8_t debug_level);
 
int wows_free_context(WOWS_CONTEXT *context);
 
int wows_free_context_no_munmap(WOWS_CONTEXT *context);
/* ---------- */
 
/* Index parsing functions */
 
int wows_parse_index_file(const char *index_file_path, WOWS_CONTEXT *context);
 
int wows_parse_index_dir(const char *index_dir_path, WOWS_CONTEXT *context);
 
int wows_parse_index_buffer(char *contents, size_t length, const char *index_file_path, int fd, WOWS_CONTEXT *context);
 
/* Archive exploration functions */
 
int wows_search(WOWS_CONTEXT *context, char *pattern, int mode, int *result_count, char ***results);
 
/* read the content of a directory */
// Not implemented
// int wows_readdir(WOWS_CONTEXT *context, char dir_path, char **result[]);
 
// Not implemented
/* give the stat of a given path (mainly if it's a directory or a file, and the file size) */
// int wows_stat_path(WOWS_CONTEXT *context, char path);
 
/* ---------- */
 
/* Archive extraction functions */
 
int wows_extract_file_fp(WOWS_CONTEXT *context, char *file_path, FILE *output);
 
int wows_extract_file(WOWS_CONTEXT *context, char *file_path, char *out_path);
 
int wows_extract_dir(WOWS_CONTEXT *context, char *dir_path, char *out_dir_path);
 
/* ---------- */
 
/* Debugging/output functions */
 
int wows_print_tree(WOWS_CONTEXT *context);
 
int wows_print_flat(WOWS_CONTEXT *context);
 
char *wows_error_string(int error_code, WOWS_CONTEXT *context);
 
/* ---------- */
 
int wows_write_pkg(WOWS_CONTEXT *context, char *in_path, char *name, FILE *pkg_fp, FILE *idx_fp);
 
int wows_get_latest_idx_dir(char *wows_base_dir, char **idx_dir);