NCBI C++ ToolKit
Classes | Macros | Typedefs | Enumerations | Functions | Variables
ncbifile.hpp File Reference

Defines classes: CDirEntry, CFile, CDir, CSymLink, CMemoryFile, CFileUtil, CFileLock, CFileIO, CFileReader, CFileWriter, CFileReaderWriter, CFileException. More...

#include <corelib/ncbi_system.hpp>
#include <corelib/ncbi_mask.hpp>
#include <corelib/ncbi_param.hpp>
#include <corelib/ncbisys.hpp>
#include <corelib/reader_writer.hpp>
#include <sys/types.h>
#include <sys/param.h>
#include <stdio.h>
+ Include dependency graph for ncbifile.hpp:

Go to the source code of this file.

Go to the SVN repository for this file.

Classes

class  CFileException
 CFileException –. More...
 
class  CFileErrnoException
 
class  CFileAPI
 Global settings related to the file API. More...
 
class  CDirEntry
 CDirEntry –. More...
 
struct  CDirEntry::SStat
 Alternate stat structure for use instead of the standard struct stat. More...
 
class  CFile
 CFile –. More...
 
class  CDir
 CDir –. More...
 
class  CSymLink
 CSymLink –. More...
 
class  CFileUtil
 CFileUtil – Utility functions. More...
 
struct  CFileUtil::SFileSystemInfo
 Structure to store information about file system. More...
 
class  CFileDeleteList
 CFileDeleteList –. More...
 
class  CFileDeleteAtExit
 CFileDeleteAtExit –. More...
 
class  CTmpFile
 CTmpFile –. More...
 
class  CMemoryFile_Base
 CMemoryFile_Base –. More...
 
class  CMemoryFileSegment
 CMemoryFileSegment –. More...
 
class  CMemoryFileMap
 CMemoryFileMap –. More...
 
class  CMemoryFile
 CMemoryFile –. More...
 
class  CFindFileNamesFunc< TNames >
 Functor for generic FindFiles, adds file name to the specified container. More...
 
struct  SCompareDirEntries
 Comparator for directory entries names. More...
 
class  CFileIO_Base
 Base class for CFileIO, CFileReader, CFileWriter, CFileReaderWriter. More...
 
class  CFileIO
 Class for support low level input/output for files. More...
 
class  CFileReaderWriter_Base
 File based IReader/IWriter/IReaderWriter with low level IO for speed. More...
 
class  CFileReader
 
class  CFileWriter
 
class  CFileReaderWriter
 
class  CFileLock
 File locking. More...
 

Macros

#define FILENAME_MAX   256
 
#define PATH_MAX   FILENAME_MAX
 

Typedefs

typedef unsigned int mode_t
 
typedef HANDLE TFileHandle
 
typedef CErrnoTemplException_Win< CFileExceptionCFileErrnoException_Base
 
typedef int TFindFiles
 Bitwise OR of "EFindFiles". More...
 

Enumerations

enum  EFindFiles {
  fFF_File = (1 << 0) , fFF_Dir = (1 << 1) , fFF_All = fFF_File | fFF_Dir , fFF_Recursive = (1 << 2) ,
  fFF_Nocase = (1 << 3) , fFF_Default = fFF_All
}
 File finding flags. More...
 

Functions

template<class TFindFunc >
void FindFilesInDir (const CDir &dir, const vector< string > &masks, const vector< string > &masks_subdir, TFindFunc &find_func, TFindFiles flags=fFF_Default)
 Find files in the specified directory. More...
 
template<class TFindFunc >
void FindFilesInDir (const CDir &dir, const CMask &masks, const CMask &masks_subdir, TFindFunc &find_func, TFindFiles flags=fFF_Default)
 Find files in the specified directory. More...
 
template<class TPathIterator , class TFindFunc >
void FindFiles (TPathIterator path_begin, TPathIterator path_end, const vector< string > &masks, TFindFunc &find_func, TFindFiles flags=fFF_Default)
 Generic algorithm for file search. More...
 
template<class TPathIterator , class TFindFunc >
void FindFiles2 (TPathIterator path_begin, TPathIterator path_end, const vector< string > &masks, const vector< string > &masks_subdir, TFindFunc &find_func, TFindFiles flags=fFF_Default)
 
template<class TPathIterator , class TMaskIterator , class TFindFunc >
void FindFiles (TPathIterator path_begin, TPathIterator path_end, TMaskIterator mask_begin, TMaskIterator mask_end, TFindFunc &find_func, TFindFiles flags=fFF_Default)
 Generic algorithm for file search. More...
 
template<class TPathIterator , class TFindFunc >
void FindFiles (TPathIterator path_begin, TPathIterator path_end, const CMask &masks, TFindFunc &find_func, TFindFiles flags=fFF_Default)
 Generic algorithm for file search. More...
 
template<class TPathIterator , class TFindFunc >
void FindFiles2 (TPathIterator path_begin, TPathIterator path_end, const CMask &masks, const CMask &masks_subdir, TFindFunc &find_func, TFindFiles flags=fFF_Default)
 
template<class TContainer , class TPathIterator >
void FindFiles (TContainer &out, TPathIterator first_path, TPathIterator last_path, const vector< string > &masks, TFindFiles flags=fFF_Default)
 Utility algorithm scans the provided directories using iterators finds files to match the masks and stores all found files in the container object. More...
 
template<class TContainer , class TPathIterator >
void FindFiles2 (TContainer &out, TPathIterator first_path, TPathIterator last_path, const vector< string > &masks, const vector< string > &masks_subdir, TFindFiles flags=fFF_Default)
 
template<class TContainer , class TPathIterator >
void FindFiles (TContainer &out, TPathIterator first_path, TPathIterator last_path, const CMask &masks, TFindFiles flags=fFF_Default)
 Utility algorithm scans the provided directories using iterators finds files to match the masks and stores all found files in the container object. More...
 
template<class TContainer , class TPathIterator >
void FindFiles2 (TContainer &out, TPathIterator first_path, TPathIterator last_path, const CMask &masks, const CMask &masks_subdir, TFindFiles flags=fFF_Default)
 
template<class TContainer , class TPathIterator , class TMaskIterator >
void FindFiles (TContainer &out, TPathIterator first_path, TPathIterator last_path, TMaskIterator first_mask, TMaskIterator last_mask, TFindFiles flags=fFF_Default)
 Utility algorithm scans the provided directories using iterators finds files to match the masks and stores all found files in the container object. More...
 
void FindFiles (const string &pattern, list< string > &result, TFindFiles flags)
 Utility function working like glob(): takes a pattern and fills the result list with files/directories matching the pattern. More...
 

Variables

const HANDLE kInvalidHandle = INVALID_HANDLE_VALUE
 

Detailed Description

Defines classes: CDirEntry, CFile, CDir, CSymLink, CMemoryFile, CFileUtil, CFileLock, CFileIO, CFileReader, CFileWriter, CFileReaderWriter, CFileException.

Defines different file finding algorithms.

Attention
The parts of API that returns bool usually set CNcbiError (ncbierror.hpp). It can be used to get an error code and get a reason why some method returns FALSE. PLEASE dont't rely on a regular 'errno' value. It is still set there for some legacy code, but please avoid.

Definition in file ncbifile.hpp.

Modified on Tue May 28 05:54:35 2024 by modify_doxy.py rev. 669887