sqsh_file.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_FILE_H
#define SQSH_FILE_H
 
#include "sqsh_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SqshFile;
struct SqshArchive;
 
/***************************************
 * context/file_reader.c
 */
 
struct SqshFileReader;
 
struct SqshFileReader *
sqsh_file_reader_new(const struct SqshFile *file, int *err);
 
__attribute__((deprecated(
        "Since 1.5.0. Use sqsh_file_reader_advance2() instead."))) int
sqsh_file_reader_advance(
        struct SqshFileReader *reader, sqsh_index_t offset, size_t size);
 
int sqsh_file_reader_advance2(
        struct SqshFileReader *reader, uint64_t offset, size_t size);
 
const uint8_t *sqsh_file_reader_data(const struct SqshFileReader *reader);
 
size_t sqsh_file_reader_size(const struct SqshFileReader *reader);
 
int sqsh_file_reader_free(struct SqshFileReader *reader);
 
/***************************************
 * file/file_iterator.c
 */
 
struct SqshFileIterator;
 
SQSH_NO_UNUSED struct SqshFileIterator *
sqsh_file_iterator_new(const struct SqshFile *file, int *err);
 
SQSH_NO_UNUSED bool sqsh_file_iterator_next(
        struct SqshFileIterator *iterator, size_t desired_size, int *err);
 
SQSH_NO_UNUSED bool
sqsh_file_iterator_is_zero_block(const struct SqshFileIterator *iterator);
 
__attribute__((
        deprecated("Since 1.5.0. Use sqsh_file_iterator_skip2() instead.")))
SQSH_NO_UNUSED int
sqsh_file_iterator_skip(
        struct SqshFileIterator *iterator, sqsh_index_t *offset,
        size_t desired_size);
 
SQSH_NO_UNUSED int sqsh_file_iterator_skip2(
        struct SqshFileIterator *iterator, uint64_t *offset,
        size_t desired_size);
 
SQSH_NO_UNUSED const uint8_t *
sqsh_file_iterator_data(const struct SqshFileIterator *iterator);
 
SQSH_NO_UNUSED size_t
sqsh_file_iterator_block_size(const struct SqshFileIterator *iterator);
 
SQSH_NO_UNUSED size_t
sqsh_file_iterator_size(const struct SqshFileIterator *iterator);
 
int sqsh_file_iterator_free(struct SqshFileIterator *iterator);
 
/***************************************
 * file/file.c
 */
 
#define SQSH_INODE_NO_FRAGMENT 0xFFFFFFFF
#define SQSH_INODE_NO_XATTR 0xFFFFFFFF
 
__attribute__((deprecated(
        "Since 1.5.0. libsqsh should never return this."))) static const int
        SQSH_FILE_TYPE_UNKNOWN = -1;
enum SqshFileType {
    /* avoid overlapping with the types in inode_data.h */
    SQSH_FILE_TYPE_DIRECTORY = 1 + (1 << 8),
    SQSH_FILE_TYPE_FILE,
    SQSH_FILE_TYPE_SYMLINK,
    SQSH_FILE_TYPE_BLOCK,
    SQSH_FILE_TYPE_CHAR,
    SQSH_FILE_TYPE_FIFO,
    SQSH_FILE_TYPE_SOCKET
};
 
SQSH_NO_UNUSED struct SqshFile *
sqsh_open(struct SqshArchive *archive, const char *path, int *err);
 
SQSH_NO_UNUSED struct SqshFile *
sqsh_lopen(struct SqshArchive *archive, const char *path, int *err);
 
SQSH_NO_UNUSED struct SqshFile *
sqsh_open_by_ref(struct SqshArchive *archive, uint64_t inode_ref, int *err);
 
bool sqsh_file_is_extended(const struct SqshFile *context);
 
uint32_t sqsh_file_hard_link_count(const struct SqshFile *context);
 
uint64_t sqsh_file_size(const struct SqshFile *context);
 
uint16_t sqsh_file_permission(const struct SqshFile *context);
 
uint32_t sqsh_file_inode(const struct SqshFile *context);
 
uint32_t sqsh_file_modified_time(const struct SqshFile *context);
 
uint64_t sqsh_file_blocks_start(const struct SqshFile *context);
 
__attribute__((deprecated("Since 1.5.0. Use sqsh_file_blockcount2() instead.")))
uint32_t
sqsh_file_block_count(const struct SqshFile *context);
 
uint64_t sqsh_file_block_count2(const struct SqshFile *context);
 
uint32_t sqsh_file_block_size(const struct SqshFile *context, uint32_t index);
 
bool
sqsh_file_block_is_compressed(const struct SqshFile *context, uint32_t index);
 
uint32_t sqsh_file_fragment_block_index(const struct SqshFile *context);
 
uint32_t sqsh_file_fragment_block_offset(const struct SqshFile *context);
 
uint32_t sqsh_file_directory_block_start(const struct SqshFile *context);
 
__attribute__((
        deprecated("Since 1.3.0. Use sqsh_file_directory_block_offset2() "
                   "instead."))) uint32_t
sqsh_file_directory_block_offset(const struct SqshFile *context);
 
uint16_t sqsh_file_directory_block_offset2(const struct SqshFile *context);
 
uint32_t sqsh_file_directory_parent_inode(const struct SqshFile *context);
 
bool sqsh_file_has_fragment(const struct SqshFile *context);
 
enum SqshFileType sqsh_file_type(const struct SqshFile *context);
 
int sqsh_file_symlink_resolve(struct SqshFile *context);
 
int sqsh_file_symlink_resolve_all(struct SqshFile *context);
 
const char *sqsh_file_symlink(const struct SqshFile *context);
 
SQSH_NO_UNUSED char *sqsh_file_symlink_dup(const struct SqshFile *context);
 
uint32_t sqsh_file_symlink_size(const struct SqshFile *context);
 
uint32_t sqsh_file_device_id(const struct SqshFile *context);
 
uint32_t sqsh_file_uid(const struct SqshFile *context);
 
uint32_t sqsh_file_gid(const struct SqshFile *context);
 
uint64_t sqsh_file_inode_ref(const struct SqshFile *context);
 
uint32_t sqsh_file_xattr_index(const struct SqshFile *context);
 
int sqsh_close(struct SqshFile *file);
 
#ifdef __cplusplus
}
#endif
#endif /* SQSH_FILE_H */