1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
.. Copyright (C) 2024-2025 Free Software Foundation, Inc.
Originally contributed by David Malcolm <dmalcolm@redhat.com>
This is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see
<https://www.gnu.org/licenses/>.
.. default-domain:: c
Text output
===========
.. type:: diagnostic_text_sink
.. function:: diagnostic_text_sink * diagnostic_manager_add_text_sink (diagnostic_manager *diag_mgr,\
FILE *dst_stream, \
enum diagnostic_colorize colorize)
Add a new output sink to ``diag_mgr``, which writes GCC-style diagnostics
to ``dst_stream``.
Return a borrowed pointer to the sink, which is cleaned up when ``diag_mgr``
is released.
``diag_mgr`` must be non-NULL.
``dst_stream`` must be non-NULL. It is borrowed and must outlive ``DIAG_MGR``.
The output for each diagnostic is written and flushed as each
:type:`diagnostic` is finished.
.. enum:: diagnostic_colorize
An enum for determining if we should colorize a text output sink.
.. macro:: DIAGNOSTIC_COLORIZE_IF_TTY
Diagnostics should be colorized if the destination stream is
directly connected to a tty.
.. macro:: DIAGNOSTIC_COLORIZE_NO
Diagnostics should not be colorized.
.. macro:: DIAGNOSTIC_COLORIZE_YES
Diagnostics should be colorized.
.. function:: void diagnostic_text_sink_set_source_printing_enabled (diagnostic_text_sink *text_sink, \
int value)
Enable or disable printing of source text in the text sink.
``text_sink`` must be non-NULL.
Default: enabled.
.. function:: void diagnostic_text_sink_set_colorize (diagnostic_text_sink *text_sink, \
enum diagnostic_colorize colorize)
Update colorization of text sink.
``text_sink`` must be non-NULL.
.. function:: void diagnostic_text_sink_set_labelled_source_colorization_enabled (diagnostic_text_sink *text_sink, \
int value)
``text_sink`` must be non-NULL.
Enable or disable colorization of the characters of source text
that are underlined.
This should be true for clients that generate range information
(so that the ranges of code are colorized), and false for clients that
merely specify points within the source code (to avoid e.g. colorizing
just the first character in a token, which would look strange).
Default: enabled.
|
