#include "load-path.h"

Collaboration diagram for octave::load_path:

[legend]

Classes
class	dir_info

class	file_info

class	package_info

Public Types
typedef void(*	hook_fcn_ptr) (const std::string &dir)

Public Member Functions
	load_path (const load_path &)=delete

	load_path (interpreter &interp)

	~load_path (void)=default

void	append (const std::string &dir, bool warn=false)

void	clear (void)

bool	contains_canonical (const std::string &dir_name) const

bool	contains_file_in_dir (const std::string &file_name, const std::string &dir_name)

std::list< std::string >	dir_list (void) const

string_vector	dirs (void) const

void	display (std::ostream &os) const

void	execute_pkg_add (const std::string &dir)

void	execute_pkg_del (const std::string &dir)

string_vector	fcn_names (void) const

string_vector	files (const std::string &dir, bool omit_exts=false) const

string_vector	find_all_first_of (const string_vector &files) const

std::string	find_dir (const std::string &dir) const

std::string	find_fcn (const std::string &fcn, const std::string &pack_name="")

std::string	find_fcn (const std::string &fcn, std::string &dir_name, const std::string &pack_name="")

std::string	find_fcn_file (const std::string &fcn, const std::string &pack_name="")

std::string	find_file (const std::string &file) const

std::string	find_first_of (const string_vector &files) const

string_vector	find_matching_dirs (const std::string &dir) const

std::string	find_method (const std::string &class_name, const std::string &meth, const std::string &pack_name="")

std::string	find_method (const std::string &class_name, const std::string &meth, std::string &dir_name, const std::string &pack_name="")

std::string	find_mex_file (const std::string &fcn, const std::string &pack_name="")

std::string	find_oct_file (const std::string &fcn, const std::string &pack_name="")

bool	find_package (const std::string &package_name) const

std::string	find_private_fcn (const std::string &dir, const std::string &fcn, const std::string &pack_name="")

std::function< void(const std::string &)>	get_add_hook (void)

std::list< std::string >	get_all_package_names (bool only_top_level=true) const

std::string	get_command_line_path (void) const

std::function< void(const std::string &)>	get_remove_hook (void)

void	initialize (bool set_initial_path=false)

std::list< std::string >	methods (const std::string &class_name, const std::string &pack_name="")

load_path &	operator= (const load_path &)=delete

std::list< std::string >	overloads (const std::string &meth) const

std::string	path (void) const

void	prepend (const std::string &dir, bool warn=false)

bool	remove (const std::string &dir)

void	set (const std::string &p, bool warn=false, bool is_init=false)

void	set_add_hook (const std::function< void(const std::string &)> &f)

void	set_command_line_path (const std::string &p)

void	set_remove_hook (const std::function< void(const std::string &)> &f)

std::string	system_path (void) const

void	update (void) const

Static Public Attributes
static const int	M_FILE = 1

static const int	MEX_FILE = 4

static const int	OCT_FILE = 2

Private Types
typedef abs_dir_cache_type::iterator	abs_dir_cache_iterator

typedef std::map< std::string, dir_info >	abs_dir_cache_type

typedef abs_dir_cache_type::const_iterator	const_abs_dir_cache_iterator

typedef dir_info_list_type::const_iterator	const_dir_info_list_iterator

typedef fcn_map_type::const_iterator	const_fcn_map_iterator

typedef file_info_list_type::const_iterator	const_file_info_list_iterator

typedef method_map_type::const_iterator	const_method_map_iterator

typedef package_map_type::const_iterator	const_package_map_iterator

typedef private_fcn_map_type::const_iterator	const_private_fcn_map_iterator

typedef dir_info_list_type::iterator	dir_info_list_iterator

typedef std::list< dir_info >	dir_info_list_type

typedef fcn_map_type::iterator	fcn_map_iterator

typedef std::map< std::string, file_info_list_type >	fcn_map_type

typedef file_info_list_type::iterator	file_info_list_iterator

typedef std::list< file_info >	file_info_list_type

