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

   1 /* Various declarations for the C and C++ pretty-printers.
   2    Copyright (C) 2002-2013 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 struct 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.c for an example of derivation.  */
  50 struct c_pretty_printer : pretty_printer
  51 {
  52   c_pretty_printer ();
  53
  54   // Format string, possibly translated.
  55   void translate_string (const char *);
  56
  57   virtual void constant (tree);
  58   virtual void id_expression (tree);
  59   virtual void primary_expression (tree);
  60   /* Points to the first element of an array of offset-list.
  61      Not used yet.  */
  62   int *offset_list;
  63
  64   pp_flags flags;
  65
  66   /* These must be overridden by each of the C and C++ front-end to
  67      reflect their understanding of syntactic productions when they differ.  */
  68   c_pretty_print_fn declaration;
  69   c_pretty_print_fn declaration_specifiers;
  70   c_pretty_print_fn declarator;
  71   c_pretty_print_fn abstract_declarator;
  72   c_pretty_print_fn direct_abstract_declarator;
  73   c_pretty_print_fn type_specifier_seq;
  74   c_pretty_print_fn direct_declarator;
  75   c_pretty_print_fn ptr_operator;
  76   c_pretty_print_fn parameter_list;
  77   c_pretty_print_fn type_id;
  78   c_pretty_print_fn simple_type_specifier;
  79   c_pretty_print_fn function_specifier;
  80   c_pretty_print_fn storage_class_specifier;
  81   c_pretty_print_fn initializer;
  82
  83   c_pretty_print_fn statement;
  84
  85   c_pretty_print_fn postfix_expression;
  86   c_pretty_print_fn unary_expression;
  87   c_pretty_print_fn multiplicative_expression;
  88   c_pretty_print_fn conditional_expression;
  89   c_pretty_print_fn assignment_expression;
  90   c_pretty_print_fn expression;
  91 };
  92
  93 #define pp_c_tree_identifier(PPI, ID)              \
  94    pp_c_identifier (PPI, IDENTIFIER_POINTER (ID))
  95
  96 #define pp_declaration(PP, T)           (PP)->declaration (PP, T)
  97 #define pp_declaration_specifiers(PP, D)         \
  98    (PP)->declaration_specifiers (PP, D)
  99 #define pp_abstract_declarator(PP, D)   (PP)->abstract_declarator (PP, D)
 100 #define pp_type_specifier_seq(PP, D)    (PP)->type_specifier_seq (PP, D)
 101 #define pp_declarator(PP, D)            (PP)->declarator (PP, D)
 102 #define pp_direct_declarator(PP, D)     (PP)->direct_declarator (PP, D)
 103 #define pp_direct_abstract_declarator(PP, D)      \
 104    (PP)->direct_abstract_declarator (PP, D)
 105 #define pp_ptr_operator(PP, D)          (PP)->ptr_operator (PP, D)
 106 #define pp_parameter_list(PP, T)        (PP)->parameter_list (PP, T)
 107 #define pp_type_id(PP, D)               (PP)->type_id (PP, D)
 108 #define pp_simple_type_specifier(PP, T) (PP)->simple_type_specifier (PP, T)
 109 #define pp_function_specifier(PP, D)    (PP)->function_specifier (PP, D)
 110 #define pp_storage_class_specifier(PP, D)         \
 111   (PP)->storage_class_specifier (PP, D);
 112
 113 #define pp_statement(PP, S)             (PP)->statement (PP, S)
 114
 115 #define pp_constant(PP, E)              (PP)->constant (E)
 116 #define pp_id_expression(PP, E)         (PP)->id_expression (E)
 117 #define pp_primary_expression(PP, E)    (PP)->primary_expression (E)
 118 #define pp_postfix_expression(PP, E)    (PP)->postfix_expression (PP, E)
 119 #define pp_unary_expression(PP, E)      (PP)->unary_expression (PP, E)
 120 #define pp_initializer(PP, E)           (PP)->initializer (PP, E)
 121 #define pp_multiplicative_expression(PP, E)      \
 122   (PP)->multiplicative_expression (PP, E)
 123 #define pp_conditional_expression(PP, E) (PP)->conditional_expression (PP, E)
 124 #define pp_assignment_expression(PP, E) (PP)->assignment_expression (PP, E)
 125 #define pp_expression(PP, E)            (PP)->expression (PP, E)
 126
 127
 128 void pp_c_whitespace (c_pretty_printer *);
 129 void pp_c_left_paren (c_pretty_printer *);
 130 void pp_c_right_paren (c_pretty_printer *);
 131 void pp_c_left_brace (c_pretty_printer *);
 132 void pp_c_right_brace (c_pretty_printer *);
 133 void pp_c_left_bracket (c_pretty_printer *);
 134 void pp_c_right_bracket (c_pretty_printer *);
 135 void pp_c_dot (c_pretty_printer *);
 136 void pp_c_ampersand (c_pretty_printer *);
 137 void pp_c_star (c_pretty_printer *);
 138 void pp_c_arrow (c_pretty_printer *);
 139 void pp_c_semicolon (c_pretty_printer *);
 140 void pp_c_complement (c_pretty_printer *);
 141 void pp_c_exclamation (c_pretty_printer *);
 142 void pp_c_space_for_pointer_operator (c_pretty_printer *, tree);
 143
 144 /* Declarations.  */
 145 void pp_c_tree_decl_identifier (c_pretty_printer *, tree);
 146 void pp_c_function_definition (c_pretty_printer *, tree);
 147 void pp_c_attributes (c_pretty_printer *, tree);
 148 void pp_c_attributes_display (c_pretty_printer *, tree);
 149 void pp_c_cv_qualifiers (c_pretty_printer *pp, int qualifiers, bool func_type);
 150 void pp_c_type_qualifier_list (c_pretty_printer *, tree);
 151 void pp_c_parameter_type_list (c_pretty_printer *, tree);
 152 void pp_c_declaration (c_pretty_printer *, tree);
 153 void pp_c_declaration_specifiers (c_pretty_printer *, tree);
 154 void pp_c_declarator (c_pretty_printer *, tree);
 155 void pp_c_direct_declarator (c_pretty_printer *, tree);
 156 void pp_c_specifier_qualifier_list (c_pretty_printer *, tree);
 157 void pp_c_function_specifier (c_pretty_printer *, tree);
 158 void pp_c_type_id (c_pretty_printer *, tree);
 159 void pp_c_direct_abstract_declarator (c_pretty_printer *, tree);
 160 void pp_c_type_specifier (c_pretty_printer *, tree);
 161 void pp_c_storage_class_specifier (c_pretty_printer *, tree);
 162 /* Statements.  */
 163 void pp_c_statement (c_pretty_printer *, tree);
 164 /* Expressions.  */
 165 void pp_c_expression (c_pretty_printer *, tree);
 166 void pp_c_logical_or_expression (c_pretty_printer *, tree);
 167 void pp_c_expression_list (c_pretty_printer *, tree);
 168 void pp_c_constructor_elts (c_pretty_printer *, vec<constructor_elt, va_gc> *);
 169 void pp_c_call_argument_list (c_pretty_printer *, tree);
 170 void pp_c_unary_expression (c_pretty_printer *, tree);
 171 void pp_c_cast_expression (c_pretty_printer *, tree);
 172 void pp_c_postfix_expression (c_pretty_printer *, tree);
 173 void pp_c_init_declarator (c_pretty_printer *, tree);
 174 void pp_c_ws_string (c_pretty_printer *, const char *);
 175 void pp_c_identifier (c_pretty_printer *, const char *);
 176 void pp_c_string_literal (c_pretty_printer *, tree);
 177
 178 void print_c_tree (FILE *file, tree t);
 179
 180 #endif /* GCC_C_PRETTY_PRINTER */