gcc/c-family/c-pretty-print.h

   1 /* Various declarations for the C and C++ pretty-printers.
   2    Copyright (C) 2002-2024 Free Software Foundation, Inc.
   3    Contributed by Gabriel Dos Reis <gdr@integrable-solutions.net>
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GCC_C_PRETTY_PRINTER
  22 #define GCC_C_PRETTY_PRINTER
  23
  24 #include "tree.h"
  25 #include "c-family/c-common.h"
  26 #include "pretty-print.h"
  27
  28
  29 enum pp_c_pretty_print_flags
  30   {
  31      pp_c_flag_abstract = 1 << 1,
  32      pp_c_flag_gnu_v3 = 1 << 2,
  33      pp_c_flag_last_bit = 3
  34   };
  35
  36
  37 /* The data type used to bundle information necessary for pretty-printing
  38    a C or C++ entity.  */
  39 class c_pretty_printer;
  40
  41 /* The type of a C pretty-printer 'member' function.  */
  42 typedef void (*c_pretty_print_fn) (c_pretty_printer *, tree);
  43
  44 /* The datatype that contains information necessary for pretty-printing
  45    a tree that represents a C construct.  Any pretty-printer for a
  46    language using C syntax can derive from this datatype and reuse
  47    facilities provided here.  A derived pretty-printer can override
  48    any function listed in the vtable below.  See cp/cxx-pretty-print.h
  49    and cp/cxx-pretty-print.cc for an example of derivation.  */
  50 class c_pretty_printer : public pretty_printer
  51 {
  52 public:
  53   c_pretty_printer ();
  54   pretty_printer *clone () const override;
  55
  56   // Format string, possibly translated.
  57   void translate_string (const char *);
  58
  59   virtual void constant (tree);
  60   virtual void id_expression (tree);
  61   virtual void primary_expression (tree);
  62   virtual void postfix_expression (tree);
  63   virtual void unary_expression (tree);
  64   virtual void multiplicative_expression (tree);
  65   virtual void conditional_expression (tree);
  66   virtual void assignment_expression (tree);
  67   virtual void expression (tree);
  68
  69   virtual void type_id (tree);
  70   virtual void statement (tree);
  71
  72   virtual void declaration (tree);
  73   virtual void declaration_specifiers (tree);
  74   virtual void simple_type_specifier (tree);
  75   virtual void function_specifier (tree);
  76   virtual void storage_class_specifier (tree);
  77   virtual void declarator (tree);
  78   virtual void direct_declarator (tree);
  79   virtual void abstract_declarator (tree);
  80   virtual void direct_abstract_declarator (tree);
  81
  82   virtual void initializer (tree);
  83   /* Points to the first element of an array of offset-list.
  84      Not used yet.  */
  85   int *offset_list;
  86
  87   pp_flags flags;
  88
  89   /* These must be overridden by each of the C and C++ front-end to
  90      reflect their understanding of syntactic productions when they differ.  */
  91   c_pretty_print_fn type_specifier_seq;
  92   c_pretty_print_fn ptr_operator;
  93   c_pretty_print_fn parameter_list;
  94 };
  95
  96 #define pp_c_tree_identifier(PPI, ID)              \
  97    pp_c_identifier (PPI, IDENTIFIER_POINTER (ID))
  98
  99 #define pp_type_specifier_seq(PP, D)    (PP)->type_specifier_seq (PP, D)
 100 #define pp_ptr_operator(PP, D)          (PP)->ptr_operator (PP, D)
 101 #define pp_parameter_list(PP, T)        (PP)->parameter_list (PP, T)
 102
 103 void pp_c_whitespace (c_pretty_printer *);
 104 void pp_c_left_paren (c_pretty_printer *);
 105 void pp_c_right_paren (c_pretty_printer *);
 106 void pp_c_left_brace (c_pretty_printer *);
 107 void pp_c_right_brace (c_pretty_printer *);
 108 void pp_c_left_bracket (c_pretty_printer *);
 109 void pp_c_right_bracket (c_pretty_printer *);
 110 void pp_c_dot (c_pretty_printer *);
 111 void pp_c_ampersand (c_pretty_printer *);
 112 void pp_c_star (c_pretty_printer *);
 113 void pp_c_arrow (c_pretty_printer *);
 114 void pp_c_semicolon (c_pretty_printer *);
 115 void pp_c_complement (c_pretty_printer *);
 116 void pp_c_exclamation (c_pretty_printer *);
 117 void pp_c_space_for_pointer_operator (c_pretty_printer *, tree);
 118
 119 /* Declarations.  */
 120 void pp_c_tree_decl_identifier (c_pretty_printer *, tree);
 121 void pp_c_function_definition (c_pretty_printer *, tree);
 122 void pp_c_attributes_display (c_pretty_printer *, tree);
 123 void pp_c_cv_qualifiers (c_pretty_printer *pp, int qualifiers, bool func_type);
 124 void pp_c_type_qualifier_list (c_pretty_printer *, tree);
 125 void pp_c_parameter_type_list (c_pretty_printer *, tree);
 126 void pp_c_specifier_qualifier_list (c_pretty_printer *, tree);
 127 /* Expressions.  */
 128 void pp_c_logical_or_expression (c_pretty_printer *, tree);
 129 void pp_c_expression_list (c_pretty_printer *, tree);
 130 void pp_c_constructor_elts (c_pretty_printer *, vec<constructor_elt, va_gc> *);
 131 void pp_c_call_argument_list (c_pretty_printer *, tree);
 132 void pp_c_type_cast (c_pretty_printer *, tree);
 133 void pp_c_cast_expression (c_pretty_printer *, tree);
 134 void pp_c_init_declarator (c_pretty_printer *, tree);
 135 void pp_c_ws_string (c_pretty_printer *, const char *);
 136 void pp_c_identifier (c_pretty_printer *, const char *);
 137 void pp_c_string_literal (c_pretty_printer *, tree);
 138 void pp_c_integer_constant (c_pretty_printer *, tree);
 139
 140 void print_c_tree (FILE *file, tree t);
 141
 142 #endif /* GCC_C_PRETTY_PRINTER */