typedef method_map_type::iterator	method_map_iterator

typedef std::map< std::string, fcn_map_type >	method_map_type

typedef package_map_type::iterator	package_map_iterator

typedef std::map< std::string, package_info >	package_map_type

typedef private_fcn_map_type::iterator	private_fcn_map_iterator

typedef std::map< std::string, dir_info::fcn_file_map_type >	private_fcn_map_type

Private Member Functions
void	add (const dir_info &di, bool at_end, const std::string &pname="", bool updating=false) const

void	add (const std::string &dir, bool at_end, bool warn)

bool	contains (const std::string &dir) const

void	execute_pkg_add_or_del (const std::string &dir, const std::string &script_file)

dir_info_list_iterator	find_dir_info (const std::string &dir)

const_dir_info_list_iterator	find_dir_info (const std::string &dir) const

string_vector	get_file_list (const dir_info::fcn_file_map_type &lst) const

package_info &	get_package (const std::string &name) const

bool	is_package (const std::string &name) const

void	move (const dir_info &di, bool at_end, const std::string &pname="")

void	move (dir_info_list_iterator i, bool at_end)

void	remove (const dir_info &di, const std::string &pname="")

Private Attributes
std::function< void(const std::string &)>	add_hook

dir_info_list_type	dir_info_list

std::set< std::string >	init_dirs

std::string	m_command_line_path

interpreter &	m_interpreter

package_map_type	package_map

std::function< void(const std::string &)>	remove_hook

package_info	top_level_package

Static Private Attributes
static abs_dir_cache_type	abs_dir_cache

static std::string	sys_path

Friends
dir_info::fcn_file_map_type	get_fcn_files (const std::string &d)

Detailed Description

Definition at line 44 of file load-path.h.

Member Typedef Documentation

◆ abs_dir_cache_iterator

typedef abs_dir_cache_type::iterator octave::load_path::abs_dir_cache_iterator

private

Definition at line 363 of file load-path.h.

◆ abs_dir_cache_type

typedef std::map<std::string, dir_info> octave::load_path::abs_dir_cache_type

private

Definition at line 360 of file load-path.h.

◆ const_abs_dir_cache_iterator

typedef abs_dir_cache_type::const_iterator octave::load_path::const_abs_dir_cache_iterator

private

Definition at line 362 of file load-path.h.

◆ const_dir_info_list_iterator

typedef dir_info_list_type::const_iterator octave::load_path::const_dir_info_list_iterator

private

Definition at line 357 of file load-path.h.

◆ const_fcn_map_iterator

typedef fcn_map_type::const_iterator octave::load_path::const_fcn_map_iterator

private

Definition at line 373 of file load-path.h.

◆ const_file_info_list_iterator

typedef file_info_list_type::const_iterator octave::load_path::const_file_info_list_iterator

private

Definition at line 367 of file load-path.h.

◆ const_method_map_iterator

typedef method_map_type::const_iterator octave::load_path::const_method_map_iterator

private

Definition at line 386 of file load-path.h.

◆ const_package_map_iterator

typedef package_map_type::const_iterator octave::load_path::const_package_map_iterator

private

Definition at line 512 of file load-path.h.

◆ const_private_fcn_map_iterator

typedef private_fcn_map_type::const_iterator octave::load_path::const_private_fcn_map_iterator

private

Definition at line 380 of file load-path.h.

◆ dir_info_list_iterator

typedef dir_info_list_type::iterator octave::load_path::dir_info_list_iterator

private

Definition at line 358 of file load-path.h.

◆ dir_info_list_type

typedef std::list<dir_info> octave::load_path::dir_info_list_type

private

Definition at line 355 of file load-path.h.

◆ fcn_map_iterator

typedef fcn_map_type::iterator octave::load_path::fcn_map_iterator

private

Definition at line 374 of file load-path.h.

◆ fcn_map_type

typedef std::map<std::string, file_info_list_type> octave::load_path::fcn_map_type

private

Definition at line 371 of file load-path.h.

