sqsh_tree.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_TREE_H
#define SQSH_TREE_H
 
#include "sqsh_common.h"
 
#include "sqsh_file.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SqshArchive;
 
/***************************************
 * tree/path_resolver.c
 */
 
struct SqshPathResolver;
 
struct SqshPathResolver *
sqsh_path_resolver_new(struct SqshArchive *archive, int *err);
 
SQSH_NO_UNUSED int sqsh_path_resolver_up(struct SqshPathResolver *walker);
 
SQSH_NO_UNUSED bool
sqsh_path_resolver_next(struct SqshPathResolver *walker, int *err);
 
enum SqshFileType
sqsh_path_resolver_type(const struct SqshPathResolver *walker);
 
const char *sqsh_path_resolver_name(const struct SqshPathResolver *walker);
 
uint16_t sqsh_path_resolver_name_size(const struct SqshPathResolver *walker);
 
SQSH_NO_UNUSED char *
sqsh_path_resolver_name_dup(const struct SqshPathResolver *walker);
 
SQSH_NO_UNUSED int sqsh_path_resolver_revert(struct SqshPathResolver *walker);
 
SQSH_NO_UNUSED int sqsh_path_resolver_lookup(
        struct SqshPathResolver *walker, const char *name,
        const size_t name_size);
 
SQSH_NO_UNUSED int sqsh_path_resolver_down(struct SqshPathResolver *walker);
 
SQSH_NO_UNUSED int sqsh_path_resolver_to_root(struct SqshPathResolver *walker);
 
SQSH_NO_UNUSED struct SqshFile *
sqsh_path_resolver_open_file(const struct SqshPathResolver *walker, int *err);
 
uint32_t sqsh_path_resolver_dir_inode(const struct SqshPathResolver *walker);
 
uint64_t sqsh_path_resolver_inode_ref(const struct SqshPathResolver *walker);
 
SQSH_NO_UNUSED int sqsh_path_resolver_resolve(
        struct SqshPathResolver *walker, const char *path,
        bool follow_symlinks);
 
int sqsh_path_resolver_free(struct SqshPathResolver *reader);
 
/***************************************
 * tree/walker.c
 */
 
struct SqshTreeWalker;
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_new() "
                          "instead."))) struct SqshTreeWalker *
sqsh_tree_walker_new(struct SqshArchive *archive, int *err);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_up() "
                          "instead."))) SQSH_NO_UNUSED int
sqsh_tree_walker_up(struct SqshTreeWalker *walker);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_next() "
                          "instead."))) SQSH_NO_UNUSED int
sqsh_tree_walker_next(struct SqshTreeWalker *walker);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_type() "
                          "instead."))) enum SqshFileType
sqsh_tree_walker_type(const struct SqshTreeWalker *walker);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_name() "
                          "instead."))) const char *
sqsh_tree_walker_name(const struct SqshTreeWalker *walker);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_name_size() "
                          "instead."))) uint16_t
sqsh_tree_walker_name_size(const struct SqshTreeWalker *walker);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_name_dup() "
                          "instead."))) SQSH_NO_UNUSED char *
sqsh_tree_walker_name_dup(const struct SqshTreeWalker *walker);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_revert() "
                          "instead."))) SQSH_NO_UNUSED int
sqsh_tree_walker_revert(struct SqshTreeWalker *walker);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_lookup() "
                          "instead."))) SQSH_NO_UNUSED int
sqsh_tree_walker_lookup(
        struct SqshTreeWalker *walker, const char *name,
        const size_t name_size);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_down() "
                          "instead."))) SQSH_NO_UNUSED int
sqsh_tree_walker_down(struct SqshTreeWalker *walker);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_to_root() "
                          "instead."))) SQSH_NO_UNUSED int
sqsh_tree_walker_to_root(struct SqshTreeWalker *walker);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_open_file() "
                          "instead."))) SQSH_NO_UNUSED struct SqshFile *
sqsh_tree_walker_open_file(const struct SqshTreeWalker *walker, int *err);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_resolve() "
                          "instead."))) SQSH_NO_UNUSED int
sqsh_tree_walker_resolve(
        struct SqshTreeWalker *walker, const char *path, bool follow_symlinks);
 
__attribute__((deprecated("Since 1.2.0. Use sqsh_path_resolver_free() "
                          "instead."))) int
sqsh_tree_walker_free(struct SqshTreeWalker *reader);
 
/***************************************
 * tree/traversal.c
 */
 
enum SqshTreeTraversalState {
    SQSH_TREE_TRAVERSAL_STATE_INIT,
    SQSH_TREE_TRAVERSAL_STATE_FILE,
    SQSH_TREE_TRAVERSAL_STATE_DIRECTORY_BEGIN,
    SQSH_TREE_TRAVERSAL_STATE_DIRECTORY_END,
};
 
struct SqshTreeTraversal;
 
struct SqshTreeTraversal *
sqsh_tree_traversal_new(const struct SqshFile *file, int *err);
 
void sqsh_tree_traversal_set_max_depth(
        struct SqshTreeTraversal *traversal, size_t max_depth);
 
SQSH_NO_UNUSED bool
sqsh_tree_traversal_next(struct SqshTreeTraversal *traversal, int *err);
 
enum SqshFileType
sqsh_tree_traversal_type(const struct SqshTreeTraversal *traversal);
 
enum SqshTreeTraversalState
sqsh_tree_traversal_state(const struct SqshTreeTraversal *traversal);
 
const char *sqsh_tree_traversal_name(
        const struct SqshTreeTraversal *traversal, size_t *len);
 
char *sqsh_tree_traversal_path_dup(const struct SqshTreeTraversal *traversal);
 
SQSH_NO_UNUSED char *
sqsh_tree_traversal_name_dup(const struct SqshTreeTraversal *traversal);
 
size_t sqsh_tree_traversal_depth(const struct SqshTreeTraversal *traversal);
 
const char *sqsh_tree_traversal_path_segment(
        const struct SqshTreeTraversal *traversal, size_t *len,
        sqsh_index_t index);
 
const struct SqshDirectoryIterator *
sqsh_tree_traversal_iterator(const struct SqshTreeTraversal *traversal);
 
SQSH_NO_UNUSED struct SqshFile *sqsh_tree_traversal_open_file(
        const struct SqshTreeTraversal *traversal, int *err);
 
int sqsh_tree_traversal_free(struct SqshTreeTraversal *traversal);
 
#ifdef __cplusplus
}
#endif
#endif // SQSH_TREE_H