#include "cmd-edit.h"

Inheritance diagram for octave::command_editor:

Collaboration diagram for octave::command_editor:

[legend]

Public Types
typedef int(*	char_is_quoted_fcn) (const std::string &, int)

typedef std::string(*	completion_fcn) (const std::string &, int)

typedef char (	completion_hook_fcn) ()

typedef std::string(*	dequoting_fcn) (const std::string &, int)

typedef int(*	event_hook_fcn) (void)

typedef int(*	pre_input_hook_fcn) (void)

typedef std::string(*	quoting_fcn) (const std::string &, int, char)

typedef int(*	startup_hook_fcn) (void)

typedef void(*	user_accept_line_fcn) (const std::string &)

Public Member Functions
	command_editor (const command_editor &)=delete

virtual	~command_editor (void)=default

command_editor &	operator= (const command_editor &)=delete

Static Public Member Functions
static void	accept_line (void)

static void	add_event_hook (event_hook_fcn f)

static void	add_pre_input_hook (pre_input_hook_fcn f)

static void	add_startup_hook (startup_hook_fcn f)

static void	blink_matching_paren (bool flag)

static void	clear_screen (bool skip_redisplay=false)

static void	clear_undo_list (void)

static int	current_command_number (void)

static std::string	decode_prompt_string (const std::string &s)

static bool	erase_empty_line (bool flag)

static bool	event_loop_interrupted (void)

static bool	filename_completion_desired (bool)

static bool	filename_quoting_desired (bool)

static void	force_default_editor (void)

static string_vector	generate_filename_completions (const std::string &text)

static char_is_quoted_fcn	get_char_is_quoted_function (void)

static completion_fcn	get_completion_function (void)

static std::string	get_current_line (void)

static dequoting_fcn	get_dequoting_function (void)

static FILE *	get_input_stream (void)

static std::string	get_line_buffer (void)

static FILE *	get_output_stream (void)

static char	get_prev_char (int)

static quoting_fcn	get_quoting_function (void)

static user_accept_line_fcn	get_user_accept_line_function (void)

static void	increment_current_command_number (void)

static int	insert_initial_input (void)

static void	insert_text (const std::string &text)

static bool	interrupt (bool=true)

static void	interrupt_event_loop (bool flag=true)

static void	kill_full_line (void)

static void	newline (void)

static bool	prefer_env_winsize (bool)

static void	re_read_init_file (void)

static void	read_init_file (const std::string &file="")

static std::string	readline (const std::string &prompt)

static std::string	readline (const std::string &prompt, bool &eof)

static void	redisplay (void)

static void	remove_event_hook (event_hook_fcn f)

static void	remove_pre_input_hook (pre_input_hook_fcn f)

static void	remove_startup_hook (startup_hook_fcn f)

static void	replace_line (const std::string &text, bool clear_undo=true)

static void	reset_current_command_number (int n)

static void	resize_terminal (void)

static void	restore_terminal_state (void)

static void	run_event_hooks (void)

static void	set_basic_quote_characters (const std::string &s)

static void	set_basic_word_break_characters (const std::string &s)

static void	set_char_is_quoted_function (char_is_quoted_fcn f)

static void	set_completer_quote_characters (const std::string &s)

static void	set_completer_word_break_characters (const std::string &s)

static void	set_completion_append_character (char c)

static void	set_completion_function (completion_fcn f)

static void	set_dequoting_function (dequoting_fcn f)

static void	set_filename_quote_characters (const std::string &s)

static void	set_initial_input (const std::string &text)

static void	set_input_stream (FILE *f)

static void	set_name (const std::string &n)

static void	set_output_stream (FILE *f)

static void	set_quoting_function (quoting_fcn f)

static void	set_screen_size (int ht, int wd)

static void	set_user_accept_line_function (user_accept_line_fcn f)

static int	terminal_cols (void)

static int	terminal_rows (void)

static bool	undo (void)

Protected Member Functions
	command_editor (void)

virtual void	do_accept_line (void)=0

virtual void	do_blink_matching_paren (bool)

virtual void	do_clear_screen (bool)

virtual void	do_clear_undo_list (void)

virtual std::string	do_decode_prompt_string (const std::string &)

virtual bool	do_erase_empty_line (bool)

bool	do_event_loop_interrupted (void) const

virtual bool	do_filename_completion_desired (bool)

virtual bool	do_filename_quoting_desired (bool)

virtual string_vector	do_generate_filename_completions (const std::string &text)=0

virtual char_is_quoted_fcn	do_get_char_is_quoted_function (void) const

virtual completion_fcn	do_get_completion_function (void) const

virtual std::string	do_get_current_line (void) const =0

virtual dequoting_fcn	do_get_dequoting_function (void) const

virtual FILE *	do_get_input_stream (void)=0

virtual std::string	do_get_line_buffer (void) const =0

virtual FILE *	do_get_output_stream (void)=0

virtual char	do_get_prev_char (int) const =0

