GNU Octave  3.8.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
default_command_editor Class Reference
Inheritance diagram for default_command_editor:
Inheritance graph
[legend]
Collaboration diagram for default_command_editor:
Collaboration graph
[legend]

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

 default_command_editor (void)
 ~default_command_editor (void)
void do_accept_line (void)
string_vector do_generate_filename_completions (const std::string &text)
std::string do_get_current_line (void) const
FILE * do_get_input_stream (void)
std::string do_get_line_buffer (void) const
FILE * do_get_output_stream (void)
void do_insert_text (const std::string &text)
void do_newline (void)
std::string do_readline (const std::string &prompt, bool &eof)
void do_replace_line (const std::string &text, bool clear_undo)
void do_set_input_stream (FILE *f)
void do_set_output_stream (FILE *f)

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 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 newline (void)
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_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

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_filename_completion_desired (bool)
virtual bool do_filename_quoting_desired (bool)
virtual char_is_quoted_fcn do_get_char_is_quoted_function (void) const
virtual completion_fcn do_get_completion_function (void) const
virtual dequoting_fcn do_get_dequoting_function (void) const
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_interrupt (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 void do_redisplay (void)
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_name (const std::string &)
virtual void do_set_quoting_function (quoting_fcn)
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 Member Functions

 default_command_editor (const default_command_editor &)
default_command_editoroperator= (const default_command_editor &)

Private Attributes

FILE * input_stream
FILE * output_stream

Detailed Description

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

Member Typedef Documentation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Constructor & Destructor Documentation

default_command_editor::default_command_editor ( void  )
inline

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

default_command_editor::~default_command_editor ( void  )
inline

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

default_command_editor::default_command_editor ( const default_command_editor )
private

Member Function Documentation

void command_editor::accept_line ( void  )
staticinherited
void command_editor::add_event_hook ( event_hook_fcn  f)
staticinherited
void command_editor::add_pre_input_hook ( pre_input_hook_fcn  f)
staticinherited
void command_editor::add_startup_hook ( startup_hook_fcn  f)
staticinherited
void command_editor::blink_matching_paren ( bool  flag)
staticinherited
void command_editor::clear_screen ( bool  skip_redisplay = false)
staticinherited
void command_editor::clear_undo_list ( void  )
staticinherited
int command_editor::current_command_number ( void  )
staticinherited
std::string command_editor::decode_prompt_string ( const std::string &  s)
staticinherited
void default_command_editor::do_accept_line ( void  )
virtual

Implements command_editor.

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

virtual void command_editor::do_blink_matching_paren ( bool  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::blink_matching_paren().

virtual void command_editor::do_clear_screen ( bool  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::clear_screen().

virtual void command_editor::do_clear_undo_list ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::clear_undo_list().

std::string command_editor::do_decode_prompt_string ( const std::string &  s)
protectedvirtualinherited
virtual bool command_editor::do_filename_completion_desired ( bool  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::filename_completion_desired().

virtual bool command_editor::do_filename_quoting_desired ( bool  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::filename_quoting_desired().

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

Implements command_editor.

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

virtual char_is_quoted_fcn command_editor::do_get_char_is_quoted_function ( void  ) const
inlineprotectedvirtualinherited

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

Referenced by command_editor::get_char_is_quoted_function().

virtual completion_fcn command_editor::do_get_completion_function ( void  ) const
inlineprotectedvirtualinherited

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

Referenced by command_editor::get_completion_function().

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

Implements command_editor.

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

virtual dequoting_fcn command_editor::do_get_dequoting_function ( void  ) const
inlineprotectedvirtualinherited

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

Referenced by command_editor::get_dequoting_function().

FILE * default_command_editor::do_get_input_stream ( void  )
virtual

Implements command_editor.

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

References input_stream.

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

Implements command_editor.

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

FILE * default_command_editor::do_get_output_stream ( void  )
virtual

Implements command_editor.

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

References output_stream.

virtual quoting_fcn command_editor::do_get_quoting_function ( void  ) const
inlineprotectedvirtualinherited

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

Referenced by command_editor::get_quoting_function().

virtual user_accept_line_fcn command_editor::do_get_user_accept_line_function ( void  ) const
inlineprotectedvirtualinherited

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

Referenced by command_editor::get_user_accept_line_function().

int command_editor::do_insert_initial_input ( void  )
protectedinherited
void default_command_editor::do_insert_text ( const std::string &  text)
virtual

Implements command_editor.

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

virtual void command_editor::do_interrupt ( bool  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::interrupt().

void default_command_editor::do_newline ( void  )
virtual

Implements command_editor.

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

virtual void command_editor::do_re_read_init_file ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::re_read_init_file().

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

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

Referenced by command_editor::read_init_file().

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

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

Referenced by command_editor::readline().

std::string default_command_editor::do_readline ( const std::string &  prompt,
bool eof 
)
virtual

Implements command_editor.

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

References input_stream, octave_fgetl(), and output_stream.

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

Implements command_editor.

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

virtual void command_editor::do_resize_terminal ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::resize_terminal().

virtual void command_editor::do_restore_terminal_state ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::restore_terminal_state().

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

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

Referenced by command_editor::set_basic_quote_characters().

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

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

Referenced by command_editor::set_basic_word_break_characters().

virtual void command_editor::do_set_char_is_quoted_function ( char_is_quoted_fcn  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::set_char_is_quoted_function().

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

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

Referenced by command_editor::set_completer_quote_characters().

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

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

Referenced by command_editor::set_completer_word_break_characters().

virtual void command_editor::do_set_completion_append_character ( char  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::set_completion_append_character().

virtual void command_editor::do_set_completion_function ( completion_fcn  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::set_completion_function().

virtual void command_editor::do_set_dequoting_function ( dequoting_fcn  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::set_dequoting_function().

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

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

Referenced by command_editor::set_filename_quote_characters().

void default_command_editor::do_set_input_stream ( FILE *  f)
virtual

Implements command_editor.

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

References f, and input_stream.

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

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

Referenced by command_editor::set_name().

void default_command_editor::do_set_output_stream ( FILE *  f)
virtual

Implements command_editor.

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

References f, and output_stream.

virtual void command_editor::do_set_quoting_function ( quoting_fcn  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::set_quoting_function().

virtual void command_editor::do_set_user_accept_line_function ( user_accept_line_fcn  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::set_user_accept_line_function().

virtual int command_editor::do_terminal_cols ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::terminal_cols().

virtual int command_editor::do_terminal_rows ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::terminal_rows().

virtual bool command_editor::do_undo ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::undo().

void command_editor::error ( int  err_num)
protectedinherited

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

References current_liboctave_error_handler.

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

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

References current_liboctave_error_handler.

bool command_editor::filename_completion_desired ( bool  arg)
staticinherited
bool command_editor::filename_quoting_desired ( bool  arg)
staticinherited
void command_editor::force_default_editor ( void  )
staticinherited

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

References command_editor::instance.

Referenced by octave_initialize_interpreter().

string_vector command_editor::generate_filename_completions ( const std::string &  text)
staticinherited
command_editor::char_is_quoted_fcn command_editor::get_char_is_quoted_function ( void  )
staticinherited
command_editor::completion_fcn command_editor::get_completion_function ( void  )
staticinherited
std::string command_editor::get_current_line ( void  )
staticinherited
command_editor::dequoting_fcn command_editor::get_dequoting_function ( void  )
staticinherited
FILE * command_editor::get_input_stream ( void  )
staticinherited
std::string command_editor::get_line_buffer ( void  )
staticinherited
FILE * command_editor::get_output_stream ( void  )
staticinherited
command_editor::quoting_fcn command_editor::get_quoting_function ( void  )
staticinherited
command_editor::user_accept_line_fcn command_editor::get_user_accept_line_function ( void  )
staticinherited
void command_editor::increment_current_command_number ( void  )
staticinherited
int command_editor::insert_initial_input ( void  )
staticinherited
void command_editor::insert_text ( const std::string &  text)
staticinherited
bool command_editor::interrupt ( bool  arg = true)
staticinherited
void command_editor::newline ( void  )
staticinherited
virtual std::string command_editor::newline_chars ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::do_decode_prompt_string().

default_command_editor& default_command_editor::operator= ( const default_command_editor )
private
void command_editor::re_read_init_file ( void  )
staticinherited
void command_editor::read_init_file ( const std::string &  file = std::string ())
staticinherited
int command_editor::read_octal ( const std::string &  s)
protectedinherited

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

Referenced by command_editor::do_decode_prompt_string().

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

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

Referenced by gnu_readline().

std::string command_editor::readline ( const std::string &  prompt,
bool eof 
)
staticinherited
void command_editor::redisplay ( void  )
staticinherited
void command_editor::remove_event_hook ( event_hook_fcn  f)
staticinherited
void command_editor::remove_pre_input_hook ( pre_input_hook_fcn  f)
staticinherited
void command_editor::remove_startup_hook ( startup_hook_fcn  f)
staticinherited
void command_editor::replace_line ( const std::string &  text,
bool  clear_undo = true 
)
staticinherited
void command_editor::reset_current_command_number ( int  n)
staticinherited
void command_editor::resize_terminal ( void  )
staticinherited
virtual void command_editor::restore_event_hook ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::remove_event_hook().

virtual void command_editor::restore_pre_input_hook ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::remove_pre_input_hook().

virtual void command_editor::restore_startup_hook ( void  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::remove_startup_hook().

void command_editor::restore_terminal_state ( void  )
staticinherited
void command_editor::run_event_hooks ( void  )
staticinherited

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

References command_editor::event_handler().

Referenced by Fwaitfor().

void command_editor::set_basic_quote_characters ( const std::string &  s)
staticinherited
void command_editor::set_basic_word_break_characters ( const std::string &  s)
staticinherited
void command_editor::set_char_is_quoted_function ( char_is_quoted_fcn  f)
staticinherited
void command_editor::set_completer_quote_characters ( const std::string &  s)
staticinherited
void command_editor::set_completer_word_break_characters ( const std::string &  s)
staticinherited
void command_editor::set_completion_append_character ( char  c)
staticinherited
void command_editor::set_completion_function ( completion_fcn  f)
staticinherited
void command_editor::set_dequoting_function ( dequoting_fcn  f)
staticinherited
virtual void command_editor::set_event_hook ( event_hook_fcn  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::add_event_hook().

void command_editor::set_filename_quote_characters ( const std::string &  s)
staticinherited
void command_editor::set_initial_input ( const std::string &  text)
staticinherited
void command_editor::set_input_stream ( FILE *  f)
staticinherited
void command_editor::set_name ( const std::string &  n)
staticinherited
void command_editor::set_output_stream ( FILE *  f)
staticinherited
virtual void command_editor::set_pre_input_hook ( pre_input_hook_fcn  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::add_pre_input_hook().

void command_editor::set_quoting_function ( quoting_fcn  f)
staticinherited
virtual void command_editor::set_startup_hook ( startup_hook_fcn  )
inlineprotectedvirtualinherited

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

Referenced by command_editor::add_startup_hook().

void command_editor::set_user_accept_line_function ( user_accept_line_fcn  f)
staticinherited
int command_editor::terminal_cols ( void  )
staticinherited
int command_editor::terminal_rows ( void  )
staticinherited
bool command_editor::undo ( void  )
staticinherited

Member Data Documentation

int command_editor::command_number
protectedinherited
std::string command_editor::initial_input
protectedinherited
FILE* default_command_editor::input_stream
private

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

Referenced by do_get_input_stream(), do_readline(), and do_set_input_stream().

bool command_editor::interrupted
protectedinherited

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

Referenced by command_editor::interrupt().

FILE* default_command_editor::output_stream
private

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

Referenced by do_get_output_stream(), do_readline(), and do_set_output_stream().


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