Mercurial > octave
annotate libgui/src/qt-application.cc @ 29503:3bfec185c9e2
experimental command window widget with server loop
This changeset provides a new experimental proof-of-concept
cross-platform command window. It is intended to demonstrate how
communication between the GUI command window and the Octave
interpreter can work when the GUI is completely responsible for user
input instead of having the interpreter wait for input inside
readline.
This initial implementation uses a simple text box for input and a
separate text edit area for output. This design is not intended to be
the final arrangement, but was easy to implement for demonstration
purposes. These changes also make it possible to run the command-line
version of Octave in a similar client-server mode with a function
gathering input in one thread and the Octave intepreter running in
another.
The new command window is not intended to provide a general-purpose
terminal window. So running something like "system ('emacs')" will not
bring up an instance of Emacs running in the command window. This
also means that it will no longer be possible to use an external
output pager such as "less" in the command window. OTOH, it is also
no longer necessary to fork and exec a separate process on some Unixy
systems when Octave starts solely to give up the controlling terminal
so that "less" will function properly.
With the new terminal window, it is now possible to start Octave in
command line mode and later open the GUI desktop window and then
return to the command line when the GUI window is closed.
Some things that need to be finished:
* Merge the input and output windows so that command input and
output are interleaved as they are in a normal command window.
* Provide real readline command editing in the GUI command window and at
the client-server CLI prompt. We can use the readline callback
interface for the GUI and the normal readline interface for the
CLI. With this design, the command widget and the CLI front end
hold a copy of the command history. They do not need to
communicate with the interpreter to navigate the command history.
* Create interpreter_event messages for handling user input so that
the interpreter can ask the GUI to gather user input for functions
like "input".
* Consider passing results back to the command widget as
octave_value objects and allowing the command widget to format and
display them instead of passing formatted text from the
interpreter to the command widget.
* Provide an output pager feature for the GUI command window? Maybe
this feature is not necessary since we have scroll bars in the GUI
and we can also have the GUI ask the user whether to display
output if it is large.
ChangeLog:
* options-usage.h (usage_string, octave_print_verbose_usage_and_exit):
Include --experimental-terminal-widget in list of options.
(EXPERIMENTAL_TERMINAL_WIDGET_OPTION): New macro.
(long_opts): Include "experimental-terminal-widget" in the list.
* octave.h, octave.cc (cmdline_options::cmdline_options):
Handle EXPERIMENTAL_TERMINAL_WIDGET_OPTION.
(cmdline_options::m_experimental_terminal_widget): New data member.
(application::experimental_terminal_widget,
cmdline_options::experimental_terminal_widget
interpreter::experimental_terminal_widget): New functions.
* main.in.cc (fork_and_exec): New static variable.
(main): Don't fork and exec if argv includes
--experimental-terminal-widget.
* interpreter-qobject.h, interpreter-qobject.cc
(interpreter_qobject::pause, interpreter_qobject::stop,
interpreter_qobject::resume): New functions.
(interpreter_qobject::execute): Don't set prompt strings here if using
the new terminal widget. If using the new terminal widget, call
interpreter::shutdown and emit the shutdown_finished signal after
interpreter::execute returns.
(interpreter_qobject::shutdown): Don't do anything if using the new
terminal widget.
* main-window.h, main-window.cc (main_window::handle_octave_ready):
Set interpreter prompt strings here if using the new terminal widget.
(main_window::close_gui_signal): New signal.
(main_window::closeEvent): If using new terminal widget and shutdown
is confirmed, simply emit close_gui_signal.
(main_window::construct_octave_qt_link): If using new terminal widget,
connect qt_interpreter_events::interpreter_output_signal to the
terminal_dock_widget::interpreter_output slot and the
qt_interpreter_events::update_prompt_signal to the
terminal_dock_widget::update_prompt slot.
* octave-qobject.h, octave-qobject.cc
(base_qobject::interpreter_pause, base_qobject::interpreter_stop,
base_qobject::interpreter_resume): New functions.
(base_qobject::base_qobject): If using new terminal widget:
Don't connect interpreter_qobject::execution_finished signal to
octave_qobject::handle_interpreter_execution_finished slot
Don't connect octave_qobject::request_interpreter_shutdown signal to
the interpreter_qobject::shutdown slot.
Do connect the qt_interpreter_events::start_gui_signal signal to the
octave_qobject::start_gui slot and simply reload settings and call
qt_application::setQuitOnLastWindowClosed. There is no need to create
the main window here.
(base_qobject::exec): If using new terminal widget, wait for main
thread to finish after qt_application::exec returns.
(base_qojbect::experimental_terminal_widget,
base_qobject::gui_running): New functions.
(base_qojbect::start_gui, base_qojbect::close_gui,
base_qojbect::interpreter_pause, base_qojbect::interpreter_stop,
base_qojbect::interpreter_resume): New slots.
(base_qojbect::handle_interpreter_execution_finished): Do nothing if
using new terminal widget.
* qt-application.cc (qt_application::start_gui_p): Return dummy value
if using new terminal widget.
* qt-interpreter-events.h, qt-interpreter-events.cc
(qt_interpreter_events::start_gui, qt_interpreter_events::close_gui,
qt_interpreter_events::interpreter_output,
qt_interpreter_events::display_exception,
qt_interpreter_events::update_prompt): New functions.
(qt_interpreter_events::start_gui_signal,
qt_interpreter_events::close_gui_signal,
qt_interpreter_events::update_prompt_signal,
qt_interpreter_events::interpreter_output_signal): New signals.
* command-widget.h, command-widget.cc: New files.
* libgui/src/module.mk: Update.
* terminal-dock-widget.h, terminal-dock-widget.cc
(terminal_dock_widget::m_experimental_terminal_widget):
New data member.
(terminal_dock_widget::terminal_dock_widget): Optionally create and
use new terminal widget. If using new terminal widget, connect
command_widget::interpreter_event signals to
terminal_dock_widget::interpreter_event signals.
(terminal_dock_widget::interpreter_output,
terminal_dock_widget::update_prompt): New slots.
(terminal_dock_widget::update_prompt_signal,
terminal_dock_widget::interpreter_output_signal): New signals.
* event-manager.h, event-manager.cc (Fdesktop): New function.
(interpreter_events::start_gui, interpreter_events::close_gui,
interpreter_events::update_prompt): New virtual functions.
(interpreter_events::confirm_shutdown): Return true.
(event_manager::start_gui, event_manager::close_gui,
event_manager::update_prompt): New functions.
* interpreter.h, interpreter.cc (interpreter::initialize): If using
new terminal widget, only display startup message if not initially
starting GUI.
(class cli_input_reader): New class.
(interpreter::experimental_terminal_widget,
interpreter::get_line_and_eval): New functions.
(interpreter::execute): If using new terminal widget, start GUI or
command line reader and then enter server loop.
* pt-eval.cc (tree_evaluator::server_loop): Reset parser at top of loop.
also catch exit exception.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 25 Mar 2021 23:06:40 -0400 |
parents | 7854d5752dd2 |
children | 796f54d4ddbf |
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 // |
29358
0a5b15007766
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
3 // Copyright (C) 2011-2021 The Octave Project Developers |
27923
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 //////////////////////////////////////////////////////////////////////// |
13501 | 25 |
21724
aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents:
21482
diff
changeset
|
26 #if defined (HAVE_CONFIG_H) |
21301
40de9f8f23a6
Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents:
21203
diff
changeset
|
27 # include "config.h" |
15155
9e62d5a3a45e
partial cleanup of include files in gui sources
John W. Eaton <jwe@octave.org>
parents:
15139
diff
changeset
|
28 #endif |
9e62d5a3a45e
partial cleanup of include files in gui sources
John W. Eaton <jwe@octave.org>
parents:
15139
diff
changeset
|
29 |
27412
da1f59fe04b3
try to use consitent ordering for include files in libgui sources
John W. Eaton <jwe@octave.org>
parents:
27405
diff
changeset
|
30 #include "main-window.h" |
da1f59fe04b3
try to use consitent ordering for include files in libgui sources
John W. Eaton <jwe@octave.org>
parents:
27405
diff
changeset
|
31 #include "octave-qobject.h" |
da1f59fe04b3
try to use consitent ordering for include files in libgui sources
John W. Eaton <jwe@octave.org>
parents:
27405
diff
changeset
|
32 #include "qt-application.h" |
da1f59fe04b3
try to use consitent ordering for include files in libgui sources
John W. Eaton <jwe@octave.org>
parents:
27405
diff
changeset
|
33 |
15368
36ececf69385
avoid some GCC warnings in the libgui code
John W. Eaton <jwe@octave.org>
parents:
15209
diff
changeset
|
34 #include "lo-utils.h" |
15597
9046ee786fe1
Use octave_env instead of setenv.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
15425
diff
changeset
|
35 #include "oct-env.h" |
17569
9d0992c6df30
arrange to pass signals to the GUI subprocess
John W. Eaton <jwe@octave.org>
parents:
17568
diff
changeset
|
36 #include "oct-syscalls.h" |
25275
4adeabc1bbfe
improve Ctrl-C interrupt handling in the GUI (bug #53635)
John W. Eaton <jwe@octave.org>
parents:
25054
diff
changeset
|
37 #include "signal-wrappers.h" |
15155
9e62d5a3a45e
partial cleanup of include files in gui sources
John W. Eaton <jwe@octave.org>
parents:
15139
diff
changeset
|
38 |
22089
c2c668b3051b
use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents:
22088
diff
changeset
|
39 #include "display.h" |
22088
c3823cb0ea02
eliminate unused class definition
John W. Eaton <jwe@octave.org>
parents:
21979
diff
changeset
|
40 #include "octave.h" |
22165
20e684ec108e
move system dependent code to sysdep.cc
John W. Eaton <jwe@octave.org>
parents:
22157
diff
changeset
|
41 #include "sysdep.h" |
17778
b5d58667d32d
new main program wrapper to handle giving up controlling tty
John W. Eaton <jwe@octave.org>
parents:
17748
diff
changeset
|
42 |
22089
c2c668b3051b
use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents:
22088
diff
changeset
|
43 namespace octave |
13501 | 44 { |
27197
b8c0d5ad024f
refactor and rename some qt application objects
John W. Eaton <jwe@octave.org>
parents:
27194
diff
changeset
|
45 qt_application::qt_application (int argc, char **argv) |
25944
ceb508ea92ee
refactor GUI main_window class
John W. Eaton <jwe@octave.org>
parents:
25938
diff
changeset
|
46 : application (argc, argv) |
23460
b605146ed2ed
do sysdep init and init global vars in app, not interpreter (bug #50880)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
47 { |
b605146ed2ed
do sysdep init and init global vars in app, not interpreter (bug #50880)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
48 // This should probably happen early. |
b605146ed2ed
do sysdep init and init global vars in app, not interpreter (bug #50880)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
49 sysdep_init (); |
b605146ed2ed
do sysdep init and init global vars in app, not interpreter (bug #50880)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
50 } |
b605146ed2ed
do sysdep init and init global vars in app, not interpreter (bug #50880)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
51 |
27197
b8c0d5ad024f
refactor and rename some qt application objects
John W. Eaton <jwe@octave.org>
parents:
27194
diff
changeset
|
52 bool qt_application::start_gui_p (void) const |
22089
c2c668b3051b
use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents:
22088
diff
changeset
|
53 { |
29503
3bfec185c9e2
experimental command window widget with server loop
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
54 // Note: this function is not needed if using the experimental |
3bfec185c9e2
experimental command window widget with server loop
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
55 // terminal widget, so return a dummy value of false in that case. |
3bfec185c9e2
experimental command window widget with server loop
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
56 |
3bfec185c9e2
experimental command window widget with server loop
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
57 return experimental_terminal_widget () ? false : m_options.gui (); |
22089
c2c668b3051b
use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents:
22088
diff
changeset
|
58 } |
c2c668b3051b
use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents:
22088
diff
changeset
|
59 |
27197
b8c0d5ad024f
refactor and rename some qt application objects
John W. Eaton <jwe@octave.org>
parents:
27194
diff
changeset
|
60 int qt_application::execute (void) |
22089
c2c668b3051b
use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents:
22088
diff
changeset
|
61 { |
25275
4adeabc1bbfe
improve Ctrl-C interrupt handling in the GUI (bug #53635)
John W. Eaton <jwe@octave.org>
parents:
25054
diff
changeset
|
62 octave_block_interrupt_signal (); |
22089
c2c668b3051b
use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents:
22088
diff
changeset
|
63 |
22165
20e684ec108e
move system dependent code to sysdep.cc
John W. Eaton <jwe@octave.org>
parents:
22157
diff
changeset
|
64 set_application_id (); |
22153
bbaeaed0c584
set AppUserModelId for application in Windows (bug #47527)
John Donoghue
parents:
22089
diff
changeset
|
65 |
22089
c2c668b3051b
use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents:
22088
diff
changeset
|
66 // Create and show main window. |
20671
d29614aed16f
Force left-to-right alignment for the whole GUI (bug #46204)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
20259
diff
changeset
|
67 |
29503
3bfec185c9e2
experimental command window widget with server loop
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
68 // Note: the second argument is ignored if using the new terminal |
3bfec185c9e2
experimental command window widget with server loop
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
69 // widget. |
3bfec185c9e2
experimental command window widget with server loop
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
70 |
29153
02ee34a30351
eliminate separate cli_qobject and gui_qobject classes
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
71 base_qobject qt_interface (*this, start_gui_p ()); |
02ee34a30351
eliminate separate cli_qobject and gui_qobject classes
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
72 |
02ee34a30351
eliminate separate cli_qobject and gui_qobject classes
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
73 return qt_interface.exec (); |
22089
c2c668b3051b
use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents:
22088
diff
changeset
|
74 } |
13501 | 75 } |