octave: libinterp/corefcn/input.h annotate

annotate libinterp/corefcn/input.h @ 28708:91f0ee715701

maint: merge stable to default.

author	John W. Eaton <jwe@octave.org>
date	Thu, 10 Sep 2020 11:46:41 -0400
parents	376ca9022b7e f0a3f4527ba6
children	dff830c84726

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	3 // Copyright (C) 1993-2020 The Octave Project Developers
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	25
27956 2310164737b3 fix many spelling errors (bug #57613) John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	26 // Use the GNU readline library for command line editing and history.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	27
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19849 diff changeset	28 #if ! defined (octave_input_h)
383 0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe] jwe parents: 339 diff changeset	29 #define octave_input_h 1
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	30
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	31 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	32
1342 61bb2bdee11e [project @ 1995-09-04 00:19:22 by jwe] jwe parents: 1315 diff changeset	33 #include <cstdio>
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	34
27503 1bc237447e56 use shared_ptr to manage base_reader object John W. Eaton <jwe@octave.org> parents: 27502 diff changeset	35 #include <memory>
1750 fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe] jwe parents: 1606 diff changeset	36 #include <string>
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe] jwe parents: 1606 diff changeset	37
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	38 #include "hook-fcn.h"
3255 4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe] jwe parents: 3165 diff changeset	39 #include "oct-time.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20791 diff changeset	40 #include "ovl.h"
3770 bf6116ca10eb [project @ 2001-02-02 02:21:40 by jwe] jwe parents: 3707 diff changeset	41 #include "pager.h"
3255 4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe] jwe parents: 3165 diff changeset	42
3804 4073be5aefa1 [project @ 2001-02-28 08:36:04 by jwe] jwe parents: 3770 diff changeset	43 // TRUE after a call to completion_matches.
2299 f296bbc757a1 [project @ 1996-06-23 03:45:44 by jwe] jwe parents: 2275 diff changeset	44 extern bool octave_completion_matches_called;
f296bbc757a1 [project @ 1996-06-23 03:45:44 by jwe] jwe parents: 2275 diff changeset	45
7409 73036cdd855d [project @ 2008-01-22 20:31:59 by jwe] jwe parents: 7017 diff changeset	46 // TRUE if the plotting system has requested a call to drawnow at
73036cdd855d [project @ 2008-01-22 20:31:59 by jwe] jwe parents: 7017 diff changeset	47 // the next user prompt.
7414 905bceea061b [project @ 2008-01-23 08:14:38 by jwe] jwe parents: 7409 diff changeset	48 extern OCTINTERP_API bool Vdrawnow_requested;
7409 73036cdd855d [project @ 2008-01-22 20:31:59 by jwe] jwe parents: 7017 diff changeset	49
27540 6971bc1a2f92 deprecate unecessary global variable Vtrack_line_num John W. Eaton <jwe@octave.org> parents: 27528 diff changeset	50 OCTAVE_DEPRECATED (6, "'Vtrack_line_num' is an obsolete internal variable; any uses should be removed")
22164 5d4a286061c8 Track line numbers when in debug mode (bug #45764) Lachlan Andrew <lachlanbis@gmail.com> parents: 22089 diff changeset	51 extern OCTINTERP_API bool Vtrack_line_num;
5d4a286061c8 Track line numbers when in debug mode (bug #45764) Lachlan Andrew <lachlanbis@gmail.com> parents: 22089 diff changeset	52
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	53 extern octave::sys::time Vlast_prompt_time;
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5307 diff changeset	54
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	55 class octave_value;
3165 e4bbfc196e53 [project @ 1998-04-16 03:01:47 by jwe] jwe parents: 3019 diff changeset	56
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	57 namespace octave
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	58 {
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	59 class interpreter;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	60
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	61 class input_system
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	62 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	63 public:
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	64
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	65 input_system (interpreter& interp);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	66
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	67 void initialize (bool line_editing);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	68
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	69 octave_value PS1 (const octave_value_list& args, int nargout);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	70
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	71 std::string PS1 (void) const { return m_PS1; }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	72
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	73 std::string PS1 (const std::string& s)
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	74 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	75 std::string val = m_PS1;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	76 m_PS1 = s;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	77 return val;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	78 }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	79
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	80 void set_PS1 (const std::string& s) { m_PS1 = s; }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	81
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	82 octave_value PS2 (const octave_value_list& args, int nargout);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	83
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	84 std::string PS2 (void) const { return m_PS2; }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	85
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	86 std::string PS2 (const std::string& s)
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	87 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	88 std::string val = m_PS2;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	89 m_PS2 = s;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	90 return val;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	91 }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	92
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	93 void set_PS2 (const std::string& s) { m_PS2 = s; }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	94
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	95 std::string last_debugging_command (void) const
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	96 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	97 return m_last_debugging_command;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	98 }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	99
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	100 std::string last_debugging_command (const std::string& s)
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	101 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	102 std::string val = m_last_debugging_command;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	103 m_last_debugging_command = s;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	104 return val;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	105 }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	106
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	107 octave_value
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	108 completion_append_char (const octave_value_list& args, int nargout);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	109
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	110 char completion_append_char (void) const
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	111 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	112 return m_completion_append_char;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	113 }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	114
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	115 char completion_append_char (char c)
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	116 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	117 char val = m_completion_append_char;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	118 m_completion_append_char = c;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	119 return val;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	120 }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	121
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	122 void set_completion_append_char (char c) { m_completion_append_char = c; }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	123
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	124 octave_value gud_mode (const octave_value_list& args, int nargout);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	125
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	126 bool gud_mode (void) const { return m_gud_mode; }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	127
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	128 bool gud_mode (bool flag)
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	129 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	130 bool val = m_gud_mode;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	131 m_gud_mode = flag;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	132 return val;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	133 }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	134
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	135 void set_gud_mode (bool flag) { m_gud_mode = flag; }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	136
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	137 octave_value mfile_encoding (const octave_value_list& args, int nargout);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	138
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	139 std::string mfile_encoding (void) const { return m_mfile_encoding; }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	140
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	141 std::string mfile_encoding (const std::string& s)
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	142 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	143 std::string val = m_mfile_encoding;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	144 m_mfile_encoding = s;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	145 return val;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	146 }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	147
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	148 void set_mfile_encoding (const std::string& s) { m_mfile_encoding = s; }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	149
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	150 bool yes_or_no (const std::string& prompt);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	151
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	152 std::string interactive_input (const std::string& s, bool& eof);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	153
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	154 octave_value_list
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	155 get_user_input (const octave_value_list& args, int nargout);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	156
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	157 bool have_input_event_hooks (void) const;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	158
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	159 void add_input_event_hook (const hook_function& hook_fcn);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	160
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	161 bool remove_input_event_hook (const std::string& hook_fcn_id);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	162
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	163 void clear_input_event_hooks (void);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	164
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	165 void run_input_event_hooks (void);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	166
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	167 private:
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	168
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	169 interpreter& m_interpreter;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	170
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	171 // Primary prompt string.
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	172 std::string m_PS1;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	173
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	174 // Secondary prompt string.
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	175 std::string m_PS2;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	176
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	177 // Character to append after successful command-line completion
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	178 // attempts.
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	179 char m_completion_append_char;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	180
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	181 // TRUE if we are running in the Emacs GUD mode.
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	182 bool m_gud_mode;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	183
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	184 // Codepage which is used to read .m files
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	185 std::string m_mfile_encoding;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	186
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	187 // If we are in debugging mode, this is the last command entered,
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	188 // so that we can repeat the previous command if the user just
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	189 // types RET.
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	190 std::string m_last_debugging_command;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	191
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	192 hook_function_list m_input_event_hook_functions;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	193
28707 f0a3f4527ba6 respond to signals when readline is waiting for input (bug #54444) John W. Eaton <jwe@octave.org> parents: 27957 diff changeset	194 bool m_initialized;
f0a3f4527ba6 respond to signals when readline is waiting for input (bug #54444) John W. Eaton <jwe@octave.org> parents: 27957 diff changeset	195
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	196 std::string gnu_readline (const std::string& s, bool& eof) const;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	197 };
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	198
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	199 class base_reader
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	200 {
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	201 public:
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	202
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	203 friend class input_reader;
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	204
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	205 base_reader (interpreter& interp)
27528 e51284fc0a51 eliminate promptflag from the lexer and input reader classes John W. Eaton <jwe@octave.org> parents: 27527 diff changeset	206 : m_interpreter (interp)
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	207 { }
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	208
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	209 base_reader (const base_reader& x)
27528 e51284fc0a51 eliminate promptflag from the lexer and input reader classes John W. Eaton <jwe@octave.org> parents: 27527 diff changeset	210 : m_interpreter (x.m_interpreter)
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	211 { }
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	212
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	213 virtual ~base_reader (void) = default;
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	214
27527 73be3c628eac refactor input_reader class and its use in lexer John W. Eaton <jwe@octave.org> parents: 27503 diff changeset	215 virtual std::string get_input (const std::string& prompt, bool& eof) = 0;
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	216
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	217 virtual std::string input_source (void) const { return s_in_src; }
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	218
27527 73be3c628eac refactor input_reader class and its use in lexer John W. Eaton <jwe@octave.org> parents: 27503 diff changeset	219 std::string octave_gets (const std::string& prompt, bool& eof);
17731 f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 16892 diff changeset	220
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	221 virtual bool input_from_terminal (void) const { return false; }
17731 f79bf671a493 eliminate global LEXER variable John W. Eaton <jwe@octave.org> parents: 16892 diff changeset	222
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	223 virtual bool input_from_file (void) const { return false; }
17733 8ad59bef27b5 use more direct method for checking input source for lexer John W. Eaton <jwe@octave.org> parents: 17731 diff changeset	224
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	225 virtual bool input_from_eval_string (void) const { return false; }
17733 8ad59bef27b5 use more direct method for checking input source for lexer John W. Eaton <jwe@octave.org> parents: 17731 diff changeset	226
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	227 protected:
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	228
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	229 interpreter& m_interpreter;
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	230
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	231 private:
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	232
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	233 static const std::string s_in_src;
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	234 };
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	235
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	236 class input_reader
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	237 {
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	238 public:
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	239
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	240 input_reader (interpreter& interp);
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	241
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	242 input_reader (interpreter& interp, FILE *file);
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	243
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	244 input_reader (interpreter& interp, const std::string& str);
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	245
27503 1bc237447e56 use shared_ptr to manage base_reader object John W. Eaton <jwe@octave.org> parents: 27502 diff changeset	246 input_reader (const input_reader& ir) = default;
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	247
27503 1bc237447e56 use shared_ptr to manage base_reader object John W. Eaton <jwe@octave.org> parents: 27502 diff changeset	248 input_reader& operator = (const input_reader& ir) = default;
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	249
27503 1bc237447e56 use shared_ptr to manage base_reader object John W. Eaton <jwe@octave.org> parents: 27502 diff changeset	250 ~input_reader (void) = default;
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	251
27527 73be3c628eac refactor input_reader class and its use in lexer John W. Eaton <jwe@octave.org> parents: 27503 diff changeset	252 std::string get_input (const std::string& prompt, bool& eof)
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	253 {
27527 73be3c628eac refactor input_reader class and its use in lexer John W. Eaton <jwe@octave.org> parents: 27503 diff changeset	254 return m_rep->get_input (prompt, eof);
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	255 }
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	256
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	257 std::string input_source (void) const
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	258 {
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	259 return m_rep->input_source ();
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	260 }
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	261
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	262 bool input_from_terminal (void) const
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	263 {
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	264 return m_rep->input_from_terminal ();
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	265 }
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	266
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	267 bool input_from_file (void) const
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	268 {
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	269 return m_rep->input_from_file ();
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	270 }
17733 8ad59bef27b5 use more direct method for checking input source for lexer John W. Eaton <jwe@octave.org> parents: 17731 diff changeset	271
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	272 bool input_from_eval_string (void) const
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	273 {
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	274 return m_rep->input_from_eval_string ();
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	275 }
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	276
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	277 private:
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	278
27503 1bc237447e56 use shared_ptr to manage base_reader object John W. Eaton <jwe@octave.org> parents: 27502 diff changeset	279 std::shared_ptr<base_reader> m_rep;
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	280 };
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	281 }
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	282
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	283 #endif

Mercurial > octave

annotate libinterp/corefcn/input.h @ 28708:91f0ee715701