doxygen/html/fileio_8hpp_source.html

 /*

  * Copyright (c) 2014 Patrick P. Frey

  *

  * This Source Code Form is subject to the terms of the Mozilla Public

  * License, v. 2.0. If a copy of the MPL was not distributed with this

  * file, You can obtain one at http://mozilla.org/MPL/2.0/.

  */

 #ifndef _STRUS_BASE_FILE_IO_HPP_INCLUDED

 #define _STRUS_BASE_FILE_IO_HPP_INCLUDED

 #include <vector>

 #include <string>

 #include <cstdio>


 namespace strus

 {


 int readFileSize( const std::string& filename, std::size_t& size);


 int readFile( const std::string& filename, std::string& res);


 int readStdin( std::string& res);


 int writeFile( const std::string& filename, const std::string& content);


 int appendFile( const std::string& filename, const std::string& content);


 int removeFile( const std::string& filename, bool fail_ifnofexist=false);


 int removeDir( const std::string& dirname, bool fail_ifnofexist=false);


 int removeDirRecursive( const std::string& dirname, bool fail_ifnofexist=false);


 int renameFile( const std::string& old_filename, const std::string& new_filename);


 int createDir( const std::string& dirname, bool fail_ifexist=true);


 int mkdirp( const std::string& dirname);


 int changeDir( const std::string& dirname);


 int readDirFiles( const std::string& path, const std::string& ext, std::vector<std::string>& res);


 int readDirSubDirs( const std::string& path, std::vector<std::string>& res);


 int readDirItems( const std::string& path, std::vector<std::string>& res);


 int expandFilePattern( const std::string& pathPattern, std::vector<std::string>& res);


 bool isFile( const std::string& path);


 bool isDir( const std::string& path);


 bool isRelativePath( const std::string& path);


 bool isAbsolutePath( const std::string& path);


 bool isExplicitPath( const std::string& path);


 bool isTextFile( const std::string& path);


 int getParentPath( const std::string& path, std::string& dest);


 int getAncestorPath( const std::string& path, int level, std::string& dest);


 int getFileName( const std::string& path, std::string& dest, bool withExtension=true);


 int getFileExtension( const std::string& path, std::string& ext);


 char dirSeparator();


 bool hasUpdirReference( const std::string& path);


 std::string joinFilePath( const std::string& parentpath, const std::string& childpath);


 int resolveUpdirReferences( std::string& path);


 }//namespace

 #endif


strus::renameFile
int renameFile(const std::string &old_filename, const std::string &new_filename)
Moves (renames) a file.

strus::isFile
bool isFile(const std::string &path)
Check if a file system path points to a file.

strus::readFile
int readFile(const std::string &filename, std::string &res)
Reads the complete content of a file to a string.

strus::isExplicitPath
bool isExplicitPath(const std::string &path)
Check if a file path is explicit (relative path or absolute path)

strus::appendFile
int appendFile(const std::string &filename, const std::string &content)
Appends a string to a file creating the file if it does not exist.

strus::getAncestorPath
int getAncestorPath(const std::string &path, int level, std::string &dest)
Get an ancestor (containing) path of a file or directory.

strus::readFileSize
int readFileSize(const std::string &filename, std::size_t &size)
Evaluate the size of a file in bytes.

strus::createDir
int createDir(const std::string &dirname, bool fail_ifexist=true)
Creates a directory if it does not exist yet.

strus::writeFile
int writeFile(const std::string &filename, const std::string &content)
Writes a string to a file creating the file if it does not exist.

strus::removeDir
int removeDir(const std::string &dirname, bool fail_ifnofexist=false)
Removes an empty directory.

strus::resolveUpdirReferences
int resolveUpdirReferences(std::string &path)
Resolve upper directory references in a path, e.g. replace "/home/john/../jack" by "/home/jack"...

strus::dirSeparator
char dirSeparator()
Get the OS path element separator.

strus::isRelativePath
bool isRelativePath(const std::string &path)
Check if a file system path is a path starting with a name and not with a directive referencing the c...

strus::isTextFile
bool isTextFile(const std::string &path)
Check if a file system path points to a file with text content (not binary)

strus::readDirSubDirs
int readDirSubDirs(const std::string &path, std::vector< std::string > &res)
Reads all subdirectories of a directory to an array of strings.

strus::readStdin
int readStdin(std::string &res)
Reads the complete input of stdin to a string.

strus::isAbsolutePath
bool isAbsolutePath(const std::string &path)
Check if a file system path is a path starting the file system root '/'.

strus::expandFilePattern
int expandFilePattern(const std::string &pathPattern, std::vector< std::string > &res)
Get all items matching a file path pattern (with '?' and '*' as substitutes)

strus::readDirFiles
int readDirFiles(const std::string &path, const std::string &ext, std::vector< std::string > &res)
Reads all file names matching to the extension ext of a directory to an array of strings.

strus::getFileName
int getFileName(const std::string &path, std::string &dest, bool withExtension=true)
Get the file name without parent path of a file or directory.

strus::isDir
bool isDir(const std::string &path)
Check if a file system path points to a directory.

strus::hasUpdirReference
bool hasUpdirReference(const std::string &path)
Return true, if the path contains an upper directory reference '..'.

strus::removeDirRecursive
int removeDirRecursive(const std::string &dirname, bool fail_ifnofexist=false)
Removes a directory with all its contents.

strus::removeFile
int removeFile(const std::string &filename, bool fail_ifnofexist=false)
Removes a file.

strus::changeDir
int changeDir(const std::string &dirname)
Change current directory of the process.

strus::getFileExtension
int getFileExtension(const std::string &path, std::string &ext)
Get the extension (including '.') of a file or directory.

strus::readDirItems
int readDirItems(const std::string &path, std::vector< std::string > &res)
Reads all items (directory or file) of a directory to an array of strings.

strus::mkdirp
int mkdirp(const std::string &dirname)
Creates a directory path (mkdir -p)

strus::getParentPath
int getParentPath(const std::string &path, std::string &dest)
Get the parent (containing) path of a file or directory.

strus::joinFilePath
std::string joinFilePath(const std::string &parentpath, const std::string &childpath)
Join two path with directory separator.