utils_filesystem.h

Go to the documentation of this file.

/*!
 * \file utils_filesystem.h
 * \brief File system related functions in CCGL.
 *
 * \remarks
 *   - 1. 2018-05-02 - lj - Make part of CCGL.
 *
 * \author Liangjun Zhu, zlj(at)lreis.ac.cn)
 * \version 1.0
 */
#ifndef CCGL_UTILS_FILESYSTEM_H
#define CCGL_UTILS_FILESYSTEM_H
 
#include "basic.h"
 
#include <vector>
 
using std::vector;
 
namespace ccgl {
/*!
 * \namespace ccgl::utils_filesystem
 * \brief File Input and output related functions
 */
namespace utils_filesystem {
/*!
 * \brief Check the given directory path (not regular file!) is exists or not.
 */
bool DirectoryExists(const string& dirpath);
 
/*!
 * \brief Make directory if not exists
 */
bool MakeDirectory(const string& dirpath);
 
/*!
 * \brief Clean a directory if exists, otherwise create it.
 */
bool CleanDirectory(const string& dirpath);
 
/*!
 * \brief Delete a directory if exists.
 *
 * Reference:
 *   - 1. Windows: https://stackoverflow.com/questions/734717/how-to-delete-a-folder-in-c
 *   - 2. Linux: https://www.linuxquestions.org/questions/programming-9/deleting-a-directory-using-c-in-linux-248696/
 */
bool DeleteDirectory(const string& dirpath, bool del_subdirs = true);
 
/*!
 * \brief Get the root path of the current executable file
 * \return \a string root path
 */
string GetAppPath();
 
/*!
 * \brief Return the absolute file path from a given file path
 * \param[in] full_filename Full file path
 * \sa GetPathFromFullName
 */
string GetAbsolutePath(string const& full_filename);
 
/*!
 * \brief Return the file name from a given file's path
 * \param[in] full_filename Full file path
 * \sa GetPathFromFullName
 */
string GetCoreFileName(string const& full_filename);
 
/*!
 * \brief Return the suffix of a given file's path without dot, e.g., "tif", "asc"
 * \param[in] full_filename Full file path
 * \sa GetPathFromFullName
 */
string GetSuffix(string const& full_filename);
 
/*!
 * \brief Replace the suffix by a given suffix
 * \param[in] full_filename Full file path
 * \param[in] new_suffix New suffix without dot, e.g., "tif", "asc"
 */
string ReplaceSuffix(string const& full_filename, string const& new_suffix);
 
/*!
 * \brief Append a given string to the core filename
 * \param[in] full_filename Full file path
 * \param[in] endstr End string
 * \param[in] deli (Optional) Delimiter
 * \return new full_filename
 */
string AppendCoreFileName(string const& full_filename, string const& endstr, char deli = '_');
 
/*!
 * \brief Append a given integer to the core filename
 */
string AppendCoreFileName(string const& full_filename, vint endint, char deli = '_');
 
/*!
 * \brief Add a prefix to the core filename
 * \param[in] full_filename Full file path
 * \param[in] prestr Start string
 * \param[in] deli (Optional) Delimiter
 * \return new full_filename
 */
string PrefixCoreFileName(string const& full_filename, string const& prestr, char deli = '_');
 
/*!
 * \brief Add a prefix to the core filename
 */
string PrefixCoreFileName(string const& full_filename, vint preint, char deli = '_');
 
/*!
 * \brief Get Path From full file path string
 * \param[in] full_filename Full file path
 * \sa GetCoreFileName
 */
string GetPathFromFullName(string const& full_filename);
 
/*!
 * \brief Concatenate directory, core file name, and suffix
 */
string ConcatFullName(string const& fdir, string const& corename, string const& suffix = std::string());
 
/*!
 * \brief Return a flag indicating if the given file exists
 * \param[in] filename String path of file
 * \return True if Exists, and false if not.
 */
bool FileExists(string const& filename);
 
/*!
 * \brief Return a flag indicating if given files exist
 * \param[in] filenames Vector of full file paths
 * \return True if all existed, else false
 */
bool FilesExist(vector<string>& filenames);
 
/*!
 * \brief Return a flag indicating if the given path (directory or file) exists
 * \param[in] path String path
 * \return True if Exists, and false if not.
 */
bool PathExists(string const& path);
 
/*!
 * \brief Delete the given file if existed.
 * \param[in] filepath \a string File path, full path or relative path
 * \return 0 if deleted successful, else return nonzero value, e.g. -1.
 */
int DeleteExistedFile(const string& filepath);
 
/*!
 * \brief Find files in given paths
 * \param[in] lp_path Directory path
 * \param[in] expression Wildcard characters, e.g., "*.*" means any filename with any suffix
 * \param[out] vec_files Vector of full file paths
 * \return 0 means success
 */
int FindFiles(const char* lp_path, const char* expression, vector<string>& vec_files);
 
/*!
 * \brief Load short plain text file as string vector, ignore comments begin with '#' and empty lines
 * \param[in] filepath Plain text file path
 * \param[out] content_strs Each line without CRLF or LF stored in vector
 * \return True when read successfully, and false with empty content_strs when failed
 */
bool LoadPlainTextFile(const string& filepath, vector<string>& content_strs);
} /* namespace: utils_filesystem */
 
} /* namespace: ccgl */
 
#endif /* CCGL_UTILS_FILESYSTEM_H */