GNU Octave  6.2.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Member Functions | Private Member Functions | Private Attributes | List of all members
octave::load_path::package_info Class Reference
Collaboration diagram for octave::load_path::package_info:
Collaboration graph
[legend]

Public Member Functions

 package_info (const package_info &l)
 
 package_info (const std::string &package_name="")
 
 ~package_info (void)=default
 
void add (const dir_info &di, bool at_end, bool updating)
 
void clear (void)
 
void display (std::ostream &out) const
 
string_vector fcn_names (void) const
 
std::string find_fcn (const std::string &fcn, std::string &dir_name, int type=M_FILE|OCT_FILE|MEX_FILE) const
 
std::string find_method (const std::string &class_name, const std::string &meth, std::string &dir_name, int type=M_FILE|OCT_FILE|MEX_FILE) const
 
std::string find_private_fcn (const std::string &dir, const std::string &fcn, int type=M_FILE|OCT_FILE|MEX_FILE) const
 
std::list< std::string > methods (const std::string &class_name) const
 
void move (const dir_info &di, bool at_end)
 
package_info & operator= (const package_info &l)
 
void overloads (const std::string &meth, std::list< std::string > &l) const
 
void remove (const dir_info &di)
 

Private Member Functions

void add_to_fcn_map (const dir_info &di, bool at_end, bool updating)
 
void add_to_method_map (const dir_info &di, bool at_end)
 
void add_to_private_fcn_map (const dir_info &di)
 
bool check_file_type (std::string &fname, int type, int possible_types, const std::string &fcn, const char *who) const
 
void move_fcn_map (const std::string &dir, const string_vector &fcn_files, bool at_end)
 
void move_method_map (const std::string &dir, bool at_end)
 
void print_fcn_list (std::ostream &os, const dir_info::fcn_file_map_type &lst) const
 
void print_types (std::ostream &os, int types) const
 
void remove_fcn_map (const std::string &dir, const string_vector &fcn_files)
 
void remove_method_map (const std::string &dir)
 
void remove_private_fcn_map (const std::string &dir)
 

Private Attributes

std::list< std::string > dir_list
 
fcn_map_type fcn_map
 
std::string m_package_name
 
method_map_type method_map
 
private_fcn_map_type private_fcn_map
 

Detailed Description

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

Constructor & Destructor Documentation

◆ package_info() [1/2]

octave::load_path::package_info::package_info ( const std::string &  package_name = "")
inline

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

◆ package_info() [2/2]

octave::load_path::package_info::package_info ( const package_info &  l)
inline

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

◆ ~package_info()

octave::load_path::package_info::~package_info ( void  )
default

Member Function Documentation

◆ add()

void octave::load_path::package_info::add ( const dir_info &  di,
bool  at_end,
bool  updating 
)
inline

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

References octave::load_path::dir_info::dir_name.

Referenced by octave::load_path::add().

◆ add_to_fcn_map()

void octave::load_path::package_info::add_to_fcn_map ( const dir_info &  di,
bool  at_end,
bool  updating 
)
private

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

References octave::__get_symbol_table__(), octave::load_path::dir_info::abs_dir_name, octave::sys::file_ops::concat(), octave::load_path::file_info::dir_name, octave::load_path::dir_info::fcn_files, octave::fi, octave::in_path_list(), octave::symbol_table::is_built_in_function_name(), len, octave::load_path::M_FILE, octave::load_path::MEX_FILE, string_vector::numel(), octave::load_path::OCT_FILE, octave::load_path::sys_path, and warning_with_id().

◆ add_to_method_map()

void octave::load_path::package_info::add_to_method_map ( const dir_info &  di,
bool  at_end 
)
private

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

References octave::load_path::dir_info::abs_dir_name, octave::sys::file_ops::concat(), octave::fi, m, octave::load_path::dir_info::class_info::method_file_map, octave::load_path::dir_info::method_file_map, and octave::load_path::dir_info::class_info::private_file_map.

◆ add_to_private_fcn_map()

void octave::load_path::package_info::add_to_private_fcn_map ( const dir_info &  di)
private

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

References octave::load_path::dir_info::abs_dir_name, and octave::load_path::dir_info::private_file_map.

◆ check_file_type()

bool octave::load_path::package_info::check_file_type ( std::string &  fname,
int  type,
int  possible_types,
const std::string &  fcn,
const char *  who 
) const
private

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

References error(), octave::load_path::M_FILE, octave::load_path::MEX_FILE, octave::load_path::OCT_FILE, and retval.