◆ file_info_list_iterator

typedef file_info_list_type::iterator octave::load_path::file_info_list_iterator

private

Definition at line 368 of file load-path.h.

◆ file_info_list_type

typedef std::list<file_info> octave::load_path::file_info_list_type

private

Definition at line 365 of file load-path.h.

◆ hook_fcn_ptr

typedef void(* octave::load_path::hook_fcn_ptr) (const std::string &dir)

Definition at line 52 of file load-path.h.

◆ method_map_iterator

typedef method_map_type::iterator octave::load_path::method_map_iterator

private

Definition at line 387 of file load-path.h.

◆ method_map_type

typedef std::map<std::string, fcn_map_type> octave::load_path::method_map_type

private

Definition at line 384 of file load-path.h.

◆ package_map_iterator

typedef package_map_type::iterator octave::load_path::package_map_iterator

private

Definition at line 513 of file load-path.h.

◆ package_map_type

typedef std::map<std::string, package_info> octave::load_path::package_map_type

private

Definition at line 510 of file load-path.h.

◆ private_fcn_map_iterator

typedef private_fcn_map_type::iterator octave::load_path::private_fcn_map_iterator

private

Definition at line 381 of file load-path.h.

◆ private_fcn_map_type

typedef std::map<std::string, dir_info::fcn_file_map_type> octave::load_path::private_fcn_map_type

private

Definition at line 378 of file load-path.h.

Constructor & Destructor Documentation

◆ load_path() [1/2]

octave::load_path::load_path ( interpreter & interp )

Definition at line 230 of file load-path.cc.

References execute_pkg_add().

◆ load_path() [2/2]

octave::load_path::load_path ( const load_path & )

delete

◆ ~load_path()

octave::load_path::~load_path ( void )

default

Member Function Documentation

◆ add() [1/2]

void octave::load_path::add	(	const dir_info &	di,
		bool	at_end,
		const std::string &	pname = `""`,
		bool	updating = `false`
	)		const

private

Definition at line 1152 of file load-path.cc.

References octave::load_path::package_info::add(), add(), get_package(), and octave::load_path::dir_info::package_dir_map.

◆ add() [2/2]

void octave::load_path::add	(	const std::string &	dir,
		bool	at_end,
		bool	warn
	)

private

Definition at line 1063 of file load-path.cc.

References add_hook, dir_info_list, octave::sys::base_file_stat::error(), find_dir_info(), octave::sys::base_file_stat::is_dir(), len, octave::maybe_canonicalize(), move(), octave::strip_trailing_separators(), octave::sys::file_ops::tilde_expand(), warning(), and warning_with_id().

Referenced by add(), append(), prepend(), and update().

◆ append()

void octave::load_path::append	(	const std::string &	dir,
		bool	warn = `false`
	)

Definition at line 340 of file load-path.cc.

References add().

Referenced by Faddpath(), and set().

◆ clear()

void octave::load_path::clear ( void )

Definition at line 276 of file load-path.cc.

References octave::load_path::package_info::clear(), dir_info_list, package_map, and top_level_package.

Referenced by set().

◆ contains()

bool octave::load_path::contains ( const std::string & dir ) const

private

Definition at line 1019 of file load-path.cc.

References dir_info_list, and find_dir_info().

◆ contains_canonical()

bool octave::load_path::contains_canonical ( const std::string & dir_name ) const

Definition at line 418 of file load-path.cc.

References d, dir_info_list, retval, and octave::same_file().

Referenced by contains_file_in_dir().

◆ contains_file_in_dir()

bool octave::load_path::contains_file_in_dir	(	const std::string &	file_name,
		const std::string &	dir_name
	)

Definition at line 435 of file load-path.cc.

References octave::sys::env::base_pathname(), octave::interpreter::chdir(), contains_canonical(), octave::event_manager::debug_cd_or_addpath_error(), find_file(), octave::sys::env::get_current_directory(), octave::interpreter::get_event_manager(), m_interpreter, prepend(), and octave::same_file().

