cmdline_options Class Reference

#include "octave.h"

Collaboration diagram for cmdline_options:

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

Private Attributes
string_vector	m_all_args
std::string	m_code_to_eval
std::list< std::string >	m_command_line_path
std::string	m_doc_cache_file
std::string	m_docstrings_file
bool	m_echo_commands = false
std::string	m_exec_path
bool	m_experimental_terminal_widget = false
bool	m_forced_interactive = false
bool	m_forced_line_editing = false
bool	m_gui = false
std::string	m_image_path
std::string	m_info_file
std::string	m_info_program
bool	m_inhibit_startup_message = false
bool	m_line_editing = true
bool	m_no_window_system = false
bool	m_persist = false
bool	m_read_history_file = true
bool	m_read_init_files = true
bool	m_read_site_files = true
string_vector	m_remaining_args
bool	m_server = false
bool	m_set_initial_path = true
std::string	m_texi_macros_file
bool	m_traditional = false
bool	m_verbose_flag = false

Detailed Description

Definition at line 43 of file octave.h.

Constructor & Destructor Documentation

cmdline_options() [1/3]

cmdline_options::cmdline_options

(

void

)

Definition at line 59 of file octave.cc.

cmdline_options() [2/3]

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

Definition at line 65 of file octave.cc.

References BUILT_IN_DOCSTRINGS_FILE_OPTION, DOC_CACHE_FILE_OPTION, EVAL_OPTION, EXEC_PATH_OPTION, EXPERIMENTAL_TERMINAL_WIDGET_OPTION, GUI_OPTION, IMAGE_PATH_OPTION, INFO_FILE_OPTION, INFO_PROG_OPTION, LINE_EDITING_OPTION, long_opts, m_all_args, m_code_to_eval, m_command_line_path, m_doc_cache_file, m_docstrings_file, m_echo_commands, m_exec_path, m_experimental_terminal_widget, m_forced_interactive, m_forced_line_editing, m_gui, m_image_path, m_info_file, m_info_program, m_inhibit_startup_message, m_line_editing, m_no_window_system, m_persist, m_read_history_file, m_read_init_files, m_read_site_files, m_remaining_args, m_server, m_set_initial_path, m_texi_macros_file, m_traditional, m_verbose_flag, NO_GUI_OPTION, NO_INIT_FILE_OPTION, NO_INIT_PATH_OPTION, NO_LINE_EDITING_OPTION, NO_SITE_FILE_OPTION, octave_debug, octave_getopt_long_wrapper(), octave_optarg_wrapper(), octave_optind_wrapper(), octave_print_terse_usage_and_exit(), octave_print_verbose_usage_and_exit(), octave_print_version_and_exit(), panic_impossible, PERSIST_OPTION, SERVER_OPTION, short_opts, TEXI_MACROS_FILE_OPTION, and TRADITIONAL_OPTION.

cmdline_options() [3/3]

cmdline_options::cmdline_options ( const cmdline_options &  )

default

Member Function Documentation

all_args() [1/2]

void cmdline_options::all_args ( const string_vector &  arg )

inline

Definition at line 120 of file octave.h.

References octave_value::arg().

all_args() [2/2]

string_vector cmdline_options::all_args ( void  ) const

inline

Definition at line 88 of file octave.h.

Referenced by interpreter::interpreter(), as_octave_value(), interpreter::execute_command_line_file(), and application::init().

as_octave_value()

octave_value cmdline_options::as_octave_value

(

void

)

const

Definition at line 242 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(), sys_argv(), texi_macros_file(), traditional(), and verbose_flag().

Referenced by Fcmdline_options().

code_to_eval() [1/2]

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

inline

Definition at line 110 of file octave.h.

References octave_value::arg().

code_to_eval() [2/2]

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

inline

Definition at line 78 of file octave.h.

Referenced by as_octave_value(), interpreter::execute_eval_option_code(), and application::init().

command_line_path() [1/2]

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

inline

Definition at line 111 of file octave.h.

References octave_value::arg().

command_line_path() [2/2]

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

inline

Definition at line 79 of file octave.h.

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

doc_cache_file() [1/2]

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

inline

Definition at line 114 of file octave.h.

References octave_value::arg().

doc_cache_file() [2/2]

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

inline

Definition at line 82 of file octave.h.

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

docstrings_file() [1/2]

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

inline

Definition at line 113 of file octave.h.

References octave_value::arg().

docstrings_file() [2/2]

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

inline

Definition at line 81 of file octave.h.

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

echo_commands() [1/2]

void cmdline_options::echo_commands ( bool  arg )

inline

Definition at line 91 of file octave.h.

References octave_value::arg().

echo_commands() [2/2]

bool cmdline_options::echo_commands ( void  ) const

inline

Definition at line 58 of file octave.h.

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

exec_path() [1/2]

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

inline

Definition at line 115 of file octave.h.

References octave_value::arg().

exec_path() [2/2]

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

inline

Definition at line 83 of file octave.h.

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

experimental_terminal_widget() [1/2]

void cmdline_options::experimental_terminal_widget ( bool  arg )

inline

Definition at line 93 of file octave.h.

