c-pretty-print.h revision 132718
1/* Various declarations for the C and C++ pretty-printers. 2 Copyright (C) 2002, 2003 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 2, 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 COPYING. If not, write to the Free 19Software Foundation, 59 Temple Place - Suite 330, Boston, MA 2002111-1307, USA. */ 21 22#ifndef GCC_C_PRETTY_PRINTER 23#define GCC_C_PRETTY_PRINTER 24 25#include "tree.h" 26#include "c-common.h" 27#include "pretty-print.h" 28 29 30typedef enum 31 { 32 pp_c_flag_abstract = 1 << 1, 33 pp_c_flag_last_bit = 2 34 } pp_c_pretty_print_flags; 35 36 37/* The data type used to bundle information necessary for pretty-printing 38 a C or C++ entity. */ 39typedef struct c_pretty_print_info c_pretty_printer; 40 41/* The type of a C pretty-printer 'member' function. */ 42typedef 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/c++ syntax can derive from this datatype and reuse 47 facilities provided here. It can do so by having a subobject of type 48 c_pretty_printer and override the macro pp_c_base to return a pointer 49 to that subobject. Such a pretty-printer has the responsibility to 50 initialize the pp_base() part, then call pp_c_pretty_printer_init 51 to set up the components that are specific to the C pretty-printer. 52 A derived pretty-printer can override any function listed in the 53 vtable below. See cp/cxx-pretty-print.h and cp/cxx-pretty-print.c 54 for an example of derivation. */ 55struct c_pretty_print_info 56{ 57 pretty_printer base; 58 /* Points to the first element of an array of offset-list. 59 Not used yet. */ 60 int *offset_list; 61 62 pp_flags flags; 63 64 /* These must be overridden by each of the C and C++ front-end to 65 reflect their understanding of syntactic productions when they differ. */ 66 c_pretty_print_fn declaration; 67 c_pretty_print_fn declaration_specifiers; 68 c_pretty_print_fn declarator; 69 c_pretty_print_fn abstract_declarator; 70 c_pretty_print_fn direct_abstract_declarator; 71 c_pretty_print_fn type_specifier_seq; 72 c_pretty_print_fn direct_declarator; 73 c_pretty_print_fn ptr_operator; 74 c_pretty_print_fn parameter_list; 75 c_pretty_print_fn type_id; 76 c_pretty_print_fn simple_type_specifier; 77 c_pretty_print_fn function_specifier; 78 c_pretty_print_fn storage_class_specifier; 79 c_pretty_print_fn initializer; 80 81 c_pretty_print_fn statement; 82 83 c_pretty_print_fn id_expression; 84 c_pretty_print_fn primary_expression; 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/* Override the pp_base macro. Derived pretty-printers should not 94 touch this macro. Instead they should override pp_c_base instead. */ 95#undef pp_base 96#define pp_base(PP) (&pp_c_base (PP)->base) 97 98 99#define pp_c_tree_identifier(PPI, ID) \ 100 pp_c_identifier (PPI, IDENTIFIER_POINTER (ID)) 101 102#define pp_declaration(PPI, T) \ 103 pp_c_base (PPI)->declaration (pp_c_base (PPI), T) 104#define pp_declaration_specifiers(PPI, D) \ 105 pp_c_base (PPI)->declaration_specifiers (pp_c_base (PPI), D) 106#define pp_abstract_declarator(PP, D) \ 107 pp_c_base (PP)->abstract_declarator (pp_c_base (PP), D) 108#define pp_type_specifier_seq(PPI, D) \ 109 pp_c_base (PPI)->type_specifier_seq (pp_c_base (PPI), D) 110#define pp_declarator(PPI, D) \ 111 pp_c_base (PPI)->declarator (pp_c_base (PPI), D) 112#define pp_direct_declarator(PPI, D) \ 113 pp_c_base (PPI)->direct_declarator (pp_c_base (PPI), D) 114#define pp_direct_abstract_declarator(PP, D) \ 115 pp_c_base (PP)->direct_abstract_declarator (pp_c_base (PP), D) 116#define pp_ptr_operator(PP, D) \ 117 pp_c_base (PP)->ptr_operator (pp_c_base (PP), D) 118#define pp_parameter_list(PPI, T) \ 119 pp_c_base (PPI)->parameter_list (pp_c_base (PPI), T) 120#define pp_type_id(PPI, D) \ 121 pp_c_base (PPI)->type_id (pp_c_base (PPI), D) 122#define pp_simple_type_specifier(PP, T) \ 123 pp_c_base (PP)->simple_type_specifier (pp_c_base (PP), T) 124#define pp_function_specifier(PP, D) \ 125 pp_c_base (PP)->function_specifier (pp_c_base (PP), D) 126#define pp_storage_class_specifier(PP, D) \ 127 pp_c_base (PP)->storage_class_specifier (pp_c_base (PP), D); 128 129#define pp_statement(PPI, S) \ 130 pp_c_base (PPI)->statement (pp_c_base (PPI), S) 131 132#define pp_id_expression(PP, E) \ 133 pp_c_base (PP)->id_expression (pp_c_base (PP), E) 134#define pp_primary_expression(PPI, E) \ 135 pp_c_base (PPI)->primary_expression (pp_c_base (PPI), E) 136#define pp_postfix_expression(PPI, E) \ 137 pp_c_base (PPI)->postfix_expression (pp_c_base (PPI), E) 138#define pp_unary_expression(PPI, E) \ 139 pp_c_base (PPI)->unary_expression (pp_c_base (PPI), E) 140#define pp_initializer(PPI, E) \ 141 pp_c_base (PPI)->initializer (pp_c_base (PPI), E) 142#define pp_multiplicative_expression(PPI, E) \ 143 pp_c_base (PPI)->multiplicative_expression (pp_c_base (PPI), E) 144#define pp_conditional_expression(PPI, E) \ 145 pp_c_base (PPI)->conditional_expression (pp_c_base (PPI), E) 146#define pp_assignment_expression(PPI, E) \ 147 pp_c_base (PPI)->assignment_expression (pp_c_base (PPI), E) 148#define pp_expression(PP, E) \ 149 pp_c_base (PP)->expression (pp_c_base (PP), E) 150 151 152/* Returns the c_pretty_printer base object of PRETTY-PRINTER. This 153 macro must be overridden by any subclass of c_pretty_print_info. */ 154#define pp_c_base(PP) (PP) 155 156extern void pp_c_pretty_printer_init (c_pretty_printer *); 157void pp_c_whitespace (c_pretty_printer *); 158void pp_c_left_paren (c_pretty_printer *); 159void pp_c_right_paren (c_pretty_printer *); 160void pp_c_left_brace (c_pretty_printer *); 161void pp_c_right_brace (c_pretty_printer *); 162void pp_c_dot (c_pretty_printer *); 163void pp_c_ampersand (c_pretty_printer *); 164void pp_c_arrow (c_pretty_printer *); 165void pp_c_semicolon (c_pretty_printer *); 166void pp_c_space_for_pointer_operator (c_pretty_printer *, tree); 167 168/* Declarations. */ 169void pp_c_function_definition (c_pretty_printer *, tree); 170void pp_c_attributes (c_pretty_printer *, tree); 171void pp_c_type_qualifier_list (c_pretty_printer *, tree); 172void pp_c_parameter_type_list (c_pretty_printer *, tree); 173void pp_c_declaration (c_pretty_printer *, tree); 174void pp_c_declaration_specifiers (c_pretty_printer *, tree); 175void pp_c_declarator (c_pretty_printer *, tree); 176void pp_c_direct_declarator (c_pretty_printer *, tree); 177void pp_c_specifier_qualifier_list (c_pretty_printer *, tree); 178void pp_c_function_specifier (c_pretty_printer *, tree); 179void pp_c_type_id (c_pretty_printer *, tree); 180void pp_c_direct_abstract_declarator (c_pretty_printer *, tree); 181void pp_c_type_specifier (c_pretty_printer *, tree); 182void pp_c_storage_class_specifier (c_pretty_printer *, tree); 183/* Statements. */ 184void pp_c_statement (c_pretty_printer *, tree); 185/* Expressions. */ 186void pp_c_expression (c_pretty_printer *, tree); 187void pp_c_logical_or_expression (c_pretty_printer *, tree); 188void pp_c_expression_list (c_pretty_printer *, tree); 189void pp_c_call_argument_list (c_pretty_printer *, tree); 190void pp_c_unary_expression (c_pretty_printer *, tree); 191void pp_c_cast_expression (c_pretty_printer *, tree); 192void pp_c_postfix_expression (c_pretty_printer *, tree); 193void pp_c_primary_expression (c_pretty_printer *, tree); 194void pp_c_init_declarator (c_pretty_printer *, tree); 195void pp_c_constant (c_pretty_printer *, tree); 196void pp_c_id_expression (c_pretty_printer *, tree); 197void pp_c_identifier (c_pretty_printer *, const char *); 198void pp_c_string_literal (c_pretty_printer *, tree); 199 200#endif /* GCC_C_PRETTY_PRINTER */ 201