Cthulhu  0.2.10
Cthulhu compiler collection
events.h
Go to the documentation of this file.
1 // SPDX-License-Identifier: LGPL-3.0-only
2 
3 #pragma once
4 
5 #include <ctu_events_api.h>
6 
7 #include "core/compiler.h"
8 
9 #include "notify/notify.h"
10 #include "os/core.h"
11 
12 CT_BEGIN_API
13 
18 
19 #define CTU_EVENT(name, ...) CT_EVENTS_API extern const diagnostic_t kEvent_##name;
20 #include "events.inc"
21 
25 CT_NODISCARD CT_CONSTFN
26 CT_EVENTS_API diagnostic_list_t get_common_diagnostics(void);
27 
33 CT_EVENTS_API void evt_scan_error(
34  IN_NOTNULL logger_t *logger,
35  IN_NOTNULL const node_t *node,
36  IN_STRING const char *msg);
37 
43 CT_EVENTS_API void evt_scan_unknown(
44  IN_NOTNULL logger_t *logger,
45  IN_NOTNULL const node_t *node,
46  IN_STRING const char *msg);
47 
56 CT_EVENTS_API event_builder_t evt_symbol_shadowed(
57  IN_NOTNULL logger_t *logger,
58  IN_STRING const char *name,
59  IN_NOTNULL const node_t *prev,
60  IN_NOTNULL const node_t *next);
61 
70 CT_EVENTS_API event_builder_t evt_os_error(
71  IN_NOTNULL logger_t *logger,
72  const diagnostic_t *diagnostic,
73  os_error_t error,
74  IN_STRING const char *msg);
75 
77 
78 CT_END_API
CT_NODISCARD
#define CT_NODISCARD
mark a function as returning a value that must be used
IN_NOTNULL
#define IN_NOTNULL
annotate a parameter as not being null
CT_CONSTFN
#define CT_CONSTFN
mark a function as const, has no side effects and always returns the same value for the same argument...
Definition: analyze.h:227
IN_STRING
#define IN_STRING
annotate a parameter as being a null terminated string
CT_BEGIN_API
#define CT_BEGIN_API
Definition: compiler.h:129
CT_END_API
#define CT_END_API
Definition: compiler.h:130
evt_scan_unknown
CT_EVENTS_API void evt_scan_unknown(logger_t *logger, const node_t *node, const char *msg)
signal that a scanner has encountered an unknown token
Definition: events.c:39
get_common_diagnostics
CT_NODISCARD CT_CONSTFN CT_EVENTS_API diagnostic_list_t get_common_diagnostics(void)
get all common diagnostics
Definition: events.c:22
evt_os_error
CT_EVENTS_API event_builder_t evt_os_error(logger_t *logger, const diagnostic_t *diagnostic, os_error_t error, const char *msg)
signal that an os error has occurred
Definition: events.c:59
evt_symbol_shadowed
CT_EVENTS_API event_builder_t evt_symbol_shadowed(logger_t *logger, const char *name, const node_t *prev, const node_t *next)
signal that a declaration would shadow a previous declaration
Definition: events.c:47
evt_scan_error
CT_EVENTS_API void evt_scan_error(logger_t *logger, const node_t *node, const char *msg)
signal that a scan error has occurred
Definition: events.c:33
diagnostic_list_t
a list of diagnostics
Definition: diagnostic.h:48
diagnostic_t
a diagnostic
Definition: diagnostic.h:27
event_builder_t
an event builder handles adding additional information to an event
Definition: notify.h:68
logger_t
a logging sink
Definition: notify.c:14
node_t
a position in a source file
Definition: node.h:23