rockbox/firmware/include/zip.h
James Buren 8846e087c0 zip: implement zip extraction support
This adds code sufficient to extract files to available storage given a
suitable root directory to extract to. It works on an already open zip
handle and also supports chain-loading a secondary callback in the event
that integration into the process is desired.

Change-Id: Id200d8f20d84a0cbd22906470de8bbd21d4525ef
2021-07-11 05:14:20 +00:00

68 lines
2 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2021 by James Buren
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#ifndef _ZIP_H_
#define _ZIP_H_
#include <stdbool.h>
#include <stdint.h>
#include <time.h>
enum {
ZIP_PASS_SHALLOW,
ZIP_PASS_START,
ZIP_PASS_DATA,
ZIP_PASS_END,
};
struct zip;
struct zip_args {
uint16_t entry;
uint16_t entries;
char* name;
uint32_t file_size;
time_t mtime;
void* block;
uint32_t block_size;
uint32_t read_size;
};
typedef int (*zip_callback) (const struct zip_args* args, int pass, void* ctx);
// open a handle for the given full file name path
struct zip* zip_open(const char* name, bool try_mem);
// quick read of only directory index
int zip_read_shallow(struct zip* z, zip_callback cb, void* ctx);
// slow read of whole archive
// this can also pickup where a successful shallow read leftoff
int zip_read_deep(struct zip* z, zip_callback cb, void* ctx);
// extract the contents to an existing directory
// this can also pickup where a successful shallow read leftoff
int zip_extract(struct zip* z, const char* root, zip_callback cb, void* ctx);
// returns system resources
void zip_close(struct zip* z);
#endif