notify.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include <ctu_format_api.h>
 
#include "core/analyze.h"
#include "core/compiler.h"
 
#include <stdbool.h>
#include <stddef.h>
 
 
 
 
typedef struct io_t io_t;
typedef struct event_t event_t;
typedef struct typevec_t typevec_t;
typedef struct arena_t arena_t;
 
typedef struct colour_pallete_t colour_pallete_t;
typedef struct cache_map_t cache_map_t;
typedef struct set_t set_t;
typedef struct text_cache_t text_cache_t;
 
CT_BEGIN_API
 
typedef struct file_config_t
{
    bool zeroth_line;
 
    size_t max_columns;
 
    bool override_fatal;
} file_config_t;
 
typedef enum text_format_t
{
    eTextSimple,    
    eTextComplex,   
 
    eTextTotal
} text_format_t;
 
typedef struct text_config_t
{
    cache_map_t *cache;
 
    // is the first line of a source file the zeroth line or the first line
    file_config_t config;
 
    // colour configuration
    const colour_pallete_t *colours;
 
    // the io object to write to
    io_t *io;
} text_config_t;
 
typedef struct report_config_t
{
    size_t max_errors;
    size_t max_warnings;
 
    set_t *ignore_warnings;
    set_t *error_warnings;
 
    text_format_t report_format;
    text_config_t text_config;
} report_config_t;
 
CT_FORMAT_API int text_report(
    IN_NOTNULL typevec_t *events,
    report_config_t config,
    IN_STRING const char *title);
 
// complex reporting
CT_FORMAT_API void text_report_rich(
    text_config_t config,
    IN_NOTNULL const event_t *event);
 
// simple reporting like msvc
// path(line): severity id: main message
 
CT_FORMAT_API void text_report_simple(
    text_config_t config,
    IN_NOTNULL const event_t *event);
 
CT_END_API