GNU Octave  4.2.1
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 Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Static Private Attributes | List of all members
octave::command_history Class Reference

#include "cmd-hist.h"

Collaboration diagram for octave::command_history:
Collaboration graph
[legend]

Public Member Functions

virtual ~command_history (void)
 

Static Public Member Functions

static bool add (const std::string &)
 
static void append (const std::string &="")
 
static int base (void)
 
static void clean_up_and_save (const std::string &="", int=-1)
 
static void clear (void)
 
static int current_number (void)
 
static std::string file (void)
 
static std::string get_entry (int)
 
static int goto_mark (void)
 
static std::string histcontrol (void)
 
static void ignore_entries (bool=true)
 
static bool ignoring_entries (void)
 
static void initialize (bool, const std::string &, int, const std::string &)
 
static bool is_initialized (void)
 
static int is_stifled (void)
 
static int length (void)
 
static string_vector list (int=-1, bool=false)
 
static int max_input_history (void)
 
static void process_histcontrol (const std::string &)
 
static void read (bool=true)
 
static void read (const std::string &, bool=true)
 
static void read_range (int=-1, int=-1, bool=true)
 
static void read_range (const std::string &, int=-1, int=-1, bool=true)
 
static void remove (int)
 
static void replace_entry (int, const std::string &)
 
static void set_file (const std::string &)
 
static void set_mark (int n)
 
static void set_size (int)
 
static int size (void)
 
static void stifle (int)
 
static void truncate_file (const std::string &="", int=-1)
 
static int unstifle (void)
 
static int where (void)
 
static void write (const std::string &="")
 

Protected Member Functions

 command_history (void)
 
virtual bool do_add (const std::string &)
 
virtual void do_append (const std::string &)
 
virtual int do_base (void) const
 
virtual void do_clean_up_and_save (const std::string &, int)
 
virtual void do_clear (void)
 
virtual int do_current_number (void) const
 
virtual std::string do_file (void)
 
virtual std::string do_get_entry (int) const
 
virtual int do_goto_mark (void)
 
virtual std::string do_histcontrol (void) const
 
virtual void do_ignore_entries (bool)
 
virtual bool do_ignoring_entries (void) const
 
virtual void do_initialize (bool, const std::string &, int, const std::string &)
 
virtual bool do_is_initialized (void) const
 
virtual int do_is_stifled (void) const
 
virtual int do_length (void) const
 
virtual string_vector do_list (int, bool) const
 
virtual int do_max_input_history (void) const
 
virtual void do_process_histcontrol (const std::string &)
 
virtual void do_read (const std::string &, bool)
 
virtual void do_read_range (const std::string &, int, int, bool)
 
virtual void do_remove (int)
 
virtual void do_replace_entry (int, const std::string &)
 
virtual void do_set_file (const std::string &)
 
virtual void do_set_mark (int)
 
virtual void do_set_size (int)
 
virtual int do_size (void) const
 
virtual void do_stifle (int)
 
virtual void do_truncate_file (const std::string &, int) const
 
virtual int do_unstifle (void)
 
virtual int do_where (void) const
 
virtual void do_write (const std::string &) const
 
void error (int, const std::string &msg="") const
 
void error (const std::string &) const
 

Protected Attributes

int history_control
 
bool ignoring_additions
 
bool initialized
 
int lines_in_file
 
int lines_this_session
 
std::string xfile
 
int xsize
 

Private Member Functions

 command_history (const command_history &)
 
command_historyoperator= (const command_history &)
 

Static Private Member Functions

static void cleanup_instance (void)
 
static bool instance_ok (void)
 
static void make_command_history (void)
 

Static Private Attributes

static command_historyinstance = 0
 

Detailed Description

Definition at line 34 of file cmd-hist.h.

Constructor & Destructor Documentation

octave::command_history::command_history ( void  )
inlineprotected

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

Referenced by make_command_history().

virtual octave::command_history::~command_history ( void  )
inlinevirtual

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

octave::command_history::command_history ( const command_history )
private

Member Function Documentation

bool octave::command_history::add ( const std::string s)
static
void octave::command_history::append ( const std::string f = "")
static

Definition at line 733 of file cmd-hist.cc.

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

Referenced by do_history().

int octave::command_history::base ( void  )
static

Definition at line 650 of file cmd-hist.cc.

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

void octave::command_history::clean_up_and_save ( const std::string f = "",
int  n = -1 
)
static

Definition at line 768 of file cmd-hist.cc.

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

static void octave::command_history::cleanup_instance ( void  )
inlinestaticprivate

Definition at line 135 of file cmd-hist.h.

Referenced by instance_ok().

void octave::command_history::clear ( void  )
static

Definition at line 622 of file cmd-hist.cc.

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

Referenced by do_history().

int octave::command_history::current_number ( void  )
static

Definition at line 657 of file cmd-hist.cc.

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

bool octave::command_history::do_add ( const std::string )
protectedvirtual

Definition at line 836 of file cmd-hist.cc.

Referenced by add().

void octave::command_history::do_append ( const std::string f_arg)
protectedvirtual

