1/* Various declarations for language-independent pretty-print subroutines.
2 Copyright (C) 2002-2024 Free Software Foundation, Inc.
3 Contributed by Gabriel Dos Reis <gdr@integrable-solutions.net>
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 3, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
20
21#ifndef GCC_PRETTY_PRINT_H
22#define GCC_PRETTY_PRINT_H
23
24#include "obstack.h"
25#include "rich-location.h"
26#include "diagnostic-url.h"
27
28/* Maximum number of format string arguments. */
29#define PP_NL_ARGMAX 30
30
31/* The type of a text to be formatted according a format specification
32 along with a list of things. */
33struct text_info
34{
35 text_info () = default;
36 text_info (const char *format_spec,
37 va_list *args_ptr,
38 int err_no,
39 void **data = nullptr,
40 rich_location *rich_loc = nullptr)
41 : m_format_spec (format_spec),
42 m_args_ptr (args_ptr),
43 m_err_no (err_no),
44 m_data (data),
45 m_richloc (rich_loc)
46 {
47 }
48
49 void set_location (unsigned int idx, location_t loc,
50 enum range_display_kind range_display_kind);
51 location_t get_location (unsigned int index_of_location) const;
52
53 const char *m_format_spec;
54 va_list *m_args_ptr;
55 int m_err_no; /* for %m */
56 void **m_data;
57 rich_location *m_richloc;
58};
59
60/* How often diagnostics are prefixed by their locations:
61 o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
62 o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit only once;
63 o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit each time a physical
64 line is started. */
65enum diagnostic_prefixing_rule_t
66{
67 DIAGNOSTICS_SHOW_PREFIX_ONCE = 0x0,
68 DIAGNOSTICS_SHOW_PREFIX_NEVER = 0x1,
69 DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2
70};
71
72class quoting_info;
73
74/* The chunk_info data structure forms a stack of the results from the
75 first phase of formatting (pp_format) which have not yet been
76 output (pp_output_formatted_text). A stack is necessary because
77 the diagnostic starter may decide to generate its own output by way
78 of the formatter. */
79struct chunk_info
80{
81 /* Pointer to previous chunk on the stack. */
82 struct chunk_info *prev;
83
84 /* Array of chunks to output. Each chunk is a NUL-terminated string.
85 In the first phase of formatting, even-numbered chunks are
86 to be output verbatim, odd-numbered chunks are format specifiers.
87 The second phase replaces all odd-numbered chunks with formatted
88 text, and the third phase simply emits all the chunks in sequence
89 with appropriate line-wrapping. */
90 const char *args[PP_NL_ARGMAX * 2];
91
92 /* If non-null, information on quoted text runs within the chunks
93 for use by a urlifier. */
94 quoting_info *m_quotes;
95};
96
97/* The output buffer datatype. This is best seen as an abstract datatype
98 whose fields should not be accessed directly by clients. */
99class output_buffer
100{
101public:
102 output_buffer ();
103 ~output_buffer ();
104
105 /* Obstack where the text is built up. */
106 struct obstack formatted_obstack;
107
108 /* Obstack containing a chunked representation of the format
109 specification plus arguments. */
110 struct obstack chunk_obstack;
111
112 /* Currently active obstack: one of the above two. This is used so
113 that the text formatters don't need to know which phase we're in. */
114 struct obstack *obstack;
115
116 /* Stack of chunk arrays. These come from the chunk_obstack. */
117 struct chunk_info *cur_chunk_array;
118
119 /* Where to output formatted text. */
120 FILE *stream;
121
122 /* The amount of characters output so far. */
123 int line_length;
124
125 /* This must be large enough to hold any printed integer or
126 floating-point value. */
127 char digit_buffer[128];
128
129 /* Nonzero means that text should be flushed when
130 appropriate. Otherwise, text is buffered until either
131 pp_really_flush or pp_clear_output_area are called. */
132 bool flush_p;
133};
134
135/* Finishes constructing a NULL-terminated character string representing
136 the buffered text. */
137inline const char *
138output_buffer_formatted_text (output_buffer *buff)
139{
140 obstack_1grow (buff->obstack, '\0');
141 return (const char *) obstack_base (buff->obstack);
142}
143
144/* Append to the output buffer a string specified by its
145 STARTing character and LENGTH. */
146inline void
147output_buffer_append_r (output_buffer *buff, const char *start, int length)
148{
149 gcc_checking_assert (start);
150 obstack_grow (buff->obstack, start, length);
151 for (int i = 0; i < length; i++)
152 if (start[i] == '\n')
153 buff->line_length = 0;
154 else
155 buff->line_length++;
156}
157
158/* Return a pointer to the last character emitted in the
159 output_buffer. A NULL pointer means no character available. */
160inline const char *
161output_buffer_last_position_in_text (const output_buffer *buff)
162{
163 const char *p = NULL;
164 struct obstack *text = buff->obstack;
165
166 if (obstack_base (text) != obstack_next_free (text))
167 p = ((const char *) obstack_next_free (text)) - 1;
168 return p;
169}
170
171
172/* The type of pretty-printer flags passed to clients. */
173typedef unsigned int pp_flags;
174
175enum pp_padding
176{
177 pp_none, pp_before, pp_after
178};
179
180/* Structure for switching in and out of verbatim mode in a convenient
181 manner. */
182struct pp_wrapping_mode_t
183{
184 /* Current prefixing rule. */
185 diagnostic_prefixing_rule_t rule;
186
187 /* The ideal upper bound of number of characters per line, as suggested
188 by front-end. */
189 int line_cutoff;
190};
191
192/* Maximum characters per line in automatic line wrapping mode.
193 Zero means don't wrap lines. */
194#define pp_line_cutoff(PP) (PP)->wrapping.line_cutoff
195
196/* Prefixing rule used in formatting a diagnostic message. */
197#define pp_prefixing_rule(PP) (PP)->wrapping.rule
198
199/* Get or set the wrapping mode as a single entity. */
200#define pp_wrapping_mode(PP) (PP)->wrapping
201
202/* The type of a hook that formats client-specific data onto a pretty_printer.
203 A client-supplied formatter returns true if everything goes well,
204 otherwise it returns false. */
205typedef bool (*printer_fn) (pretty_printer *, text_info *, const char *,
206 int, bool, bool, bool, bool *, const char **);
207
208/* Client supplied function used to decode formats. */
209#define pp_format_decoder(PP) (PP)->format_decoder
210
211/* Base class for an optional client-supplied object for doing additional
212 processing between stages 2 and 3 of formatted printing. */
213class format_postprocessor
214{
215 public:
216 virtual ~format_postprocessor () {}
217 virtual format_postprocessor *clone() const = 0;
218 virtual void handle (pretty_printer *) = 0;
219};
220
221/* TRUE if a newline character needs to be added before further
222 formatting. */
223#define pp_needs_newline(PP) (PP)->need_newline
224
225/* True if PRETTY-PRINTER is in line-wrapping mode. */
226#define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0)
227
228/* The amount of whitespace to be emitted when starting a new line. */
229#define pp_indentation(PP) (PP)->indent_skip
230
231/* True if identifiers are translated to the locale character set on
232 output. */
233#define pp_translate_identifiers(PP) (PP)->translate_identifiers
234
235/* True if colors should be shown. */
236#define pp_show_color(PP) (PP)->show_color
237
238class urlifier;
239
240/* The data structure that contains the bare minimum required to do
241 proper pretty-printing. Clients may derived from this structure
242 and add additional fields they need. */
243class pretty_printer
244{
245public:
246 /* Default construct a pretty printer with specified
247 maximum line length cut off limit. */
248 explicit pretty_printer (int = 0);
249 explicit pretty_printer (const pretty_printer &other);
250
251 virtual ~pretty_printer ();
252
253 virtual pretty_printer *clone () const;
254
255 /* Where we print external representation of ENTITY. */
256 output_buffer *buffer;
257
258 /* The prefix for each new line. If non-NULL, this is "owned" by the
259 pretty_printer, and will eventually be free-ed. */
260 char *prefix;
261
262 /* Where to put whitespace around the entity being formatted. */
263 pp_padding padding;
264
265 /* The real upper bound of number of characters per line, taking into
266 account the case of a very very looong prefix. */
267 int maximum_length;
268
269 /* Indentation count. */
270 int indent_skip;
271
272 /* Current wrapping mode. */
273 pp_wrapping_mode_t wrapping;
274
275 /* If non-NULL, this function formats a TEXT into the BUFFER. When called,
276 TEXT->format_spec points to a format code. FORMAT_DECODER should call
277 pp_string (and related functions) to add data to the BUFFER.
278 FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG.
279 If the BUFFER needs additional characters from the format string, it
280 should advance the TEXT->format_spec as it goes. When FORMAT_DECODER
281 returns, TEXT->format_spec should point to the last character processed.
282 The QUOTE and BUFFER_PTR are passed in, to allow for deferring-handling
283 of format codes (e.g. %H and %I in the C++ frontend). */
284 printer_fn format_decoder;
285
286 /* If non-NULL, this is called by pp_format once after all format codes
287 have been processed, to allow for client-specific postprocessing.
288 This is used by the C++ frontend for handling the %H and %I
289 format codes (which interract with each other). */
290 format_postprocessor *m_format_postprocessor;
291
292 /* Nonzero if current PREFIX was emitted at least once. */
293 bool emitted_prefix;
294
295 /* Nonzero means one should emit a newline before outputting anything. */
296 bool need_newline;
297
298 /* Nonzero means identifiers are translated to the locale character
299 set on output. */
300 bool translate_identifiers;
301
302 /* Nonzero means that text should be colorized. */
303 bool show_color;
304
305 /* Whether URLs should be emitted, and which terminator to use. */
306 diagnostic_url_format url_format;
307
308 /* If true, then we've had a pp_begin_url (nullptr), and so the
309 next pp_end_url should be a no-op. */
310 bool m_skipping_null_url;
311};
312
313inline const char *
314pp_get_prefix (const pretty_printer *pp) { return pp->prefix; }
315
316#define pp_space(PP) pp_character (PP, ' ')
317#define pp_left_paren(PP) pp_character (PP, '(')
318#define pp_right_paren(PP) pp_character (PP, ')')
319#define pp_left_bracket(PP) pp_character (PP, '[')
320#define pp_right_bracket(PP) pp_character (PP, ']')
321#define pp_left_brace(PP) pp_character (PP, '{')
322#define pp_right_brace(PP) pp_character (PP, '}')
323#define pp_semicolon(PP) pp_character (PP, ';')
324#define pp_comma(PP) pp_character (PP, ',')
325#define pp_dot(PP) pp_character (PP, '.')
326#define pp_colon(PP) pp_character (PP, ':')
327#define pp_colon_colon(PP) pp_string (PP, "::")
328#define pp_arrow(PP) pp_string (PP, "->")
329#define pp_equal(PP) pp_character (PP, '=')
330#define pp_question(PP) pp_character (PP, '?')
331#define pp_bar(PP) pp_character (PP, '|')
332#define pp_bar_bar(PP) pp_string (PP, "||")
333#define pp_carret(PP) pp_character (PP, '^')
334#define pp_ampersand(PP) pp_character (PP, '&')
335#define pp_ampersand_ampersand(PP) pp_string (PP, "&&")
336#define pp_less(PP) pp_character (PP, '<')
337#define pp_less_equal(PP) pp_string (PP, "<=")
338#define pp_greater(PP) pp_character (PP, '>')
339#define pp_greater_equal(PP) pp_string (PP, ">=")
340#define pp_plus(PP) pp_character (PP, '+')
341#define pp_minus(PP) pp_character (PP, '-')
342#define pp_star(PP) pp_character (PP, '*')
343#define pp_slash(PP) pp_character (PP, '/')
344#define pp_modulo(PP) pp_character (PP, '%')
345#define pp_exclamation(PP) pp_character (PP, '!')
346#define pp_complement(PP) pp_character (PP, '~')
347#define pp_quote(PP) pp_character (PP, '\'')
348#define pp_backquote(PP) pp_character (PP, '`')
349#define pp_doublequote(PP) pp_character (PP, '"')
350#define pp_underscore(PP) pp_character (PP, '_')
351#define pp_maybe_newline_and_indent(PP, N) \
352 if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N)
353#define pp_scalar(PP, FORMAT, SCALAR) \
354 do \
355 { \
356 sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \
357 pp_string (PP, pp_buffer (PP)->digit_buffer); \
358 } \
359 while (0)
360#define pp_decimal_int(PP, I) pp_scalar (PP, "%d", I)
361#define pp_unsigned_wide_integer(PP, I) \
362 pp_scalar (PP, HOST_WIDE_INT_PRINT_UNSIGNED, (unsigned HOST_WIDE_INT) I)
363#define pp_vrange(PP, R) \
364 do \
365 { \
366 vrange_printer vrange_pp (PP); \
367 (R)->accept (vrange_pp); \
368 } \
369 while (0)
370#define pp_double(PP, F) pp_scalar (PP, "%f", F)
371#define pp_pointer(PP, P) pp_scalar (PP, "%p", P)
372
373#define pp_identifier(PP, ID) pp_string (PP, (pp_translate_identifiers (PP) \
374 ? identifier_to_locale (ID) \
375 : (ID)))
376
377
378#define pp_buffer(PP) (PP)->buffer
379
380extern void pp_set_line_maximum_length (pretty_printer *, int);
381extern void pp_set_prefix (pretty_printer *, char *);
382extern char *pp_take_prefix (pretty_printer *);
383extern void pp_destroy_prefix (pretty_printer *);
384extern int pp_remaining_character_count_for_line (pretty_printer *);
385extern void pp_clear_output_area (pretty_printer *);
386extern const char *pp_formatted_text (pretty_printer *);
387extern const char *pp_last_position_in_text (const pretty_printer *);
388extern void pp_emit_prefix (pretty_printer *);
389extern void pp_append_text (pretty_printer *, const char *, const char *);
390extern void pp_newline_and_flush (pretty_printer *);
391extern void pp_newline_and_indent (pretty_printer *, int);
392extern void pp_separate_with (pretty_printer *, char);
393
394/* If we haven't already defined a front-end-specific diagnostics
395 style, use the generic one. */
396#ifdef GCC_DIAG_STYLE
397#define GCC_PPDIAG_STYLE GCC_DIAG_STYLE
398#else
399#define GCC_PPDIAG_STYLE __gcc_diag__
400#endif
401
402/* This header may be included before diagnostics-core.h, hence the duplicate
403 definitions to allow for GCC-specific formats. */
404#if GCC_VERSION >= 3005
405#define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (GCC_PPDIAG_STYLE, m ,n))) ATTRIBUTE_NONNULL(m)
406#else
407#define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m)
408#endif
409extern void pp_printf (pretty_printer *, const char *, ...)
410 ATTRIBUTE_GCC_PPDIAG(2,3);
411
412extern void pp_verbatim (pretty_printer *, const char *, ...)
413 ATTRIBUTE_GCC_PPDIAG(2,3);
414extern void pp_flush (pretty_printer *);
415extern void pp_really_flush (pretty_printer *);
416extern void pp_format (pretty_printer *, text_info *,
417 const urlifier * = nullptr);
418extern void pp_output_formatted_text (pretty_printer *,
419 const urlifier * = nullptr);
420extern void pp_format_verbatim (pretty_printer *, text_info *);
421
422extern void pp_indent (pretty_printer *);
423extern void pp_newline (pretty_printer *);
424extern void pp_character (pretty_printer *, int);
425extern void pp_string (pretty_printer *, const char *);
426extern void pp_unicode_character (pretty_printer *, unsigned);
427
428extern void pp_write_text_to_stream (pretty_printer *);
429extern void pp_write_text_as_dot_label_to_stream (pretty_printer *, bool);
430extern void pp_write_text_as_html_like_dot_to_stream (pretty_printer *pp);
431
432extern void pp_maybe_space (pretty_printer *);
433
434extern void pp_begin_quote (pretty_printer *, bool);
435extern void pp_end_quote (pretty_printer *, bool);
436
437extern void pp_begin_url (pretty_printer *pp, const char *url);
438extern void pp_end_url (pretty_printer *pp);
439
440/* Switch into verbatim mode and return the old mode. */
441inline pp_wrapping_mode_t
442pp_set_verbatim_wrapping_ (pretty_printer *pp)
443{
444 pp_wrapping_mode_t oldmode = pp_wrapping_mode (pp);
445 pp_line_cutoff (pp) = 0;
446 pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_NEVER;
447 return oldmode;
448}
449#define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (PP)
450
451extern const char *identifier_to_locale (const char *);
452extern void *(*identifier_to_locale_alloc) (size_t);
453extern void (*identifier_to_locale_free) (void *);
454
455/* Print I to PP in decimal. */
456
457inline void
458pp_wide_integer (pretty_printer *pp, HOST_WIDE_INT i)
459{
460 pp_scalar (pp, HOST_WIDE_INT_PRINT_DEC, i);
461}
462
463inline void
464pp_wide_int (pretty_printer *pp, const wide_int_ref &w, signop sgn)
465{
466 unsigned int len;
467 print_dec_buf_size (wi: w, sgn, len: &len);
468 if (UNLIKELY (len > sizeof (pp_buffer (pp)->digit_buffer)))
469 pp_wide_int_large (pp, w, sgn);
470 else
471 {
472 print_dec (wi: w, pp_buffer (pp)->digit_buffer, sgn);
473 pp_string (pp, pp_buffer (pp)->digit_buffer);
474 }
475}
476
477template<unsigned int N, typename T>
478void pp_wide_integer (pretty_printer *pp, const poly_int<N, T> &);
479
480#endif /* GCC_PRETTY_PRINT_H */
481

source code of gcc/pretty-print.h