1117395Skan/* Various declarations for language-independent pretty-print subroutines. 2169689Skan Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc. 3117395Skan Contributed by Gabriel Dos Reis <gdr@integrable-solutions.net> 4117395Skan 5117395SkanThis file is part of GCC. 6117395Skan 7117395SkanGCC is free software; you can redistribute it and/or modify it under 8117395Skanthe terms of the GNU General Public License as published by the Free 9117395SkanSoftware Foundation; either version 2, or (at your option) any later 10117395Skanversion. 11117395Skan 12117395SkanGCC is distributed in the hope that it will be useful, but WITHOUT ANY 13117395SkanWARRANTY; without even the implied warranty of MERCHANTABILITY or 14117395SkanFITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 15117395Skanfor more details. 16117395Skan 17117395SkanYou should have received a copy of the GNU General Public License 18117395Skanalong with GCC; see the file COPYING. If not, write to the Free 19169689SkanSoftware Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 20169689Skan02110-1301, USA. */ 21117395Skan 22117395Skan#ifndef GCC_PRETTY_PRINT_H 23117395Skan#define GCC_PRETTY_PRINT_H 24117395Skan 25132718Skan#include "obstack.h" 26132718Skan#include "input.h" 27117395Skan 28169689Skan/* Maximum number of format string arguments. */ 29169689Skan#define PP_NL_ARGMAX 30 30169689Skan 31132718Skan/* The type of a text to be formatted according a format specification 32132718Skan along with a list of things. */ 33132718Skantypedef struct 34132718Skan{ 35132718Skan const char *format_spec; 36132718Skan va_list *args_ptr; 37132718Skan int err_no; /* for %m */ 38169689Skan location_t *locus; 39132718Skan} text_info; 40132718Skan 41132718Skan/* How often diagnostics are prefixed by their locations: 42132718Skan o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported; 43132718Skan o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit only once; 44132718Skan o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit each time a physical 45132718Skan line is started. */ 46132718Skantypedef enum 47132718Skan{ 48132718Skan DIAGNOSTICS_SHOW_PREFIX_ONCE = 0x0, 49132718Skan DIAGNOSTICS_SHOW_PREFIX_NEVER = 0x1, 50132718Skan DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2 51132718Skan} diagnostic_prefixing_rule_t; 52132718Skan 53169689Skan/* The chunk_info data structure forms a stack of the results from the 54169689Skan first phase of formatting (pp_base_format) which have not yet been 55169689Skan output (pp_base_output_formatted_text). A stack is necessary because 56169689Skan the diagnostic starter may decide to generate its own output by way 57169689Skan of the formatter. */ 58169689Skanstruct chunk_info 59169689Skan{ 60169689Skan /* Pointer to previous chunk on the stack. */ 61169689Skan struct chunk_info *prev; 62169689Skan 63169689Skan /* Array of chunks to output. Each chunk is a NUL-terminated string. 64169689Skan In the first phase of formatting, even-numbered chunks are 65169689Skan to be output verbatim, odd-numbered chunks are format specifiers. 66169689Skan The second phase replaces all odd-numbered chunks with formatted 67169689Skan text, and the third phase simply emits all the chunks in sequence 68169689Skan with appropriate line-wrapping. */ 69169689Skan const char *args[PP_NL_ARGMAX * 2]; 70169689Skan}; 71169689Skan 72132718Skan/* The output buffer datatype. This is best seen as an abstract datatype 73132718Skan whose fields should not be accessed directly by clients. */ 74132718Skantypedef struct 75132718Skan{ 76169689Skan /* Obstack where the text is built up. */ 77169689Skan struct obstack formatted_obstack; 78132718Skan 79169689Skan /* Obstack containing a chunked representation of the format 80169689Skan specification plus arguments. */ 81169689Skan struct obstack chunk_obstack; 82169689Skan 83169689Skan /* Currently active obstack: one of the above two. This is used so 84169689Skan that the text formatters don't need to know which phase we're in. */ 85169689Skan struct obstack *obstack; 86169689Skan 87169689Skan /* Stack of chunk arrays. These come from the chunk_obstack. */ 88169689Skan struct chunk_info *cur_chunk_array; 89169689Skan 90132718Skan /* Where to output formatted text. */ 91132718Skan FILE *stream; 92132718Skan 93132718Skan /* The amount of characters output so far. */ 94132718Skan int line_length; 95132718Skan 96132718Skan /* This must be large enough to hold any printed integer or 97132718Skan floating-point value. */ 98132718Skan char digit_buffer[128]; 99132718Skan} output_buffer; 100132718Skan 101117395Skan/* The type of pretty-printer flags passed to clients. */ 102117395Skantypedef unsigned int pp_flags; 103117395Skan 104117395Skantypedef enum 105117395Skan{ 106117395Skan pp_none, pp_before, pp_after 107117395Skan} pp_padding; 108117395Skan 109169689Skan/* Structure for switching in and out of verbatim mode in a convenient 110169689Skan manner. */ 111169689Skantypedef struct 112169689Skan{ 113169689Skan /* Current prefixing rule. */ 114169689Skan diagnostic_prefixing_rule_t rule; 115169689Skan 116169689Skan /* The ideal upper bound of number of characters per line, as suggested 117169689Skan by front-end. */ 118169689Skan int line_cutoff; 119169689Skan} pp_wrapping_mode_t; 120169689Skan 121169689Skan/* Maximum characters per line in automatic line wrapping mode. 122169689Skan Zero means don't wrap lines. */ 123169689Skan#define pp_line_cutoff(PP) pp_base (PP)->wrapping.line_cutoff 124169689Skan 125169689Skan/* Prefixing rule used in formatting a diagnostic message. */ 126169689Skan#define pp_prefixing_rule(PP) pp_base (PP)->wrapping.rule 127169689Skan 128169689Skan/* Get or set the wrapping mode as a single entity. */ 129169689Skan#define pp_wrapping_mode(PP) pp_base (PP)->wrapping 130169689Skan 131132718Skan/* The type of a hook that formats client-specific data onto a pretty_pinter. 132132718Skan A client-supplied formatter returns true if everything goes well, 133132718Skan otherwise it returns false. */ 134132718Skantypedef struct pretty_print_info pretty_printer; 135169689Skantypedef bool (*printer_fn) (pretty_printer *, text_info *, const char *, 136169689Skan int, bool, bool, bool); 137132718Skan 138132718Skan/* Client supplied function used to decode formats. */ 139132718Skan#define pp_format_decoder(PP) pp_base (PP)->format_decoder 140132718Skan 141132718Skan/* TRUE if a newline character needs to be added before further 142132718Skan formatting. */ 143132718Skan#define pp_needs_newline(PP) pp_base (PP)->need_newline 144132718Skan 145132718Skan/* True if PRETTY-PTINTER is in line-wrapping mode. */ 146132718Skan#define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0) 147132718Skan 148132718Skan/* The amount of whitespace to be emitted when starting a new line. */ 149132718Skan#define pp_indentation(PP) pp_base (PP)->indent_skip 150132718Skan 151132718Skan/* The data structure that contains the bare minimum required to do 152132718Skan proper pretty-printing. Clients may derived from this structure 153132718Skan and add additional fields they need. */ 154117395Skanstruct pretty_print_info 155117395Skan{ 156117395Skan /* Where we print external representation of ENTITY. */ 157117395Skan output_buffer *buffer; 158132718Skan 159132718Skan /* The prefix for each new line. */ 160132718Skan const char *prefix; 161132718Skan 162117395Skan /* Where to put whitespace around the entity being formatted. */ 163117395Skan pp_padding padding; 164132718Skan 165132718Skan /* The real upper bound of number of characters per line, taking into 166132718Skan account the case of a very very looong prefix. */ 167132718Skan int maximum_length; 168132718Skan 169132718Skan /* Indentation count. */ 170132718Skan int indent_skip; 171132718Skan 172169689Skan /* Current wrapping mode. */ 173169689Skan pp_wrapping_mode_t wrapping; 174132718Skan 175132718Skan /* If non-NULL, this function formats a TEXT into the BUFFER. When called, 176132718Skan TEXT->format_spec points to a format code. FORMAT_DECODER should call 177132718Skan pp_string (and related functions) to add data to the BUFFER. 178132718Skan FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG. 179132718Skan If the BUFFER needs additional characters from the format string, it 180132718Skan should advance the TEXT->format_spec as it goes. When FORMAT_DECODER 181132718Skan returns, TEXT->format_spec should point to the last character processed. 182132718Skan */ 183132718Skan printer_fn format_decoder; 184132718Skan 185132718Skan /* Nonzero if current PREFIX was emitted at least once. */ 186132718Skan bool emitted_prefix; 187132718Skan 188132718Skan /* Nonzero means one should emit a newline before outputting anything. */ 189132718Skan bool need_newline; 190117395Skan}; 191117395Skan 192132718Skan#define pp_set_line_maximum_length(PP, L) \ 193132718Skan pp_base_set_line_maximum_length (pp_base (PP), L) 194132718Skan#define pp_set_prefix(PP, P) pp_base_set_prefix (pp_base (PP), P) 195132718Skan#define pp_destroy_prefix(PP) pp_base_destroy_prefix (pp_base (PP)) 196132718Skan#define pp_remaining_character_count_for_line(PP) \ 197132718Skan pp_base_remaining_character_count_for_line (pp_base (PP)) 198132718Skan#define pp_clear_output_area(PP) \ 199132718Skan pp_base_clear_output_area (pp_base (PP)) 200132718Skan#define pp_formatted_text(PP) pp_base_formatted_text (pp_base (PP)) 201132718Skan#define pp_last_position_in_text(PP) \ 202132718Skan pp_base_last_position_in_text (pp_base (PP)) 203132718Skan#define pp_emit_prefix(PP) pp_base_emit_prefix (pp_base (PP)) 204132718Skan#define pp_append_text(PP, B, E) \ 205132718Skan pp_base_append_text (pp_base (PP), B, E) 206132718Skan#define pp_flush(PP) pp_base_flush (pp_base (PP)) 207169689Skan#define pp_format(PP, TI) pp_base_format (pp_base (PP), TI) 208169689Skan#define pp_output_formatted_text(PP) \ 209169689Skan pp_base_output_formatted_text (pp_base (PP)) 210132718Skan#define pp_format_verbatim(PP, TI) \ 211132718Skan pp_base_format_verbatim (pp_base (PP), TI) 212132718Skan 213132718Skan#define pp_character(PP, C) pp_base_character (pp_base (PP), C) 214132718Skan#define pp_string(PP, S) pp_base_string (pp_base (PP), S) 215132718Skan#define pp_newline(PP) pp_base_newline (pp_base (PP)) 216132718Skan 217132718Skan#define pp_space(PP) pp_character (PP, ' ') 218132718Skan#define pp_left_paren(PP) pp_character (PP, '(') 219132718Skan#define pp_right_paren(PP) pp_character (PP, ')') 220132718Skan#define pp_left_bracket(PP) pp_character (PP, '[') 221132718Skan#define pp_right_bracket(PP) pp_character (PP, ']') 222132718Skan#define pp_left_brace(PP) pp_character (PP, '{') 223132718Skan#define pp_right_brace(PP) pp_character (PP, '}') 224132718Skan#define pp_semicolon(PP) pp_character (PP, ';') 225132718Skan#define pp_comma(PP) pp_string (PP, ", ") 226132718Skan#define pp_dot(PP) pp_character (PP, '.') 227132718Skan#define pp_colon(PP) pp_character (PP, ':') 228132718Skan#define pp_colon_colon(PP) pp_string (PP, "::") 229132718Skan#define pp_arrow(PP) pp_string (PP, "->") 230132718Skan#define pp_equal(PP) pp_character (PP, '=') 231132718Skan#define pp_question(PP) pp_character (PP, '?') 232132718Skan#define pp_bar(PP) pp_character (PP, '|') 233132718Skan#define pp_carret(PP) pp_character (PP, '^') 234132718Skan#define pp_ampersand(PP) pp_character (PP, '&') 235132718Skan#define pp_less(PP) pp_character (PP, '<') 236132718Skan#define pp_greater(PP) pp_character (PP, '>') 237132718Skan#define pp_plus(PP) pp_character (PP, '+') 238132718Skan#define pp_minus(PP) pp_character (PP, '-') 239132718Skan#define pp_star(PP) pp_character (PP, '*') 240132718Skan#define pp_slash(PP) pp_character (PP, '/') 241132718Skan#define pp_modulo(PP) pp_character (PP, '%') 242132718Skan#define pp_exclamation(PP) pp_character (PP, '!') 243132718Skan#define pp_complement(PP) pp_character (PP, '~') 244132718Skan#define pp_quote(PP) pp_character (PP, '\'') 245132718Skan#define pp_backquote(PP) pp_character (PP, '`') 246132718Skan#define pp_doublequote(PP) pp_character (PP, '"') 247132718Skan#define pp_newline_and_indent(PP, N) \ 248132718Skan do { \ 249132718Skan pp_indentation (PP) += N; \ 250132718Skan pp_newline (PP); \ 251132718Skan pp_base_indent (pp_base (PP)); \ 252132718Skan pp_needs_newline (PP) = false; \ 253117395Skan } while (0) 254132718Skan#define pp_maybe_newline_and_indent(PP, N) \ 255132718Skan if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N) 256169689Skan#define pp_maybe_space(PP) pp_base_maybe_space (pp_base (PP)) 257132718Skan#define pp_separate_with(PP, C) \ 258132718Skan do { \ 259132718Skan pp_character (PP, C); \ 260132718Skan pp_space (PP); \ 261117395Skan } while (0) 262132718Skan#define pp_scalar(PP, FORMAT, SCALAR) \ 263132718Skan do \ 264132718Skan { \ 265132718Skan sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \ 266132718Skan pp_string (PP, pp_buffer (PP)->digit_buffer); \ 267132718Skan } \ 268132718Skan while (0) 269132718Skan#define pp_decimal_int(PP, I) pp_scalar (PP, "%d", I) 270132718Skan#define pp_wide_integer(PP, I) \ 271132718Skan pp_scalar (PP, HOST_WIDE_INT_PRINT_DEC, (HOST_WIDE_INT) I) 272169689Skan#define pp_widest_integer(PP, I) \ 273169689Skan pp_scalar (PP, HOST_WIDEST_INT_PRINT_DEC, (HOST_WIDEST_INT) I) 274132718Skan#define pp_pointer(PP, P) pp_scalar (PP, "%p", P) 275117395Skan 276132718Skan#define pp_identifier(PP, ID) pp_string (PP, ID) 277132718Skan#define pp_tree_identifier(PP, T) \ 278132718Skan pp_append_text(PP, IDENTIFIER_POINTER (T), \ 279132718Skan IDENTIFIER_POINTER (T) + IDENTIFIER_LENGTH (T)) 280117395Skan 281132718Skan#define pp_unsupported_tree(PP, T) \ 282169689Skan pp_verbatim (pp_base (PP), "#%qs not supported by %s#", \ 283132718Skan tree_code_name[(int) TREE_CODE (T)], __FUNCTION__) 284117395Skan 285132718Skan 286132718Skan#define pp_buffer(PP) pp_base (PP)->buffer 287132718Skan/* Clients that directly derive from pretty_printer need to override 288132718Skan this macro to return a pointer to the base pretty_printer structure. */ 289132718Skan#define pp_base(PP) (PP) 290132718Skan 291132718Skanextern void pp_construct (pretty_printer *, const char *, int); 292132718Skanextern void pp_base_set_line_maximum_length (pretty_printer *, int); 293132718Skanextern void pp_base_set_prefix (pretty_printer *, const char *); 294132718Skanextern void pp_base_destroy_prefix (pretty_printer *); 295132718Skanextern int pp_base_remaining_character_count_for_line (pretty_printer *); 296132718Skanextern void pp_base_clear_output_area (pretty_printer *); 297132718Skanextern const char *pp_base_formatted_text (pretty_printer *); 298132718Skanextern const char *pp_base_last_position_in_text (const pretty_printer *); 299132718Skanextern void pp_base_emit_prefix (pretty_printer *); 300132718Skanextern void pp_base_append_text (pretty_printer *, const char *, const char *); 301169689Skan 302169689Skan/* This header may be included before toplev.h, hence the duplicate 303169689Skan definitions to allow for GCC-specific formats. */ 304169689Skan#if GCC_VERSION >= 3005 305169689Skan#define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (__gcc_diag__, m ,n))) ATTRIBUTE_NONNULL(m) 306169689Skan#else 307169689Skan#define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m) 308169689Skan#endif 309169689Skanextern void pp_printf (pretty_printer *, const char *, ...) 310169689Skan ATTRIBUTE_GCC_PPDIAG(2,3); 311169689Skan 312169689Skanextern void pp_verbatim (pretty_printer *, const char *, ...) 313169689Skan ATTRIBUTE_GCC_PPDIAG(2,3); 314132718Skanextern void pp_base_flush (pretty_printer *); 315169689Skanextern void pp_base_format (pretty_printer *, text_info *); 316169689Skanextern void pp_base_output_formatted_text (pretty_printer *); 317132718Skanextern void pp_base_format_verbatim (pretty_printer *, text_info *); 318132718Skan 319132718Skanextern void pp_base_indent (pretty_printer *); 320132718Skanextern void pp_base_newline (pretty_printer *); 321132718Skanextern void pp_base_character (pretty_printer *, int); 322132718Skanextern void pp_base_string (pretty_printer *, const char *); 323169689Skanextern void pp_write_text_to_stream (pretty_printer *pp); 324169689Skanextern void pp_base_maybe_space (pretty_printer *); 325132718Skan 326169689Skan/* Switch into verbatim mode and return the old mode. */ 327169689Skanstatic inline pp_wrapping_mode_t 328169689Skanpp_set_verbatim_wrapping_ (pretty_printer *pp) 329169689Skan{ 330169689Skan pp_wrapping_mode_t oldmode = pp_wrapping_mode (pp); 331169689Skan pp_line_cutoff (pp) = 0; 332169689Skan pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_NEVER; 333169689Skan return oldmode; 334169689Skan} 335169689Skan#define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (pp_base (PP)) 336169689Skan 337117395Skan#endif /* GCC_PRETTY_PRINT_H */ 338