command_editor Class Reference

#include "cmd-edit.h"

Inheritance diagram for command_editor:

Collaboration diagram for command_editor:

Public Types
typedef int(*	char_is_quoted_fcn )(const std::string &, int)
typedef std::string(*	completion_fcn )(const std::string &, int)
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
virtual	~command_editor (void)

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	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 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	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=std::string())
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)
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 quoting_fcn	do_get_quoting_function (void) const
virtual user_accept_line_fcn	do_get_user_accept_line_function (void) const
int	do_insert_initial_input (void)
virtual void	do_insert_text (const std::string &text)=0
virtual void	do_interrupt (bool)
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 &)
std::string	do_readline (const std::string &prompt)
virtual std::string	do_readline (const std::string &, bool &)=0
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_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, int)
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 (int)
void	error (const std::string &)
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	command_number
std::string	initial_input
bool	interrupted

Private Types
typedef std::set < event_hook_fcn > ::const_iterator	event_hook_set_const_iterator
typedef std::set < event_hook_fcn >::iterator	event_hook_set_iterator
typedef std::set < pre_input_hook_fcn > ::const_iterator	pre_input_hook_set_const_iterator
typedef std::set < pre_input_hook_fcn > ::iterator	pre_input_hook_set_iterator
typedef std::set < startup_hook_fcn > ::const_iterator	startup_hook_set_const_iterator
typedef std::set < startup_hook_fcn >::iterator	startup_hook_set_iterator

Private Member Functions
	command_editor (const command_editor &)
command_editor &	operator= (const command_editor &)