virtual quoting_fcn	do_get_quoting_function (void) const

virtual user_accept_line_fcn	do_get_user_accept_line_function (void) const

virtual void	do_handle_interrupt_signal (void)

int	do_insert_initial_input (void)

virtual void	do_insert_text (const std::string &text)=0

virtual void	do_interrupt (bool)

void	do_interrupt_event_loop (bool arg)

virtual void	do_kill_full_line (void)=0

virtual void	do_newline (void)=0

virtual bool	do_prefer_env_winsize (bool)

virtual void	do_re_read_init_file (void)

virtual void	do_read_init_file (const std::string &)

virtual std::string	do_readline (const std::string &, bool &)=0

std::string	do_readline (const std::string &prompt)

virtual void	do_redisplay (void)

virtual void	do_replace_line (const std::string &text, bool clear_undo)=0

virtual void	do_resize_terminal (void)

virtual void	do_restore_terminal_state (void)

virtual void	do_set_basic_quote_characters (const std::string &)

virtual void	do_set_basic_word_break_characters (const std::string &)

virtual void	do_set_char_is_quoted_function (char_is_quoted_fcn)

virtual void	do_set_completer_quote_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_completion_append_character (char)

virtual void	do_set_completion_function (completion_fcn)

virtual void	do_set_dequoting_function (dequoting_fcn)

virtual void	do_set_filename_quote_characters (const std::string &)

virtual void	do_set_input_stream (FILE *)=0

virtual void	do_set_name (const std::string &)

virtual void	do_set_output_stream (FILE *)=0

virtual void	do_set_quoting_function (quoting_fcn)

virtual void	do_set_screen_size (int ht, int wd)

virtual void	do_set_user_accept_line_function (user_accept_line_fcn)

virtual int	do_terminal_cols (void)

virtual int	do_terminal_rows (void)

virtual bool	do_undo (void)

void	error (const std::string &)

void	error (int)

virtual std::string	newline_chars (void)

int	read_octal (const std::string &s)

virtual void	restore_event_hook (void)

virtual void	restore_pre_input_hook (void)

virtual void	restore_startup_hook (void)

virtual void	set_event_hook (event_hook_fcn)

virtual void	set_pre_input_hook (pre_input_hook_fcn)

virtual void	set_startup_hook (startup_hook_fcn)

Protected Attributes
int	m_cols

int	m_command_number

std::string	m_initial_input

bool	m_interrupt_event_loop

bool	m_interrupted

int	m_rows

Static Private Member Functions
static void	cleanup_instance (void)

static int	event_handler (void)

static void	handle_interrupt_signal (void)

static bool	instance_ok (void)

static void	make_command_editor (void)

static int	pre_input_handler (void)

static int	startup_handler (void)

Static Private Attributes
static std::set< event_hook_fcn >	event_hook_set

static std::set< pre_input_hook_fcn >	pre_input_hook_set

static command_editor *	s_instance = nullptr

static std::set< startup_hook_fcn >	startup_hook_set

Detailed Description

Definition at line 40 of file cmd-edit.h.

Member Typedef Documentation

◆ char_is_quoted_fcn

typedef int(* octave::command_editor::char_is_quoted_fcn) (const std::string &, int)

Definition at line 67 of file cmd-edit.h.

◆ completion_fcn

typedef std::string(* octave::command_editor::completion_fcn) (const std::string &, int)

Definition at line 59 of file cmd-edit.h.

◆ completion_hook_fcn

typedef char*(* octave::command_editor::completion_hook_fcn) ()

Definition at line 61 of file cmd-edit.h.

◆ dequoting_fcn

typedef std::string(* octave::command_editor::dequoting_fcn) (const std::string &, int)

Definition at line 65 of file cmd-edit.h.

◆ event_hook_fcn

typedef int(* octave::command_editor::event_hook_fcn) (void)

Definition at line 57 of file cmd-edit.h.

◆ pre_input_hook_fcn

typedef int(* octave::command_editor::pre_input_hook_fcn) (void)

Definition at line 55 of file cmd-edit.h.

◆ quoting_fcn

typedef std::string(* octave::command_editor::quoting_fcn) (const std::string &, int, char)

Definition at line 63 of file cmd-edit.h.

◆ startup_hook_fcn

typedef int(* octave::command_editor::startup_hook_fcn) (void)

Definition at line 53 of file cmd-edit.h.

◆ user_accept_line_fcn

typedef void(* octave::command_editor::user_accept_line_fcn) (const std::string &)

Definition at line 69 of file cmd-edit.h.

Constructor & Destructor Documentation

◆ command_editor() [1/2]

octave::command_editor::command_editor ( void )

inlineprotected

Definition at line 46 of file cmd-edit.h.

◆ command_editor() [2/2]

octave::command_editor::command_editor ( const command_editor & )

delete

◆ ~command_editor()

virtual octave::command_editor::~command_editor ( void )

virtualdefault

