zipios_FilePath - Man Page

Handle a file path and name and its statistics.

FilePath (std::string const &path='')
Initialize a FilePath object.
bool exists () const
Check whether the file exists.
std::string filename () const
Retrieve the basename.
size_t fileSize () const
Get the size of the file.
bool isBlockSpecial () const
Check whether the file is a block special file.
bool isCharSpecial () const
Check whether the file is a character special file.
bool isDirectory () const
Check whether the file is a directory.
bool isFifo () const
Check whether the file is a pipe.
bool isRegular () const
Check whether the file is a regular file.
bool isSocket () const
Check whether the file is a socket.
std::time_t lastModificationTime () const
Get the last modification time of the file.
size_t length () const
Get the length of the string.
operator std::string () const
Retrieve the path.
FilePath operator+ (FilePath const &name) const
Append the a child name to this path.
FilePath & operator= (std::string const &path)
Replace the path with a new path.
bool operator== (char const *rhs) const
Check whether two FilePath represent the same file.
bool operator== (FilePath const &rhs) const
Check whether two FilePath represent the same file.
bool operator== (std::string const &rhs) const
Check whether two FilePath represent the same file.
size_t size () const
Get the length of the string.

Private Member Functions

void check () const
Read the file mode.

Private Attributes

bool m_checked = false
bool m_exists = false
std::string m_path
os_stat_t m_stat

Friends

bool operator== (char const *lhs, FilePath const &rhs)
Check whether two FilePath represent the same file.
bool operator== (std::string const &lhs, FilePath const &rhs)
Check whether two FilePath represent the same file.

Detailed Description

The FilePath class represents a path to a file or directory name. FilePath has member functions to check if the file path is a valid file system entity, and to check what kind of file system entity it is, e.g. is it a file, a directory, a pipe, etc.

It also knows of the last modification time and size of the file.

Warning: The information about a file is cached so at the time it gets used the file on disk may have changed, it may even have been deleted.

Definition at line 46 of file filepath.hpp.

Constructor & Destructor Documentation

zipios::FilePath::FilePath (std::string const & path = '')

The constructor saves the path and if check_exists is true, read the file statistics, especially the st_mode.

Parameters

path A string representation of the path.

See also

exists()

pruneTrailingSeparator()

Definition at line 103 of file filepath.cpp.

References m_stat.

Member Function Documentation

void zipios::FilePath::check () const [private]

This function sets m_checked to true, stat()'s the path, to see if it exists and to determine what type of file it is. All the query functions call check() before they test a flag to make sure it is set appropriately.

This means stat()'ing is deferred until it becomes necessary. But also it is cached meaning that if the file changes in between we get the old flags.

Todo: Under MS-Windows, we need to use _wstat() to make it work in Unicode (i.e. UTF-8 to wchar_t then call _wstat()...) Also we want to use the 64 bit variant to make sure that we get a valid size. Any other reference to the stat() command should be replace by using a FilePath().

See zipios/zipios-config.hpp.in

Definition at line 124 of file filepath.cpp.

References m_checked, m_exists, m_path, and m_stat.

Referenced by exists(), fileSize(), isBlockSpecial(), isCharSpecial(), isDirectory(), isFifo(), isRegular(), isSocket(), and lastModificationTime().

bool zipios::FilePath::exists () const

This function calls check() and then returns true if the file exists on disk.

Returns: true If the path is a valid file system entity.

Definition at line 360 of file filepath.cpp.

References check(), and m_exists.

std::string zipios::FilePath::filename () const

This function returns the filename part of the FilePath object by pruning the path off.

Returns: Return the basename of this FilePath filename.

Definition at line 306 of file filepath.cpp.

References zipios::g_separator, and m_path.

Referenced by zipios::FileEntry::getFileName().

size_t zipios::FilePath::fileSize () const

This function returns the size of the file. The size may be a 64 bit size on 64 bit systems.

Note

If the file represents a directory, the size will be zero.

If the file is not considered valid, the size returned is zero.

Warning

There is also a function called size() which actually checks the length of the path and not the size of the file.

Returns

The last modification as a Unix time.

See also

size()

Definition at line 470 of file filepath.cpp.

References check(), and m_stat.

Referenced by zipios::DirectoryEntry::DirectoryEntry().