notify.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include <ctu_notify_api.h>
 
#include "core/analyze.h"
#include "core/compiler.h"
 
#include "scan/node.h"
 
#include "notify/diagnostic.h"
 
#include <stdarg.h>
#include <stdbool.h>
 
CT_BEGIN_API
 
typedef struct node_t node_t;
typedef struct typevec_t typevec_t;
typedef struct vector_t vector_t;
typedef struct arena_t arena_t;
typedef struct set_t set_t;
 
 
typedef struct logger_t logger_t;
 
typedef struct event_t
{
    const diagnostic_t *diagnostic;
 
    node_t node;
 
    STA_FIELD_STRING char *message;
 
    typevec_t *segments;
 
    vector_t *notes;
} event_t;
 
typedef struct segment_t
{
    node_t node;
 
    STA_FIELD_STRING char *message;
} segment_t;
 
typedef struct event_builder_t
{
    event_t *event;
 
    arena_t *arena;
} event_builder_t;
 
typedef struct notify_rules_t
{
    set_t *warnings_as_errors;
 
    set_t *ignored_warnings;
} notify_rules_t;
 
RET_NOTNULL CT_NODISCARD
CT_NOTIFY_API logger_t *logger_new(IN_NOTNULL arena_t *arena);
 
RET_NOTNULL CT_NODISCARD
CT_NOTIFY_API typevec_t *logger_get_events(IN_NOTNULL const logger_t *logs);
 
CT_NODISCARD
CT_NOTIFY_API bool logger_has_errors(IN_NOTNULL const logger_t *logs, notify_rules_t rules);
 
CT_NOTIFY_API void logger_reset(IN_NOTNULL logger_t *logs);
 
RET_NOTNULL CT_NODISCARD
CT_NOTIFY_API arena_t *logger_get_arena(IN_NOTNULL const logger_t *logs);
 
STA_PRINTF(4, 5)
CT_NOTIFY_API event_builder_t msg_notify(
    INOUT_NOTNULL logger_t *logs,
    IN_NOTNULL const diagnostic_t *diagnostic,
    const node_t *node,
    STA_FORMAT_STRING const char *fmt, ...);
 
CT_NOTIFY_API event_builder_t msg_vnotify(
    INOUT_NOTNULL logger_t *logs,
    IN_NOTNULL const diagnostic_t *diagnostic,
    const node_t *node,
    IN_STRING const char *fmt, va_list args);
 
STA_PRINTF(3, 4)
CT_NOTIFY_API void msg_append(
    event_builder_t builder,
    const node_t *node,
    STA_FORMAT_STRING const char *fmt, ...);
 
CT_NOTIFY_API void msg_vappend(
    event_builder_t builder,
    const node_t *node,
    IN_STRING const char *fmt, va_list args);
 
STA_PRINTF(2, 3)
CT_NOTIFY_API void msg_note(
    event_builder_t builder,
    STA_FORMAT_STRING const char *fmt, ...);
 
CT_NOTIFY_API void msg_vnote(
    event_builder_t builder,
    IN_STRING const char *fmt, va_list args);
 
 
CT_END_API