Mercurial > octave
annotate liboctave/util/cmd-edit.h @ 17744:d63878346099
maint: Update copyright notices for release.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 23 Oct 2013 22:09:27 -0400 |
parents | d5ae5aa80d42 |
children | 49a5a4be04a1 |
rev | line source |
---|---|
2926 | 1 /* |
2 | |
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
16570
diff
changeset
|
3 Copyright (C) 1996-2013 John W. Eaton |
2926 | 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 | |
7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
10 option) any later version. | |
2926 | 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 | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
19 <http://www.gnu.org/licenses/>. | |
2926 | 20 |
21 */ | |
22 | |
23 #if !defined (octave_cmd_edit_h) | |
24 #define octave_cmd_edit_h 1 | |
25 | |
26 #include <cstdio> | |
27 | |
6913 | 28 #include <set> |
2926 | 29 #include <string> |
30 | |
4604 | 31 #include "str-vec.h" |
32 | |
2926 | 33 class |
6108 | 34 OCTAVE_API |
2926 | 35 command_editor |
36 { | |
37 protected: | |
38 | |
39 command_editor (void) | |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
40 : command_number (0), interrupted (false), initial_input () { } |
2926 | 41 |
42 public: | |
43 | |
4802 | 44 typedef int (*startup_hook_fcn) (void); |
3519 | 45 |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
46 typedef int (*pre_input_hook_fcn) (void); |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
47 |
4802 | 48 typedef int (*event_hook_fcn) (void); |
2926 | 49 |
3504 | 50 typedef std::string (*completion_fcn) (const std::string&, int); |
2941 | 51 |
6979 | 52 typedef std::string (*quoting_fcn) (const std::string&, int, char); |
53 | |
54 typedef std::string (*dequoting_fcn) (const std::string&, int); | |
55 | |
56 typedef int (*char_is_quoted_fcn) (const std::string&, int); | |
57 | |
58 typedef void (*user_accept_line_fcn) (const std::string&); | |
59 | |
2926 | 60 virtual ~command_editor (void) { } |
61 | |
3504 | 62 static void set_name (const std::string& n); |
2926 | 63 |
3504 | 64 static std::string readline (const std::string& prompt); |
2926 | 65 |
3504 | 66 static std::string readline (const std::string& prompt, bool& eof); |
3219 | 67 |
2926 | 68 static void set_input_stream (FILE *f); |
69 | |
70 static FILE *get_input_stream (void); | |
71 | |
72 static void set_output_stream (FILE *f); | |
73 | |
74 static FILE *get_output_stream (void); | |
75 | |
16539
8ea8df0747e9
make undo button and menu item work for command window
John W. Eaton <jwe@octave.org>
parents:
16537
diff
changeset
|
76 static void redisplay (void); |
8ea8df0747e9
make undo button and menu item work for command window
John W. Eaton <jwe@octave.org>
parents:
16537
diff
changeset
|
77 |
2926 | 78 static int terminal_rows (void); |
79 | |
80 static int terminal_cols (void); | |
81 | |
16537
106a38d7b396
optionall disable redisplay in command editor clear screen function
John W. Eaton <jwe@octave.org>
parents:
16534
diff
changeset
|
82 static void clear_screen (bool skip_redisplay = false); |
2926 | 83 |
3281 | 84 static void resize_terminal (void); |
85 | |
3504 | 86 static std::string decode_prompt_string (const std::string& s); |
2926 | 87 |
88 static void restore_terminal_state (void); | |
89 | |
90 static void blink_matching_paren (bool flag); | |
91 | |
4055 | 92 static void set_basic_word_break_characters (const std::string& s); |
3933 | 93 |
4055 | 94 static void set_completer_word_break_characters (const std::string& s); |
3933 | 95 |
3504 | 96 static void set_basic_quote_characters (const std::string& s); |
2926 | 97 |
6979 | 98 static void set_filename_quote_characters (const std::string& s); |
99 | |
100 static void set_completer_quote_characters (const std::string& s); | |
101 | |
2926 | 102 static void set_completion_append_character (char c); |
103 | |
2941 | 104 static void set_completion_function (completion_fcn f); |
105 | |
6979 | 106 static void set_quoting_function (quoting_fcn f); |
107 | |
108 static void set_dequoting_function (dequoting_fcn f); | |
109 | |
110 static void set_char_is_quoted_function (char_is_quoted_fcn f); | |
111 | |
112 static void set_user_accept_line_function (user_accept_line_fcn f); | |
113 | |
2941 | 114 static completion_fcn get_completion_function (void); |
2926 | 115 |
6979 | 116 static quoting_fcn get_quoting_function (void); |
117 | |
118 static dequoting_fcn get_dequoting_function (void); | |
119 | |
120 static char_is_quoted_fcn get_char_is_quoted_function (void); | |
121 | |
122 static user_accept_line_fcn get_user_accept_line_function (void); | |
123 | |
4604 | 124 static string_vector generate_filename_completions (const std::string& text); |
125 | |
9485
3cee58bf4acf
selectively complete filenames in some cases
John W. Eaton <jwe@octave.org>
parents:
9321
diff
changeset
|
126 static std::string get_line_buffer (void); |
3cee58bf4acf
selectively complete filenames in some cases
John W. Eaton <jwe@octave.org>
parents:
9321
diff
changeset
|
127 |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
128 static std::string get_current_line (void); |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
129 |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
130 static void replace_line (const std::string& text, bool clear_undo = true); |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
131 |
3504 | 132 static void insert_text (const std::string& text); |
2926 | 133 |
134 static void newline (void); | |
135 | |
6979 | 136 static void accept_line (void); |
137 | |
16539
8ea8df0747e9
make undo button and menu item work for command window
John W. Eaton <jwe@octave.org>
parents:
16537
diff
changeset
|
138 static bool undo (void); |
8ea8df0747e9
make undo button and menu item work for command window
John W. Eaton <jwe@octave.org>
parents:
16537
diff
changeset
|
139 |
2926 | 140 static void clear_undo_list (void); |
141 | |
6913 | 142 static void add_startup_hook (startup_hook_fcn f); |
2926 | 143 |
6913 | 144 static void remove_startup_hook (startup_hook_fcn f); |
2926 | 145 |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
146 static void add_pre_input_hook (pre_input_hook_fcn f); |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
147 |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
148 static void remove_pre_input_hook (pre_input_hook_fcn f); |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
149 |
6913 | 150 static void add_event_hook (event_hook_fcn f); |
3215 | 151 |
6913 | 152 static void remove_event_hook (event_hook_fcn f); |
3215 | 153 |
13924
3b654a0753b1
Implement waitfor, uiwait and uiresume.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
11586
diff
changeset
|
154 static void run_event_hooks (void); |
3b654a0753b1
Implement waitfor, uiwait and uiresume.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
11586
diff
changeset
|
155 |
3504 | 156 static void read_init_file (const std::string& file = std::string ()); |
3189 | 157 |
7758
8e14a01ffe9f
input.cc (Fre_read_readline_init_file): new function
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
158 static void re_read_init_file (void); |
8e14a01ffe9f
input.cc (Fre_read_readline_init_file): new function
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
159 |
4143 | 160 static bool filename_completion_desired (bool); |
161 | |
6979 | 162 static bool filename_quoting_desired (bool); |
163 | |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
164 static bool interrupt (bool = true); |
16382
389b09a914e2
allow gui to force readline to return from its idle/read loop
John W. Eaton <jwe@octave.org>
parents:
15271
diff
changeset
|
165 |
2926 | 166 static int current_command_number (void); |
167 | |
168 static void reset_current_command_number (int n); | |
169 | |
2967 | 170 static void increment_current_command_number (void); |
171 | |
9321
9b87aeb24ea9
avoid using readline at all when line editing suppressed or interpreter embedded
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
172 static void force_default_editor (void); |
9b87aeb24ea9
avoid using readline at all when line editing suppressed or interpreter embedded
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
173 |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
174 static void set_initial_input (const std::string& text); |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
175 |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
176 static int insert_initial_input (void); |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
177 |
2926 | 178 private: |
179 | |
180 // No copying! | |
181 | |
182 command_editor (const command_editor&); | |
183 | |
184 command_editor& operator = (const command_editor&); | |
185 | |
186 static bool instance_ok (void); | |
187 | |
188 static void make_command_editor (void); | |
189 | |
6913 | 190 static int startup_handler (void); |
191 | |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
192 static int pre_input_handler (void); |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
193 |
6913 | 194 static int event_handler (void); |
195 | |
196 static std::set<startup_hook_fcn> startup_hook_set; | |
197 | |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
198 static std::set<pre_input_hook_fcn> pre_input_hook_set; |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
199 |
6913 | 200 static std::set<event_hook_fcn> event_hook_set; |
201 | |
202 typedef std::set<startup_hook_fcn>::iterator startup_hook_set_iterator; | |
203 typedef std::set<startup_hook_fcn>::const_iterator startup_hook_set_const_iterator; | |
204 | |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
205 typedef std::set<pre_input_hook_fcn>::iterator pre_input_hook_set_iterator; |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
206 typedef std::set<pre_input_hook_fcn>::const_iterator pre_input_hook_set_const_iterator; |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
207 |
6913 | 208 typedef std::set<event_hook_fcn>::iterator event_hook_set_iterator; |
209 typedef std::set<event_hook_fcn>::const_iterator event_hook_set_const_iterator; | |
210 | |
2926 | 211 // The real thing. |
212 static command_editor *instance; | |
213 | |
13983
7dd7cccf0757
clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents:
13924
diff
changeset
|
214 static void cleanup_instance (void) { delete instance; instance = 0; } |
7dd7cccf0757
clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents:
13924
diff
changeset
|
215 |
2926 | 216 protected: |
217 | |
218 // To use something other than the GNU readline library, derive a new | |
219 // class from command_editor, overload these functions as | |
220 // necessary, and make instance point to the new class. | |
221 | |
3504 | 222 virtual void do_set_name (const std::string&) { } |
2926 | 223 |
3504 | 224 std::string do_readline (const std::string& prompt) |
3219 | 225 { |
226 bool eof; | |
227 | |
228 return do_readline (prompt, eof); | |
229 } | |
230 | |
3504 | 231 virtual std::string do_readline (const std::string&, bool&) = 0; |
2926 | 232 |
233 virtual void do_set_input_stream (FILE *) = 0; | |
234 | |
235 virtual FILE *do_get_input_stream (void) = 0; | |
236 | |
237 virtual void do_set_output_stream (FILE *) = 0; | |
238 | |
239 virtual FILE *do_get_output_stream (void) = 0; | |
240 | |
16539
8ea8df0747e9
make undo button and menu item work for command window
John W. Eaton <jwe@octave.org>
parents:
16537
diff
changeset
|
241 virtual void do_redisplay (void) { } |
8ea8df0747e9
make undo button and menu item work for command window
John W. Eaton <jwe@octave.org>
parents:
16537
diff
changeset
|
242 |
2926 | 243 virtual int do_terminal_rows (void) { return 24; } |
244 | |
245 virtual int do_terminal_cols (void) { return 80; } | |
246 | |
16537
106a38d7b396
optionall disable redisplay in command editor clear screen function
John W. Eaton <jwe@octave.org>
parents:
16534
diff
changeset
|
247 virtual void do_clear_screen (bool) { } |
2926 | 248 |
3281 | 249 virtual void do_resize_terminal (void) { } |
250 | |
3504 | 251 virtual std::string do_decode_prompt_string (const std::string&); |
2926 | 252 |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
253 virtual std::string newline_chars (void) { return "\n"; } |
2926 | 254 |
255 virtual void do_restore_terminal_state (void) { } | |
256 | |
257 virtual void do_blink_matching_paren (bool) { } | |
258 | |
3933 | 259 virtual void do_set_basic_word_break_characters (const std::string&) { } |
260 | |
261 virtual void do_set_completer_word_break_characters (const std::string&) { } | |
262 | |
3504 | 263 virtual void do_set_basic_quote_characters (const std::string&) { } |
2926 | 264 |
6979 | 265 virtual void do_set_filename_quote_characters (const std::string&) { } |
266 | |
267 virtual void do_set_completer_quote_characters (const std::string&) { } | |
268 | |
2926 | 269 virtual void do_set_completion_append_character (char) { } |
270 | |
2941 | 271 virtual void do_set_completion_function (completion_fcn) { } |
272 | |
6979 | 273 virtual void do_set_quoting_function (quoting_fcn) { } |
274 | |
275 virtual void do_set_dequoting_function (dequoting_fcn) { } | |
276 | |
277 virtual void do_set_char_is_quoted_function (char_is_quoted_fcn) { } | |
278 | |
279 virtual void do_set_user_accept_line_function (user_accept_line_fcn) { } | |
280 | |
2941 | 281 virtual completion_fcn do_get_completion_function (void) const { return 0; } |
2926 | 282 |
6979 | 283 virtual quoting_fcn do_get_quoting_function (void) const { return 0; } |
284 | |
285 virtual dequoting_fcn do_get_dequoting_function (void) const { return 0; } | |
286 | |
287 virtual char_is_quoted_fcn do_get_char_is_quoted_function (void) const { return 0; } | |
288 | |
289 virtual user_accept_line_fcn do_get_user_accept_line_function (void) const { return 0; } | |
290 | |
4604 | 291 virtual string_vector do_generate_filename_completions (const std::string& text) = 0; |
292 | |
9485
3cee58bf4acf
selectively complete filenames in some cases
John W. Eaton <jwe@octave.org>
parents:
9321
diff
changeset
|
293 virtual std::string do_get_line_buffer (void) const = 0; |
3cee58bf4acf
selectively complete filenames in some cases
John W. Eaton <jwe@octave.org>
parents:
9321
diff
changeset
|
294 |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
295 virtual std::string do_get_current_line (void) const = 0; |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
296 |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
297 virtual void do_replace_line (const std::string& text, bool clear_undo) = 0; |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
298 |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
299 virtual void do_insert_text (const std::string& text) = 0; |
2926 | 300 |
301 virtual void do_newline (void) = 0; | |
302 | |
6979 | 303 virtual void do_accept_line (void) = 0; |
304 | |
16539
8ea8df0747e9
make undo button and menu item work for command window
John W. Eaton <jwe@octave.org>
parents:
16537
diff
changeset
|
305 virtual bool do_undo (void) { return false; } |
8ea8df0747e9
make undo button and menu item work for command window
John W. Eaton <jwe@octave.org>
parents:
16537
diff
changeset
|
306 |
2926 | 307 virtual void do_clear_undo_list (void) { } |
308 | |
6913 | 309 virtual void set_startup_hook (startup_hook_fcn) { } |
2926 | 310 |
6913 | 311 virtual void restore_startup_hook (void) { } |
2926 | 312 |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
313 virtual void set_pre_input_hook (pre_input_hook_fcn) { } |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
314 |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
315 virtual void restore_pre_input_hook (void) { } |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
316 |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
317 virtual void set_event_hook (event_hook_fcn) { } |
3215 | 318 |
6913 | 319 virtual void restore_event_hook (void) { } |
3215 | 320 |
3504 | 321 virtual void do_read_init_file (const std::string&) { } |
3189 | 322 |
7758
8e14a01ffe9f
input.cc (Fre_read_readline_init_file): new function
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
323 virtual void do_re_read_init_file (void) { } |
8e14a01ffe9f
input.cc (Fre_read_readline_init_file): new function
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
324 |
4143 | 325 virtual bool do_filename_completion_desired (bool) { return false; } |
326 | |
6979 | 327 virtual bool do_filename_quoting_desired (bool) { return false; } |
328 | |
16382
389b09a914e2
allow gui to force readline to return from its idle/read loop
John W. Eaton <jwe@octave.org>
parents:
15271
diff
changeset
|
329 virtual void do_interrupt (bool) { } |
389b09a914e2
allow gui to force readline to return from its idle/read loop
John W. Eaton <jwe@octave.org>
parents:
15271
diff
changeset
|
330 |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
331 int do_insert_initial_input (void); |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
332 |
3504 | 333 int read_octal (const std::string& s); |
2926 | 334 |
335 void error (int); | |
336 | |
3504 | 337 void error (const std::string&); |
2926 | 338 |
339 // The current command number. | |
340 int command_number; | |
16382
389b09a914e2
allow gui to force readline to return from its idle/read loop
John W. Eaton <jwe@octave.org>
parents:
15271
diff
changeset
|
341 |
389b09a914e2
allow gui to force readline to return from its idle/read loop
John W. Eaton <jwe@octave.org>
parents:
15271
diff
changeset
|
342 bool interrupted; |
16570
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
343 |
d5ae5aa80d42
preserve pending command line input when running commands from GUI actions
John W. Eaton <jwe@octave.org>
parents:
16539
diff
changeset
|
344 std::string initial_input; |
2926 | 345 }; |
346 | |
347 #endif |