Static Private Member Functions
static void	cleanup_instance (void)
static int	event_handler (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 command_editor *	instance = 0
static std::set < pre_input_hook_fcn >	pre_input_hook_set
static std::set< startup_hook_fcn >	startup_hook_set

Detailed Description

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

Member Typedef Documentation

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

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

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

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

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

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

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

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

typedef std::set<event_hook_fcn>::const_iterator command_editor::event_hook_set_const_iterator

private

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

typedef std::set<event_hook_fcn>::iterator command_editor::event_hook_set_iterator

private

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

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

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

typedef std::set<pre_input_hook_fcn>::const_iterator command_editor::pre_input_hook_set_const_iterator

private

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

typedef std::set<pre_input_hook_fcn>::iterator command_editor::pre_input_hook_set_iterator

private

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

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

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

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

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

typedef std::set<startup_hook_fcn>::const_iterator command_editor::startup_hook_set_const_iterator

private

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

typedef std::set<startup_hook_fcn>::iterator command_editor::startup_hook_set_iterator

private

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

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

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

Constructor & Destructor Documentation

command_editor::command_editor ( void  )

inlineprotected

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

virtual command_editor::~command_editor ( void  )

inlinevirtual

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

command_editor::command_editor ( const command_editor &  )

private

Member Function Documentation

void command_editor::accept_line ( void  )

static

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

References do_accept_line(), instance, and instance_ok().

Referenced by octave_cmd_exec::execute().

void command_editor::add_event_hook ( event_hook_fcn  f )

static

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

References event_handler(), event_hook_set, instance, instance_ok(), and set_event_hook().

Referenced by gh_manager::do_enable_event_processing(), gh_manager::do_post_event(), Fadd_input_event_hook(), and octave_link::octave_link().

void command_editor::add_pre_input_hook ( pre_input_hook_fcn  f )

static

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

References instance, instance_ok(), pre_input_handler(), pre_input_hook_set, and set_pre_input_hook().

Referenced by readline().

void command_editor::add_startup_hook ( startup_hook_fcn  f )

static

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

References instance, instance_ok(), set_startup_hook(), startup_handler(), and startup_hook_set.

void command_editor::blink_matching_paren ( bool  flag )

static

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

References do_blink_matching_paren(), instance, and instance_ok().

Referenced by octave_execute_interpreter().

static void command_editor::cleanup_instance ( void  )

inlinestaticprivate

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

Referenced by instance_ok().

void command_editor::clear_screen ( bool  skip_redisplay = false )

static

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

References do_clear_screen(), instance, and instance_ok().

Referenced by main_window::clear_command_window_callback(), and Fclc().

void command_editor::clear_undo_list ( void  )

static

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

References do_clear_undo_list(), instance, and instance_ok().

int command_editor::current_command_number ( void  )

static

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

References command_number, instance, and instance_ok().

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

static

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

References do_decode_prompt_string(), instance, and instance_ok().

Referenced by octave_base_reader::do_input_echo(), and octave_base_reader::octave_gets().

virtual void command_editor::do_accept_line ( void  )

protectedpure virtual

Implemented in default_command_editor.

Referenced by accept_line().

virtual void command_editor::do_blink_matching_paren ( bool  )

inlineprotectedvirtual

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

Referenced by blink_matching_paren().

virtual void command_editor::do_clear_screen ( bool  )

inlineprotectedvirtual

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

Referenced by clear_screen().

virtual void command_editor::do_clear_undo_list ( void  )

inlineprotectedvirtual

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

Referenced by clear_undo_list().

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

protectedvirtual

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

References octave_env::base_pathname(), command_number, command_history::current_number(), octave_env::get_current_directory(), octave_env::get_home_directory(), octave_env::get_host_name(), octave_env::get_program_name(), octave_env::get_user_name(), newline_chars(), octave_rl_prompt_end_ignore(), octave_rl_prompt_start_ignore(), octave_env::polite_directory_format(), read_octal(), and octave_base_tm::strftime().

Referenced by decode_prompt_string().

virtual bool command_editor::do_erase_empty_line ( bool  )

inlineprotectedvirtual

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

Referenced by erase_empty_line().

virtual bool command_editor::do_filename_completion_desired ( bool  )

inlineprotectedvirtual

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

Referenced by filename_completion_desired().

virtual bool command_editor::do_filename_quoting_desired ( bool  )

inlineprotectedvirtual

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

Referenced by filename_quoting_desired().

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

protectedpure virtual

Implemented in default_command_editor.

Referenced by generate_filename_completions().

virtual char_is_quoted_fcn command_editor::do_get_char_is_quoted_function ( void  ) const

inlineprotectedvirtual

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

Referenced by get_char_is_quoted_function().

virtual completion_fcn command_editor::do_get_completion_function ( void  ) const

inlineprotectedvirtual

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

Referenced by get_completion_function().

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

protectedpure virtual

Implemented in default_command_editor.

Referenced by get_current_line().

virtual dequoting_fcn command_editor::do_get_dequoting_function ( void  ) const

inlineprotectedvirtual

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

Referenced by get_dequoting_function().

virtual FILE* command_editor::do_get_input_stream ( void  )

protectedpure virtual

Implemented in default_command_editor.

Referenced by get_input_stream().

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

protectedpure virtual

Implemented in default_command_editor.

Referenced by get_line_buffer().

virtual FILE* command_editor::do_get_output_stream ( void  )

protectedpure virtual

Implemented in default_command_editor.

Referenced by get_output_stream().

virtual quoting_fcn command_editor::do_get_quoting_function ( void  ) const

inlineprotectedvirtual

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

Referenced by get_quoting_function().

virtual user_accept_line_fcn command_editor::do_get_user_accept_line_function ( void  ) const

inlineprotectedvirtual

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

Referenced by get_user_accept_line_function().

int command_editor::do_insert_initial_input ( void  )

protected

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

References do_insert_text(), do_redisplay(), initial_input, and input().

Referenced by insert_initial_input().

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

protectedpure virtual

Implemented in default_command_editor.

Referenced by do_insert_initial_input(), and insert_text().

virtual void command_editor::do_interrupt ( bool  )

inlineprotectedvirtual

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

Referenced by interrupt().

virtual void command_editor::do_kill_full_line ( void  )

protectedpure virtual

Implemented in default_command_editor.

Referenced by kill_full_line().

virtual void command_editor::do_newline ( void  )

protectedpure virtual

Implemented in default_command_editor.

Referenced by newline().

virtual bool command_editor::do_prefer_env_winsize ( bool  )

inlineprotectedvirtual

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

Referenced by prefer_env_winsize().

virtual void command_editor::do_re_read_init_file ( void  )

inlineprotectedvirtual

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

Referenced by re_read_init_file().

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

inlineprotectedvirtual

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

Referenced by read_init_file().

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

inlineprotected

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

Referenced by readline().

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

protectedpure virtual

Implemented in default_command_editor.

virtual void command_editor::do_redisplay ( void  )

inlineprotectedvirtual

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

Referenced by do_insert_initial_input(), and redisplay().

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

protectedpure virtual

Implemented in default_command_editor.

Referenced by replace_line().

virtual void command_editor::do_resize_terminal ( void  )

inlineprotectedvirtual

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

Referenced by resize_terminal().

virtual void command_editor::do_restore_terminal_state ( void  )

inlineprotectedvirtual

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

Referenced by restore_terminal_state().

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

inlineprotectedvirtual

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

Referenced by set_basic_quote_characters().

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

inlineprotectedvirtual

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

Referenced by set_basic_word_break_characters().

virtual void command_editor::do_set_char_is_quoted_function ( char_is_quoted_fcn  )

inlineprotectedvirtual

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

Referenced by set_char_is_quoted_function().

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

inlineprotectedvirtual

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

Referenced by set_completer_quote_characters().

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

inlineprotectedvirtual

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

Referenced by set_completer_word_break_characters().

virtual void command_editor::do_set_completion_append_character ( char  )

inlineprotectedvirtual

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

Referenced by set_completion_append_character().

virtual void command_editor::do_set_completion_function ( completion_fcn  )

inlineprotectedvirtual

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

Referenced by set_completion_function().

virtual void command_editor::do_set_dequoting_function ( dequoting_fcn  )

inlineprotectedvirtual

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

Referenced by set_dequoting_function().

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

inlineprotectedvirtual

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

Referenced by set_filename_quote_characters().

virtual void command_editor::do_set_input_stream ( FILE *  )

protectedpure virtual

Implemented in default_command_editor.

Referenced by set_input_stream().

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

inlineprotectedvirtual

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

Referenced by set_name().

virtual void command_editor::do_set_output_stream ( FILE *  )

protectedpure virtual

Implemented in default_command_editor.

Referenced by set_output_stream().

virtual void command_editor::do_set_quoting_function ( quoting_fcn  )

inlineprotectedvirtual

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

Referenced by set_quoting_function().

virtual void command_editor::do_set_screen_size ( int  , int    )

inlineprotectedvirtual

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

Referenced by set_screen_size().

virtual void command_editor::do_set_user_accept_line_function ( user_accept_line_fcn  )

inlineprotectedvirtual

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

Referenced by set_user_accept_line_function().

virtual int command_editor::do_terminal_cols ( void  )

inlineprotectedvirtual

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

Referenced by terminal_cols().

virtual int command_editor::do_terminal_rows ( void  )

inlineprotectedvirtual

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

Referenced by terminal_rows().

virtual bool command_editor::do_undo ( void  )

inlineprotectedvirtual

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

Referenced by undo().

bool command_editor::erase_empty_line ( bool  flag )

static

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

References do_erase_empty_line(), instance, and instance_ok().

Referenced by get_debug_input().

void command_editor::error ( int  err_num )

protected

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

References current_liboctave_error_handler.

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

protected

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

References current_liboctave_error_handler.

int command_editor::event_handler ( void  )

staticprivate

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

References event_hook_set, f, octave_mutex::lock(), and octave_mutex::unlock().

Referenced by add_event_hook(), and run_event_hooks().

bool command_editor::filename_completion_desired ( bool  arg )

static

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

References do_filename_completion_desired(), instance, and instance_ok().

bool command_editor::filename_quoting_desired ( bool  arg )

static

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

References do_filename_quoting_desired(), instance, and instance_ok().

void command_editor::force_default_editor ( void  )

static

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

References instance.

Referenced by octave_initialize_interpreter().

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

static

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

References do_generate_filename_completions(), instance, and instance_ok().

Referenced by generate_completion().

command_editor::char_is_quoted_fcn command_editor::get_char_is_quoted_function ( void  )

static

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

References do_get_char_is_quoted_function(), instance, and instance_ok().

command_editor::completion_fcn command_editor::get_completion_function ( void  )

static

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

References do_get_completion_function(), instance, and instance_ok().

std::string command_editor::get_current_line ( void  )

static

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

References do_get_current_line(), instance, and instance_ok().

Referenced by octave_cmd_exec::execute(), and octave_cmd_eval::execute().

command_editor::dequoting_fcn command_editor::get_dequoting_function ( void  )

static

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

References do_get_dequoting_function(), instance, and instance_ok().

FILE * command_editor::get_input_stream ( void  )

static

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

References do_get_input_stream(), instance, and instance_ok().

Referenced by get_input_from_stdin(), and parse_fcn_file().

std::string command_editor::get_line_buffer ( void  )

static

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

References do_get_line_buffer(), instance, and instance_ok().

Referenced by is_completing_dirfns().

FILE * command_editor::get_output_stream ( void  )

static

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

References do_get_output_stream(), instance, and instance_ok().

command_editor::quoting_fcn command_editor::get_quoting_function ( void  )

static

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

References do_get_quoting_function(), instance, and instance_ok().

command_editor::user_accept_line_fcn command_editor::get_user_accept_line_function ( void  )

static

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

References do_get_user_accept_line_function(), instance, and instance_ok().

void command_editor::increment_current_command_number ( void  )

static

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

References command_number, instance, and instance_ok().

Referenced by main_loop().

int command_editor::insert_initial_input ( void  )

static

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

References do_insert_initial_input(), instance, and instance_ok().

Referenced by readline().

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

static

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

References do_insert_text(), instance, and instance_ok().

bool command_editor::instance_ok ( void  )

staticprivate

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

References singleton_cleanup_list::add(), cleanup_instance(), current_liboctave_error_handler, instance, and make_command_editor().

Referenced by accept_line(), add_event_hook(), add_pre_input_hook(), add_startup_hook(), blink_matching_paren(), clear_screen(), clear_undo_list(), current_command_number(), decode_prompt_string(), erase_empty_line(), filename_completion_desired(), filename_quoting_desired(), generate_filename_completions(), get_char_is_quoted_function(), get_completion_function(), get_current_line(), get_dequoting_function(), get_input_stream(), get_line_buffer(), get_output_stream(), get_quoting_function(), get_user_accept_line_function(), increment_current_command_number(), insert_initial_input(), insert_text(), interrupt(), kill_full_line(), newline(), prefer_env_winsize(), re_read_init_file(), read_init_file(), readline(), redisplay(), remove_event_hook(), remove_pre_input_hook(), remove_startup_hook(), replace_line(), reset_current_command_number(), resize_terminal(), restore_terminal_state(), set_basic_quote_characters(), set_basic_word_break_characters(), set_char_is_quoted_function(), set_completer_quote_characters(), set_completer_word_break_characters(), set_completion_append_character(), set_completion_function(), set_dequoting_function(), set_filename_quote_characters(), set_initial_input(), set_input_stream(), set_name(), set_output_stream(), set_quoting_function(), set_screen_size(), set_user_accept_line_function(), terminal_cols(), terminal_rows(), and undo().

bool command_editor::interrupt ( bool  arg = true )

static

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

References arg(), do_interrupt(), instance, instance_ok(), and interrupted.

Referenced by octave_cmd_eval::execute(), main_window::execute_debug_callback(), and get_debug_input().

void command_editor::kill_full_line ( void  )

static

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

References do_kill_full_line(), instance, and instance_ok().

Referenced by main_window::clear_command_window_callback().

void command_editor::make_command_editor ( void  )

staticprivate

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

References gnu_readline(), and instance.

Referenced by instance_ok().

void command_editor::newline ( void  )

static

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

References do_newline(), instance, and instance_ok().

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

inlineprotectedvirtual

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

Referenced by do_decode_prompt_string().

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

private

int command_editor::pre_input_handler ( void  )

staticprivate

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

References f, and pre_input_hook_set.

Referenced by add_pre_input_hook().

bool command_editor::prefer_env_winsize ( bool  arg )

static

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

References do_prefer_env_winsize(), instance, and instance_ok().

void command_editor::re_read_init_file ( void  )

static

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

References do_re_read_init_file(), instance, and instance_ok().

Referenced by Freadline_re_read_init_file().

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

static

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

References do_read_init_file(), instance, instance_ok(), and file_ops::tilde_expand().

Referenced by Freadline_read_init_file().

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

protected

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

Referenced by do_decode_prompt_string().

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

static

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

Referenced by gnu_readline().

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

static

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

References add_pre_input_hook(), do_readline(), initial_input, insert_initial_input(), instance, and instance_ok().

void command_editor::redisplay ( void  )

static

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

References do_redisplay(), instance, and instance_ok().

Referenced by main_window::command_window_undo_callback(), octave_cmd_exec::execute(), and octave_cmd_eval::execute().

void command_editor::remove_event_hook ( event_hook_fcn  f )

static

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

References event_hook_set, instance, instance_ok(), and restore_event_hook().

Referenced by gh_manager::do_enable_event_processing(), gh_manager::do_process_events(), Fremove_input_event_hook(), and internal_input_event_hook_fcn().

void command_editor::remove_pre_input_hook ( pre_input_hook_fcn  f )

static

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

References instance, instance_ok(), pre_input_hook_set, and restore_pre_input_hook().

void command_editor::remove_startup_hook ( startup_hook_fcn  f )

static

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

References instance, instance_ok(), restore_startup_hook(), and startup_hook_set.

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

static

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

References do_replace_line(), instance, and instance_ok().

Referenced by octave_cmd_exec::execute(), and octave_cmd_eval::execute().

void command_editor::reset_current_command_number ( int  n )

static

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

References command_number, instance, and instance_ok().

Referenced by octave_execute_interpreter().

void command_editor::resize_terminal ( void  )

static

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

References do_resize_terminal(), instance, and instance_ok().

Referenced by main_window::resize_command_window_callback().

virtual void command_editor::restore_event_hook ( void  )

inlineprotectedvirtual

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

Referenced by remove_event_hook().

virtual void command_editor::restore_pre_input_hook ( void  )

inlineprotectedvirtual

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

Referenced by remove_pre_input_hook().

virtual void command_editor::restore_startup_hook ( void  )

inlineprotectedvirtual

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

Referenced by remove_startup_hook().

void command_editor::restore_terminal_state ( void  )

static

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

References do_restore_terminal_state(), instance, and instance_ok().

Referenced by do_octave_atexit().

void command_editor::run_event_hooks ( void  )

static

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

References event_handler().

Referenced by Fwaitfor().

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

static

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

References do_set_basic_quote_characters(), instance, and instance_ok().

Referenced by initialize_command_input().

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

static

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

References do_set_basic_word_break_characters(), instance, and instance_ok().

Referenced by initialize_command_input().

void command_editor::set_char_is_quoted_function ( char_is_quoted_fcn  f )

static

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

References do_set_char_is_quoted_function(), instance, and instance_ok().

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

static

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

References do_set_completer_quote_characters(), instance, and instance_ok().

Referenced by initialize_command_input().

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

static

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

References do_set_completer_word_break_characters(), instance, and instance_ok().

Referenced by initialize_command_input().

void command_editor::set_completion_append_character ( char  c )

static

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

References do_set_completion_append_character(), instance, and instance_ok().

Referenced by generate_completion().

void command_editor::set_completion_function ( completion_fcn  f )

static

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

References do_set_completion_function(), instance, and instance_ok().

Referenced by initialize_command_input().

void command_editor::set_dequoting_function ( dequoting_fcn  f )

static

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

References do_set_dequoting_function(), instance, and instance_ok().

virtual void command_editor::set_event_hook ( event_hook_fcn  )

inlineprotectedvirtual

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

Referenced by add_event_hook().

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

static

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

References do_set_filename_quote_characters(), instance, and instance_ok().

Referenced by initialize_command_input().

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

static

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

References initial_input, instance, and instance_ok().

Referenced by octave_cmd_exec::execute(), and octave_cmd_eval::execute().

void command_editor::set_input_stream ( FILE *  f )

static

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

References do_set_input_stream(), instance, and instance_ok().

Referenced by get_input_from_stdin(), and parse_fcn_file().

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

static

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

References do_set_name(), instance, and instance_ok().

Referenced by initialize_command_input().

void command_editor::set_output_stream ( FILE *  f )

static

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

References do_set_output_stream(), instance, and instance_ok().

virtual void command_editor::set_pre_input_hook ( pre_input_hook_fcn  )

inlineprotectedvirtual

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

Referenced by add_pre_input_hook().

void command_editor::set_quoting_function ( quoting_fcn  f )

static

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

References do_set_quoting_function(), instance, and instance_ok().

Referenced by initialize_command_input().

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

static

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

References do_set_screen_size(), instance, and instance_ok().

Referenced by main_window::set_screen_size_callback().

virtual void command_editor::set_startup_hook ( startup_hook_fcn  )

inlineprotectedvirtual

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

Referenced by add_startup_hook().

void command_editor::set_user_accept_line_function ( user_accept_line_fcn  f )

static

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

References do_set_user_accept_line_function(), instance, and instance_ok().

int command_editor::startup_handler ( void  )

staticprivate

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

References f, and startup_hook_set.

Referenced by add_startup_hook().

int command_editor::terminal_cols ( void  )

static

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

References do_terminal_cols(), instance, and instance_ok().

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

int command_editor::terminal_rows ( void  )

static

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

References do_terminal_rows(), instance, and instance_ok().

Referenced by Fterminal_size(), and more_than_a_screenful().

bool command_editor::undo ( void  )

static

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

References do_undo(), instance, and instance_ok().

Referenced by main_window::command_window_undo_callback().

Member Data Documentation

int command_editor::command_number

protected

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

Referenced by current_command_number(), do_decode_prompt_string(), increment_current_command_number(), and reset_current_command_number().

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

staticprivate

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

Referenced by add_event_hook(), event_handler(), and remove_event_hook().

std::string command_editor::initial_input

protected

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

Referenced by do_insert_initial_input(), readline(), and set_initial_input().

command_editor * command_editor::instance = 0

staticprivate

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

Referenced by accept_line(), add_event_hook(), add_pre_input_hook(), add_startup_hook(), blink_matching_paren(), clear_screen(), clear_undo_list(), current_command_number(), decode_prompt_string(), erase_empty_line(), filename_completion_desired(), filename_quoting_desired(), force_default_editor(), generate_filename_completions(), get_char_is_quoted_function(), get_completion_function(), get_current_line(), get_dequoting_function(), get_input_stream(), get_line_buffer(), get_output_stream(), get_quoting_function(), get_user_accept_line_function(), increment_current_command_number(), insert_initial_input(), insert_text(), instance_ok(), interrupt(), kill_full_line(), make_command_editor(), newline(), prefer_env_winsize(), re_read_init_file(), read_init_file(), readline(), redisplay(), remove_event_hook(), remove_pre_input_hook(), remove_startup_hook(), replace_line(), reset_current_command_number(), resize_terminal(), restore_terminal_state(), set_basic_quote_characters(), set_basic_word_break_characters(), set_char_is_quoted_function(), set_completer_quote_characters(), set_completer_word_break_characters(), set_completion_append_character(), set_completion_function(), set_dequoting_function(), set_filename_quote_characters(), set_initial_input(), set_input_stream(), set_name(), set_output_stream(), set_quoting_function(), set_screen_size(), set_user_accept_line_function(), terminal_cols(), terminal_rows(), and undo().

bool command_editor::interrupted

protected

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

Referenced by interrupt().

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

staticprivate

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

Referenced by add_pre_input_hook(), pre_input_handler(), and remove_pre_input_hook().

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

staticprivate

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

Referenced by add_startup_hook(), remove_startup_hook(), and startup_handler().

---

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

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