Mercurial > octave
view liboctave/util/cmd-edit.h @ 32628:ae4e19c0a2b1
maint: Place class name and class keyword on one line.
* libinterp/corefcn/Cell.h, libinterp/corefcn/__magick_read__.cc,
libinterp/corefcn/auto-shlib.h, libinterp/corefcn/base-text-renderer.h,
libinterp/corefcn/c-file-ptr-stream.h, libinterp/corefcn/call-stack.h,
libinterp/corefcn/dynamic-ld.h, libinterp/corefcn/event-manager.h,
libinterp/corefcn/event-queue.h, libinterp/corefcn/ft-text-renderer.cc,
libinterp/corefcn/gl-render.cc, libinterp/corefcn/gl-render.h,
libinterp/corefcn/gl2ps-print.cc, libinterp/corefcn/graphics.cc,
libinterp/corefcn/graphics.in.h, libinterp/corefcn/input.cc,
libinterp/corefcn/latex-text-renderer.cc, libinterp/corefcn/load-path.h,
libinterp/corefcn/mx-type-traits.h, libinterp/corefcn/oct-errno.h,
libinterp/corefcn/oct-fstrm.h, libinterp/corefcn/oct-iostrm.h,
libinterp/corefcn/oct-prcstrm.h, libinterp/corefcn/oct-procbuf.h,
libinterp/corefcn/oct-process.h, libinterp/corefcn/oct-stdstrm.h,
libinterp/corefcn/oct-stream.cc, libinterp/corefcn/oct-stream.h,
libinterp/corefcn/oct-strstrm.h, libinterp/corefcn/pager.h,
libinterp/corefcn/pr-flt-fmt.h, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pr-output.h, libinterp/corefcn/procstream.h,
libinterp/corefcn/syminfo.h, libinterp/corefcn/text-engine.h,
libinterp/corefcn/text-renderer.h, libinterp/corefcn/utils.h,
libinterp/octave-value/cdef-class.h, libinterp/octave-value/cdef-manager.h,
libinterp/octave-value/cdef-method.h, libinterp/octave-value/cdef-object.h,
libinterp/octave-value/cdef-package.h, libinterp/octave-value/cdef-property.h,
libinterp/octave-value/ov-base-diag.h, libinterp/octave-value/ov-base-int.h,
libinterp/octave-value/ov-base-mat.h, libinterp/octave-value/ov-base-scalar.h,
libinterp/octave-value/ov-base-sparse.h, libinterp/octave-value/ov-base.h,
libinterp/octave-value/ov-bool-mat.h, libinterp/octave-value/ov-bool-sparse.h,
libinterp/octave-value/ov-bool.h, libinterp/octave-value/ov-builtin.h,
libinterp/octave-value/ov-cell.h, libinterp/octave-value/ov-ch-mat.h,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-class.h,
libinterp/octave-value/ov-classdef.h, libinterp/octave-value/ov-colon.h,
libinterp/octave-value/ov-complex.h, libinterp/octave-value/ov-cs-list.h,
libinterp/octave-value/ov-cx-diag.h, libinterp/octave-value/ov-cx-mat.h,
libinterp/octave-value/ov-cx-sparse.h, libinterp/octave-value/ov-dld-fcn.h,
libinterp/octave-value/ov-fcn-handle.h, libinterp/octave-value/ov-fcn.h,
libinterp/octave-value/ov-float.h, libinterp/octave-value/ov-flt-complex.h,
libinterp/octave-value/ov-flt-cx-diag.h,
libinterp/octave-value/ov-flt-cx-mat.h,
libinterp/octave-value/ov-flt-re-diag.h,
libinterp/octave-value/ov-flt-re-mat.h, libinterp/octave-value/ov-int-traits.h,
libinterp/octave-value/ov-intx.h, libinterp/octave-value/ov-lazy-idx.h,
libinterp/octave-value/ov-legacy-range.cc,
libinterp/octave-value/ov-legacy-range.h,
libinterp/octave-value/ov-magic-int.h, libinterp/octave-value/ov-mex-fcn.h,
libinterp/octave-value/ov-null-mat.h, libinterp/octave-value/ov-perm.h,
libinterp/octave-value/ov-range-traits.h, libinterp/octave-value/ov-range.h,
libinterp/octave-value/ov-re-diag.h, libinterp/octave-value/ov-re-mat.h,
libinterp/octave-value/ov-re-sparse.h, libinterp/octave-value/ov-scalar.h,
libinterp/octave-value/ov-str-mat.h, libinterp/octave-value/ov-struct.h,
libinterp/octave-value/ov-typeinfo.h, libinterp/octave-value/ov-usr-fcn.h,
libinterp/octave-value/ov.h, libinterp/octave-value/ovl.h,
libinterp/parse-tree/comment-list.h, libinterp/parse-tree/lex.h,
libinterp/parse-tree/profiler.h, libinterp/parse-tree/pt-anon-scopes.h,
liboctave/array/Array.h, liboctave/array/CColVector.h,
liboctave/array/CDiagMatrix.h, liboctave/array/CMatrix.h,
liboctave/array/CNDArray.h, liboctave/array/CRowVector.h,
liboctave/array/CSparse.h, liboctave/array/DiagArray2.h,
liboctave/array/MArray.h, liboctave/array/MDiagArray2.h,
liboctave/array/MSparse.h, liboctave/array/MatrixType.h,
liboctave/array/Range.h, liboctave/array/Sparse.h,
liboctave/array/boolMatrix.h, liboctave/array/boolNDArray.h,
liboctave/array/boolSparse.h, liboctave/array/chMatrix.h,
liboctave/array/chNDArray.h, liboctave/array/dColVector.h,
liboctave/array/dDiagMatrix.h, liboctave/array/dMatrix.h,
liboctave/array/dNDArray.h, liboctave/array/dRowVector.h,
liboctave/array/dSparse.h, liboctave/array/dim-vector.h,
liboctave/array/fCColVector.h, liboctave/array/fCDiagMatrix.h,
liboctave/array/fCMatrix.h, liboctave/array/fCNDArray.h,
liboctave/array/fCRowVector.h, liboctave/array/fColVector.h,
liboctave/array/fDiagMatrix.h, liboctave/array/fMatrix.h,
liboctave/array/fNDArray.h, liboctave/array/fRowVector.h,
liboctave/array/idx-vector.h, liboctave/array/intNDArray.h,
liboctave/numeric/DAE.h, liboctave/numeric/DAEFunc.h,
liboctave/numeric/DAERT.h, liboctave/numeric/DAERTFunc.h,
liboctave/numeric/DASPK.h, liboctave/numeric/DASRT.h,
liboctave/numeric/DASSL.h, liboctave/numeric/DET.h, liboctave/numeric/EIG.h,
liboctave/numeric/LSODE.h, liboctave/numeric/ODE.h,
liboctave/numeric/ODEFunc.h, liboctave/numeric/ODES.h,
liboctave/numeric/ODESFunc.h, liboctave/numeric/Quad.h,
liboctave/numeric/aepbalance.h, liboctave/numeric/base-dae.h,
liboctave/numeric/base-de.h, liboctave/numeric/chol.h,
liboctave/numeric/fEIG.h, liboctave/numeric/gepbalance.h,
liboctave/numeric/gsvd.h, liboctave/numeric/hess.h, liboctave/numeric/lu.h,
liboctave/numeric/oct-fftw.h, liboctave/numeric/qr.h, liboctave/numeric/qrp.h,
liboctave/numeric/schur.h, liboctave/numeric/sparse-chol.h,
liboctave/numeric/sparse-lu.h, liboctave/numeric/sparse-qr.cc,
liboctave/numeric/sparse-qr.h, liboctave/numeric/svd.cc,
liboctave/numeric/svd.h, liboctave/system/dir-ops.h,
liboctave/system/file-stat.h, liboctave/system/oct-env.h,
liboctave/system/oct-group.h, liboctave/system/oct-password.h,
liboctave/system/oct-time.h, liboctave/system/oct-uname.h,
liboctave/util/action-container.h, liboctave/util/base-list.h,
liboctave/util/cmd-edit.cc, liboctave/util/cmd-edit.h,
liboctave/util/cmd-hist.cc, liboctave/util/cmd-hist.h,
liboctave/util/data-conv.h, liboctave/util/glob-match.h,
liboctave/util/lo-regexp.h, liboctave/util/oct-inttypes.h,
liboctave/util/oct-mutex.cc, liboctave/util/oct-mutex.h,
liboctave/util/oct-shlib.cc, liboctave/util/oct-shlib.h,
liboctave/util/oct-sort.h, liboctave/util/oct-string.h,
liboctave/util/octave-preserve-stream-state.h, liboctave/util/pathsearch.h,
liboctave/util/singleton-cleanup.h, liboctave/util/str-vec.h,
liboctave/util/unwind-prot.h, liboctave/util/url-transfer.h:
Place class name and class keyword on one line.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 21 Dec 2023 11:22:26 -0800 |
parents | 2da025d5e98d |
children | 4b601ca024d5 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1996-2023 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave is free software: you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if ! defined (octave_cmd_edit_h) #define octave_cmd_edit_h 1 #include "octave-config.h" #include <cstdio> #include <set> #include <string> #include "str-vec.h" OCTAVE_BEGIN_NAMESPACE(octave) class OCTAVE_API command_editor { protected: command_editor () : m_command_number (1), m_rows (24), m_cols (80), m_interrupted (false), m_interrupt_event_loop (false), m_initial_input () { } public: typedef int (*startup_hook_fcn) (); typedef int (*pre_input_hook_fcn) (); typedef int (*event_hook_fcn) (); typedef std::string (*completion_fcn) (const std::string&, int); typedef char *(*completion_hook_fcn) (); typedef std::string (*quoting_fcn) (const std::string&, int, char); typedef std::string (*dequoting_fcn) (const std::string&, int); typedef int (*char_is_quoted_fcn) (const std::string&, int); typedef void (*user_accept_line_fcn) (const std::string&); OCTAVE_DISABLE_COPY_MOVE (command_editor) virtual ~command_editor () = default; static void set_name (const std::string& n); static std::string readline (const std::string& prompt); static std::string readline (const std::string& prompt, bool& eof); static void set_input_stream (FILE *f); static FILE * get_input_stream (); static void set_output_stream (FILE *f); static FILE * get_output_stream (); static void redisplay (); static int terminal_rows (); static int terminal_cols (); static void clear_screen (bool skip_redisplay = false); static void resize_terminal (); static void set_screen_size (int ht, int wd); static std::string decode_prompt_string (const std::string& s); static void restore_terminal_state (); static void blink_matching_paren (bool flag); static bool erase_empty_line (bool flag); static void set_basic_word_break_characters (const std::string& s); static void set_completer_word_break_characters (const std::string& s); static void set_basic_quote_characters (const std::string& s); static void set_filename_quote_characters (const std::string& s); static void set_completer_quote_characters (const std::string& s); static void set_completion_append_character (char c); static void set_completion_function (completion_fcn f); static void set_quoting_function (quoting_fcn f); static void set_dequoting_function (dequoting_fcn f); static void set_char_is_quoted_function (char_is_quoted_fcn f); static void set_user_accept_line_function (user_accept_line_fcn f); static completion_fcn get_completion_function (); static quoting_fcn get_quoting_function (); static dequoting_fcn get_dequoting_function (); static char_is_quoted_fcn get_char_is_quoted_function (); static user_accept_line_fcn get_user_accept_line_function (); static string_vector generate_filename_completions (const std::string& text); static std::string get_line_buffer (); static std::string get_current_line (); static char get_prev_char (int); static void replace_line (const std::string& text, bool clear_undo = true); static void kill_full_line (); static void insert_text (const std::string& text); static void newline (); static void accept_line (); static bool undo (); static void clear_undo_list (); static void add_startup_hook (startup_hook_fcn f); static void remove_startup_hook (startup_hook_fcn f); static void add_pre_input_hook (pre_input_hook_fcn f); static void remove_pre_input_hook (pre_input_hook_fcn f); static void add_event_hook (event_hook_fcn f); static void remove_event_hook (event_hook_fcn f); static void run_event_hooks (); static void read_init_file (const std::string& file = ""); static void re_read_init_file (); static bool filename_completion_desired (bool); static bool filename_quoting_desired (bool); static bool prefer_env_winsize (bool); static bool interrupt (bool = true); static void interrupt_event_loop (bool flag = true); static bool event_loop_interrupted (); static int current_command_number (); static void reset_current_command_number (int n); static void increment_current_command_number (); static void force_default_editor (); static void set_initial_input (const std::string& text); static int insert_initial_input (); private: static bool instance_ok (); static void make_command_editor (); static int startup_handler (); static int pre_input_handler (); static int event_handler (); static void cleanup_instance () { delete s_instance; s_instance = nullptr; } static void handle_interrupt_signal (); //-------- static command_editor *s_instance; // the real thing. static std::set<startup_hook_fcn> s_startup_hook_set; static std::set<pre_input_hook_fcn> s_pre_input_hook_set; static std::set<event_hook_fcn> s_event_hook_set; protected: // To use something other than the GNU readline library, derive a new // class from command_editor, overload these functions as // necessary, and make instance point to the new class. virtual void do_set_name (const std::string&) { } std::string do_readline (const std::string& prompt) { bool eof; return do_readline (prompt, eof); } virtual std::string do_readline (const std::string&, bool&) = 0; virtual void do_set_input_stream (FILE *) = 0; virtual FILE * do_get_input_stream () = 0; virtual void do_set_output_stream (FILE *) = 0; virtual FILE * do_get_output_stream () = 0; virtual void do_redisplay () { } virtual int do_terminal_rows () { return m_rows; } virtual int do_terminal_cols () { return m_cols; } virtual void do_clear_screen (bool) { } virtual void do_resize_terminal () { } virtual void do_set_screen_size (int ht, int wd) { m_rows = ht; m_cols = wd; } virtual std::string do_decode_prompt_string (const std::string&); virtual std::string newline_chars () { return "\n"; } virtual void do_restore_terminal_state () { } virtual void do_blink_matching_paren (bool) { } virtual bool do_erase_empty_line (bool) { return false; } virtual void do_set_basic_word_break_characters (const std::string&) { } virtual void do_set_completer_word_break_characters (const std::string&) { } virtual void do_set_completer_word_break_hook (completion_hook_fcn) { } virtual void do_set_basic_quote_characters (const std::string&) { } virtual void do_set_filename_quote_characters (const std::string&) { } virtual void do_set_completer_quote_characters (const std::string&) { } virtual void do_set_completion_append_character (char) { } virtual void do_set_completion_function (completion_fcn) { } virtual void do_set_quoting_function (quoting_fcn) { } virtual void do_set_dequoting_function (dequoting_fcn) { } virtual void do_set_char_is_quoted_function (char_is_quoted_fcn) { } virtual void do_set_user_accept_line_function (user_accept_line_fcn) { } virtual completion_fcn do_get_completion_function () const { return nullptr; } virtual quoting_fcn do_get_quoting_function () const { return nullptr; } virtual dequoting_fcn do_get_dequoting_function () const { return nullptr; } virtual char_is_quoted_fcn do_get_char_is_quoted_function () const { return nullptr; } virtual user_accept_line_fcn do_get_user_accept_line_function () const { return nullptr; } virtual string_vector do_generate_filename_completions (const std::string& text) = 0; virtual std::string do_get_line_buffer () const = 0; virtual std::string do_get_current_line () const = 0; virtual char do_get_prev_char (int) const = 0; virtual void do_replace_line (const std::string& text, bool clear_undo) = 0; virtual void do_kill_full_line () = 0; virtual void do_insert_text (const std::string& text) = 0; virtual void do_newline () = 0; virtual void do_accept_line () = 0; virtual bool do_undo () { return false; } virtual void do_clear_undo_list () { } virtual void set_startup_hook (startup_hook_fcn) { } virtual void restore_startup_hook () { } virtual void set_pre_input_hook (pre_input_hook_fcn) { } virtual void restore_pre_input_hook () { } virtual void set_event_hook (event_hook_fcn) { } virtual void restore_event_hook () { } virtual void do_read_init_file (const std::string&) { } virtual void do_re_read_init_file () { } virtual bool do_filename_completion_desired (bool) { return false; } virtual bool do_filename_quoting_desired (bool) { return false; } virtual bool do_prefer_env_winsize (bool) { return false; } virtual void do_interrupt (bool) { } virtual void do_handle_interrupt_signal () { } void do_interrupt_event_loop (bool arg) { m_interrupt_event_loop = arg; } bool do_event_loop_interrupted () const { return m_interrupt_event_loop; } int do_insert_initial_input (); int read_octal (const std::string& s); void error (int); void error (const std::string&); // The current command number. int m_command_number; int m_rows; int m_cols; bool m_interrupted; bool m_interrupt_event_loop; std::string m_initial_input; }; OCTAVE_END_NAMESPACE(octave) #endif