os.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include "os/core.h"
#include "os/impl/impl.h" // IWYU pragma: export
 
#include <stdbool.h>
 
CT_BEGIN_API
 
 
 
 
 
typedef struct os_library_t
{
    // used by os_common
    const char *name;
 
    // used by os_native
    os_library_impl_t impl;
} os_library_t;
 
typedef struct os_file_t
{
    // used by os_common
    const char *path;
 
    // used by os_native
    os_file_impl_t impl;
} os_file_t;
 
typedef struct os_inode_t
{
    // used by os_common
    os_dirent_t type;
    char name[CT_OS_NAME_MAX];
} os_inode_t;
 
typedef struct os_iter_t
{
    // used by os_common
    os_error_t error;
    os_inode_t inode;
 
    // used by os_native
    os_iter_impl_t impl;
    os_inode_impl_t current;
} os_iter_t;
 
typedef os_exitcode_t (*os_thread_fn_t)(void *arg);
 
typedef struct os_thread_t
{
    // used by os_common
    const char *name;
 
    os_thread_fn_t fn;
    void *arg;
 
    // used by os_native
    os_thread_impl_t impl;
    os_thread_id_t id;
} os_thread_t;
 
typedef struct os_mutex_t
{
    // used by os_common
    const char *name;
 
    // used by os_native
    os_mutex_impl_t impl;
} os_mutex_t;
 
 
RET_INSPECT
CT_OS_API os_error_t os_library_open(
        IN_STRING const char *path,
        OUT_NOTNULL os_library_t *library);
 
RET_INSPECT
CT_OS_API os_error_t os_library_close(
        STA_RELEASE os_library_t *library);
 
CT_NODISCARD
CT_OS_API os_error_t os_library_symbol(
        IN_NOTNULL os_library_t *library,
        OUT_NOTNULL void **symbol,
        IN_STRING const char *name);
 
CT_NODISCARD
CT_OS_API const char *os_library_name(IN_NOTNULL const os_library_t *library);
 
 
 
RET_INSPECT
CT_OS_API os_error_t os_file_copy(
        IN_STRING const char *dst,
        IN_STRING const char *src);
 
RET_INSPECT
CT_OS_API os_error_t os_file_exists(IN_STRING const char *path);
 
RET_INSPECT
CT_OS_API os_error_t os_file_create(IN_STRING const char *path);
 
RET_INSPECT
CT_OS_API os_error_t os_file_delete(IN_STRING const char *path);
 
RET_INSPECT
CT_OS_API os_error_t os_dir_create(IN_STRING const char *path);
 
RET_INSPECT
CT_OS_API os_error_t os_dir_delete(IN_STRING const char *path);
 
RET_INSPECT
CT_OS_API bool os_dir_exists(IN_STRING const char *path);
 
CT_NODISCARD
CT_OS_API os_dirent_t os_dirent_type(IN_STRING const char *path);
 
 
RET_INSPECT
CT_OS_API os_error_t os_iter_begin(IN_STRING const char *path, OUT_NOTNULL os_iter_t *iter);
 
CT_OS_API os_error_t os_iter_end(STA_RELEASE os_iter_t *iter);
 
CT_NODISCARD STA_SUCCESS(return == true)
CT_OS_API bool os_iter_next(IN_NOTNULL os_iter_t *iter, OUT_NOTNULL os_inode_t *dir);
 
RET_INSPECT
CT_OS_API os_error_t os_iter_error(IN_NOTNULL const os_iter_t *iter);
 
 
RET_INSPECT
CT_OS_API os_error_t os_file_open(IN_STRING const char *path, os_access_t access, OUT_NOTNULL os_file_t *file);
 
RET_INSPECT
CT_OS_API os_error_t os_tmpfile_open(OUT_NOTNULL os_file_t *file);
 
RET_INSPECT
CT_OS_API os_error_t os_file_close(STA_RELEASE os_file_t *file);
 
RET_INSPECT
CT_OS_API os_error_t os_file_read(
        IN_NOTNULL os_file_t *file,
        STA_WRITES(size) void *buffer,
        IN_DOMAIN(>, 0) size_t size,
        OUT_NOTNULL size_t *actual);
 
RET_INSPECT
CT_OS_API os_error_t os_file_write(
        IN_NOTNULL os_file_t *file,
        STA_READS(size) const void *buffer,
        IN_DOMAIN(>, 0) size_t size,
        OUT_NOTNULL size_t *actual);
 
RET_INSPECT
CT_OS_API os_error_t os_file_size(IN_NOTNULL os_file_t *file, OUT_NOTNULL size_t *actual);
 
RET_INSPECT
CT_OS_API os_error_t os_file_seek(IN_NOTNULL os_file_t *file, size_t offset, OUT_NOTNULL size_t *actual);
 
RET_INSPECT
CT_OS_API os_error_t os_file_tell(IN_NOTNULL os_file_t *file, OUT_NOTNULL size_t *actual);
 
RET_INSPECT
CT_OS_API os_error_t os_file_resize(IN_NOTNULL os_file_t *file, size_t size);
 
RET_INSPECT
CT_OS_API os_error_t os_file_map(
        IN_NOTNULL os_file_t *file,
        os_protect_t protect,
        size_t size,
        OUT_NOTNULL os_mapping_t *mapping);
 
CT_OS_API os_error_t os_unmap(INOUT_NOTNULL os_mapping_t *mapping);
 
CT_NODISCARD
CT_OS_API void *os_mapping_data(IN_NOTNULL os_mapping_t *mapping);
 
CT_NODISCARD
CT_OS_API size_t os_mapping_size(IN_NOTNULL const os_mapping_t *mapping);
 
CT_NODISCARD CT_PUREFN
CT_OS_API bool os_mapping_active(IN_NOTNULL const os_mapping_t *mapping);
 
CT_NODISCARD CT_PUREFN
CT_OS_API const char *os_file_name(IN_NOTNULL const os_file_t *file);
 
 
 
CT_OS_API os_error_t os_thread_init(
    OUT_NOTNULL os_thread_t *thread,
    IN_STRING const char *name,
    IN_NOTNULL os_thread_fn_t fn,
    void *arg);
 
CT_OS_API os_error_t os_thread_join(
    IN_NOTNULL os_thread_t *thread,
    OUT_NOTNULL os_status_t *status);
 
CT_OS_API const char *os_thread_name(
    IN_NOTNULL const os_thread_t *thread);
 
CT_OS_API bool os_thread_cmpid(
    IN_NOTNULL const os_thread_t *thread,
    os_thread_id_t id);
 
 
 
CT_END_API