comparison libgui/src/main-window.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 34922160bda9
children 0b429d1a4974
comparison
equal deleted inserted replaced
29502:76fdbe78884f 29503:3bfec185c9e2
1720 m_editor_window->empty_script (true, false); 1720 m_editor_window->empty_script (true, false);
1721 m_editor_window->restore_session (settings); 1721 m_editor_window->restore_session (settings);
1722 #endif 1722 #endif
1723 } 1723 }
1724 1724
1725 if (m_octave_qobj.experimental_terminal_widget ())
1726 {
1727 // Set initial prompt.
1728
1729 emit interpreter_event
1730 ([] (interpreter& interp)
1731 {
1732 // INTERPRETER_THREAD
1733
1734 event_manager& evmgr = interp.get_event_manager ();
1735 input_system& input_sys = interp.get_input_system ();
1736
1737 input_sys.PS1 (">> ");
1738 std::string prompt = input_sys.PS1 ();
1739
1740 evmgr.update_prompt (command_editor::decode_prompt_string (prompt));
1741 });
1742 }
1743
1725 focus_command_window (); // make sure that the command window has focus 1744 focus_command_window (); // make sure that the command window has focus
1726 } 1745 }
1727 1746
1728 void main_window::handle_set_path_dialog_request (void) 1747 void main_window::handle_set_path_dialog_request (void)
1729 { 1748 {
1960 // without having to stop the interpreter, for example, if the 1979 // without having to stop the interpreter, for example, if the
1961 // GUI is started from the interpreter command line. 1980 // GUI is started from the interpreter command line.
1962 1981
1963 e->ignore (); 1982 e->ignore ();
1964 1983
1965 emit interpreter_event 1984 if (m_octave_qobj.experimental_terminal_widget ())
1966 ([] (interpreter& interp) 1985 emit close_gui_signal ();
1967 { 1986 else
1968 // INTERPRETER THREAD 1987 {
1969 1988 emit interpreter_event
1970 interp.quit (0, false, false); 1989 ([] (interpreter& interp)
1971 }); 1990 {
1991 // INTERPRETER THREAD
1992
1993 interp.quit (0, false, false);
1994 });
1995 }
1972 } 1996 }
1973 else 1997 else
1974 e->ignore (); 1998 e->ignore ();
1975 } 1999 }
1976 2000
2159 connect (qt_link, SIGNAL (settings_changed (const gui_settings *, bool)), 2183 connect (qt_link, SIGNAL (settings_changed (const gui_settings *, bool)),
2160 this, SLOT (notice_settings (const gui_settings *, bool))); 2184 this, SLOT (notice_settings (const gui_settings *, bool)));
2161 2185
2162 connect (qt_link, SIGNAL (apply_new_settings (void)), 2186 connect (qt_link, SIGNAL (apply_new_settings (void)),
2163 this, SLOT (request_reload_settings (void))); 2187 this, SLOT (request_reload_settings (void)));
2188
2189 if (m_octave_qobj.experimental_terminal_widget ())
2190 {
2191 connect (qt_link, SIGNAL (interpreter_output_signal (const QString&)),
2192 m_command_window,
2193 SLOT (interpreter_output (const QString&)));
2194
2195 connect (qt_link, SIGNAL (update_prompt_signal (const QString&)),
2196 m_command_window, SLOT (update_prompt (const QString&)));
2197 }
2164 2198
2165 connect (qt_link, 2199 connect (qt_link,
2166 SIGNAL (set_workspace_signal (bool, bool, const symbol_info_list&)), 2200 SIGNAL (set_workspace_signal (bool, bool, const symbol_info_list&)),
2167 m_workspace_model, 2201 m_workspace_model,
2168 SLOT (set_workspace (bool, bool, const symbol_info_list&))); 2202 SLOT (set_workspace (bool, bool, const symbol_info_list&)));