octave_env Class Reference

#include "oct-env.h"

Collaboration diagram for octave_env:

Static Public Member Functions
static bool	absolute_pathname (const std::string &s)
static std::string	base_pathname (const std::string &s)
static bool	chdir (const std::string &newdir)
static std::string	get_current_directory (void)
static std::string	get_home_directory (void)
static std::string	get_host_name (void)
static std::string	get_program_invocation_name (void)
static std::string	get_program_name (void)
static std::string	get_temp_directory (void)
static std::string	get_user_name (void)
static std::string	getenv (const std::string &name)
static bool	have_x11_display (void)
static std::string	make_absolute (const std::string &s, const std::string &dot_path=get_current_directory())
static std::string	polite_directory_format (const std::string &name)
static void	putenv (const std::string &name, const std::string &value)
static bool	rooted_relative_pathname (const std::string &s)
static void	set_program_name (const std::string &s)

Protected Member Functions
	octave_env (void)

Private Member Functions
	octave_env (const octave_env &)
bool	do_absolute_pathname (const std::string &s) const
std::string	do_base_pathname (const std::string &s) const
bool	do_chdir (const std::string &newdir)
std::string	do_get_home_directory (void) const
std::string	do_get_host_name (void) const
std::string	do_get_temp_directory (void) const
std::string	do_get_user_name (void) const
std::string	do_getcwd (void) const
std::string	do_getenv (const std::string &name) const
std::string	do_make_absolute (const std::string &s, const std::string &dot_path) const
std::string	do_polite_directory_format (const std::string &name) const
void	do_putenv (const std::string &name, const std::string &value) const
bool	do_rooted_relative_pathname (const std::string &s) const
void	do_set_program_name (const std::string &s) const
void	error (int) const
void	error (const std::string &) const
octave_env &	operator= (const octave_env &)
void	pathname_backup (std::string &path, int n) const

Static Private Member Functions
static void	cleanup_instance (void)
static bool	instance_ok (void)

Private Attributes
std::string	current_directory
bool	follow_symbolic_links
std::string	host_name
std::string	prog_invocation_name
std::string	prog_name
std::string	user_name
bool	verbatim_pwd

Static Private Attributes
static octave_env *	instance = 0

Detailed Description

Definition at line 28 of file oct-env.h.

Constructor & Destructor Documentation

octave_env::octave_env ( void  )

protected

Definition at line 63 of file oct-env.cc.

References do_get_host_name(), do_get_user_name(), and do_getcwd().

Referenced by instance_ok().

octave_env::octave_env ( const octave_env &  )

private

Member Function Documentation

bool octave_env::absolute_pathname ( const std::string &  s )

static

Definition at line 111 of file oct-env.cc.

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

Referenced by load_path::do_find_all_first_of(), load_path::do_find_dir(), load_path::do_find_file(), load_path::do_find_first_of(), load_path::do_find_matching_dirs(), Fautoload(), fcn_file_in_path(), find_data_file_in_load_path(), Fis_absolute_filename(), load_path::dir_info::initialize(), load_fcn_from_file(), mex_file_in_path(), oct_file_in_path(), and out_of_date_check().

std::string octave_env::base_pathname ( const std::string &  s )

static

Definition at line 125 of file oct-env.cc.

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

Referenced by command_editor::do_decode_prompt_string(), F__parse_file__(), octave_qt_link::file_in_path(), get_help_from_file(), and load_fcn_from_file().

bool octave_env::chdir ( const std::string &  newdir )

static

Definition at line 259 of file oct-env.cc.

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

Referenced by octave_change_to_directory().

static void octave_env::cleanup_instance ( void  )

inlinestaticprivate

Definition at line 123 of file oct-env.h.

Referenced by instance_ok().

bool octave_env::do_absolute_pathname ( const std::string &  s ) const

private

Definition at line 307 of file oct-env.cc.

References file_ops::is_dir_sep().

Referenced by absolute_pathname(), do_base_pathname(), and do_make_absolute().

std::string octave_env::do_base_pathname ( const std::string &  s ) const

private

Definition at line 355 of file oct-env.cc.

References file_ops::dir_sep_chars(), do_absolute_pathname(), and do_rooted_relative_pathname().

Referenced by base_pathname().

bool octave_env::do_chdir ( const std::string &  newdir )

private

Definition at line 521 of file oct-env.cc.

References current_directory, do_getcwd(), do_make_absolute(), follow_symbolic_links, file_ops::is_dir_sep(), and octave_chdir().

Referenced by chdir().

std::string octave_env::do_get_home_directory ( void  ) const

private

Definition at line 455 of file oct-env.cc.

