sqsh_metablock_private.h

Go to the documentation of this file.

/******************************************************************************
 *                                                                            *
 * Copyright (c) 2023-2024, Enno Boland <g@s01.de>                            *
 *                                                                            *
 * Redistribution and use in source and binary forms, with or without         *
 * modification, are permitted provided that the following conditions are     *
 * met:                                                                       *
 *                                                                            *
 * * Redistributions of source code must retain the above copyright notice,   *
 *   this list of conditions and the following disclaimer.                    *
 * * Redistributions in binary form must reproduce the above copyright        *
 *   notice, this list of conditions and the following disclaimer in the      *
 *   documentation and/or other materials provided with the distribution.     *
 *                                                                            *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS    *
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  *
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR     *
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR          *
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,      *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,        *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR         *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF     *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING       *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS         *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.               *
 *                                                                            *
 ******************************************************************************/
 
#ifndef SQSH_METABLOCK_PRIVATE_H
#define SQSH_METABLOCK_PRIVATE_H
 
#include "sqsh_extract_private.h"
#include "sqsh_mapper_private.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SqshArchive;
 
/***************************************
 * metablock/metablock_iterator.c
 */
 
struct SqshMetablockIterator {
    struct SqshMapReader reader;
    struct SqshExtractManager *compression_manager;
    struct SqshExtractView extract_view;
    bool is_compressed;
    uint16_t outer_size;
    uint16_t inner_size;
    const uint8_t *data;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__metablock_iterator_init(
        struct SqshMetablockIterator *iterator, struct SqshArchive *sqsh,
        uint64_t start_address, uint64_t upper_limit);
 
SQSH_NO_EXPORT bool
sqsh__metablock_iterator_next(struct SqshMetablockIterator *iterator, int *err);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__metablock_iterator_skip(
        struct SqshMetablockIterator *iterator, uint64_t *offset);
 
SQSH_NO_EXPORT const uint8_t *
sqsh__metablock_iterator_data(const struct SqshMetablockIterator *iterator);
 
SQSH_NO_EXPORT size_t
sqsh__metablock_iterator_size(const struct SqshMetablockIterator *iterator);
 
SQSH_NO_EXPORT int
sqsh__metablock_iterator_cleanup(struct SqshMetablockIterator *iterator);
 
/***************************************
 * metablock/metablock_reader.c
 */
 
struct SqshMetablockReader {
    struct SqshReader reader;
    struct SqshMetablockIterator iterator;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__metablock_reader_init(
        struct SqshMetablockReader *reader, struct SqshArchive *sqsh,
        const uint64_t start_address, const uint64_t upper_limit);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__metablock_reader_advance(
        struct SqshMetablockReader *reader, uint64_t offset, size_t size);
 
SQSH_NO_EXPORT const uint8_t *
sqsh__metablock_reader_data(const struct SqshMetablockReader *reader);
 
SQSH_NO_EXPORT size_t
sqsh__metablock_reader_size(const struct SqshMetablockReader *reader);
 
SQSH_NO_EXPORT int
sqsh__metablock_reader_cleanup(struct SqshMetablockReader *reader);
 
#ifdef __cplusplus
}
#endif
#endif /* SQSH_METABLOCK_PRIVATE_H */