FileSystemUtils Namespace Reference

Utility functions to deal with file system. More...

Functions
std::wstring	convert_utf8_to_utf16 (const std::string &str)
	Converts utf8 string represented by std::string to utf16 string represented by std::wstring. More...
bool	createDirectories (const std::string &dir_name)
	Creates directories in current directory for any element of dir_name which doesn't exist. More...
bool	createDirectory (const std::string &dir_name)
	Creates directory in current directory. More...
std::string	extension (const std::string &path)
	Returns extension of given filename. More...
std::string	extensions (const std::string &path)
	Returns extension(s) of given filename. More...
std::string	filename (const std::string &path)
	Returns path without directory part ("Foo/Bar/Doz.int.gz" -> "Doz.int.gz") More...
std::vector< std::string >	filesInDirectory (const std::string &dir_name)
	Returns filenames of files in directory. More...
std::vector< std::string >	glob (const std::string &dir, const std::string &pattern)
	Returns file names that agree with a regex glob pattern. More...
bool	IsFileExists (const std::string &path)
	Returns true if file with given name exists on disk. More...
std::string	jointPath (const std::string &path1, const std::string &path2)
	Returns joint path name. More...
std::string	stem (const std::string &path)
	Returns filename without (last) extension. More...
std::string	stem_ext (const std::string &path)
	Returns filename without extension(s). More...

Detailed Description

Utility functions to deal with file system.

Function Documentation

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(), IsFileExists(), IntensityDataIOFactory::readOutputData(), and IntensityDataIOFactory::writeOutputData().

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 49 of file FileSystemUtils.cpp.

{
#ifdef _WIN32
    return fs::create_directories(convert_utf8_to_utf16(dir_name));
#else
    return fs::create_directories(dir_name);
#endif
}

References convert_utf8_to_utf16().

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 40 of file FileSystemUtils.cpp.

{
#ifdef _WIN32
    return fs::create_directory(convert_utf8_to_utf16(dir_name));
#else
    return fs::create_directory(dir_name);
#endif
}

References convert_utf8_to_utf16(), and ModelView::Utils::create_directory().

Here is the call graph for this function:

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 25 of file FileSystemUtils.cpp.

{
    return fs::path(path).extension().string();
}

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 30 of file FileSystemUtils.cpp.

{
    const auto name = FileSystemUtils::filename(path);
    if (name == "..")
        return {};
 
    const auto pos = name.find_first_of('.', 1); // 1: ignore any file-is-hidden dot
    return pos != std::string::npos ? name.substr(pos, name.size() - pos) : std::string();
}

References filename(), and RealSpace::Particles::name().

Here is the call graph for this function:

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 80 of file FileSystemUtils.cpp.

{
    return fs::path(path).filename().string();
}

Referenced by TestUtils::CreateEmptyFile(), IHistogram::createFrom(), TestUtils::CreateTestFile(), extensions(), SaveLoadInterface::fileName(), ModelView ::Utils::is_binary(), ModelView ::Utils::is_text(), csv::isAscii(), SessionModel::load(), DataItem::load(), PointwiseAxisItem::load(), IHistogram::load(), ModelView::Project::ProjectImpl::process(), ProjectUtils::removeFile(), SessionModel::save(), IHistogram::save(), DataItem::setFileName(), RealDataItem::setNativeFileName(), JobModelFunctions::setupJobItemInstrument(), stem_ext(), TEST_F(), SpecularBeamItem::updateFileName(), SpecularBeamInclinationItem::updateFileName(), and ParticleView::updatePixmap().

filesInDirectory()

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

(

const std::string &

dir_name

)

Returns filenames of files in directory.

Definition at line 58 of file FileSystemUtils.cpp.

{
    std::vector<std::string> ret;
    if (!fs::exists(dir_name))
        throw std::runtime_error("FileSystemUtils::filesInDirectory '" + dir_name
                                 + "' does not exist");
 
    for (const auto& entry : fs::directory_iterator(dir_name))
        if (entry.is_regular_file())
            ret.push_back(entry.path().filename().string());
 
    return ret;
}

References ProjectUtils::exists().

Referenced by glob().

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 85 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:

IsFileExists()

bool FileSystemUtils::IsFileExists

(

const std::string &

path

)

Returns true if file with given name exists on disk.

Definition at line 115 of file FileSystemUtils.cpp.

{
#ifdef _WIN32
    return fs::exists(convert_utf8_to_utf16(path));
#else
    return fs::exists(path);
#endif
}

References convert_utf8_to_utf16(), and ProjectUtils::exists().

Referenced by IntensityDataIOFactory::readOutputData().

Here is the call graph for this function:

jointPath()

std::string FileSystemUtils::jointPath	(	const std::string &	path1,
		const std::string &	path2
	)

Returns joint path name.

Definition at line 72 of file FileSystemUtils.cpp.

{
    ASSERT(path1 != "");
    ASSERT(path2 != "");
 
    return (fs::path(path1) / fs::path(path2)).string();
}

References ASSERT.

stem()

std::string FileSystemUtils::stem

(

const std::string &

path

)

Returns filename without (last) extension.

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

Definition at line 94 of file FileSystemUtils.cpp.

{
    return fs::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 99 of file FileSystemUtils.cpp.

{
    const auto name = FileSystemUtils::filename(path);
    if (name == "..")
        return name;
 
    const auto pos = name.find_first_of('.', 1); // 1: ignore any file-is-hidden dot
    return pos != std::string::npos ? name.substr(0, pos) : name;
}

References filename(), and RealSpace::Particles::name().

Here is the call graph for this function: