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