Referenced by octave::file_editor_tab::add_breakpoint_event(), octave::file_editor_tab::handle_request_remove_breakpoint(), and octave::file_editor_tab::remove_all_breakpoints().

◆ dir_list()

std::list< std::string > octave::load_path::dir_list ( void ) const

Definition at line 847 of file load-path.cc.

References dir_info_list, and retval.

Referenced by octave::load_path::package_info::display(), octave::load_path::package_info::move(), octave::set_path_model::path_to_model(), and octave::load_path::package_info::remove().

◆ dirs()

string_vector octave::load_path::dirs ( void ) const

Definition at line 832 of file load-path.cc.

References dir_info_list, len, and retval.

Referenced by Fpath(), and path().

◆ display()

void octave::load_path::display ( std::ostream & os ) const

Definition at line 910 of file load-path.cc.

References dir_info_list, octave::load_path::package_info::display(), string_vector::empty(), get_file_list(), string_vector::list_in_columns(), octave::load_path::dir_info::class_info::method_file_map, package_map, and top_level_package.

Referenced by F__dump_load_path__().

◆ execute_pkg_add()

void octave::load_path::execute_pkg_add ( const std::string & dir )

Definition at line 949 of file load-path.cc.

References execute_pkg_add_or_del().

Referenced by load_path(), and octave::interpreter::execute_pkg_add().

◆ execute_pkg_add_or_del()

void octave::load_path::execute_pkg_add_or_del	(	const std::string &	dir,
		const std::string &	script_file
	)

private

Definition at line 960 of file load-path.cc.

References octave::sys::file_ops::concat(), octave::sys::base_file_stat::exists(), octave_interpreter_ready, and octave::source_file().

Referenced by execute_pkg_add(), and execute_pkg_del().

◆ execute_pkg_del()

void octave::load_path::execute_pkg_del ( const std::string & dir )

Definition at line 955 of file load-path.cc.

References execute_pkg_add_or_del().

◆ fcn_names()

string_vector octave::load_path::fcn_names ( void ) const

Definition at line 886 of file load-path.cc.

References octave::load_path::package_info::fcn_names(), and top_level_package.

Referenced by octave::file_editor_tab::update_lexer_settings().

◆ files()

string_vector octave::load_path::files	(	const std::string &	dir,
		bool	omit_exts = `false`
	)		const

Definition at line 858 of file load-path.cc.

References dir_info_list, find_dir_info(), len, Array< T >::numel(), and retval.

◆ find_all_first_of()

string_vector octave::load_path::find_all_first_of ( const string_vector & files ) const

Definition at line 764 of file load-path.cc.

References octave::sys::env::absolute_pathname(), octave::sys::file_ops::concat(), dir_info_list, octave::sys::file_ops::dir_sep_chars(), octave::sys::base_file_stat::exists(), len, string_vector::numel(), string_vector::resize(), and octave::sys::env::rooted_relative_pathname().

Referenced by Ffile_in_loadpath().

◆ find_dir()

std::string octave::load_path::find_dir ( const std::string & dir ) const

Definition at line 593 of file load-path.cc.

References octave::sys::env::absolute_pathname(), dir_info_list, octave::sys::file_ops::dir_sep_chars(), octave::sys::file_ops::dir_sep_str(), octave::sys::base_file_stat::exists(), octave::sys::base_file_stat::is_dir(), octave::sys::file_ops::is_dir_sep(), octave::maybe_canonicalize(), retval, and octave::sys::env::rooted_relative_pathname().

Referenced by octave::contents_file_in_path(), and Fdir_in_loadpath().

◆ find_dir_info() [1/2]

load_path::dir_info_list_iterator octave::load_path::find_dir_info ( const std::string & dir )

private

Definition at line 999 of file load-path.cc.

References dir_info_list, octave::maybe_canonicalize(), retval, and octave::sys::file_ops::tilde_expand().

◆ find_dir_info() [2/2]

load_path::const_dir_info_list_iterator octave::load_path::find_dir_info ( const std::string & dir ) const