Definition at line 935 of file cmd-hist.cc.

References do_where(), error(), initialized, lines_this_session, string, and xfile.

Referenced by append().

int octave::command_history::do_base ( void  ) const
protectedvirtual

Definition at line 868 of file cmd-hist.cc.

Referenced by base(), and do_current_number().

void octave::command_history::do_clean_up_and_save ( const std::string f_arg,
int   
)
protectedvirtual

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

References error(), initialized, string, and xfile.

Referenced by clean_up_and_save().

void octave::command_history::do_clear ( void  )
protectedvirtual

Definition at line 846 of file cmd-hist.cc.

Referenced by clear().

int octave::command_history::do_current_number ( void  ) const
protectedvirtual

Definition at line 874 of file cmd-hist.cc.

References do_base(), do_where(), and xsize.

Referenced by current_number().

std::string octave::command_history::do_file ( void  )
protectedvirtual

Definition at line 806 of file cmd-hist.cc.

References xfile.

Referenced by file().

std::string octave::command_history::do_get_entry ( int  ) const
protectedvirtual

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

Referenced by get_entry().

int octave::command_history::do_goto_mark ( void  )
protectedvirtual

Definition at line 900 of file cmd-hist.cc.

Referenced by goto_mark().

virtual std::string octave::command_history::do_histcontrol ( void  ) const
inlineprotectedvirtual

Definition at line 149 of file cmd-hist.h.

Referenced by histcontrol().

void octave::command_history::do_ignore_entries ( bool  flag)
protectedvirtual

Definition at line 824 of file cmd-hist.cc.

References ignoring_additions.

Referenced by ignore_entries().

bool octave::command_history::do_ignoring_entries ( void  ) const
protectedvirtual

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

References ignoring_additions.

Referenced by ignoring_entries().

void octave::command_history::do_initialize ( bool  read_history_file,
const std::string f_arg,
int  sz,
const std::string control_arg 
)
protectedvirtual

Definition at line 779 of file cmd-hist.cc.

References initialized, process_histcontrol(), read(), set_file(), and set_size().

Referenced by initialize().

bool octave::command_history::do_is_initialized ( void  ) const
protectedvirtual

Definition at line 794 of file cmd-hist.cc.

References initialized.

Referenced by is_initialized().

int octave::command_history::do_is_stifled ( void  ) const
protectedvirtual

Definition at line 890 of file cmd-hist.cc.

Referenced by is_stifled().

int octave::command_history::do_length ( void  ) const
protectedvirtual

Definition at line 856 of file cmd-hist.cc.

Referenced by length().

string_vector octave::command_history::do_list ( int  ,
bool   
) const
protectedvirtual

Definition at line 973 of file cmd-hist.cc.

Referenced by list().

int octave::command_history::do_max_input_history ( void  ) const
protectedvirtual

Definition at line 862 of file cmd-hist.cc.

Referenced by max_input_history().

void octave::command_history::do_process_histcontrol ( const std::string )
protectedvirtual

Definition at line 775 of file cmd-hist.cc.

Referenced by process_histcontrol().

void octave::command_history::do_read ( const std::string f,
bool   
)
protectedvirtual

Definition at line 906 of file cmd-hist.cc.

References error().

Referenced by read().

void octave::command_history::do_read_range ( const std::string f,
int  ,
int  ,
bool   
)
protectedvirtual

Definition at line 913 of file cmd-hist.cc.

References error().

Referenced by read_range().

void octave::command_history::do_remove ( int  )
protectedvirtual

Definition at line 842 of file cmd-hist.cc.

Referenced by remove().

void octave::command_history::do_replace_entry ( int  ,
const std::string  
)
protectedvirtual

Definition at line 985 of file cmd-hist.cc.

Referenced by replace_entry().

void octave::command_history::do_set_file ( const std::string f)
protectedvirtual

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

References f, and xfile.

Referenced by set_file().

void octave::command_history::do_set_mark ( int  )
protectedvirtual

Definition at line 896 of file cmd-hist.cc.

Referenced by set_mark().

void octave::command_history::do_set_size ( int  n)
protectedvirtual

Definition at line 812 of file cmd-hist.cc.

References xsize.

Referenced by set_size().

int octave::command_history::do_size ( void  ) const
protectedvirtual

Definition at line 818 of file cmd-hist.cc.

References xsize.

Referenced by size().

void octave::command_history::do_stifle ( int  )
protectedvirtual

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

Referenced by stifle().

void octave::command_history::do_truncate_file ( const std::string f_arg,
int   
) const
protectedvirtual

Definition at line 958 of file cmd-hist.cc.

References error(), initialized, string, and xfile.

Referenced by truncate_file().

int octave::command_history::do_unstifle ( void  )
protectedvirtual

Definition at line 884 of file cmd-hist.cc.

Referenced by unstifle().

int octave::command_history::do_where ( void  ) const
protectedvirtual

Definition at line 850 of file cmd-hist.cc.

Referenced by do_append(), do_current_number(), and where().

void octave::command_history::do_write ( const std::string f_arg) const
protectedvirtual

