sqsh-tools/doxygen/sqsh__directory_8h_source.html

/******************************************************************************

 *                                                                            *

 * 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_DIRECTORY_H

#define SQSH_DIRECTORY_H


#include "sqsh_file.h"


#ifdef __cplusplus

extern "C" {

#endif


/***************************************

 * iterator/directory_iterator.c

 */


struct SqshDirectoryIterator;


SQSH_NO_UNUSED struct SqshDirectoryIterator *

sqsh_directory_iterator_new(const struct SqshFile *file, int *err);


SQSH_NO_UNUSED bool

sqsh_directory_iterator_next(struct SqshDirectoryIterator *iterator, int *err);


SQSH_NO_UNUSED int sqsh_directory_iterator_lookup(

        struct SqshDirectoryIterator *iterator, const char *name,

        const size_t name_len);


__attribute__((deprecated("Since 1.3.0. Use sqsh_directory_iterator_name2() "

                          "instead"))) uint16_t

sqsh_directory_iterator_name_size(const struct SqshDirectoryIterator *iterator);


uint32_t

sqsh_directory_iterator_inode(const struct SqshDirectoryIterator *iterator);


__attribute__((deprecated("Since 1.2.0. Use sqsh_directory_iterator_inode() "

                          "instead"))) uint64_t

sqsh_directory_iterator_inode_number(

        const struct SqshDirectoryIterator *iterator);

uint64_t

sqsh_directory_iterator_inode_ref(const struct SqshDirectoryIterator *iterator);


enum SqshFileType

sqsh_directory_iterator_file_type(const struct SqshDirectoryIterator *iterator);


SQSH_NO_UNUSED struct SqshFile *sqsh_directory_iterator_open_file(

        const struct SqshDirectoryIterator *iterator, int *err);


const char *sqsh_directory_iterator_name2(

        const struct SqshDirectoryIterator *iterator, size_t *len);


__attribute__((deprecated("Since 1.3.0. Use sqsh_directory_iterator_inode() "

                          "instead"))) const char *

sqsh_directory_iterator_name(const struct SqshDirectoryIterator *iterator);


SQSH_NO_UNUSED char *

sqsh_directory_iterator_name_dup(const struct SqshDirectoryIterator *iterator);


int sqsh_directory_iterator_free(struct SqshDirectoryIterator *iterator);


#ifdef __cplusplus

}

#endif

#endif /* SQSH_DIRECTORY_H */

SQSH_NO_UNUSED
#define SQSH_NO_UNUSED
Warn if return value is unused.
Definition sqsh_common.h:59

sqsh_file.h

SqshFileType
SqshFileType
enum that represents the file type.
Definition sqsh_file.h:315

SqshDirectoryIterator
A directory iterator.
Definition sqsh_directory_private.h:53

SqshDirectoryIterator::sqsh_directory_iterator_inode
uint32_t sqsh_directory_iterator_inode(const struct SqshDirectoryIterator *iterator)
Retrieves the inode number of the current entry.

SqshDirectoryIterator::sqsh_directory_iterator_new
SQSH_NO_UNUSED struct SqshDirectoryIterator * sqsh_directory_iterator_new(const struct SqshFile *file, int *err)
Allocates and initializes a new directory iterator.

SqshDirectoryIterator::sqsh_directory_iterator_inode_ref
uint64_t sqsh_directory_iterator_inode_ref(const struct SqshDirectoryIterator *iterator)
Retrieves the inode reference of the current entry.

SqshDirectoryIterator::sqsh_directory_iterator_lookup
SQSH_NO_UNUSED int sqsh_directory_iterator_lookup(struct SqshDirectoryIterator *iterator, const char *name, const size_t name_len)
Looks up an entry by name.

SqshDirectoryIterator::sqsh_directory_iterator_free
int sqsh_directory_iterator_free(struct SqshDirectoryIterator *iterator)
Frees the resources used by a directory iterator.

SqshDirectoryIterator::sqsh_directory_iterator_name_size
uint16_t sqsh_directory_iterator_name_size(const struct SqshDirectoryIterator *iterator)
Retrieves the size of the name of the current entry.

SqshDirectoryIterator::sqsh_directory_iterator_file_type
enum SqshFileType sqsh_directory_iterator_file_type(const struct SqshDirectoryIterator *iterator)
Retrieves the inode type of the current entry.

SqshDirectoryIterator::sqsh_directory_iterator_name_dup
SQSH_NO_UNUSED char * sqsh_directory_iterator_name_dup(const struct SqshDirectoryIterator *iterator)
creates a heap allocated copy of the name of the current entry.

SqshDirectoryIterator::sqsh_directory_iterator_open_file
SQSH_NO_UNUSED struct SqshFile * sqsh_directory_iterator_open_file(const struct SqshDirectoryIterator *iterator, int *err)
Loads the inode of the current entry.

SqshDirectoryIterator::sqsh_directory_iterator_inode_number
uint64_t sqsh_directory_iterator_inode_number(const struct SqshDirectoryIterator *iterator)
Retrieves the inode number of the current entry.

SqshDirectoryIterator::sqsh_directory_iterator_name
const char * sqsh_directory_iterator_name(const struct SqshDirectoryIterator *iterator)
Retrieves the name of the current entry.

SqshDirectoryIterator::sqsh_directory_iterator_next
SQSH_NO_UNUSED bool sqsh_directory_iterator_next(struct SqshDirectoryIterator *iterator, int *err)
Advances the iterator to the next entry.

SqshDirectoryIterator::sqsh_directory_iterator_name2
const char * sqsh_directory_iterator_name2(const struct SqshDirectoryIterator *iterator, size_t *len)
Retrieves the name of the current entry.

SqshFile
The Inode context.
Definition sqsh_file_private.h:245