octave: libinterp/corefcn/input.h annotate

annotate libinterp/corefcn/input.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

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
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 Copyright (C) 1993-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27540 diff changeset	4
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27540 diff changeset	5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27540 diff changeset	6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27540 diff changeset	7
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	8
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	9 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	10
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24279 diff changeset	11 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	12 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24279 diff changeset	13 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	14 (at your option) any later version.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	15
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	19 GNU General Public License for more details.
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 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: 6208 diff changeset	22 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24279 diff changeset	23 <https://www.gnu.org/licenses/>.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	24
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	25 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	26
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	27 // Use the GNU readline library for command line editing and hisory.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	28
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19849 diff changeset	29 #if ! defined (octave_input_h)
383 0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe] jwe parents: 339 diff changeset	30 #define octave_input_h 1
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	31
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	32 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	33
1342 61bb2bdee11e [project @ 1995-09-04 00:19:22 by jwe] jwe parents: 1315 diff changeset	34 #include <cstdio>
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	35
27503 1bc237447e56 use shared_ptr to manage base_reader object John W. Eaton <jwe@octave.org> parents: 27502 diff changeset	36 #include <memory>
1750 fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe] jwe parents: 1606 diff changeset	37 #include <string>
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe] jwe parents: 1606 diff changeset	38
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	39 #include "hook-fcn.h"
3255 4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe] jwe parents: 3165 diff changeset	40 #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	41 #include "ovl.h"
3770 bf6116ca10eb [project @ 2001-02-02 02:21:40 by jwe] jwe parents: 3707 diff changeset	42 #include "pager.h"
3255 4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe] jwe parents: 3165 diff changeset	43
3804 4073be5aefa1 [project @ 2001-02-28 08:36:04 by jwe] jwe parents: 3770 diff changeset	44 // TRUE after a call to completion_matches.
2299 f296bbc757a1 [project @ 1996-06-23 03:45:44 by jwe] jwe parents: 2275 diff changeset	45 extern bool octave_completion_matches_called;
f296bbc757a1 [project @ 1996-06-23 03:45:44 by jwe] jwe parents: 2275 diff changeset	46
7409 73036cdd855d [project @ 2008-01-22 20:31:59 by jwe] jwe parents: 7017 diff changeset	47 // 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	48 // the next user prompt.
7414 905bceea061b [project @ 2008-01-23 08:14:38 by jwe] jwe parents: 7409 diff changeset	49 extern OCTINTERP_API bool Vdrawnow_requested;
7409 73036cdd855d [project @ 2008-01-22 20:31:59 by jwe] jwe parents: 7017 diff changeset	50
27540 6971bc1a2f92 deprecate unecessary global variable Vtrack_line_num John W. Eaton <jwe@octave.org> parents: 27528 diff changeset	51 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	52 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	53
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	54 extern octave::sys::time Vlast_prompt_time;
5640 426719471ac6 [project @ 2006-03-04 06:02:14 by jwe] jwe parents: 5307 diff changeset	55
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	56 class octave_value;
3165 e4bbfc196e53 [project @ 1998-04-16 03:01:47 by jwe] jwe parents: 3019 diff changeset	57
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	58 namespace octave
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	59 {
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	60 class interpreter;
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	61
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	62 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	63 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	64 public:
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	65
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	66 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	67
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	68 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	69
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	70 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	71
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	72 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	73
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	74 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	75 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	76 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	77 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	78 return val;
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
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	81 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	82
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	83 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	84
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	85 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	86
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	87 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	88 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	89 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	90 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	91 return val;
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
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	94 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	95
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	96 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	97 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	98 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	99 }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	100
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	101 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	102 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	103 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	104 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	105 return val;
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
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	108 octave_value
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	109 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	110
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	111 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	112 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	113 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	114 }
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	115
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	116 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	117 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	118 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	119 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	120 return val;
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
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	123 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	124
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	125 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	126
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	127 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	128
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	129 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	130 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	131 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	132 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	133 return val;
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
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	136 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	137
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	138 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	139
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	140 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	141
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	142 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	143 {
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	144 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	145 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	146 return val;
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
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	149 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	150
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	151 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	152
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	153 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	154
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	155 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	156 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	157
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	158 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	159
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	160 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	161
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	162 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	163
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	164 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	165
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	166 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	167
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	168 private:
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	169
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	170 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	171
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	172 // 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	173 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	174
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	175 // 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	176 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	177
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	178 // 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	179 // attempts.
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	180 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	181
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	182 // 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	183 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	184
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	185 // 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	186 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	187
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	188 // 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	189 // 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	190 // types RET.
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	191 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	192
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	193 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	194
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	195 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	196 };
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 class base_reader
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	199 {
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	200 public:
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	201
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	202 friend class input_reader;
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	203
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	204 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	205 : m_interpreter (interp)
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	206 { }
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	207
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	208 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	209 : m_interpreter (x.m_interpreter)
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	210 { }
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	211
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	212 virtual ~base_reader (void) = default;
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	213
27527 73be3c628eac refactor input_reader class and its use in lexer John W. Eaton <jwe@octave.org> parents: 27503 diff changeset	214 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	215
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	216 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	217
27527 73be3c628eac refactor input_reader class and its use in lexer John W. Eaton <jwe@octave.org> parents: 27503 diff changeset	218 std::string octave_gets (const std::string& prompt, bool& eof);
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	219
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	220 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	221
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	222 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	223
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	224 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	225
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	226 protected:
f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	227
f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	228 interpreter& m_interpreter;
f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	229
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	230 private:
17733 8ad59bef27b5 use more direct method for checking input source for lexer John W. Eaton <jwe@octave.org> parents: 17731 diff changeset	231
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	232 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	233 };
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	234
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	235 class input_reader
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	236 {
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	237 public:
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	238
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	239 input_reader (interpreter& interp);
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	240
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	241 input_reader (interpreter& interp, FILE *file);
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	242
27502 f62f1170ad98 in base_reader, store reference to interpreter instead of lexer John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	243 input_reader (interpreter& interp, const std::string& str);
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	244
27503 1bc237447e56 use shared_ptr to manage base_reader object John W. Eaton <jwe@octave.org> parents: 27502 diff changeset	245 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	246
27503 1bc237447e56 use shared_ptr to manage base_reader object John W. Eaton <jwe@octave.org> parents: 27502 diff changeset	247 input_reader& operator = (const input_reader& ir) = default;
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	248
27503 1bc237447e56 use shared_ptr to manage base_reader object John W. Eaton <jwe@octave.org> parents: 27502 diff changeset	249 ~input_reader (void) = default;
16209 e7ff32e7cf82 move global promptflag variable to octave_reader class John W. Eaton <jwe@octave.org> parents: 16208 diff changeset	250
27527 73be3c628eac refactor input_reader class and its use in lexer John W. Eaton <jwe@octave.org> parents: 27503 diff changeset	251 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	252 {
27527 73be3c628eac refactor input_reader class and its use in lexer John W. Eaton <jwe@octave.org> parents: 27503 diff changeset	253 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	254 }
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 std::string input_source (void) const
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	257 {
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	258 return m_rep->input_source ();
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	259 }
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	260
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	261 bool input_from_terminal (void) const
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	262 {
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	263 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	264 }
16195 b52d2f9294b6 use class for reading lexer input John W. Eaton <jwe@octave.org> parents: 16098 diff changeset	265
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	266 bool input_from_file (void) const
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	267 {
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	268 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	269 }
17733 8ad59bef27b5 use more direct method for checking input source for lexer John W. Eaton <jwe@octave.org> parents: 17731 diff changeset	270
23061 aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	271 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	272 {
24833 7c88cf242111 use m_ prefix for data members in more classes John W. Eaton <jwe@octave.org> parents: 24740 diff changeset	273 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	274 }
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 private:
aedc662896a3 move input reader classes into octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	277
27503 1bc237447e56 use shared_ptr to manage base_reader object John W. Eaton <jwe@octave.org> parents: 27502 diff changeset	278 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	279 };
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
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	282 #if defined (OCTAVE_USE_DEPRECATED_FUNCTIONS)
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	283
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	284 OCTAVE_DEPRECATED (5, "use 'octave::input_system::yes_or_no' instead")
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	285 extern bool octave_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	286
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	287 OCTAVE_DEPRECATED (5, "use 'octave::input_system::clear_input_event_hooks' instead")
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	288 extern void remove_input_event_hook_functions (void);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	289
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	290 OCTAVE_DEPRECATED (5, "this function will be removed in a future version of Octave")
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	291 extern OCTINTERP_API FILE * get_input_from_stdin (void);
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	292
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	293 #endif
25407 ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	294
ab10403a0b50 new input_system class to manage user input for the interpreter John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	295 #endif

Mercurial > octave

annotate libinterp/corefcn/input.h @ 27919:1891570abac8