|
1
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
1
|
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 2, or (at your option) any |
|
|
10 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, write to the Free |
|
1315
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
1
|
20 |
|
|
21 */ |
|
|
22 |
|
2939
|
23 // Get command input interactively or from files. |
|
1
|
24 |
|
240
|
25 #ifdef HAVE_CONFIG_H |
|
1192
|
26 #include <config.h> |
|
1
|
27 #endif |
|
|
28 |
|
1343
|
29 #include <cstdio> |
|
|
30 #include <cstdlib> |
|
|
31 #include <cstring> |
|
|
32 #include <cassert> |
|
|
33 |
|
3503
|
34 #include <iostream> |
|
1728
|
35 #include <string> |
|
|
36 |
|
1350
|
37 #ifdef HAVE_UNISTD_H |
|
2442
|
38 #ifdef HAVE_SYS_TYPES_H |
|
529
|
39 #include <sys/types.h> |
|
2442
|
40 #endif |
|
529
|
41 #include <unistd.h> |
|
|
42 #endif |
|
1343
|
43 |
|
2927
|
44 #include "cmd-edit.h" |
|
3189
|
45 #include "file-ops.h" |
|
1755
|
46 #include "str-vec.h" |
|
|
47 |
|
1352
|
48 #include "defun.h" |
|
|
49 #include "dirfns.h" |
|
1
|
50 #include "error.h" |
|
2181
|
51 #include "gripes.h" |
|
3016
|
52 #include "help.h" |
|
1
|
53 #include "input.h" |
|
1352
|
54 #include "oct-map.h" |
|
1742
|
55 #include "oct-hist.h" |
|
1670
|
56 #include "toplev.h" |
|
1755
|
57 #include "oct-obj.h" |
|
1
|
58 #include "pager.h" |
|
529
|
59 #include "parse.h" |
|
1352
|
60 #include "pathlen.h" |
|
3772
|
61 #include "pt.h" |
|
1755
|
62 #include "pt-const.h" |
|
3805
|
63 #include "pt-stmt.h" |
|
1352
|
64 #include "sighandlers.h" |
|
|
65 #include "symtab.h" |
|
1114
|
66 #include "sysdep.h" |
|
3098
|
67 #include "unwind-prot.h" |
|
1352
|
68 #include "utils.h" |
|
|
69 #include "variables.h" |
|
529
|
70 |
|
2181
|
71 // Primary prompt string. |
|
3523
|
72 static std::string Vps1; |
|
2181
|
73 |
|
|
74 // Secondary prompt string. |
|
3523
|
75 static std::string Vps2; |
|
2181
|
76 |
|
|
77 // String printed before echoed input (enabled by --echo-input). |
|
3523
|
78 std::string Vps4; |
|
2181
|
79 |
|
3019
|
80 // Echo commands as they are executed? |
|
|
81 // |
|
|
82 // 1 ==> echo commands read from script files |
|
|
83 // 2 ==> echo commands from functions |
|
|
84 // 4 ==> echo commands read from command line |
|
|
85 // |
|
|
86 // more than one state can be active at once. |
|
|
87 int Vecho_executing_commands; |
|
|
88 |
|
3165
|
89 // The time we last printed a prompt. |
|
3255
|
90 octave_time Vlast_prompt_time; |
|
3165
|
91 |
|
2181
|
92 // Character to append after successful command-line completion attempts. |
|
|
93 static char Vcompletion_append_char; |
|
|
94 |
|
1
|
95 // Global pointer for eval(). |
|
3523
|
96 std::string current_eval_string; |
|
1
|
97 |
|
3019
|
98 // TRUE means get input from current_eval_string. |
|
|
99 bool get_input_from_eval_string = false; |
|
1
|
100 |
|
3877
|
101 // TRUE means we haven't been asked for the input from |
|
|
102 // current_eval_string yet. |
|
|
103 bool input_from_eval_string_pending = false; |
|
|
104 |
|
3019
|
105 // TRUE means we're parsing a function file. |
|
|
106 bool reading_fcn_file = false; |
|
1
|
107 |
|
338
|
108 // Simple name of function file we are reading. |
|
3523
|
109 std::string curr_fcn_file_name; |
|
1606
|
110 |
|
|
111 // Full name of file we are reading. |
|
3523
|
112 std::string curr_fcn_file_full_name; |
|
1
|
113 |
|
3019
|
114 // TRUE means we're parsing a script file. |
|
|
115 bool reading_script_file = false; |
|
1
|
116 |
|
|
117 // If we are reading from an M-file, this is it. |
|
529
|
118 FILE *ff_instream = 0; |
|
1
|
119 |
|
3019
|
120 // TRUE means this is an interactive shell. |
|
|
121 bool interactive = false; |
|
1
|
122 |
|
3019
|
123 // TRUE means the user forced this shell to be interactive (-i). |
|
|
124 bool forced_interactive = false; |
|
1
|
125 |
|
|
126 // Should we issue a prompt? |
|
|
127 int promptflag = 1; |
|
|
128 |
|
|
129 // The current line of input, from wherever. |
|
3523
|
130 std::string current_input_line; |
|
1
|
131 |
|
3804
|
132 // TRUE after a call to completion_matches. |
|
2299
|
133 bool octave_completion_matches_called = false; |
|
|
134 |
|
1044
|
135 static void |
|
3523
|
136 do_input_echo (const std::string& input_string) |
|
1044
|
137 { |
|
1588
|
138 int do_echo = reading_script_file ? |
|
2205
|
139 (Vecho_executing_commands & ECHO_SCRIPTS) |
|
2618
|
140 : (Vecho_executing_commands & ECHO_CMD_LINE) && ! forced_interactive; |
|
1588
|
141 |
|
|
142 if (do_echo) |
|
1044
|
143 { |
|
1403
|
144 if (forced_interactive) |
|
|
145 { |
|
1755
|
146 if (promptflag > 0) |
|
2927
|
147 octave_stdout << command_editor::decode_prompt_string (Vps1); |
|
1755
|
148 else |
|
2927
|
149 octave_stdout << command_editor::decode_prompt_string (Vps2); |
|
1403
|
150 } |
|
|
151 else |
|
2927
|
152 octave_stdout << command_editor::decode_prompt_string (Vps4); |
|
1044
|
153 |
|
1755
|
154 if (! input_string.empty ()) |
|
1044
|
155 { |
|
2095
|
156 octave_stdout << input_string; |
|
1755
|
157 |
|
|
158 if (input_string[input_string.length () - 1] != '\n') |
|
2095
|
159 octave_stdout << "\n"; |
|
1044
|
160 } |
|
|
161 } |
|
|
162 } |
|
|
163 |
|
3536
|
164 std::string |
|
3523
|
165 gnu_readline (const std::string& s, bool force_readline) |
|
1822
|
166 { |
|
3523
|
167 std::string retval; |
|
1822
|
168 |
|
2927
|
169 if (line_editing || force_readline) |
|
1822
|
170 { |
|
3219
|
171 bool eof; |
|
1898
|
172 |
|
3219
|
173 retval = command_editor::readline (s, eof); |
|
|
174 |
|
|
175 if (! eof && retval.empty ()) |
|
2927
|
176 retval = "\n"; |
|
1822
|
177 } |
|
|
178 else |
|
|
179 { |
|
2927
|
180 if (! s.empty () && (interactive || forced_interactive)) |
|
2618
|
181 { |
|
2927
|
182 FILE *stream = command_editor::get_output_stream (); |
|
|
183 |
|
|
184 fprintf (stream, s.c_str ()); |
|
|
185 fflush (stream); |
|
2618
|
186 } |
|
1822
|
187 |
|
2927
|
188 FILE *curr_stream = command_editor::get_input_stream (); |
|
|
189 |
|
1822
|
190 if (reading_fcn_file || reading_script_file) |
|
|
191 curr_stream = ff_instream; |
|
|
192 |
|
2927
|
193 retval = octave_fgets (curr_stream); |
|
1822
|
194 } |
|
|
195 |
|
|
196 return retval; |
|
|
197 } |
|
581
|
198 |
|
3536
|
199 static std::string |
|
1
|
200 octave_gets (void) |
|
|
201 { |
|
3523
|
202 std::string retval; |
|
1
|
203 |
|
3255
|
204 Vlast_prompt_time.stamp (); |
|
3165
|
205 |
|
1822
|
206 if ((interactive || forced_interactive) |
|
|
207 && (! (reading_fcn_file || reading_script_file))) |
|
1
|
208 { |
|
3523
|
209 std::string ps = (promptflag > 0) ? Vps1 : Vps2; |
|
1755
|
210 |
|
3523
|
211 std::string prompt = command_editor::decode_prompt_string (ps); |
|
1
|
212 |
|
2618
|
213 pipe_handler_error_count = 0; |
|
|
214 |
|
|
215 flush_octave_stdout (); |
|
1
|
216 |
|
2095
|
217 octave_diary << prompt; |
|
581
|
218 |
|
2927
|
219 retval = gnu_readline (prompt); |
|
1
|
220 } |
|
|
221 else |
|
1822
|
222 retval = gnu_readline (""); |
|
1
|
223 |
|
2927
|
224 current_input_line = retval; |
|
1
|
225 |
|
1822
|
226 if (! current_input_line.empty ()) |
|
1
|
227 { |
|
1799
|
228 if (! input_from_startup_file) |
|
2927
|
229 command_history::add (current_input_line); |
|
1
|
230 |
|
3176
|
231 if (! (reading_fcn_file || reading_script_file)) |
|
|
232 { |
|
|
233 octave_diary << current_input_line; |
|
|
234 |
|
|
235 if (current_input_line[current_input_line.length () - 1] != '\n') |
|
|
236 octave_diary << "\n"; |
|
|
237 } |
|
581
|
238 |
|
1822
|
239 do_input_echo (current_input_line); |
|
1
|
240 } |
|
3176
|
241 else if (! (reading_fcn_file || reading_script_file)) |
|
|
242 octave_diary << "\n"; |
|
581
|
243 |
|
1822
|
244 return retval; |
|
1
|
245 } |
|
|
246 |
|
581
|
247 // Read a line from the input stream. |
|
|
248 |
|
3536
|
249 static std::string |
|
1822
|
250 get_user_input (void) |
|
1
|
251 { |
|
3523
|
252 std::string retval; |
|
1
|
253 |
|
|
254 if (get_input_from_eval_string) |
|
|
255 { |
|
3877
|
256 if (input_from_eval_string_pending) |
|
|
257 { |
|
|
258 input_from_eval_string_pending = false; |
|
|
259 |
|
|
260 retval = current_eval_string; |
|
1822
|
261 |
|
3877
|
262 size_t len = retval.length (); |
|
1822
|
263 |
|
3877
|
264 if (retval[len-1] != '\n') |
|
|
265 retval.append ("\n"); |
|
|
266 } |
|
1822
|
267 } |
|
|
268 else |
|
|
269 retval = octave_gets (); |
|
|
270 |
|
2927
|
271 current_input_line = retval; |
|
1822
|
272 |
|
2114
|
273 if (! get_input_from_eval_string) |
|
|
274 input_line_number++; |
|
1822
|
275 |
|
|
276 return retval; |
|
|
277 } |
|
|
278 |
|
|
279 int |
|
|
280 octave_read (char *buf, unsigned max_size) |
|
|
281 { |
|
2927
|
282 // XXX FIXME XXX -- is this a safe way to buffer the input? |
|
|
283 |
|
3523
|
284 static std::string input_buf; |
|
2927
|
285 static const char *pos = 0; |
|
|
286 static size_t chars_left = 0; |
|
1822
|
287 |
|
|
288 int status = 0; |
|
|
289 |
|
2927
|
290 if (input_buf.empty ()) |
|
1822
|
291 { |
|
2927
|
292 pos = 0; |
|
|
293 |
|
|
294 input_buf = get_user_input (); |
|
1822
|
295 |
|
2927
|
296 chars_left = input_buf.length (); |
|
|
297 |
|
|
298 pos = input_buf.c_str (); |
|
1822
|
299 } |
|
|
300 |
|
|
301 if (chars_left > 0) |
|
|
302 { |
|
|
303 buf[0] = '\0'; |
|
|
304 |
|
2927
|
305 size_t len = max_size > 2 ? max_size - 2 : 0; |
|
1822
|
306 |
|
2927
|
307 assert (len > 0); |
|
|
308 |
|
|
309 strncpy (buf, pos, len); |
|
1822
|
310 |
|
|
311 if (chars_left > len) |
|
1
|
312 { |
|
1822
|
313 chars_left -= len; |
|
|
314 |
|
2927
|
315 pos += len; |
|
1822
|
316 |
|
|
317 buf[len] = '\0'; |
|
|
318 |
|
1
|
319 status = len; |
|
|
320 } |
|
|
321 else |
|
|
322 { |
|
2927
|
323 input_buf = ""; |
|
1755
|
324 |
|
1822
|
325 len = chars_left; |
|
|
326 |
|
|
327 if (buf[len-1] != '\n') |
|
|
328 buf[len++] = '\n'; |
|
1
|
329 |
|
1822
|
330 buf[len] = '\0'; |
|
1755
|
331 |
|
1822
|
332 status = len; |
|
1
|
333 } |
|
1044
|
334 } |
|
1822
|
335 else if (chars_left == 0) |
|
2862
|
336 { |
|
2927
|
337 input_buf = ""; |
|
2862
|
338 |
|
|
339 status = 0; |
|
|
340 } |
|
1822
|
341 else |
|
|
342 status = -1; |
|
1044
|
343 |
|
1
|
344 return status; |
|
|
345 } |
|
|
346 |
|
581
|
347 // Fix things up so that input can come from file `name', printing a |
|
|
348 // warning if the file doesn't exist. |
|
|
349 |
|
1
|
350 FILE * |
|
3523
|
351 get_input_from_file (const std::string& name, int warn) |
|
1
|
352 { |
|
529
|
353 FILE *instream = 0; |
|
1
|
354 |
|
1750
|
355 if (name.length () > 0) |
|
|
356 instream = fopen (name.c_str (), "r"); |
|
1
|
357 |
|
529
|
358 if (! instream && warn) |
|
1750
|
359 warning ("%s: no such file or directory", name.c_str ()); |
|
1
|
360 |
|
338
|
361 if (reading_fcn_file || reading_script_file) |
|
339
|
362 ff_instream = instream; |
|
1
|
363 else |
|
2927
|
364 command_editor::set_input_stream (instream); |
|
1
|
365 |
|
|
366 return instream; |
|
|
367 } |
|
|
368 |
|
581
|
369 // Fix things up so that input can come from the standard input. This |
|
|
370 // may need to become much more complicated, which is why it's in a |
|
|
371 // separate function. |
|
|
372 |
|
1
|
373 FILE * |
|
|
374 get_input_from_stdin (void) |
|
|
375 { |
|
2927
|
376 command_editor::set_input_stream (stdin); |
|
|
377 return command_editor::get_input_stream (); |
|
1
|
378 } |
|
|
379 |
|
2921
|
380 // XXX FIXME XXX -- make this generate file names when appropriate. |
|
|
381 |
|
2247
|
382 static string_vector |
|
3523
|
383 generate_possible_completions (const std::string& text, std::string& prefix, |
|
|
384 std::string& hint) |
|
1280
|
385 { |
|
2247
|
386 string_vector names; |
|
1280
|
387 |
|
2921
|
388 prefix = ""; |
|
1280
|
389 |
|
2921
|
390 if (! text.empty () && text != "." && text.rfind ('.') != NPOS) |
|
1430
|
391 names = generate_struct_completions (text, prefix, hint); |
|
|
392 else |
|
2247
|
393 names = make_name_list (); |
|
1280
|
394 |
|
2944
|
395 // Sort and remove duplicates. |
|
2348
|
396 |
|
2944
|
397 names.qsort (true); |
|
2348
|
398 |
|
1280
|
399 return names; |
|
|
400 } |
|
|
401 |
|
3536
|
402 static std::string |
|
3523
|
403 generate_completion (const std::string& text, int state) |
|
1280
|
404 { |
|
3523
|
405 std::string retval; |
|
2944
|
406 |
|
3523
|
407 static std::string prefix; |
|
|
408 static std::string hint; |
|
1280
|
409 |
|
2921
|
410 static size_t prefix_len = 0; |
|
|
411 static size_t hint_len = 0; |
|
1280
|
412 |
|
1
|
413 static int list_index = 0; |
|
2921
|
414 static int name_list_len = 0; |
|
2247
|
415 static string_vector name_list; |
|
1
|
416 |
|
1280
|
417 static int matches = 0; |
|
1
|
418 |
|
|
419 if (state == 0) |
|
|
420 { |
|
|
421 list_index = 0; |
|
|
422 |
|
2921
|
423 prefix = ""; |
|
1280
|
424 |
|
2921
|
425 hint = text; |
|
1280
|
426 |
|
|
427 name_list = generate_possible_completions (text, prefix, hint); |
|
|
428 |
|
2921
|
429 name_list_len = name_list.length (); |
|
|
430 |
|
|
431 prefix_len = prefix.length (); |
|
1280
|
432 |
|
2921
|
433 hint_len = hint.length (); |
|
1280
|
434 |
|
|
435 matches = 0; |
|
2247
|
436 |
|
2921
|
437 for (int i = 0; i < name_list_len; i++) |
|
3565
|
438 if (hint == name_list[i].substr (0, hint_len)) |
|
2247
|
439 matches++; |
|
1
|
440 } |
|
|
441 |
|
2921
|
442 if (name_list_len > 0 && matches > 0) |
|
1
|
443 { |
|
2921
|
444 while (list_index < name_list_len) |
|
244
|
445 { |
|
3523
|
446 std::string name = name_list[list_index]; |
|
2247
|
447 |
|
1280
|
448 list_index++; |
|
2247
|
449 |
|
3565
|
450 if (hint == name.substr (0, hint_len)) |
|
1280
|
451 { |
|
2944
|
452 if (! prefix.empty ()) |
|
|
453 retval = prefix + "." + name; |
|
|
454 else |
|
|
455 retval = name; |
|
1280
|
456 |
|
2944
|
457 if (matches == 1 && looks_like_struct (retval)) |
|
2927
|
458 command_editor::set_completion_append_character ('.'); |
|
1280
|
459 else |
|
2927
|
460 command_editor::set_completion_append_character |
|
|
461 (Vcompletion_append_char); |
|
1280
|
462 |
|
2944
|
463 break; |
|
1280
|
464 } |
|
244
|
465 } |
|
1
|
466 } |
|
|
467 |
|
2944
|
468 return retval; |
|
1
|
469 } |
|
|
470 |
|
2927
|
471 void |
|
|
472 initialize_command_input (void) |
|
|
473 { |
|
|
474 // If we are using readline, this allows conditional parsing of the |
|
|
475 // .inputrc file. |
|
269
|
476 |
|
2927
|
477 command_editor::set_name ("Octave"); |
|
1358
|
478 |
|
3933
|
479 // XX FIXME XXX -- this needs to include a comma too, but that |
|
|
480 // causes trouble for the new struct element completion code. |
|
|
481 |
|
|
482 static char *s = "\t\n !\"\'*+-/:;<=>[\\]^`~"; |
|
|
483 |
|
|
484 command_editor::set_basic_word_break_characters (s); |
|
|
485 |
|
|
486 command_editor::set_completer_word_break_characters (s); |
|
|
487 |
|
3004
|
488 command_editor::set_basic_quote_characters ("\""); |
|
2944
|
489 |
|
|
490 command_editor::set_completion_function (generate_completion); |
|
269
|
491 } |
|
|
492 |
|
2927
|
493 static bool |
|
3523
|
494 match_sans_spaces (const std::string& standard, const std::string& test) |
|
269
|
495 { |
|
3180
|
496 size_t beg = test.find_first_not_of (" \t"); |
|
|
497 |
|
|
498 if (beg != NPOS) |
|
|
499 { |
|
|
500 size_t end = test.find_last_not_of (" \t"); |
|
269
|
501 |
|
3180
|
502 size_t len = end == NPOS ? NPOS : end - beg + 1; |
|
1
|
503 |
|
3484
|
504 return (test.substr (beg, len) == standard); |
|
3180
|
505 } |
|
|
506 |
|
|
507 return false; |
|
529
|
508 } |
|
|
509 |
|
581
|
510 // If the user simply hits return, this will produce an empty matrix. |
|
|
511 |
|
2086
|
512 static octave_value_list |
|
3100
|
513 get_user_input (const octave_value_list& args, bool debug, int nargout) |
|
529
|
514 { |
|
3100
|
515 octave_value_list retval; |
|
529
|
516 |
|
|
517 int nargin = args.length (); |
|
|
518 |
|
|
519 int read_as_string = 0; |
|
|
520 |
|
712
|
521 if (nargin == 2) |
|
529
|
522 read_as_string++; |
|
|
523 |
|
3523
|
524 std::string prompt ("debug> "); |
|
1761
|
525 |
|
712
|
526 if (nargin > 0) |
|
3707
|
527 { |
|
|
528 prompt = args(0).string_value (); |
|
636
|
529 |
|
3707
|
530 if (error_state) |
|
|
531 { |
|
|
532 error ("input: unrecognized argument"); |
|
|
533 return retval; |
|
|
534 } |
|
529
|
535 } |
|
|
536 |
|
|
537 again: |
|
|
538 |
|
2095
|
539 flush_octave_stdout (); |
|
529
|
540 |
|
3523
|
541 std::string input_buf = gnu_readline (prompt.c_str (), true); |
|
529
|
542 |
|
2927
|
543 if (! input_buf.empty ()) |
|
529
|
544 { |
|
1799
|
545 if (! input_from_startup_file) |
|
2927
|
546 command_history::add (input_buf); |
|
529
|
547 |
|
2927
|
548 size_t len = input_buf.length (); |
|
529
|
549 |
|
|
550 if (len < 1) |
|
|
551 { |
|
|
552 if (debug) |
|
|
553 goto again; |
|
|
554 else |
|
963
|
555 { |
|
|
556 if (read_as_string) |
|
|
557 return ""; |
|
|
558 else |
|
|
559 return Matrix (); |
|
|
560 } |
|
529
|
561 } |
|
|
562 |
|
3772
|
563 if (debug) |
|
|
564 { |
|
|
565 if (match_sans_spaces ("exit", input_buf) |
|
3180
|
566 || match_sans_spaces ("quit", input_buf) |
|
3772
|
567 || match_sans_spaces ("return", input_buf) |
|
|
568 || match_sans_spaces ("dbg_cont", input_buf)) |
|
|
569 { |
|
|
570 return retval; |
|
|
571 } |
|
|
572 else if (match_sans_spaces ("dbg_step", input_buf)) |
|
|
573 { |
|
|
574 tree::break_next = true; |
|
3805
|
575 |
|
|
576 tree::last_line = 0; |
|
|
577 |
|
|
578 tree::break_function = curr_function; |
|
|
579 |
|
|
580 return retval; |
|
|
581 } |
|
|
582 else if (match_sans_spaces ("dbg_next", input_buf)) |
|
|
583 { |
|
|
584 tree::break_next = true; |
|
|
585 |
|
|
586 tree::last_line = curr_statement->line (); |
|
|
587 |
|
|
588 tree::break_function = curr_function; |
|
|
589 |
|
3772
|
590 return retval; |
|
|
591 } |
|
963
|
592 } |
|
3772
|
593 |
|
|
594 if (read_as_string) |
|
963
|
595 { |
|
3081
|
596 // XXX FIXME XXX -- fix gnu_readline and octave_gets instead! |
|
|
597 if (input_buf.length () == 1 && input_buf[0] == '\n') |
|
3100
|
598 retval(0) = ""; |
|
3081
|
599 else |
|
3100
|
600 retval(0) = input_buf; |
|
963
|
601 } |
|
529
|
602 else |
|
|
603 { |
|
|
604 int parse_status = 0; |
|
2900
|
605 |
|
3100
|
606 bool silent = ! debug; |
|
2900
|
607 |
|
3100
|
608 retval = eval_string (input_buf, silent, parse_status, nargout); |
|
|
609 |
|
3215
|
610 if (! debug && retval.length () == 0) |
|
3100
|
611 retval(0) = Matrix (); |
|
529
|
612 } |
|
|
613 } |
|
|
614 else |
|
|
615 error ("input: reading user-input failed!"); |
|
|
616 |
|
|
617 if (debug) |
|
3098
|
618 { |
|
|
619 // Clear error_state so that if errors were encountered while |
|
|
620 // evaluating user input, extra error messages will not be |
|
|
621 // printed after we return. |
|
|
622 |
|
|
623 error_state = 0; |
|
|
624 |
|
3100
|
625 retval = octave_value_list (); |
|
3098
|
626 |
|
|
627 goto again; |
|
|
628 } |
|
529
|
629 |
|
|
630 return retval; |
|
|
631 } |
|
|
632 |
|
3100
|
633 DEFUN (input, args, nargout, |
|
3372
|
634 "-*- texinfo -*-\n\ |
|
|
635 @deftypefn {Built-in Function} {} input (@var{prompt})\n\ |
|
|
636 @deftypefnx {Built-in Function} {} input (@var{prompt}, \"s\")\n\ |
|
|
637 Print a prompt and wait for user input. For example,\n\ |
|
|
638 \n\ |
|
|
639 @example\n\ |
|
|
640 input (\"Pick a number, any number! \")\n\ |
|
|
641 @end example\n\ |
|
|
642 \n\ |
|
|
643 @noindent\n\ |
|
|
644 prints the prompt\n\ |
|
|
645 \n\ |
|
|
646 @example\n\ |
|
|
647 Pick a number, any number!\n\ |
|
|
648 @end example\n\ |
|
529
|
649 \n\ |
|
3372
|
650 @noindent\n\ |
|
|
651 and waits for the user to enter a value. The string entered by the user\n\ |
|
|
652 is evaluated as an expression, so it may be a literal constant, a\n\ |
|
|
653 variable name, or any other valid expression.\n\ |
|
|
654 \n\ |
|
|
655 Currently, @code{input} only returns one value, regardless of the number\n\ |
|
|
656 of values produced by the evaluation of the expression.\n\ |
|
|
657 \n\ |
|
|
658 If you are only interested in getting a literal string value, you can\n\ |
|
|
659 call @code{input} with the character string @code{\"s\"} as the second\n\ |
|
|
660 argument. This tells Octave to return the string entered by the user\n\ |
|
|
661 directly, without evaluating it first.\n\ |
|
|
662 \n\ |
|
|
663 Because there may be output waiting to be displayed by the pager, it is\n\ |
|
|
664 a good idea to always call @code{fflush (stdout)} before calling\n\ |
|
|
665 @code{input}. This will ensure that all pending output is written to\n\ |
|
|
666 the screen before your prompt. @xref{Input and Output}.\n\ |
|
|
667 @end deftypefn") |
|
529
|
668 { |
|
2086
|
669 octave_value_list retval; |
|
529
|
670 |
|
|
671 int nargin = args.length (); |
|
|
672 |
|
712
|
673 if (nargin == 1 || nargin == 2) |
|
3100
|
674 retval = get_user_input (args, false, nargout); |
|
529
|
675 else |
|
|
676 print_usage ("input"); |
|
|
677 |
|
|
678 return retval; |
|
|
679 } |
|
|
680 |
|
3098
|
681 static void |
|
|
682 restore_command_history (void *) |
|
|
683 { |
|
|
684 command_history::ignore_entries (! Vsaving_history); |
|
|
685 } |
|
|
686 |
|
3707
|
687 octave_value |
|
|
688 do_keyboard (const octave_value_list& args) |
|
|
689 { |
|
|
690 octave_value retval; |
|
|
691 |
|
|
692 int nargin = args.length (); |
|
|
693 |
|
|
694 assert (nargin == 0 || nargin == 1); |
|
|
695 |
|
|
696 unwind_protect::begin_frame ("do_keyboard"); |
|
|
697 |
|
|
698 // XXX FIXME XXX -- we shouldn't need both the |
|
|
699 // command_history object and the |
|
|
700 // Vsaving_history variable... |
|
|
701 command_history::ignore_entries (false); |
|
|
702 |
|
|
703 unwind_protect::add (restore_command_history, 0); |
|
|
704 |
|
|
705 unwind_protect_bool (Vsaving_history); |
|
|
706 |
|
|
707 Vsaving_history = true; |
|
|
708 |
|
|
709 retval = get_user_input (args, true, 0); |
|
|
710 |
|
|
711 unwind_protect::run_frame ("do_keyboard"); |
|
|
712 |
|
|
713 return retval; |
|
|
714 } |
|
|
715 |
|
1957
|
716 DEFUN (keyboard, args, , |
|
3372
|
717 "-*- texinfo -*-\n\ |
|
|
718 @deftypefn {Built-in Function} {} keyboard (@var{prompt})\n\ |
|
|
719 This function is normally used for simple debugging. When the\n\ |
|
|
720 @code{keyboard} function is executed, Octave prints a prompt and waits\n\ |
|
|
721 for user input. The input strings are then evaluated and the results\n\ |
|
|
722 are printed. This makes it possible to examine the values of variables\n\ |
|
|
723 within a function, and to assign new values to variables. No value is\n\ |
|
|
724 returned from the @code{keyboard} function, and it continues to prompt\n\ |
|
|
725 for input until the user types @samp{quit}, or @samp{exit}.\n\ |
|
529
|
726 \n\ |
|
3372
|
727 If @code{keyboard} is invoked without any arguments, a default prompt of\n\ |
|
|
728 @samp{debug> } is used.\n\ |
|
|
729 @end deftypefn") |
|
529
|
730 { |
|
2086
|
731 octave_value_list retval; |
|
529
|
732 |
|
|
733 int nargin = args.length (); |
|
|
734 |
|
712
|
735 if (nargin == 0 || nargin == 1) |
|
3707
|
736 do_keyboard (args); |
|
529
|
737 else |
|
|
738 print_usage ("keyboard"); |
|
|
739 |
|
|
740 return retval; |
|
|
741 } |
|
|
742 |
|
3741
|
743 DEFUN_TEXT (echo, args, , |
|
3332
|
744 "-*- texinfo -*-\n\ |
|
|
745 @deffn {Command} echo options\n\ |
|
|
746 Control whether commands are displayed as they are executed. Valid\n\ |
|
|
747 options are:\n\ |
|
1588
|
748 \n\ |
|
3332
|
749 @table @code\n\ |
|
|
750 @item on\n\ |
|
|
751 Enable echoing of commands as they are executed in script files.\n\ |
|
|
752 \n\ |
|
|
753 @item off\n\ |
|
|
754 Disable echoing of commands as they are executed in script files.\n\ |
|
1588
|
755 \n\ |
|
3332
|
756 @item on all\n\ |
|
|
757 Enable echoing of commands as they are executed in script files and\n\ |
|
|
758 functions.\n\ |
|
1588
|
759 \n\ |
|
3332
|
760 @item off all\n\ |
|
|
761 Disable echoing of commands as they are executed in script files and\n\ |
|
|
762 functions.\n\ |
|
|
763 @end table\n\ |
|
|
764 \n\ |
|
|
765 @noindent\n\ |
|
|
766 If invoked without any arguments, @code{echo} toggles the current echo\n\ |
|
|
767 state.\n\ |
|
3333
|
768 @end deffn") |
|
1588
|
769 { |
|
2086
|
770 octave_value_list retval; |
|
1588
|
771 |
|
1755
|
772 int argc = args.length () + 1; |
|
|
773 |
|
1968
|
774 string_vector argv = args.make_argv ("echo"); |
|
1755
|
775 |
|
|
776 if (error_state) |
|
|
777 return retval; |
|
1588
|
778 |
|
|
779 switch (argc) |
|
|
780 { |
|
|
781 case 1: |
|
|
782 { |
|
2205
|
783 if ((Vecho_executing_commands & ECHO_SCRIPTS) |
|
|
784 || (Vecho_executing_commands & ECHO_FUNCTIONS)) |
|
2431
|
785 bind_builtin_variable ("echo_executing_commands", |
|
2800
|
786 static_cast<double> (ECHO_OFF)); |
|
1588
|
787 else |
|
2431
|
788 bind_builtin_variable ("echo_executing_commands", |
|
2800
|
789 static_cast<double> (ECHO_SCRIPTS)); |
|
1588
|
790 } |
|
|
791 break; |
|
|
792 |
|
|
793 case 2: |
|
|
794 { |
|
3523
|
795 std::string arg = argv[1]; |
|
1755
|
796 |
|
|
797 if (arg == "on") |
|
2431
|
798 bind_builtin_variable ("echo_executing_commands", |
|
2800
|
799 static_cast<double> (ECHO_SCRIPTS)); |
|
1755
|
800 else if (arg == "off") |
|
2431
|
801 bind_builtin_variable ("echo_executing_commands", |
|
2800
|
802 static_cast<double> (ECHO_OFF)); |
|
1588
|
803 else |
|
|
804 print_usage ("echo"); |
|
|
805 } |
|
|
806 break; |
|
|
807 |
|
|
808 case 3: |
|
|
809 { |
|
3523
|
810 std::string arg = argv[1]; |
|
1755
|
811 |
|
|
812 if (arg == "on" && argv[2] == "all") |
|
2800
|
813 { |
|
|
814 int tmp = (ECHO_SCRIPTS | ECHO_FUNCTIONS); |
|
|
815 bind_builtin_variable ("echo_executing_commands", |
|
|
816 static_cast<double> (tmp)); |
|
|
817 } |
|
1755
|
818 else if (arg == "off" && argv[2] == "all") |
|
2431
|
819 bind_builtin_variable ("echo_executing_commands", |
|
2800
|
820 static_cast<double> (ECHO_OFF)); |
|
1588
|
821 else |
|
|
822 print_usage ("echo"); |
|
|
823 } |
|
|
824 break; |
|
|
825 |
|
|
826 default: |
|
|
827 print_usage ("echo"); |
|
|
828 break; |
|
|
829 } |
|
|
830 |
|
|
831 return retval; |
|
|
832 } |
|
|
833 |
|
2234
|
834 DEFUN (completion_matches, args, nargout, |
|
3332
|
835 "-*- texinfo -*-\n\ |
|
|
836 @deftypefn {Built-in Function} {} completion_matches (@var{hint})\n\ |
|
|
837 Generate possible completions given @var{hint}.\n\ |
|
2299
|
838 \n\ |
|
|
839 This function is provided for the benefit of programs like Emacs which\n\ |
|
3332
|
840 might be controlling Octave and handling user input. The current\n\ |
|
|
841 command number is not incremented when this function is called. This is\n\ |
|
|
842 a feature, not a bug.\n\ |
|
3333
|
843 @end deftypefn") |
|
2234
|
844 { |
|
2281
|
845 octave_value retval; |
|
2234
|
846 |
|
|
847 int nargin = args.length (); |
|
|
848 |
|
|
849 if (nargin == 1) |
|
|
850 { |
|
3523
|
851 std::string hint = args(0).string_value (); |
|
2234
|
852 |
|
|
853 if (! error_state) |
|
|
854 { |
|
|
855 int n = 32; |
|
|
856 |
|
|
857 string_vector list (n); |
|
|
858 |
|
|
859 int k = 0; |
|
|
860 |
|
|
861 for (;;) |
|
|
862 { |
|
3523
|
863 std::string cmd = generate_completion (hint, k); |
|
2234
|
864 |
|
2944
|
865 if (! cmd.empty ()) |
|
2234
|
866 { |
|
2944
|
867 if (k == n) |
|
2234
|
868 { |
|
2944
|
869 n *= 2; |
|
|
870 list.resize (n); |
|
|
871 } |
|
2235
|
872 |
|
2944
|
873 list[k++] = cmd; |
|
2234
|
874 } |
|
|
875 else |
|
|
876 { |
|
|
877 list.resize (k); |
|
|
878 break; |
|
|
879 } |
|
|
880 } |
|
|
881 |
|
|
882 if (nargout > 0) |
|
2281
|
883 { |
|
|
884 if (! list.empty ()) |
|
|
885 retval = list; |
|
2282
|
886 else |
|
|
887 retval = ""; |
|
2281
|
888 } |
|
2234
|
889 else |
|
|
890 { |
|
2235
|
891 // We don't use string_vector::list_in_columns here |
|
|
892 // because it will be easier for Emacs if the names |
|
|
893 // appear in a single column. |
|
|
894 |
|
2234
|
895 int len = list.length (); |
|
|
896 |
|
|
897 for (int i = 0; i < len; i++) |
|
|
898 octave_stdout << list[i] << "\n"; |
|
|
899 } |
|
2299
|
900 |
|
|
901 octave_completion_matches_called = true; |
|
2234
|
902 } |
|
|
903 } |
|
|
904 else |
|
|
905 print_usage ("completion_matches"); |
|
|
906 |
|
|
907 return retval; |
|
|
908 } |
|
|
909 |
|
3189
|
910 DEFUN (read_readline_init_file, args, , |
|
3448
|
911 "-*- texinfo -*-\n\ |
|
|
912 @deftypefn {Built-in Function} {} read_readline_init_file (@var{file})\n\ |
|
|
913 Read the readline library initialiazation file @var{file}. If\n\ |
|
|
914 @var{file} is omitted, read the default initialization file (normally\n\ |
|
|
915 @file{~/.inputrc}.\n\ |
|
|
916 @end deftypefn") |
|
3189
|
917 { |
|
|
918 octave_value_list retval; |
|
|
919 |
|
|
920 int nargin = args.length (); |
|
|
921 |
|
|
922 if (nargin == 0) |
|
|
923 command_editor::read_init_file (); |
|
|
924 else if (nargin == 1) |
|
|
925 { |
|
3523
|
926 std::string file = file_ops::tilde_expand (args(0).string_value ()); |
|
3189
|
927 |
|
|
928 if (! error_state) |
|
|
929 command_editor::read_init_file (file); |
|
|
930 } |
|
|
931 else |
|
|
932 print_usage ("read_readline_init_file"); |
|
|
933 |
|
|
934 return retval; |
|
|
935 } |
|
|
936 |
|
3523
|
937 static std::string hook_fcn; |
|
3498
|
938 static octave_value user_data; |
|
|
939 |
|
3519
|
940 static void |
|
|
941 input_event_hook (void) |
|
3498
|
942 { |
|
|
943 if (user_data.is_defined ()) |
|
|
944 feval (hook_fcn, user_data, 0); |
|
|
945 else |
|
|
946 feval (hook_fcn, octave_value_list (), 0); |
|
|
947 } |
|
|
948 |
|
|
949 DEFUN (input_event_hook, args, , |
|
|
950 "-*- texinfo -*-\n\ |
|
|
951 @deftypefn {Built-in Function} {[@var{ofcn}, @var{odata}] =} input_event_hook (@var{fcn}, @var{data})\n\ |
|
|
952 Given the name of a function as a string and any Octave value object,\n\ |
|
|
953 install @var{fcn} as a function to call periodically, when Octave is\n\ |
|
|
954 waiting for input. The function should have the form\n\ |
|
|
955 @example\n\ |
|
|
956 @var{fcn} (@var{data})\n\ |
|
|
957 @end example\n\ |
|
|
958 \n\ |
|
|
959 If @var{data} is omitted, Octave calls the function without any\n\ |
|
|
960 arguments. If both @var{fcn} and @var{data} are omitted, Octave\n\ |
|
|
961 clears the hook. In all cases, the name of the previous hook function\n\ |
|
|
962 and the user data are returned.\n\ |
|
|
963 @end deftypefn") |
|
|
964 { |
|
|
965 octave_value_list retval; |
|
|
966 |
|
|
967 int nargin = args.length (); |
|
|
968 |
|
|
969 if (nargin > 2) |
|
|
970 print_usage ("input_event_hook"); |
|
|
971 else |
|
|
972 { |
|
|
973 octave_value tmp_user_data; |
|
|
974 |
|
3523
|
975 std::string tmp_hook_fcn; |
|
3498
|
976 |
|
|
977 if (nargin > 1) |
|
|
978 tmp_user_data = args(1); |
|
|
979 |
|
|
980 if (nargin > 0) |
|
|
981 { |
|
|
982 tmp_hook_fcn = args(0).string_value (); |
|
|
983 |
|
|
984 if (error_state) |
|
|
985 { |
|
|
986 error ("input_event_hook: expecting string as first arg"); |
|
|
987 return retval; |
|
|
988 } |
|
|
989 |
|
|
990 command_editor::set_event_hook (input_event_hook); |
|
|
991 } |
|
|
992 |
|
|
993 if (nargin == 0) |
|
|
994 command_editor::set_event_hook (0); |
|
|
995 |
|
|
996 retval(1) = user_data; |
|
|
997 retval(0) = hook_fcn; |
|
|
998 |
|
|
999 hook_fcn = tmp_hook_fcn; |
|
|
1000 user_data = tmp_user_data; |
|
|
1001 } |
|
|
1002 |
|
|
1003 return retval; |
|
|
1004 } |
|
|
1005 |
|
2181
|
1006 static int |
|
|
1007 ps1 (void) |
|
|
1008 { |
|
|
1009 int status = 0; |
|
|
1010 |
|
|
1011 Vps1 = builtin_string_variable ("PS1"); |
|
|
1012 |
|
|
1013 return status; |
|
|
1014 } |
|
|
1015 |
|
|
1016 static int |
|
|
1017 ps2 (void) |
|
|
1018 { |
|
|
1019 int status = 0; |
|
|
1020 |
|
|
1021 Vps2 = builtin_string_variable ("PS2"); |
|
|
1022 |
|
|
1023 return status; |
|
|
1024 } |
|
|
1025 |
|
|
1026 static int |
|
|
1027 ps4 (void) |
|
|
1028 { |
|
|
1029 int status = 0; |
|
|
1030 |
|
|
1031 Vps4 = builtin_string_variable ("PS4"); |
|
|
1032 |
|
|
1033 return status; |
|
|
1034 } |
|
|
1035 |
|
|
1036 static int |
|
|
1037 completion_append_char (void) |
|
|
1038 { |
|
|
1039 int status = 0; |
|
|
1040 |
|
3523
|
1041 std::string s = builtin_string_variable ("completion_append_char"); |
|
2181
|
1042 |
|
|
1043 switch (s.length ()) |
|
|
1044 { |
|
|
1045 case 1: |
|
|
1046 Vcompletion_append_char = s[0]; |
|
|
1047 break; |
|
|
1048 |
|
|
1049 case 0: |
|
|
1050 Vcompletion_append_char = '\0'; |
|
|
1051 break; |
|
|
1052 |
|
|
1053 default: |
|
|
1054 warning ("completion_append_char must be a single character"); |
|
|
1055 status = -1; |
|
|
1056 break; |
|
|
1057 } |
|
|
1058 |
|
|
1059 return status; |
|
|
1060 } |
|
|
1061 |
|
3019
|
1062 static int |
|
|
1063 echo_executing_commands (void) |
|
|
1064 { |
|
|
1065 Vecho_executing_commands = check_preference ("echo_executing_commands"); |
|
|
1066 |
|
|
1067 return 0; |
|
|
1068 } |
|
|
1069 |
|
2181
|
1070 void |
|
|
1071 symbols_of_input (void) |
|
|
1072 { |
|
3258
|
1073 DEFVAR (PS1, "\\s:\\#> ", ps1, |
|
3332
|
1074 "-*- texinfo -*-\n\ |
|
|
1075 @defvr {Built-in Variable} PS1\n\ |
|
|
1076 The primary prompt string. When executing interactively, Octave\n\ |
|
|
1077 displays the primary prompt @code{PS1} when it is ready to read a\n\ |
|
|
1078 command.\n\ |
|
|
1079 \n\ |
|
|
1080 The default value of @code{PS1} is @code{\"\\s:\\#> \"}. To change it, use a\n\ |
|
|
1081 command like\n\ |
|
|
1082 \n\ |
|
|
1083 @example\n\ |
|
|
1084 octave:13> PS1 = \"\\\\u@@\\\\H> \"\n\ |
|
|
1085 @end example\n\ |
|
|
1086 \n\ |
|
|
1087 @noindent\n\ |
|
|
1088 which will result in the prompt @samp{boris@@kremvax> } for the user\n\ |
|
|
1089 @samp{boris} logged in on the host @samp{kremvax.kgb.su}. Note that two\n\ |
|
|
1090 backslashes are required to enter a backslash into a string.\n\ |
|
|
1091 @xref{Strings}.\n\ |
|
3333
|
1092 @end defvr"); |
|
2181
|
1093 |
|
3258
|
1094 DEFVAR (PS2, "> ", ps2, |
|
3332
|
1095 "-*- texinfo -*-\n\ |
|
|
1096 @defvr {Built-in Variable} PS2\n\ |
|
|
1097 The secondary prompt string, which is printed when Octave is\n\ |
|
|
1098 expecting additional input to complete a command. For example, when\n\ |
|
|
1099 defining a function over several lines, Octave will print the value of\n\ |
|
|
1100 @code{PS1} at the beginning of each line after the first. The default\n\ |
|
|
1101 value of @code{PS2} is @code{\"> \"}.\n\ |
|
3333
|
1102 @end defvr"); |
|
2181
|
1103 |
|
3258
|
1104 DEFVAR (PS4, "+ ", ps4, |
|
3332
|
1105 "-*- texinfo -*-\n\ |
|
|
1106 @defvr {Built-in Variable} PS4\n\ |
|
|
1107 If Octave is invoked with the @code{--echo-input} option, the value of\n\ |
|
|
1108 @code{PS4} is printed before each line of input that is echoed. The\n\ |
|
3333
|
1109 default value of @code{PS4} is @code{\"+ \"}. @xref{Invoking Octave}, for\n\ |
|
3332
|
1110 a description of @code{--echo-input}.\n\ |
|
3333
|
1111 @end defvr"); |
|
2181
|
1112 |
|
3258
|
1113 DEFVAR (completion_append_char, " ", completion_append_char, |
|
3332
|
1114 "-*- texinfo -*-\n\ |
|
|
1115 @defvr {Built-in Variable} completion_append_char\n\ |
|
|
1116 The value of @code{completion_append_char} is used as the character to\n\ |
|
|
1117 append to successful command-line completion attempts. The default\n\ |
|
|
1118 value is @code{\" \"} (a single space).\n\ |
|
3333
|
1119 @end defvr"); |
|
3019
|
1120 |
|
3258
|
1121 DEFVAR (echo_executing_commands, static_cast<double> (ECHO_OFF), |
|
3019
|
1122 echo_executing_commands, |
|
3332
|
1123 "-*- texinfo -*-\n\ |
|
|
1124 @defvr {Built-in Variable} echo_executing_commands\n\ |
|
|
1125 This variable may also be used to control the echo state. It may be\n\ |
|
|
1126 the sum of the following values:\n\ |
|
|
1127 \n\ |
|
|
1128 @table @asis\n\ |
|
|
1129 @item 1\n\ |
|
|
1130 Echo commands read from script files.\n\ |
|
|
1131 \n\ |
|
|
1132 @item 2\n\ |
|
|
1133 Echo commands from functions.\n\ |
|
|
1134 \n\ |
|
|
1135 @item 4\n\ |
|
|
1136 Echo commands read from command line.\n\ |
|
|
1137 @end table\n\ |
|
|
1138 \n\ |
|
|
1139 More than one state can be active at once. For example, a value of 3 is\n\ |
|
|
1140 equivalent to the command @kbd{echo on all}.\n\ |
|
|
1141 \n\ |
|
|
1142 The value of @code{echo_executing_commands} is set by the @kbd{echo}\n\ |
|
|
1143 command and the command line option @code{--echo-input}.\n\ |
|
3333
|
1144 @end defvr"); |
|
2181
|
1145 } |
|
|
1146 |
|
1
|
1147 /* |
|
|
1148 ;;; Local Variables: *** |
|
|
1149 ;;; mode: C++ *** |
|
|
1150 ;;; End: *** |
|
|
1151 */ |