private

Definition at line 979 of file load-path.cc.

References dir_info_list, octave::maybe_canonicalize(), retval, and octave::sys::file_ops::tilde_expand().

Referenced by add(), contains(), files(), and remove().

◆ find_fcn() [1/2]

std::string octave::load_path::find_fcn	(	const std::string &	fcn,
		const std::string &	pack_name = `""`
	)

inline

Definition at line 117 of file load-path.h.

◆ find_fcn() [2/2]

std::string octave::load_path::find_fcn	(	const std::string &	fcn,
		std::string &	dir_name,
		const std::string &	pack_name = `""`
	)

inline

Definition at line 111 of file load-path.h.

Referenced by octave::fcn_info::fcn_info_rep::find_user_function(), octave::out_of_date_check(), and symbol_exist().

◆ find_fcn_file()

std::string octave::load_path::find_fcn_file	(	const std::string &	fcn,
		const std::string &	pack_name = `""`
	)

inline

Definition at line 131 of file load-path.h.

Referenced by octave::fcn_file_in_path().

◆ find_file()

std::string octave::load_path::find_file ( const std::string & file ) const

Definition at line 538 of file load-path.cc.

References octave::sys::env::absolute_pathname(), octave::sys::file_ops::concat(), dir_info_list, octave::sys::file_ops::dir_sep_chars(), octave::sys::base_file_stat::exists(), octave::find_private_file(), len, string_vector::numel(), retval, and octave::sys::env::rooted_relative_pathname().

Referenced by contains_file_in_dir(), octave::file_in_path(), octave::find_data_file_in_load_path(), and octave::tree_evaluator::lookup_autoload().

◆ find_first_of()

std::string octave::load_path::find_first_of ( const string_vector & files ) const

Definition at line 687 of file load-path.cc.

References octave::sys::env::absolute_pathname(), octave::sys::file_ops::concat(), dir_info_list, octave::sys::file_ops::dir_sep_chars(), octave::sys::base_file_stat::exists(), len, string_vector::numel(), string_vector::resize(), retval, and octave::sys::env::rooted_relative_pathname().

Referenced by Ffile_in_loadpath().

◆ find_matching_dirs()

string_vector octave::load_path::find_matching_dirs ( const std::string & dir ) const

Definition at line 640 of file load-path.cc.

References octave::sys::env::absolute_pathname(), dir_info_list, octave::sys::file_ops::dir_sep_chars(), octave::sys::file_ops::dir_sep_str(), octave::sys::base_file_stat::exists(), octave::sys::base_file_stat::is_dir(), octave::sys::file_ops::is_dir_sep(), octave::maybe_canonicalize(), and octave::sys::env::rooted_relative_pathname().

Referenced by Fdir_in_loadpath().

◆ find_method() [1/2]

std::string octave::load_path::find_method	(	const std::string &	class_name,
		const std::string &	meth,
		const std::string &	pack_name = `""`
	)

inline

Definition at line 87 of file load-path.h.

◆ find_method() [2/2]

std::string octave::load_path::find_method	(	const std::string &	class_name,
		const std::string &	meth,
		std::string &	dir_name,
		const std::string &	pack_name = `""`
	)

inline

Definition at line 79 of file load-path.h.

Referenced by octave::cdef_method::cdef_method_rep::check_method(), octave::load_path::package_info::find_fcn(), octave_class::load_ascii(), octave_class::load_binary(), octave::fcn_info::fcn_info_rep::load_class_constructor(), octave::fcn_info::fcn_info_rep::load_class_method(), octave_class::load_hdf5(), octave::out_of_date_check(), read_mat5_binary_element(), octave_class::save_ascii(), octave_class::save_binary(), octave_class::save_hdf5(), save_mat5_binary_element(), and symbol_exist().

◆ find_mex_file()

std::string octave::load_path::find_mex_file	(	const std::string &	fcn,
		const std::string &	pack_name = `""`
	)

inline

Definition at line 145 of file load-path.h.

◆ find_oct_file()

