GNU Octave  6.2.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
octave::sys::file_stat Class Reference

#include "file-stat.h"

Inheritance diagram for octave::sys::file_stat:
Inheritance graph
[legend]
Collaboration diagram for octave::sys::file_stat:
Collaboration graph
[legend]

Public Member Functions

 file_stat (const file_stat &fs)
 
 file_stat (const std::string &n="", bool fl=true)
 
 ~file_stat (void)
 
sys::time atime (void) const
 
long blksize (void) const
 
long blocks (void) const
 
sys::time ctime (void) const
 
dev_t dev (void) const
 
std::string error (void) const
 
bool exists (void) const
 
void get_stats (bool force=false)
 
void get_stats (const std::string &n, bool force=false)
 
gid_t gid (void) const
 
ino_t ino (void) const
 
bool is_blk (void) const
 
bool is_chr (void) const
 
bool is_dir (void) const
 
bool is_fifo (void) const
 
bool is_lnk (void) const
 
bool is_newer (const sys::time &time) const
 
bool is_reg (void) const
 
bool is_sock (void) const
 
mode_t mode (void) const
 
std::string mode_as_string (void) const
 
sys::time mtime (void) const
 
nlink_t nlink (void) const
 
bool ok (void) const
 
 operator bool () const
 
file_stat & operator= (const file_stat &fs)
 
dev_t rdev (void) const
 
off_t size (void) const
 
sys::time time_resolution (void) const
 
uid_t uid (void) const
 

Static Public Member Functions

static bool have_struct_stat_st_blksize (void)
 
static bool have_struct_stat_st_blocks (void)
 
static bool have_struct_stat_st_rdev (void)
 
static bool is_blk (mode_t mode)
 
static bool is_chr (mode_t mode)
 
static bool is_dir (mode_t mode)
 
static bool is_fifo (mode_t mode)
 
static bool is_lnk (mode_t mode)
 
static int is_newer (const std::string &, const sys::time &)
 
static bool is_reg (mode_t mode)
 
static bool is_sock (mode_t mode)
 

Protected Attributes

std::string errmsg
 
bool fail
 
bool initialized
 
sys::time m_atime
 
long m_blksize
 
long m_blocks
 
sys::time m_ctime
 
dev_t m_dev
 
gid_t m_gid
 
ino_t m_ino
 
mode_t m_mode
 
sys::time m_mtime
 
nlink_t m_nlink
 
dev_t m_rdev
 
off_t m_size
 
uid_t m_uid
 

Private Member Functions

void update_internal (bool force=false)
 

Private Attributes

std::string file_name
 
bool follow_links
 

Detailed Description

Definition at line 211 of file file-stat.h.

Constructor & Destructor Documentation

◆ file_stat() [1/2]

octave::sys::file_stat::file_stat ( const std::string &  n = "",
bool  fl = true 
)

Definition at line 178 of file file-stat.cc.

References file_name, and update_internal().

◆ file_stat() [2/2]

octave::sys::file_stat::file_stat ( const file_stat &  fs)
inline

Definition at line 221 of file file-stat.h.

◆ ~file_stat()

octave::sys::file_stat::~file_stat ( void  )

Definition at line 185 of file file-stat.cc.

Member Function Documentation

◆ atime()

sys::time octave::sys::base_file_stat::atime ( void  ) const
inlineinherited

Definition at line 130 of file file-stat.h.

Referenced by mk_stat_map().

◆ blksize()

long octave::sys::base_file_stat::blksize ( void  ) const
inlineinherited

Definition at line 136 of file file-stat.h.

Referenced by mk_stat_map().

◆ blocks()

long octave::sys::base_file_stat::blocks ( void  ) const
inlineinherited

Definition at line 137 of file file-stat.h.

Referenced by mk_stat_map().

◆ ctime()

sys::time octave::sys::base_file_stat::ctime ( void  ) const
inlineinherited

Definition at line 132 of file file-stat.h.

Referenced by mk_stat_map().

◆ dev()

dev_t octave::sys::base_file_stat::dev ( void  ) const
inlineinherited

Definition at line 121 of file file-stat.h.

Referenced by mk_stat_map(), and octave::same_file_internal().

◆ error()

std::string octave::sys::base_file_stat::error ( void  ) const
inlineinherited

Definition at line 149 of file file-stat.h.

Referenced by octave::load_path::add(), F__magick_finfo__(), octave::load_path::dir_info::initialize(), mk_stat_result(), octave::sys::recursive_rmdir(), and octave::load_path::dir_info::update().

◆ exists()

bool octave::sys::base_file_stat::exists ( void  ) const
inlineinherited

Definition at line 147 of file file-stat.h.

