Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/group__Files.html below:

NCBI C++ ToolKit: File System Access

Define a list of pointers to directory entries.

Definition at line 1759 of file ncbifile.hpp.

Binary OR of "EProcessingFlags".

Definition at line 754 of file ncbifile.hpp.

Flags based on TProcessingFlags.

Definition at line 757 of file ncbifile.hpp.

Which I/O operations permitted on the file.

File can be read.

File can be written.

File can be read and written.

Definition at line 3444 of file ncbifile.hpp.

Which operations to allow on temporary file.

Allow read and write.

Allow write only.

Definition at line 1481 of file ncbifile.hpp.

Controls how temporary file is removed.

Do not ever remove temporary file.

Remove temporary file immediately after closing its handle in Close().

Remove the file at the earliest possible moment (in CreateTemporary() on UNIX).

Definition at line 3498 of file ncbifile.hpp.

Backup modes.

Copy entry.

Rename entry.

Default mode.

Definition at line 667 of file ncbifile.hpp.

Mode to compare streams in text form.

Skip end-of-line characters ('\r' and '
')

Skip white spaces (in terms of isspace(), including end-of-line)

Definition at line 1665 of file ncbifile.hpp.

Copy flags.

Note that updating modification time for directory depends on the OS. Normally it gets updated when a new directory entry is added/removed. On the other hand, changing contents of files in that directory doesn't usually affect the directory modification time.

The following flags define what to do when the destination entry already exists:

• Overwrite the destination

• Update older entries only (compare modification times)

• Backup destination (renames to ".bak" by default)

Safe copy (copy to temporary object and rename).

Be aware if used together with fCF_TopDirOnly for copying directories: if specified – full copy of the source directory will be created, after successful copying it replaces the destination. if not specified – existing destination directory will be "upgraded" with files from source directory, safe copying will be applied for every copied entry inside.

All above flags can be applied to the top directory only (not for every file therein), to process the directory as a single entity for overwriting, updating or backing up.

If destination entry exists, it must have the same type as source.

Copy entries following their sym.links, not the links themselves.

Verify data after copying.

Preserve owner/group.

Preserve permissions/attributes.

Preserve date/times.

Copy recursively (for dir only)

Skip all entries for which we don't have Copy() method.

Default flags.

Definition at line 531 of file ncbifile.hpp.

Flags for Create()/CreatePath()

See also

Create, CreatePath

Default directory creation mode.

• no error if directory already exists;
• don't change permissions if already exists;
• use default mode for created directory see: SetDefaultMode(), SetDefaultModeGlobal(), CFileAPI::SetHonorUmask().

Don't change permissions after creation, leave it for OS and umask control.

This flag have a priority over CFileAPI::SetHonorUmask(), that works with fCD_Default only.

Use same permissions as parent directory (umask ignored)

Error, if directory already exists.

All other existent entry with the same name (including symbolic links to directory) lead to an error by default.

Allow to "update" permissions for already existent directory using default, umask or parent permissions as specified by previous flags.

Note: Create() only, ignored by CreatePath().

Definition at line 1921 of file ncbifile.hpp.

Error types that file operations can generate.

Definition at line 139 of file ncbifile.hpp.

Error types.

Definition at line 168 of file ncbifile.hpp.

Unix: The path name to any file/dir withing file system.

MS Windows: The path name to any file/dir withing file system. The root directory of the disk, or UNC name (for example, \MyServer\MyShare\, C:\). The "." can be used to get disk space on current disk.

File system type could not be determined.

Acorn's Advanced Disc Filing System.

Tru64 UNIX Advanced File System.

Amiga Fast File System.

AFS File System.

Automount File System.

The Be (BeOS) File System (BeFS)

Boot File System.

Cache File System.

eCryptfs (Enterprise Cryptographic Filesystem)

ISO 9660 CD-ROM file system (CDFS/ISO9660)

Common Internet File System.

Coda File System.

Coherent (System V)

Compressed ROMFS.

Debug File System (Linux)

Device File System.

DCE Distributed File System (DCE/DFS)

The Encrypting File System (EFS) (MSWin)

EXtended Object File System (EXOFS)

Extended file system.

Second Extended file system.

Journalled form of ext2.

Traditional 8.3 MSDOS-style file system.

FAT32 file system.

File Descriptor File System.

File-on-File Mounting file system.

Fast File System (*BSD)

Filesystem in Userspace (FUSE)

Fusectl (helper filesystem for FUSE)

Global File System.

IBM General Parallel File System.

Hierarchical File System.

Hierarchical File System.

OS/2 High-Performance File System.

High Sierra File System.

Journalling File System.

Journalling Flash File System.

Journalling Flash File System v2.

Loopback File System.

Memory File System.

Minix v1.

Minix v2.

Minix v3.

Mail Slot File System.

NetWare Core Protocol File System.

Network File System (NFS)

New Technology File System.

Oracle Cluster File System 2.

/proc/openprom filesystem

Panasas FS.

/proc file system

Parallel Virtual File System.

Reiser File System.

Remote File Share file system (AT&T RFS)

QNX4 file system.

ROM File System.

Security-Enhanced Linux (SELinux)

Samba File System.

SPECial File System.

Compressed read-only filesystem (Linux)

(Linux)

System V.

System V.

Virtual Memory File System (TMPFS/SHMFS)

The Unsorted Block Image File System.

Universal Disk Format.

UNIX File System.

UNIX File System.

USBDevice file system.

UNIX V7 File System.

VERITAS File System (VxFS)

Virtuozzo File System (VZFS)

Xenix (SysV) file system.

XFS File System.

Definition at line 2140 of file ncbifile.hpp.

File finding flags.

find files

find directories

find files and directories (used automatically if fFF_File or fFF_Dir has not specified)

descend into sub-dirs

case-insensitive name search

default behavior

Definition at line 3017 of file ncbifile.hpp.

Flags, used in constructors.

Default flag in each group have priority above non-default, if they are used together.

Lock file using parameters specified in constructor.

Automatically remove all obtained locks in the destructor.

Note, that you still can unlock any segment. All remaining locks will be removed in the destructor.

Default flags.

Definition at line 3805 of file ncbifile.hpp.

Flags for GetEntries()

See also

GetEntries, GetEntriesPtr

Suppress "self recursive" elements (the directories "." and "..").

Create appropriate subclasses of CDirEntry (CFile,CDir,...), not just CDirEntry objects.

Ignore upper and lower-case differences when doing a mask comparison.

Makes the mask case-insensitive.

Return only names of entries, not their full paths.

Throws an exceptions on error, instead of returning empty/null value.

Deprecated:

Only provided for backward compatibility.

Will be removed in the future. Do not use.

Deprecated:

Only provided for backward compatibility.

Will be removed in the future. Do not use.

Definition at line 1764 of file ncbifile.hpp.

Windows specific: Historically, we try to use APPDATA% first, and use USERPROFILE% as a fallback to detect a "home" directory on Windows.

This is actually not exactly correct, and at least some users want to do it in the reverse order.

See also

GetHome

Try env var APPDATA% first.

Try env var USERPROFILE% first.

Definition at line 1726 of file ncbifile.hpp.

What IsNewer() should do if the dir entry does not exist or is not accessible.

See also

IsNewer

Throw an exception.

Deem absent entry to be "newer".

Deem absent entry to be "older".

Definition at line 992 of file ncbifile.hpp.

What path version of IsNewer() should do if the dir entry or specified path does not exist or is not accessible.

Default flags (0) mean throwing an exceptions if one of dir entries does not exists. But if you don't like to have an exception here, you can change IsNewer() behavior specifying flags. There are three cases: there's a problem only with the argument (HasThis-NoPath), there's a problem only with original entry (NoThis-HasPath), or there are problems with both (NoThis-NoPath). The EIfAbsent2 lets you independently select what to do in each of those scenarios: throw an exception (no flags set), return true (f*_Newer), or return false (f*_NotNewer).

See also

IsNewer

Definition at line 1037 of file ncbifile.hpp.

What GetDir() should return if the dir entry does not contain path.

See also

GetDir

Return empty string.

Return current dir like "./".

Definition at line 329 of file ncbifile.hpp.

What to do if stream already exists in the AsInputFile/AsOutputFile.

You can make call of AsInputFile/AsOutputFile only once, on each following call throws CFileException exception.

Delete previous stream and return reference to new object.

Invalidate all previously returned references.

Return reference to current stream, create new one if it does not exists yet.

Definition at line 2384 of file ncbifile.hpp.

What type of data access pattern will be used for mapped region.

Advises the VM system that the a certain region of user mapped memory will be accessed following a type of pattern. The VM system uses this information to optimize work with mapped memory.

NOTE: Works on UNIX platform only.

See also

EMemoryAdvise, MemoryAdvise

Definition at line 2480 of file ncbifile.hpp.

Which operations are permitted in memory map file.

Data can be read.

Data can be written.

Data can be read and written.

Definition at line 2440 of file ncbifile.hpp.

Whether to share changes or not.

Changes are shared.

Changes are private (write do not change file)

Definition at line 2447 of file ncbifile.hpp.

Directory entry access permissions.

Execute / List(directory) permission.

Write permission.

Read permission.

Special flag: ignore all other flags, use current default mode.

Default user permission for a dir.

Default group permission for a dir.

Default other permission for a dir.

Default user permission for a file.

Default group permission for a file.

Default other permission for a file.

Definition at line 1151 of file ncbifile.hpp.

Relative permissions change modes.

Can be combined with TMode or TSpecialModeBits. Only one of these flags is allowed for each mode.

Adds the argument permission mode to the entry's current mode.

Removes the argument permission mode from the entry's current mode.

Do not change permission mode.

Definition at line 1185 of file ncbifile.hpp.

Permission mode string format.

See also

StringToMode, ModeToString

Octal format ("664")

Shell symbolic format ("u=rwx,g=rwx,o=rx")

Shell list 'ls -l' like format ("rwxrwxrwx")

Default mode.

Definition at line 1353 of file ncbifile.hpp.

Memory file open mode.

Create new file or rewrite existent with zeros.

Open existent file, throw exception otherwise.

Extend file size with zeros if it exist, throw exception otherwise.

Default open mode.

Definition at line 2453 of file ncbifile.hpp.

File open mode.

Create a new file, or truncate an existing one.

Create a new file, or fail if the file already exists.

Open an existing file, or fail if the file does not exist.

Open an existing file, or create a new one.

Open an existing file and truncate its size to 0.

Fail if the file does not exist.

Definition at line 3429 of file ncbifile.hpp.

Which starting point to use for the moves of the file pointer.

Absolute position from beginning of the file.

Relative to current position.

The starting point is the current EOF position.

Definition at line 3470 of file ncbifile.hpp.

Entries processing flags.

Note

Different methods use different sets of flags, and ignore all other. Refer to method descriptions for details.

Current entry only.

Top directory entry.

Non-directory entries.

Subdirectory entries (non recursive)

Add a recursion.

Mask to check what should be processed in a directory.

Ignore missed entries.

Process all entries.

Directory entry only, no other files or subdirectories.

All files in the top directory only, no subdirectories and any files in them.

All files and subdirectories in the top directory, but no files in subdirectories.

Process all files and subdirectories recursively.

Stop processing on a first error.

Same as eRecursive, but do not report an error for disappeared entries (e.g.

if the same directory is being removed in a parallel thread for example).

Same as eRecursiveIgnoreMissing, but process all possible entries.

Do not break processing if it cannot ptocess some entries due permission or other errors.

Definition at line 704 of file ncbifile.hpp.

How to interpret relative paths.

See also

CreateAbsolutePath

Relative to the current working directory.

Relative to the executable's location.

If the executable was invoked via a symlink, search the directory containing the symlink before the directory (if different) containing the actual binary.

Definition at line 434 of file ncbifile.hpp.

What to do with the file on object destruction.

Remove file.

Do not remove file.

Definition at line 2365 of file ncbifile.hpp.

Rename flags.

Remove destination if it exists.

Update older entries only (compare modification times).

Backup destination if it exists before renaming.

If destination entry exists, it must have the same type as source.

Rename entries following sym.links, not the links themselves.

Default flags.

Definition at line 610 of file ncbifile.hpp.

Sharing mode for opened file.

Note

If OS does not support sharing mode for files, that it will be ignored. But you can use CFileLock to lock a file or its part.

See also

CFileLock

Enables subsequent open operations on the file that request read access.

Otherwise, other processes cannot open the file for reading.

Enables subsequent open operations on the file that request write access.

Otherwise, other processes cannot open the file for writing.

Combines both eShareRead and eShareWrite modes.

Open file for exclusive access.

Disables any subsequent open operations on the file.

Definition at line 3455 of file ncbifile.hpp.

Sorting mode.

Sort by full path (default)

Directory name.

Full file name.

Base file name.

File extension.

Definition at line 3395 of file ncbifile.hpp.

Definition at line 1175 of file ncbifile.hpp.

What type of temporary file to create.

Create text file.

Create binary file.

Definition at line 1475 of file ncbifile.hpp.

Temporary file creation mode.

Create empty file for each GetTmpName* call.

Get name of the file only.

Definition at line 1414 of file ncbifile.hpp.

Directory entry type.

Regular file.

Directory.

Pipe.

Symbolic link (UNIX only)

Symbolic link (UNIX only)

Socket (UNIX only)

Door (UNIX only)

Block special (UNIX only)

Character special.

Unknown type.

Definition at line 783 of file ncbifile.hpp.

Type of file lock.

Shared lock allows all processes to read from the locked portion of the file, while denying to write into it. Exclusive lock denies other processes both read and write to the locked portion of the file, while allowing the locking process to read or write through a specified or obtained file handle.

"read" lock.

"write" lock.

Definition at line 3796 of file ncbifile.hpp.

Which default mode: user, group, or other.

Used as an index into an array that contains default mode values; so there is no "fDefault" as an enumeration value for EWho here!

User mode.

Group mode.

Other mode.

Special bits.

Definition at line 1571 of file ncbifile.hpp.

Add trailing path separator, if needed.

Definition at line 455 of file ncbifile.cpp.

References ALL_SEPARATORS, CDirEntry::GetPathSeparator(), len, and NPOS.

Referenced by CMsvcPrjProjectContext::AdditionalIncludeDirectories(), CMsvcPrjProjectContext::AdditionalLibraryDirectories(), BDB_CreateEnv(), CFastaOstreamComp::CFastaOstreamComp(), CMsvcPrjGeneralContext::CMsvcPrjGeneralContext(), CMsvcPrjProjectContext::CMsvcPrjProjectContext(), CDirEntry::ConcatPath(), CQueueDataBase::CQueueDataBase(), SMakeProjectT::CreateIncludeDirs(), CDirEntry::CreateRelativePath(), CFileIO::CreateTemporary(), SAsnProjectMultipleT::DoCreate(), FindFilesInDir(), CProjBulderApp::GenerateMsvcProjects(), CProjBulderApp::GenerateUnixProjects(), CProjBulderApp::GetBuildDir(), CDir::GetEntriesPtr(), CDir::GetHome(), CProjBulderApp::GetProjectTreeInfo(), CProjBulderApp::GetProjectTreeRoot(), CMsvcMetaMakefile::GetUsePchThroughHeader(), CProjBulderApp::GetUtilityProjectsDir(), CProjBulderApp::GetUtilityProjectsSrcDir(), IdentifySlnGUID(), CProjectsLstFileFilter::InitFromString(), CNetScheduleServer::InitNodeID(), CConfigurationImpl< ConfTrait >::IntermediateDirectory(), CDirEntry::MakePath(), SGridWorkerNodeImpl::OfflineRun(), CBDB_Cache::Open(), CBDB_Volumes::Open(), CBDB_Cache::OpenReadOnly(), ParentDir(), CProjBulderApp::ParseArguments(), CTbl2AsnApp::Run(), CTAbleValApp::Run(), s_InitializeECNumberMaps(), s_ToArchiveName(), CBDB_Cache::SameCacheParams(), CArchive::SetBaseDir(), CBDB_ExtBlobStore< TBV >::SetStoreAttrDir(), CBDB_ExtBlobStore< TBV >::SetStoreDataDir(), CBDB_Cache::Verify(), CProjBulderApp::VerifyArguments(), and x_Glob().

Backup an entry.

Create a copy of the current entry with the same name and an extension specified by SetBackupSuffix(). By default this extension is ".bak". Backups can be automatically created in 'copy' or 'rename' operations. If an entry with the name of the backup already exists, then it will be deleted (if possible). The current entry name components are changed to reflect the backed up copy.

Parameters

suffix Extension to add to backup entry. If empty, GetBackupSuffix() is be used. mode Backup mode. Specifies what to do, copy the entry or just rename it. copyflags Flags to copy the entry. Used only if mode is eBackup_Copy, copybufsize Buffer size to use while copying the file contents. Used only if 'mode' is eBackup_Copy,

Returns

TRUE if backup created successfully; FALSE otherwise.

See also

EBackupMode

Definition at line 2634 of file ncbifile.cpp.

References _TROUBLE, CDirEntry::Copy(), CDirEntry::DeleteTrailingPathSeparator(), CDirEntry::eBackup_Copy, CDirEntry::eBackup_Rename, CDirEntry::fCF_Backup, CDirEntry::fCF_Overwrite, CDirEntry::fCF_TopDirOnly, CDirEntry::fCF_Update, flags, CDirEntry::fRF_Overwrite, CDirEntry::GetBackupSuffix(), CDirEntry::GetPath(), CDirEntry::Rename(), and string.

Referenced by CFile::Copy(), CDir::Copy(), CSymLink::Copy(), CDirEntry::Rename(), and CArchive::x_ExtractEntry().

Check access rights.

Use effective user ID (or process owner) to check the entry for accessibility accordingly to specified mask.

Note

• If an entry is a symbolic link, that the access rights will be checked for entry to which the link points.
• Execute bit means 'search' for directories.
• Success checking fExecute mode do not guarantee that the file will executable at all. This function just check permissions and not the file format.
• On some platforms, if the file is currently open for execution, the function reports that it is not writable, regardless of the setting of its mode.

This method may not work correctly On MS-Windows:

• for network shares and mapped network drives. On Unix:
• for entries on NFS file systems.

Using CheckAccess() to check if a user is authorized to e.g. open a file before actually doing so creates a security hole, because the user might exploit the short time interval between checking and opening the file to manipulate it. Always is better to try to open a file with necessary permissions and check result.

Parameters

access_mode Checked access mode (any combination of fRead/fWrite/fExecute).

Returns

TRUE if specified permissions granted, FALSE otherwise (also returns FALSE if the file doesn't exists or an error occurs).

See also

GetMode

Definition at line 1720 of file ncbifile.cpp.

References CDirEntry::fExecute, CDirEntry::fRead, CDirEntry::fWrite, CWinSecurity::GetFilePermissions(), CDirEntry::GetPath(), mask, s_CheckAccessPath(), and CNcbiError::SetFromErrno().

Referenced by CBuildDatabase::CreateDirectories(), GetIndexSuperHeader(), CwxSavePdfBaseDlg::OnSaveClick(), CwxExportAlnmultiImgDlg::OnSaveClick(), CwxExportVectorImageDlg::OnSaveClick(), SGridWorkerNodeImpl::Run(), and CAsn2FastaApp::x_ProcessISubdirectory().

Close file.

Definition at line 6638 of file ncbifile.cpp.

References _T_XCSTRING, close(), CFileIO::eDoNotRemove, kInvalidHandle, CFileIO::m_AutoRemove, CFileIO::m_Handle, CFileIO::m_Pathname, NCBI_THROW, and NcbiSys_remove.

Referenced by CNetCacheReader::Close(), CVCFVariantList::CVCFVariantList(), NVcfUtil::DeserializeColumn(), CDirEntry::GetTmpNameEx(), CArchiveMemory::Load(), NVcfUtil::PrintToFile(), CArchiveMemory::Save(), CFileIO::SetFileHandle(), CColumnarVCFReaderApp::x_ReadVCFBlob(), and CFileIO::~CFileIO().

Constructor.

Initialize memory mapping for file "file_name".

Parameters

filename Name of file to map to memory. protect_attr Specify operations permitted on memory mapped file. share_attr Specify if change to memory mapped file can be shared or not. offset The file offset where mapping is to begin. length Number of bytes to map. The value 0 means that all file size will be mapped. mode File open mode. max_file_len The size of created file if 'mode' parameter is eCreate or eExtend. File will be never truncated if open mode is eExtend and real file size is more that specified maximum length.

See also

EMemMapProtect, EMemMapShare, EOpenMode

EMemMapProtect, EMemMapShare, Map

Note

MS Windows: If file is open in eMMP_Read mode with eMMS_Private protection, that memory pages will be mapped in exclusive mode, and any other process cannot access the same file for writing.

Definition at line 6107 of file ncbifile.cpp.

References SMemoryFileHandle::hMap, kInvalidHandle, CMemoryFileMap::m_Handle, CMemoryFile::Map(), and offset.

Constructor.

Initialize the memory mapping on file "file_name".

Parameters

filename Name of file to map to memory. protect_attr Specify operations permitted on memory mapped file. share_attr Specify if change to memory mapped file can be shared or not. mode File open mode. max_file_len The size of created file if 'mode' parameter is eCreate or eExtend. File will be never truncated if open mode is eExtend and real file size is more that specified maximum length.

See also

EMemMapProtect, EMemMapShare, EOpenMode

Note

MS Windows: If file is open in eMMP_Read mode with eMMS_Private protection, that memory pages will be mapped in exclusive mode, and any other process cannot access the same file for writing.

Definition at line 5726 of file ncbifile.cpp.

References CMemoryFile_Base::eCreate, CMemoryFile_Base::eExtend, CMemoryFileMap::GetFileSize(), SMemoryFileHandle::hMap, kInvalidHandle, CMemoryFileMap::m_Attrs, CMemoryFileMap::m_FileName, CMemoryFileMap::m_Handle, NCBI_THROW, NStr::ReplaceInPlace(), s_TranslateAttrs(), SMemoryFileHandle::sFileName, CMemoryFileMap::x_Create(), CMemoryFileMap::x_Extend(), and CMemoryFileMap::x_Open().

Constructor.

Maps a view of the file, represented by "handle", into the address space of the calling process.

Parameters

handle Handle to view of the mapped file. attr Specify operations permitted on memory mapped region. offset The file offset where mapping is to begin. Cannot accept values less than 0. length Number of bytes to map. The parameter value should be more than 0.

See also

EMemMapProtect, EMemMapShare, GetPtr, GetSize, GetOffset

Definition at line 5599 of file ncbifile.cpp.

References CSystemInfo::GetVirtualMemoryAllocationGranularity(), SMemoryFileHandle::hMap, NStr::Int8ToString(), CMemoryFileSegment::m_DataPtr, CMemoryFileSegment::m_DataPtrReal, CMemoryFileSegment::m_Length, CMemoryFileSegment::m_LengthReal, CMemoryFileSegment::m_Offset, CMemoryFileSegment::m_OffsetReal, SMemoryFileAttrs::map_access, SMemoryFileAttrs::map_protect, NCBI_THROW, NcbiSys_strerror, SMemoryFileHandle::sFileName, and WIN_LAST_ERROR_STR.

Compare files contents in binary form.

Parameters

file File name to compare. buf_size Size of buffer to read file. Zero value means using default buffer size.

Returns

TRUE if files content is equal; FALSE otherwise.

Definition at line 3459 of file ncbifile.cpp.

References CNcbiError::eIoError, CFileIO_Base::eOpen, CNcbiError::eOperationNotPermitted, CFileIO_Base::eRead, CFileIO::GetFileSize(), CDirEntry::GetPath(), kDefaultBufferSize, LOG_ERROR_NCBI, memmove, min(), n, CFileIO::Open(), CFileIO::Read(), and x_size().

Referenced by CFile::Copy().

Concatenate two parts of the path for the current OS.

Note that the arguments must be OS-specific.

Parameters

first First part of the path which can be either absolute or relative. second Second part of the path must always be relative.

Returns

The concatenated path.

Definition at line 776 of file ncbifile.cpp.

References CDirEntry::AddTrailingPathSeparator(), DIR_SEPARATOR, first(), and NStr::TruncateSpaces().

Referenced by CSimpleMakeFileContents::SParser::AcceptLine(), CMsvcPrjProjectContext::AdditionalIncludeDirectories(), CMsvcPrjProjectContext::AdditionalLibraryDirectories(), CMsvcPrjProjectContext::AdditionalLinkerOptions(), CMakeProject::AddSourceFile(), CMsvcConfigure::AnalyzeDefines(), BOOST_AUTO_TEST_CASE(), CProjectTreeBuilder::BuildOneProjectTree(), CMsvcCombinedProjectMakefile::CMsvcCombinedProjectMakefile(), CMsvcPrjGeneralContext::CMsvcPrjGeneralContext(), CMsvcPrjProjectContext::CMsvcPrjProjectContext(), CMsvcSite::CMsvcSite(), CMsvcPrjFilesCollector::CollectExtra(), CMsvcPrjFilesCollector::CollectResources(), CMsvcPrjFilesCollector::CollectSources(), CDirEntry::CreateAbsolutePath(), CProjBulderApp::CreateCheckList(), CreateConfigurableFile(), CreateDllBuildTree(), CProjBulderApp::CreateFeaturesAndPackagesFiles(), SMakeProjectT::CreateFullPathes(), SMakeProjectT::CreateIncludeDirs(), SMakeProjectT::CreateMakeAppLibFileName(), SAsnProjectSingleT::DoCreate(), SAsnProjectMultipleT::DoCreate(), SAppProjectT::DoCreate(), SLibProjectT::DoCreate(), SMsvcProjectT::DoCreate(), CIgBlastArgs::ExtractAlgorithmOptions(), CProjBulderApp::FindDepGraph(), CCodeGenerator::GenerateModuleCPP(), CProjBulderApp::GenerateMsvcProjects(), CProjBulderApp::GenerateSummary(), CProjBulderApp::GenerateUnixProjects(), NASNCacheFileName::GetBDBIndex(), CProjBulderApp::GetBuildDir(), CProjBulderApp::GetConfigureMacro(), CMsvcProjectMakefile::GetCustomBuildInfo(), CMsvcSite::GetLibChoiceIncludes(), CProjBulderApp::GetMetaMakefile(), CMsvcPrjProjectContext::GetMsvcProjectMakefile(), CProjItem::GetPath(), CProjBulderApp::GetProjectTreeInfo(), CProjBulderApp::GetProjectTreeRoot(), SMakeProjectT::GetProjType(), NASNCacheFileName::GetSeqIdChunk(), CMsvc7RegSettings::GetTopBuilddir(), CMsvcMetaMakefile::GetUsePchThroughHeader(), CProjBulderApp::GetUtilityProjectsDir(), CProjBulderApp::GetUtilityProjectsSrcDir(), CPhyloPdfGrabber::GrabImages(), IImageGrabber::GrabImages(), CPdfGrabber::GrabImages(), CSVGGrabber::GrabImages(), IdentifySlnGUID(), CTestBMApp::Init(), CConfigurationImpl< ConfTrait >::IntermediateDirectory(), CMsvcSite::IsLibOk(), IsProducedByDatatool(), CDataToolGeneratedSrc::LoadFrom(), CwxSavePdfBaseDlg::OnSaveClick(), CwxExportAlnmultiImgDlg::OnSaveClick(), CwxExportVectorImageDlg::OnSaveClick(), CwxExportVectorImageDlg::OnTimer(), CProjBulderApp::ParseArguments(), CProjectTreeBuilder::ProcessDir(), CProjBulderApp::ProcessLocationMacros(), CFastCgiMTSampleRequestProcessor::ProcessRequest(), CProjBulderApp::RegisterProjectWatcher(), CProjBulderApp::ReportGeneratedFiles(), CProjSRCResolver::ResolveTo(), CSplignApp::Run(), CLDS2IndexerApplication::Run(), CDemoApp::Run(), CProjBulderApp::Run(), s_AddProjItemToDll(), s_CollectDatatoolIds(), s_ConvertRelativePaths(), s_CreateThirdPartyLibsInstallMakefile(), s_GetMakefileIncludes(), s_InitalizeDllProj(), CChunkFile::s_MakeChunkFileName(), s_ProcessParameters(), s_ResetLibInstallKey(), s_SourceFileExists(), s_StoreStartupParams(), s_ToFilesystemPath(), s_WriteBuildOrder(), CNetScheduleJobSerializer::SaveJobInput(), CNetScheduleJobSerializer::SaveJobOutput(), SetLogFileName(), CDiagContext::SetupDiag(), sUpdateCase(), CNcbiEncrypt::sx_InitKeyMap(), CProjBulderApp::VerifyArguments(), CMakeNode::Write(), CMakeProject::Write(), CMsvcConfigure::WriteBuildVer(), CMsvcConfigure::WriteExtraDefines(), CPhyloPdfGrabber::x_BeginCaptures(), CPdfGrabber::x_BeginCaptures(), CSVGGrabber::x_BeginCaptures(), CDumpASNIndex::x_CreateRootDir(), CDownloadJob::x_DownloadAndExtract(), CArchive::x_ExtractEntry(), CMetaRegistry::x_FindRegistry(), CDll::x_Init(), CRegexpTemplateTester::x_Op_Include(), CTar::x_ReadEntryInfo(), CArchive::x_RestoreAttrs(), CSaveHitMatrixPdfDlg::x_SavePdf(), CSaveTreePdfDlg::x_SavePdf(), CTestBMApp::x_Serialize(), CBLASTDatabases::x_UpdateDbMap(), and CDumpASNIndex::x_WriteHeader().

Concatenate two parts of the path for any OS.

Note that the arguments are not OS-specific.

Parameters

first First part of the path which can be either absolute or relative. second Second part of the path must always be relative.

Returns

The concatenated path.

Definition at line 791 of file ncbifile.cpp.

References ALL_OS_SEPARATORS, CTempString::find_last_of(), first(), CDirEntry::GetPathSeparator(), kEmptyStr, NPOS, CTempString::size(), string, CTempString::substr(), and NStr::TruncateSpaces_Unsafe().

Referenced by CMacroFlowEditor::CopyDefaultLibrary(), CProjectsLstFileFilter::InitFromFile(), s_ExpandProjectFolder(), s_UpdateMacros(), and NMacroStats::SaveScriptToFile().

Convert "path" on any OS to the current OS-dependent path.

Converts related paths, normalizes absolute.

See also

IsAbsolutePath, NormalizePath

Definition at line 745 of file ncbifile.cpp.

References DIR_CURRENT, DIR_PARENT, DIR_SEPARATOR, NStr::EndsWith(), i, CDirEntry::IsAbsolutePathEx(), and CDirEntry::NormalizePath().

Referenced by BOOST_AUTO_TEST_CASE(), CProjectTreeBuilder::BuildOneProjectTree(), CDiagFileHandleHolder::CDiagFileHandleHolder(), CMsvcSite::CMsvcSite(), CProjBulderApp::FindDepGraph(), CCodeGenerator::GenerateFileList(), CMsvcMetaMakefile::GetPchInfo(), CProjBulderApp::GetProjectTreeInfo(), CProjBulderApp::GetRegSettings(), CProjectsLstFileFilter::InitFromFile(), CHugeFileDemoApp::Run(), and CMsvcConfigure::WriteBuildVer().

Copy the entry to a location specified by "new_path".

The Copy() method must be overloaded in derived classes that support copy operation.

Parameters

new_path New path/name of an entry. flags Flags specifying how to copy the entry. buf_size Buffer size to use while copying the file contents. Zero value means using default buffer size. This parameter have advisory status and can be override, depends from OS and size of copied file.

Returns

TRUE if the operation was completed successfully; FALSE, otherwise.

See also

CFile::Copy, CDir::Copy, CLink::Copy, CopyToDir

Reimplemented in CSymLink, CDir, and CFile.

Definition at line 2428 of file ncbifile.cpp.

References CFile::Copy(), CDir::Copy(), CSymLink::Copy(), CDirEntry::eDir, CDirEntry::eFile, eFollowLinks, eIgnoreLinks, CDirEntry::eLink, CNcbiError::eNoSuchFileOrDirectory, CNcbiError::eNotSupported, CDirEntry::eUnknown, F_ISSET, CDirEntry::fCF_FollowLinks, CDirEntry::fCF_SkipUnsupported, flags, CDirEntry::GetPath(), CDirEntry::GetType(), and CNcbiError::Set().

Referenced by CDirEntry::Backup(), BOOST_AUTO_TEST_CASE(), CDirEntry::CopyToDir(), CBlastdbConvertApp::Run(), sRunTest(), and CTar::x_ExtractEntry().

Copy a file.

Parameters

new_path Target entry path/name. flags Flags specified how to copy entry. buf_size Size of buffer to read file. Zero value means using default buffer size.

Returns

TRUE if operation successful; FALSE, otherwise.

See also

TCopyFlags

Reimplemented from CDirEntry.

Definition at line 3334 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::Backup(), CFile::Compare(), CDirEntry::DereferenceLink(), CDirEntry::eBackup_Rename, CDirEntry::eFile, CNcbiError::eIoError, CNcbiError::eOperationNotPermitted, CDirEntry::eUnknown, F_ISSET, FALSE, CDirEntry::fCF_Backup, CDirEntry::fCF_EqualTypes, CDirEntry::fCF_FollowLinks, CDirEntry::fCF_Overwrite, CDirEntry::fCF_PreserveAll, CDirEntry::fCF_PreservePerm, CDirEntry::fCF_PreserveTime, CDirEntry::fCF_Safe, CDirEntry::fCF_Update, CDirEntry::fCF_Verify, flags, CDirEntry::fRF_Overwrite, CDirEntry::GetBackupSuffix(), CDir::GetCwd(), CDirEntry::GetPath(), CDirEntry::GetTmpNameEx(), CDirEntry::GetType(), CDirEntry::IsIdentical(), CDirEntry::IsNewer(), kTmpSafeSuffix, LOG_ERROR, LOG_ERROR_ERRNO, LOG_ERROR_NCBI, LOG_ERROR_WIN, CDirEntry::Remove(), CDirEntry::RemoveEntry(), CDirEntry::Rename(), CDirEntry::Reset(), s_CopyAttrs(), CDirEntry::SplitPath(), and tmp.

Referenced by CDirEntry::Copy(), CSymLink::Copy(), CMacroFlowEditor::CopyDefaultLibrary(), PostProcessFile(), sRunTest(), and CMsvcConfigure::WriteBuildVer().

Copy directory.

Parameters

new_path New path/name for entry. flags Flags specified how to copy directory. buf_size Size of buffer to read file. Zero value means using default buffer size.

Returns

TRUE if operation successful; FALSE, otherwise.

See also

CDirEntry::TCopyFlags, CDirEntry::Copy, CFile::Copy

Reimplemented from CDirEntry.

Definition at line 4187 of file ncbifile.cpp.

References CDirEntry::Backup(), CDirEntry::CopyToDir(), CDir::CreatePath(), CDirEntry::DereferenceLink(), CDirEntry::eBackup_Rename, CDirEntry::eDir, eFollowLinks, eIgnoreLinks, CNcbiError::eNoSuchFileOrDirectory, CNcbiError::eOperationNotPermitted, CDirEntry::eUnknown, F_ISSET, CDirEntry::fCF_Backup, CDirEntry::fCF_EqualTypes, CDirEntry::fCF_FollowLinks, CDirEntry::fCF_Overwrite, CDirEntry::fCF_PreserveAll, CDirEntry::fCF_Recursive, CDirEntry::fCF_Safe, CDirEntry::fCF_TopDirOnly, CDirEntry::fCF_Update, CDirEntry::fDefault, flags, CDirEntry::fRF_Overwrite, CDirEntry::GetBackupSuffix(), CDir::GetCwd(), CDir::GetEntriesPtr(), CDirEntry::GetPath(), CDirEntry::GetTmpNameEx(), CDirEntry::GetType(), CDirEntry::IsDir(), CDirEntry::IsIdentical(), CDirEntry::IsNewer(), ITERATE, kEmptyStr, kTmpSafeSuffix, LOG_ERROR, LOG_ERROR_NCBI, NCBI, NCBI_PARAM_TYPE, CDir::Remove(), CDirEntry::Rename(), CDirEntry::Reset(), s_CopyAttrs(), CDir::SetMode(), CDirEntry::SplitPath(), and tmp.

Referenced by CDirEntry::Copy(), and CSymLink::Copy().

Copy link.

Parameters

new_path Target entry path/name. flags Flags specified how to copy entry. buf_size Size of buffer to read file. Zero value means using default buffer size.

Returns

TRUE if operation successful; FALSE, otherwise.

See also

CDirEntry::TCopyFlags, CDirEntry::Copy, Create

Reimplemented from CDirEntry.

Definition at line 4597 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::Backup(), buf, CDirEntry::CDirEntry(), CFile::Copy(), CDir::Copy(), CSymLink::Copy(), CDirEntry::eBackup_Rename, CDirEntry::eDir, CDirEntry::eFile, eFollowLinks, eIgnoreLinks, CNcbiError::eInvalidArgument, CNcbiError::eIoError, CDirEntry::eLink, CNcbiError::eNoSuchFileOrDirectory, CNcbiError::eOperationNotPermitted, CDirEntry::eUnknown, F_ISSET, CDirEntry::fCF_Backup, CDirEntry::fCF_EqualTypes, CDirEntry::fCF_FollowLinks, CDirEntry::fCF_Overwrite, CDirEntry::fCF_PreserveAll, CDirEntry::fCF_Safe, CDirEntry::fCF_Update, flags, CDirEntry::fRF_Overwrite, CDirEntry::GetBackupSuffix(), CDir::GetCwd(), CDirEntry::GetPath(), CDirEntry::GetTmpNameEx(), CDirEntry::GetType(), int, CDirEntry::IsIdentical(), CDirEntry::IsNewer(), kTmpSafeSuffix, len, LOG_ERROR, LOG_ERROR_ERRNO, LOG_ERROR_NCBI, PATH_MAX, CDirEntry::Remove(), CDirEntry::Rename(), CDirEntry::Reset(), s_CopyAttrs(), CDirEntry::SplitPath(), and tmp.

Referenced by CDirEntry::Copy(), and CSymLink::Copy().

Create symbolic link.

Parameters

path Path to some entry that link will be pointed to.

Returns

TRUE if operation successful; FALSE, otherwise. Return FALSE also if link already exists.

Definition at line 4572 of file ncbifile.cpp.

References _T_XCSTRING, buf, CNcbiError::eNotSupported, CDirEntry::GetPath(), int, len, LOG_ERROR_ERRNO, LOG_ERROR_NCBI, PATH_MAX, and util::strcmp().

Referenced by CTar::x_ExtractEntry().

Create the directory using "dirname" passed in the constructor.

Default directory creation mode:

• TRUE if directory already exists;
• don't change permissions if already exists;
• use default mode for created directory

  Returns

  TRUE if operation successful; FALSE, otherwise.

  See also

  SetDefaultMode, SetDefaultModeGlobal, CFileAPI::SetHonorUmask, CreatePath

Definition at line 4069 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::CreateAbsolutePath(), CDirEntry::DeleteTrailingPathSeparator(), CNcbiError::eInvalidArgument, ctll::empty(), CNcbiError::eNoSuchFileOrDirectory, F_ISSET, flags, CDirEntry::GetDefaultModeT(), CDirEntry::GetDir(), CDirEntry::GetPath(), LOG_ERROR_ERRNO, LOG_ERROR_NCBI, NcbiSys_stat, s_DirCreate(), and st().

Referenced by BDB_CreateEnv(), CMacroFlowEditor::CopyDefaultLibrary(), CAgpFastaComparator::CTmpSeqVecStorage::CTmpSeqVecStorage(), CBDB_Cache::Open(), CSQLITE3_Cache::Open(), CBDB_Volumes::Open(), CBDB_ExtBlobStore< TBV >::Open(), CSplignApp::Run(), CTbl2AsnApp::Run(), CTAbleValApp::Run(), CSeqAnnotSplicerApp::Run(), s_EnsureDirExist(), NMacroStats::SaveScriptToFile(), CBDB_Env::SetLogDir(), CSplitCacheApp::SetupCache(), CAsnvalApp::ValidateOneDirectory(), CQueueDataBase::x_CreateSpaceReserveFile(), CQueueDataBase::x_Dump(), and CQueueDataBase::x_Open().

Get an absolute path from some, possibly relative, path.

Parameters

path Path to resolve, in native syntax; returned as is if absolute. rtw Starting point for relative path resolution – the current directory by default, but looking alongside the executable is also an option.

Returns

Corresponding absolute path. May be the original string (if already absolute) or the starting point indicated by rtw (if the input was empty or ".").

See also

ERelativeToWhat, CreateAbsolutePath

Definition at line 665 of file ncbifile.cpp.

References CDirEntry::CDirEntry(), CDirEntry::ConcatPath(), DISK_SEPARATOR, CNcbiApplicationAPI::eFullName, CNcbiApplicationAPI::eRealName, CDirEntry::eRelativeToCwd, CDirEntry::eRelativeToExe, CDirEntry::Exists(), CNcbiApplicationAPI::GetAppName(), CDir::GetCwd(), CDirEntry::IsAbsolutePath(), NCBI_THROW, CDirEntry::NormalizePath(), NPOS, result, s_Win_IsNetworkPath(), and CDirEntry::SplitPath().

Referenced by CFileDeleteList::Add(), CLDS2_Manager::AddDataFile(), CAlignSort::CAlignSort(), CAsnCache::CAsnCache(), CAsnCacheStore::CAsnCacheStore(), CBDB_SplitCursor< BDB_SplitStore, BDB_Vol >::CBDB_SplitCursor(), CBuildDatabase::CBuildDatabase(), CVPath::ConvertSysPathToPOSIX(), CDir::Create(), CCgiApplication::CreateFastCGIWatchFile(), CDir::CreatePath(), FindFiles(), CHugeFileProcess::ForEachEntry(), GetAbsolutePath(), CFileManifest::GetAllFilePaths(), CLDS2_DataLoader::GetLoaderNameFromArgs(), NCBITEST_AUTO_INIT(), CDownloadJob::Run(), CBlastdbConvertApp::Run(), CSplignApp::Run(), CCleanupApp::Run(), CDiscRepApp::Run(), CTbl2AsnApp::Run(), COmssa2pepxmlApplication::Run(), CGffDeconcatApp::Run(), s_GetFileName(), s_GetIndexFileName(), CFileHandleDiagHandler::SetLogName(), CFileDiagHandler::SetLogName(), sx_GetVPath(), TraverseAndRunTestCases(), CAsnvalThreadState::ValidateOneHugeBlob(), CDownloadJob::x_DownloadAndExtract(), CBDB_Cache::x_PidLock(), and CDataLoadersUtil::x_SetupLDS2DataLoader().

Construct a directory entry object of a specified type.

An object of specified type will be constructed in memory only, file system will not be modified.

Parameters

type Define a type of the object to create.

Returns

A pointer to newly created entry. If a class for specified type is not defined, generic CDirEntry will be returned. Do not forget to delete the returned pointer when it is no longer used.

See also

CFile, CDir, CSymLink

Definition at line 277 of file ncbifile.cpp.

References CDirEntry::CDirEntry(), CDirEntry::eDir, CDirEntry::eFile, and CDirEntry::eLink.

Referenced by CDirEntry::Rename(), s_AddEntry(), CArchive::x_ExtractEntry(), CTar::x_ProcessEntry(), and CArchive::x_RestoreAttrs().

Create the directory path recursively possibly more than one at a time.

Returns

TRUE if operation successful; FALSE otherwise.

See also

Create

Definition at line 4104 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::CreateAbsolutePath(), DIR_SEPARATORS, CNcbiError::eInvalidArgument, ctll::empty(), CDirEntry::Exists(), F_ISSET, flags, CDirEntry::GetDefaultModeT(), CDirEntry::GetDir(), CDirEntry::GetPath(), CDirEntry::GetPathSeparator(), i, LOG_ERROR, LOG_ERROR_ERRNO, LOG_ERROR_NCBI, NCBI_OS_MSWIN, NcbiSys_stat, NPOS, s_DirCreate(), st(), and tmp.

Referenced by CMsvcConfigure::AnalyzeDefines(), CArg_Dir::AsDirectory(), CAlignSort::CAlignSort(), CFileDBEngine::CFileDBEngine(), CNetStorageServer::CheckStartAfterCrash(), CMultiFileDestination::CMultiFileDestination(), CDir::Copy(), CFileDBEngine::CreateBlob(), CProjBulderApp::CreateCheckList(), CreateConfigurableFile(), CBuildDatabase::CreateDirectories(), CProjBulderApp::CreateFeaturesAndPackagesFiles(), CFileCode::CreateFileFolder(), CRemoteAppRemoverTask::CRemoteAppRemoverTask(), CFileDBEngine::DropDB(), CSplitCacheApp::GetFileName(), CProjBulderApp::ParseArguments(), CPrimeCacheApplication::Run(), CAsnSubCacheCreateApplication::Run(), s_CreateThirdPartyLibsInstallMakefile(), s_ExpandProjectFolder(), CMakeNode::Write(), CMakeProject::Write(), CMsvcConfigure::WriteBuildVer(), CMsvcConfigure::WriteExtraDefines(), CArg_Ios::x_CreatePath(), CDumpASNIndex::x_CreateRootDir(), CRemoteAppRequest::x_CreateWDir(), and CTar::x_ExtractEntry().

Create a relative path between two points in the file system specified by their absolute paths.

Parameters

path_from Absolute path that defines start of the relative path. path_to Absolute path that defines endpoint of the relative path.

Returns

Relative path (empty string if the paths are the same). Throw CFileException on error (e.g. if any of the paths is not absolute, or if it is impossible to create a relative path, such as in case of different disks on MS-Windows).

Definition at line 599 of file ncbifile.cpp.

References CDirEntry::AddTrailingPathSeparator(), NStr::Compare(), DIR_PARTS_CMP_MODE, CDirEntry::GetPathSeparator(), i, CDirEntry::IsAbsolutePath(), min(), NCBI_THROW, s_StripDir(), and CDirEntry::SplitPath().

Referenced by CProjBulderApp::AddCustomMetaData(), CMsvcPrjProjectContext::AdditionalIncludeDirectories(), CMsvcPrjProjectContext::AdditionalLibraryDirectories(), CProjectsLstFileFilter::CheckProject(), CMsvcPrjGeneralContext::CMsvcPrjGeneralContext(), CMsvcPrjProjectContext::CMsvcPrjProjectContext(), CMsvcPrjFilesCollector::CollectExtra(), CMsvcPrjFilesCollector::CollectResources(), CMsvcPrjFilesCollector::CollectSources(), CProjectTreeFolders::CreatePath(), SAsnProjectSingleT::DoCreate(), SAsnProjectMultipleT::DoCreate(), SAppProjectT::DoCreate(), SMsvcProjectT::DoCreate(), CProjBulderApp::GenerateUnixProjects(), CProjBulderApp::GetUtilityProjectsSrcDir(), IdentifySlnGUID(), CProjectsLstFileFilter::InitFromString(), CProjBulderApp::ParseArguments(), CProjectTreeBuilder::ProcessDir(), CProjBulderApp::RegisterProjectWatcher(), CProjBulderApp::ReportGeneratedFiles(), CProjSRCResolver::ResolveTo(), s_AddProjItemToDll(), s_CollectDatatoolIds(), s_CollectRelPathes(), s_ConvertRelativePaths(), s_InitalizeDllProj(), and CMsvcConfigure::WriteNcbiconfMsvcSite().

Create temporary file in the specified directory.

The prefix argument is used to generate a unique file name.

Definition at line 6559 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::AddTrailingPathSeparator(), buffer, CFileIO_Base::eCreateNew, CFileIO_Base::eReadWrite, CFileIO::eRemoveASAP, CDir::GetAppTmpDir(), GetCurrentThreadSystemID(), CCurrentProcess::GetPid(), int, kInvalidHandle, CFileIO::m_AutoClose, CFileIO::m_AutoRemove, CFileIO::m_Handle, CFileIO::m_Pathname, max(), NCBI_THROW, NcbiSys_remove, NULL, NStr::NumericToString(), CFileIO::Open(), PATH_MAX, and s_Count().

Referenced by CNetCacheReader::CNetCacheReader(), CNetCacheWriter::CNetCacheWriter(), and CDirEntry::GetTmpNameEx().

Create temporary file and return pointer to corresponding stream.

The temporary file will be automatically deleted after the stream object is deleted. If the file exists before the function call, then after the function call it will be removed. Also any previous contents of the file will be overwritten.

Parameters

filename Use this value as name of temporary file. If "kEmptyStr" is passed generate a temporary file name. text_binary Specifies if temporary filename should be text ("eText") or binary ("eBinary"). allow_read If set to "eAllowRead", read and write are permitted on temporary file. If set to "eWriteOnly", only write is permitted on temporary file.

Returns

• Pointer to corresponding stream, or
• NULL if error encountered.

See also

CreateTmpFileEx

Definition at line 2985 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::eAllowRead, CDirEntry::eBinary, CNcbiError::eNoSuchFileOrDirectory, CDirEntry::eTmpFileCreate, file, CDirEntry::GetTmpName(), in(), LOG_ERROR, LOG_ERROR_ERRNO, LOG_ERROR_NCBI, NcbiSys_fopen, out(), and trunc.

Referenced by CDirEntry::CreateTmpFileEx(), s_GetBigBedFeats(), s_GetBigBedSummary(), s_GetData(), CWigGraph::x_GetBigWigData(), CWigGraph::x_GetBigWigSummary(), and CRemoteBlast::x_GetSearchResultsHTTP().

Create temporary file and return pointer to corresponding stream.

Similar to CreateTmpEx() except that you can also specify the directory in which to create the temporary file and the prefix string to be used for creating the temporary file.

The temporary file will be automatically deleted after the stream object is deleted. If the file exists before the function call, then after the function call it will be removed. Also any previous contents of the file will be overwritten.

Parameters

dir The directory in which the temporary file is to be created. If not specified, the temporary file will be created in the current directory. prefix Use this value as the prefix for temporary file name. If "kEmptyStr" is passed generate a temporary file name. text_binary Specifies if temporary filename should be text ("eText") or binary ("eBinary"). allow_read If set to "eAllowRead", read and write are permitted on temporary file. If set to "eWriteOnly", only write is permitted on temporary file.

Returns

• Pointer to corresponding stream, or
• NULL if error encountered.

See also

CreateTmpFile

Definition at line 3038 of file ncbifile.cpp.

References CDirEntry::CreateTmpFile(), CDirEntry::eTmpFileCreate, and CDirEntry::GetTmpNameEx().

Constructor using specified path string.

Definition at line 4153 of file ncbifile.hpp.

Constructor.

Use given temporary file name.

Definition at line 5396 of file ncbifile.cpp.

Delete trailing path separator, if any.

Definition at line 465 of file ncbifile.cpp.

References DIR_SEPARATORS.

Referenced by CDirEntry::Backup(), CDir::Create(), CSQLITE3_BlobCacheCF::CreateInstance(), CDllResolver::FindCandidates(), NASNCacheFileName::GenerateLockfilePath(), CProjBulderApp::GenerateUnixProjects(), CTestBMApp::Init(), CDirEntry::NormalizePath(), CProjectTreeBuilder::ProcessDir(), CProjBulderApp::RegisterProjectWatcher(), CDirEntry::Reset(), and CQueueDataBase::x_BackupDump().

Dereference a link.

If the current entry is a symbolic link, then dereference it recursively until it is no further a link (but a file, directory, etc, or does not exist). Replace the entry path string with the dereferenced path.

Note

This method dereference only last component of the path. To dereference all path components use DereferencePath() method.

See also

DereferencePath, IsLink, LookupLink, NormalizePath

Definition at line 2360 of file ncbifile.cpp.

References eNormalizePath, CDirEntry::GetDir(), CDirEntry::IsAbsolutePath(), CDirEntry::IsLink(), CDirEntry::LookupLink(), CDirEntry::MakePath(), CDirEntry::NormalizePath(), prev(), and CDirEntry::Reset().

Referenced by CFile::Copy(), CDir::Copy(), GetSybaseClientVersion(), CDirEntry::Rename(), s_DereferencePath(), and CVDBAliasNode::x_ResolveVDBList().

Check the entry existence.

Reimplemented in CSymLink, CDir, and CFile.

Definition at line 2325 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::GetPath(), HANDLE, INVALID_HANDLE_VALUE, NULL, and CNcbiError::SetFromWindowsError().

Referenced by CMsvcPrjProjectContext::AdditionalLinkerOptions(), CPrintOptions::CPrintOptions(), CDirEntry::CreateAbsolutePath(), CDir::CreatePath(), CTarTempDirEntry::CTarTempDirEntry(), CIgBlastArgs::ExtractAlgorithmOptions(), CProjBulderApp::FindDepGraph(), CVDBMgr::FindDereferencedAccPath(), g_FindDataFile(), CFtglFontManager::GetFont(), CDirEntry::GetNearestExistingParentDir(), CFlatFileParser::Parse(), FileMessenger::PollMessageFile(), CDirEntry::Rename(), CDownloadJob::Run(), CBlastdbConvertApp::Run(), s_GetDiskSpace_PANFS(), s_GetFileSystemInfo(), CLDS2_Manager::UpdateData(), CArg_Ios::x_CreatePath(), CMsvcSite::x_DirExists(), CBDB_Cache::x_DropOverflow(), and CTar::x_ExtractEntry().

Check existence of file.

Note

CDirEntry::Exists() could be faster on some platforms, if you don't need to check that entry is a file.

See also

CDirEntry::Exists

Reimplemented from CDirEntry.

Definition at line 4048 of file ncbifile.hpp.

References CDirEntry::IsFile().

Referenced by BlastDbFileExists(), BOOST_AUTO_TEST_CASE(), CBlastLMDBManager::CBlastEnv::CBlastEnv(), CNCHeartBeat::CheckConfFile(), CSeqDBAliasNode::ComputeMasks(), CLDS2_Database::Create(), CNetStorageServer::CreateCrashFlagFile(), CGlShader::CreateShader(), DeserializePauseState(), DeserializeRefuseSubmitState(), CBlastDbFinder::GetFileName(), GetIndexSuperHeader(), CBDB_Cache::GetSizeEx(), CAutoOutputFileReset::GetStream(), CAlignFormatUtil::GetURLFromRegistry(), CSeqDBIsam::IndexExists(), CSeqDBGiIndex::IndexExists(), CAlignFormatUtil::InitConfig(), CNetScheduleServer::InitNodeID(), CFileLoader::LoadFile(), CMacroFlowEditor::OnSaveCopies(), CBDB_Cache::Open(), CFileIO::Open(), CSeqIdChunkFile::OpenForRead(), CChunkFile::OpenForRead(), CChunkFile::OpenForWrite(), CSeqIdChunkFile::OpenForWrite(), CDiagContext::PrintStart(), CCgiRequestProcessor::ProcessHelpRequest(), CNetStorageServer::RemoveCrashFlagFile(), NVcfUtil::RemoveFile(), CNgAlignApp::Run(), CTbl2AsnApp::Run(), SGridWorkerNodeImpl::Run(), CMultiApplication::Run(), CAgpconvertApplication::Run(), CPrimeCacheApplication::Run(), CChunkFile::s_FindLastChunk(), CChunkFile::s_FindNextChunk(), s_LockInstanceGuard(), CSequenceEditingEventHandler::SaveSubmissionFile(), SerializePauseState(), SerializeRefuseSubmitState(), CCodeGenerator::UndoGenerateCode(), CMsvcConfigure::WriteBuildVer(), CQueueDataBase::x_AppendDumpLinkedSections(), CQueueDataBase::x_CheckOpenPreconditions(), CBlastUsageReport::x_CheckRunEnv(), CSeqDBOIDList::x_ComputeFilters(), CQueueDataBase::x_CreateCrashFlagFile(), CBamLoadingJob::x_CreateDataLoader(), CQueueDataBase::x_CreateDumpErrorFlagFile(), CQueueDataBase::x_DoesCrashFlagFileExist(), CNetStorageServer::x_DoesCrashFlagFileExist(), CQueueDataBase::x_DoesDumpErrorFlagFileExist(), CSeqDB::x_GetDBFilesMetaData(), CQueueDataBase::x_ReadDumpQueueDesrc(), CQueueDataBase::x_RemoveCrashFlagFile(), CQueueDataBase::x_RemoveDumpErrorFlagFile(), CQueueDataBase::x_RemoveSpaceReserveFile(), and CVDBAliasNode::x_ResolveVDBList().

Check if directory "dirname" exists.

Note

CDirEntry::Exists() could be faster on some platforms, if you don't need to check that entry is a directory.

Reimplemented from CDirEntry.

Definition at line 4075 of file ncbifile.hpp.

References CDirEntry::IsDir().

Referenced by BDB_CreateEnv(), CAlignSort::CAlignSort(), CFileDBEngine::CFileDBEngine(), CMacroFlowEditor::CopyDefaultLibrary(), CFileDBEngine::CreateBlob(), CProjBulderApp::CreateCheckList(), CreateConfigurableFile(), CBuildDatabase::CreateDirectories(), CRemoteAppRemoverTask::CRemoteAppRemoverTask(), CAgpFastaComparator::CTmpSeqVecStorage::CTmpSeqVecStorage(), CFileDBEngine::DropDB(), CFileDBEngine::GetCommands(), CFileDBEngine::HasBlob(), CSeqTestApplication::Init(), CInputStreamSource::InitFilesInDirSubtree(), CBDB_Cache::Open(), CSQLITE3_Cache::Open(), CBDB_Volumes::Open(), CBDB_ExtBlobStore< TBV >::Open(), CAgpConverter::OutputOneFileForEach(), CProjBulderApp::ParseArguments(), CFileObsolete::Remove(), CTbl2AsnApp::Run(), CConcatSeqEntriesApplication::Run(), CAsnCacheDumpSeqIdsApplication::Run(), CPrimeCacheApplication::Run(), CReadIndexSpeedApp::Run(), CAsnSubCacheCreateApplication::Run(), CGffDeconcatApp::Run(), CTAbleValApp::Run(), CRunTestApplication::Run(), s_CollectRelPathes(), s_CreateThirdPartyLibsInstallMakefile(), s_EnsureDirExist(), NMacroStats::SaveScriptToFile(), CBDB_Env::SetLogDir(), CSplitCacheApp::SetupCache(), TraverseAndRunTestCases(), CAsnvalApp::ValidateOneDirectory(), CQueueDataBase::x_AppendDumpLinkedSections(), CQueueDataBase::x_BackupDump(), CQueueDataBase::x_CheckOpenPreconditions(), CDumpASNIndex::x_CreateRootDir(), CQueueDataBase::x_CreateSpaceReserveFile(), CRemoteAppRequest::x_CreateWDir(), CQueueDataBase::x_Dump(), CQueueDataBase::x_Open(), CDiscRepApp::x_ParseDirectory(), CAsn2FastaApp::x_ProcessISubdirectory(), CQueueDataBase::x_ReadDumpQueueDesrc(), CQueueDataBase::x_RemoveDataFiles(), CQueueDataBase::x_RemoveDump(), CRemoteAppRequest::x_RemoveWDir(), and CBDB_Cache::x_TruncateDB().

Extend length of the mapped region.

If the sum of the current offset (from Map() method) and new size of the mapped region is more than current file size, that file size will be increased, added space filed with zeros and mapped region will be remapped.

Parameters

new_length New length of the mapped region. The value 0 means that file will be mapped from 'offset' to the end of file.

Returns

New pointer to start of data.

See also

GetPtr, GetOffset, GetSize

Definition at line 6147 of file ncbifile.cpp.

References get_limits(), CMemoryFileMap::GetFileSize(), CMemoryFileSegment::GetOffset(), CMemoryFile::GetPtr(), NStr::Int8ToString(), CMemoryFile::m_Ptr, CMemoryFile::Map(), max(), NCBI_THROW, offset, CMemoryFileMap::x_Close(), CMemoryFileMap::x_Extend(), CMemoryFileMap::x_GetMemoryFileSegment(), CMemoryFileMap::x_Open(), and CMemoryFile::x_Verify().

Utility function working like glob(): takes a pattern and fills the result list with files/directories matching the pattern.

Definition at line 6266 of file ncbifile.cpp.

References CDirEntry::CreateAbsolutePath(), DIR_SEPARATOR, fFF_All, flags, NStr::fSplit_MergeDelimiters, NStr::fSplit_Truncate, CDir::GetCwd(), CDirEntry::GetPathSeparator(), result, NStr::Split(), CDirEntry::SplitPathEx(), and x_Glob().

Referenced by x_Glob().

template<class TContainer , class TPathIterator >

Utility algorithm scans the provided directories using iterators finds files to match the masks and stores all found files in the container object.

Definition at line 3319 of file ncbifile.hpp.

References FindFiles(), flags, and out().

template<class TContainer , class TPathIterator >

Utility algorithm scans the provided directories using iterators finds files to match the masks and stores all found files in the container object.

Definition at line 3288 of file ncbifile.hpp.

References FindFiles(), flags, and out().

template<class TContainer , class TPathIterator , class TMaskIterator >

Utility algorithm scans the provided directories using iterators finds files to match the masks and stores all found files in the container object.

Definition at line 3350 of file ncbifile.hpp.

References FindFiles(), flags, and out().

template<class TPathIterator , class TFindFunc >

Generic algorithm for file search.

Algorithm scans the provided directories using iterators, finds files to match the masks and stores all calls functor object for all found entries. Functor call should match: void Functor(const CDirEntry& dir_entry).

Definition at line 3230 of file ncbifile.hpp.

References FindFilesInDir(), and flags.

template<class TPathIterator , class TFindFunc >

Generic algorithm for file search.

Algorithm scans the provided directories using iterators, finds files to match the masks and stores all calls functor object for all found entries. Functor call should match: void Functor(const CDirEntry& dir_entry).

The difference between FindFiles<> and FileFiles2<> is that last one use two different masks - one for dir entries (files and/or subdirs) and second for subdirectories, that will be used for recursive search. FindFiles<> use one set of masks for all subdirectories with recursive search.

Definition at line 3155 of file ncbifile.hpp.

References FindFilesInDir(), and flags.

Referenced by CBDB_SplitCursor< BDB_SplitStore, BDB_Vol >::CBDB_SplitCursor(), CWriteDB_ConsolidateAliasFiles(), CDllResolver::FindCandidates(), FindFiles(), GetTaxIdWithWindowMaskerSupport(), CInputStreamSource::InitFilesInDirSubtree(), CRunTestApplication::Run(), and s_OldGetTaxIdWithWindowMaskerSupport().

template<class TPathIterator , class TMaskIterator , class TFindFunc >

Generic algorithm for file search.

Algorithm scans the provided directories using iterators, finds files to match the masks and stores all calls functor object for all found entries. Functor call should match: void Functor(const CDirEntry& dir_entry).

Definition at line 3202 of file ncbifile.hpp.

References FindFiles(), and flags.

template<class TContainer , class TPathIterator >

template<class TContainer , class TPathIterator >

template<class TPathIterator , class TFindFunc >

template<class TPathIterator , class TFindFunc >

template<class TFindFunc >

Find files in the specified directory.

Definition at line 3085 of file ncbifile.hpp.

References CDirEntry::AddTrailingPathSeparator(), NStr::eCase, NStr::eNocase, fFF_All, fFF_Dir, fFF_File, fFF_Nocase, fFF_Recursive, CDir::fIgnorePath, CDir::fIgnoreRecursive, FindFilesInDir(), flags, CDir::GetEntriesPtr(), CDirEntry::GetPath(), CDirEntry::IsDir(), ITERATE, kEmptyStr, CDirEntry::MakePath(), CMask::Match(), NULL, and CDirEntry::Reset().

template<class TFindFunc >

Find files in the specified directory.

Definition at line 3032 of file ncbifile.hpp.

References CDirEntry::AddTrailingPathSeparator(), NStr::eCase, NStr::eNocase, fFF_All, fFF_Dir, fFF_File, fFF_Nocase, fFF_Recursive, CDir::fIgnorePath, CDir::fIgnoreRecursive, flags, CDir::GetEntriesPtr(), CDirEntry::GetPath(), CDirEntry::IsDir(), ITERATE, kEmptyStr, CDirEntry::MakePath(), CDirEntry::MatchesMask(), NULL, and CDirEntry::Reset().

Referenced by BOOST_AUTO_TEST_CASE(), FindBlastDBs(), FindFiles(), FindFiles2(), FindFilesInDir(), NCBITEST_AUTO_INIT(), sUpdateAll(), and TraverseAndRunTestCases().

Get the base entry name without extension.

Definition at line 3934 of file ncbifile.hpp.

References CDirEntry::GetPath(), and CDirEntry::SplitPath().

Referenced by CBAMDataLoader_Impl::AddBamFile(), CBAMDataLoader_Impl::AddSrzDef(), CreateProjKey(), CNcbiApplicationAPI::FindProgramExecutablePath(), CCodeGenerator::GenerateCombiningFile(), CCodeGenerator::GenerateCvsignore(), CCodeGenerator::GenerateDoxygenGroupDescription(), CCodeGenerator::GenerateFileList(), IsProducedByDatatool(), DTDParser::Modules(), CTbl2AsnApp::Run(), CFileDiagHandler::SetLogFile(), CDiagContext::SetupDiag(), CFileCode::WriteUserCopyright(), CGBProjectTool::x_Collapse(), CDiscRepApp::x_ConstructOutputName(), and CBamFileInfo::x_Initialize().

Get the current working directory.

Definition at line 3706 of file ncbifile.cpp.

References _T_CSTRING, buf, kEmptyCStr, LOG_ERROR_ERRNO, and NcbiSys_getcwd.

Referenced by BOOST_AUTO_TEST_CASE(), CFile::Copy(), CDir::Copy(), CSymLink::Copy(), CDirEntry::CreateAbsolutePath(), CRemoteAppLauncher::CRemoteAppLauncher(), CSymbolGuard::CSymbolGuard(), CWriteDB_ConsolidateAliasFiles(), CRemoteAppLauncher::ExecRemoteApp(), CIgBlastArgs::ExtractAlgorithmOptions(), FindFiles(), CNcbiApplicationAPI::FindProgramExecutablePath(), FtaErrGetMsgCodes(), CSeqDBAtlas::GenerateSearchPath(), MakeAbsolutePath(), CProjBulderApp::ParseArguments(), CProjBulderApp::RegisterProjectWatcher(), CProjBulderApp::ReportGeneratedFiles(), CExec::ResolvePath(), CSplignApp::Run(), s_FindPathToWM(), s_GetFileSystemInfo(), s_ProcessParameters(), s_StoreStartupParams(), SetLogFileName(), CNCServer::WriteEnvInfo(), CSeqDBAliasNode::x_ExpandAliases(), and CMetaRegistry::x_FindRegistry().

Get the directory component for this directory entry.

Parameters

path Flag to control returning value for paths that don't have directory name.

Returns

The directory component for this directory entry, or empty string.

See also

EGetDirMode, SplitPath

Definition at line 475 of file ncbifile.cpp.

References DIR_CURRENT, DIR_SEPARATOR, CDirEntry::eIfEmptyPath_Current, ctll::empty(), CDirEntry::GetPath(), CDirEntry::SplitPath(), and string.

Referenced by CSimpleMakeFileContents::SParser::AcceptLine(), CMsvcPrjProjectContext::CMsvcPrjProjectContext(), CMultiFileSource::CMultiFileSource(), CDir::Create(), createAnnot(), CBuildDatabase::CreateDirectories(), CFileCode::CreateFileFolder(), CDir::CreatePath(), CDirEntry::DereferenceLink(), CMetaDataTest::DoTest(), CCodeGenerator::GenerateCode(), CCodeGenerator::GenerateFileList(), CCodeGenerator::GenerateModuleCPP(), GetDefaultLogLocation(), CDirEntry::GetNearestExistingParentDir(), CProjBulderApp::GetUtilityProjectsDir(), CProjBulderApp::GetUtilityProjectsSrcDir(), CProjectsLstFileFilter::InitFromFile(), CCodeGenerator::IsGitRepository(), DTDParser::Modules(), CProjBulderApp::ParseArguments(), CProjSRCResolver::PrepareResolver(), CBam2GraphApp::ProcessSrz(), CSearchHelper::ReadModFiles(), CFileHandleDiagHandler::Reopen(), CBlastdbConvertApp::Run(), s_GetMakefileIncludes(), CFileDiagHandler::SetLogFile(), SetLogFile(), CProjBulderApp::VerifyArguments(), CDiscRepApp::x_ConstructOutputName(), CArg_Ios::x_CreatePath(), CTar::x_ExtractEntry(), and CDataLoadersUtil::x_SetupSRADataLoader().

Get directory entries based on the specified set of "masks".

Parameters

mask Use to select only entries that match this set of masks. flags Flags defines behavior and which entries to return.

Returns

A list containing all directory entries. Return empty list on error.

Note

Use fThrowOnError to avoid getting empty list on error and throwing an exception instead.

Definition at line 3949 of file ncbifile.cpp.

References flags.

Get directory entries based on the specified "mask".

Parameters

mask Use to select only entries that match this mask. Do not use file mask if set to "kEmptyStr". flags Flags defines behavior and which entries to return.

Returns

A list containing all directory entries. Return empty list on error.

Note

Use fThrowOnError to avoid getting empty list on error and throwing an exception instead.

Definition at line 3844 of file ncbifile.cpp.

References CMask::Add(), flags, and mask.

Referenced by CLDS2_Manager::AddDataDir(), CAsnCache::CAsnCache(), CBDB_Env::CheckRemove(), CMsvcSite::CMsvcSite(), CMultiFileSource::CMultiFileSource(), CMetaDataTest::DoTest(), DumpSeqEntries(), CSampleLibraryObject::FindInPath(), CFileDBEngine::GetCommands(), CDir::GetEntries(), LoadScope(), CBDB_Cache::Open(), CBDB_Volumes::Open(), CProjectTreeBuilder::ProcessDir(), CBiosampleChkApp::ProcessOneDirectory(), CFileObsolete::Remove(), CAsnSubCacheCreateApplication::Run(), subfuse::CSubfuseApp::Run(), CTLSApp::Run(), s_CollapseProjectFolder(), s_CollectRelPathes(), s_IsInsideDatatoolSourceDir(), s_UpdateMacros(), CAsnvalApp::ValidateOneDirectory(), CArchive::x_Append(), CElementaryMatching::x_CleanVolumes(), CDownloadJob::x_DownloadAndExtract(), CElementaryMatching::x_InitParticipationVector(), CDiscRepApp::x_ParseDirectory(), CAsn2FastaApp::x_ProcessISubdirectory(), CCleanupApp::x_ProcessOneDirectory(), CQueueDataBase::x_ReadDumpQueueDesrc(), CQueueDataBase::x_RemoveDataFiles(), CElementaryMatching::x_Search(), and CBDB_Cache::x_TruncateDB().

Get directory entries based on the specified set of "masks".

Parameters

masks Use to select only entries that match this set of masks. flags Flags defines behavior and which entries to return.

Returns

A list containing all directory entries. Return empty list on error.

Note

Use fThrowOnError to avoid getting empty list on error and throwing an exception instead.

Definition at line 3864 of file ncbifile.cpp.

References flags.

Get directory entries based on the specified set of "masks".

This methods are faster on big directories than GetEntries().

Parameters

mask Use to select only entries that match this set of masks. flags Flags defines behavior and which entries to return.

Returns

A pointer to list of directory entries. NULL in the case of error.

Note

Do not forget to release allocated memory using return pointer.

Definition at line 3956 of file ncbifile.cpp.

References _T_CSTRING, _T_XCSTRING, CDirEntry::AddTrailingPathSeparator(), DIR_CURRENT, NStr::eCase, CDirEntry::eFile, ctll::empty(), NStr::eNocase, F_ISSET, flags, CDirEntry::GetPath(), HANDLE, INVALID_HANDLE_VALUE, IS_RECURSIVE_ENTRY, CMask::Match(), NCBI_THROW, NULL, s_AddEntry(), s_SetFindFileError(), CNcbiError::SetFromErrno(), CNcbiError::SetFromWindowsError(), and CNcbiError::SetWindowsError().

Get directory entries based on the specified set of "masks".

This methods are faster on big directories than GetEntries().

Parameters

mask Use to select only entries that match this set of masks. flags Flags defines behavior and which entries to return.

Returns

A pointer to list of directory entries. NULL in the case of error.

Note

Do not forget to release allocated memory using return pointer.

Definition at line 3871 of file ncbifile.cpp.

References _T_CSTRING, _T_XCSTRING, CDirEntry::AddTrailingPathSeparator(), DIR_CURRENT, NStr::eCase, CDirEntry::eFile, ctll::empty(), NStr::eNocase, F_ISSET, flags, CDirEntry::GetPath(), HANDLE, INVALID_HANDLE_VALUE, IS_RECURSIVE_ENTRY, ITERATE, kEmptyStr, mask, CDirEntry::MatchesMask(), NCBI_THROW, NULL, s_AddEntry(), s_SetFindFileError(), CNcbiError::SetFromErrno(), CNcbiError::SetFromWindowsError(), and CNcbiError::SetWindowsError().

Return system file handle.

If you want to read/write from/to the file, you should work with it using only the file descriptor, obtained using this method. It can be the same file descriptor as was given in the constructor.

Returns

File descriptor associated with the file.

Definition at line 3881 of file ncbifile.hpp.

References CFileLock::m_Handle.

Get length of the mapped file.

Returns

Size in bytes of the mapped file.

Definition at line 5872 of file ncbifile.cpp.

References CFile::GetLength(), SMemoryFileHandle::hMap, kInvalidHandle, LOG_ERROR_ERRNO, CMemoryFileMap::m_FileName, CMemoryFileMap::m_Handle, NcbiSys_fstat, and st().

Referenced by BOOST_AUTO_TEST_CASE(), CMemoryFileMap::CMemoryFileMap(), CMemoryFile::Extend(), CMemoryFile::GetSize(), and CMemoryFileMap::Map().

Get file system information.

Get information for the user associated with the calling thread only.

Parameters

path String that specifies filesystem for which information is to be returned. info Pointer to structure which receives file system information.

Definition at line 5320 of file ncbifile.cpp.

References fFSI_All, info, and s_GetFileSystemInfo().

Get size of file.

Returns

Size of the file, if operation successful; -1, otherwise.

Definition at line 3204 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::eFile, CNcbiError::eOperationNotPermitted, CDirEntry::GetPath(), CDirEntry::GetType(), LOG_ERROR_ERRNO, LOG_ERROR_NCBI, NcbiSys_stat, and st().

Referenced by CChunkFile::Append(), BOOST_AUTO_TEST_CASE(), CBlastLMDBManager::CBlastEnv::CBlastEnv(), CCompressionDictionary::CCompressionDictionary(), CheckWrittenFile(), CTaxDBFileInfo::CTaxDBFileInfo(), CMetaDataTest::DoTest(), CMemoryFileMap::GetFileSize(), GetIndexSuperHeader(), GetMemoryUsage(), CCurrentProcess::GetMemoryUsage(), CBDB_Cache::GetSizeEx(), CFileLoader::LoadFile(), CDbIndex::LoadIndex(), CTableImportDataSource::LoadTable(), CHugeFile::Open(), CHugeFile::OpenPlain(), FileMessenger::PollMessageFile(), CAttribTableDelimitersPanel::PreviewData(), CTableFormatPanel::PreviewData(), CTbl2AsnApp::Run(), s_ConvertV4toV5(), CChunkFile::s_FindNextChunk(), s_OpenIndexDB(), CNCServer::WriteEnvInfo(), CBDB_Cache::x_CreateOverflowReader(), CSeqDB::x_GetDBFilesMetaData(), CUnicodeToAsciiTranslation::x_Initialize(), CHTMLPage::x_LoadTemplate(), CHTMLPage::x_LoadTemplateLib(), CSoapServerApplication::x_ProcessWsdlRequest(), and CElementaryMatching::x_Search().

Get the base entry name with extension (if any).

Definition at line 3926 of file ncbifile.hpp.

References CDirEntry::GetPath(), and CDirEntry::SplitPath().

Referenced by CMsvcPrjProjectContext::AdditionalLinkerOptions(), CWriteDB_Impl::Close(), CMultiFileSource::CMultiFileSource(), CDirEntry::CopyToDir(), CBuildDatabase::CreateDirectories(), CWriteDB_ConsolidateAliasFiles(), CWriteDB_CreateAliasFile(), SAppProjectT::DoCreate(), SLibProjectT::DoCreate(), CMetaDataTest::DoTest(), CCodeGenerator::GenerateCvsignore(), CCodeGenerator::GenerateFileList(), CProjBulderApp::GenerateUnixProjects(), CNcbiApplicationAPI::LoadConfig(), CDirEntry::MoveToDir(), CMultiFileDestination::Next(), SGridWorkerNodeImpl::OfflineRun(), CVDBGraphDataLoader_Impl::OpenVDBGraphFileOnce(), CFileModules::PrintSpecDump(), CBlastdbConvertApp::Run(), s_PositionAsString(), sRunTest(), CArgAllowMaximumFileNameLength::Verify(), CFileCode::WriteCopyright(), CFileCode::WriteSourceFile(), CFileCode::WriteSpecRefs(), CFileCode::WriteUserCopyright(), CDebugDumpViewer::x_CheckLocation(), CSeqDB::x_GetDBFilesMetaData(), CWriteDB_Impl::x_MakeAlias(), CTable2AsnValidator::x_PopulateDiscrepancy(), CAsn2FastaApp::x_ProcessISubdirectory(), and CDataLoadersUtil::x_SetupSRADataLoader().

Given a path, gets the closest parent directory which actually exists.

Parameters

path Some path to a directory entry.

Returns

The closest parent directory which actually exists.

Exceptions

Note

For relative not-existent path it always returns ".". To avoid this, you can always use absolute path for "path": CDirEntry::GetNearestExistingParentDir(CDirEntry::CreateAbsolutePath(path))

On Unix, a non-empty path should always have some existing parent, because '/' is a common path that should always exist.

See also

GetDir, CreateAbsolutePath

Definition at line 547 of file ncbifile.cpp.

References CDirEntry::Exists(), CDirEntry::GetDir(), CDirEntry::GetPath(), NCBI_THROW, CDirEntry::NormalizePath(), and CDirEntry::Reset().

Get an entry owner.

WINDOWS: Retrieve the name of the account and the name of the first group, which the account belongs to. The obtained group name may be an empty string, if we don't have permissions to get it. Windows 2000/XP: In addition to looking up for local accounts, local domain accounts, and explicitly trusted domain accounts, it also can look for any account in any known domain around. UNIX: Retrieve an entry owner:group pair.

Parameters

owner Pointer to a string to receive an owner name. group Pointer to a string to receive a group name. follow Whether to follow symbolic links when getting the information. uid Pointer to an unsigned int to receive numeric user id (this information is purely supplemental). gid Pointer to an unsigned int to receive numeric group id (this information is purely supplemental).

Note

Numeric uid/gid may be fake ones on Windows (and may be 0).

The call will fail if neither owner nor group is provided non-NULL (even though uid and/or gid may be non-NULL).

It is in best interest of the caller to clear all strings and integers that are expected to get values out of this call prior to making the actual call.

Returns

TRUE if successful, FALSE otherwise.

See also

SetOwner

Definition at line 2760 of file ncbifile.cpp.

References eFollowLinks, CNcbiError::eInvalidArgument, CWinSecurity::GetFileOwner(), CUnixFeature::GetGroupNameByGID(), CDirEntry::GetPath(), CUnixFeature::GetUserNameByUID(), LOG_ERROR, LOG_ERROR_ERRNO, LOG_ERROR_NCBI, NStr::NumericToString(), and st().

Referenced by CTar::x_Append(), and CArchive::x_Append().

Get entry path.

Definition at line 3920 of file ncbifile.hpp.

References CDirEntry::m_Path.

Referenced by CLDS2_Manager::AddDataDir(), CChunkFile::Append(), CSeqIdChunkFile::Append(), CDirEntry::Backup(), BOOST_AUTO_TEST_CASE(), CDirEntry::CheckAccess(), CFile::Compare(), CFile::CompareTextContents(), CDirEntry::Copy(), CFile::Copy(), CDir::Copy(), CSymLink::Copy(), CPrintOptions::CPrintOptions(), CSymLink::Create(), CDir::Create(), CreateLock(), CDir::CreatePath(), CTarTempDirEntry::CTarTempDirEntry(), CAgpFastaComparator::CTmpSeqVecStorage::CTmpSeqVecStorage(), CTmpEntryDeleter::Delete(), CDirEntry::DereferencePath(), CDirEntry::Exists(), CArchive::ExtractEntry(), CProjBulderApp::FindDepGraph(), CVDBMgr::FindDereferencedAccPath(), FindFilesInDir(), g_FindDataFile(), CCodeGenerator::GenerateFileList(), CDirEntry::GetBase(), CFileDBEngine::GetCommands(), CDirEntry::GetDir(), CDir::GetEntriesPtr(), CDirEntry::GetExt(), CFile::GetLength(), CDirEntry::GetMode(), CDirEntry::GetName(), CDirEntry::GetNearestExistingParentDir(), CDirEntry::GetOwner(), GetSybaseClientVersion(), CDirEntry::GetTime(), CDirEntry::GetTimeT(), CDirEntry::GetType(), CAsnSubCacheCreateApplication::IndexNewBlobsInSubCache(), CNetScheduleServer::InitNodeID(), CDirEntry::IsIdentical(), CDirEntry::LookupLink(), SGridWorkerNodeImpl::OfflineRun(), CBDB_Cache::Open(), CSeqIdChunkFile::OpenForRead(), CChunkFile::OpenForRead(), CChunkFile::OpenForWrite(), CSeqIdChunkFile::OpenForWrite(), SBlobInserter::operator()(), CBlastDbFinder::operator()(), CFindFileNamesFunc< TNames >::operator()(), CTestNameToInfoMapLoader::operator()(), SBlobCopier::operator()(), SBlobLocator::operator<(), SBlobLocator::operator==(), CAgpConverter::OutputOneFileForEach(), FileMessenger::PollMessageFile(), CProjectTreeBuilder::ProcessDir(), CTbl2AsnApp::ProcessOneFile(), CTAbleValApp::ProcessOneFile(), CChunkFile::RawRead(), FileMessenger::ReceiveCommands(), CDirEntry::Remove(), CDir::Remove(), CDirEntry::RemoveEntry(), CDirEntry::Rename(), CTarTempDirEntry::Restore(), CBlastdbConvertApp::Run(), CConcatSeqEntriesApplication::Run(), CAsnCacheDumpSeqIdsApplication::Run(), CPrimeCacheApplication::Run(), CReadIndexSpeedApp::Run(), CAsnSubCacheCreateApplication::Run(), CRunTestApplication::Run(), s_DereferencePath(), s_ExpandProjectFolder(), FileMessenger::SendPendingCommands(), CDirEntry::SetMode(), CDir::SetMode(), CDirEntry::SetModeEntry(), CDirEntry::SetOwner(), CDirEntry::SetTime(), CDirEntry::SetTimeT(), sRunFeatureTrimTest(), sRunTest(), CDirEntry::Stat(), sUpdateCase(), TraverseAndRunTestCases(), CAsnSubCacheCreateApplication::WriteBlobsInSubCache(), CMsvcConfigure::WriteBuildVer(), CFileCode::WriteSpecRefs(), CBlastUsageReport::x_CheckRunEnv(), CTar::x_ExtractEntry(), CTar::x_ExtractPlainFile(), CTar::x_ExtractSparseFile(), CSeqDB::x_GetDBFilesMetaData(), CVDBAliasNode::x_ResolveVDBList(), CArchive::x_RestoreAttrs(), and CTar::x_RestoreAttrs().

Get path separator symbol specific for the current platform.

Definition at line 433 of file ncbifile.cpp.

References DIR_SEPARATOR.

Referenced by CDirEntry::AddTrailingPathSeparator(), BlastFindMatrixPath(), BOOST_AUTO_TEST_CASE(), CFileDBEngine::CFileDBEngine(), CMsvcPrjGeneralContext::CMsvcPrjGeneralContext(), CFileDBEngine::CommitTransaction(), CDirEntry::ConcatPathEx(), CFileDBEngine::CreateBlob(), CProjectTreeFolders::CreatePath(), CDir::CreatePath(), CDirEntry::CreateRelativePath(), CRemoteAppLauncher::CRemoteAppLauncher(), CTmpStreamGuard::CTmpStreamGuard(), CRemoteAppLauncher::ExecRemoteApp(), FindBlastDbPath(), FindFiles(), CNcbiApplicationAPI::FindProgramExecutablePath(), FtaErrGetMsgCodes(), NASNCacheFileName::GenerateLockfilePath(), CFileDBEngine::GetCommands(), CSeqDB::GetDBMetaData(), CSplitCacheApp::GetFileName(), CAgpFastaComparator::CTmpSeqVecStorage::GetFileName(), GetLdsDbDir(), CSimpleMakeFileContents::GetPathValue(), GetTaxIdWithWindowMaskerSupport(), CFileDBEngine::HasBlob(), CProjectsLstFileFilter::InitFromString(), CVDBBlastUtil::IsSRA(), CVDBBlastUtil::IsWGS(), LogCmdOptions(), CProjectTreeBuilder::ProcessDir(), ReadASNFromFile(), CProjBulderApp::RegisterProjectWatcher(), CDir::Remove(), CProjBulderApp::ReportGeneratedFiles(), CExec::ResolvePath(), CSplignApp::Run(), CSeqAnnotSplicerApp::Run(), s_CollectRelPathes(), s_OldGetTaxIdWithWindowMaskerSupport(), s_StripDir(), SeqDB_CombinePath(), SeqDB_ConvertOSPath(), SeqDB_RemoveDirName(), SeqDB_RemoveFileName(), CFtglFontManager::SetFontPath(), CDir::SetMode(), CMsvcSite::ToOSPath(), TraverseAndRunTestCases(), SNetStorage::SConfig::Validate(), WindowMaskerTaxidToDb(), CBlastDBCmdApp::x_AddCmdOptions(), CMakeBlastDBApp::x_BuildDatabase(), CMakeClusterDBApp::x_BuildDatabase(), CElementaryMatching::x_CreateRemapData(), CRemoteAppRequest::x_Deserialize(), CDownloadJob::x_Download(), CSeqDBAliasNode::x_ExpandAliases(), CFileDBEngine::x_GetCmdFileName(), CMsvcProjectMakefile::x_GetHeaders(), SDiagMessage::x_GetModule(), CElementaryMatching::x_InitFilteringVector(), CElementaryMatching::x_LoadRemapData(), CWriteDB_IndexFile::x_MakeLmdbName(), CCleanupApp::x_OpenOStream(), CSeqDBAliasNode::x_ResolveNames(), CVDBAliasNode::x_ResolveVDBList(), and CElementaryMatching::x_WriteIndexFile().

Get pointer to beginning of data.

Returns

Pointer to start of data.

See also

Map, Extend

Definition at line 4291 of file ncbifile.hpp.

References CMemoryFile::m_Ptr.

Referenced by CDbIndex_Impl< LEGACY >::CDbIndex_Impl(), CMemoryFile::Extend(), CSeqDBLMDB::GetOidsForTaxIds(), CProfileData::Load(), s_ContainsBinaryNumericIdList(), s_GetMinimumSupportedWordSizeByIndex(), SeqDB_ReadBinaryGiList(), SeqDB_ReadGiList(), SeqDB_ReadMixList(), SeqDB_ReadPigList(), SeqDB_ReadSiList(), SeqDB_ReadTaxIdList(), and SeqDB_ReadTiList().

Get real offset of the mapped area from beginning of file.

This real offset is adjusted to system's memory allocation granularity value and can be less than requested "offset" in the constructor.

Returns

Offset in bytes of mapped area from beginning of the file. Always return adjusted value even if data was not successfully mapped.

See also

GetRealPtr, GetRealSize, GetOffset

Definition at line 4239 of file ncbifile.hpp.

References CMemoryFileSegment::m_OffsetReal.

Get pointer to beginning of really mapped data.

When the mapping object is creating and the offset is not a multiple of the allocation granularity, that offset and length can be adjusted to match it. The "length" value will be automatically increased on the difference between passed and real offsets.

Returns

• Pointer to start of data, or
• NULL if mapped to a file of zero length, or if not mapped.

See also

GetRealOffset, GetRealSize, GetPtr

Definition at line 4226 of file ncbifile.hpp.

References CMemoryFileSegment::m_DataPtrReal.

Get length of the mapped region.

Returns

• Length in bytes of the mapped region, or
• 0 if not mapped or file is empty.

Definition at line 4297 of file ncbifile.hpp.

References CMemoryFileMap::GetFileSize(), CMemoryFileMap::GetSize(), CMemoryFile::m_Ptr, and CMemoryFile::x_Verify().

Referenced by s_ContainsBinaryNumericIdList(), SeqDB_ReadBinaryGiList(), SeqDB_ReadGiList(), SeqDB_ReadMixList(), SeqDB_ReadPigList(), SeqDB_ReadSiList(), SeqDB_ReadTaxIdList(), SeqDB_ReadTiList(), and CVDBAliasNode::x_ReadValues().

Get time stamp(s) of a directory entry.

The creation time under MS windows is an actual creation time of the entry. Under UNIX "creation" time is the time of last entry status change. If either OS or file system does not support some time type (modification/last access/creation), then the corresponding CTime gets returned "empty". Returned times are always in CTime's time zone format (eLocal/eGMT). NOTE that what GetTime returns may not be equal to the the time(s) previously set by SetTime, as the behavior depends on the OS and the file system used.

Returns

TRUE if time(s) obtained successfully, FALSE otherwise.

See also

GetTimeT, SetTime, Stat

Definition at line 1840 of file ncbifile.cpp.

References _T_XCSTRING, buf, CDirEntry::GetPath(), HANDLE, INVALID_HANDLE_VALUE, LOG_ERROR, LOG_ERROR_WIN, s_FileTimeToCTime(), CTime::SetNanoSecond(), CTime::SetTimeT(), st(), and CDirEntry::Stat().

Referenced by CNCHeartBeat::CheckConfFile(), g_IsDataFileOld(), CDirEntry::IsNewer(), CDbapiTestSpeedApp::RunSample(), and CDirEntry::SetTime().

Get temporary file name.

This class generates a temporary file name in the temporary directory specified by the OS. But this behavior can be changed – just set the desired temporary directory using the global parameter 'TmpDir' in in the 'NCBI' registry section or the environment (see CParam class description), and it will used by default in this class.

Parameters

mode Temporary file creation mode. Note, that default mode eTmpFileGetName returns only the name of the temporary file, without creating it. This method can be faster, but it have potential race condition, when other process can leave as behind and create file with the same name first. Also, please note, that if you call GetTmpName() again, without creating file for previous call of this method, the same file name can be returned.

Returns

Name of temporary file, or "kEmptyStr" if there was an error getting temporary file name.

See also

GetTmpNameEx, ETmpFileCreationMode

Definition at line 2903 of file ncbifile.cpp.

References _T_CSTRING, ERR_POST_X, CDirEntry::eTmpFileCreate, free(), CDirEntry::GetTmpNameEx(), kEmptyStr, LOG_ERROR_ERRNO, NcbiSys_tempnam, and Warning().

Referenced by BOOST_AUTO_TEST_CASE(), CDirEntry::CreateTmpFile(), CTmpFile::CTmpFile(), CGBDocument::LoadFile(), CMakefilePatch::PatchTreeMakefiles(), s_GetBigBedFeats(), s_GetBigBedSummary(), s_GetData(), CBrowserUtils::SendToBrowser(), sRunTest(), CMsvcConfigure::WriteBuildVer(), CBLASTSeqToolJob::x_CreateProjectItems(), CWigGraph::x_GetBigWigData(), CWigGraph::x_GetBigWigSummary(), and CFlat2AsnApp::x_OpenFiles().

Get temporary file name.

Parameters

dir Directory in which temporary file is to be created; default of kEmptyStr means that function try to get application specific temporary directory name from global parameter (see GetTmpName description), then it try to get system temporary directory, and all of this fails - current directory will be used. prefix Temporary file name will be prefixed by value of this parameter; default of kEmptyStr means that, effectively, no prefix value will be used. mode Temporary file creation mode. If set to "eTmpFileCreate", empty file with unique name will be created. Please, do not forget to remove it yourself as soon as it is no longer needed. On some platforms "eTmpFileCreate" mode is equal to "eTmpFileGetName". If set to "eTmpFileGetName", returns only the name of the temporary file, without creating it. This method can be faster, but it have potential race condition, when other process can leave as behind and create file with the same name first.

Returns

Name of temporary file, or "kEmptyStr" if there was an error getting temporary file name.

See also

GetTmpName, ETmpFileCreationMode

Definition at line 2940 of file ncbifile.cpp.

References CFileIO::Close(), CFileIO::CreateTemporary(), CFileIO::eDoNotRemove, CFileIO::eRemoveInClose, CDirEntry::eTmpFileCreate, and CFileIO::GetPathname().

Referenced by CAlignSort::CAlignSort(), CFile::Copy(), CDir::Copy(), CSymLink::Copy(), CPrintOptions::CPrintOptions(), CDirEntry::CreateTmpFileEx(), g_SaveToTemp(), CDirEntry::GetTmpName(), CBrowserUtils::SendToBrowser(), and CArchive::x_ExtractEntry().

Get total disk space information.

Get information for the user associated with the calling thread only. If per-user quotas are in use, then the returned value may be less than the actual total number of bytes on the disk.

Parameters

path String that specifies the file system for which to return the total disk space in bytes.

Returns

The amount of total disk space in bytes.

See also

GetFileSystemInfo, GetFreeDiskSpace, GetUsedDiskSpace

Definition at line 5342 of file ncbifile.cpp.

References fFSI_DiskSpace, info, and s_GetFileSystemInfo().

Get a type of a directory entry by status information.

Parameters

st Status file information.

Returns

Return one of the values in EType. If the directory entry does not exist, return "eUnknown".

See also

IsFile, IsDir, IsLink

Definition at line 2247 of file ncbifile.cpp.

References CDirEntry::eBlockSpecial, CDirEntry::eCharSpecial, CDirEntry::eDir, CDirEntry::eDoor, CDirEntry::eFile, CDirEntry::eLink, CDirEntry::ePipe, CDirEntry::eSocket, CDirEntry::eUnknown, if(), int, NCBI_IS_TYPE, and st().

Get a type of a directory entry.

Returns

Return one of the values in EType. If the directory entry does not exist, return "eUnknown".

See also

IsFile, IsDir, IsLink

Definition at line 2203 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::eDir, CDirEntry::eFile, eFollowLinks, CDirEntry::eUnknown, F_ISSET, CDirEntry::GetPath(), NcbiSys_stat, s_Win_IsNetworkPath(), CNcbiError::SetFromErrno(), CNcbiError::SetFromWindowsError(), and st().

Referenced by CDirEntry::Copy(), CFile::Copy(), CDir::Copy(), CSymLink::Copy(), g_FindDataFile(), CArchiveZip::GetEntryInfo(), CFile::GetLength(), CDirEntry::IsDir(), CDirEntry::IsFile(), CDirEntry::IsLink(), CDirEntry::Rename(), s_PositionAsString(), CDirEntry::SetOwner(), CTar::x_Append(), CArchive::x_Append(), and CTar::x_ExtractEntry().

Get used disk space information.

Get information for the user associated with the calling thread only. If per-user quotas are in use, then the returned values may be less than the actual number of free bytes available on disk.

Parameters

path String that specifies the file system for which to return the number of used bytes on disk.

Returns

The amount of used space in bytes.

See also

GetFileSystemInfo, GetTotalDiskSpace, GetFreeDiskSpace

Definition at line 5334 of file ncbifile.cpp.

References fFSI_DiskSpace, info, and s_GetFileSystemInfo().

Check if a "path" is absolute for the current OS.

Note that the "path" must be for the current OS.

Definition at line 508 of file ncbifile.cpp.

References s_Win_IsDiskPath(), and s_Win_IsNetworkPath().

Referenced by CBDB_SplitCursor< BDB_SplitStore, BDB_Vol >::CBDB_SplitCursor(), CInterProcessLock::CInterProcessLock(), CMsvcPrjFilesCollector::CollectSources(), CDirEntry::CreateAbsolutePath(), SMakeProjectT::CreateIncludeDirs(), CDirEntry::CreateRelativePath(), CRemoteAppLauncher::CRemoteAppLauncher(), CDirEntry::DereferenceLink(), SMsvcProjectT::DoCreate(), CNcbiApplicationAPI::FindProgramExecutablePath(), g_FindDataFile(), CProjectsLstFileFilter::InitFromFile(), CMsvcSite::IsLibOk(), MakeAbsolutePath(), CProjBulderApp::ParseArguments(), CSearchHelper::ReadModFiles(), CProjBulderApp::RegisterProjectWatcher(), CProjBulderApp::ReportGeneratedFiles(), CExec::ResolvePath(), CSplignApp::Run(), COmssa2pepxmlApplication::Run(), CGffDeconcatApp::Run(), s_ProcessParameters(), s_StoreStartupParams(), s_ToArchiveName(), s_ToFilesystemPath(), SetLogFileName(), CFileHandleDiagHandler::SetLogName(), CFileDiagHandler::SetLogName(), and CMetaRegistry::x_FindRegistry().

Check whether a directory entry is a directory.

See also

GetType

Definition at line 3956 of file ncbifile.hpp.

References CDirEntry::eDir, and CDirEntry::GetType().

Referenced by CLDS2_Manager::AddDataDir(), BOOST_AUTO_TEST_CASE(), CDir::Copy(), CDir::Exists(), CIgBlastArgs::ExtractAlgorithmOptions(), FindFilesInDir(), CwxSavePdfBaseDlg::OnFilepathClick(), CwxExportAlnmultiImgDlg::OnFilepathClick(), CwxExportVectorImageDlg::OnFilepathClick(), CAgpConverter::OutputOneFileForEach(), CProjectTreeBuilder::ProcessDir(), CDirEntry::Remove(), CDir::Remove(), CConcatSeqEntriesApplication::Run(), CAsnCacheDumpSeqIdsApplication::Run(), CReadIndexSpeedApp::Run(), CAsnSubCacheCreateApplication::Run(), CDirEntry::SetMode(), CDir::SetMode(), TraverseAndRunTestCases(), and CDiscRepApp::x_ParseDirectory().

Check whether a directory entry is a file.

See also

GetType

Definition at line 3950 of file ncbifile.hpp.

References CDirEntry::eFile, and CDirEntry::GetType().

Referenced by CLDS2_Manager::AddDataDir(), CFile::Exists(), CIgBlastArgs::ExtractAlgorithmOptions(), CProjBulderApp::FindDepGraph(), CTableImportDataSource::LoadTable(), SGridWorkerNodeImpl::OfflineRun(), CMacroFlowEditor::OnSaveCopies(), CTestNameToInfoMapLoader::operator()(), CFlatFileParser::Parse(), FileMessenger::PollMessageFile(), CAttribTableDelimitersPanel::PreviewData(), CTableFormatPanel::PreviewData(), NVcfUtil::RemoveFile(), CSequenceEditingEventHandler::SaveSubmissionFile(), and CFileManifest::Validate().

Check if the current entry is newer than some other.

Parameters

path An entry name, of which to compare the modification times.

Returns

TRUE if the modification time of the current entry is newer than the modification time of the specified entry, or if that entry doesn't exist. Return FALSE otherwise.

See also

GetTime, EIfAbsent2

Definition at line 2657 of file ncbifile.cpp.

References CDirEntry::fHasThisNoPath_Newer, CDirEntry::fHasThisNoPath_NotNewer, CDirEntry::fNoThisHasPath_Newer, CDirEntry::fNoThisHasPath_NotNewer, CDirEntry::fNoThisNoPath_Newer, CDirEntry::fNoThisNoPath_NotNewer, CDirEntry::GetTime(), and NCBI_THROW.

Check if the current entry is newer than a specified date/time.

Parameters

tm Time to compare with the current entry modification time. if_absent What to do if If the entry does not exist or is not accessible.

Returns

TRUE if the entry's modification time is newer than specified time. Return FALSE otherwise.

See also

GetTime, EIfAbsent

Definition at line 2700 of file ncbifile.cpp.

References CDirEntry::eIfAbsent_Newer, CDirEntry::eIfAbsent_NotNewer, CDirEntry::eIfAbsent_Throw, CDirEntry::GetTimeT(), and NCBI_THROW.

Referenced by CFile::Copy(), CDir::Copy(), CSymLink::Copy(), CDirEntry::Rename(), CMsvcConfigure::WriteBuildVer(), and CWorkspaceAutoSaver::x_SaveWorkspace().

Lock file.

Lock whole file, or the part of the file. Previous lock will be removed. It do not remove locks, established on the file somewhere else. Throw CFileException if the lock cannot be obtained (since someone else has it locked already), or on error.

Parameters

type Type of the lock, one of eShared or eExclusive. offset The file offset where lock starts. Cannot accept values less than 0. length Number of bytes to lock. The value 0 means that whole file will be locked.

See also

Unlock

Definition at line 7324 of file ncbifile.cpp.

References CFileLock::eExclusive, CFileLock::eShared, flags, SLock::length_hi, SLock::length_lo, CFileLock::m_Handle, CFileLock::m_IsLocked, CFileLock::m_Lock, NCBI_THROW, offset, SLock::offset_hi, SLock::offset_lo, SLock::Reset(), SEEK_SET, TRUE, and CFileLock::Unlock().

Referenced by CFileLock::x_Init().

Get an entry name that a link points to.

Returns

The real entry name that the link points to. Return an empty string if the entry is not a link, or cannot be dereferenced. The dereferenced name can be another symbolic link.

See also

GetType, IsLink, DereferenceLink

Definition at line 2343 of file ncbifile.cpp.

References _T_XCSTRING, buf, CDirEntry::GetPath(), int, kEmptyStr, and PATH_MAX.

Referenced by CDirEntry::DereferenceLink(), CTar::x_Append(), and CArchive::x_Append().

Construct mode_t value from permission modes.

Parameters must not have "fDefault" values.

See also

ModeFromModeT

Definition at line 1193 of file ncbifile.cpp.

References CDirEntry::fExecute, CDirEntry::fRead, CDirEntry::fSetGID, CDirEntry::fSetUID, CDirEntry::fSticky, and CDirEntry::fWrite.

Referenced by CDiagFileHandleHolder::CDiagFileHandleHolder(), CDirEntry::GetDefaultModeT(), CInterProcessLock::Lock(), CFileIO::Open(), CDirEntry::SetModeEntry(), and CDirEntry::SetUmask().

Assemble a path from basic components.

Parameters

dir The directory component to make the path string. This will always have a terminating path separator (example: "/usr/local/"). base The base name of the file component that is used to make up the path. ext The extension component. This will always be added with a leading dot (input of either "bat" or ".bat" gets added to the path as ".bat").

Returns

Path built from the components.

Definition at line 413 of file ncbifile.cpp.

References CDirEntry::AddTrailingPathSeparator().

Referenced by BDB_CreateEnv(), BOOST_AUTO_TEST_CASE(), CBDB_Cache::Close(), CNSStartIDs::CNSStartIDs(), CMsvcPrjFilesCollector::CollectSources(), CDirEntry::CopyToDir(), CPIDGuard::CPIDGuard(), createAnnot(), CSQLITE3_BlobCacheCF::CreateInstance(), CDirEntry::DereferenceLink(), DeserializePauseState(), DeserializeRefuseSubmitState(), CAliasTest::DoTest(), CSrzPath::FindAccPath(), FindBlastDbPath(), FindFilesInDir(), CNcbiApplicationAPI::FindProgramExecutablePath(), g_FindDataFile(), CSeqDB::GetDiskUsage(), CSplitCacheApp::GetFileName(), CNetScheduleServer::InitNodeID(), CCSraDb::MakeSraIdPart(), CDirEntry::MoveToDir(), CMultiFileDestination::Next(), CWGSDb_Impl::NormalizePathOrAccession(), SGridWorkerNodeImpl::OfflineRun(), CBDB_Cache::Open(), CAgpConverter::OutputOneFileForEach(), CBam2GraphApp::ProcessFile(), CBiosampleChkApp::ProcessOneDirectory(), CBam2GraphApp::ProcessSrz(), DTDParser::PushEntityLexer(), CExec::ResolvePath(), CCleanupApp::Run(), CMultiReaderApp::Run(), CTLSApp::Run(), s_DereferencePath(), s_GetFileName(), s_GetIndexFileName(), s_InitFileName(), s_LoadECNumberTable(), s_ReadStorageParams(), s_UpdateMacros(), SerializePauseState(), SerializeRefuseSubmitState(), CNcbiEncrypt::sx_InitKeyMap(), CAsnvalApp::ValidateOneDirectory(), WriteASNToFile(), CAliasTest::x_CheckFile(), CDiscRepApp::x_ConstructOutputName(), CQueueDataBase::x_CreateCrashFlagFile(), CQueueDataBase::x_CreateDumpErrorFlagFile(), CQueueDataBase::x_DoesCrashFlagFileExist(), CQueueDataBase::x_DoesDumpErrorFlagFileExist(), CDownloadJob::x_DownloadAndExtract(), CMetaRegistry::x_FindRegistry(), CNetStorageServer::x_GetCrashFlagFileName(), CNcbiEncrypt::x_GetDomainKeys(), CBamUILoadManager::x_GetSrzRefSeqs(), CCSRAFileInfo::x_Initialize(), CGICacheReader::x_Initialize(), CCleanupApp::x_OpenOStream(), CCleanupApp::x_ProcessOneDirectory(), CQueueDataBase::x_RemoveCrashFlagFile(), and CQueueDataBase::x_RemoveDumpErrorFlagFile().

Map file segment.

Parameters

offset The file offset where mapping is to begin. If the offset is not a multiple of the allocation granularity, that it can be decreased to match it. The "length" value will be automatically increased on the difference between passed and real offsets. The real offset can be obtained using GetRealOffset(). Cannot accept values less than 0. length Number of bytes to map. This value can be increased if "offset" is not a multiple of the allocation granularity. The real length of mapped region can be obtained using GetRealSize() method. The value 0 means that all file size will be mapped.

Returns

• Pointer to start of data, or
• NULL if mapped to a file of zero length, or if not mapped.

See also

Unmap, GetOffset, GetSize, GetRealOffset, GetRealSize

Note

MS Windows: If file is open in eMMP_Read mode with eMMS_Private protection, that memory pages will be mapped in exclusive mode, and any other process cannot access the same file for writing.

Definition at line 5784 of file ncbifile.cpp.

References get_limits(), CMemoryFileMap::GetFileSize(), CMemoryFileSegment::GetPtr(), SMemoryFileHandle::hMap, NStr::Int8ToString(), kInvalidHandle, CMemoryFileMap::m_Attrs, CMemoryFileMap::m_FileName, CMemoryFileMap::m_Handle, CMemoryFileMap::m_Segments, max(), NCBI_THROW, and offset.

Referenced by CMemoryFile::Map(), s_ConvertV4toV5(), CMMapByteSourceReader::x_GetNextChunkAt(), and CPagedFile::x_ReadPage().

Map file.

Parameters

offset The file offset where mapping is to begin. If the offset is not a multiple of the allocation granularity, that it can be decreased to match it. The "length" value will be automatically increased on the difference between passed and real offsets. The real offset can be obtained using GetRealOffset(). Cannot accept values less than 0. length Number of bytes to map. This value can be increased if "offset" is not a multiple of the allocation granularity. The real length of mapped region can be obtained using GetRealSize() method. The value 0 means that file will be mapped from 'offset' to the end of file.

Returns

• Pointer to start of data, or
• NULL if mapped to a file of zero length, or if not mapped.

See also

Unmap, GetPtr, GetOffset, GetSize, Extend

Definition at line 6125 of file ncbifile.cpp.

References CMemoryFile::m_Ptr, CMemoryFileMap::Map(), offset, and CMemoryFile::Unmap().

Referenced by CMemoryFile::CMemoryFile(), CMemoryFile::Extend(), CElementaryMatching::x_InitFilteringVector(), CElementaryMatching::x_InitParticipationVector(), CVDBAliasNode::x_ReadValues(), and CElementaryMatching::x_Search().

Match a "name" against a set of "masks" Note that any name match to empty set of masks.

Definition at line 3984 of file ncbifile.hpp.

References mask.

Advise on memory map usage for specified region.

Parameters

addr Address of memory region whose usage is being advised. len Length of memory region whose usage is being advised. advise Advise on expected memory usage pattern.

Returns

• TRUE, if memory advise operation successful.
• FALSE, if memory advise operation not successful, or is not supported on current platform.

See also

EMemMapAdvise, MemMapAdvise

Definition at line 4197 of file ncbifile.hpp.

References len, and MemoryAdvise().

Referenced by CMemoryFileSegment::MemMapAdvise().

Convert mode_t to permission mode(s).

Note

On WINDOWS: There is only the "user_mode" permission setting, and "group_mode" and "other_mode" settings will be ignored. The "user_mode" will be combined with effective permissions for the current process owner on specified directory entry.

See also

GetMode, SetMode, MakeModeT

Definition at line 1246 of file ncbifile.cpp.

References CDirEntry::fExecute, CDirEntry::fRead, CDirEntry::fSetGID, CDirEntry::fSetUID, CDirEntry::fSticky, and CDirEntry::fWrite.

Referenced by CArchiveEntryInfo::GetMode(), CDirEntry::GetMode(), CDirEntry::GetUmask(), operator<<(), CDirEntry::SetModeEntry(), and CArchive::x_RestoreAttrs().

Convert permission modes to string representation using one of predefined formats.

Parameters must not have "fDefault" values.

See also

StringToMode, EModeStringFormat

Definition at line 1355 of file ncbifile.cpp.

References _TROUBLE, CDirEntry::eGroup, CDirEntry::eModeFormat_List, CDirEntry::eModeFormat_Octal, CDirEntry::eModeFormat_Symbolic, CDirEntry::eOther, CDirEntry::eUser, format, CDirEntry::fSetGID, CDirEntry::fSetUID, CDirEntry::fSticky, i, out(), and CDirEntry::x_ModeToSymbolicString().

Referenced by operator<<(), and CDirEntry::SetModeEntry().

Normalize a path.

Remove from an input "path" all redundancy, and if possible, convert it to more simple form for the current OS. Note that "path" must be OS-specific.

Parameters

follow_links Whether to follow symlinks (shortcuts, aliases)

Definition at line 820 of file ncbifile.cpp.

References buf, NStr::CompareNocase(), CDirEntry::DeleteTrailingPathSeparator(), DIR_CURRENT, DIR_PARENT, DIR_SEPARATOR, DISK_SEPARATOR, eIgnoreLinks, ERR_POST_X, CNcbiError::eTooManySymbolicLinkLevels, head, int, NStr::Join(), kEmptyStr, kSep, last(), next(), NPOS, PATH_MAX, NStr::ReplaceInPlace(), CNcbiError::Set(), NStr::Split(), string, and Warning().

Referenced by CSimpleMakeFileContents::SParser::AcceptLine(), CFileDeleteList::Add(), CMsvcPrjProjectContext::AdditionalIncludeDirectories(), CAlignSort::CAlignSort(), CAsnCache::CAsnCache(), CAsnCacheStore::CAsnCacheStore(), CMsvcPrjProjectContext::CMsvcPrjProjectContext(), CMsvcPrjFilesCollector::CollectExtra(), CMsvcPrjFilesCollector::CollectResources(), CMsvcPrjFilesCollector::CollectSources(), CDirEntry::ConvertToOSPath(), CDirEntry::CreateAbsolutePath(), SMakeProjectT::CreateIncludeDirs(), CRemoteAppLauncher::CRemoteAppLauncher(), CDirEntry::DereferenceLink(), CDirEntry::DereferencePath(), SAsnProjectSingleT::DoCreate(), SAsnProjectMultipleT::DoCreate(), SAppProjectT::DoCreate(), CIgBlastArgs::ExtractAlgorithmOptions(), FindBlastDbPath(), CNcbiApplicationAPI::FindProgramExecutablePath(), CSeqDBAtlas::GenerateSearchPath(), GetAbsolutePath(), CFileManifest::GetAllFilePaths(), CMsvcProjectMakefile::GetCustomBuildInfo(), CMsvcSite::GetLibChoiceIncludes(), CDirEntry::GetNearestExistingParentDir(), CNcbiArguments::GetProgramName(), CProjBulderApp::Init(), CDirEntry::IsIdentical(), CDataToolGeneratedSrc::LoadFrom(), MakeAbsolutePath(), ParentDir(), CProjBulderApp::ParseArguments(), CProjectTreeBuilder::ProcessDir(), CExec::ResolvePath(), CSplignApp::Run(), CAsnSubCacheCreateApplication::Run(), s_AddProjItemToDll(), s_CreateThirdPartyLibsInstallMakefile(), s_GetMakefileIncludes(), s_ProcessParameters(), s_StoreStartupParams(), s_ToFilesystemPath(), SetLogFileName(), CDiagContext::SetupDiag(), CSeqDBAliasNode::x_ExpandAliases(), CArchive::x_ExtractEntry(), CMetaRegistry::x_FindRegistry(), CSeqDBAliasNode::x_ResolveNames(), CArchive::x_RestoreAttrs(), and CDataLoadersUtil::x_SetupLDS2DataLoader().

Open file.

Definition at line 6414 of file ncbifile.cpp.

References _T_XCSTRING, _TROUBLE, CFileIO_Base::eCreate, CFileIO_Base::eCreateNew, CFileIO_Base::eExclusive, CFileIO_Base::eOpen, CFileIO_Base::eOpenAlways, CFileIO_Base::eRead, CFileIO_Base::eReadWrite, CFileIO_Base::eShare, CFileIO_Base::eShareRead, CFileIO_Base::eShareWrite, CFileIO_Base::eTruncate, CFileIO_Base::eWrite, CFile::Exists(), flags, CDirEntry::fRead, CDirEntry::fWrite, kInvalidHandle, CFileIO::m_AutoClose, CFileIO::m_Handle, CFileIO::m_Pathname, CDirEntry::MakeModeT(), NCBI_THROW, NcbiSys_open, NcbiSys_strerror, NULL, and WIN_LAST_ERROR_STR.

Referenced by CFileReader::CFileReader(), CFileReaderWriter::CFileReaderWriter(), CFileWriter::CFileWriter(), CFile::Compare(), CPagedFile::CPagedFile(), CGlShader::CreateShader(), CFileIO::CreateTemporary(), CVCFVariantList::CVCFVariantList(), NVcfUtil::DeserializeColumn(), CArchiveMemory::Load(), NVcfUtil::PrintToFile(), CArchiveMemory::Save(), CColumnarVCFReaderApp::x_ReadVCFBlob(), and CTestBMApp::x_Serialize().

Definition at line 6346 of file ncbifile.cpp.

References NStr::CompareCase(), SCompareDirEntries::eBase, SCompareDirEntries::eDir, SCompareDirEntries::eExt, SCompareDirEntries::eName, SCompareDirEntries::ePath, i, SCompareDirEntries::m_Sort, NCBI_THROW, CDirEntry::SplitPath(), and UNDEFINED_SORT_MODE.

Via parameter "count" (which is guaranteed to be supplied non-NULL) return the number of bytes that are ready to be read from the input device without blocking.

Return eRW_Success if the number of pending bytes has been stored at the location pointed to by "count". Return eRW_NotImplemented if the number cannot be determined. Otherwise, return other eRW_... condition to reflect the problem ("*count" does not need to be updated in the case of non-eRW_Success). Note that if reporting 0 bytes ready, the method may return either both eRW_Success and zero "*count", or return eRW_NotImplemented alone.

Implements IReader.

Definition at line 6999 of file ncbifile.cpp.

References eRW_NotImplemented.

Via parameter "count" (which is guaranteed to be supplied non-NULL) return the number of bytes that are ready to be read from the input device without blocking.

Return eRW_Success if the number of pending bytes has been stored at the location pointed to by "count". Return eRW_NotImplemented if the number cannot be determined. Otherwise, return other eRW_... condition to reflect the problem ("*count" does not need to be updated in the case of non-eRW_Success). Note that if reporting 0 bytes ready, the method may return either both eRW_Success and zero "*count", or return eRW_NotImplemented alone.

Implements IReader.

Definition at line 7150 of file ncbifile.cpp.

References eRW_NotImplemented.

Read file.

Returns

The number of bytes actually read. Can be less than 'count', zero indicates end of file.

Definition at line 6660 of file ncbifile.cpp.

References buf, count, kMax, CFileIO::m_Handle, max(), n, NCBI_THROW, and NULL.

Referenced by CFile::Compare(), CGlShader::CreateShader(), CVCFVariantList::CVCFVariantList(), NVcfUtil::DeserializeColumn(), CArchiveMemory::Load(), CFileReader::Read(), CFileReaderWriter::Read(), CNetCacheReader::Read(), CNetCacheWriter::UploadCacheFile(), CPagedFile::x_ReadPage(), and CColumnarVCFReaderApp::x_ReadVCFBlob().

Virtual methods from IReader.

Implements IReader.

Definition at line 6976 of file ncbifile.cpp.

References buf, count, eRW_Eof, eRW_Error, eRW_Success, CErrnoTemplExceptionEx< TBase, PErrCode, PErrStr >::GetErrno(), CFileReaderWriter_Base::m_File, n, CFileIO::Read(), and CNcbiError::SetErrno().

Virtual methods from IReaderWriter.

Implements IReader.

Definition at line 7126 of file ncbifile.cpp.

References buf, count, eRW_Eof, eRW_Error, eRW_Success, CErrnoTemplExceptionEx< TBase, PErrCode, PErrStr >::GetErrno(), CFileReaderWriter_Base::m_File, n, CFileIO::Read(), and CNcbiError::SetErrno().

Remove a directory entry.

@flags Entry processing flags. See EProcessingFlags and CDir::Remove() for details.

See also

CDir::Remove, EProcessingFlags

Reimplemented in CDir.

Definition at line 2595 of file ncbifile.cpp.

References CDirEntry::eEntryOnly, eIgnoreLinks, CDirEntry::fDir_All, CDirEntry::fDir_Recursive, flags, CDirEntry::GetPath(), CDirEntry::IsDir(), CDir::Remove(), and CDirEntry::RemoveEntry().

Referenced by BOOST_AUTO_TEST_CASE(), CBDB_Env::CleanLog(), CBDB_Cache::Close(), CFile::Copy(), CSymLink::Copy(), CLDS2_Database::Create(), CTmpStream::CTmpStream(), CWriteDB_ConsolidateAliasFiles(), CTmpEntryDeleter::Delete(), DeleteBlastDb(), CSQLITE_Connection::DeleteDatabase(), CTable2AsnContext::DeleteOutputs(), CDelayedOfstream::Discard(), g_RestoreFromTemp(), CProjBulderApp::GenerateUnixProjects(), CAutoOutputFileReset::GetStream(), CAlignSort::MergeSortedFiles(), CMacroFlowEditor::OnSaveCopies(), CBDB_Cache::Open(), CSQLITE3_Cache::Open(), CMakefilePatch::PatchTreeMakefiles(), PostProcessFile(), CTbl2AsnApp::ProcessOneFile(), CTAbleValApp::ProcessOneFile(), PromoteIfDifferent(), CPIDGuard::Release(), CDir::Remove(), CPIDGuard::Remove(), CNetStorageServer::RemoveCrashFlagFile(), NVcfUtil::RemoveFile(), CDirEntry::Rename(), CTarTempDirEntry::Restore(), CRotatingLogStreamBuf::Rotate(), CFlat2AsnApp::Run(), CCacheIndexCopyApp::Run(), s_CreateAliasFilePriv(), s_OpenIndexDB(), s_ReinitializeStorage(), s_RemoveFile(), s_ResetLibInstallKey(), s_UnlockInstanceGuard(), s_UpdateMacros(), CSequenceEditingEventHandler::SaveSubmissionFile(), SerializePauseState(), SerializeRefuseSubmitState(), CAlignSort::SortAlignments(), sRunTest(), CSequenceEditingEventHandler::TableReaderClipboard(), CEditingBtnsPanel::TableReaderFromClipboard(), CCodeGenerator::UndoGenerateCode(), STempFileLocker::Unlock(), CMsvcConfigure::WriteBuildVer(), CBamLoadingJob::x_CreateDataLoader(), CBLASTSeqToolJob::x_CreateProjectItems(), CImportFeatTable::x_DoImportFeaturesFromClipboard(), CDownloadJob::x_Download(), CDownloadJob::x_DownloadAndExtract(), CBDB_Cache::x_DropOverflow(), CBuildDatabase::x_EndBuild(), CTar::x_ExtractSparseFile(), CQueueDataBase::x_RemoveCrashFlagFile(), CQueueDataBase::x_RemoveDumpErrorFlagFile(), CQueueDataBase::x_RemoveSpaceReserveFile(), CElementaryMatching::x_Search(), CMakeProfileDBApp::~CMakeProfileDBApp(), COutputFileHelper::~COutputFileHelper(), CTarTempDirEntry::~CTarTempDirEntry(), CTmpStream::~CTmpStream(), CWriteDB_LMDB::~CWriteDB_LMDB(), and CWriteDB_TaxID::~CWriteDB_TaxID().

Delete existing directory.

Parameters

flags Directory processing flags. Some popular sets of flags combined together and listed below:

• eOnlyEmpty directory can be removed only if it is empty;
• eTopDirOnly remove all files in the top directory only, no any subdirectory or files in it;
• eNonRecursive same as eTopDirOnly, but removes also empty subdirectories in the top directory only;
• eRecursive remove all files in directory and all its subdirectories;
• eRecursiveIgnoreMissing same as eRecursive, but do not report an error for missed entries.
• eRecursiveNotStopOnErrors same as eRecursiveIgnoreMissing, but do not stop on a first error and process all entries, so Remove() will try to remove all what it can. Still returns FALSE if it was unable to remove any entry.

Returns

TRUE if operation successful; FALSE otherwise.

See also

CDirEntry::Remove, EProcessingFlags

Reimplemented from CDirEntry.

Definition at line 4340 of file ncbifile.cpp.

References _ASSERT, _T_XCSTRING, eIgnoreLinks, CDirEntry::eOnlyEmpty, f, CDirEntry::fDir_All, CDirEntry::fDir_Files, CDirEntry::fDir_Recursive, CDirEntry::fDir_Self, CDirEntry::fDir_Subdirs, CDirEntry::fEntry, CDirEntry::fIgnoreMissing, flags, CDirEntry::fModeAdd, CDirEntry::fModeNoChange, CDirEntry::fProcessAll, CDirEntry::fWrite, CDirEntry::GetPath(), CDirEntry::GetPathSeparator(), CDirEntry::IsDir(), ITERATE, LOG_ERROR, LOG_ERROR_ERRNO, NcbiSys_rmdir, CDirEntry::Remove(), CDir::Remove(), and CDirEntry::SetMode().

Referenced by BDB_CreateEnv(), CDir::Copy(), CFileDBEngine::DropDB(), CBDB_Cache::Open(), CDirEntry::Remove(), CDir::Remove(), CAsnSubCacheCreateApplication::Run(), CSeqAnnotSplicerApp::Run(), CRemoteAppRequest::x_CreateWDir(), CQueueDataBase::x_Open(), CQueueDataBase::x_RemoveDump(), and CRemoteAppRequest::x_RemoveWDir().

Remove a directory entry.

Same as Remove(), but removes current entry only. Don't process entries inside directories.

See also

Remove

Definition at line 2606 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::fDefault, CDirEntry::fIgnoreMissing, flags, CDirEntry::GetPath(), LOG_ERROR_ERRNO, NCBI, NCBI_PARAM_TYPE, NcbiSys_remove, and CDirEntry::SetModeEntry().

Referenced by CFile::Copy(), CDirEntry::Remove(), and CDirEntry::Rename().

Rename entry.

Parameters

new_path New path/name of an entry. flags Flags specifying how to rename the entry.

Returns

TRUE if the operation was completed successfully; FALSE, otherwise. NOTE that if flag fRF_Update is set, the function returns TRUE and just removes the current entry in case when destination entry exists and has its modification time newer than the current entry.

See also

ERenameFlags, Copy

Definition at line 2456 of file ncbifile.cpp.

References _T_XCSTRING, CDirEntry::Backup(), CDirEntry::CreateObject(), CDirEntry::DereferenceLink(), CDirEntry::eBackup_Rename, CDirEntry::eFile, CNcbiError::eNoSuchFileOrDirectory, CNcbiError::eOperationNotPermitted, CDirEntry::eRecursive, CDirEntry::eUnknown, CDirEntry::Exists(), F_ISSET, CDirEntry::fCF_PreserveAll, CDirEntry::fCF_Recursive, flags, CDirEntry::fRF_Backup, CDirEntry::fRF_EqualTypes, CDirEntry::fRF_FollowLinks, CDirEntry::fRF_Overwrite, CDirEntry::fRF_Update, CDirEntry::GetBackupSuffix(), CDirEntry::GetPath(), CDirEntry::GetType(), CDirEntry::IsNewer(), LOG_ERROR, LOG_ERROR_ERRNO, LOG_ERROR_NCBI, NcbiSys_rename, CDirEntry::Remove(), CDirEntry::RemoveEntry(), CDirEntry::Reset(), and tmp.

Referenced by CDirEntry::Backup(), CFile::Copy(), CDir::Copy(), CSymLink::Copy(), CDirEntry::MoveToDir(), PromoteIfDifferent(), CWriteDB_File::RenameFileIndex(), CWriteDB_File::RenameSingle(), CTarTempDirEntry::Restore(), CRotatingLogStreamBuf::Rotate(), CQueueDataBase::x_BackupDump(), and CDownloadJob::x_DownloadAndExtract().

Reset path string.

Definition at line 298 of file ncbifile.cpp.

References CDirEntry::DeleteTrailingPathSeparator(), DISK_SEPARATOR, CDirEntry::IsPathSeparator(), len, and CDirEntry::m_Path.

Referenced by CChunkFile::Append(), CSeqIdChunkFile::Append(), CDirEntry::CDirEntry(), CMultiFileSource::CMultiFileSource(), CFile::Copy(), CDir::Copy(), CSymLink::Copy(), CPrintOptions::CPrintOptions(), CDirEntry::DereferenceLink(), CDirEntry::DereferencePath(), FindFilesInDir(), g_FindDataFile(), CDirEntry::GetNearestExistingParentDir(), SGridWorkerNodeImpl::OfflineRun(), CSeqIdChunkFile::OpenForRead(), CChunkFile::OpenForRead(), CChunkFile::OpenForWrite(), CSeqIdChunkFile::OpenForWrite(), CTAbleValApp::ProcessOneFile(), CDirEntry::Rename(), s_DereferencePath(), and CCodeGenerator::UndoGenerateCode().

Set default permission modes globally for all CDirEntry objects.

The default mode is set globally for all CDirEntry objects except for those having their own mode set with individual SetDefaultMode().

When "fDefault" is passed as a value of the mode parameters, the default mode takes places for the value as defined in EType:

If user_mode is "fDefault", then the default is to take

• "fDefaultDirUser" if this is a directory, or
• "fDefaultUser" if this is a file.

If group_mode is "fDefault", then the default is to take

• "fDefaultDirGroup" if this is a directory, or
• "fDefaultGroup" if this is a file.

If other_mode is "fDefault", then the default is to take

• "fDefaultDirOther" if this is a directory, or
• "fDefaultOther" if this is a file.

Definition at line 1094 of file ncbifile.cpp.

References CDirEntry::eDir, CDirEntry::eGroup, CDirEntry::eOther, CDirEntry::eSpecial, CDirEntry::eUnknown, CDirEntry::eUser, CDirEntry::fDefault, CDirEntry::fDefaultDirGroup, CDirEntry::fDefaultDirOther, CDirEntry::fDefaultDirUser, CDirEntry::fDefaultGroup, CDirEntry::fDefaultOther, CDirEntry::fDefaultUser, and CDirEntry::m_DefaultModeGlobal.

Specify whether read-only files can be deleted via CDirEntry::Remove() on Windows.

Have the same effect as DeleteReadOnlyFiles global parameter: Registry file: [NCBI] DeleteReadOnlyFiles = true/false Environment variable: NCBI_CONFIG__DELETEREADONLYFILES

Parameters

on_off_default When set to eOn, allows read-only files to be deleted. Otherwise, an attempt to delete a read-only files will return an error (EACCES).

Note

Windows only.

Definition at line 7424 of file ncbifile.cpp.

References eOn, NCBI, and NCBI_PARAM_TYPE.

Referenced by CGridWorkerApp::Init().

Set file position.

Parameters

offset Defines a number of bytes to move the file pointer. A positive value moves the pointer from the position indicated by 'whence' forward in the file, and a negative value backspaces the file pointer towards the beginning of the file. whence Defines a pointer move origin.

Definition at line 6811 of file ncbifile.cpp.

References _TROUBLE, CFileIO_Base::eBegin, CFileIO_Base::eCurrent, CFileIO_Base::eEnd, NStr::Int8ToString(), NStr::IntToString(), CFileIO::m_Handle, NCBI_THROW, NcbiSys_lseek, NULL, offset, SEEK_CUR, SEEK_END, SEEK_SET, and TRUE.