ra8_rar.h

Go to the documentation of this file.

#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct ra8_rar5_state ra8_rar5_state_t;

typedef size_t (*ra8_rar_read_fn)(void* ctx, uint64_t offset, void* buf, size_t len);

typedef enum : uint8_t {
  k_ra8_rar_ver_none = 0U, 
  k_ra8_rar_ver_4    = 4U, 
  k_ra8_rar_ver_5    = 5U, 
} ra8_rar_version_t;

typedef enum : uint8_t {
  k_ra8_rar_method_store      = 0U, 
  k_ra8_rar_method_compressed = 1U, 
} ra8_rar_method_t;

typedef enum : uint16_t {
  k_ra8_rar_sig4_len    = 7U,   
  k_ra8_rar_sig5_len    = 8U,   
  k_ra8_rar_hdr_scratch = 128U, 
  k_ra8_rar_vint_max    = 10U,  
} ra8_rar_limits_t;

typedef struct {
  ra8_rar_read_fn   read;      
  void*             ctx;       
  uint64_t          size;      
  uint64_t          first_off; 
  ra8_rar_version_t version;   
} ra8_rar_t;

typedef struct {
  uint64_t data_off;  
  uint64_t pack_size; 
  uint64_t unp_size;  
  uint64_t next_off;  
  uint16_t name_len;  
  uint8_t  method;    
  uint8_t  is_file;   
  uint8_t  is_dir;    
} ra8_rar_entry_t;

[[nodiscard]] ra8_err_t
ra8_rar_open(ra8_rar_t* rar, ra8_rar_read_fn read, void* ctx, uint64_t size);

[[nodiscard]] ra8_err_t ra8_rar_next(const ra8_rar_t* rar,
                                     uint64_t         off,
                                     char*            name_buf,
                                     uint16_t         name_cap,
                                     ra8_rar_entry_t* out);

[[nodiscard]] ra8_err_t ra8_rar_extract_stored(const ra8_rar_t*       rar,
                                               const ra8_rar_entry_t* ent,
                                               uint8_t*               buf,
                                               size_t                 cap,
                                               size_t*                got);

[[nodiscard]] ra8_err_t ra8_rar_extract(const ra8_rar_t*       rar,
                                        const ra8_rar_entry_t* ent,
                                        uint8_t*               buf,
                                        size_t                 cap,
                                        ra8_rar5_state_t*      st,
                                        size_t*                got);
 
#ifdef __cplusplus
}
#endif