core.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include <ctu_os_api.h>
 
#include "core/analyze.h"
 
#if STA_PRESENT
#   include "os/impl/impl.h"
#endif
 
#include <stddef.h>
 
typedef struct path_t path_t;
typedef struct arena_t arena_t;
typedef struct text_t text_t;
 
CT_BEGIN_API
 
 
typedef struct os_file_t os_file_t;
 
typedef struct os_mapping_t os_mapping_t;
 
typedef struct os_inode_t os_inode_t;
 
typedef struct os_iter_t os_iter_t;
 
typedef enum os_access_t
{
#define OS_ACCESS(ID, STR, BIT) ID = (BIT),
#include "os.inc"
 
    eOsAccessMask = eOsAccessRead | eOsAccessWrite | eOsAccessTruncate,
} os_access_t;
 
typedef enum os_protect_t
{
#define OS_PROTECT(ID, STR, BIT) ID = (BIT),
#include "os.inc"
 
    eOsProtectMask = eOsProtectRead | eOsProtectWrite | eOsProtectExecute,
} os_protect_t;
 
typedef enum os_dirent_t
{
#define OS_DIRENT(ID, STR) ID,
#include "os.inc"
 
    eOsNodeCount
} os_dirent_t;
 
typedef STA_SUCCESS_TYPE(return == eOsSuccess) size_t os_error_t;
 
typedef int os_exitcode_t;
 
typedef unsigned os_status_t;
 
typedef size_t os_thread_id_t;
 
typedef void (*os_symbol_t)(void);
 
CT_OS_API void os_init(void);
 
CT_NORETURN CT_OS_API os_exit(os_exitcode_t code);
 
CT_NORETURN CT_OS_API os_thread_exit(os_status_t status);
 
CT_OS_API os_thread_id_t os_get_thread_id(void);
 
CT_NORETURN CT_OS_API os_abort(void);
 
CT_NODISCARD
CT_OS_API size_t os_error_get_string(os_error_t error, STA_WRITES(size) char *buffer, size_t size);
 
CT_NODISCARD
CT_OS_API size_t os_cwd_get_string(STA_WRITES(size) char *buffer, size_t size);
 
CT_NODISCARD STA_RET_STRING
CT_OS_API char *os_error_string(os_error_t error, IN_NOTNULL arena_t *arena);
 
RET_INSPECT
CT_OS_API char *os_cwd_string(IN_NOTNULL arena_t *arena);
 
RET_INSPECT
CT_OS_API os_error_t os_getcwd(OUT_NOTNULL text_t *text, IN_NOTNULL arena_t *arena);
 
CT_NODISCARD CT_PUREFN
CT_OS_API os_dirent_t os_inode_type(IN_NOTNULL const os_inode_t *node);
 
CT_NODISCARD STA_RET_STRING CT_PUREFN
CT_OS_API const char *os_inode_name(IN_NOTNULL const os_inode_t *node);
 
CT_NODISCARD CT_CONSTFN STA_RET_STRING
CT_OS_API const char *os_dirent_string(os_dirent_t type);
 
CT_NODISCARD CT_CONSTFN STA_RET_STRING
CT_OS_API const char *os_access_string(os_access_t access);
 
CT_NODISCARD CT_CONSTFN STA_RET_STRING
CT_OS_API const char *os_protect_string(os_protect_t protect);
 
 
CT_END_API
 
CT_ENUM_FLAGS(os_access_t, int)
CT_ENUM_FLAGS(os_protect_t, int)