Referenced by octave::tree_evaluator::check_autoload_file(), octave::contents_file_in_path(), octave::load_path::execute_pkg_add_or_del(), F__ftp_mput__(), Faudioinfo(), octave::fcn_file_in_path(), octave::load_path::find_all_first_of(), octave::find_data_file_in_load_path(), octave::load_path::find_dir(), octave::load_path::find_file(), octave::find_file_to_load(), octave::load_path::find_first_of(), octave::load_path::find_matching_dirs(), octave::find_private_file(), have_gnuplot_binary(), octave::sys::base_file_stat::is_blk(), octave::sys::base_file_stat::is_chr(), octave::sys::base_file_stat::is_dir(), octave::sys::base_file_stat::is_fifo(), octave::sys::base_file_stat::is_lnk(), octave::sys::base_file_stat::is_reg(), octave::sys::base_file_stat::is_sock(), octave::base_url_transfer::mput_directory(), read_mat5_binary_element(), and octave::single_match_exists().

◆ get_stats() [1/2]

void octave::sys::file_stat::get_stats ( bool  force = false)
inline

Definition at line 242 of file file-stat.h.

◆ get_stats() [2/2]

void octave::sys::file_stat::get_stats ( const std::string &  n,
bool  force = false 
)
inline

Definition at line 248 of file file-stat.h.

References n.

◆ gid()

gid_t octave::sys::base_file_stat::gid ( void  ) const
inlineinherited

Definition at line 126 of file file-stat.h.

Referenced by mk_stat_map().

◆ have_struct_stat_st_blksize()

bool octave::sys::base_file_stat::have_struct_stat_st_blksize ( void  )
staticinherited

Definition at line 143 of file file-stat.cc.

References octave_have_struct_stat_st_blksize().

Referenced by mk_stat_map().

◆ have_struct_stat_st_blocks()

bool octave::sys::base_file_stat::have_struct_stat_st_blocks ( void  )
staticinherited

Definition at line 149 of file file-stat.cc.

References octave_have_struct_stat_st_blocks().

Referenced by mk_stat_map().

◆ have_struct_stat_st_rdev()

bool octave::sys::base_file_stat::have_struct_stat_st_rdev ( void  )
staticinherited

Definition at line 137 of file file-stat.cc.

References octave_have_struct_stat_st_rdev().

Referenced by mk_stat_map().

◆ ino()

ino_t octave::sys::base_file_stat::ino ( void  ) const
inlineinherited

Definition at line 120 of file file-stat.h.

Referenced by mk_stat_map(), and octave::same_file_internal().

◆ is_blk() [1/2]

bool octave::sys::base_file_stat::is_blk ( mode_t  mode)
staticinherited

Definition at line 95 of file file-stat.cc.

References octave::sys::base_file_stat::mode(), and octave_is_blk_wrapper().

◆ is_blk() [2/2]

bool octave::sys::base_file_stat::is_blk ( void  ) const
inherited

Definition at line 53 of file file-stat.cc.

References octave::sys::base_file_stat::exists(), and octave::sys::base_file_stat::m_mode.

Referenced by FS_ISBLK().

◆ is_chr() [1/2]

bool octave::sys::base_file_stat::is_chr ( mode_t  mode)
staticinherited

Definition at line 101 of file file-stat.cc.

References octave::sys::base_file_stat::mode(), and octave_is_chr_wrapper().

◆ is_chr() [2/2]

bool octave::sys::base_file_stat::is_chr ( void  ) const
inherited

Definition at line 59 of file file-stat.cc.

References octave::sys::base_file_stat::exists(), and octave::sys::base_file_stat::m_mode.

Referenced by FS_ISCHR().

◆ is_dir() [1/2]

bool octave::sys::base_file_stat::is_dir ( mode_t  mode)
staticinherited

Definition at line 107 of file file-stat.cc.

References octave::sys::base_file_stat::mode(), and octave_is_dir_wrapper().

◆ is_dir() [2/2]

bool octave::sys::base_file_stat::is_dir ( void  ) const
inherited

Definition at line 65 of file file-stat.cc.

References octave::sys::base_file_stat::exists(), and octave::sys::base_file_stat::m_mode.

Referenced by octave::load_path::add(), dir_p(), do_stream_open(), F__ftp_mput__(), F__mkdir__(), octave::fcn_file_in_path(), Fdrawnow(), octave::load_path::find_dir(), octave::load_path::find_matching_dirs(), FS_ISDIR(), octave::genpath(), octave::load_path::dir_info::get_file_list(), octave::load_path::dir_info::get_method_file_map(), octave::base_url_transfer::mget_directory(), octave::base_url_transfer::mput_directory(), READABLE(), octave::sys::recursive_rmdir(), symbol_exist(), octave::load_path::dir_info::update(), and octave::xzip().

◆ is_fifo() [1/2]