Definition at line 920 of file cmd-hist.cc.

References error(), initialized, string, and xfile.

Referenced by write().

void octave::command_history::error ( int  err_num,
const std::string msg = "" 
) const
protected
void octave::command_history::error ( const std::string s) const
protected

Definition at line 1014 of file cmd-hist.cc.

std::string octave::command_history::file ( void  )
static

Definition at line 558 of file cmd-hist.cc.

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

Referenced by do_history(), read(), and read_range().

std::string octave::command_history::get_entry ( int  n)
static

Definition at line 754 of file cmd-hist.cc.

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

int octave::command_history::goto_mark ( void  )
static

Definition at line 692 of file cmd-hist.cc.

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

std::string octave::command_history::histcontrol ( void  )
static

Definition at line 572 of file cmd-hist.cc.

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

void octave::command_history::ignore_entries ( bool  flag = true)
static

Definition at line 593 of file cmd-hist.cc.

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

Referenced by parse_fcn_file().

bool octave::command_history::ignoring_entries ( void  )
static

Definition at line 600 of file cmd-hist.cc.

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

Referenced by parse_fcn_file().

void octave::command_history::initialize ( bool  read_history_file,
const std::string f_arg,
int  sz,
const std::string control_arg 
)
static

Definition at line 530 of file cmd-hist.cc.

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

Referenced by initialize_history().

bool octave::command_history::instance_ok ( void  )
staticprivate
bool octave::command_history::is_initialized ( void  )
static

Definition at line 539 of file cmd-hist.cc.

References do_is_initialized(), and instance.

int octave::command_history::is_stifled ( void  )
static

Definition at line 678 of file cmd-hist.cc.

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

int octave::command_history::length ( void  )
static

Definition at line 636 of file cmd-hist.cc.

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

string_vector octave::command_history::list ( int  limit = -1,
bool  number_lines = false 
)
static

Definition at line 747 of file cmd-hist.cc.

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

Referenced by do_history(), initialize_history(), and mk_tmp_hist_file().

void octave::command_history::make_command_history ( void  )
staticprivate

Definition at line 520 of file cmd-hist.cc.

References command_history(), and instance.

Referenced by instance_ok().

int octave::command_history::max_input_history ( void  )
static

Definition at line 643 of file cmd-hist.cc.

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

command_history& octave::command_history::operator= ( const command_history )
private
void octave::command_history::process_histcontrol ( const std::string control_arg)
static

Definition at line 565 of file cmd-hist.cc.

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

Referenced by do_initialize().

void octave::command_history::read ( bool  must_exist = true)
static

Definition at line 699 of file cmd-hist.cc.

References file().

Referenced by do_history(), and do_initialize().

void octave::command_history::read ( const std::string f,
bool  must_exist = true 
)
static

Definition at line 705 of file cmd-hist.cc.

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

void octave::command_history::read_range ( int  from = -1,
int  to = -1,
bool  must_exist = true 
)
static

Definition at line 712 of file cmd-hist.cc.

References file().

Referenced by do_history().

void octave::command_history::read_range ( const std::string f,
int  from = -1,
int  to = -1,
bool  must_exist = true 
)
static

Definition at line 718 of file cmd-hist.cc.

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

void octave::command_history::remove ( int  n)
static

Definition at line 615 of file cmd-hist.cc.

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

Referenced by mk_tmp_hist_file().

void octave::command_history::replace_entry ( int  which,
const std::string line 
)
static

Definition at line 761 of file cmd-hist.cc.

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

void octave::command_history::set_file ( const std::string f_arg)
static
void octave::command_history::set_mark ( int  n)
static

Definition at line 685 of file cmd-hist.cc.

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

void octave::command_history::set_size ( int  n)
static

Definition at line 579 of file cmd-hist.cc.

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

Referenced by do_initialize().

int octave::command_history::size ( void  )
static

Definition at line 586 of file cmd-hist.cc.

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

void octave::command_history::stifle ( int  n)
static

Definition at line 664 of file cmd-hist.cc.

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

void octave::command_history::truncate_file ( const std::string f = "",
int  n = -1 
)
static

Definition at line 740 of file cmd-hist.cc.

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

int octave::command_history::unstifle ( void  )
static

Definition at line 671 of file cmd-hist.cc.

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

int octave::command_history::where ( void  )
static

Definition at line 629 of file cmd-hist.cc.

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

void octave::command_history::write ( const std::string f = "")
static

Definition at line 726 of file cmd-hist.cc.

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

Referenced by do_history().

Member Data Documentation

int octave::command_history::history_control
protected

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

bool octave::command_history::ignoring_additions
protected

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

Referenced by do_ignore_entries(), and do_ignoring_entries().

bool octave::command_history::initialized
protected
command_history * octave::command_history::instance = 0
staticprivate
int octave::command_history::lines_in_file
protected

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

int octave::command_history::lines_this_session
protected

Definition at line 226 of file cmd-hist.h.

Referenced by do_append().

std::string octave::command_history::xfile
protected
int octave::command_history::xsize
protected

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

Referenced by do_current_number(), do_set_size(), and do_size().


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