Member Function Documentation

◆ accept_line()

void octave::command_editor::accept_line ( void )

static

Definition at line 1480 of file cmd-edit.cc.

Referenced by octave::octave_qscintilla::contextmenu_run(), octave::main_window::execute_command_in_terminal(), and octave::main_window::run_file_in_terminal().

◆ add_event_hook()

void octave::command_editor::add_event_hook ( event_hook_fcn f )

static

Definition at line 1552 of file cmd-edit.cc.

References octave::event_hook_lock, and f.

Referenced by octave::event_manager::event_manager(), gh_manager::enable_event_processing(), and gh_manager::post_event().

◆ add_pre_input_hook()

void octave::command_editor::add_pre_input_hook ( pre_input_hook_fcn f )

static

Definition at line 1526 of file cmd-edit.cc.

References f.

◆ add_startup_hook()

void octave::command_editor::add_startup_hook ( startup_hook_fcn f )

static

Definition at line 1500 of file cmd-edit.cc.

References f.

◆ blink_matching_paren()

void octave::command_editor::blink_matching_paren ( bool flag )

static

Definition at line 1302 of file cmd-edit.cc.

Referenced by octave::interpreter::execute().

◆ cleanup_instance()

static void octave::command_editor::cleanup_instance ( void )

inlinestaticprivate

Definition at line 230 of file cmd-edit.h.

◆ clear_screen()

void octave::command_editor::clear_screen ( bool skip_redisplay = false )

static

Definition at line 1248 of file cmd-edit.cc.

Referenced by Fclc(), and octave::main_window::handle_clear_command_window_request().

◆ clear_undo_list()

void octave::command_editor::clear_undo_list ( void )

static

Definition at line 1493 of file cmd-edit.cc.

◆ current_command_number()

int octave::command_editor::current_command_number ( void )

static

Definition at line 1275 of file cmd-edit.cc.

◆ decode_prompt_string()

std::string octave::command_editor::decode_prompt_string ( const std::string & s )

static

Definition at line 1269 of file cmd-edit.cc.

Referenced by octave::tree_evaluator::echo_code(), octave::lexer::fill_flex_buffer(), octave::debugger::repl(), and octave::push_parser::run().

◆ do_accept_line()

virtual void octave::command_editor::do_accept_line ( void )

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_blink_matching_paren()

virtual void octave::command_editor::do_blink_matching_paren ( bool )

inlineprotectedvirtual

Definition at line 285 of file cmd-edit.h.

◆ do_clear_screen()

virtual void octave::command_editor::do_clear_screen ( bool )

inlineprotectedvirtual

Definition at line 269 of file cmd-edit.h.

◆ do_clear_undo_list()

virtual void octave::command_editor::do_clear_undo_list ( void )

inlineprotectedvirtual

Definition at line 346 of file cmd-edit.h.

◆ do_decode_prompt_string()

std::string octave::command_editor::do_decode_prompt_string ( const std::string & s )

protectedvirtual

Definition at line 1682 of file cmd-edit.cc.

References n, octave_geteuid_wrapper(), octave_rl_prompt_end_ignore(), octave_rl_prompt_start_ignore(), retval, and octave::sys::base_tm::strftime().

◆ do_erase_empty_line()

virtual bool octave::command_editor::do_erase_empty_line ( bool )

inlineprotectedvirtual

Definition at line 287 of file cmd-edit.h.

◆ do_event_loop_interrupted()

bool octave::command_editor::do_event_loop_interrupted ( void ) const

inlineprotected

Definition at line 376 of file cmd-edit.h.

◆ do_filename_completion_desired()

virtual bool octave::command_editor::do_filename_completion_desired ( bool )

inlineprotectedvirtual

Definition at line 364 of file cmd-edit.h.

◆ do_filename_quoting_desired()

virtual bool octave::command_editor::do_filename_quoting_desired ( bool )

inlineprotectedvirtual

Definition at line 366 of file cmd-edit.h.

◆ do_generate_filename_completions()

virtual string_vector octave::command_editor::do_generate_filename_completions ( const std::string & text )

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_get_char_is_quoted_function()

virtual char_is_quoted_fcn octave::command_editor::do_get_char_is_quoted_function ( void ) const

inlineprotectedvirtual

Definition at line 319 of file cmd-edit.h.

◆ do_get_completion_function()

virtual completion_fcn octave::command_editor::do_get_completion_function ( void ) const

inlineprotectedvirtual

Definition at line 313 of file cmd-edit.h.

◆ do_get_current_line()

virtual std::string octave::command_editor::do_get_current_line ( void ) const

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_get_dequoting_function()

virtual dequoting_fcn octave::command_editor::do_get_dequoting_function ( void ) const

inlineprotectedvirtual

Definition at line 317 of file cmd-edit.h.

◆ do_get_input_stream()

virtual FILE* octave::command_editor::do_get_input_stream ( void )

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_get_line_buffer()