References octave_value::arg().

experimental_terminal_widget() [2/2]

bool cmdline_options::experimental_terminal_widget ( void  ) const

inline

Definition at line 60 of file octave.h.

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

forced_interactive() [1/2]

void cmdline_options::forced_interactive ( bool  arg )

inline

Definition at line 96 of file octave.h.

References octave_value::arg().

forced_interactive() [2/2]

bool cmdline_options::forced_interactive ( void  ) const

inline

Definition at line 62 of file octave.h.

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

forced_line_editing() [1/2]

void cmdline_options::forced_line_editing ( bool  arg )

inline

Definition at line 95 of file octave.h.

References octave_value::arg().

forced_line_editing() [2/2]

bool cmdline_options::forced_line_editing ( void  ) const

inline

Definition at line 63 of file octave.h.

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

gui() [1/2]

void cmdline_options::gui ( bool  arg )

inline

Definition at line 97 of file octave.h.

References octave_value::arg().

gui() [2/2]

bool cmdline_options::gui ( void  ) const

inline

Definition at line 64 of file octave.h.

Referenced by as_octave_value(), base_qobject::close_gui(), interpreter::execute(), application::init(), interpreter::initialize(), and qt_application::start_gui_p().

image_path() [1/2]

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

inline

Definition at line 116 of file octave.h.

References octave_value::arg().

image_path() [2/2]

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

inline

Definition at line 84 of file octave.h.

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

info_file() [1/2]

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

inline

Definition at line 117 of file octave.h.

References octave_value::arg().

info_file() [2/2]

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

inline

Definition at line 85 of file octave.h.

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

info_program() [1/2]

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

inline

Definition at line 118 of file octave.h.

References octave_value::arg().

info_program() [2/2]

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

inline

Definition at line 86 of file octave.h.

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

inhibit_startup_message() [1/2]

void cmdline_options::inhibit_startup_message ( bool  arg )

inline

Definition at line 98 of file octave.h.

References octave_value::arg().

inhibit_startup_message() [2/2]

bool cmdline_options::inhibit_startup_message ( void  ) const

inline

Definition at line 65 of file octave.h.

Referenced by as_octave_value(), interpreter::display_startup_message(), and interpreter::execute_startup_files().

line_editing() [1/2]

void cmdline_options::line_editing ( bool  arg )

inline

Definition at line 99 of file octave.h.

References octave_value::arg().

line_editing() [2/2]

bool cmdline_options::line_editing ( void  ) const

inline

Definition at line 67 of file octave.h.

Referenced by interpreter::interpreter(), as_octave_value(), and application::init().

no_window_system() [1/2]

void cmdline_options::no_window_system ( bool  arg )

inline

Definition at line 101 of file octave.h.

References octave_value::arg().

no_window_system() [2/2]

bool cmdline_options::no_window_system ( void  ) const

inline

Definition at line 69 of file octave.h.

Referenced by interpreter::interpreter(), as_octave_value(), and application::init().

operator=()

cmdline_options& cmdline_options::operator= ( const cmdline_options &  )

default

persist() [1/2]

void cmdline_options::persist ( bool  arg )

inline

Definition at line 102 of file octave.h.

References octave_value::arg().

persist() [2/2]

bool cmdline_options::persist ( void  ) const

inline

Definition at line 70 of file octave.h.

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

read_history_file() [1/2]

void cmdline_options::read_history_file ( bool  arg )

inline

Definition at line 103 of file octave.h.

References octave_value::arg().

read_history_file() [2/2]

bool cmdline_options::read_history_file ( void  ) const

inline

Definition at line 71 of file octave.h.

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

read_init_files() [1/2]

void cmdline_options::read_init_files ( bool  arg )

inline

Definition at line 104 of file octave.h.

References octave_value::arg().

read_init_files() [2/2]

bool cmdline_options::read_init_files ( void  ) const

inline

Definition at line 72 of file octave.h.

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

read_site_files() [1/2]

void cmdline_options::read_site_files ( bool  arg )

inline

Definition at line 105 of file octave.h.

References octave_value::arg().

read_site_files() [2/2]

bool cmdline_options::read_site_files ( void  ) const

inline

Definition at line 73 of file octave.h.

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

remaining_args() [1/2]

void cmdline_options::remaining_args ( const string_vector &  arg )

inline

Definition at line 121 of file octave.h.

References octave_value::arg().

remaining_args() [2/2]

string_vector cmdline_options::remaining_args ( void  ) const

inline

Definition at line 89 of file octave.h.

Referenced by as_octave_value(), interpreter::execute_command_line_file(), and application::init().

server() [1/2]

void cmdline_options::server ( bool  arg )

inline

Definition at line 106 of file octave.h.

References octave_value::arg().

server() [2/2]

bool cmdline_options::server ( void  ) const

inline

Definition at line 74 of file octave.h.

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

set_initial_path() [1/2]

void cmdline_options::set_initial_path ( bool  arg )

inline

Definition at line 107 of file octave.h.

References octave_value::arg().

set_initial_path() [2/2]

bool cmdline_options::set_initial_path ( void  ) const

inline

Definition at line 75 of file octave.h.

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