std::string octave::load_path::find_oct_file	(	const std::string &	fcn,
		const std::string &	pack_name = `""`
	)

inline

Definition at line 138 of file load-path.h.

◆ find_package()

bool octave::load_path::find_package ( const std::string & package_name ) const

inline

Definition at line 103 of file load-path.h.

Referenced by octave::cdef_manager::find_package().

◆ find_private_fcn()

std::string octave::load_path::find_private_fcn	(	const std::string &	dir,
		const std::string &	fcn,
		const std::string &	pack_name = `""`
	)

inline

Definition at line 124 of file load-path.h.

Referenced by octave::fcn_info::fcn_info_rep::load_private_function().

◆ get_add_hook()

std::function<void (const std::string&)> octave::load_path::get_add_hook ( void )

inline

Definition at line 174 of file load-path.h.

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

◆ get_all_package_names()

std::list< std::string > octave::load_path::get_all_package_names ( bool only_top_level = true ) const

Definition at line 524 of file load-path.cc.

References package_map, and retval.

Referenced by octave::package_getAllPackages().

◆ get_command_line_path()

std::string octave::load_path::get_command_line_path ( void ) const

inline

Definition at line 205 of file load-path.h.

Referenced by Fcommand_line_path().

◆ get_file_list()

string_vector octave::load_path::get_file_list ( const dir_info::fcn_file_map_type & lst ) const

private

Definition at line 1173 of file load-path.cc.

References MEX_FILE, n, OCT_FILE, and retval.

Referenced by display(), and octave::load_path::dir_info::initialize().

◆ get_package()

package_info& octave::load_path::get_package ( const std::string & name ) const

inlineprivate

Definition at line 556 of file load-path.h.

References name.

Referenced by add(), move(), and remove().

◆ get_remove_hook()

std::function<void (const std::string&)> octave::load_path::get_remove_hook ( void )

inline

Definition at line 179 of file load-path.h.

◆ initialize()

void octave::load_path::initialize ( bool set_initial_path = false )

Definition at line 238 of file load-path.cc.

References octave::config::fcn_file_dir(), octave::sys::env::getenv(), octave::config::local_api_fcn_file_dir(), octave::config::local_api_oct_file_dir(), octave::config::local_fcn_file_dir(), octave::config::local_oct_file_dir(), octave::config::local_ver_fcn_file_dir(), octave::config::local_ver_oct_file_dir(), m_command_line_path, octave::maybe_add_path_elts(), octave::config::oct_data_dir(), octave::config::oct_file_dir(), octave::directory_path::path_sep_str(), set(), and sys_path.

Referenced by Frestoredefaultpath(), and octave::interpreter::initialize_load_path().

◆ is_package()

bool octave::load_path::is_package ( const std::string & name ) const

private

Definition at line 1140 of file load-path.cc.

References dir_info_list, and name.

◆ methods()

std::list<std::string> octave::load_path::methods	(	const std::string &	class_name,
		const std::string &	pack_name = `""`
	)

inline

Definition at line 95 of file load-path.h.

Referenced by F__methods__(), and octave::cdef_class::make_meta_class().

◆ move() [1/2]

void octave::load_path::move	(	const dir_info &	di,
		bool	at_end,
		const std::string &	pname = `""`
	)

private

Definition at line 1043 of file load-path.cc.

References get_package(), octave::load_path::package_info::move(), move(), and octave::load_path::dir_info::package_dir_map.

◆ move() [2/2]

void octave::load_path::move	(	dir_info_list_iterator	i,
		bool	at_end
	)

private

Definition at line 1025 of file load-path.cc.

References dir_info_list.

Referenced by add(), and move().

◆ operator=()

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

delete

◆ overloads()

std::list< std::string > octave::load_path::overloads ( const std::string & meth ) const

Definition at line 509 of file load-path.cc.

References octave::load_path::package_info::overloads(), package_map, retval, and top_level_package.

◆ path()

std::string octave::load_path::path ( void ) const

