scan.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include <ctu_scan_api.h>
 
#include "core/analyze.h"
#include "core/compiler.h"
#include "core/text.h"
 
#include <stddef.h>
#include <stdbool.h>
 
typedef struct io_t io_t;
typedef struct arena_t arena_t;
 
CT_BEGIN_API
 
 
typedef struct scan_t
{
    io_t *io;
 
    arena_t *arena;
 
    arena_t *nodes;
 
    STA_FIELD_STRING const char *language;
 
    STA_FIELD_STRING const char *path;
 
    void *tree;
 
    void *context;
 
    text_view_t mapped;
} scan_t;
 
#define CT_SCAN_BUILTIN_NAME "<builtin>"
 
CT_NODISCARD CT_PUREFN
CT_SCAN_API const char *scan_language(IN_NOTNULL const scan_t *scan);
 
CT_NODISCARD CT_PUREFN
CT_SCAN_API const char *scan_path(IN_NOTNULL const scan_t *scan);
 
CT_NODISCARD CT_PUREFN
CT_SCAN_API void *scan_get(IN_NOTNULL scan_t *scan);
 
CT_SCAN_API void scan_set(IN_NOTNULL scan_t *scan, void *value);
 
CT_SCAN_API void scan_set_context(IN_NOTNULL scan_t *scan, void *value);
 
CT_NODISCARD CT_PUREFN
CT_SCAN_API void *scan_get_context(IN_NOTNULL const scan_t *scan);
 
CT_NODISCARD CT_PUREFN
CT_SCAN_API text_view_t scan_source(IN_NOTNULL const scan_t *scan);
 
CT_NODISCARD CT_PUREFN
CT_SCAN_API arena_t *scan_get_arena(IN_NOTNULL const scan_t *scan);
 
CT_NODISCARD STA_RET_RANGE(0, size) CT_NOALIAS
CT_SCAN_API size_t scan_read(
    IN_NOTNULL scan_t *scan,
    STA_WRITES(size) void *dst,
    size_t size);
 
CT_NODISCARD
CT_SCAN_API scan_t *scan_io(
    IN_STRING const char *language,
    IN_NOTNULL io_t *io,
    IN_NOTNULL arena_t *arena);
 
CT_NODISCARD
CT_SCAN_API scan_t *scan_builtin(IN_STRING const char *language, IN_NOTNULL arena_t *arena);
 
CT_NODISCARD CT_PUREFN
CT_SCAN_API bool scan_is_builtin(IN_NOTNULL const scan_t *scan);
 
 
CT_END_API