◆ clear()

void octave::load_path::package_info::clear ( void  )
inline

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

Referenced by octave::load_path::clear(), and octave::load_path::update().

◆ display()

void octave::load_path::package_info::display ( std::ostream &  out) const

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

References octave::sys::file_ops::concat(), and octave::load_path::dir_list().

Referenced by octave::load_path::display().

◆ fcn_names()

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

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

References len, and retval.

Referenced by octave::load_path::fcn_names().

◆ find_fcn()

std::string octave::load_path::package_info::find_fcn ( const std::string &  fcn,
std::string &  dir_name,
int  type = M_FILE | OCT_FILE | MEX_FILE 
) const

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

References octave::sys::file_ops::concat(), octave::fi, Array< T >::find(), octave::load_path::find_method(), and retval.

◆ find_method()

std::string octave::load_path::package_info::find_method ( const std::string &  class_name,
const std::string &  meth,
std::string &  dir_name,
int  type = M_FILE | OCT_FILE | MEX_FILE 
) const

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

References octave::sys::file_ops::concat(), octave::fi, Array< T >::find(), m, and retval.

◆ find_private_fcn()

std::string octave::load_path::package_info::find_private_fcn ( const std::string &  dir,
const std::string &  fcn,
int  type = M_FILE | OCT_FILE | MEX_FILE 
) const

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

References octave::sys::file_ops::concat(), Array< T >::find(), and retval.

◆ methods()

std::list< std::string > octave::load_path::package_info::methods ( const std::string &  class_name) const

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

References Array< T >::find(), retval, and Array< T >::sort().

◆ move()

void octave::load_path::package_info::move ( const dir_info &  di,
bool  at_end 
)

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

References octave::load_path::dir_info::abs_dir_name, octave::load_path::dir_list(), octave::load_path::dir_info::fcn_files, and find().

Referenced by octave::load_path::move().

◆ move_fcn_map()

void octave::load_path::package_info::move_fcn_map ( const std::string &  dir,
const string_vector &  fcn_files,
bool  at_end 
)
private

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

References len, and string_vector::numel().

◆ move_method_map()

void octave::load_path::package_info::move_method_map ( const std::string &  dir,
bool  at_end 
)
private

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

References octave::sys::file_ops::concat().

◆ operator=()

package_info& octave::load_path::package_info::operator= ( const package_info &  l)
inline

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

References dir_list, fcn_map, m_package_name, method_map, and private_fcn_map.

◆ overloads()

void octave::load_path::package_info::overloads ( const std::string &  meth,
std::list< std::string > &  l 
) const

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

References m.

Referenced by octave::load_path::overloads().

◆ print_fcn_list()

void octave::load_path::package_info::print_fcn_list ( std::ostream &  os,
const dir_info::fcn_file_map_type &  lst 
) const
private

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

◆ print_types()

void octave::load_path::package_info::print_types ( std::ostream &  os,
int  types 
) const
private

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

References octave::load_path::M_FILE, octave::load_path::MEX_FILE, and octave::load_path::OCT_FILE.

◆ remove()

void octave::load_path::package_info::remove ( const dir_info &  di)

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

References octave::load_path::dir_info::abs_dir_name, octave::load_path::dir_list(), and octave::load_path::dir_info::fcn_files.

Referenced by octave::load_path::remove().

◆ remove_fcn_map()

void octave::load_path::package_info::remove_fcn_map ( const std::string &  dir,
const string_vector &  fcn_files 
)
private

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

References len, and string_vector::numel().

◆ remove_method_map()

void octave::load_path::package_info::remove_method_map ( const std::string &  dir)
private

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

References octave::sys::file_ops::concat().

◆ remove_private_fcn_map()

void octave::load_path::package_info::remove_private_fcn_map ( const std::string &  dir)
private

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

Member Data Documentation

◆ dir_list

std::list<std::string> octave::load_path::package_info::dir_list
private

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

Referenced by operator=().

◆ fcn_map

fcn_map_type octave::load_path::package_info::fcn_map
private

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

Referenced by operator=().

◆ m_package_name

std::string octave::load_path::package_info::m_package_name
private

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

Referenced by operator=().

◆ method_map

method_map_type octave::load_path::package_info::method_map
private

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

Referenced by operator=().

◆ private_fcn_map

private_fcn_map_type octave::load_path::package_info::private_fcn_map
private

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

Referenced by operator=().

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