virtual std::string octave::command_editor::do_get_line_buffer ( void ) const

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_get_output_stream()

virtual FILE* octave::command_editor::do_get_output_stream ( void )

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_get_prev_char()

virtual char octave::command_editor::do_get_prev_char ( int ) const

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_get_quoting_function()

virtual quoting_fcn octave::command_editor::do_get_quoting_function ( void ) const

inlineprotectedvirtual

Definition at line 315 of file cmd-edit.h.

◆ do_get_user_accept_line_function()

virtual user_accept_line_fcn octave::command_editor::do_get_user_accept_line_function ( void ) const

inlineprotectedvirtual

Definition at line 322 of file cmd-edit.h.

◆ do_handle_interrupt_signal()

virtual void octave::command_editor::do_handle_interrupt_signal ( void )

inlineprotectedvirtual

Definition at line 372 of file cmd-edit.h.

◆ do_insert_initial_input()

int octave::command_editor::do_insert_initial_input ( void )

protected

Definition at line 1909 of file cmd-edit.cc.

References input().

◆ do_insert_text()

virtual void octave::command_editor::do_insert_text ( const std::string & text )

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_interrupt()

virtual void octave::command_editor::do_interrupt ( bool )

inlineprotectedvirtual

Definition at line 370 of file cmd-edit.h.

◆ do_interrupt_event_loop()

void octave::command_editor::do_interrupt_event_loop ( bool arg )

inlineprotected

Definition at line 374 of file cmd-edit.h.

◆ do_kill_full_line()

virtual void octave::command_editor::do_kill_full_line ( void )

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_newline()

virtual void octave::command_editor::do_newline ( void )

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_prefer_env_winsize()

virtual bool octave::command_editor::do_prefer_env_winsize ( bool )

inlineprotectedvirtual

Definition at line 368 of file cmd-edit.h.

◆ do_re_read_init_file()

virtual void octave::command_editor::do_re_read_init_file ( void )

inlineprotectedvirtual

Definition at line 362 of file cmd-edit.h.

◆ do_read_init_file()

virtual void octave::command_editor::do_read_init_file ( const std::string & )

inlineprotectedvirtual

Definition at line 360 of file cmd-edit.h.

◆ do_readline() [1/2]

virtual std::string octave::command_editor::do_readline	(	const std::string &	,
		bool &
	)

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_readline() [2/2]

std::string octave::command_editor::do_readline ( const std::string & prompt )

inlineprotected

Definition at line 246 of file cmd-edit.h.

◆ do_redisplay()

virtual void octave::command_editor::do_redisplay ( void )

inlineprotectedvirtual

Definition at line 263 of file cmd-edit.h.

◆ do_replace_line()

virtual void octave::command_editor::do_replace_line	(	const std::string &	text,
		bool	clear_undo
	)

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_resize_terminal()

virtual void octave::command_editor::do_resize_terminal ( void )

inlineprotectedvirtual

Definition at line 271 of file cmd-edit.h.

◆ do_restore_terminal_state()

virtual void octave::command_editor::do_restore_terminal_state ( void )

inlineprotectedvirtual

Definition at line 283 of file cmd-edit.h.

◆ do_set_basic_quote_characters()

virtual void octave::command_editor::do_set_basic_quote_characters ( const std::string & )

inlineprotectedvirtual

Definition at line 295 of file cmd-edit.h.

◆ do_set_basic_word_break_characters()

virtual void octave::command_editor::do_set_basic_word_break_characters ( const std::string & )

inlineprotectedvirtual

Definition at line 289 of file cmd-edit.h.

◆ do_set_char_is_quoted_function()

virtual void octave::command_editor::do_set_char_is_quoted_function ( char_is_quoted_fcn )

inlineprotectedvirtual

Definition at line 309 of file cmd-edit.h.

◆ do_set_completer_quote_characters()

virtual void octave::command_editor::do_set_completer_quote_characters ( const std::string & )

inlineprotectedvirtual

Definition at line 299 of file cmd-edit.h.

◆ do_set_completer_word_break_characters()

virtual void octave::command_editor::do_set_completer_word_break_characters ( const std::string & )

inlineprotectedvirtual

Definition at line 291 of file cmd-edit.h.

◆ do_set_completer_word_break_hook()

virtual void octave::command_editor::do_set_completer_word_break_hook ( completion_hook_fcn )

inlineprotectedvirtual

Definition at line 293 of file cmd-edit.h.

◆ do_set_completion_append_character()

virtual void octave::command_editor::do_set_completion_append_character ( char )

inlineprotectedvirtual

Definition at line 301 of file cmd-edit.h.

◆ do_set_completion_function()

virtual void octave::command_editor::do_set_completion_function ( completion_fcn )

inlineprotectedvirtual

Definition at line 303 of file cmd-edit.h.

◆ do_set_dequoting_function()

virtual void octave::command_editor::do_set_dequoting_function ( dequoting_fcn )

inlineprotectedvirtual

