file_util.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2014:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter, Torbjörn Klatt
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 */
 
#ifndef __H__UG__FILE_UTIL__
#define __H__UG__FILE_UTIL__
 
#include <fstream>
#include <vector>
#include <string>
#include "common/ug_config.h"
 
namespace ug
{
 
 
UG_API bool GetDirectoriesInDirectory(std::vector<std::string>& dirsOut, const char* dir);
 
UG_API bool GetFilesInDirectory(std::vector<std::string>& filesOut, const char* dir);
 
UG_API bool DirectoryExists(const char* dirname);
static inline bool DirectoryExists( std::string filename)
{
  return DirectoryExists(filename.c_str());
}
UG_API bool FileExists( const char *filename );
static inline bool FileExists( std::string filename)
{
  return FileExists(filename.c_str());
}
 
UG_API size_t FileSize( const char *filename );
static inline size_t FileSize( std::string filename)
{
  return FileSize(filename.c_str());
}
 
UG_API bool FileTypeIs( const char *filename, const char *extension );
 
UG_API bool CreateDirectoryTMP(const char *directory);
 
UG_API bool CreateDirectory(const char *directory);
 
UG_API bool CreateDirectory(const char *directory, int mode);
 
static inline bool CreateDirectory(std::string directory)
{
  return CreateDirectoryTMP(directory.c_str());
}
 
UG_API bool FileCompare( const char *file1, const char *file2 );
 
UG_API std::string GetTmpPath();
 
UG_API bool ReadFile(const char* filename, std::vector<char> &file, bool bText);
 
 
UG_API std::string MakeTmpFile(std::string filename, const std::string &extension,
    bool &bSuccess);
 
UG_API void ChangeDirectory(std::string dir);
 
 
 
std::string FindFileInStandardPaths(const char* filename);
 
 
std::string FindDirInStandardPaths(const char* dirname);
 
std::string CurrentWorkingDirectory();
 
// end group ugbase_common_io
 
} // namespace ug
 
#endif // __H__UG__FILE_UTIL__
 
// EOF