filesystem.h

/*
 * filesystem.h
 *
 * Version: 2.2.5
 *
 * -----------------------------------------------------------------------------
 *
 * SPDX-License-Identifier: MIT
 *
 * Copyright (c) 2018-2024 Ryan M. Lederman <lederman@gmail.com>
 * Copyright (c) 2018-2024 Jeffrey H. Johnson <trnsz@pobox.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * -----------------------------------------------------------------------------
 */
 
#ifndef _SIR_FILESYSTEM_H_INCLUDED
# define _SIR_FILESYSTEM_H_INCLUDED
 
# include "sir/platform.h"
 
# if defined(__cplusplus)
extern "C" {
# endif
 
# define SIR_PATH_BUFFER_GROW_BY 32
 
# define SIR_STAT_NONEXISTENT ((off_t)0xffffff02)
 
typedef enum {
    SIR_PATH_REL_TO_CWD = 0x0001,
    SIR_PATH_REL_TO_APP = 0x0002
} sir_rel_to;
 
bool _sir_pathgetstat(const char* restrict path, struct stat* restrict st, sir_rel_to rel_to);
bool _sir_pathexists(const char* restrict path, bool* restrict exists, sir_rel_to rel_to);
bool _sir_openfile(FILE* restrict* restrict f, const char* restrict path,
    const char* restrict mode, sir_rel_to rel_to);
 
char* _sir_getcwd(void);
 
char* _sir_getappfilename(void);
char* _sir_getappbasename(void);
char* _sir_getappdir(void);
 
char* _sir_getbasename(char* restrict path);
char* _sir_getdirname(char* restrict path);
 
bool _sir_ispathrelative(const char* restrict path, bool* restrict relative);
bool _sir_getrelbasepath(const char* restrict path, bool* restrict relative,
    const char* restrict* restrict base_path, sir_rel_to rel_to);
 
bool _sir_deletefile(const char* restrict path);
 
# if !defined(__WIN__)
/* suppress unconditional warning from Flawfinder about the use of
 * the readlink function, which is prone to pathname race conditions. */
static inline
ssize_t _sir_readlink(const char* restrict path, char* restrict buf, size_t bufsize)
{
    return readlink(path, buf, bufsize); /* flawfinder: ignore */
}
# endif
 
# if defined(_AIX)
int _sir_aixself(char* buffer, size_t* size);
# endif
 
# if defined(__OpenBSD__)
int _sir_openbsdself(char* buffer, int size);
# endif
 
# if defined(__OpenBSD__) || (defined(_AIX) && defined(__PASE__))
int _sir_resolvepath(const char* restrict path, char* restrict buffer, size_t size);
# endif
 
# if defined(__cplusplus)
}
# endif
 
#endif /* !_SIR_FILESYSTEM_H_INCLUDED */