bool octave::sys::base_file_stat::is_fifo ( mode_t  mode)
staticinherited

Definition at line 113 of file file-stat.cc.

References octave::sys::base_file_stat::mode(), and octave_is_fifo_wrapper().

◆ is_fifo() [2/2]

bool octave::sys::base_file_stat::is_fifo ( void  ) const
inherited

Definition at line 71 of file file-stat.cc.

References octave::sys::base_file_stat::exists(), and octave::sys::base_file_stat::m_mode.

Referenced by FS_ISFIFO().

◆ is_lnk() [1/2]

bool octave::sys::base_file_stat::is_lnk ( mode_t  mode)
staticinherited

Definition at line 119 of file file-stat.cc.

References octave::sys::base_file_stat::mode(), and octave_is_lnk_wrapper().

◆ is_lnk() [2/2]

bool octave::sys::base_file_stat::is_lnk ( void  ) const
inherited

Definition at line 77 of file file-stat.cc.

References octave::sys::base_file_stat::exists(), and octave::sys::base_file_stat::m_mode.

Referenced by FS_ISLNK().

◆ is_newer() [1/2]

int octave::sys::base_file_stat::is_newer ( const std::string &  file,
const sys::time &  time 
)
staticinherited

Definition at line 168 of file file-stat.cc.

References octave::sys::base_file_stat::is_newer().

◆ is_newer() [2/2]

bool octave::sys::base_file_stat::is_newer ( const sys::time &  time) const
inlineinherited

Definition at line 152 of file file-stat.h.

Referenced by octave::dynamic_library::dynlib_rep::fake_reload(), octave::sys::base_file_stat::is_newer(), octave::dynamic_library::dynlib_rep::is_out_of_date(), octave::out_of_date_check(), and octave::base_parser::start_function().

◆ is_reg() [1/2]

bool octave::sys::base_file_stat::is_reg ( mode_t  mode)
staticinherited

Definition at line 125 of file file-stat.cc.

References octave::sys::base_file_stat::mode(), and octave_is_reg_wrapper().

◆ is_reg() [2/2]

bool octave::sys::base_file_stat::is_reg ( void  ) const
inherited

Definition at line 83 of file file-stat.cc.

References octave::sys::base_file_stat::exists(), and octave::sys::base_file_stat::m_mode.

Referenced by octave::find_data_file_in_load_path(), octave::find_file_to_load(), octave::find_private_file(), FS_ISREG(), and octave::xzip().

◆ is_sock() [1/2]

bool octave::sys::base_file_stat::is_sock ( mode_t  mode)
staticinherited

Definition at line 131 of file file-stat.cc.

References octave::sys::base_file_stat::mode(), and octave_is_sock_wrapper().

◆ is_sock() [2/2]

bool octave::sys::base_file_stat::is_sock ( void  ) const
inherited

Definition at line 89 of file file-stat.cc.

References octave::sys::base_file_stat::exists(), and octave::sys::base_file_stat::m_mode.

Referenced by FS_ISSOCK().

◆ mode()

mode_t octave::sys::base_file_stat::mode ( void  ) const
inlineinherited

Definition at line 139 of file file-stat.h.

Referenced by octave::sys::base_file_stat::is_blk(), octave::sys::base_file_stat::is_chr(), octave::sys::base_file_stat::is_dir(), octave::sys::base_file_stat::is_fifo(), octave::sys::base_file_stat::is_lnk(), octave::sys::base_file_stat::is_reg(), octave::sys::base_file_stat::is_sock(), and mk_stat_map().

◆ mode_as_string()

std::string octave::sys::base_file_stat::mode_as_string ( void  ) const
inherited

Definition at line 155 of file file-stat.cc.

References octave::sys::base_file_stat::m_mode, and octave_strmode_wrapper().

Referenced by mk_stat_map().

◆ mtime()

sys::time octave::sys::base_file_stat::mtime ( void  ) const
inlineinherited

Definition at line 131 of file file-stat.h.

Referenced by F__magick_finfo__(), octave::dynamic_library::dynlib_rep::fake_reload(), octave_user_code::get_file_info(), octave::load_path::dir_info::initialize(), mk_stat_map(), and octave::load_path::dir_info::update().

◆ nlink()

nlink_t octave::sys::base_file_stat::nlink ( void  ) const
inlineinherited

Definition at line 123 of file file-stat.h.

Referenced by mk_stat_map().

◆ ok()

bool octave::sys::base_file_stat::ok ( void  ) const
inlineinherited

Definition at line 143 of file file-stat.h.

◆ operator bool()

octave::sys::base_file_stat::operator bool ( ) const
inlineinherited

Definition at line 145 of file file-stat.h.

◆ operator=()

file_stat& octave::sys::file_stat::operator= ( const file_stat &  fs)
inline

