FileSystemUtils Namespace Reference

Functions
std::string	extension (const std::string &path)
std::string	extensions (const std::string &path)
bool	createDirectory (const std::string &dir_name)
bool	createDirectories (const std::string &dir_name)
std::vector< std::string >	filesInDirectory (const std::string &dir_name)
std::string	jointPath (const std::string &spath1, const std::string &spath2)
std::string	filename (const std::string &path)
std::string	stem (const std::string &path)
std::string	stem_ext (const std::string &path)
std::vector< std::string >	glob (const std::string &dir, const std::string &pattern)
std::wstring	convert_utf8_to_utf16 (const std::string &str)
bool	IsFileExists (const std::string &str)

Detailed Description

Utility functions to deal with file system.

Function Documentation

extension()

std::string FileSystemUtils::extension

(

const std::string &

path

)

Returns extension of given filename.

"/home/user/filename.int" -> ".int", "/home/user/filename.int.gz" -> ".gz"

Definition at line 24 of file FileSystemUtils.cpp.

{
    return boost::filesystem::extension(path.c_str());
}

Referenced by DataFormatUtils::GetFileMainExtension(), DataFormatUtils::isBZipped(), and DataFormatUtils::isGZipped().

extensions()

std::string FileSystemUtils::extensions

(

const std::string &

path

)

Returns extension(s) of given filename.

"/home/user/filename.int" -> ".int", "/home/user/filename.int.gz" -> ".int.gz"

Definition at line 29 of file FileSystemUtils.cpp.

{
    auto name = FileSystemUtils::filename(path);
    auto npos = name.find_first_of('.');
    return npos != std::string::npos ? name.substr(npos, name.size() - npos) : std::string();
}

References filename().

Here is the call graph for this function:

createDirectory()

bool FileSystemUtils::createDirectory

(

const std::string &

dir_name

)

Creates directory in current directory.

Definition at line 36 of file FileSystemUtils.cpp.

{
#ifdef _WIN32
    boost::filesystem::path path(convert_utf8_to_utf16(dir_name));
#else
    boost::filesystem::path path(dir_name);
#endif
    return boost::filesystem::create_directory(dir_name);
}

References convert_utf8_to_utf16().

Here is the call graph for this function:

createDirectories()

bool FileSystemUtils::createDirectories

(

const std::string &

dir_name

)

Creates directories in current directory for any element of dir_name which doesn't exist.

Definition at line 46 of file FileSystemUtils.cpp.

{
#ifdef _WIN32
    boost::filesystem::path path(convert_utf8_to_utf16(dir_name));
#else
    boost::filesystem::path path(dir_name);
#endif
    return boost::filesystem::create_directories(path);
}

References convert_utf8_to_utf16().

Here is the call graph for this function:

filesInDirectory()

std::vector< std::string > FileSystemUtils::filesInDirectory

(

const std::string &

dir_name

)

Returns filenames of files in directory.

Definition at line 56 of file FileSystemUtils.cpp.

{
    std::vector<std::string> ret;
    if (!boost::filesystem::exists(dir_name))
        throw std::runtime_error("FileSystemUtils::filesInDirectory '" + dir_name
                                 + "' does not exist");
    boost::filesystem::directory_iterator end_it; // default construction yields past-the-end
    for (boost::filesystem::directory_iterator it(dir_name);
         it != boost::filesystem::directory_iterator(); ++it) {
        if (!boost::filesystem::is_regular_file(it->status()))
            continue;
        ret.push_back(it->path().filename().string());
    }
    return ret;
}

Referenced by glob().

jointPath()

std::string FileSystemUtils::jointPath	(	const std::string &	spath1,
		const std::string &	spath2
	)

Returns joint path name.

Definition at line 72 of file FileSystemUtils.cpp.

{
    ASSERT(spath1 != "");
    ASSERT(spath2 != "");
    boost::filesystem::path path1(spath1);
    boost::filesystem::path path2(spath2);
    boost::filesystem::path full_path = path1 / path2;
 
    return full_path.string();
}

References ASSERT.

filename()

std::string FileSystemUtils::filename

(

const std::string &

path

)

Returns path without directory part ("Foo/Bar/Doz.int.gz" -> "Doz.int.gz")

Definition at line 83 of file FileSystemUtils.cpp.

{
    return boost::filesystem::path(path).filename().string();
}

Referenced by IHistogram::createFrom(), extensions(), IHistogram::load(), IHistogram::save(), and stem_ext().

stem()

std::string FileSystemUtils::stem

(

const std::string &

path

)

Returns filename without extension.

"/home/user/filename.int" -> "filename", "/home/user/filename.int.gz" -> "filename.int"

Definition at line 97 of file FileSystemUtils.cpp.

{
    return boost::filesystem::path(path).stem().string();
}

stem_ext()

std::string FileSystemUtils::stem_ext

(

const std::string &

path

)

Returns filename without extension(s).

"/home/user/filename.int" -> "filename", "/home/user/filename.int.gz" -> "filename"

Definition at line 102 of file FileSystemUtils.cpp.

{
    auto name = FileSystemUtils::filename(path);
    auto npos = name.find_first_of('.');
    return npos != std::string::npos ? name.substr(0, npos) : std::string();
}

References filename().

Here is the call graph for this function:

glob()

std::vector< std::string > FileSystemUtils::glob	(	const std::string &	dir,
		const std::string &	pattern
	)

Returns file names that agree with a regex glob pattern.

Definition at line 88 of file FileSystemUtils.cpp.

{
    std::vector<std::string> ret;
    for (const std::string& fname : filesInDirectory(dir))
        if (std::regex_match(fname, std::regex(pattern)))
            ret.push_back(fname);
    return ret;
}

References filesInDirectory().

Here is the call graph for this function:

convert_utf8_to_utf16()

std::wstring FileSystemUtils::convert_utf8_to_utf16

(

const std::string &

str

)

Converts utf8 string represented by std::string to utf16 string represented by std::wstring.

Definition at line 109 of file FileSystemUtils.cpp.

{
    std::wstring_convert<std::codecvt_utf8_utf16<wchar_t>> converter;
    return converter.from_bytes(str);
}

Referenced by createDirectories(), createDirectory(), OutputDataReader::getOutputData(), IsFileExists(), and OutputDataWriter::writeOutputData().

IsFileExists()

bool FileSystemUtils::IsFileExists

(

const std::string &

str

)

Returns true if file with given name exists on disk.

Definition at line 115 of file FileSystemUtils.cpp.

{
#ifdef _WIN32
    boost::filesystem::path path(convert_utf8_to_utf16(str));
#else
    boost::filesystem::path path(str);
#endif
    return boost::filesystem::exists(path);
}

References convert_utf8_to_utf16().

Referenced by IntensityDataIOFactory::readOutputData(), and IntensityDataIOFactory::readReflectometryData().

Here is the call graph for this function: