FileTools.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstddef>
#include <iosfwd>
#include <limits>
#include <string>
#include <tuple>
#include <vector>
 
namespace BaseLib
{
bool isProjectDirectorySet();
 
bool IsFileExisting(const std::string& strFilename);
 
std::tuple<std::string, std::string::size_type, std::string::size_type>
getParenthesizedString(std::string const& in,
                       char const open_char,
                       char const close_char,
                       std::string::size_type pos);
 
std::string constructFormattedFileName(std::string const& format_specification,
                                       std::string const& mesh_name,
                                       int const timestep,
                                       double const t,
                                       int const iteration);
 
std::vector<double> readDoublesFromBinaryFile(const std::string& filename);
 
template <typename T>
void writeValueBinary(std::ostream& out, T const& val);
 
template <typename T>
T swapEndianness(T const& v)
{
    union
    {
        T v;
        char c[sizeof(T)];
    } a, b;
 
    a.v = v;
    for (unsigned short i = 0; i < sizeof(T); i++)
    {
        b.c[i] = a.c[sizeof(T) - i - 1];
    }
 
    return b.v;
}
 
double swapEndianness(double const& v);
 
template <typename T>
T readBinaryValue(std::istream& in);
 
extern template float readBinaryValue<float>(std::istream&);
extern template double readBinaryValue<double>(std::istream&);
 
template <typename T>
std::vector<T> readBinaryVector(
    std::string const& filename, std::size_t const start_element = 0,
    std::size_t const num_elements = std::numeric_limits<std::size_t>::max());
 
std::string extractBaseName(std::string const& pathname);
 
std::string extractBaseNameWithoutExtension(std::string const& pathname);
 
std::string getFileExtension(std::string const& path);
 
bool hasFileExtension(std::string const& extension,
                      std::string const& filename);
 
std::string dropFileExtension(std::string const& filename);
 
std::string extractPath(std::string const& pathname);
 
std::string joinPaths(std::string const& pathA, std::string const& pathB);
 
std::string const& getProjectDirectory();
 
void setProjectDirectory(std::string const& dir);
 
void unsetProjectDirectory();
 
void removeFile(std::string const& filename);
 
void removeFiles(std::vector<std::string> const& files);
 
// Creates the given directory. Returns true on success.
bool createOutputDirectory(std::string const& dir);
}  // end namespace BaseLib