1 //////////////////////////////////////////////////////////////////////// 2 // 3 // Copyright (C) 1996-2021 The Octave Project Developers 4 // 5 // See the file COPYRIGHT.md in the top-level directory of this 6 // distribution or <https://octave.org/copyright/>. 7 // 8 // This file is part of Octave. 9 // 10 // Octave is free software: you can redistribute it and/or modify it 11 // under the terms of the GNU General Public License as published by 12 // the Free Software Foundation, either version 3 of the License, or 13 // (at your option) any later version. 14 // 15 // Octave is distributed in the hope that it will be useful, but 16 // WITHOUT ANY WARRANTY; without even the implied warranty of 17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 // GNU General Public License for more details. 19 // 20 // You should have received a copy of the GNU General Public License 21 // along with Octave; see the file COPYING. If not, see 22 // <https://www.gnu.org/licenses/>. 23 // 24 //////////////////////////////////////////////////////////////////////// 25 26 #if ! defined (octave_pt_pr_code_h) 27 #define octave_pt_pr_code_h 1 28 29 #include "octave-config.h" 30 31 #include <stack> 32 #include <string> 33 34 #include "pt-walk.h" 35 36 namespace octave 37 { 38 class comment_elt; 39 class comment_list; 40 class tree_decl_command; 41 class tree_expression; 42 43 // How to print the code that the parse trees represent. 44 45 class tree_print_code : public tree_walker 46 { 47 public: 48 49 tree_print_code (std::ostream& os_arg, 50 const std::string& pfx = "", 51 bool pr_orig_txt = true) m_os(os_arg)52 : m_os (os_arg), m_prefix (pfx), m_nesting (), 53 m_print_original_text (pr_orig_txt), 54 m_curr_print_indent_level (0), m_beginning_of_line (true), 55 m_suppress_newlines (0) 56 { 57 // For "none". 58 m_nesting.push ('n'); 59 } 60 61 // No copying! 62 63 tree_print_code (const tree_print_code&) = delete; 64 65 tree_print_code& operator = (const tree_print_code&) = delete; 66 67 ~tree_print_code (void) = default; 68 69 void visit_anon_fcn_handle (tree_anon_fcn_handle&); 70 71 void visit_argument_list (tree_argument_list&); 72 73 void visit_binary_expression (tree_binary_expression&); 74 75 void visit_break_command (tree_break_command&); 76 77 void visit_colon_expression (tree_colon_expression&); 78 79 void visit_continue_command (tree_continue_command&); 80 81 void visit_decl_command (tree_decl_command&); 82 83 void visit_decl_init_list (tree_decl_init_list&); 84 85 void visit_decl_elt (tree_decl_elt&); 86 87 void visit_simple_for_command (tree_simple_for_command&); 88 89 void visit_complex_for_command (tree_complex_for_command&); 90 91 void visit_octave_user_script (octave_user_script&); 92 93 void visit_octave_user_function (octave_user_function&); 94 95 void visit_octave_user_function_header (octave_user_function&); 96 97 void visit_octave_user_function_trailer (octave_user_function&); 98 99 void visit_function_def (tree_function_def&); 100 101 void visit_identifier (tree_identifier&); 102 103 void visit_if_clause (tree_if_clause&); 104 105 void visit_if_command (tree_if_command&); 106 107 void visit_if_command_list (tree_if_command_list&); 108 109 void visit_index_expression (tree_index_expression&); 110 111 void visit_matrix (tree_matrix&); 112 113 void visit_cell (tree_cell&); 114 115 void visit_multi_assignment (tree_multi_assignment&); 116 117 void visit_no_op_command (tree_no_op_command&); 118 119 void visit_constant (tree_constant&); 120 121 void visit_fcn_handle (tree_fcn_handle&); 122 123 void visit_parameter_list (tree_parameter_list&); 124 125 void visit_postfix_expression (tree_postfix_expression&); 126 127 void visit_prefix_expression (tree_prefix_expression&); 128 129 void visit_return_command (tree_return_command&); 130 131 void visit_simple_assignment (tree_simple_assignment&); 132 133 void visit_statement (tree_statement&); 134 135 void visit_statement_list (tree_statement_list&); 136 137 void visit_switch_case (tree_switch_case&); 138 139 void visit_switch_command (tree_switch_command&); 140 141 void visit_try_catch_command (tree_try_catch_command&); 142 143 void visit_unwind_protect_command (tree_unwind_protect_command&); 144 145 void visit_while_command (tree_while_command&); 146 147 void visit_do_until_command (tree_do_until_command&); 148 149 void visit_superclass_ref (tree_superclass_ref&); 150 151 void visit_metaclass_query (tree_metaclass_query&); 152 153 void print_fcn_handle_body (tree_expression *); 154 155 private: 156 157 std::ostream& m_os; 158 159 std::string m_prefix; 160 161 std::stack<char> m_nesting; 162 163 bool m_print_original_text; 164 165 // Current indentation. 166 int m_curr_print_indent_level; 167 168 // TRUE means we are at the beginning of a line. 169 bool m_beginning_of_line; 170 171 // Nonzero means we are not printing newlines and indenting. 172 int m_suppress_newlines; 173 reset_indent_level(void)174 void reset_indent_level (void) { m_curr_print_indent_level = 0; } 175 increment_indent_level(void)176 void increment_indent_level (void) { m_curr_print_indent_level += 2; } 177 decrement_indent_level(void)178 void decrement_indent_level (void) { m_curr_print_indent_level -= 2; } 179 180 void newline (const char *alt_txt = ", "); 181 182 void indent (void); 183 184 void reset (void); 185 186 void print_parens (const tree_expression& expr, const char *txt); 187 188 void print_comment_list (comment_list *comment_list); 189 190 void print_comment_elt (const comment_elt& comment_elt); 191 192 void print_indented_comment (comment_list *comment_list); 193 194 // Must create with an output stream! 195 196 tree_print_code (void); 197 }; 198 } 199 200 #endif 201