#include "octave.h"

Collaboration diagram for octave::cmdline_options:

[legend]

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

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	debug_jit (bool arg)

bool	debug_jit (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	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	jit_compiler (bool arg)

bool	jit_compiler (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	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

bool	m_debug_jit = false

std::string	m_doc_cache_file

std::string	m_docstrings_file

bool	m_echo_commands = false

std::string	m_exec_path

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_jit_compiler = 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_set_initial_path = true

std::string	m_texi_macros_file

bool	m_traditional = false

bool	m_verbose_flag = false

Detailed Description

Definition at line 40 of file octave.h.

Constructor & Destructor Documentation

◆ cmdline_options() [1/3]

octave::cmdline_options::cmdline_options ( void )

Definition at line 58 of file octave.cc.

References m_all_args, and string_vector::resize().

◆ cmdline_options() [2/3]

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

Definition at line 64 of file octave.cc.

References BUILT_IN_DOCSTRINGS_FILE_OPTION, DEBUG_JIT_OPTION, DOC_CACHE_FILE_OPTION, EVAL_OPTION, EXEC_PATH_OPTION, GUI_OPTION, IMAGE_PATH_OPTION, INFO_FILE_OPTION, INFO_PROG_OPTION, JIT_COMPILER_OPTION, LINE_EDITING_OPTION, long_opts, m_all_args, m_code_to_eval, m_command_line_path, m_debug_jit, m_doc_cache_file, m_docstrings_file, m_echo_commands, m_exec_path, m_forced_interactive, m_forced_line_editing, m_gui, m_image_path, m_info_file, m_info_program, m_inhibit_startup_message, m_jit_compiler, 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_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, short_opts, TEXI_MACROS_FILE_OPTION, and TRADITIONAL_OPTION.

◆ cmdline_options() [3/3]

octave::cmdline_options::cmdline_options ( const cmdline_options & )

default

Member Function Documentation

◆ all_args() [1/2]

void octave::cmdline_options::all_args ( const string_vector & arg )

inline

Definition at line 112 of file octave.h.

◆ all_args() [2/2]

string_vector octave::cmdline_options::all_args ( void ) const

inline

Definition at line 82 of file octave.h.

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

◆ code_to_eval() [1/2]

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

inline

Definition at line 103 of file octave.h.

◆ code_to_eval() [2/2]

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

inline

Definition at line 73 of file octave.h.

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

◆ command_line_path() [1/2]

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

inline

Definition at line 104 of file octave.h.

◆ command_line_path() [2/2]

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

inline

Definition at line 74 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ debug_jit() [1/2]

void octave::cmdline_options::debug_jit ( bool arg )

inline

Definition at line 85 of file octave.h.

◆ debug_jit() [2/2]

bool octave::cmdline_options::debug_jit ( void ) const

inline

Definition at line 55 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ doc_cache_file() [1/2]

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

inline

Definition at line 106 of file octave.h.

◆ doc_cache_file() [2/2]

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

inline

Definition at line 76 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ docstrings_file() [1/2]

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

inline

Definition at line 105 of file octave.h.

◆ docstrings_file() [2/2]

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

inline

Definition at line 75 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ echo_commands() [1/2]

void octave::cmdline_options::echo_commands ( bool arg )

inline

Definition at line 86 of file octave.h.

◆ echo_commands() [2/2]

bool octave::cmdline_options::echo_commands ( void ) const

inline

Definition at line 56 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ exec_path() [1/2]

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

inline

Definition at line 107 of file octave.h.

◆ exec_path() [2/2]

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

inline

Definition at line 77 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ forced_interactive() [1/2]

void octave::cmdline_options::forced_interactive ( bool arg )

inline

Definition at line 89 of file octave.h.

◆ forced_interactive() [2/2]

bool octave::cmdline_options::forced_interactive ( void ) const

inline

Definition at line 58 of file octave.h.

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

◆ forced_line_editing() [1/2]

void octave::cmdline_options::forced_line_editing ( bool arg )

inline

Definition at line 88 of file octave.h.

◆ forced_line_editing() [2/2]

bool octave::cmdline_options::forced_line_editing ( void ) const

inline

Definition at line 59 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ gui() [1/2]

void octave::cmdline_options::gui ( bool arg )

inline

Definition at line 90 of file octave.h.

◆ gui() [2/2]

bool octave::cmdline_options::gui ( void ) const

inline

Definition at line 60 of file octave.h.

Referenced by octave::application::init(), and octave::qt_application::start_gui_p().

◆ image_path() [1/2]

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

inline

Definition at line 108 of file octave.h.

◆ image_path() [2/2]

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

inline

Definition at line 78 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ info_file() [1/2]

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

inline

Definition at line 109 of file octave.h.

◆ info_file() [2/2]

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

inline

Definition at line 79 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ info_program() [1/2]

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

inline

Definition at line 110 of file octave.h.

◆ info_program() [2/2]

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

inline

Definition at line 80 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ inhibit_startup_message() [1/2]

void octave::cmdline_options::inhibit_startup_message ( bool arg )

inline

Definition at line 91 of file octave.h.

◆ inhibit_startup_message() [2/2]

bool octave::cmdline_options::inhibit_startup_message ( void ) const

inline

Definition at line 61 of file octave.h.

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

◆ jit_compiler() [1/2]

void octave::cmdline_options::jit_compiler ( bool arg )

inline

Definition at line 92 of file octave.h.

◆ jit_compiler() [2/2]

bool octave::cmdline_options::jit_compiler ( void ) const

inline

Definition at line 62 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ line_editing() [1/2]

void octave::cmdline_options::line_editing ( bool arg )

inline

Definition at line 93 of file octave.h.

◆ line_editing() [2/2]

bool octave::cmdline_options::line_editing ( void ) const

inline

Definition at line 63 of file octave.h.

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

◆ no_window_system() [1/2]

void octave::cmdline_options::no_window_system ( bool arg )

inline

Definition at line 95 of file octave.h.

◆ no_window_system() [2/2]

bool octave::cmdline_options::no_window_system ( void ) const

inline

Definition at line 65 of file octave.h.

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

◆ operator=()

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

default

◆ persist() [1/2]

void octave::cmdline_options::persist ( bool arg )

inline

Definition at line 96 of file octave.h.

◆ persist() [2/2]

bool octave::cmdline_options::persist ( void ) const

inline

Definition at line 66 of file octave.h.

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

◆ read_history_file() [1/2]

void octave::cmdline_options::read_history_file ( bool arg )

inline

Definition at line 97 of file octave.h.

◆ read_history_file() [2/2]

bool octave::cmdline_options::read_history_file ( void ) const

inline

Definition at line 67 of file octave.h.

Referenced by octave::interpreter::initialize_history().

◆ read_init_files() [1/2]

void octave::cmdline_options::read_init_files ( bool arg )

inline

Definition at line 98 of file octave.h.

◆ read_init_files() [2/2]

bool octave::cmdline_options::read_init_files ( void ) const

inline

Definition at line 68 of file octave.h.

Referenced by octave::interpreter::execute_startup_files().

◆ read_site_files() [1/2]

void octave::cmdline_options::read_site_files ( bool arg )

inline

Definition at line 99 of file octave.h.

◆ read_site_files() [2/2]

bool octave::cmdline_options::read_site_files ( void ) const

inline

Definition at line 69 of file octave.h.

Referenced by octave::interpreter::execute_startup_files().

◆ remaining_args() [1/2]

void octave::cmdline_options::remaining_args ( const string_vector & arg )

inline

Definition at line 113 of file octave.h.

◆ remaining_args() [2/2]

string_vector octave::cmdline_options::remaining_args ( void ) const

inline

Definition at line 83 of file octave.h.

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

◆ set_initial_path() [1/2]

void octave::cmdline_options::set_initial_path ( bool arg )

inline

Definition at line 100 of file octave.h.

◆ set_initial_path() [2/2]

bool octave::cmdline_options::set_initial_path ( void ) const

inline

Definition at line 70 of file octave.h.

Referenced by octave::interpreter::initialize_load_path().

◆ sys_argc()

int octave::cmdline_options::sys_argc ( void ) const

inline

Definition at line 52 of file octave.h.

◆ sys_argv()

char** octave::cmdline_options::sys_argv ( void ) const

inline

Definition at line 53 of file octave.h.

◆ texi_macros_file() [1/2]

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

inline

Definition at line 111 of file octave.h.

◆ texi_macros_file() [2/2]

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

inline

Definition at line 81 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ traditional() [1/2]

void octave::cmdline_options::traditional ( bool arg )

inline

Definition at line 101 of file octave.h.

◆ traditional() [2/2]

bool octave::cmdline_options::traditional ( void ) const

inline

Definition at line 71 of file octave.h.

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

◆ verbose_flag() [1/2]

void octave::cmdline_options::verbose_flag ( bool arg )

inline

Definition at line 102 of file octave.h.

◆ verbose_flag() [2/2]

bool octave::cmdline_options::verbose_flag ( void ) const

inline

Definition at line 72 of file octave.h.

Referenced by octave::interpreter::execute_startup_files().

Member Data Documentation

◆ m_all_args

string_vector octave::cmdline_options::m_all_args

private

Definition at line 219 of file octave.h.

Referenced by cmdline_options().

◆ m_code_to_eval

std::string octave::cmdline_options::m_code_to_eval

private

Definition at line 183 of file octave.h.

Referenced by cmdline_options().

◆ m_command_line_path

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

private

Definition at line 187 of file octave.h.

Referenced by cmdline_options().

◆ m_debug_jit

bool octave::cmdline_options::m_debug_jit = false

private

Definition at line 119 of file octave.h.

Referenced by cmdline_options().

◆ m_doc_cache_file

std::string octave::cmdline_options::m_doc_cache_file

private

Definition at line 196 of file octave.h.

Referenced by cmdline_options().

◆ m_docstrings_file

std::string octave::cmdline_options::m_docstrings_file

private

Definition at line 192 of file octave.h.

Referenced by cmdline_options().

◆ m_echo_commands

bool octave::cmdline_options::m_echo_commands = false

private

Definition at line 123 of file octave.h.

Referenced by cmdline_options().

◆ m_exec_path

std::string octave::cmdline_options::m_exec_path

private

Definition at line 200 of file octave.h.

Referenced by cmdline_options().

◆ m_forced_interactive

bool octave::cmdline_options::m_forced_interactive = false

private

Definition at line 131 of file octave.h.

Referenced by cmdline_options().

◆ m_forced_line_editing

bool octave::cmdline_options::m_forced_line_editing = false

private

Definition at line 135 of file octave.h.

Referenced by cmdline_options().

◆ m_gui

bool octave::cmdline_options::m_gui = false

private

Definition at line 127 of file octave.h.

Referenced by cmdline_options().

◆ m_image_path

std::string octave::cmdline_options::m_image_path

private

Definition at line 204 of file octave.h.

Referenced by cmdline_options().

◆ m_info_file

std::string octave::cmdline_options::m_info_file

private

Definition at line 208 of file octave.h.

Referenced by cmdline_options().

◆ m_info_program

std::string octave::cmdline_options::m_info_program

private

Definition at line 212 of file octave.h.

Referenced by cmdline_options().

◆ m_inhibit_startup_message

bool octave::cmdline_options::m_inhibit_startup_message = false

private

Definition at line 139 of file octave.h.

Referenced by cmdline_options().

◆ m_jit_compiler

bool octave::cmdline_options::m_jit_compiler = false

private

Definition at line 143 of file octave.h.

Referenced by cmdline_options().

◆ m_line_editing

bool octave::cmdline_options::m_line_editing = true

private

Definition at line 147 of file octave.h.

Referenced by cmdline_options().

◆ m_no_window_system

bool octave::cmdline_options::m_no_window_system = false

private

Definition at line 151 of file octave.h.

Referenced by cmdline_options().

◆ m_persist

bool octave::cmdline_options::m_persist = false

private

Definition at line 155 of file octave.h.

Referenced by cmdline_options().

◆ m_read_history_file

bool octave::cmdline_options::m_read_history_file = true

private

Definition at line 159 of file octave.h.

Referenced by cmdline_options().

◆ m_read_init_files

bool octave::cmdline_options::m_read_init_files = true

private

Definition at line 163 of file octave.h.

Referenced by cmdline_options().

◆ m_read_site_files

bool octave::cmdline_options::m_read_site_files = true

private

Definition at line 167 of file octave.h.

Referenced by cmdline_options().

◆ m_remaining_args

string_vector octave::cmdline_options::m_remaining_args

private

Definition at line 222 of file octave.h.

Referenced by cmdline_options().

◆ m_set_initial_path

bool octave::cmdline_options::m_set_initial_path = true

private

Definition at line 171 of file octave.h.

Referenced by cmdline_options().

◆ m_texi_macros_file

std::string octave::cmdline_options::m_texi_macros_file

private

Definition at line 216 of file octave.h.

Referenced by cmdline_options().

◆ m_traditional

bool octave::cmdline_options::m_traditional = false

private

Definition at line 175 of file octave.h.

Referenced by cmdline_options().

◆ m_verbose_flag

bool octave::cmdline_options::m_verbose_flag = false

private

Definition at line 179 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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ cmdline_options() [1/3]

◆ cmdline_options() [2/3]

◆ cmdline_options() [3/3]

Member Function Documentation

◆ all_args() [1/2]

◆ all_args() [2/2]

◆ code_to_eval() [1/2]

◆ code_to_eval() [2/2]

◆ command_line_path() [1/2]

◆ command_line_path() [2/2]

◆ debug_jit() [1/2]

◆ debug_jit() [2/2]

◆ doc_cache_file() [1/2]

◆ doc_cache_file() [2/2]

◆ docstrings_file() [1/2]

◆ docstrings_file() [2/2]

◆ echo_commands() [1/2]

◆ echo_commands() [2/2]

◆ exec_path() [1/2]

◆ exec_path() [2/2]

◆ forced_interactive() [1/2]

◆ forced_interactive() [2/2]

◆ forced_line_editing() [1/2]

◆ forced_line_editing() [2/2]

◆ gui() [1/2]

◆ gui() [2/2]

◆ image_path() [1/2]

◆ image_path() [2/2]

◆ info_file() [1/2]

◆ info_file() [2/2]

◆ info_program() [1/2]

◆ info_program() [2/2]

◆ inhibit_startup_message() [1/2]

◆ inhibit_startup_message() [2/2]

◆ jit_compiler() [1/2]

◆ jit_compiler() [2/2]

◆ line_editing() [1/2]

◆ line_editing() [2/2]

◆ no_window_system() [1/2]

◆ no_window_system() [2/2]

◆ operator=()

◆ persist() [1/2]

◆ persist() [2/2]

◆ read_history_file() [1/2]

◆ read_history_file() [2/2]

◆ read_init_files() [1/2]

◆ read_init_files() [2/2]

◆ read_site_files() [1/2]

◆ read_site_files() [2/2]

◆ remaining_args() [1/2]

◆ remaining_args() [2/2]

◆ set_initial_path() [1/2]

◆ set_initial_path() [2/2]

◆ sys_argc()

◆ sys_argv()

◆ texi_macros_file() [1/2]

◆ texi_macros_file() [2/2]

◆ traditional() [1/2]

◆ traditional() [2/2]

◆ verbose_flag() [1/2]

◆ verbose_flag() [2/2]

Member Data Documentation

◆ m_all_args

◆ m_code_to_eval

◆ m_command_line_path

◆ m_debug_jit

◆ m_doc_cache_file

◆ m_docstrings_file

◆ m_echo_commands

◆ m_exec_path

◆ m_forced_interactive

◆ m_forced_line_editing

◆ m_gui

◆ m_image_path

◆ m_info_file

◆ m_info_program