Definition at line 892 of file load-path.cc.

References dirs(), len, string_vector::numel(), and octave::directory_path::path_sep_str().

Referenced by Faddpath(), Fpath(), and Frmpath().

◆ prepend()

void octave::load_path::prepend	(	const std::string &	dir,
		bool	warn = `false`
	)

Definition at line 347 of file load-path.cc.

References add().

Referenced by contains_file_in_dir(), Faddpath(), and set().

◆ remove() [1/2]

void octave::load_path::remove	(	const dir_info &	di,
		const std::string &	pname = `""`
	)

private

Definition at line 1120 of file load-path.cc.

References get_package(), octave::load_path::dir_info::package_dir_map, octave::load_path::package_info::remove(), and remove().

◆ remove() [2/2]

bool octave::load_path::remove ( const std::string & dir )

Definition at line 354 of file load-path.cc.

References dir_info_list, find_dir_info(), remove_hook, retval, octave::strip_trailing_separators(), octave::sys::file_ops::tilde_expand(), and warning().

Referenced by Frmpath(), and remove().

◆ set()

void octave::load_path::set	(	const std::string &	p,
		bool	warn = `false`,
		bool	is_init = `false`
	)

Definition at line 286 of file load-path.cc.

References add_hook, append(), clear(), dir_info_list, init_dirs, octave::maybe_canonicalize(), prepend(), octave::action_container::protect_var(), octave::unwind_protect::run_first(), octave::split_path(), and warning_with_id().

Referenced by Fpath(), initialize(), and octave::set_path_model::model_to_path().

◆ set_add_hook()

void octave::load_path::set_add_hook ( const std::function< void(const std::string &)> & f )

inline

Definition at line 184 of file load-path.h.

References octave::f().

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

◆ set_command_line_path()

void octave::load_path::set_command_line_path ( const std::string & p )

inline

Definition at line 197 of file load-path.h.

References octave::directory_path::path_sep_str().

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

◆ set_remove_hook()

void octave::load_path::set_remove_hook ( const std::function< void(const std::string &)> & f )

inline

Definition at line 189 of file load-path.h.

References octave::f().

◆ system_path()

std::string octave::load_path::system_path ( void ) const

inline

Definition at line 210 of file load-path.h.

Referenced by F__pathorig__(), Frestoredefaultpath(), and read_mat5_binary_element().

◆ update()

void octave::load_path::update ( void ) const

Definition at line 395 of file load-path.cc.

References add(), octave::load_path::package_info::clear(), dir_info_list, package_map, top_level_package, and warning().

Referenced by octave::fcn_info::fcn_info_rep::builtin_find(), octave::interpreter::chdir(), octave::fcn_info::fcn_info_rep::find(), and octave::rehash_internal().

Friends And Related Function Documentation

◆ get_fcn_files

dir_info::fcn_file_map_type get_fcn_files ( const std::string & d )

friend

Definition at line 1201 of file load-path.cc.

Referenced by octave::load_path::dir_info::get_method_file_map(), and octave::load_path::dir_info::get_private_file_map().

Member Data Documentation

◆ abs_dir_cache

load_path::abs_dir_cache_type octave::load_path::abs_dir_cache

staticprivate

Definition at line 529 of file load-path.h.

Referenced by octave::load_path::dir_info::initialize(), and octave::load_path::dir_info::update().

◆ add_hook

std::function<void (const std::string&)> octave::load_path::add_hook

private

Definition at line 531 of file load-path.h.

Referenced by add(), and set().

◆ dir_info_list

dir_info_list_type octave::load_path::dir_info_list

mutableprivate

Definition at line 521 of file load-path.h.

Referenced by add(), clear(), contains(), contains_canonical(), dir_list(), dirs(), display(), files(), find_all_first_of(), find_dir(), find_dir_info(), find_file(), find_first_of(), find_matching_dirs(), is_package(), move(), remove(), set(), and update().

◆ init_dirs

std::set<std::string> octave::load_path::init_dirs

mutableprivate

Definition at line 523 of file load-path.h.

