sqsh_directory_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_ITERATOR_PRIVATE_H
#define SQSH_ITERATOR_PRIVATE_H
 
#include "sqsh_directory.h"
 
#include "sqsh_file_private.h"
#include "sqsh_metablock_private.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***************************************
 * directory/directory_iterator.c
 */
 
struct SqshDirectoryIterator {
    const struct SqshFile *file;
    uint32_t remaining_size;
 
    struct SqshMetablockReader metablock;
    size_t remaining_entries;
    sqsh_index_t next_offset;
    uint32_t current_inode;
 
    uint32_t start_base;
    uint32_t inode_base;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__directory_iterator_init(
        struct SqshDirectoryIterator *iterator, const struct SqshFile *inode);
 
SQSH_NO_EXPORT int
sqsh__directory_iterator_cleanup(struct SqshDirectoryIterator *iterator);
 
/***************************************
 * inode/directory_index_iterator.c
 */
 
struct SqshDirectoryIndexIterator {
    struct SqshFile file;
    size_t remaining_entries;
    sqsh_index_t next_offset;
};
 
SQSH_NO_EXPORT SQSH_NO_UNUSED int sqsh__directory_index_iterator_init(
        struct SqshDirectoryIndexIterator *iterator, struct SqshArchive *sqsh,
        uint64_t inode_ref);
 
SQSH_NO_EXPORT SQSH_NO_UNUSED bool sqsh__directory_index_iterator_next(
        struct SqshDirectoryIndexIterator *iterator, int *err);
 
SQSH_NO_EXPORT uint32_t sqsh__directory_index_iterator_index(
        const struct SqshDirectoryIndexIterator *iterator);
 
SQSH_NO_EXPORT uint32_t sqsh__directory_index_iterator_start(
        const struct SqshDirectoryIndexIterator *iterator);
 
SQSH_NO_EXPORT uint32_t sqsh__directory_index_iterator_name_size(
        const struct SqshDirectoryIndexIterator *iterator);
 
SQSH_NO_EXPORT const char *sqsh__directory_index_iterator_name(
        const struct SqshDirectoryIndexIterator *iterator);
 
SQSH_NO_EXPORT int sqsh__directory_index_iterator_cleanup(
        struct SqshDirectoryIndexIterator *iterator);
 
#ifdef __cplusplus
}
#endif
#endif /* SQSH_ITERATOR_PRIVATE_H */