sqsh_xattr.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_XATTR_H
#define SQSH_XATTR_H
 
#include "sqsh_common.h"
#include "sqsh_data.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SqshFile;
 
/***************************************
 * xattr/xattr_iterator.c
 */
 
struct SqshXattrIterator;
 
SQSH_NO_UNUSED struct SqshXattrIterator *
sqsh_xattr_iterator_new(const struct SqshFile *file, int *err);
 
SQSH_NO_UNUSED bool
sqsh_xattr_iterator_next(struct SqshXattrIterator *iterator, int *err);
 
uint16_t sqsh_xattr_iterator_type(const struct SqshXattrIterator *iterator);
 
bool sqsh_xattr_iterator_is_indirect(const struct SqshXattrIterator *iterator);
 
const char *
sqsh_xattr_iterator_prefix(const struct SqshXattrIterator *iterator);
 
uint16_t
sqsh_xattr_iterator_prefix_size(const struct SqshXattrIterator *iterator);
 
const char *sqsh_xattr_iterator_name(const struct SqshXattrIterator *iterator);
 
uint16_t
sqsh_xattr_iterator_name_size(const struct SqshXattrIterator *iterator);
 
SQSH_NO_UNUSED int sqsh_xattr_iterator_lookup(
        struct SqshXattrIterator *iterator, const char *name);
 
SQSH_NO_UNUSED int sqsh_xattr_iterator_fullname_cmp(
        const struct SqshXattrIterator *iterator, const char *name);
 
SQSH_NO_UNUSED char *
sqsh_xattr_iterator_fullname_dup(const struct SqshXattrIterator *iterator);
 
SQSH_NO_UNUSED char *
sqsh_xattr_iterator_value_dup(const struct SqshXattrIterator *iterator);
 
const char *sqsh_xattr_iterator_value(const struct SqshXattrIterator *iterator);
 
uint32_t
sqsh_xattr_iterator_value_size2(const struct SqshXattrIterator *iterator);
 
__attribute__((deprecated(
        "Since 1.3.0. Use sqsh_xattr_iterator_value_size2() instead.")))
uint16_t
sqsh_xattr_iterator_value_size(const struct SqshXattrIterator *iterator);
 
int sqsh_xattr_iterator_free(struct SqshXattrIterator *iterator);
 
#ifdef __cplusplus
}
#endif
#endif /* SQSH_XATTR_H */