cmdline_options Class Reference

#include "octave.h"

Public Member Functions
	cmdline_options ()
	cmdline_options (int argc, char **argv)
string_vector	all_args () const
void	all_args (const string_vector &arg)
octave_value	as_octave_value () const
std::string	code_to_eval () const
void	code_to_eval (const std::string &arg)
std::list< std::string >	command_line_path () const
void	command_line_path (const std::list< std::string > &arg)
std::string	doc_cache_file () const
void	doc_cache_file (const std::string &arg)
std::string	docstrings_file () const
void	docstrings_file (const std::string &arg)
bool	echo_commands () const
void	echo_commands (bool arg)
std::string	exec_path () const
void	exec_path (const std::string &arg)
bool	experimental_terminal_widget () const
void	experimental_terminal_widget (bool arg)
bool	forced_interactive () const
void	forced_interactive (bool arg)
bool	forced_line_editing () const
void	forced_line_editing (bool arg)
bool	gui () const
void	gui (bool arg)
std::string	image_path () const
void	image_path (const std::string &arg)
std::string	info_file () const
void	info_file (const std::string &arg)
std::string	info_program () const
void	info_program (const std::string &arg)
bool	inhibit_startup_message () const
void	inhibit_startup_message (bool arg)
bool	line_editing () const
void	line_editing (bool arg)
bool	no_window_system () const
void	no_window_system (bool arg)
bool	persist () const
void	persist (bool arg)
bool	read_history_file () const
void	read_history_file (bool arg)
bool	read_init_files () const
void	read_init_files (bool arg)
bool	read_site_files () const
void	read_site_files (bool arg)
string_vector	remaining_args () const
void	remaining_args (const string_vector &arg)
bool	server () const
void	server (bool arg)
bool	set_initial_path () const
void	set_initial_path (bool arg)
int	sys_argc () const
char **	sys_argv () const
std::string	texi_macros_file () const
void	texi_macros_file (const std::string &arg)
bool	traditional () const
void	traditional (bool arg)
bool	verbose_flag () const
void	verbose_flag (bool arg)

Detailed Description

Definition at line 43 of file octave.h.

Constructor & Destructor Documentation

cmdline_options() [1/2]

cmdline_options::cmdline_options

(

)

Definition at line 59 of file octave.cc.

cmdline_options() [2/2]

cmdline_options::cmdline_options	(	int	argc,
		char **	argv
	)

Definition at line 65 of file octave.cc.

References octave_getopt_long_wrapper().

Member Function Documentation

all_args() [1/2]

string_vector cmdline_options::all_args ( ) const

inline

Definition at line 86 of file octave.h.

Referenced by as_octave_value().

all_args() [2/2]

void cmdline_options::all_args ( const string_vector &  arg )

inline

Definition at line 118 of file octave.h.

References octave_value::arg().

as_octave_value()

octave_value cmdline_options::as_octave_value

(

void

)

const

Definition at line 243 of file octave.cc.

References all_args(), code_to_eval(), command_line_path(), doc_cache_file(), docstrings_file(), echo_commands(), exec_path(), forced_interactive(), forced_line_editing(), gui(), image_path(), info_file(), info_program(), inhibit_startup_message(), line_editing(), m, no_window_system(), persist(), read_history_file(), read_init_files(), read_site_files(), remaining_args(), server(), set_initial_path(), sys_argc(), texi_macros_file(), traditional(), and verbose_flag().

Referenced by octave::Fcmdline_options().

code_to_eval() [1/2]

std::string cmdline_options::code_to_eval ( ) const

inline

Definition at line 76 of file octave.h.

Referenced by as_octave_value().

code_to_eval() [2/2]

void cmdline_options::code_to_eval ( const std::string &  arg )

inline

Definition at line 108 of file octave.h.

References octave_value::arg().

command_line_path() [1/2]

std::list<std::string> cmdline_options::command_line_path ( ) const

inline

Definition at line 77 of file octave.h.

Referenced by as_octave_value().

command_line_path() [2/2]

void cmdline_options::command_line_path ( const std::list< std::string > &  arg )

inline

Definition at line 109 of file octave.h.

References octave_value::arg().

doc_cache_file() [1/2]

