GNU Octave  4.0.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
pt-pr-code.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1996-2015 John W. Eaton
4 
5 This file is part of Octave.
6 
7 Octave is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
11 
12 Octave is distributed in the hope that it will be useful, but WITHOUT
13 ANY 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 Octave; see the file COPYING. If not, see
19 <http://www.gnu.org/licenses/>.
20 
21 */
22 
23 #if !defined (octave_pt_pr_code_h)
24 #define octave_pt_pr_code_h 1
25 
26 #include <stack>
27 #include <string>
28 
29 #include "comment-list.h"
30 #include "pt-walk.h"
31 
32 class tree_decl_command;
33 class tree_expression;
34 
35 // How to print the code that the parse trees represent.
36 
37 class
39 {
40 public:
41 
42  tree_print_code (std::ostream& os_arg,
43  const std::string& pfx = std::string (),
44  bool pr_orig_txt = true)
45  : os (os_arg), prefix (pfx), nesting (),
46  print_original_text (pr_orig_txt),
47  curr_print_indent_level (0), beginning_of_line (true),
48  suppress_newlines (0)
49  {
50  // For "none".
51  nesting.push ('n');
52  }
53 
54  ~tree_print_code (void) { }
55 
56  void visit_anon_fcn_handle (tree_anon_fcn_handle&);
57 
58  void visit_argument_list (tree_argument_list&);
59 
60  void visit_binary_expression (tree_binary_expression&);
61 
62  void visit_break_command (tree_break_command&);
63 
64  void visit_colon_expression (tree_colon_expression&);
65 
66  void visit_continue_command (tree_continue_command&);
67 
68  void visit_global_command (tree_global_command&);
69 
70  void visit_persistent_command (tree_persistent_command&);
71 
72  void visit_decl_elt (tree_decl_elt&);
73 
74  void visit_decl_init_list (tree_decl_init_list&);
75 
76  void visit_simple_for_command (tree_simple_for_command&);
77 
78  void visit_complex_for_command (tree_complex_for_command&);
79 
80  void visit_octave_user_script (octave_user_script&);
81 
82  void visit_octave_user_function (octave_user_function&);
83 
84  void visit_octave_user_function_header (octave_user_function&);
85 
86  void visit_octave_user_function_trailer (octave_user_function&);
87 
88  void visit_function_def (tree_function_def&);
89 
90  void visit_identifier (tree_identifier&);
91 
92  void visit_if_clause (tree_if_clause&);
93 
94  void visit_if_command (tree_if_command&);
95 
96  void visit_if_command_list (tree_if_command_list&);
97 
98  void visit_index_expression (tree_index_expression&);
99 
100  void visit_matrix (tree_matrix&);
101 
102  void visit_cell (tree_cell&);
103 
104  void visit_multi_assignment (tree_multi_assignment&);
105 
106  void visit_no_op_command (tree_no_op_command&);
107 
108  void visit_constant (tree_constant&);
109 
110  void visit_fcn_handle (tree_fcn_handle&);
111 
112  void visit_funcall (tree_funcall&);
113 
114  void visit_parameter_list (tree_parameter_list&);
115 
116  void visit_postfix_expression (tree_postfix_expression&);
117 
118  void visit_prefix_expression (tree_prefix_expression&);
119 
120  void visit_return_command (tree_return_command&);
121 
122  void visit_return_list (tree_return_list&);
123 
124  void visit_simple_assignment (tree_simple_assignment&);
125 
126  void visit_statement (tree_statement&);
127 
128  void visit_statement_list (tree_statement_list&);
129 
130  void visit_switch_case (tree_switch_case&);
131 
132  void visit_switch_case_list (tree_switch_case_list&);
133 
134  void visit_switch_command (tree_switch_command&);
135 
136  void visit_try_catch_command (tree_try_catch_command&);
137 
138  void visit_unwind_protect_command (tree_unwind_protect_command&);
139 
140  void visit_while_command (tree_while_command&);
141 
142  void visit_do_until_command (tree_do_until_command&);
143 
144  void print_fcn_handle_body (tree_statement_list *);
145 
146 private:
147 
148  std::ostream& os;
149 
150  std::string prefix;
151 
152  std::stack<char> nesting;
153 
155 
156  // Current indentation.
158 
159  // TRUE means we are at the beginning of a line.
161 
162  // Nonzero means we are not printing newlines and indenting.
164 
165  void do_decl_command (tree_decl_command& cmd);
166 
167  void reset_indent_level (void) { curr_print_indent_level = 0; }
168 
169  void increment_indent_level (void) { curr_print_indent_level += 2; }
170 
171  void decrement_indent_level (void) { curr_print_indent_level -= 2; }
172 
173  void newline (const char *alt_txt = ", ");
174 
175  void indent (void);
176 
177  void reset (void);
178 
179  void print_parens (const tree_expression& expr, const char *txt);
180 
181  void print_comment_list (octave_comment_list *comment_list);
182 
183  void print_comment_elt (const octave_comment_elt& comment_elt);
184 
185  void print_indented_comment (octave_comment_list *comment_list);
186 
187  // Must create with an output stream!
188 
189  tree_print_code (void);
190 
191  // No copying!
192 
194 
196 };
197 
198 #endif
void decrement_indent_level(void)
Definition: pt-pr-code.h:171
bool print_original_text
Definition: pt-pr-code.h:154
bool beginning_of_line
Definition: pt-pr-code.h:160
void increment_indent_level(void)
Definition: pt-pr-code.h:169
tree_expression & operator=(const tree_expression &)
std::ostream & os
Definition: pt-pr-code.h:148
~tree_print_code(void)
Definition: pt-pr-code.h:54
void reset_indent_level(void)
Definition: pt-pr-code.h:167
std::stack< char > nesting
Definition: pt-pr-code.h:152
tree_print_code(std::ostream &os_arg, const std::string &pfx=std::string(), bool pr_orig_txt=true)
Definition: pt-pr-code.h:42
std::string prefix
Definition: pt-pr-code.h:150
int curr_print_indent_level
Definition: pt-pr-code.h:157