dir_reader.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-3.0-or-later */
/*
 * dir_reader.h - This file is part of libsquashfs
 *
 * Copyright (C) 2019 David Oberhollenzer <goliath@infraroot.at>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
#ifndef SQFS_DIR_READER_H
#define SQFS_DIR_READER_H
 
#include "sqfs/predef.h"
 
typedef enum {
    SQFS_TREE_NO_DEVICES = 0x01,
 
    SQFS_TREE_NO_SOCKETS = 0x02,
 
    SQFS_TREE_NO_FIFO = 0x04,
 
    SQFS_TREE_NO_SLINKS = 0x08,
 
    SQFS_TREE_NO_EMPTY = 0x10,
 
    SQFS_TREE_NO_RECURSE = 0x20,
 
    SQFS_TREE_STORE_PARENTS = 0x40,
 
    SQFS_TREE_ALL_FLAGS = 0x7F,
} SQFS_TREE_FILTER_FLAGS;
 
struct sqfs_tree_node_t {
    sqfs_tree_node_t *parent;
 
    sqfs_tree_node_t *children;
 
    sqfs_tree_node_t *next;
 
    sqfs_inode_generic_t *inode;
 
    sqfs_u32 uid;
 
    sqfs_u32 gid;
 
    sqfs_u8 name[];
};
 
typedef enum {
    SQFS_DIR_READER_DOT_ENTRIES = 0x00000001,
 
    SQFS_DIR_READER_ALL_FLAGS = 0x00000001,
} SQFS_DIR_READER_FLAGS;
 
typedef enum {
    SQFS_DIR_OPEN_NO_DOT_ENTRIES = 0x00000001,
 
    SQFS_DIR_OPEN_ALL_FLAGS = 0x00000001,
} SQFS_DIR_OPEN_FLAGS;
 
#ifdef __cplusplus
extern "C" {
#endif
 
SQFS_API sqfs_dir_reader_t *sqfs_dir_reader_create(const sqfs_super_t *super,
                           sqfs_compressor_t *cmp,
                           sqfs_file_t *file,
                           sqfs_u32 flags);
 
SQFS_API int sqfs_dir_reader_open_dir(sqfs_dir_reader_t *rd,
                      const sqfs_inode_generic_t *inode,
                      sqfs_u32 flags);
 
SQFS_API int sqfs_dir_reader_rewind(sqfs_dir_reader_t *rd);
 
SQFS_API int sqfs_dir_reader_find(sqfs_dir_reader_t *rd, const char *name);
 
SQFS_API int sqfs_dir_reader_read(sqfs_dir_reader_t *rd,
                  sqfs_dir_entry_t **out);
 
SQFS_API int sqfs_dir_reader_get_inode(sqfs_dir_reader_t *rd,
                       sqfs_inode_generic_t **inode);
 
SQFS_API int sqfs_dir_reader_get_root_inode(sqfs_dir_reader_t *rd,
                        sqfs_inode_generic_t **inode);
 
SQFS_API int sqfs_dir_reader_find_by_path(sqfs_dir_reader_t *rd,
                      const sqfs_inode_generic_t *start,
                      const char *path,
                      sqfs_inode_generic_t **out);
 
SQFS_API int sqfs_dir_reader_get_full_hierarchy(sqfs_dir_reader_t *rd,
                        const sqfs_id_table_t *idtbl,
                        const char *path,
                        sqfs_u32 flags,
                        sqfs_tree_node_t **out);
 
SQFS_API void sqfs_dir_tree_destroy(sqfs_tree_node_t *root);
 
SQFS_API int sqfs_tree_node_get_path(const sqfs_tree_node_t *node,
                     char **out);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SQFS_DIR_READER_H */