std::string cmdline_options::doc_cache_file ( ) const

inline

Definition at line 80 of file octave.h.

Referenced by as_octave_value().

doc_cache_file() [2/2]

void cmdline_options::doc_cache_file ( const std::string &  arg )

inline

Definition at line 112 of file octave.h.

References octave_value::arg().

docstrings_file() [1/2]

std::string cmdline_options::docstrings_file ( ) const

inline

Definition at line 79 of file octave.h.

Referenced by as_octave_value().

docstrings_file() [2/2]

void cmdline_options::docstrings_file ( const std::string &  arg )

inline

Definition at line 111 of file octave.h.

References octave_value::arg().

echo_commands() [1/2]

bool cmdline_options::echo_commands ( ) const

inline

Definition at line 56 of file octave.h.

Referenced by as_octave_value().

echo_commands() [2/2]

void cmdline_options::echo_commands ( bool  arg )

inline

Definition at line 89 of file octave.h.

References octave_value::arg().

exec_path() [1/2]

std::string cmdline_options::exec_path ( ) const

inline

Definition at line 81 of file octave.h.

Referenced by as_octave_value().

exec_path() [2/2]

void cmdline_options::exec_path ( const std::string &  arg )

inline

Definition at line 113 of file octave.h.

References octave_value::arg().

experimental_terminal_widget() [1/2]

bool cmdline_options::experimental_terminal_widget ( ) const

inline

Definition at line 58 of file octave.h.

Referenced by interpreter::execute(), interpreter::experimental_terminal_widget(), application::experimental_terminal_widget(), and interpreter::initialize().

experimental_terminal_widget() [2/2]

void cmdline_options::experimental_terminal_widget ( bool  arg )

inline

Definition at line 91 of file octave.h.

References octave_value::arg().

forced_interactive() [1/2]

bool cmdline_options::forced_interactive ( ) const

inline

Definition at line 60 of file octave.h.

Referenced by as_octave_value(), interpreter::execute(), and application::forced_interactive().

forced_interactive() [2/2]

void cmdline_options::forced_interactive ( bool  arg )

inline

Definition at line 94 of file octave.h.

References octave_value::arg().

forced_line_editing() [1/2]

bool cmdline_options::forced_line_editing ( ) const

inline

Definition at line 61 of file octave.h.

Referenced by as_octave_value().

forced_line_editing() [2/2]

void cmdline_options::forced_line_editing ( bool  arg )

inline

Definition at line 93 of file octave.h.

References octave_value::arg().

gui() [1/2]

bool cmdline_options::gui ( ) const

inline

Definition at line 62 of file octave.h.

Referenced by as_octave_value(), interpreter::execute(), and interpreter::initialize().

gui() [2/2]

void cmdline_options::gui ( bool  arg )

inline

Definition at line 95 of file octave.h.

References octave_value::arg().

image_path() [1/2]

std::string cmdline_options::image_path ( ) const

inline

Definition at line 82 of file octave.h.

Referenced by as_octave_value().

image_path() [2/2]

void cmdline_options::image_path ( const std::string &  arg )

inline

Definition at line 114 of file octave.h.

References octave_value::arg().

info_file() [1/2]

std::string cmdline_options::info_file ( ) const

inline

Definition at line 83 of file octave.h.

Referenced by as_octave_value().

info_file() [2/2]

void cmdline_options::info_file ( const std::string &  arg )

inline

Definition at line 115 of file octave.h.

References octave_value::arg().

info_program() [1/2]

std::string cmdline_options::info_program ( ) const

inline

Definition at line 84 of file octave.h.

Referenced by as_octave_value().

info_program() [2/2]

void cmdline_options::info_program ( const std::string &  arg )

inline

Definition at line 116 of file octave.h.

References octave_value::arg().

inhibit_startup_message() [1/2]

bool cmdline_options::inhibit_startup_message ( ) const

inline

Definition at line 63 of file octave.h.

Referenced by as_octave_value().

inhibit_startup_message() [2/2]

void cmdline_options::inhibit_startup_message ( bool  arg )

inline

Definition at line 96 of file octave.h.

References octave_value::arg().

line_editing() [1/2]

bool cmdline_options::line_editing ( ) const