sys_argc()

int cmdline_options::sys_argc ( void  ) const

inline

Definition at line 55 of file octave.h.

Referenced by as_octave_value().

sys_argv()

char** cmdline_options::sys_argv ( void  ) const

inline

Definition at line 56 of file octave.h.

Referenced by as_octave_value().

texi_macros_file() [1/2]

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

inline

Definition at line 119 of file octave.h.

References octave_value::arg().

texi_macros_file() [2/2]

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

inline

Definition at line 87 of file octave.h.

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

traditional() [1/2]

void cmdline_options::traditional ( bool  arg )

inline

Definition at line 108 of file octave.h.

References octave_value::arg().

traditional() [2/2]

bool cmdline_options::traditional ( void  ) const

inline

Definition at line 76 of file octave.h.

Referenced by interpreter::interpreter(), as_octave_value(), and application::init().

verbose_flag() [1/2]

void cmdline_options::verbose_flag ( bool  arg )

inline

Definition at line 109 of file octave.h.

References octave_value::arg().

verbose_flag() [2/2]

bool cmdline_options::verbose_flag ( void  ) const

inline

Definition at line 77 of file octave.h.

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

Member Data Documentation

m_all_args

string_vector cmdline_options::m_all_args

private

Definition at line 229 of file octave.h.

Referenced by cmdline_options().

m_code_to_eval

std::string cmdline_options::m_code_to_eval

private

Definition at line 193 of file octave.h.

Referenced by cmdline_options().

m_command_line_path

std::list<std::string> cmdline_options::m_command_line_path

private

Definition at line 197 of file octave.h.

Referenced by cmdline_options().

m_doc_cache_file

std::string cmdline_options::m_doc_cache_file

private

Definition at line 206 of file octave.h.

Referenced by cmdline_options().

m_docstrings_file

std::string cmdline_options::m_docstrings_file

private

Definition at line 202 of file octave.h.

Referenced by cmdline_options().

m_echo_commands

bool cmdline_options::m_echo_commands = false

private

Definition at line 129 of file octave.h.

Referenced by cmdline_options().

m_exec_path

std::string cmdline_options::m_exec_path

private

Definition at line 210 of file octave.h.

Referenced by cmdline_options().

m_experimental_terminal_widget

bool cmdline_options::m_experimental_terminal_widget = false

private

Definition at line 133 of file octave.h.

Referenced by cmdline_options().

m_forced_interactive

bool cmdline_options::m_forced_interactive = false

private

Definition at line 141 of file octave.h.

Referenced by cmdline_options().

m_forced_line_editing

bool cmdline_options::m_forced_line_editing = false

private

Definition at line 145 of file octave.h.

Referenced by cmdline_options().

m_gui

bool cmdline_options::m_gui = false

private

Definition at line 137 of file octave.h.

Referenced by cmdline_options().

m_image_path

std::string cmdline_options::m_image_path

private

Definition at line 214 of file octave.h.

Referenced by cmdline_options().

m_info_file

std::string cmdline_options::m_info_file

private

Definition at line 218 of file octave.h.

Referenced by cmdline_options().

m_info_program

std::string cmdline_options::m_info_program

private

Definition at line 222 of file octave.h.

Referenced by cmdline_options().

m_inhibit_startup_message

bool cmdline_options::m_inhibit_startup_message = false

private

Definition at line 149 of file octave.h.

Referenced by cmdline_options().

m_line_editing

bool cmdline_options::m_line_editing = true

private

Definition at line 153 of file octave.h.

Referenced by cmdline_options().

m_no_window_system

bool cmdline_options::m_no_window_system = false

private

Definition at line 157 of file octave.h.

Referenced by cmdline_options().

m_persist

bool cmdline_options::m_persist = false

private

Definition at line 161 of file octave.h.

Referenced by cmdline_options().

m_read_history_file

bool cmdline_options::m_read_history_file = true

private

Definition at line 165 of file octave.h.

Referenced by cmdline_options().

m_read_init_files

bool cmdline_options::m_read_init_files = true

private

Definition at line 169 of file octave.h.

Referenced by cmdline_options().

m_read_site_files

bool cmdline_options::m_read_site_files = true

private

Definition at line 173 of file octave.h.

Referenced by cmdline_options().

m_remaining_args

string_vector cmdline_options::m_remaining_args

private

Definition at line 232 of file octave.h.

Referenced by cmdline_options().

m_server

bool cmdline_options::m_server = false

private

Definition at line 177 of file octave.h.

Referenced by cmdline_options().

m_set_initial_path

bool cmdline_options::m_set_initial_path = true

private

Definition at line 181 of file octave.h.

Referenced by cmdline_options().

m_texi_macros_file

std::string cmdline_options::m_texi_macros_file

private

Definition at line 226 of file octave.h.

Referenced by cmdline_options().

m_traditional

bool cmdline_options::m_traditional = false

private

Definition at line 185 of file octave.h.

Referenced by cmdline_options().

m_verbose_flag

bool cmdline_options::m_verbose_flag = false

private

Definition at line 189 of file octave.h.

Referenced by cmdline_options().

---

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

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