Definition at line 307 of file cmd-edit.h.

◆ do_set_filename_quote_characters()

virtual void octave::command_editor::do_set_filename_quote_characters ( const std::string & )

inlineprotectedvirtual

Definition at line 297 of file cmd-edit.h.

◆ do_set_input_stream()

virtual void octave::command_editor::do_set_input_stream ( FILE * )

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_set_name()

virtual void octave::command_editor::do_set_name ( const std::string & )

inlineprotectedvirtual

Definition at line 244 of file cmd-edit.h.

◆ do_set_output_stream()

virtual void octave::command_editor::do_set_output_stream ( FILE * )

protectedpure virtual

Implemented in octave::default_command_editor.

◆ do_set_quoting_function()

virtual void octave::command_editor::do_set_quoting_function ( quoting_fcn )

inlineprotectedvirtual

Definition at line 305 of file cmd-edit.h.

◆ do_set_screen_size()

virtual void octave::command_editor::do_set_screen_size	(	int	ht,
		int	wd
	)

inlineprotectedvirtual

Definition at line 273 of file cmd-edit.h.

◆ do_set_user_accept_line_function()

virtual void octave::command_editor::do_set_user_accept_line_function ( user_accept_line_fcn )

inlineprotectedvirtual

Definition at line 311 of file cmd-edit.h.

◆ do_terminal_cols()

virtual int octave::command_editor::do_terminal_cols ( void )

inlineprotectedvirtual

Definition at line 267 of file cmd-edit.h.

◆ do_terminal_rows()

virtual int octave::command_editor::do_terminal_rows ( void )

inlineprotectedvirtual

Definition at line 265 of file cmd-edit.h.

◆ do_undo()

virtual bool octave::command_editor::do_undo ( void )

inlineprotectedvirtual

Definition at line 344 of file cmd-edit.h.

◆ erase_empty_line()

bool octave::command_editor::erase_empty_line ( bool flag )

static

Definition at line 1309 of file cmd-edit.cc.

Referenced by octave::octave_qscintilla::context_run(), octave::octave_qscintilla::contextmenu_run(), and octave::debugger::repl().

◆ error() [1/2]

void octave::command_editor::error ( const std::string & s )

protected

Definition at line 1955 of file cmd-edit.cc.

◆ error() [2/2]

void octave::command_editor::error ( int err_num )

protected

Definition at line 1949 of file cmd-edit.cc.

◆ event_handler()

int octave::command_editor::event_handler ( void )

staticprivate

Definition at line 1151 of file cmd-edit.cc.

References octave::event_hook_lock, f, octave::mutex::lock(), octave_interrupt_state, and octave::mutex::unlock().

◆ event_loop_interrupted()

bool octave::command_editor::event_loop_interrupted ( void )

static

Definition at line 1643 of file cmd-edit.cc.

Referenced by octave::action_container::run().

◆ filename_completion_desired()

bool octave::command_editor::filename_completion_desired ( bool arg )

static

Definition at line 1596 of file cmd-edit.cc.

◆ filename_quoting_desired()

bool octave::command_editor::filename_quoting_desired ( bool arg )

static

Definition at line 1603 of file cmd-edit.cc.

◆ force_default_editor()

void octave::command_editor::force_default_editor ( void )

static

Definition at line 1097 of file cmd-edit.cc.

◆ generate_filename_completions()

string_vector octave::command_editor::generate_filename_completions ( const std::string & text )

static

Definition at line 1424 of file cmd-edit.cc.

◆ get_char_is_quoted_function()

command_editor::char_is_quoted_fcn octave::command_editor::get_char_is_quoted_function ( void )

static

Definition at line 1410 of file cmd-edit.cc.

◆ get_completion_function()

command_editor::completion_fcn octave::command_editor::get_completion_function ( void )

static

Definition at line 1392 of file cmd-edit.cc.

◆ get_current_line()

std::string octave::command_editor::get_current_line ( void )

static

Definition at line 1438 of file cmd-edit.cc.

Referenced by octave::octave_qscintilla::contextmenu_run(), octave::main_window::execute_command_in_terminal(), and octave::main_window::run_file_in_terminal().

◆ get_dequoting_function()

command_editor::dequoting_fcn octave::command_editor::get_dequoting_function ( void )

static

Definition at line 1404 of file cmd-edit.cc.

◆ get_input_stream()

FILE * octave::command_editor::get_input_stream ( void )

static

Definition at line 1210 of file cmd-edit.cc.

◆ get_line_buffer()

std::string octave::command_editor::get_line_buffer ( void )

static

Definition at line 1432 of file cmd-edit.cc.

◆ get_output_stream()

FILE * octave::command_editor::get_output_stream ( void )

static

Definition at line 1223 of file cmd-edit.cc.

◆ get_prev_char()

char octave::command_editor::get_prev_char ( int offset )

static

Definition at line 1446 of file cmd-edit.cc.

◆ get_quoting_function()