References octave_passwd::dir(), file_ops::dir_sep_str(), do_getenv(), octave_passwd::getpwuid(), and octave_syscalls::getuid().

Referenced by do_polite_directory_format(), and get_home_directory().

std::string octave_env::do_get_host_name ( void  ) const

private

Definition at line 495 of file oct-env.cc.

References host_name.

Referenced by get_host_name(), and octave_env().

std::string octave_env::do_get_temp_directory ( void  ) const

private

Definition at line 195 of file oct-env.cc.

References do_getenv().

Referenced by get_temp_directory().

std::string octave_env::do_get_user_name ( void  ) const

private

Definition at line 482 of file oct-env.cc.

References octave_passwd::getpwuid(), octave_syscalls::getuid(), octave_passwd::name(), and user_name.

Referenced by get_user_name(), and octave_env().

std::string octave_env::do_getcwd ( void  ) const

private

Definition at line 440 of file oct-env.cc.

References current_directory, follow_symbolic_links, octave_getcwd(), and verbatim_pwd.

Referenced by do_chdir(), do_make_absolute(), get_current_directory(), and octave_env().

std::string octave_env::do_getenv ( const std::string &  name ) const

private

Definition at line 510 of file oct-env.cc.

References getenv().

Referenced by do_get_home_directory(), do_get_temp_directory(), and getenv().

std::string octave_env::do_make_absolute ( const std::string &  s, const std::string &  dot_path  ) const

private

Definition at line 372 of file oct-env.cc.

References file_ops::dir_sep_chars(), file_ops::dir_sep_str(), do_absolute_pathname(), do_getcwd(), file_ops::is_dir_sep(), and pathname_backup().

Referenced by do_chdir(), and make_absolute().

std::string octave_env::do_polite_directory_format ( const std::string &  name ) const

private

Definition at line 286 of file oct-env.cc.

References do_get_home_directory(), and file_ops::is_dir_sep().

Referenced by polite_directory_format().

void octave_env::do_putenv ( const std::string &  name, const std::string &  value  ) const

private

bool octave_env::do_rooted_relative_pathname ( const std::string &  s ) const

private

Definition at line 328 of file oct-env.cc.

References file_ops::is_dir_sep().

Referenced by do_base_pathname(), and rooted_relative_pathname().

void octave_env::do_set_program_name ( const std::string &  s ) const

private

Definition at line 266 of file oct-env.cc.

References file_ops::dir_sep_chars(), prog_invocation_name, prog_name, and set_program_name().

Referenced by set_program_name().

void octave_env::error ( int  err_num ) const

private

Definition at line 584 of file oct-env.cc.

void octave_env::error ( const std::string &  s ) const

private

Definition at line 590 of file oct-env.cc.

std::string octave_env::get_current_directory ( void  )

static

Definition at line 139 of file oct-env.cc.

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

Referenced by command_editor::do_decode_prompt_string(), Fcd(), octave_qt_link::file_in_path(), Fpwd(), and octave_change_to_directory().

std::string octave_env::get_home_directory ( void  )

static

Definition at line 146 of file oct-env.cc.

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

Referenced by default_history_file(), command_editor::do_decode_prompt_string(), execute_startup_files(), Fcd(), Fget_home_directory(), kpse_tilde_expand(), files_dock_widget::popdownmenu_home(), and tilde_expand_word().

std::string octave_env::get_host_name ( void  )

static

Definition at line 188 of file oct-env.cc.

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

Referenced by default_history_timestamp_format(), default_save_header_format(), command_editor::do_decode_prompt_string(), and Fgethostname().

std::string octave_env::get_program_invocation_name ( void  )

static

Definition at line 167 of file oct-env.cc.

References instance, instance_ok(), and prog_invocation_name.

Referenced by maybe_initialize_magick(), and octave_initialize_interpreter().

std::string octave_env::get_program_name ( void  )

static

Definition at line 160 of file oct-env.cc.

References instance, instance_ok(), and prog_name.

Referenced by command_editor::do_decode_prompt_string(), and octave_initialize_interpreter().

std::string octave_env::get_temp_directory ( void  )

static

Definition at line 153 of file oct-env.cc.

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

Referenced by octave_tempnam().

std::string octave_env::get_user_name ( void  )

static

Definition at line 181 of file oct-env.cc.

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

Referenced by default_history_timestamp_format(), default_save_header_format(), and command_editor::do_decode_prompt_string().

std::string octave_env::getenv ( const std::string &  name )

static

Definition at line 238 of file oct-env.cc.

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

