Editing GUI terminal widget

== Background ==

Way back in January 2012, jwe [https://lists.gnu.org/archive/html/octave-maintainers/2012-01/msg00416.html posted the following message] about changing the terminal widget in the GUI to handle input differently.

Jwe included a simple example written with gtkmm to illustrate the idea of having the terminal widget in the GUI be in control of input and output and feed lines of text to the interpreter.
To properly handle input that spans multiple lines, a push parser is used instead of the current pull parser.
It worked as an example, but was not much help for Octave since we are using Qt.
So now jwe has reworked it using Qt and you can find the sources here:

https://hg.octave.org/jwe-qt-gui-with-push-parser

See the [https://hg.octave.org/jwe-qt-gui-with-push-parser/file/tip/NOTES NOTES file] for build instructions.
That file also contains the following list of open questions that will need to be resolved if we are going to attempt a switch.


== Open questions ==

=== Threads ===

# With this arrangement, would the interpreter have to run in a separate thread? As the example shows, it's not absolutely necessary.  It could offer some advantages, but only if it is possible for the GUI to do useful things while the interpreter is busy.
# If the interpreter is not running in a separate thread but but the graphics engine is, then what happens to graphics callbacks when the parser is in the middle of parsing an expression?  Or is this not an issue because separate parsers can be used even if there is only one evaluator?  Could it ultimately be possible to have the evaluator running in multiple threads?
# If the interpreter does run in a separate thread, we still must wait for it to calculate and return a result so we can synchronize input and output.  Otherwise, we may print the next prompt before the output from the previous expression is evaluated and printed.  You'll see this behavior if you build the example program with CALC_USE_INTERPRETER_THREAD defined.

=== Multiple-line handling ===

# The example parser currently also performs evaluations and computes results immediately so it doesn't properly handle expression lists that are split across multiple lines.  Octave wouldn't have this problem because we already build a parse tree then execute it once it is complete.
# The example program doesn't attempt handle multi-line prompts or prompts with invisible characters (color specifications, for example). Fixing that will make the redisplay function significantly more complex. See, for example, how complicated the default rl_redisplay function is in the readline library.  Unless we actually write a terminal emulator (like the current terminal widgets) then it is not possible to use readline's rl_redisplay function directly.

=== Cursor position ===

# Do we need text position markers to keep track of the prompt position (beginning of current line) when inserting or clearing text? This doesn't seem necessary in the current example, but it doesn't have functions that can clear the screen or otherwise redraw prior output that would cause the position of the cursor in the window to change.

=== Pager ===

# We'll need to implement a pager ourselves, since "less" won't work in this simplified terminal widget.

=== History ===

# If readline runs in the terminal widget, who owns the command-line history?  Either way, if the GUI is in control of keyboard input, it will need access to the history list and Octave will also need access for the history functions.

=== External programs / Portability ===

# The system function may need to be modified so that external programs that expect to be running in a terminal will continue to work properly.  On Unixy systems, this job can be done with ptys.  I guess Windows systems can use a hidden console?  But if these things are required, are we more or less back to were we were before since we used a pty and hidden console to implement the terminal widgets?  I believe the Emacs start-process function must do similar things, so we might be able to reuse that code.


=== [[International Characters Support]] ===

# Does GNU Readline support Unicode input?  What are the limiting factors to support Unicode?
#* '''MAYBE.''' If correctly configured, reasonably recent versions of GNU readline support 8bit characters if LC_CTYPE is set to a UTF-8 locale. Versions 6.1 and newer versions should be working if the user didn't override "meta-flag", "convert-meta", or "output-meta" (maybe also others). It is unclear from the documentation whether this also means support for all UTF-8 characters (including multibyte characters). But bash uses readline and it supports UTF-8. So it should be possible.
#* '''MAYBE.''' Setting LC_CTYPE to a UTF-8 locale is invalid on Windows but we could set the necessary flags manually.
#** Can we manage this problem in current MXE builds?
#*** '''MAYBE.''' See the patch in {{bug|47571}} ([https://savannah.gnu.org/bugs/?47571#comment42 comment #42]).
# Can the open bugs be resolved with the new solution?
#* <s>{{bug|56173}} (probably unrelated)</s> fixed/closed
#* {{bug|47571}} (probably resolved)
#* {{bug|43099}} (probably resolved)
#* {{bug|55689}} (probably resolved)
#* {{bug|50409}} (probably unrelated)
#* {{bug|59495}} (probably resolved)
#* {{bug|56224}} (probably resolved)
#* <s>{{bug|53809}} (probably resolved)</s> closed
#* {{bug|54069}} (probably resolved)
#* {{bug|58717}} (probably resolved)

=== Alternatives ===

# [https://github.com/jupyter/qtconsole qtconsole]
#* (+) Fancy interactive features including plots
#* (+) Contains history and a pager
#* (-) Written in Python
# [https://github.com/lxqt/qtermwidget qtermwidget]
#* (+) Reusable component (less Octave code) as shared and development library [https://packages.debian.org/stretch/libqtermwidget5-0 Debian],  [https://software.opensuse.org/package/libqtermwidget5-0 openSUSE].
#* (+) Contains history (and a pager?)
#* (+) Written in C++
#* (-) AFAIK, the current implementation was forked from this implementation some years ago. It deviated quite substantially which makes merging difficult and which might suggest that the original implementation doesn't fit our needs (confirmation needed).
#* (-) Not cross-platform ([https://github.com/lxqt/qtermwidget/issues/240 no Windows support]).

[[Category:Development]]