command_editor::quoting_fcn octave::command_editor::get_quoting_function ( void )

static

Definition at line 1398 of file cmd-edit.cc.

◆ get_user_accept_line_function()

command_editor::user_accept_line_fcn octave::command_editor::get_user_accept_line_function ( void )

static

Definition at line 1417 of file cmd-edit.cc.

◆ handle_interrupt_signal()

void octave::command_editor::handle_interrupt_signal ( void )

staticprivate

Definition at line 1649 of file cmd-edit.cc.

◆ increment_current_command_number()

void octave::command_editor::increment_current_command_number ( void )

static

Definition at line 1288 of file cmd-edit.cc.

Referenced by octave::interpreter::main_loop().

◆ insert_initial_input()

int octave::command_editor::insert_initial_input ( void )

static

Definition at line 1111 of file cmd-edit.cc.

◆ insert_text()

void octave::command_editor::insert_text ( const std::string & text )

static

Definition at line 1466 of file cmd-edit.cc.

◆ instance_ok()

bool octave::command_editor::instance_ok ( void )

staticprivate

Definition at line 1063 of file cmd-edit.cc.

References singleton_cleanup_list::add(), and retval.

◆ interrupt()

bool octave::command_editor::interrupt ( bool arg = true )

static

Definition at line 1616 of file cmd-edit.cc.

References retval.

Referenced by octave::file_editor_tab::confirm_dbquit_and_save(), octave::main_window::debug_continue(), octave::main_window::debug_quit(), octave::main_window::debug_step_into(), octave::main_window::debug_step_out(), octave::main_window::debug_step_over(), and octave::debugger::repl().

◆ interrupt_event_loop()

void octave::command_editor::interrupt_event_loop ( bool flag = true )

static

Definition at line 1636 of file cmd-edit.cc.

Referenced by octave::octave_qscintilla::contextmenu_run(), octave::main_window::execute_command_in_terminal(), octave::action_container::run(), and octave::main_window::run_file_in_terminal().

◆ kill_full_line()

void octave::command_editor::kill_full_line ( void )

static

Definition at line 1459 of file cmd-edit.cc.

Referenced by octave::main_window::handle_clear_command_window_request().

◆ make_command_editor()

void octave::command_editor::make_command_editor ( void )

staticprivate

Definition at line 1087 of file cmd-edit.cc.

◆ newline()

void octave::command_editor::newline ( void )

static

Definition at line 1473 of file cmd-edit.cc.

◆ newline_chars()

virtual std::string octave::command_editor::newline_chars ( void )

inlineprotectedvirtual

Definition at line 281 of file cmd-edit.h.

◆ operator=()

command_editor& octave::command_editor::operator= ( const command_editor & )

delete

◆ pre_input_handler()

int octave::command_editor::pre_input_handler ( void )

staticprivate

Definition at line 1134 of file cmd-edit.cc.

References f.

◆ prefer_env_winsize()

bool octave::command_editor::prefer_env_winsize ( bool arg )

static

Definition at line 1610 of file cmd-edit.cc.

◆ re_read_init_file()

void octave::command_editor::re_read_init_file ( void )

static

Definition at line 1589 of file cmd-edit.cc.

◆ read_init_file()

void octave::command_editor::read_init_file ( const std::string & file = "" )

static

Definition at line 1578 of file cmd-edit.cc.

References octave::sys::file_ops::tilde_expand().

◆ read_octal()

int octave::command_editor::read_octal ( const std::string & s )

protected

Definition at line 1927 of file cmd-edit.cc.

◆ readline() [1/2]

std::string octave::command_editor::readline ( const std::string & prompt )

static

Definition at line 1179 of file cmd-edit.cc.

◆ readline() [2/2]

std::string octave::command_editor::readline	(	const std::string &	prompt,
		bool &	eof
	)

static

Definition at line 1187 of file cmd-edit.cc.

References retval.

◆ redisplay()

void octave::command_editor::redisplay ( void )

static

Definition at line 1229 of file cmd-edit.cc.

Referenced by octave::octave_qscintilla::contextmenu_run(), octave::main_window::execute_command_in_terminal(), octave::main_window::handle_undo_request(), and octave::main_window::run_file_in_terminal().

◆ remove_event_hook()

void octave::command_editor::remove_event_hook ( event_hook_fcn f )

static

Definition at line 1560 of file cmd-edit.cc.

References octave::event_hook_lock, and f.

Referenced by gh_manager::enable_event_processing(), and gh_manager::process_events().

◆ remove_pre_input_hook()

void octave::command_editor::remove_pre_input_hook ( pre_input_hook_fcn f )

static

Definition at line 1537 of file cmd-edit.cc.

References f.

◆ remove_startup_hook()

void octave::command_editor::remove_startup_hook ( startup_hook_fcn f )

static

Definition at line 1511 of file cmd-edit.cc.

References f.

◆ replace_line()

void octave::command_editor::replace_line	(	const std::string &	text,
		bool	clear_undo = `true`
	)