Referenced by default_history_file(), default_history_size(), default_pager(), default_qt_settings_file(), do_getenv(), load_path::do_initialize(), execute_startup_files(), expand(), Fgetenv(), resource_manager::get_gui_translation_dir(), get_P_tmpdir(), have_gnuplot_binary(), have_x11_display(), dir_path::init(), initialize_history(), kpse_expand_kpse_dot(), kpse_var_value(), octave_start_gui(), set_built_in_docstrings_file(), set_default_doc_cache_file(), set_default_editor(), set_default_info_file(), set_default_info_prog(), set_default_texi_macros_file(), set_exec_path(), set_image_path(), set_local_site_defaults_file(), set_octave_home(), and set_site_defaults_file().

bool octave_env::have_x11_display ( void  )

static

Definition at line 251 of file oct-env.cc.

References getenv().

bool octave_env::instance_ok ( void  )

staticprivate

Definition at line 80 of file oct-env.cc.

References singleton_cleanup_list::add(), cleanup_instance(), instance, and octave_env().

Referenced by absolute_pathname(), base_pathname(), chdir(), get_current_directory(), get_home_directory(), get_host_name(), get_program_invocation_name(), get_program_name(), get_temp_directory(), get_user_name(), getenv(), make_absolute(), polite_directory_format(), rooted_relative_pathname(), and set_program_name().

std::string octave_env::make_absolute ( const std::string &  s, const std::string &  dot_path = get_current_directory ()  )

static

Definition at line 132 of file oct-env.cc.

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

Referenced by contents_file_in_path(), load_path::do_find_dir(), load_path::do_find_matching_dirs(), do_which(), execute_startup_files(), F__parse_file__(), Fautoload(), Ffile_in_loadpath(), file_in_path(), find_data_file_in_load_path(), Fmake_absolute_filename(), Furlwrite(), load_path::dir_info::initialize(), load_fcn_from_file(), make_absolute(), read_mat5_binary_element(), search_path_for_all_files(), search_path_for_file(), octave_fcn_handle::set_fcn(), source_file(), and load_path::dir_info::update().

octave_env& octave_env::operator= ( const octave_env &  )

private

void octave_env::pathname_backup ( std::string &  path, int  n  ) const

private

Definition at line 562 of file oct-env.cc.

References file_ops::is_dir_sep().

Referenced by do_make_absolute().

std::string octave_env::polite_directory_format ( const std::string &  name )

static

Definition at line 104 of file oct-env.cc.

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

Referenced by command_editor::do_decode_prompt_string().

void octave_env::putenv ( const std::string &  name, const std::string &  value  )

static

Definition at line 245 of file oct-env.cc.

References octave_putenv().

Referenced by Fsetenv(), octave_initialize_interpreter(), octave_start_gui(), and set_exec_path().

bool octave_env::rooted_relative_pathname ( const std::string &  s )

static

Definition at line 118 of file oct-env.cc.

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

Referenced by load_path::do_find_all_first_of(), load_path::do_find_dir(), load_path::do_find_file(), load_path::do_find_first_of(), load_path::do_find_matching_dirs(), find_data_file_in_load_path(), and Fis_rooted_relative_filename().

void octave_env::set_program_name ( const std::string &  s )

static

Definition at line 174 of file oct-env.cc.

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

Referenced by do_set_program_name(), and octave_initialize_interpreter().

Member Data Documentation

std::string octave_env::current_directory

mutableprivate

Definition at line 134 of file oct-env.h.

Referenced by do_chdir(), and do_getcwd().

bool octave_env::follow_symbolic_links

private

Definition at line 127 of file oct-env.h.

Referenced by do_chdir(), and do_getcwd().

std::string octave_env::host_name

mutableprivate

Definition at line 143 of file oct-env.h.

Referenced by do_get_host_name().

octave_env * octave_env::instance = 0

staticprivate

Definition at line 120 of file oct-env.h.

Referenced by absolute_pathname(), base_pathname(), chdir(), get_current_directory(), get_home_directory(), get_host_name(), get_program_invocation_name(), get_program_name(), get_temp_directory(), get_user_name(), getenv(), instance_ok(), make_absolute(), polite_directory_format(), rooted_relative_pathname(), and set_program_name().

std::string octave_env::prog_invocation_name

mutableprivate

Definition at line 139 of file oct-env.h.

Referenced by do_set_program_name(), and get_program_invocation_name().

std::string octave_env::prog_name

mutableprivate

Definition at line 137 of file oct-env.h.

Referenced by do_set_program_name(), and get_program_name().

std::string octave_env::user_name

mutableprivate

Definition at line 141 of file oct-env.h.

Referenced by do_get_user_name().

bool octave_env::verbatim_pwd

private

Definition at line 131 of file oct-env.h.

Referenced by do_getcwd().

---

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

• liboctave/system/oct-env.h
• liboctave/system/oct-env.cc