Referenced by set().

◆ m_command_line_path

std::string octave::load_path::m_command_line_path

private

Definition at line 525 of file load-path.h.

Referenced by initialize().

◆ M_FILE

const int octave::load_path::M_FILE = 1

static

Definition at line 212 of file load-path.h.

Referenced by octave::load_path::package_info::add_to_fcn_map(), octave::load_path::package_info::check_file_type(), and octave::load_path::package_info::print_types().

◆ m_interpreter

interpreter& octave::load_path::m_interpreter

private

Definition at line 515 of file load-path.h.

Referenced by contains_file_in_dir().

◆ MEX_FILE

const int octave::load_path::MEX_FILE = 4

static

Definition at line 214 of file load-path.h.

Referenced by octave::load_path::package_info::add_to_fcn_map(), octave::load_path::package_info::check_file_type(), get_file_list(), and octave::load_path::package_info::print_types().

◆ OCT_FILE

const int octave::load_path::OCT_FILE = 2

static

Definition at line 213 of file load-path.h.

Referenced by octave::load_path::package_info::add_to_fcn_map(), octave::load_path::package_info::check_file_type(), get_file_list(), and octave::load_path::package_info::print_types().

◆ package_map

package_map_type octave::load_path::package_map

mutableprivate

Definition at line 517 of file load-path.h.

Referenced by clear(), display(), get_all_package_names(), overloads(), and update().

◆ remove_hook

std::function<void (const std::string&)> octave::load_path::remove_hook

private

Definition at line 533 of file load-path.h.

Referenced by remove().

◆ sys_path

std::string octave::load_path::sys_path

staticprivate

Definition at line 527 of file load-path.h.

Referenced by octave::load_path::package_info::add_to_fcn_map(), and initialize().

◆ top_level_package

package_info octave::load_path::top_level_package

mutableprivate

Definition at line 519 of file load-path.h.

Referenced by clear(), display(), fcn_names(), overloads(), and update().

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

libinterp/corefcn/load-path.h
libinterp/corefcn/load-path.cc

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ abs_dir_cache_iterator

◆ abs_dir_cache_type

◆ const_abs_dir_cache_iterator

◆ const_dir_info_list_iterator

◆ const_fcn_map_iterator

◆ const_file_info_list_iterator

◆ const_method_map_iterator

◆ const_package_map_iterator

◆ const_private_fcn_map_iterator

◆ dir_info_list_iterator

◆ dir_info_list_type

◆ fcn_map_iterator

◆ fcn_map_type

◆ file_info_list_iterator

◆ file_info_list_type

◆ hook_fcn_ptr

◆ method_map_iterator

◆ method_map_type

◆ package_map_iterator

◆ package_map_type

◆ private_fcn_map_iterator

◆ private_fcn_map_type

Constructor & Destructor Documentation

◆ load_path() [1/2]

◆ load_path() [2/2]

◆ ~load_path()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ append()

◆ clear()

◆ contains()

◆ contains_canonical()

◆ contains_file_in_dir()

◆ dir_list()

◆ dirs()

◆ display()

◆ execute_pkg_add()

◆ execute_pkg_add_or_del()

◆ execute_pkg_del()

◆ fcn_names()

◆ files()

◆ find_all_first_of()

◆ find_dir()

◆ find_dir_info() [1/2]

◆ find_dir_info() [2/2]

◆ find_fcn() [1/2]

◆ find_fcn() [2/2]

◆ find_fcn_file()

◆ find_file()

◆ find_first_of()

◆ find_matching_dirs()

◆ find_method() [1/2]

◆ find_method() [2/2]

◆ find_mex_file()

◆ find_oct_file()

◆ find_package()

◆ find_private_fcn()

◆ get_add_hook()

◆ get_all_package_names()

◆ get_command_line_path()

◆ get_file_list()

◆ get_package()

◆ get_remove_hook()

◆ initialize()

◆ is_package()

◆ methods()

◆ move() [1/2]

◆ move() [2/2]