static

Definition at line 1452 of file cmd-edit.cc.

Referenced by octave::octave_qscintilla::contextmenu_run(), and octave::main_window::execute_command_in_terminal().

◆ reset_current_command_number()

void octave::command_editor::reset_current_command_number ( int n )

static

Definition at line 1281 of file cmd-edit.cc.

References n.

◆ resize_terminal()

void octave::command_editor::resize_terminal ( void )

static

Definition at line 1255 of file cmd-edit.cc.

◆ restore_event_hook()

virtual void octave::command_editor::restore_event_hook ( void )

inlineprotectedvirtual

Definition at line 358 of file cmd-edit.h.

◆ restore_pre_input_hook()

virtual void octave::command_editor::restore_pre_input_hook ( void )

inlineprotectedvirtual

Definition at line 354 of file cmd-edit.h.

◆ restore_startup_hook()

virtual void octave::command_editor::restore_startup_hook ( void )

inlineprotectedvirtual

Definition at line 350 of file cmd-edit.h.

◆ restore_terminal_state()

void octave::command_editor::restore_terminal_state ( void )

static

Definition at line 1295 of file cmd-edit.cc.

Referenced by octave::interpreter::shutdown().

◆ run_event_hooks()

void octave::command_editor::run_event_hooks ( void )

static

Definition at line 1572 of file cmd-edit.cc.

Referenced by Fwaitfor().

◆ set_basic_quote_characters()

void octave::command_editor::set_basic_quote_characters ( const std::string & s )

static

Definition at line 1329 of file cmd-edit.cc.

◆ set_basic_word_break_characters()

void octave::command_editor::set_basic_word_break_characters ( const std::string & s )

static

Definition at line 1315 of file cmd-edit.cc.

◆ set_char_is_quoted_function()

void octave::command_editor::set_char_is_quoted_function ( char_is_quoted_fcn f )

static

Definition at line 1378 of file cmd-edit.cc.

References f.

◆ set_completer_quote_characters()

void octave::command_editor::set_completer_quote_characters ( const std::string & s )

static

Definition at line 1343 of file cmd-edit.cc.

◆ set_completer_word_break_characters()

void octave::command_editor::set_completer_word_break_characters ( const std::string & s )

static

Definition at line 1322 of file cmd-edit.cc.

◆ set_completion_append_character()

void octave::command_editor::set_completion_append_character ( char c )

static

Definition at line 1350 of file cmd-edit.cc.

◆ set_completion_function()

void octave::command_editor::set_completion_function ( completion_fcn f )

static

Definition at line 1357 of file cmd-edit.cc.

References f.

◆ set_dequoting_function()

void octave::command_editor::set_dequoting_function ( dequoting_fcn f )

static

Definition at line 1371 of file cmd-edit.cc.

References f.

◆ set_event_hook()

virtual void octave::command_editor::set_event_hook ( event_hook_fcn )

inlineprotectedvirtual

Definition at line 356 of file cmd-edit.h.

◆ set_filename_quote_characters()

void octave::command_editor::set_filename_quote_characters ( const std::string & s )

static

Definition at line 1336 of file cmd-edit.cc.

◆ set_initial_input()

void octave::command_editor::set_initial_input ( const std::string & text )

static

Definition at line 1104 of file cmd-edit.cc.

Referenced by octave::octave_qscintilla::contextmenu_run(), octave::main_window::execute_command_in_terminal(), and octave::main_window::run_file_in_terminal().

◆ set_input_stream()

void octave::command_editor::set_input_stream ( FILE * f )

static

Definition at line 1203 of file cmd-edit.cc.

References f.

◆ set_name()

void octave::command_editor::set_name ( const std::string & n )

static

Definition at line 1172 of file cmd-edit.cc.

References n.

◆ set_output_stream()

void octave::command_editor::set_output_stream ( FILE * f )

static

Definition at line 1216 of file cmd-edit.cc.

References f.

◆ set_pre_input_hook()

virtual void octave::command_editor::set_pre_input_hook ( pre_input_hook_fcn )

inlineprotectedvirtual

Definition at line 352 of file cmd-edit.h.

◆ set_quoting_function()

void octave::command_editor::set_quoting_function ( quoting_fcn f )

static

Definition at line 1364 of file cmd-edit.cc.

References f.

◆ set_screen_size()

void octave::command_editor::set_screen_size	(	int	ht,
		int	wd
	)

static

Definition at line 1262 of file cmd-edit.cc.

Referenced by Fterminal_size(), and octave::main_window::set_screen_size().

◆ set_startup_hook()

virtual void octave::command_editor::set_startup_hook ( startup_hook_fcn )

inlineprotectedvirtual

Definition at line 348 of file cmd-edit.h.

◆ set_user_accept_line_function()

void octave::command_editor::set_user_accept_line_function ( user_accept_line_fcn f )

static

Definition at line 1385 of file cmd-edit.cc.

