1117395Skan/* Various declarations for the C and C++ pretty-printers. 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_C_PRETTY_PRINTER 23117395Skan#define GCC_C_PRETTY_PRINTER 24117395Skan 25117395Skan#include "tree.h" 26117395Skan#include "c-common.h" 27117395Skan#include "pretty-print.h" 28117395Skan 29117395Skan 30132718Skantypedef enum 31132718Skan { 32132718Skan pp_c_flag_abstract = 1 << 1, 33169689Skan pp_c_flag_last_bit = 2 34132718Skan } pp_c_pretty_print_flags; 35132718Skan 36132718Skan 37117395Skan/* The data type used to bundle information necessary for pretty-printing 38117395Skan a C or C++ entity. */ 39132718Skantypedef struct c_pretty_print_info c_pretty_printer; 40117395Skan 41117395Skan/* The type of a C pretty-printer 'member' function. */ 42132718Skantypedef void (*c_pretty_print_fn) (c_pretty_printer *, tree); 43117395Skan 44132718Skan/* The datatype that contains information necessary for pretty-printing 45132718Skan a tree that represents a C construct. Any pretty-printer for a 46132718Skan language using C/c++ syntax can derive from this datatype and reuse 47132718Skan facilities provided here. It can do so by having a subobject of type 48132718Skan c_pretty_printer and override the macro pp_c_base to return a pointer 49132718Skan to that subobject. Such a pretty-printer has the responsibility to 50132718Skan initialize the pp_base() part, then call pp_c_pretty_printer_init 51132718Skan to set up the components that are specific to the C pretty-printer. 52132718Skan A derived pretty-printer can override any function listed in the 53132718Skan vtable below. See cp/cxx-pretty-print.h and cp/cxx-pretty-print.c 54132718Skan for an example of derivation. */ 55117395Skanstruct c_pretty_print_info 56117395Skan{ 57132718Skan pretty_printer base; 58117395Skan /* Points to the first element of an array of offset-list. 59117395Skan Not used yet. */ 60117395Skan int *offset_list; 61117395Skan 62132718Skan pp_flags flags; 63169689Skan 64132718Skan /* These must be overridden by each of the C and C++ front-end to 65132718Skan reflect their understanding of syntactic productions when they differ. */ 66117395Skan c_pretty_print_fn declaration; 67117395Skan c_pretty_print_fn declaration_specifiers; 68117395Skan c_pretty_print_fn declarator; 69132718Skan c_pretty_print_fn abstract_declarator; 70132718Skan c_pretty_print_fn direct_abstract_declarator; 71132718Skan c_pretty_print_fn type_specifier_seq; 72117395Skan c_pretty_print_fn direct_declarator; 73132718Skan c_pretty_print_fn ptr_operator; 74132718Skan c_pretty_print_fn parameter_list; 75117395Skan c_pretty_print_fn type_id; 76132718Skan c_pretty_print_fn simple_type_specifier; 77132718Skan c_pretty_print_fn function_specifier; 78132718Skan c_pretty_print_fn storage_class_specifier; 79132718Skan c_pretty_print_fn initializer; 80117395Skan 81117395Skan c_pretty_print_fn statement; 82117395Skan 83169689Skan c_pretty_print_fn constant; 84132718Skan c_pretty_print_fn id_expression; 85117395Skan c_pretty_print_fn primary_expression; 86117395Skan c_pretty_print_fn postfix_expression; 87117395Skan c_pretty_print_fn unary_expression; 88117395Skan c_pretty_print_fn multiplicative_expression; 89117395Skan c_pretty_print_fn conditional_expression; 90117395Skan c_pretty_print_fn assignment_expression; 91132718Skan c_pretty_print_fn expression; 92117395Skan}; 93117395Skan 94132718Skan/* Override the pp_base macro. Derived pretty-printers should not 95132718Skan touch this macro. Instead they should override pp_c_base instead. */ 96132718Skan#undef pp_base 97132718Skan#define pp_base(PP) (&pp_c_base (PP)->base) 98132718Skan 99169689Skan 100117395Skan#define pp_c_tree_identifier(PPI, ID) \ 101117395Skan pp_c_identifier (PPI, IDENTIFIER_POINTER (ID)) 102117395Skan 103117395Skan#define pp_declaration(PPI, T) \ 104132718Skan pp_c_base (PPI)->declaration (pp_c_base (PPI), T) 105117395Skan#define pp_declaration_specifiers(PPI, D) \ 106132718Skan pp_c_base (PPI)->declaration_specifiers (pp_c_base (PPI), D) 107132718Skan#define pp_abstract_declarator(PP, D) \ 108132718Skan pp_c_base (PP)->abstract_declarator (pp_c_base (PP), D) 109132718Skan#define pp_type_specifier_seq(PPI, D) \ 110132718Skan pp_c_base (PPI)->type_specifier_seq (pp_c_base (PPI), D) 111117395Skan#define pp_declarator(PPI, D) \ 112132718Skan pp_c_base (PPI)->declarator (pp_c_base (PPI), D) 113117395Skan#define pp_direct_declarator(PPI, D) \ 114132718Skan pp_c_base (PPI)->direct_declarator (pp_c_base (PPI), D) 115132718Skan#define pp_direct_abstract_declarator(PP, D) \ 116132718Skan pp_c_base (PP)->direct_abstract_declarator (pp_c_base (PP), D) 117132718Skan#define pp_ptr_operator(PP, D) \ 118132718Skan pp_c_base (PP)->ptr_operator (pp_c_base (PP), D) 119132718Skan#define pp_parameter_list(PPI, T) \ 120132718Skan pp_c_base (PPI)->parameter_list (pp_c_base (PPI), T) 121117395Skan#define pp_type_id(PPI, D) \ 122132718Skan pp_c_base (PPI)->type_id (pp_c_base (PPI), D) 123132718Skan#define pp_simple_type_specifier(PP, T) \ 124132718Skan pp_c_base (PP)->simple_type_specifier (pp_c_base (PP), T) 125132718Skan#define pp_function_specifier(PP, D) \ 126132718Skan pp_c_base (PP)->function_specifier (pp_c_base (PP), D) 127132718Skan#define pp_storage_class_specifier(PP, D) \ 128132718Skan pp_c_base (PP)->storage_class_specifier (pp_c_base (PP), D); 129117395Skan 130117395Skan#define pp_statement(PPI, S) \ 131132718Skan pp_c_base (PPI)->statement (pp_c_base (PPI), S) 132117395Skan 133169689Skan#define pp_constant(PP, E) \ 134169689Skan pp_c_base (PP)->constant (pp_c_base (PP), E) 135132718Skan#define pp_id_expression(PP, E) \ 136132718Skan pp_c_base (PP)->id_expression (pp_c_base (PP), E) 137117395Skan#define pp_primary_expression(PPI, E) \ 138132718Skan pp_c_base (PPI)->primary_expression (pp_c_base (PPI), E) 139117395Skan#define pp_postfix_expression(PPI, E) \ 140132718Skan pp_c_base (PPI)->postfix_expression (pp_c_base (PPI), E) 141117395Skan#define pp_unary_expression(PPI, E) \ 142132718Skan pp_c_base (PPI)->unary_expression (pp_c_base (PPI), E) 143117395Skan#define pp_initializer(PPI, E) \ 144132718Skan pp_c_base (PPI)->initializer (pp_c_base (PPI), E) 145117395Skan#define pp_multiplicative_expression(PPI, E) \ 146132718Skan pp_c_base (PPI)->multiplicative_expression (pp_c_base (PPI), E) 147117395Skan#define pp_conditional_expression(PPI, E) \ 148132718Skan pp_c_base (PPI)->conditional_expression (pp_c_base (PPI), E) 149117395Skan#define pp_assignment_expression(PPI, E) \ 150132718Skan pp_c_base (PPI)->assignment_expression (pp_c_base (PPI), E) 151132718Skan#define pp_expression(PP, E) \ 152132718Skan pp_c_base (PP)->expression (pp_c_base (PP), E) 153117395Skan 154117395Skan 155117395Skan/* Returns the c_pretty_printer base object of PRETTY-PRINTER. This 156132718Skan macro must be overridden by any subclass of c_pretty_print_info. */ 157117395Skan#define pp_c_base(PP) (PP) 158117395Skan 159132718Skanextern void pp_c_pretty_printer_init (c_pretty_printer *); 160132718Skanvoid pp_c_whitespace (c_pretty_printer *); 161132718Skanvoid pp_c_left_paren (c_pretty_printer *); 162132718Skanvoid pp_c_right_paren (c_pretty_printer *); 163132718Skanvoid pp_c_left_brace (c_pretty_printer *); 164132718Skanvoid pp_c_right_brace (c_pretty_printer *); 165169689Skanvoid pp_c_left_bracket (c_pretty_printer *); 166169689Skanvoid pp_c_right_bracket (c_pretty_printer *); 167132718Skanvoid pp_c_dot (c_pretty_printer *); 168132718Skanvoid pp_c_ampersand (c_pretty_printer *); 169169689Skanvoid pp_c_star (c_pretty_printer *); 170261188Spfg/* APPLE LOCAL blocks */ 171261188Spfgvoid pp_c_caret (c_pretty_printer *); 172132718Skanvoid pp_c_arrow (c_pretty_printer *); 173132718Skanvoid pp_c_semicolon (c_pretty_printer *); 174169689Skanvoid pp_c_complement (c_pretty_printer *); 175169689Skanvoid pp_c_exclamation (c_pretty_printer *); 176132718Skanvoid pp_c_space_for_pointer_operator (c_pretty_printer *, tree); 177117395Skan 178117395Skan/* Declarations. */ 179169689Skanvoid pp_c_tree_decl_identifier (c_pretty_printer *, tree); 180132718Skanvoid pp_c_function_definition (c_pretty_printer *, tree); 181132718Skanvoid pp_c_attributes (c_pretty_printer *, tree); 182132718Skanvoid pp_c_type_qualifier_list (c_pretty_printer *, tree); 183132718Skanvoid pp_c_parameter_type_list (c_pretty_printer *, tree); 184132718Skanvoid pp_c_declaration (c_pretty_printer *, tree); 185132718Skanvoid pp_c_declaration_specifiers (c_pretty_printer *, tree); 186132718Skanvoid pp_c_declarator (c_pretty_printer *, tree); 187132718Skanvoid pp_c_direct_declarator (c_pretty_printer *, tree); 188132718Skanvoid pp_c_specifier_qualifier_list (c_pretty_printer *, tree); 189132718Skanvoid pp_c_function_specifier (c_pretty_printer *, tree); 190132718Skanvoid pp_c_type_id (c_pretty_printer *, tree); 191132718Skanvoid pp_c_direct_abstract_declarator (c_pretty_printer *, tree); 192132718Skanvoid pp_c_type_specifier (c_pretty_printer *, tree); 193132718Skanvoid pp_c_storage_class_specifier (c_pretty_printer *, tree); 194117395Skan/* Statements. */ 195132718Skanvoid pp_c_statement (c_pretty_printer *, tree); 196117395Skan/* Expressions. */ 197132718Skanvoid pp_c_expression (c_pretty_printer *, tree); 198132718Skanvoid pp_c_logical_or_expression (c_pretty_printer *, tree); 199132718Skanvoid pp_c_expression_list (c_pretty_printer *, tree); 200169689Skanvoid pp_c_constructor_elts (c_pretty_printer *, VEC(constructor_elt,gc) *); 201132718Skanvoid pp_c_call_argument_list (c_pretty_printer *, tree); 202132718Skanvoid pp_c_unary_expression (c_pretty_printer *, tree); 203132718Skanvoid pp_c_cast_expression (c_pretty_printer *, tree); 204132718Skanvoid pp_c_postfix_expression (c_pretty_printer *, tree); 205132718Skanvoid pp_c_primary_expression (c_pretty_printer *, tree); 206132718Skanvoid pp_c_init_declarator (c_pretty_printer *, tree); 207132718Skanvoid pp_c_constant (c_pretty_printer *, tree); 208132718Skanvoid pp_c_id_expression (c_pretty_printer *, tree); 209132718Skanvoid pp_c_identifier (c_pretty_printer *, const char *); 210132718Skanvoid pp_c_string_literal (c_pretty_printer *, tree); 211117395Skan 212169689Skanvoid print_c_tree (FILE *file, tree t); 213169689Skan 214117395Skan#endif /* GCC_C_PRETTY_PRINTER */ 215