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

source code of gcc/pretty-print.h