octave-nkf: libinterp/corefcn/input.cc annotate

annotate libinterp/corefcn/input.cc @ 20207:4f45eaf83908 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed libinterp/corefcn directory. * libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc, libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc, libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc, libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc, libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc, libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc, libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc, libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc, libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, scripts/polynomial/spline.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Sat, 09 May 2015 17:19:30 -0700
parents	19755f4fc851
children	2ae4a7ef4378

rev	line source
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	1 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	2
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19630 diff changeset	3 Copyright (C) 1993-2015 John W. Eaton
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	4
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	6
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	8 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	10 option) any later version.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	11
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	15 for more details.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	16
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	17 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	19 <http://www.gnu.org/licenses/>.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	20
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	21 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	22
2939 f2feebf0eb7d [project @ 1997-05-06 16:36:34 by jwe] jwe parents: 2927 diff changeset	23 // Get command input interactively or from files.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	24
240 a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe] jwe parents: 217 diff changeset	25 #ifdef HAVE_CONFIG_H
1192 b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe] jwe parents: 1125 diff changeset	26 #include <config.h>
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	27 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	28
10463 bbe99b2a5ba7 undo recent gnulib-related changes John W. Eaton <jwe@octave.org> parents: 10447 diff changeset	29 #include <cstdio>
1343 94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	30 #include <cstdlib>
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	31 #include <cstring>
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	32 #include <cassert>
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	33
3503 d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe] jwe parents: 3498 diff changeset	34 #include <iostream>
5765 7ba9ad1fec11 [project @ 2006-04-17 05:05:15 by jwe] jwe parents: 5744 diff changeset	35 #include <sstream>
1728 42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1705 diff changeset	36 #include <string>
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1705 diff changeset	37
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	38 #include <sys/types.h>
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	39 #include <unistd.h>
1343 94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	40
2927 8722c6284b72 [project @ 1997-05-05 03:44:04 by jwe] jwe parents: 2921 diff changeset	41 #include "cmd-edit.h"
3189 bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	42 #include "file-ops.h"
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 4143 diff changeset	43 #include "quit.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	44 #include "str-vec.h"
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	45
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8503 diff changeset	46 #include "debug.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	47 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	48 #include "dirfns.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	49 #include "error.h"
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	50 #include "gripes.h"
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	51 #include "help.h"
16381 f33dcbd6a005 move hook_function classes to separate file John W. Eaton <jwe@octave.org> parents: 16378 diff changeset	52 #include "hook-fcn.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	53 #include "input.h"
9999 653716f3d976 get_debug_input: force interactive input mode; don't get user input unless stdin is a tty John W. Eaton <jwe@octave.org> parents: 9485 diff changeset	54 #include "lex.h"
5832 5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe] jwe parents: 5823 diff changeset	55 #include "load-path.h"
16416 169f71c9d9c8 use octave_link instead of hook functions in input.cc John W. Eaton <jwe@octave.org> parents: 16395 diff changeset	56 #include "octave-link.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	57 #include "oct-map.h"
1742 a02f140ed897 [project @ 1996-01-12 11:09:39 by jwe] jwe parents: 1728 diff changeset	58 #include "oct-hist.h"
1670 6708c53892c1 [project @ 1995-12-27 04:33:00 by jwe] jwe parents: 1606 diff changeset	59 #include "toplev.h"
16528 9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	60 #include "octave-link.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	61 #include "oct-obj.h"
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	62 #include "ov-fcn-handle.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	63 #include "pager.h"
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	64 #include "parse.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	65 #include "pathlen.h"
3772 e44ffad3d06c [project @ 2001-02-03 06:23:38 by jwe] jwe parents: 3741 diff changeset	66 #include "pt.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	67 #include "pt-const.h"
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8503 diff changeset	68 #include "pt-eval.h"
3805 44386b0e53da [project @ 2001-03-01 16:54:31 by jwe] jwe parents: 3804 diff changeset	69 #include "pt-stmt.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	70 #include "sighandlers.h"
16468 0f143f68078d use signal/slot for updating workspace instead of using event listener John W. Eaton <jwe@octave.org> parents: 16438 diff changeset	71 #include "symtab.h"
1114 971f2289d6de [project @ 1995-02-15 04:58:06 by jwe] jwe parents: 1112 diff changeset	72 #include "sysdep.h"
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7734 diff changeset	73 #include "toplev.h"
3098 f4acdc9a77cc [project @ 1997-11-14 09:30:20 by jwe] jwe parents: 3081 diff changeset	74 #include "unwind-prot.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	75 #include "utils.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	76 #include "variables.h"
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	77
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	78 // Primary prompt string.
16528 9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	79 static std::string VPS1;
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	80
138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	81 // Secondary prompt string.
16528 9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	82 static std::string VPS2;
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	83
138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	84 // String printed before echoed input (enabled by --echo-input).
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	85 std::string VPS4 = "+ ";
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	86
3019 92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	87 // Echo commands as they are executed?
92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	88 //
92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	89 // 1 ==> echo commands read from script files
92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	90 // 2 ==> echo commands from functions
92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	91 // 4 ==> echo commands read from command line
92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	92 //
92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	93 // more than one state can be active at once.
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	94 int Vecho_executing_commands = ECHO_OFF;
3019 92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	95
3165 e4bbfc196e53 [project @ 1998-04-16 03:01:47 by jwe] jwe parents: 3100 diff changeset	96 // The time we last printed a prompt.
5832 5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe] jwe parents: 5823 diff changeset	97 octave_time Vlast_prompt_time = 0.0;
3165 e4bbfc196e53 [project @ 1998-04-16 03:01:47 by jwe] jwe parents: 3100 diff changeset	98
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	99 // Character to append after successful command-line completion attempts.
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	100 static char Vcompletion_append_char = ' ';
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	101
19883 1c9ed5b4c73d input.h: change meaning of interactive and forced_interactive global variables. Carnë Draug <carandraug@octave.org> parents: 19735 diff changeset	102 // TRUE means this is an interactive shell (either forced or not)
3019 92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	103 bool interactive = false;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	104
3019 92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	105 // TRUE means the user forced this shell to be interactive (-i).
19883 1c9ed5b4c73d input.h: change meaning of interactive and forced_interactive global variables. Carnë Draug <carandraug@octave.org> parents: 19735 diff changeset	106 // FALSE means the shell would be interactive, independent of user settings.
3019 92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	107 bool forced_interactive = false;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	108
3804 4073be5aefa1 [project @ 2001-02-28 08:36:04 by jwe] jwe parents: 3772 diff changeset	109 // TRUE after a call to completion_matches.
2299 f296bbc757a1 [project @ 1996-06-23 03:45:44 by jwe] jwe parents: 2287 diff changeset	110 bool octave_completion_matches_called = false;
f296bbc757a1 [project @ 1996-06-23 03:45:44 by jwe] jwe parents: 2287 diff changeset	111
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	112 // TRUE if the plotting system has requested a call to drawnow at
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	113 // the next user prompt.
7409 73036cdd855d [project @ 2008-01-22 20:31:59 by jwe] jwe parents: 7336 diff changeset	114 bool Vdrawnow_requested = false;
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	115
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7734 diff changeset	116 // TRUE if we are in debugging mode.
40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7734 diff changeset	117 bool Vdebugging = false;
40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7734 diff changeset	118
8841 c74389115610 auto repeat for debugging commands John W. Eaton <jwe@octave.org> parents: 8749 diff changeset	119 // If we are in debugging mode, this is the last command entered, so
c74389115610 auto repeat for debugging commands John W. Eaton <jwe@octave.org> parents: 8749 diff changeset	120 // that we can repeat the previous command if the user just types RET.
16336 0ce49f9fb171 "\n" is the new empty string (bug #38552) John W. Eaton <jwe@octave.org> parents: 16288 diff changeset	121 static std::string last_debugging_command = "\n";
8841 c74389115610 auto repeat for debugging commands John W. Eaton <jwe@octave.org> parents: 8749 diff changeset	122
7294 fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	123 // TRUE if we are running in the Emacs GUD mode.
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	124 static bool Vgud_mode = false;
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	125
7818 5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	126 // The filemarker used to separate filenames from subfunction names
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	127 char Vfilemarker = '>';
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	128
16378 b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	129 static hook_function_list input_event_hook_functions;
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	130
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	131 // For octave_quit.
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	132 void
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	133 remove_input_event_hook_functions (void)
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	134 {
16378 b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	135 input_event_hook_functions.clear ();
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	136 }
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	137
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	138 void
16528 9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	139 set_default_prompts (void)
9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	140 {
18037 708173343c50 use "octave" instead of "\\s" in default prompt John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	141 // Use literal "octave" instead of "\\s" to avoid setting the prompt
708173343c50 use "octave" instead of "\\s" in default prompt John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	142 // to "octave.exe" or "octave-gui", etc.
708173343c50 use "octave" instead of "\\s" in default prompt John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	143
708173343c50 use "octave" instead of "\\s" in default prompt John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	144 VPS1 = "octave:\\#> ";
16528 9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	145 VPS2 = "> ";
9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	146 VPS4 = "+ ";
9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	147
9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	148 octave_link::set_default_prompts (VPS1, VPS2, VPS4);
9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	149 }
9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	150
9bc1f8278966 allow GUI to customize prompts at startup John W. Eaton <jwe@octave.org> parents: 16524 diff changeset	151 void
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	152 octave_base_reader::do_input_echo (const std::string& input_string) const
1044 1aa6f2edd975 [project @ 1995-01-18 16:35:01 by jwe] jwe parents: 1034 diff changeset	153 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	154 int do_echo = reading_script_file ()
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	155 ? (Vecho_executing_commands & ECHO_SCRIPTS)
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	156 : (Vecho_executing_commands & ECHO_CMD_LINE) && ! forced_interactive;
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	157
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	158 if (do_echo)
1044 1aa6f2edd975 [project @ 1995-01-18 16:35:01 by jwe] jwe parents: 1034 diff changeset	159 {
1403 69d15711b832 [project @ 1995-09-15 05:25:16 by jwe] jwe parents: 1363 diff changeset	160 if (forced_interactive)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	161 {
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	162 if (pflag > 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	163 octave_stdout << command_editor::decode_prompt_string (VPS1);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	164 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	165 octave_stdout << command_editor::decode_prompt_string (VPS2);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	166 }
1403 69d15711b832 [project @ 1995-09-15 05:25:16 by jwe] jwe parents: 1363 diff changeset	167 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	168 octave_stdout << command_editor::decode_prompt_string (VPS4);
1044 1aa6f2edd975 [project @ 1995-01-18 16:35:01 by jwe] jwe parents: 1034 diff changeset	169
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	170 if (! input_string.empty ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	171 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	172 octave_stdout << input_string;
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	173
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	174 if (input_string[input_string.length () - 1] != '\n')
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	175 octave_stdout << "\n";
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	176 }
1044 1aa6f2edd975 [project @ 1995-01-18 16:35:01 by jwe] jwe parents: 1034 diff changeset	177 }
1aa6f2edd975 [project @ 1995-01-18 16:35:01 by jwe] jwe parents: 1034 diff changeset	178 }
1aa6f2edd975 [project @ 1995-01-18 16:35:01 by jwe] jwe parents: 1034 diff changeset	179
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	180 static std::string
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	181 gnu_readline (const std::string& s, bool& eof)
1822 3a47ca3dd227 [project @ 1996-02-01 08:06:35 by jwe] jwe parents: 1799 diff changeset	182 {
10142 829e69ec3110 make OCTAVE_QUIT a function Jaroslav Hajek <highegg@gmail.com> parents: 10066 diff changeset	183 octave_quit ();
5142 0f9108f298ab [project @ 2005-02-12 02:29:34 by jwe] jwe parents: 5092 diff changeset	184
16097 2f4fa62089b3 improve end of file handling for lexer input John W. Eaton <jwe@octave.org> parents: 16053 diff changeset	185 eof = false;
2f4fa62089b3 improve end of file handling for lexer input John W. Eaton <jwe@octave.org> parents: 16053 diff changeset	186
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	187 std::string retval = command_editor::readline (s, eof);
19629 be7ac98fab43 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19413 diff changeset	188
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	189 if (! eof && retval.empty ())
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	190 retval = "\n";
1822 3a47ca3dd227 [project @ 1996-02-01 08:06:35 by jwe] jwe parents: 1799 diff changeset	191
3a47ca3dd227 [project @ 1996-02-01 08:06:35 by jwe] jwe parents: 1799 diff changeset	192 return retval;
3a47ca3dd227 [project @ 1996-02-01 08:06:35 by jwe] jwe parents: 1799 diff changeset	193 }
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 529 diff changeset	194
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	195 static inline std::string
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	196 interactive_input (const std::string& s, bool& eof)
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	197 {
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	198 Vlast_prompt_time.stamp ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	199
19883 1c9ed5b4c73d input.h: change meaning of interactive and forced_interactive global variables. Carnë Draug <carandraug@octave.org> parents: 19735 diff changeset	200 if (Vdrawnow_requested && interactive)
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	201 {
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	202 feval ("drawnow");
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	203
6367 268bfc8a2755 [project @ 2007-02-28 20:16:05 by jwe] jwe parents: 6317 diff changeset	204 flush_octave_stdout ();
268bfc8a2755 [project @ 2007-02-28 20:16:05 by jwe] jwe parents: 6317 diff changeset	205
6305 48f8af442b8a [project @ 2007-02-14 22:16:53 by jwe] jwe parents: 6257 diff changeset	206 // We set Vdrawnow_requested to false even if there is an error
48f8af442b8a [project @ 2007-02-14 22:16:53 by jwe] jwe parents: 6257 diff changeset	207 // in drawnow so that the error doesn't reappear at every prompt.
48f8af442b8a [project @ 2007-02-14 22:16:53 by jwe] jwe parents: 6257 diff changeset	208
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	209 Vdrawnow_requested = false;
6305 48f8af442b8a [project @ 2007-02-14 22:16:53 by jwe] jwe parents: 6257 diff changeset	210
48f8af442b8a [project @ 2007-02-14 22:16:53 by jwe] jwe parents: 6257 diff changeset	211 if (error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	212 return "\n";
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	213 }
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	214
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	215 return gnu_readline (s, eof);
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	216 }
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	217
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	218 std::string
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	219 octave_base_reader::octave_gets (bool& eof)
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	220 {
10142 829e69ec3110 make OCTAVE_QUIT a function Jaroslav Hajek <highegg@gmail.com> parents: 10066 diff changeset	221 octave_quit ();
5142 0f9108f298ab [project @ 2005-02-12 02:29:34 by jwe] jwe parents: 5092 diff changeset	222
16097 2f4fa62089b3 improve end of file handling for lexer input John W. Eaton <jwe@octave.org> parents: 16053 diff changeset	223 eof = false;
2f4fa62089b3 improve end of file handling for lexer input John W. Eaton <jwe@octave.org> parents: 16053 diff changeset	224
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3519 diff changeset	225 std::string retval;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	226
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	227 // Process pre input event hook function prior to flushing output and
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	228 // printing the prompt.
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	229
19883 1c9ed5b4c73d input.h: change meaning of interactive and forced_interactive global variables. Carnë Draug <carandraug@octave.org> parents: 19735 diff changeset	230 if (interactive)
16438 a971d8bdaadc use signals instead of event queue for entering/leaving debug mode John W. Eaton <jwe@octave.org> parents: 16433 diff changeset	231 {
a971d8bdaadc use signals instead of event queue for entering/leaving debug mode John W. Eaton <jwe@octave.org> parents: 16433 diff changeset	232 if (! Vdebugging)
a971d8bdaadc use signals instead of event queue for entering/leaving debug mode John W. Eaton <jwe@octave.org> parents: 16433 diff changeset	233 octave_link::exit_debugger_event ();
a971d8bdaadc use signals instead of event queue for entering/leaving debug mode John W. Eaton <jwe@octave.org> parents: 16433 diff changeset	234
a971d8bdaadc use signals instead of event queue for entering/leaving debug mode John W. Eaton <jwe@octave.org> parents: 16433 diff changeset	235 octave_link::pre_input_event ();
16468 0f143f68078d use signal/slot for updating workspace instead of using event listener John W. Eaton <jwe@octave.org> parents: 16438 diff changeset	236
16524 6a8e63dadfad provide octave_link::set_workspace function with default values John W. Eaton <jwe@octave.org> parents: 16502 diff changeset	237 octave_link::set_workspace ();
16438 a971d8bdaadc use signals instead of event queue for entering/leaving debug mode John W. Eaton <jwe@octave.org> parents: 16433 diff changeset	238 }
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	239
8841 c74389115610 auto repeat for debugging commands John W. Eaton <jwe@octave.org> parents: 8749 diff changeset	240 bool history_skip_auto_repeated_debugging_command = false;
c74389115610 auto repeat for debugging commands John W. Eaton <jwe@octave.org> parents: 8749 diff changeset	241
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	242 std::string ps = (pflag > 0) ? VPS1 : VPS2;
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	243
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	244 std::string prompt = command_editor::decode_prompt_string (ps);
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	245
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	246 pipe_handler_error_count = 0;
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	247
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	248 flush_octave_stdout ();
2618 aa667ac18d12 [project @ 1997-01-23 03:16:28 by jwe] jwe parents: 2470 diff changeset	249
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	250 octave_pager_stream::reset ();
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	251 octave_diary_stream::reset ();
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	252
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	253 octave_diary << prompt;
13266 c053740eb2aa improve memory use for the pager and diary streams (bug #34431) John W. Eaton <jwe@octave.org> parents: 12989 diff changeset	254
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	255 retval = interactive_input (prompt, eof);
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 529 diff changeset	256
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	257 // There is no need to update the load_path cache if there is no
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	258 // user input.
16336 0ce49f9fb171 "\n" is the new empty string (bug #38552) John W. Eaton <jwe@octave.org> parents: 16288 diff changeset	259 if (retval != "\n"
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	260 && retval.find_first_not_of (" \t\n\r") != std::string::npos)
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	261 {
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	262 load_path::update ();
8841 c74389115610 auto repeat for debugging commands John W. Eaton <jwe@octave.org> parents: 8749 diff changeset	263
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	264 if (Vdebugging)
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	265 last_debugging_command = retval;
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	266 else
16336 0ce49f9fb171 "\n" is the new empty string (bug #38552) John W. Eaton <jwe@octave.org> parents: 16288 diff changeset	267 last_debugging_command = "\n";
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	268 }
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	269 else if (Vdebugging)
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	270 {
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	271 retval = last_debugging_command;
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	272 history_skip_auto_repeated_debugging_command = true;
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	273 }
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	274
16336 0ce49f9fb171 "\n" is the new empty string (bug #38552) John W. Eaton <jwe@octave.org> parents: 16288 diff changeset	275 if (retval != "\n")
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	276 {
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	277 if (! history_skip_auto_repeated_debugging_command)
17215 7c06875c2dcc Backed out changeset 3d1205d5771e John W. Eaton <jwe@octave.org> parents: 17214 diff changeset	278 {
17219 33ce8c381f2c make history widget respect history_control settings (bug #39728) Torsten <ttl@justmail.de> parents: 17215 diff changeset	279 if (command_history::add (retval))
17215 7c06875c2dcc Backed out changeset 3d1205d5771e John W. Eaton <jwe@octave.org> parents: 17214 diff changeset	280 octave_link::append_history (retval);
7c06875c2dcc Backed out changeset 3d1205d5771e John W. Eaton <jwe@octave.org> parents: 17214 diff changeset	281 }
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	282
16207 0467d68ca891 move current_input_line to lexical_feedback class John W. Eaton <jwe@octave.org> parents: 16203 diff changeset	283 octave_diary << retval;
3176 fccab8e7d35f [project @ 1998-05-18 20:33:31 by jwe] jwe parents: 3165 diff changeset	284
16207 0467d68ca891 move current_input_line to lexical_feedback class John W. Eaton <jwe@octave.org> parents: 16203 diff changeset	285 if (retval[retval.length () - 1] != '\n')
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	286 octave_diary << "\n";
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 529 diff changeset	287
16207 0467d68ca891 move current_input_line to lexical_feedback class John W. Eaton <jwe@octave.org> parents: 16203 diff changeset	288 do_input_echo (retval);
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	289 }
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	290 else
3176 fccab8e7d35f [project @ 1998-05-18 20:33:31 by jwe] jwe parents: 3165 diff changeset	291 octave_diary << "\n";
9476 d9b25c5b8ee5 handle classdef syntax in lexer and parser Ryan Rusaw parents: 9396 diff changeset	292
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	293 // Process post input event hook function after the internal history
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	294 // list has been updated.
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	295
19883 1c9ed5b4c73d input.h: change meaning of interactive and forced_interactive global variables. Carnë Draug <carandraug@octave.org> parents: 19735 diff changeset	296 if (interactive)
16433 2c8860d563e5 fix incorrect call to octave_link::pre_input_event John W. Eaton <jwe@octave.org> parents: 16431 diff changeset	297 octave_link::post_input_event ();
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	298
1822 3a47ca3dd227 [project @ 1996-02-01 08:06:35 by jwe] jwe parents: 1799 diff changeset	299 return retval;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	300 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	301
17731 f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	302 bool
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	303 octave_base_reader::reading_fcn_file (void) const
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	304 {
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	305 return lexer ? lexer->reading_fcn_file : false;
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	306 }
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	307
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	308 bool
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	309 octave_base_reader::reading_classdef_file (void) const
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	310 {
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	311 return lexer ? lexer->reading_classdef_file : false;
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	312 }
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	313
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	314 bool
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	315 octave_base_reader::reading_script_file (void) const
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	316 {
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	317 return lexer ? lexer->reading_script_file : false;
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	318 }
f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 17323 diff changeset	319
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 529 diff changeset	320 // Fix things up so that input can come from the standard input. This
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 529 diff changeset	321 // may need to become much more complicated, which is why it's in a
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 529 diff changeset	322 // separate function.
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 529 diff changeset	323
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	324 FILE *
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	325 get_input_from_stdin (void)
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	326 {
2927 8722c6284b72 [project @ 1997-05-05 03:44:04 by jwe] jwe parents: 2921 diff changeset	327 command_editor::set_input_stream (stdin);
8722c6284b72 [project @ 1997-05-05 03:44:04 by jwe] jwe parents: 2921 diff changeset	328 return command_editor::get_input_stream ();
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	329 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	330
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	331 // FIXME: make this generate file names when appropriate.
2921 64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe] jwe parents: 2900 diff changeset	332
2247 108d848901b4 [project @ 1996-05-22 07:39:29 by jwe] jwe parents: 2235 diff changeset	333 static string_vector
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3519 diff changeset	334 generate_possible_completions (const std::string& text, std::string& prefix,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	335 std::string& hint)
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	336 {
2247 108d848901b4 [project @ 1996-05-22 07:39:29 by jwe] jwe parents: 2235 diff changeset	337 string_vector names;
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	338
2921 64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe] jwe parents: 2900 diff changeset	339 prefix = "";
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	340
4604 cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	341 if (looks_like_struct (text))
1430 045e70a15a8f [project @ 1995-09-19 07:05:37 by jwe] jwe parents: 1403 diff changeset	342 names = generate_struct_completions (text, prefix, hint);
045e70a15a8f [project @ 1995-09-19 07:05:37 by jwe] jwe parents: 1403 diff changeset	343 else
2247 108d848901b4 [project @ 1996-05-22 07:39:29 by jwe] jwe parents: 2235 diff changeset	344 names = make_name_list ();
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	345
2944 e9c24f32f175 [project @ 1997-05-08 02:42:22 by jwe] jwe parents: 2939 diff changeset	346 // Sort and remove duplicates.
2348 a88c5cc51f62 [project @ 1996-07-25 09:54:40 by jwe] jwe parents: 2327 diff changeset	347
8503 8ba2ee57c594 remove qsort in favor of sort Jaroslav Hajek <highegg@gmail.com> parents: 8447 diff changeset	348 names.sort (true);
2348 a88c5cc51f62 [project @ 1996-07-25 09:54:40 by jwe] jwe parents: 2327 diff changeset	349
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	350 return names;
b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	351 }
b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	352
9485 3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	353 static bool
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	354 is_completing_dirfns (void)
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	355 {
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	356 static std::string dirfns_commands[] = {"cd", "ls"};
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	357 static const size_t dirfns_commands_length = 2;
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	358
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	359 bool retval = false;
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	360
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	361 std::string line = command_editor::get_line_buffer ();
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	362
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	363 for (size_t i = 0; i < dirfns_commands_length; i++)
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	364 {
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	365 int index = line.find (dirfns_commands[i] + " ");
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	366
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	367 if (index == 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	368 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	369 retval = true;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	370 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	371 }
9485 3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	372 }
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	373
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	374 return retval;
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	375 }
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	376
3536 e8fbc8c3d6d9 [project @ 2000-02-02 12:01:00 by jwe] jwe parents: 3534 diff changeset	377 static std::string
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3519 diff changeset	378 generate_completion (const std::string& text, int state)
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	379 {
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3519 diff changeset	380 std::string retval;
2944 e9c24f32f175 [project @ 1997-05-08 02:42:22 by jwe] jwe parents: 2939 diff changeset	381
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3519 diff changeset	382 static std::string prefix;
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3519 diff changeset	383 static std::string hint;
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	384
2921 64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe] jwe parents: 2900 diff changeset	385 static size_t hint_len = 0;
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	386
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	387 static int list_index = 0;
2921 64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe] jwe parents: 2900 diff changeset	388 static int name_list_len = 0;
4604 cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	389 static int name_list_total_len = 0;
2247 108d848901b4 [project @ 1996-05-22 07:39:29 by jwe] jwe parents: 2235 diff changeset	390 static string_vector name_list;
4604 cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	391 static string_vector file_name_list;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	392
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	393 static int matches = 0;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	394
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	395 if (state == 0)
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	396 {
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	397 list_index = 0;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	398
2921 64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe] jwe parents: 2900 diff changeset	399 prefix = "";
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	400
2921 64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe] jwe parents: 2900 diff changeset	401 hint = text;
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	402
9485 3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	403 // No reason to display symbols while completing a
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	404 // file/directory operation.
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	405
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	406 if (is_completing_dirfns ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	407 name_list = string_vector ();
9485 3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	408 else
3cee58bf4acf selectively complete filenames in some cases John W. Eaton <jwe@octave.org> parents: 9484 diff changeset	409 name_list = generate_possible_completions (text, prefix, hint);
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	410
2921 64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe] jwe parents: 2900 diff changeset	411 name_list_len = name_list.length ();
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe] jwe parents: 2900 diff changeset	412
4604 cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	413 file_name_list = command_editor::generate_filename_completions (text);
cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	414
cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	415 name_list.append (file_name_list);
cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	416
cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	417 name_list_total_len = name_list.length ();
cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	418
2921 64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe] jwe parents: 2900 diff changeset	419 hint_len = hint.length ();
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	420
b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	421 matches = 0;
2247 108d848901b4 [project @ 1996-05-22 07:39:29 by jwe] jwe parents: 2235 diff changeset	422
2921 64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe] jwe parents: 2900 diff changeset	423 for (int i = 0; i < name_list_len; i++)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	424 if (hint == name_list[i].substr (0, hint_len))
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	425 matches++;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	426 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	427
4604 cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	428 if (name_list_total_len > 0 && matches > 0)
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	429 {
4604 cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe] jwe parents: 4565 diff changeset	430 while (list_index < name_list_total_len)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	431 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	432 std::string name = name_list[list_index];
2247 108d848901b4 [project @ 1996-05-22 07:39:29 by jwe] jwe parents: 2235 diff changeset	433
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	434 list_index++;
2247 108d848901b4 [project @ 1996-05-22 07:39:29 by jwe] jwe parents: 2235 diff changeset	435
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	436 if (hint == name.substr (0, hint_len))
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	437 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	438 if (list_index <= name_list_len && ! prefix.empty ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	439 retval = prefix + "." + name;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	440 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	441 retval = name;
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	442
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	443 // FIXME: looks_like_struct is broken for now,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	444 // so it always returns false.
4179 8734ba917fea [project @ 2002-11-14 04:31:19 by jwe] jwe parents: 4170 diff changeset	445
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	446 if (matches == 1 && looks_like_struct (retval))
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	447 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	448 // Don't append anything, since we don't know
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	449 // whether it should be '(' or '.'.
4179 8734ba917fea [project @ 2002-11-14 04:31:19 by jwe] jwe parents: 4170 diff changeset	450
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	451 command_editor::set_completion_append_character ('\0');
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	452 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	453 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	454 command_editor::set_completion_append_character
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	455 (Vcompletion_append_char);
1280 b01f9577b0da [project @ 1995-04-26 17:49:19 by jwe] jwe parents: 1215 diff changeset	456
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	457 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	458 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	459 }
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	460 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	461
2944 e9c24f32f175 [project @ 1997-05-08 02:42:22 by jwe] jwe parents: 2939 diff changeset	462 return retval;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	463 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	464
6979 2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	465 static std::string
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	466 quoting_filename (const std::string &text, int, char quote)
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	467 {
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	468 if (quote)
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	469 return text;
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	470 else
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	471 return (std::string ("'") + text);
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	472 }
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	473
2927 8722c6284b72 [project @ 1997-05-05 03:44:04 by jwe] jwe parents: 2921 diff changeset	474 void
8722c6284b72 [project @ 1997-05-05 03:44:04 by jwe] jwe parents: 2921 diff changeset	475 initialize_command_input (void)
8722c6284b72 [project @ 1997-05-05 03:44:04 by jwe] jwe parents: 2921 diff changeset	476 {
8722c6284b72 [project @ 1997-05-05 03:44:04 by jwe] jwe parents: 2921 diff changeset	477 // If we are using readline, this allows conditional parsing of the
8722c6284b72 [project @ 1997-05-05 03:44:04 by jwe] jwe parents: 2921 diff changeset	478 // .inputrc file.
269 0febc87abbd4 [project @ 1994-01-05 08:17:07 by jwe] jwe parents: 252 diff changeset	479
2927 8722c6284b72 [project @ 1997-05-05 03:44:04 by jwe] jwe parents: 2921 diff changeset	480 command_editor::set_name ("Octave");
1358 dc9c01f66a19 [project @ 1995-09-05 21:10:01 by jwe] jwe parents: 1352 diff changeset	481
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	482 // FIXME: this needs to include a comma too, but that
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3877 diff changeset	483 // causes trouble for the new struct element completion code.
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3877 diff changeset	484
4272 fd406afe8a10 [project @ 2003-01-03 19:52:30 by jwe] jwe parents: 4253 diff changeset	485 static const char s = "\t\n !\"\'+-/:;<=>(){}[\\]^`~";
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3877 diff changeset	486
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3877 diff changeset	487 command_editor::set_basic_word_break_characters (s);
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3877 diff changeset	488
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3877 diff changeset	489 command_editor::set_completer_word_break_characters (s);
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3877 diff changeset	490
3004 9a54159563de [project @ 1997-05-23 05:00:49 by jwe] jwe parents: 2944 diff changeset	491 command_editor::set_basic_quote_characters ("\"");
2944 e9c24f32f175 [project @ 1997-05-08 02:42:22 by jwe] jwe parents: 2939 diff changeset	492
6979 2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	493 command_editor::set_filename_quote_characters (" \t\n\\\"'@<>=;\|&()#$`?*[!:{");
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	494 command_editor::set_completer_quote_characters ("'\"");
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	495
2944 e9c24f32f175 [project @ 1997-05-08 02:42:22 by jwe] jwe parents: 2939 diff changeset	496 command_editor::set_completion_function (generate_completion);
6979 2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	497
2883ea1c5c18 [project @ 2007-10-08 20:23:48 by dbateman] dbateman parents: 6945 diff changeset	498 command_editor::set_quoting_function (quoting_filename);
269 0febc87abbd4 [project @ 1994-01-05 08:17:07 by jwe] jwe parents: 252 diff changeset	499 }
0febc87abbd4 [project @ 1994-01-05 08:17:07 by jwe] jwe parents: 252 diff changeset	500
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	501 static void
16438 a971d8bdaadc use signals instead of event queue for entering/leaving debug mode John W. Eaton <jwe@octave.org> parents: 16433 diff changeset	502 execute_in_debugger_handler (const std::pair<std::string, int>& arg)
16419 16bfbf9136d3 avoid creating unnecessary octave_value objects for octave_link calls John W. Eaton <jwe@octave.org> parents: 16416 diff changeset	503 {
16438 a971d8bdaadc use signals instead of event queue for entering/leaving debug mode John W. Eaton <jwe@octave.org> parents: 16433 diff changeset	504 octave_link::execute_in_debugger_event (arg.first, arg.second);
16419 16bfbf9136d3 avoid creating unnecessary octave_value objects for octave_link calls John W. Eaton <jwe@octave.org> parents: 16416 diff changeset	505 }
16bfbf9136d3 avoid creating unnecessary octave_value objects for octave_link calls John W. Eaton <jwe@octave.org> parents: 16416 diff changeset	506
16bfbf9136d3 avoid creating unnecessary octave_value objects for octave_link calls John W. Eaton <jwe@octave.org> parents: 16416 diff changeset	507 static void
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	508 get_debug_input (const std::string& prompt)
269 0febc87abbd4 [project @ 1994-01-05 08:17:07 by jwe] jwe parents: 252 diff changeset	509 {
16395 fc491da603f6 also provide a hook for exiting debugger John W. Eaton <jwe@octave.org> parents: 16386 diff changeset	510 unwind_protect frame;
fc491da603f6 also provide a hook for exiting debugger John W. Eaton <jwe@octave.org> parents: 16386 diff changeset	511
19413 c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	512 bool silent = tree_evaluator::quiet_breakpoint_flag;
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	513 tree_evaluator::quiet_breakpoint_flag = false;
19629 be7ac98fab43 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19413 diff changeset	514
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	515 octave_user_code *caller = octave_call_stack::caller_user_code ();
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	516 std::string nm;
18629 a87bdd302b1b set editor cursor on error line when debug_on_error is true (bug #41532) John W. Eaton <jwe@octave.org> parents: 18037 diff changeset	517 int curr_debug_line;
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8503 diff changeset	518
73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8503 diff changeset	519 bool have_file = false;
73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8503 diff changeset	520
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	521 if (caller)
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	522 {
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	523 nm = caller->fcn_file_name ();
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	524
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	525 if (nm.empty ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	526 nm = caller->name ();
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8503 diff changeset	527 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	528 have_file = true;
18629 a87bdd302b1b set editor cursor on error line when debug_on_error is true (bug #41532) John W. Eaton <jwe@octave.org> parents: 18037 diff changeset	529
a87bdd302b1b set editor cursor on error line when debug_on_error is true (bug #41532) John W. Eaton <jwe@octave.org> parents: 18037 diff changeset	530 curr_debug_line = octave_call_stack::caller_user_code_line ();
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	531 }
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	532 else
18629 a87bdd302b1b set editor cursor on error line when debug_on_error is true (bug #41532) John W. Eaton <jwe@octave.org> parents: 18037 diff changeset	533 curr_debug_line = octave_call_stack::current_line ();
3180 c17387059fd3 [project @ 1998-09-24 18:59:11 by jwe] jwe parents: 3176 diff changeset	534
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	535 std::ostringstream buf;
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	536
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	537 if (! nm.empty ())
3180 c17387059fd3 [project @ 1998-09-24 18:59:11 by jwe] jwe parents: 3176 diff changeset	538 {
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	539 if (Vgud_mode)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	540 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	541 static char ctrl_z = 'Z' & 0x1f;
269 0febc87abbd4 [project @ 1994-01-05 08:17:07 by jwe] jwe parents: 252 diff changeset	542
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	543 buf << ctrl_z << ctrl_z << nm << ":" << curr_debug_line;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	544 }
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	545 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	546 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	547 // FIXME: we should come up with a clean way to detect
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	548 // that we are stopped on the no-op command that marks the
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	549 // end of a function or script.
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8503 diff changeset	550
19413 c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	551 if (! silent)
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	552 {
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	553 buf << "stopped in " << nm;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	554
19413 c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	555 if (curr_debug_line > 0)
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	556 buf << " at line " << curr_debug_line;
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	557 }
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8503 diff changeset	558
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	559 if (have_file)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	560 {
16419 16bfbf9136d3 avoid creating unnecessary octave_value objects for octave_link calls John W. Eaton <jwe@octave.org> parents: 16416 diff changeset	561 octave_link::enter_debugger_event (nm, curr_debug_line);
16395 fc491da603f6 also provide a hook for exiting debugger John W. Eaton <jwe@octave.org> parents: 16386 diff changeset	562
16524 6a8e63dadfad provide octave_link::set_workspace function with default values John W. Eaton <jwe@octave.org> parents: 16502 diff changeset	563 octave_link::set_workspace ();
16468 0f143f68078d use signal/slot for updating workspace instead of using event listener John W. Eaton <jwe@octave.org> parents: 16438 diff changeset	564
16438 a971d8bdaadc use signals instead of event queue for entering/leaving debug mode John W. Eaton <jwe@octave.org> parents: 16433 diff changeset	565 frame.add_fcn (execute_in_debugger_handler,
16419 16bfbf9136d3 avoid creating unnecessary octave_value objects for octave_link calls John W. Eaton <jwe@octave.org> parents: 16416 diff changeset	566 std::pair<std::string, int> (nm, curr_debug_line));
16374 8b0a04cbdc9d provide hook function for dbstop events John W. Eaton <jwe@octave.org> parents: 16373 diff changeset	567
19413 c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	568 if (! silent)
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	569 {
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	570 std::string line_buf
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	571 = get_file_line (nm, curr_debug_line);
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8503 diff changeset	572
19413 c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	573 if (! line_buf.empty ())
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	574 buf << "\n" << curr_debug_line << ": " << line_buf;
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	575 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	576 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	577 }
3180 c17387059fd3 [project @ 1998-09-24 18:59:11 by jwe] jwe parents: 3176 diff changeset	578 }
c17387059fd3 [project @ 1998-09-24 18:59:11 by jwe] jwe parents: 3176 diff changeset	579
19413 c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	580 if (silent)
c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	581 command_editor::erase_empty_line (true);
19629 be7ac98fab43 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19413 diff changeset	582
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	583 std::string msg = buf.str ();
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	584
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	585 if (! msg.empty ())
9484 bbe033dcfe13 make dbwhere work when called at keyboard prompt John W. Eaton <jwe@octave.org> parents: 9483 diff changeset	586 std::cerr << msg << std::endl;
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	587
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 9999 diff changeset	588 frame.protect_var (VPS1);
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	589 VPS1 = prompt;
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	590
19883 1c9ed5b4c73d input.h: change meaning of interactive and forced_interactive global variables. Carnë Draug <carandraug@octave.org> parents: 19735 diff changeset	591 if (! interactive)
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	592 {
19883 1c9ed5b4c73d input.h: change meaning of interactive and forced_interactive global variables. Carnë Draug <carandraug@octave.org> parents: 19735 diff changeset	593 frame.protect_var (interactive);
1c9ed5b4c73d input.h: change meaning of interactive and forced_interactive global variables. Carnë Draug <carandraug@octave.org> parents: 19735 diff changeset	594 interactive = true;
12907 6e1b9f079e0f allow debugging when input is not coming from a tty John W. Eaton <jwe@octave.org> parents: 12573 diff changeset	595 frame.protect_var (forced_interactive);
6e1b9f079e0f allow debugging when input is not coming from a tty John W. Eaton <jwe@octave.org> parents: 12573 diff changeset	596 forced_interactive = true;
6e1b9f079e0f allow debugging when input is not coming from a tty John W. Eaton <jwe@octave.org> parents: 12573 diff changeset	597 }
6e1b9f079e0f allow debugging when input is not coming from a tty John W. Eaton <jwe@octave.org> parents: 12573 diff changeset	598
16187 490625211945 don't use new to create parser object John W. Eaton <jwe@octave.org> parents: 16177 diff changeset	599 octave_parser curr_parser;
16151 e309eb7940be parser tweaks John W. Eaton <jwe@octave.org> parents: 16149 diff changeset	600
12907 6e1b9f079e0f allow debugging when input is not coming from a tty John W. Eaton <jwe@octave.org> parents: 12573 diff changeset	601 while (Vdebugging)
6e1b9f079e0f allow debugging when input is not coming from a tty John W. Eaton <jwe@octave.org> parents: 12573 diff changeset	602 {
16127 f7eb13f14320 avoid using unwind_protect::run John W. Eaton <jwe@octave.org> parents: 16122 diff changeset	603 unwind_protect middle_frame;
f7eb13f14320 avoid using unwind_protect::run John W. Eaton <jwe@octave.org> parents: 16122 diff changeset	604
12907 6e1b9f079e0f allow debugging when input is not coming from a tty John W. Eaton <jwe@octave.org> parents: 12573 diff changeset	605 reset_error_handler ();
6e1b9f079e0f allow debugging when input is not coming from a tty John W. Eaton <jwe@octave.org> parents: 12573 diff changeset	606
16187 490625211945 don't use new to create parser object John W. Eaton <jwe@octave.org> parents: 16177 diff changeset	607 curr_parser.reset ();
9999 653716f3d976 get_debug_input: force interactive input mode; don't get user input unless stdin is a tty John W. Eaton <jwe@octave.org> parents: 9485 diff changeset	608
16187 490625211945 don't use new to create parser object John W. Eaton <jwe@octave.org> parents: 16177 diff changeset	609 int retval = curr_parser.run ();
9999 653716f3d976 get_debug_input: force interactive input mode; don't get user input unless stdin is a tty John W. Eaton <jwe@octave.org> parents: 9485 diff changeset	610
16382 389b09a914e2 allow gui to force readline to return from its idle/read loop John W. Eaton <jwe@octave.org> parents: 16381 diff changeset	611 if (command_editor::interrupt (false))
389b09a914e2 allow gui to force readline to return from its idle/read loop John W. Eaton <jwe@octave.org> parents: 16381 diff changeset	612 break;
19895 19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions. Rik <rik@octave.org> parents: 19883 diff changeset	613 else
12907 6e1b9f079e0f allow debugging when input is not coming from a tty John W. Eaton <jwe@octave.org> parents: 12573 diff changeset	614 {
16382 389b09a914e2 allow gui to force readline to return from its idle/read loop John W. Eaton <jwe@octave.org> parents: 16381 diff changeset	615 if (retval == 0 && curr_parser.stmt_list)
389b09a914e2 allow gui to force readline to return from its idle/read loop John W. Eaton <jwe@octave.org> parents: 16381 diff changeset	616 {
389b09a914e2 allow gui to force readline to return from its idle/read loop John W. Eaton <jwe@octave.org> parents: 16381 diff changeset	617 curr_parser.stmt_list->accept (*current_evaluator);
9999 653716f3d976 get_debug_input: force interactive input mode; don't get user input unless stdin is a tty John W. Eaton <jwe@octave.org> parents: 9485 diff changeset	618
16382 389b09a914e2 allow gui to force readline to return from its idle/read loop John W. Eaton <jwe@octave.org> parents: 16381 diff changeset	619 if (octave_completion_matches_called)
389b09a914e2 allow gui to force readline to return from its idle/read loop John W. Eaton <jwe@octave.org> parents: 16381 diff changeset	620 octave_completion_matches_called = false;
389b09a914e2 allow gui to force readline to return from its idle/read loop John W. Eaton <jwe@octave.org> parents: 16381 diff changeset	621 }
389b09a914e2 allow gui to force readline to return from its idle/read loop John W. Eaton <jwe@octave.org> parents: 16381 diff changeset	622
389b09a914e2 allow gui to force readline to return from its idle/read loop John W. Eaton <jwe@octave.org> parents: 16381 diff changeset	623 octave_quit ();
9999 653716f3d976 get_debug_input: force interactive input mode; don't get user input unless stdin is a tty John W. Eaton <jwe@octave.org> parents: 9485 diff changeset	624 }
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	625 }
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	626 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	627
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	628 const std::string octave_base_reader::in_src ("invalid");
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	629
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	630 const std::string octave_terminal_reader::in_src ("terminal");
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	631
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	632 std::string
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	633 octave_terminal_reader::get_input (bool& eof)
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	634 {
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	635 octave_quit ();
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	636
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	637 eof = false;
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	638
16207 0467d68ca891 move current_input_line to lexical_feedback class John W. Eaton <jwe@octave.org> parents: 16203 diff changeset	639 return octave_gets (eof);
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	640 }
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	641
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	642 const std::string octave_file_reader::in_src ("file");
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	643
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	644 std::string
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	645 octave_file_reader::get_input (bool& eof)
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	646 {
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	647 octave_quit ();
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	648
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	649 eof = false;
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	650
16207 0467d68ca891 move current_input_line to lexical_feedback class John W. Eaton <jwe@octave.org> parents: 16203 diff changeset	651 return octave_fgets (file, eof);
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	652 }
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	653
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	654 const std::string octave_eval_string_reader::in_src ("eval_string");
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	655
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	656 std::string
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	657 octave_eval_string_reader::get_input (bool& eof)
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	658 {
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	659 octave_quit ();
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	660
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	661 eof = false;
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	662
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	663 std::string retval;
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	664
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	665 retval = eval_string;
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	666
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	667 // Clear the eval string so that the next call will return
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	668 // an empty character string with EOF = true.
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	669 eval_string = "";
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	670
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	671 if (retval.empty ())
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	672 eof = true;
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	673
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	674 return retval;
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	675 }
b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16187 diff changeset	676
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 529 diff changeset	677 // If the user simply hits return, this will produce an empty matrix.
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 529 diff changeset	678
2086 bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe] jwe parents: 1996 diff changeset	679 static octave_value_list
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7734 diff changeset	680 get_user_input (const octave_value_list& args, int nargout)
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	681 {
3100 bea2f5be3eab [project @ 1997-11-14 10:07:50 by jwe] jwe parents: 3098 diff changeset	682 octave_value_list retval;
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	683
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	684 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	685
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	686 int read_as_string = 0;
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	687
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 661 diff changeset	688 if (nargin == 2)
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	689 read_as_string++;
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	690
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	691 std::string prompt = args(0).string_value ();
4975 80842ad3f85c [project @ 2004-09-08 18:37:58 by jwe] jwe parents: 4802 diff changeset	692
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	693 if (error_state)
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	694 {
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	695 error ("input: unrecognized argument");
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	696 return retval;
4975 80842ad3f85c [project @ 2004-09-08 18:37:58 by jwe] jwe parents: 4802 diff changeset	697 }
80842ad3f85c [project @ 2004-09-08 18:37:58 by jwe] jwe parents: 4802 diff changeset	698
2095 36903d507b0e [project @ 1996-04-28 09:00:07 by jwe] jwe parents: 2086 diff changeset	699 flush_octave_stdout ();
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	700
13266 c053740eb2aa improve memory use for the pager and diary streams (bug #34431) John W. Eaton <jwe@octave.org> parents: 12989 diff changeset	701 octave_pager_stream::reset ();
c053740eb2aa improve memory use for the pager and diary streams (bug #34431) John W. Eaton <jwe@octave.org> parents: 12989 diff changeset	702 octave_diary_stream::reset ();
c053740eb2aa improve memory use for the pager and diary streams (bug #34431) John W. Eaton <jwe@octave.org> parents: 12989 diff changeset	703
4565 1db951a4fcd5 [project @ 2003-10-29 13:49:30 by jwe] jwe parents: 4526 diff changeset	704 octave_diary << prompt;
1db951a4fcd5 [project @ 2003-10-29 13:49:30 by jwe] jwe parents: 4526 diff changeset	705
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	706 bool eof = false;
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	707
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	708 std::string input_buf = interactive_input (prompt.c_str (), eof);
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	709
7459 d3fe4d466bc2 don't inhibit drawnow in debug mode John W. Eaton <jwe@octave.org> parents: 7409 diff changeset	710 if (! (error_state \|\| input_buf.empty ()))
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	711 {
2927 8722c6284b72 [project @ 1997-05-05 03:44:04 by jwe] jwe parents: 2921 diff changeset	712 size_t len = input_buf.length ();
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	713
4565 1db951a4fcd5 [project @ 2003-10-29 13:49:30 by jwe] jwe parents: 4526 diff changeset	714 octave_diary << input_buf;
1db951a4fcd5 [project @ 2003-10-29 13:49:30 by jwe] jwe parents: 4526 diff changeset	715
1db951a4fcd5 [project @ 2003-10-29 13:49:30 by jwe] jwe parents: 4526 diff changeset	716 if (input_buf[len - 1] != '\n')
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	717 octave_diary << "\n";
4565 1db951a4fcd5 [project @ 2003-10-29 13:49:30 by jwe] jwe parents: 4526 diff changeset	718
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	719 if (len < 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	720 return read_as_string ? octave_value ("") : octave_value (Matrix ());
3772 e44ffad3d06c [project @ 2001-02-03 06:23:38 by jwe] jwe parents: 3741 diff changeset	721
e44ffad3d06c [project @ 2001-02-03 06:23:38 by jwe] jwe parents: 3741 diff changeset	722 if (read_as_string)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	723 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	724 // FIXME: fix gnu_readline and octave_gets instead!
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	725 if (input_buf.length () == 1 && input_buf[0] == '\n')
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	726 retval(0) = "";
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	727 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	728 retval(0) = input_buf;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	729 }
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	730 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	731 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	732 int parse_status = 0;
2900 5ed088015839 [project @ 1997-04-30 03:26:56 by jwe] jwe parents: 2896 diff changeset	733
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	734 retval = eval_string (input_buf, true, parse_status, nargout);
3100 bea2f5be3eab [project @ 1997-11-14 10:07:50 by jwe] jwe parents: 3098 diff changeset	735
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	736 if (! Vdebugging && retval.length () == 0)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	737 retval(0) = Matrix ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	738 }
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	739 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	740 else
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	741 error ("input: reading user-input failed!");
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	742
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	743 return retval;
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	744 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	745
3100 bea2f5be3eab [project @ 1997-11-14 10:07:50 by jwe] jwe parents: 3098 diff changeset	746 DEFUN (input, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	747 "-- texinfo --\n\
16053 119ce9f5e1a3 doc: Add seealso links between input, yes_or_no, kbhit. Rik <rik@octave.org> parents: 15469 diff changeset	748 @deftypefn {Built-in Function} {@var{ans} =} input (@var{prompt})\n\
119ce9f5e1a3 doc: Add seealso links between input, yes_or_no, kbhit. Rik <rik@octave.org> parents: 15469 diff changeset	749 @deftypefnx {Built-in Function} {@var{ans} =} input (@var{prompt}, \"s\")\n\
18708 7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	750 Print @var{prompt} and wait for user input.\n\
7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	751 \n\
7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	752 For example,\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	753 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	754 @example\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	755 input (\"Pick a number, any number! \")\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	756 @end example\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	757 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	758 @noindent\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	759 prints the prompt\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	760 \n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	761 @example\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	762 Pick a number, any number!\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	763 @end example\n\
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	764 \n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	765 @noindent\n\
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	766 and waits for the user to enter a value. The string entered by the user\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	767 is evaluated as an expression, so it may be a literal constant, a variable\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	768 name, or any other valid Octave code.\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	769 \n\
18707 1dcc9539234c Fix bug with input() and nargout==0 (bug #42111). Rik <rik@octave.org> parents: 18639 diff changeset	770 The number of return arguments, their size, and their class depend on the\n\
1dcc9539234c Fix bug with input() and nargout==0 (bug #42111). Rik <rik@octave.org> parents: 18639 diff changeset	771 expression entered.\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	772 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	773 If you are only interested in getting a literal string value, you can call\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	774 @code{input} with the character string @qcode{\"s\"} as the second argument.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	775 This tells Octave to return the string entered by the user directly, without\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	776 evaluating it first.\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	777 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	778 Because there may be output waiting to be displayed by the pager, it is a\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	779 good idea to always call @code{fflush (stdout)} before calling @code{input}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	780 This will ensure that all pending output is written to the screen before\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	781 your prompt.\n\
18708 7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	782 @seealso{yes_or_no, kbhit, pause, menu, listdlg}\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	783 @end deftypefn")
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	784 {
2086 bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe] jwe parents: 1996 diff changeset	785 octave_value_list retval;
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	786
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	787 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	788
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 661 diff changeset	789 if (nargin == 1 \|\| nargin == 2)
18707 1dcc9539234c Fix bug with input() and nargout==0 (bug #42111). Rik <rik@octave.org> parents: 18639 diff changeset	790 retval = get_user_input (args, std::max (nargout, 1));
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	791 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5794 diff changeset	792 print_usage ();
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	793
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	794 return retval;
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	795 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	796
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	797 bool
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	798 octave_yes_or_no (const std::string& prompt)
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	799 {
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	800 std::string prompt_string = prompt + "(yes or no) ";
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	801
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	802 while (1)
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	803 {
16198 2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	804 bool eof = false;
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	805
2c5c538be353 clean up input.cc and eliminate ff_instream global variable John W. Eaton <jwe@octave.org> parents: 16195 diff changeset	806 std::string input_buf = interactive_input (prompt_string, eof);
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	807
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	808 if (input_buf == "yes")
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	809 return true;
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	810 else if (input_buf == "no")
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	811 return false;
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	812 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	813 message (0, "Please answer yes or no.");
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	814 }
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	815 }
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	816
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	817 DEFUN (yes_or_no, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	818 "-- texinfo --\n\
16053 119ce9f5e1a3 doc: Add seealso links between input, yes_or_no, kbhit. Rik <rik@octave.org> parents: 15469 diff changeset	819 @deftypefn {Built-in Function} {@var{ans} =} yes_or_no (\"@var{prompt}\")\n\
18708 7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	820 Ask the user a yes-or-no question.\n\
7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	821 \n\
7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	822 Return logical true if the answer is yes or false if the answer is no.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	823 \n\
18708 7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	824 Takes one argument, @var{prompt}, which is the string to display when asking\n\
7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	825 the question. @var{prompt} should end in a space; @code{yes-or-no} adds the\n\
7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	826 string @samp{(yes or no) } to it. The user must confirm the answer with\n\
7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	827 @key{RET} and can edit it until it has been confirmed.\n\
16053 119ce9f5e1a3 doc: Add seealso links between input, yes_or_no, kbhit. Rik <rik@octave.org> parents: 15469 diff changeset	828 @seealso{input}\n\
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	829 @end deftypefn")
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	830 {
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	831 octave_value retval;
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	832
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	833 int nargin = args.length ();
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	834
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	835 if (nargin == 0 \|\| nargin == 1)
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	836 {
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	837 std::string prompt;
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	838
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	839 if (nargin == 1)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	840 {
19437 03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19414 diff changeset	841 if (args(0).is_string ())
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19414 diff changeset	842 prompt = args(0).string_value ();
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19414 diff changeset	843 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	844 {
19437 03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19414 diff changeset	845 error ("yes_or_no: PROMPT must be a string");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	846 return retval;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	847 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	848 }
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	849
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	850 retval = octave_yes_or_no (prompt);
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	851 }
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	852 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5794 diff changeset	853 print_usage ();
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	854
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	855 return retval;
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	856 }
426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5388 diff changeset	857
3707 58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	858 octave_value
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	859 do_keyboard (const octave_value_list& args)
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	860 {
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	861 octave_value retval;
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	862
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	863 int nargin = args.length ();
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	864
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	865 assert (nargin == 0 \|\| nargin == 1);
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	866
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 9999 diff changeset	867 unwind_protect frame;
3707 58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	868
12989 00235a6446da eliminate duplication of internal variables controlling command history John W. Eaton <jwe@octave.org> parents: 12942 diff changeset	869 frame.add_fcn (command_history::ignore_entries,
00235a6446da eliminate duplication of internal variables controlling command history John W. Eaton <jwe@octave.org> parents: 12942 diff changeset	870 command_history::ignoring_entries ());
00235a6446da eliminate duplication of internal variables controlling command history John W. Eaton <jwe@octave.org> parents: 12942 diff changeset	871
3707 58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	872 command_history::ignore_entries (false);
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	873
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 9999 diff changeset	874 frame.protect_var (Vdebugging);
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7734 diff changeset	875
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	876 frame.add_fcn (octave_call_stack::restore_frame,
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 9999 diff changeset	877 octave_call_stack::current_frame ());
3707 58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	878
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	879 // FIXME: probably we just want to print one line, not the
9484 bbe033dcfe13 make dbwhere work when called at keyboard prompt John W. Eaton <jwe@octave.org> parents: 9483 diff changeset	880 // entire statement, which might span many lines...
bbe033dcfe13 make dbwhere work when called at keyboard prompt John W. Eaton <jwe@octave.org> parents: 9483 diff changeset	881 //
bbe033dcfe13 make dbwhere work when called at keyboard prompt John W. Eaton <jwe@octave.org> parents: 9483 diff changeset	882 // tree_print_code tpc (octave_stdout);
bbe033dcfe13 make dbwhere work when called at keyboard prompt John W. Eaton <jwe@octave.org> parents: 9483 diff changeset	883 // stmt.accept (tpc);
bbe033dcfe13 make dbwhere work when called at keyboard prompt John W. Eaton <jwe@octave.org> parents: 9483 diff changeset	884
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7734 diff changeset	885 Vdebugging = true;
3707 58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	886
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	887 std::string prompt = "debug> ";
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	888 if (nargin > 0)
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	889 prompt = args(0).string_value ();
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 4208 diff changeset	890
7787 6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	891 if (! error_state)
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input David Bateman <dbateman@free.fr> parents: 7758 diff changeset	892 get_debug_input (prompt);
3707 58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	893
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	894 return retval;
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	895 }
58140935c812 [project @ 2000-07-28 09:40:52 by jwe] jwe parents: 3566 diff changeset	896
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1900 diff changeset	897 DEFUN (keyboard, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	898 "-- texinfo --\n\
9300 fddb9f9f724b Correct documentation for keyboard function Rik <rdrider0-list@yahoo.com> parents: 9260 diff changeset	899 @deftypefn {Built-in Function} {} keyboard ()\n\
16053 119ce9f5e1a3 doc: Add seealso links between input, yes_or_no, kbhit. Rik <rik@octave.org> parents: 15469 diff changeset	900 @deftypefnx {Built-in Function} {} keyboard (\"@var{prompt}\")\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	901 Stop m-file execution and enter debug mode.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	902 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	903 When the @code{keyboard} function is executed, Octave prints a prompt and\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	904 waits for user input. The input strings are then evaluated and the results\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	905 are printed. This makes it possible to examine the values of variables\n\
9300 fddb9f9f724b Correct documentation for keyboard function Rik <rdrider0-list@yahoo.com> parents: 9260 diff changeset	906 within a function, and to assign new values if necessary. To leave the\n\
fddb9f9f724b Correct documentation for keyboard function Rik <rdrider0-list@yahoo.com> parents: 9260 diff changeset	907 prompt and return to normal execution type @samp{return} or @samp{dbcont}.\n\
fddb9f9f724b Correct documentation for keyboard function Rik <rdrider0-list@yahoo.com> parents: 9260 diff changeset	908 The @code{keyboard} function does not return an exit status.\n\
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	909 \n\
9300 fddb9f9f724b Correct documentation for keyboard function Rik <rdrider0-list@yahoo.com> parents: 9260 diff changeset	910 If @code{keyboard} is invoked without arguments, a default prompt of\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	911 @samp{debug> } is used.\n\
18708 7bccc182e2f7 doc: Update pause documentation and add seealso links between related functions. Rik <rik@octave.org> parents: 18037 diff changeset	912 @seealso{dbstop, dbcont, dbquit}\n\
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3333 diff changeset	913 @end deftypefn")
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	914 {
2086 bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe] jwe parents: 1996 diff changeset	915 octave_value_list retval;
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	916
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	917 int nargin = args.length ();
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	918
712 36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe] jwe parents: 661 diff changeset	919 if (nargin == 0 \|\| nargin == 1)
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7734 diff changeset	920 {
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 9999 diff changeset	921 unwind_protect frame;
10186 095a1e670e68 make dbstep work with keyboard function John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	922
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	923 frame.add_fcn (octave_call_stack::restore_frame,
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 9999 diff changeset	924 octave_call_stack::current_frame ());
9483 25c2e92ee03c correctly skip frame assigned to keyboard function John W. Eaton <jwe@octave.org> parents: 9482 diff changeset	925
25c2e92ee03c correctly skip frame assigned to keyboard function John W. Eaton <jwe@octave.org> parents: 9482 diff changeset	926 // Skip the frame assigned to the keyboard function.
9484 bbe033dcfe13 make dbwhere work when called at keyboard prompt John W. Eaton <jwe@octave.org> parents: 9483 diff changeset	927 octave_call_stack::goto_frame_relative (0);
9483 25c2e92ee03c correctly skip frame assigned to keyboard function John W. Eaton <jwe@octave.org> parents: 9482 diff changeset	928
10186 095a1e670e68 make dbstep work with keyboard function John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	929 tree_evaluator::debug_mode = true;
19413 c1ce43276b86 avoid printing debug location in cmd window when using GUI to step John W. Eaton <jwe@octave.org> parents: 18728 diff changeset	930 tree_evaluator::quiet_breakpoint_flag = false;
10186 095a1e670e68 make dbstep work with keyboard function John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	931
095a1e670e68 make dbstep work with keyboard function John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	932 tree_evaluator::current_frame = octave_call_stack::current_frame ();
095a1e670e68 make dbstep work with keyboard function John W. Eaton <jwe@octave.org> parents: 10182 diff changeset	933
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7734 diff changeset	934 do_keyboard (args);
40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7734 diff changeset	935 }
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	936 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5794 diff changeset	937 print_usage ();
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	938
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	939 return retval;
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	940 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 339 diff changeset	941
8746 5dd06f19e9be handle commands in the lexer John W. Eaton <jwe@octave.org> parents: 8658 diff changeset	942 DEFUN (echo, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	943 "-- texinfo --\n\
11547 e1851653d59c Eliminate @deffn macros. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	944 @deftypefn {Command} {} echo options\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	945 Control whether commands are displayed as they are executed.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	946 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	947 Valid options are:\n\
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	948 \n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	949 @table @code\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	950 @item on\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	951 Enable echoing of commands as they are executed in script files.\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	952 \n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	953 @item off\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	954 Disable echoing of commands as they are executed in script files.\n\
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	955 \n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	956 @item on all\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	957 Enable echoing of commands as they are executed in script files and\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	958 functions.\n\
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	959 \n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	960 @item off all\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	961 Disable echoing of commands as they are executed in script files and\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	962 functions.\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	963 @end table\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	964 \n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	965 @noindent\n\
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	966 With no arguments, @code{echo} toggles the current echo state.\n\
11547 e1851653d59c Eliminate @deffn macros. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	967 @end deftypefn")
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	968 {
2086 bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe] jwe parents: 1996 diff changeset	969 octave_value_list retval;
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	970
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	971 int argc = args.length () + 1;
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	972
1968 a2e206524aa0 [project @ 1996-02-17 02:54:24 by jwe] jwe parents: 1957 diff changeset	973 string_vector argv = args.make_argv ("echo");
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	974
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	975 if (error_state)
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	976 return retval;
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	977
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	978 switch (argc)
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	979 {
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	980 case 1:
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	981 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	982 if ((Vecho_executing_commands & ECHO_SCRIPTS)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	983 \|\| (Vecho_executing_commands & ECHO_FUNCTIONS))
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	984 Vecho_executing_commands = ECHO_OFF;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	985 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	986 Vecho_executing_commands = ECHO_SCRIPTS;
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	987 }
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	988 break;
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	989
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	990 case 2:
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	991 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	992 std::string arg = argv[1];
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	993
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	994 if (arg == "on")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	995 Vecho_executing_commands = ECHO_SCRIPTS;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	996 else if (arg == "off")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	997 Vecho_executing_commands = ECHO_OFF;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	998 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	999 print_usage ();
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1000 }
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1001 break;
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1002
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1003 case 3:
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1004 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1005 std::string arg = argv[1];
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	1006
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1007 if (arg == "on" && argv[2] == "all")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1008 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1009 int tmp = (ECHO_SCRIPTS \| ECHO_FUNCTIONS);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1010 Vecho_executing_commands = tmp;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1011 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1012 else if (arg == "off" && argv[2] == "all")
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1013 Vecho_executing_commands = ECHO_OFF;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1014 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1015 print_usage ();
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1016 }
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1017 break;
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1018
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1019 default:
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5794 diff changeset	1020 print_usage ();
1588 27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1021 break;
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1022 }
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1023
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1024 return retval;
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1025 }
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe] jwe parents: 1569 diff changeset	1026
18799 692e16c9e488 build: Fix some unused parameter warnings from cset 89448a7523b2. Rik <rik@octave.org> parents: 18798 diff changeset	1027 DEFUN (__echostate__, , ,
18798 89448a7523b2 Add some more callbacks for root properties (bug #42347). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 18729 diff changeset	1028 "-- texinfo --\n\
18854 19a140e93b1f doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 18799 diff changeset	1029 @deftypefn {Built-in Function} {@var{state} =} __echostate__ ()\n\
18798 89448a7523b2 Add some more callbacks for root properties (bug #42347). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 18729 diff changeset	1030 Undocumented internal function\n\
89448a7523b2 Add some more callbacks for root properties (bug #42347). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 18729 diff changeset	1031 @end deftypefn")
89448a7523b2 Add some more callbacks for root properties (bug #42347). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 18729 diff changeset	1032 {
89448a7523b2 Add some more callbacks for root properties (bug #42347). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 18729 diff changeset	1033 return ovl (Vecho_executing_commands == ECHO_SCRIPTS);
89448a7523b2 Add some more callbacks for root properties (bug #42347). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 18729 diff changeset	1034 }
89448a7523b2 Add some more callbacks for root properties (bug #42347). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 18729 diff changeset	1035
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1036 DEFUN (completion_matches, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1037 "-- texinfo --\n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1038 @deftypefn {Built-in Function} {} completion_matches (@var{hint})\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1039 Generate possible completions given @var{hint}.\n\
2299 f296bbc757a1 [project @ 1996-06-23 03:45:44 by jwe] jwe parents: 2287 diff changeset	1040 \n\
f296bbc757a1 [project @ 1996-06-23 03:45:44 by jwe] jwe parents: 2287 diff changeset	1041 This function is provided for the benefit of programs like Emacs which\n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1042 might be controlling Octave and handling user input. The current\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1043 command number is not incremented when this function is called. This is\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1044 a feature, not a bug.\n\
3333 15cddaacbc2d [project @ 1999-11-03 19:53:59 by jwe] jwe parents: 3332 diff changeset	1045 @end deftypefn")
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1046 {
2281 7d11fd3aaaa1 [project @ 1996-05-24 19:58:59 by jwe] jwe parents: 2275 diff changeset	1047 octave_value retval;
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1048
a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1049 int nargin = args.length ();
a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1050
a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1051 if (nargin == 1)
a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1052 {
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3519 diff changeset	1053 std::string hint = args(0).string_value ();
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1054
a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1055 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1056 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1057 int n = 32;
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1058
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1059 string_vector list (n);
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1060
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1061 int k = 0;
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1062
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1063 for (;;)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1064 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1065 std::string cmd = generate_completion (hint, k);
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1066
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1067 if (! cmd.empty ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1068 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1069 if (k == n)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1070 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1071 n *= 2;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1072 list.resize (n);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1073 }
2235 896966940135 [project @ 1996-05-17 18:09:01 by jwe] jwe parents: 2234 diff changeset	1074
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1075 list[k++] = cmd;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1076 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1077 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1078 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1079 list.resize (k);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1080 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1081 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1082 }
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1083
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1084 if (nargout > 0)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1085 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1086 if (! list.empty ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1087 retval = list;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1088 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1089 retval = "";
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1090 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1091 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1092 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1093 // We don't use string_vector::list_in_columns here
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1094 // because it will be easier for Emacs if the names
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1095 // appear in a single column.
2235 896966940135 [project @ 1996-05-17 18:09:01 by jwe] jwe parents: 2234 diff changeset	1096
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1097 int len = list.length ();
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1098
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1099 for (int i = 0; i < len; i++)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1100 octave_stdout << list[i] << "\n";
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1101 }
2299 f296bbc757a1 [project @ 1996-06-23 03:45:44 by jwe] jwe parents: 2287 diff changeset	1102
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1103 octave_completion_matches_called = true;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1104 }
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1105 }
a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1106 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5794 diff changeset	1107 print_usage ();
2234 a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1108
a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1109 return retval;
a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1110 }
a174011c96f2 [project @ 1996-05-17 17:51:20 by jwe] jwe parents: 2205 diff changeset	1111
16879 cc3743a91652 Rename read_readline_init_file to readline_read_init_file. Rik <rik@octave.org> parents: 16816 diff changeset	1112 DEFUN (readline_read_init_file, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1113 "-- texinfo --\n\
16879 cc3743a91652 Rename read_readline_init_file to readline_read_init_file. Rik <rik@octave.org> parents: 16816 diff changeset	1114 @deftypefn {Built-in Function} {} readline_read_init_file (@var{file})\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1115 Read the readline library initialization file @var{file}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1116 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1117 If @var{file} is omitted, read the default initialization file\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1118 (normally @file{~/.inputrc}).\n\
6615 687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6489 diff changeset	1119 \n\
687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6489 diff changeset	1120 @xref{Readline Init File, , , readline, GNU Readline Library},\n\
687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6489 diff changeset	1121 for details.\n\
16880 1aebb613a5ac Rename re_read_readline_init_file to readline_re_read_init_file. Rik <rik@octave.org> parents: 16879 diff changeset	1122 @seealso{readline_re_read_init_file}\n\
3448 0fb75d95b14f [project @ 2000-01-17 20:38:31 by jwe] jwe parents: 3373 diff changeset	1123 @end deftypefn")
3189 bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1124 {
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1125 octave_value_list retval;
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1126
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1127 int nargin = args.length ();
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1128
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1129 if (nargin == 0)
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1130 command_editor::read_init_file ();
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1131 else if (nargin == 1)
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1132 {
5872 44f24cf66b95 [project @ 2006-06-30 18:19:20 by jwe] jwe parents: 5832 diff changeset	1133 std::string file = args(0).string_value ();
3189 bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1134
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1135 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1136 command_editor::read_init_file (file);
3189 bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1137 }
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1138 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5794 diff changeset	1139 print_usage ();
3189 bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1140
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1141 return retval;
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1142 }
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe] jwe parents: 3180 diff changeset	1143
16880 1aebb613a5ac Rename re_read_readline_init_file to readline_re_read_init_file. Rik <rik@octave.org> parents: 16879 diff changeset	1144 DEFUN (readline_re_read_init_file, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1145 "-- texinfo --\n\
16880 1aebb613a5ac Rename re_read_readline_init_file to readline_re_read_init_file. Rik <rik@octave.org> parents: 16879 diff changeset	1146 @deftypefn {Built-in Function} {} readline_re_read_init_file ()\n\
7758 8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1147 Re-read the last readline library initialization file that was read.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1148 \n\
7758 8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1149 @xref{Readline Init File, , , readline, GNU Readline Library},\n\
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1150 for details.\n\
16879 cc3743a91652 Rename read_readline_init_file to readline_read_init_file. Rik <rik@octave.org> parents: 16816 diff changeset	1151 @seealso{readline_read_init_file}\n\
7758 8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1152 @end deftypefn")
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1153 {
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1154 octave_value_list retval;
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1155
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1156 if (args.length () == 0)
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1157 command_editor::re_read_init_file ();
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1158 else
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1159 print_usage ();
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1160
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1161 return retval;
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1162 }
8e14a01ffe9f input.cc (Fre_read_readline_init_file): new function John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	1163
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	1164 static int
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	1165 internal_input_event_hook_fcn (void)
610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	1166 {
16378 b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	1167 input_event_hook_functions.run ();
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	1168
16378 b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	1169 if (input_event_hook_functions.empty ())
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	1170 command_editor::remove_event_hook (internal_input_event_hook_fcn);
16152 c48847a781d5 * input.cc (input_event_hook): Return 0. John W. Eaton <jwe@octave.org> parents: 16151 diff changeset	1171
c48847a781d5 * input.cc (input_event_hook): Return 0. John W. Eaton <jwe@octave.org> parents: 16151 diff changeset	1172 return 0;
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1173 }
e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1174
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1175 DEFUN (add_input_event_hook, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1176 "-- texinfo --\n\
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1177 @deftypefn {Built-in Function} {@var{id} =} add_input_event_hook (@var{fcn})\n\
bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1178 @deftypefnx {Built-in Function} {@var{id} =} add_input_event_hook (@var{fcn}, @var{data})\n\
16816 12005245b645 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 16534 diff changeset	1179 Add the named function or function handle @var{fcn} to the list of functions\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1180 to call periodically when Octave is waiting for input.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1181 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1182 The function should have the form\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10463 diff changeset	1183 \n\
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1184 @example\n\
e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1185 @var{fcn} (@var{data})\n\
e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1186 @end example\n\
e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1187 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1188 If @var{data} is omitted, Octave calls the function without any arguments.\n\
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1189 \n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1190 The returned identifier may be used to remove the function handle from the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1191 list of input hook functions.\n\
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1192 @seealso{remove_input_event_hook}\n\
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1193 @end deftypefn")
e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1194 {
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1195 octave_value retval;
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1196
e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1197 int nargin = args.length ();
e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1198
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1199 if (nargin == 1 \|\| nargin == 2)
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1200 {
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1201 octave_value user_data;
1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1202
1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1203 if (nargin == 2)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1204 user_data = args(1);
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1205
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1206 hook_function hook_fcn (args(0), user_data);
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1207
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1208 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1209 {
16378 b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	1210 if (input_event_hook_functions.empty ())
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	1211 command_editor::add_event_hook (internal_input_event_hook_fcn);
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1212
16378 b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	1213 input_event_hook_functions.insert (hook_fcn.id (), hook_fcn);
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1214
bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1215 retval = hook_fcn.id ();
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1216 }
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1217 else
19437 03067dab10ca Use stricter input validation when looking for a string as input (bug #42651). Rik <rik@octave.org> parents: 19414 diff changeset	1218 error ("add_input_event_hook: FCN must be a function handle or string");
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1219 }
1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1220 else
1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1221 print_usage ();
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1222
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1223 return retval;
1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1224 }
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1225
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1226 DEFUN (remove_input_event_hook, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1227 "-- texinfo --\n\
16816 12005245b645 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 16534 diff changeset	1228 @deftypefn {Built-in Function} {} remove_input_event_hook (@var{name})\n\
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1229 @deftypefnx {Built-in Function} {} remove_input_event_hook (@var{fcn_id})\n\
bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1230 Remove the named function or function handle with the given identifier\n\
bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1231 from the list of functions to call periodically when Octave is waiting\n\
bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1232 for input.\n\
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1233 @seealso{add_input_event_hook}\n\
1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1234 @end deftypefn")
1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1235 {
1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1236 octave_value_list retval;
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1237
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1238 int nargin = args.length ();
1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1239
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1240 if (nargin == 1 \|\| nargin == 2)
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1241 {
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1242 std::string hook_fcn_id = args(0).string_value ();
bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1243
bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1244 bool warn = (nargin < 2);
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1245
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1246 if (! error_state)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1247 {
16378 b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	1248 hook_function_list::iterator p
b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	1249 = input_event_hook_functions.find (hook_fcn_id);
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1250
16378 b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	1251 if (p != input_event_hook_functions.end ())
b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	1252 input_event_hook_functions.erase (p);
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1253 else if (warn)
bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1254 warning ("remove_input_event_hook: %s not found in list",
bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1255 hook_fcn_id.c_str ());
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1256
16378 b28ae106e316 use class for lists of input hook functions John W. Eaton <jwe@octave.org> parents: 16374 diff changeset	1257 if (input_event_hook_functions.empty ())
16349 610617eb84d1 provide pre- and post-input hook functions John W. Eaton <jwe@octave.org> parents: 16347 diff changeset	1258 command_editor::remove_event_hook (internal_input_event_hook_fcn);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10186 diff changeset	1259 }
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1260 else
16347 bf8397caeff1 allow add_input_event_hook to accept function handles John W. Eaton <jwe@octave.org> parents: 16336 diff changeset	1261 error ("remove_input_event_hook: argument not valid as a hook function name or id");
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1262 }
9215 1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1263 else
1500d0197484 allow multiple input event hook functions to be installed simultaneously John W. Eaton <jwe@octave.org> parents: 9134 diff changeset	1264 print_usage ();
3498 e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1265
e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1266 return retval;
e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1267 }
e391aeef2b3c [project @ 2000-01-31 03:17:14 by jwe] jwe parents: 3484 diff changeset	1268
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1269 DEFUN (PS1, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1270 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10463 diff changeset	1271 @deftypefn {Built-in Function} {@var{val} =} PS1 ()\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1272 @deftypefnx {Built-in Function} {@var{old_val} =} PS1 (@var{new_val})\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1273 @deftypefnx {Built-in Function} {} PS1 (@var{new_val}, \"local\")\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1274 Query or set the primary prompt string.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1275 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1276 When executing interactively, Octave displays the primary prompt when it is\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1277 ready to read a command.\n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1278 \n\
18037 708173343c50 use "octave" instead of "\\s" in default prompt John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	1279 The default value of the primary prompt string is @qcode{\"octave:\\#> \"}.\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1280 To change it, use a command like\n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1281 \n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1282 @example\n\
11405 51b6193e90bb Documentation fixes Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11367 diff changeset	1283 PS1 (\"\\\\u@@\\\\H> \")\n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1284 @end example\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1285 \n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1286 @noindent\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1287 which will result in the prompt @samp{boris@@kremvax> } for the user\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1288 @samp{boris} logged in on the host @samp{kremvax.kgb.su}. Note that two\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1289 backslashes are required to enter a backslash into a double-quoted\n\
11413 ae0deb52af27 Correct use of xref macro to prevent Texinfo warning. Rik <octave@nomad.inbox5.com> parents: 11405 diff changeset	1290 character string. @xref{Strings}.\n\
11405 51b6193e90bb Documentation fixes Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11367 diff changeset	1291 \n\
51b6193e90bb Documentation fixes Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11367 diff changeset	1292 You can also use ANSI escape sequences if your terminal supports them.\n\
11575 d6619410e79c Spellcheck documentation before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11572 diff changeset	1293 This can be useful for coloring the prompt. For example,\n\
11405 51b6193e90bb Documentation fixes Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11367 diff changeset	1294 \n\
51b6193e90bb Documentation fixes Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11367 diff changeset	1295 @example\n\
14880 9e5df4d6cefa doc: typo on PS1 documentation example Carnë Draug <carandraug+dev@gmail.com> parents: 14138 diff changeset	1296 PS1 (\"\\\\[\\\\033[01;31m\\\\]\\\\s:\\\\#> \\\\[\\\\033[0m\\\\]\")\n\
11405 51b6193e90bb Documentation fixes Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11367 diff changeset	1297 @end example\n\
51b6193e90bb Documentation fixes Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11367 diff changeset	1298 \n\
11572 7d6d8c1e471f Grammarcheck Texinfo for files in src directory. Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	1299 @noindent\n\
11575 d6619410e79c Spellcheck documentation before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11572 diff changeset	1300 will give the default Octave prompt a red coloring.\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1301 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1302 When called from inside a function with the @qcode{\"local\"} option, the\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1303 variable is changed locally for the function and any subroutines it calls.\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1304 The original variable value is restored when exiting the function.\n\
6373 b3c37bc17c5f [project @ 2007-03-01 15:49:03 by jwe] jwe parents: 6367 diff changeset	1305 @seealso{PS2, PS4}\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1306 @end deftypefn")
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1307 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1308 return SET_INTERNAL_VARIABLE (PS1);
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1309 }
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	1310
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1311 DEFUN (PS2, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1312 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10463 diff changeset	1313 @deftypefn {Built-in Function} {@var{val} =} PS2 ()\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1314 @deftypefnx {Built-in Function} {@var{old_val} =} PS2 (@var{new_val})\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1315 @deftypefnx {Built-in Function} {} PS2 (@var{new_val}, \"local\")\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1316 Query or set the secondary prompt string.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1317 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1318 The secondary prompt is printed when Octave is expecting additional input to\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1319 complete a command. For example, if you are typing a @code{for} loop that\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1320 spans several lines, Octave will print the secondary prompt at the beginning\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1321 of each line after the first. The default value of the secondary prompt\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1322 string is @qcode{\"> \"}.\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1323 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1324 When called from inside a function with the @qcode{\"local\"} option, the\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1325 variable is changed locally for the function and any subroutines it calls.\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1326 The original variable value is restored when exiting the function.\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1327 @seealso{PS1, PS4}\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1328 @end deftypefn")
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1329 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1330 return SET_INTERNAL_VARIABLE (PS2);
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1331 }
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	1332
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1333 DEFUN (PS4, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1334 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10463 diff changeset	1335 @deftypefn {Built-in Function} {@var{val} =} PS4 ()\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1336 @deftypefnx {Built-in Function} {@var{old_val} =} PS4 (@var{new_val})\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1337 @deftypefnx {Built-in Function} {} PS4 (@var{new_val}, \"local\")\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1338 Query or set the character string used to prefix output produced\n\
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	1339 when echoing commands is enabled.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1340 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1341 The default value is @qcode{\"+ \"}.\n\
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	1342 @xref{Diary and Echo Commands}, for a description of echoing commands.\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1343 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1344 When called from inside a function with the @qcode{\"local\"} option, the\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1345 variable is changed locally for the function and any subroutines it calls.\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1346 The original variable value is restored when exiting the function.\n\
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	1347 @seealso{echo, echo_executing_commands, PS1, PS2}\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1348 @end deftypefn")
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1349 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1350 return SET_INTERNAL_VARIABLE (PS4);
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1351 }
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	1352
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1353 DEFUN (completion_append_char, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1354 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10463 diff changeset	1355 @deftypefn {Built-in Function} {@var{val} =} completion_append_char ()\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1356 @deftypefnx {Built-in Function} {@var{old_val} =} completion_append_char (@var{new_val})\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1357 @deftypefnx {Built-in Function} {} completion_append_char (@var{new_val}, \"local\")\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1358 Query or set the internal character variable that is appended to\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1359 successful command-line completion attempts.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1360 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1361 The default value is @qcode{\" \"} (a single space).\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1362 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1363 When called from inside a function with the @qcode{\"local\"} option, the\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1364 variable is changed locally for the function and any subroutines it calls.\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1365 The original variable value is restored when exiting the function.\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1366 @end deftypefn")
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1367 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1368 return SET_INTERNAL_VARIABLE (completion_append_char);
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1369 }
3019 92aa3d651723 [project @ 1997-06-03 22:07:16 by jwe] jwe parents: 3016 diff changeset	1370
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1371 DEFUN (echo_executing_commands, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1372 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10463 diff changeset	1373 @deftypefn {Built-in Function} {@var{val} =} echo_executing_commands ()\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1374 @deftypefnx {Built-in Function} {@var{old_val} =} echo_executing_commands (@var{new_val})\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1375 @deftypefnx {Built-in Function} {} echo_executing_commands (@var{new_val}, \"local\")\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1376 Query or set the internal variable that controls the echo state.\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1377 \n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1378 It may be the sum of the following values:\n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1379 \n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1380 @table @asis\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1381 @item 1\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1382 Echo commands read from script files.\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1383 \n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1384 @item 2\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1385 Echo commands from functions.\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1386 \n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1387 @item 4\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1388 Echo commands read from command line.\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1389 @end table\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1390 \n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1391 More than one state can be active at once. For example, a value of 3 is\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1392 equivalent to the command @kbd{echo on all}.\n\
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3258 diff changeset	1393 \n\
9134 a3739e27b017 Update section 2.4 of basics.txi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	1394 The value of @code{echo_executing_commands} may be set by the @kbd{echo}\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10463 diff changeset	1395 command or the command line option @option{--echo-commands}.\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1396 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1397 When called from inside a function with the @qcode{\"local\"} option, the\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1398 variable is changed locally for the function and any subroutines it calls.\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1399 The original variable value is restored when exiting the function.\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1400 @end deftypefn")
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1401 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	1402 return SET_INTERNAL_VARIABLE (echo_executing_commands);
2181 138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	1403 }
138b3c98dc85 [project @ 1996-05-13 18:02:31 by jwe] jwe parents: 2114 diff changeset	1404
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1405 DEFUN (__request_drawnow__, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1406 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10463 diff changeset	1407 @deftypefn {Built-in Function} {} __request_drawnow__ ()\n\
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1408 @deftypefnx {Built-in Function} {} __request_drawnow__ (@var{flag})\n\
6945 6bbf56a9718a [project @ 2007-10-02 20:47:22 by jwe] jwe parents: 6913 diff changeset	1409 Undocumented internal function.\n\
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1410 @end deftypefn")
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1411 {
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1412 octave_value retval;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1413
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1414 int nargin = args.length ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1415
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1416 if (nargin == 0)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1417 Vdrawnow_requested = true;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1418 else if (nargin == 1)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1419 Vdrawnow_requested = args(0).bool_value ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1420 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1421 print_usage ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1422
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1423 return retval;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1424 }
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6206 diff changeset	1425
7294 fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1426 DEFUN (__gud_mode__, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1427 "-- texinfo --\n\
7294 fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1428 @deftypefn {Built-in Function} {} __gud_mode__ ()\n\
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1429 Undocumented internal function.\n\
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1430 @end deftypefn")
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1431 {
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1432 octave_value retval;
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1433
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1434 int nargin = args.length ();
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1435
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1436 if (nargin == 0)
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1437 retval = Vgud_mode;
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1438 else if (nargin == 1)
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1439 Vgud_mode = args(0).bool_value ();
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1440 else
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1441 print_usage ();
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1442
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1443 return retval;
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1444 }
fb902b3b2a5d [project @ 2007-12-11 18:55:46 by jwe] jwe parents: 7097 diff changeset	1445
7818 5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1446 DEFUN (filemarker, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1447 "-- texinfo --\n\
12211 11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12179 diff changeset	1448 @deftypefn {Built-in Function} {@var{val} =} filemarker ()\n\
18260 bffa6c8255a9 doc: Rewrite docstring for filemarker. Rik <rik@octave.org> parents: 18037 diff changeset	1449 @deftypefnx {Built-in Function} {@var{old_val} =} filemarker (@var{new_val})\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1450 @deftypefnx {Built-in Function} {} filemarker (@var{new_val}, \"local\")\n\
18260 bffa6c8255a9 doc: Rewrite docstring for filemarker. Rik <rik@octave.org> parents: 18037 diff changeset	1451 Query or set the character used to separate the filename from the subfunction\n\
20207 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1452 names contained within the file.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1453 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19895 diff changeset	1454 By default this is the character @samp{>}.\n\
18260 bffa6c8255a9 doc: Rewrite docstring for filemarker. Rik <rik@octave.org> parents: 18037 diff changeset	1455 This can be used in a generic manner to interact with subfunctions.\n\
bffa6c8255a9 doc: Rewrite docstring for filemarker. Rik <rik@octave.org> parents: 18037 diff changeset	1456 For example,\n\
7818 5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1457 \n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1458 @example\n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1459 help ([\"myfunc\", filemarker, \"mysubfunc\"])\n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1460 @end example\n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1461 \n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1462 @noindent\n\
14852 53d2c3598d33 doc: Periodic spellcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1463 returns the help string associated with the subfunction @code{mysubfunc}\n\
18260 bffa6c8255a9 doc: Rewrite docstring for filemarker. Rik <rik@octave.org> parents: 18037 diff changeset	1464 located in the file @file{myfunc.m}.\n\
bffa6c8255a9 doc: Rewrite docstring for filemarker. Rik <rik@octave.org> parents: 18037 diff changeset	1465 \n\
bffa6c8255a9 doc: Rewrite docstring for filemarker. Rik <rik@octave.org> parents: 18037 diff changeset	1466 @code{filemarker} is also useful during debugging for placing breakpoints\n\
bffa6c8255a9 doc: Rewrite docstring for filemarker. Rik <rik@octave.org> parents: 18037 diff changeset	1467 within subfunctions or nested functions.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10463 diff changeset	1468 For example,\n\
7818 5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1469 \n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1470 @example\n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1471 dbstop ([\"myfunc\", filemarker, \"mysubfunc\"])\n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1472 @end example\n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1473 \n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1474 @noindent\n\
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1475 will set a breakpoint at the first line of the subfunction @code{mysubfunc}.\n\
13951 79aa00a94e9e doc: Document "local" option for configuration variables. Rik <octave@nomad.inbox5.com> parents: 13266 diff changeset	1476 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1477 When called from inside a function with the @qcode{\"local\"} option, the\n\
18260 bffa6c8255a9 doc: Rewrite docstring for filemarker. Rik <rik@octave.org> parents: 18037 diff changeset	1478 variable is changed locally for the function and any subroutines it calls.\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17219 diff changeset	1479 The original variable value is restored when exiting the function.\n\
7818 5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1480 @end deftypefn")
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1481 {
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1482 char tmp = Vfilemarker;
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1483 octave_value retval = SET_INTERNAL_VARIABLE (filemarker);
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1484
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1485 // The character passed must not be a legal character for a function name
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1486 if (! error_state && (::isalnum (Vfilemarker) \|\| Vfilemarker == '_'))
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1487 {
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1488 Vfilemarker = tmp;
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1489 error ("filemarker: character can not be a valid character for a function name");
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1490 }
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1491
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1492 return retval;
5640a70cbab1 Add Ffilemarker and fix for 'dbstep in' David Bateman <dbateman@free.fr> parents: 7787 diff changeset	1493 }

Mercurial > octave-nkf

annotate libinterp/corefcn/input.cc @ 20207:4f45eaf83908 stable