inline

Definition at line 65 of file octave.h.

Referenced by as_octave_value().

line_editing() [2/2]

void cmdline_options::line_editing ( bool  arg )

inline

Definition at line 97 of file octave.h.

References octave_value::arg().

no_window_system() [1/2]

bool cmdline_options::no_window_system ( ) const

inline

Definition at line 67 of file octave.h.

Referenced by as_octave_value().

no_window_system() [2/2]

void cmdline_options::no_window_system ( bool  arg )

inline

Definition at line 99 of file octave.h.

References octave_value::arg().

persist() [1/2]

bool cmdline_options::persist ( ) const

inline

Definition at line 68 of file octave.h.

Referenced by as_octave_value(), and interpreter::execute().

persist() [2/2]

void cmdline_options::persist ( bool  arg )

inline

Definition at line 100 of file octave.h.

References octave_value::arg().

read_history_file() [1/2]

bool cmdline_options::read_history_file ( ) const

inline

Definition at line 69 of file octave.h.

Referenced by as_octave_value(), and interpreter::initialize_history().

read_history_file() [2/2]

void cmdline_options::read_history_file ( bool  arg )

inline

Definition at line 101 of file octave.h.

References octave_value::arg().

read_init_files() [1/2]

bool cmdline_options::read_init_files ( ) const

inline

Definition at line 70 of file octave.h.

Referenced by as_octave_value().

read_init_files() [2/2]

void cmdline_options::read_init_files ( bool  arg )

inline

Definition at line 102 of file octave.h.

References octave_value::arg().

read_site_files() [1/2]

bool cmdline_options::read_site_files ( ) const

inline

Definition at line 71 of file octave.h.

Referenced by as_octave_value().

read_site_files() [2/2]

void cmdline_options::read_site_files ( bool  arg )

inline

Definition at line 103 of file octave.h.

References octave_value::arg().

remaining_args() [1/2]

string_vector cmdline_options::remaining_args ( ) const

inline

Definition at line 87 of file octave.h.

Referenced by as_octave_value().

remaining_args() [2/2]

void cmdline_options::remaining_args ( const string_vector &  arg )

inline

Definition at line 119 of file octave.h.

References octave_value::arg().

server() [1/2]

bool cmdline_options::server ( ) const

inline

Definition at line 72 of file octave.h.

Referenced by as_octave_value(), and interpreter::execute().

server() [2/2]

void cmdline_options::server ( bool  arg )

inline

Definition at line 104 of file octave.h.

References octave_value::arg().

set_initial_path() [1/2]

bool cmdline_options::set_initial_path ( ) const

inline

Definition at line 73 of file octave.h.

Referenced by as_octave_value(), and interpreter::initialize_load_path().

set_initial_path() [2/2]

void cmdline_options::set_initial_path ( bool  arg )

inline

Definition at line 105 of file octave.h.

References octave_value::arg().

sys_argc()

int cmdline_options::sys_argc ( ) const

inline

Definition at line 53 of file octave.h.

Referenced by as_octave_value().

sys_argv()

char** cmdline_options::sys_argv ( ) const

inline

Definition at line 54 of file octave.h.

texi_macros_file() [1/2]

std::string cmdline_options::texi_macros_file ( ) const

inline

Definition at line 85 of file octave.h.

Referenced by as_octave_value().

texi_macros_file() [2/2]

void cmdline_options::texi_macros_file ( const std::string &  arg )

inline

Definition at line 117 of file octave.h.

References octave_value::arg().

traditional() [1/2]

bool cmdline_options::traditional ( ) const

inline

Definition at line 74 of file octave.h.

Referenced by as_octave_value().

traditional() [2/2]

void cmdline_options::traditional ( bool  arg )

inline

Definition at line 106 of file octave.h.

References octave_value::arg().

verbose_flag() [1/2]

bool cmdline_options::verbose_flag ( ) const

inline

Definition at line 75 of file octave.h.

Referenced by as_octave_value().

verbose_flag() [2/2]

void cmdline_options::verbose_flag ( bool  arg )

inline

Definition at line 107 of file octave.h.

References octave_value::arg().

---

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

• libinterp/octave.h
• libinterp/octave.cc