unarch_tar.h

Go to the documentation of this file.

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

typedef enum : uint16_t {
  k_unarch_tar_block    = 512U,  
  k_unarch_tar_meta_max = 4U,    
  k_unarch_tar_pax_max  = 2048U, 
} unarch_tar_dims_t;

typedef struct {
  unarch_read_fn      read;   
  void*               ctx;    
  uint64_t            size;   
  ra8_decomp_budget_t budget; 
  bool                live;   
} unarch_tar_t;

typedef struct {
  uint64_t data_off; 
  uint64_t size;     
  uint64_t next_off; 
  uint16_t name_len; 
  uint8_t  is_file;  
  uint8_t  is_dir;   
} unarch_tar_entry_t;

[[nodiscard]] bool unarch_tar_probe(const uint8_t* block, size_t len);

[[nodiscard]] ra8_err_t unarch_tar_open(unarch_tar_t*              t,
                                        unarch_read_fn             read,
                                        void*                      ctx,
                                        uint64_t                   size,
                                        const ra8_decomp_limits_t* limits);

[[nodiscard]] ra8_err_t unarch_tar_next(unarch_tar_t*       t,
                                        uint64_t            off,
                                        char*               name_buf,
                                        uint16_t            name_cap,
                                        unarch_tar_entry_t* out);

[[nodiscard]] ra8_err_t unarch_tar_read(const unarch_tar_t*       t,
                                        const unarch_tar_entry_t* ent,
                                        uint8_t*                  buf,
                                        size_t                    cap,
                                        size_t*                   got);
 
#ifdef __cplusplus
}
#endif