References f.

◆ startup_handler()

int octave::command_editor::startup_handler ( void )

staticprivate

Definition at line 1117 of file cmd-edit.cc.

References f.

◆ terminal_cols()

int octave::command_editor::terminal_cols ( void )

static

Definition at line 1242 of file cmd-edit.cc.

Referenced by Fterminal_size(), string_vector::list_in_columns(), octave::more_than_a_screenful(), octave_print_diag_matrix_internal(), octave_print_internal(), octave_print_internal_template(), and octave_print_matrix_internal().

◆ terminal_rows()

int octave::command_editor::terminal_rows ( void )

static

Definition at line 1236 of file cmd-edit.cc.

Referenced by Fterminal_size(), and octave::more_than_a_screenful().

◆ undo()

bool octave::command_editor::undo ( void )

static

Definition at line 1487 of file cmd-edit.cc.

Referenced by octave::main_window::handle_undo_request().

Member Data Documentation

◆ event_hook_set

std::set< command_editor::event_hook_fcn > octave::command_editor::event_hook_set

staticprivate

Definition at line 225 of file cmd-edit.h.

◆ m_cols

int octave::command_editor::m_cols

protected

Definition at line 393 of file cmd-edit.h.

◆ m_command_number

int octave::command_editor::m_command_number

protected

Definition at line 390 of file cmd-edit.h.

◆ m_initial_input

std::string octave::command_editor::m_initial_input

protected

Definition at line 399 of file cmd-edit.h.

◆ m_interrupt_event_loop

bool octave::command_editor::m_interrupt_event_loop

protected

Definition at line 397 of file cmd-edit.h.

◆ m_interrupted

bool octave::command_editor::m_interrupted

protected

Definition at line 395 of file cmd-edit.h.

◆ m_rows

int octave::command_editor::m_rows

protected

Definition at line 392 of file cmd-edit.h.

◆ pre_input_hook_set

std::set< command_editor::pre_input_hook_fcn > octave::command_editor::pre_input_hook_set

staticprivate

Definition at line 223 of file cmd-edit.h.

◆ s_instance

command_editor * octave::command_editor::s_instance = nullptr

staticprivate

Definition at line 228 of file cmd-edit.h.

◆ startup_hook_set

std::set< command_editor::startup_hook_fcn > octave::command_editor::startup_hook_set

staticprivate

Definition at line 221 of file cmd-edit.h.

The documentation for this class was generated from the following files:

liboctave/util/cmd-edit.h
liboctave/util/cmd-edit.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ char_is_quoted_fcn

◆ completion_fcn

◆ completion_hook_fcn

◆ dequoting_fcn

◆ event_hook_fcn

◆ pre_input_hook_fcn

◆ quoting_fcn

◆ startup_hook_fcn

◆ user_accept_line_fcn

Constructor & Destructor Documentation

◆ command_editor() [1/2]

◆ command_editor() [2/2]

◆ ~command_editor()

Member Function Documentation

◆ accept_line()

◆ add_event_hook()

◆ add_pre_input_hook()

◆ add_startup_hook()

◆ blink_matching_paren()

◆ cleanup_instance()

◆ clear_screen()

◆ clear_undo_list()

◆ current_command_number()

◆ decode_prompt_string()

◆ do_accept_line()

◆ do_blink_matching_paren()

◆ do_clear_screen()

◆ do_clear_undo_list()

◆ do_decode_prompt_string()

◆ do_erase_empty_line()

◆ do_event_loop_interrupted()

◆ do_filename_completion_desired()

◆ do_filename_quoting_desired()

◆ do_generate_filename_completions()

◆ do_get_char_is_quoted_function()

◆ do_get_completion_function()

◆ do_get_current_line()

◆ do_get_dequoting_function()

◆ do_get_input_stream()

◆ do_get_line_buffer()

◆ do_get_output_stream()

◆ do_get_prev_char()

◆ do_get_quoting_function()

◆ do_get_user_accept_line_function()

◆ do_handle_interrupt_signal()

◆ do_insert_initial_input()

◆ do_insert_text()

◆ do_interrupt()

◆ do_interrupt_event_loop()

◆ do_kill_full_line()

◆ do_newline()

◆ do_prefer_env_winsize()

◆ do_re_read_init_file()

◆ do_read_init_file()

◆ do_readline() [1/2]

◆ do_readline() [2/2]

◆ do_redisplay()

◆ do_replace_line()

◆ do_resize_terminal()

◆ do_restore_terminal_state()

◆ do_set_basic_quote_characters()

◆ do_set_basic_word_break_characters()

◆ do_set_char_is_quoted_function()

◆ do_set_completer_quote_characters()

◆ do_set_completer_word_break_characters()

◆ do_set_completer_word_break_hook()

◆ do_set_completion_append_character()

◆ do_set_completion_function()

◆ do_set_dequoting_function()

◆ do_set_filename_quote_characters()

◆ do_set_input_stream()