Definition at line 225 of file file-stat.h.

References file_name, follow_links, and octave::sys::base_file_stat::operator=().

◆ rdev()

dev_t octave::sys::base_file_stat::rdev ( void  ) const
inlineinherited

Definition at line 134 of file file-stat.h.

Referenced by mk_stat_map().

◆ size()

off_t octave::sys::base_file_stat::size ( void  ) const
inlineinherited

Definition at line 128 of file file-stat.h.

Referenced by F__magick_finfo__(), mk_stat_map(), and octave::file_info::snarf_file().

◆ time_resolution()

sys::time octave::sys::base_file_stat::time_resolution ( void  ) const
inlineinherited

Definition at line 89 of file file-stat.h.

Referenced by octave::load_path::dir_info::update().

◆ uid()

uid_t octave::sys::base_file_stat::uid ( void  ) const
inlineinherited

Definition at line 125 of file file-stat.h.

Referenced by mk_stat_map().

◆ update_internal()

void octave::sys::file_stat::update_internal ( bool  force = false)
private

Definition at line 188 of file file-stat.cc.

References octave::sys::base_file_stat::errmsg, octave::sys::base_file_stat::fail, file_name, follow_links, octave::sys::base_file_stat::initialized, octave::sys::file_ops::is_dir_sep(), octave::regexp::is_match(), octave::sys::base_file_stat::m_atime, octave::sys::base_file_stat::m_blksize, octave::sys::base_file_stat::m_blocks, octave::sys::base_file_stat::m_ctime, octave::sys::base_file_stat::m_dev, octave::sys::base_file_stat::m_gid, octave::sys::base_file_stat::m_ino, octave::sys::base_file_stat::m_mode, octave::sys::base_file_stat::m_mtime, octave::sys::base_file_stat::m_nlink, octave::sys::base_file_stat::m_rdev, octave::sys::base_file_stat::m_size, octave::sys::base_file_stat::m_uid, octave::sys::env::make_absolute(), octave_lstat_wrapper(), octave_stat_wrapper(), and octave::sys::file_ops::tilde_expand().

Referenced by file_stat().

Member Data Documentation

◆ errmsg

std::string octave::sys::base_file_stat::errmsg
protectedinherited

Definition at line 169 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ fail

bool octave::sys::base_file_stat::fail
protectedinherited

Definition at line 166 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ file_name

std::string octave::sys::file_stat::file_name
private

Definition at line 263 of file file-stat.h.

Referenced by file_stat(), operator=(), and update_internal().

◆ follow_links

bool octave::sys::file_stat::follow_links
private

Definition at line 267 of file file-stat.h.

Referenced by operator=(), and update_internal().

◆ initialized

bool octave::sys::base_file_stat::initialized
protectedinherited

Definition at line 163 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_atime

sys::time octave::sys::base_file_stat::m_atime
protectedinherited

Definition at line 193 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_blksize

long octave::sys::base_file_stat::m_blksize
protectedinherited

Definition at line 205 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_blocks

long octave::sys::base_file_stat::m_blocks
protectedinherited

Definition at line 208 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_ctime

sys::time octave::sys::base_file_stat::m_ctime
protectedinherited

Definition at line 199 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_dev

dev_t octave::sys::base_file_stat::m_dev
protectedinherited

Definition at line 178 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_gid

gid_t octave::sys::base_file_stat::m_gid
protectedinherited

Definition at line 187 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_ino

ino_t octave::sys::base_file_stat::m_ino
protectedinherited

Definition at line 175 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_mode

mode_t octave::sys::base_file_stat::m_mode
protectedinherited

Definition at line 172 of file file-stat.h.

Referenced by octave::sys::base_file_stat::is_blk(), octave::sys::base_file_stat::is_chr(), octave::sys::base_file_stat::is_dir(), octave::sys::base_file_stat::is_fifo(), octave::sys::base_file_stat::is_lnk(), octave::sys::base_file_stat::is_reg(), octave::sys::base_file_stat::is_sock(), octave::sys::base_file_stat::mode_as_string(), octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_mtime

sys::time octave::sys::base_file_stat::m_mtime
protectedinherited

Definition at line 196 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_nlink

nlink_t octave::sys::base_file_stat::m_nlink
protectedinherited

Definition at line 181 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_rdev

dev_t octave::sys::base_file_stat::m_rdev
protectedinherited

Definition at line 202 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_size

off_t octave::sys::base_file_stat::m_size
protectedinherited

Definition at line 190 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

◆ m_uid

uid_t octave::sys::base_file_stat::m_uid
protectedinherited

Definition at line 184 of file file-stat.h.

Referenced by octave::sys::base_file_stat::operator=(), update_internal(), and octave::sys::file_fstat::update_internal().

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