File Namespace Reference

Interface for several file and directory related services. More...

Classes
class	Permissions
	File permissions class, should most often be a combination File::Permission flags on Unix, but uses directly file attributes for local files and directories on Windows, see SetFileAttributes / GetFileAttributes documentation. More...
class	ViewPars

Enumerations
enum class	DirListType { AllEntriesInDir , FilesInDir , DirsInDir }
enum class	Permission {   ReadOwner =0x4000 , WriteOwner =0x2000 , ExeOwner =0x1000 , ReadUser =0x0400 ,   WriteUser =0x0200 , ExeUser =0x0100 , ReadGroup =0x0040 , WriteGroup =0x0020 ,   ExeGroup =0x0010 , ReadOther =0x0004 , WriteOther =0x0002 , ExeOther =0x0001 }
enum class	SizeUnit {   Bytes =0 , KB =1 , MB =2 , GB =3 ,   TB =4 , PB =5 , Auto =6 }
enum class	Type {   File =0 , Directory =1 , SymLink =2 , Alias =3 ,   Shortcut =4 , Character =5 , Block =6 , Fifo =7 ,   Socket =8 , URI =9 , Other =9 , Unknown =10 }
enum class	ViewStyle { Text , Table , Log , Bin }

Functions
const char *	allFilesFilter ()
const char *	asciiFilesFilter ()
bool	changeDir (const char *path)
bool	checkDir (const char *fnm, bool forread, uiString *errmsg=nullptr)
bool	copy (const char *from, const char *to, bool preserve=true, uiString *errmsg=nullptr, TaskRunner *=nullptr)
bool	copyDir (const char *from, const char *to, bool preserve=true, uiString *errmsg=nullptr, TaskRunner *=nullptr)
bool	createDir (const char *)
bool	createLink (const char *from, const char *to)
bool	exists (const char *)
BufferString	findExecutable (const char *exenm, const BufferStringSet &paths, bool includesyspath=true)
const char *	getAbsolutePath (const char *dir, const char *relfnm)
const char *	getCanonicalPath (const char *)
bool	getContent (const char *, BufferString &)
const char *	getCurrentPath ()
od_int64	getFileSize (const char *fnm, bool followlink=true)
BufferString	getFileSizeString (const char *fnm, File::SizeUnit=File::SizeUnit::Auto)
BufferString	getFileSizeString (od_int64 filesz, File::SizeUnit=File::SizeUnit::Auto)
BufferString	getHash (const char *, Crypto::Algorithm)
const char *	getHomePath ()
od_int64	getKbSize (const char *)
Permissions	getPermissions (const char *fnm)
Executor *	getRecursiveCopier (const char *from, const char *to, bool preserve=true)
Executor *	getRecursiveDeleter (const char *dirnm, const BufferStringSet *externallist=nullptr, bool filesonly=false)
const char *	getRelativePath (const char *reltodir, const char *fnm)
const char *	getRootPath (const char *path)
const char *	getSizeUnitString (SizeUnit)
const char *	getTempPath ()
od_int64	getTimeInMilliSeconds (const char *filenm, bool modif=true, bool followlink=true)
od_int64	getTimeInSeconds (const char *filenm, bool modif=true, bool followlink=true)
bool	getTimes (const char *filenm, Time::FileTimeSet &, bool followlink=true)
	Retrieve file timestamps.
Type	getType (const char *, bool followlinks=false)
const char *	getUserAppDataPath ()
const char *	getViewStyleString (ViewStyle)
void	hide (const char *fnm, bool yn)
bool	initTempDir ()
bool	isDirectory (const char *)
bool	isDirEmpty (const char *)
bool	isEmpty (const char *)
bool	isExecutable (const char *)
bool	isFile (const char *)
bool	isFileInUse (const char *fnm)
bool	isHidden (const char *)
bool	isInUse (const char *fnm)
bool	isLink (const char *fnm)
bool	isLocal (const char *)
bool	isReadable (const char *)
bool	isShortcut (const char *)
bool	isSymbolicLink (const char *)
bool	isSymLink (const char *)
bool	isSystem (const char *)
bool	isURI (const char *)
bool	isWritable (const char *)
bool	launchViewer (const char *, const ViewPars &vp=ViewPars())
const char *	linkEnd (const char *linkname)
const char *	linkTarget (const char *)
const char *	linkValue (const char *linkname)
bool	listDir (const char *, DirListType, BufferStringSet &fnames, const char *mask=nullptr)
bool	makeExecutable (const char *fnm, bool yn)
bool	makeReadOnly (const char *fnm, bool recursive)
void	makeRecursiveFileList (const char *dir, BufferStringSet &filelist, bool followlinks=false)
bool	makeWritable (const char *fnm, bool yn, bool recursive)
int	maxPathLength ()
bool	parseEnum (const char *, SizeUnit &)
bool	parseEnum (const char *, ViewStyle &)
bool	parseEnum (const IOPar &, const char *, SizeUnit &)
bool	parseEnum (const IOPar &, const char *, ViewStyle &)
SizeUnit	parseEnumSizeUnit (const char *)
bool	parseEnumSizeUnit (const char *, SizeUnit &)
ViewStyle	parseEnumViewStyle (const char *)
bool	parseEnumViewStyle (const char *, ViewStyle &)
bool	putContent (const char *buf, int sz, const char *tofnm)
bool	putContent (const OD::String &, const char *tofnm)
bool	remove (const char *)
bool	removeDir (const char *)
bool	rename (const char *oldname, const char *newname, uiString *errmsg=nullptr)
bool	resize (const char *, od_int64)
bool	saveCopy (const char *from, const char *to, bool preserve=true)
bool	setExecutable (const char *, bool yn, bool recursive=false)
bool	setHiddenFileAttrib (const char *, bool yn)
	only Windows local files
bool	setPermissions (const char *, const Permissions &)
bool	setReadOnly (const char *fnm, bool recursive=false)
bool	setSystemFileAttrib (const char *, bool yn)
	only Windows local files
bool	setTimes (const char *filenm, const Time::FileTimeSet &, bool followlink=true)
	Set file timestamps (if supported by OS)
bool	setWritable (const char *, bool yn, bool recursive=false)
const EnumDefImpl< SizeUnit > &	SizeUnitDef ()
const char **	SizeUnitNames ()
const char *	textFilesFilter ()
const char *	timeCreated (const char *filenm, const char *fmt=Time::defDateTimeFmt(), bool followlink=true)
const char *	timeLastModified (const char *filenm, const char *fmt=Time::defDateTimeFmt(), bool followlink=true)
const char *	toString (SizeUnit)
const char *	toString (ViewStyle)
uiString	toUiString (SizeUnit)
uiString	toUiString (ViewStyle)
const EnumDefImpl< ViewStyle > &	ViewStyleDef ()
const char **	ViewStyleNames ()
bool	waitUntilExists (const char *fnm, double maxwaittm, double *actualwaited)

Variables
const char *	SizeUnitKeys_ []
const char *	ViewStyleKeys_ []

Detailed Description

Interface for several file and directory related services.

Enumeration Type Documentation

DirListType

enum class File::DirListType

strong

Enumerator
AllEntriesInDir
FilesInDir
DirsInDir

Permission

enum class File::Permission

strong

Enumerator
ReadOwner
WriteOwner
ExeOwner
ReadUser
WriteUser
ExeUser
ReadGroup
WriteGroup
ExeGroup
ReadOther
WriteOther
ExeOther

SizeUnit

enum class File::SizeUnit

strong

Enumerator
Bytes
KB
MB
GB
TB
PB
Auto

Type

enum class File::Type

strong

Enumerator
File
Directory
SymLink
Alias
Shortcut
Character
Block
Fifo
Socket
URI
Other
Unknown

ViewStyle

enum class File::ViewStyle

strong

Enumerator
Text
Table
Log
Bin

Function Documentation

allFilesFilter()

const char * File::allFilesFilter

(

)

asciiFilesFilter()

const char * File::asciiFilesFilter

(

)

changeDir()

bool File::changeDir

(

const char *

path

)

checkDir()

bool File::checkDir	(	const char *	fnm,
		bool	forread,
		uiString *	errmsg = nullptr )

checks if the parent directory of a file is readable/writable

copy()

bool File::copy	(	const char *	from,
		const char *	to,
		bool	preserve = true,
		uiString *	errmsg = nullptr,
		TaskRunner *	= nullptr )

copyDir()

bool File::copyDir	(	const char *	from,
		const char *	to,
		bool	preserve = true,
		uiString *	errmsg = nullptr,
		TaskRunner *	= nullptr )

createDir()

bool File::createDir

(

const char *

)

createLink()

bool File::createLink	(	const char *	from,
		const char *	to )

will be a shortcut on Windows and a symbolic link on Unix

exists()

bool File::exists

(

const char *

)

always follows links, returns false if the link is broken

findExecutable()

BufferString File::findExecutable	(	const char *	exenm,
		const BufferStringSet &	paths,
		bool	includesyspath = true )

getAbsolutePath()

const char * File::getAbsolutePath	(	const char *	dir,
		const char *	relfnm )

getCanonicalPath()

const char * File::getCanonicalPath

(

const char *

)

getContent()

bool File::getContent	(	const char *	,
		BufferString &	)

getCurrentPath()

const char * File::getCurrentPath

(

)

getFileSize()

od_int64 File::getFileSize	(	const char *	fnm,
		bool	followlink = true )

getFileSizeString() [1/2]

BufferString File::getFileSizeString	(	const char *	fnm,
		File::SizeUnit	= File::SizeUnit::Auto )

getFileSizeString() [2/2]

BufferString File::getFileSizeString	(	od_int64	filesz,
		File::SizeUnit	= File::SizeUnit::Auto )

getHash()

BufferString File::getHash	(	const char *	,
		Crypto::Algorithm	)

getHomePath()

const char * File::getHomePath

(

)

getKbSize()

od_int64 File::getKbSize

(

const char *

)

getPermissions()

Permissions File::getPermissions

(

const char *

fnm

)

getRecursiveCopier()

Executor * File::getRecursiveCopier	(	const char *	from,
		const char *	to,
		bool	preserve = true )

getRecursiveDeleter()

Executor * File::getRecursiveDeleter	(	const char *	dirnm,
		const BufferStringSet *	externallist = nullptr,
		bool	filesonly = false )

getRelativePath()

const char * File::getRelativePath	(	const char *	reltodir,
		const char *	fnm )

getRootPath()

const char * File::getRootPath

(

const char *

path

)

getSizeUnitString()

const char * File::getSizeUnitString

(

SizeUnit

)

getTempPath()

const char * File::getTempPath

(

)

getTimeInMilliSeconds()

od_int64 File::getTimeInMilliSeconds	(	const char *	filenm,
		bool	modif = true,
		bool	followlink = true )

getTimeInSeconds()

od_int64 File::getTimeInSeconds	(	const char *	filenm,
		bool	modif = true,
		bool	followlink = true )

getTimes()

bool File::getTimes	(	const char *	filenm,
		Time::FileTimeSet &	,
		bool	followlink = true )

Retrieve file timestamps.

getType()

Type File::getType	(	const char *	,
		bool	followlinks = false )

getUserAppDataPath()

const char * File::getUserAppDataPath

(

)

getViewStyleString()

const char * File::getViewStyleString

(

ViewStyle

)

hide()

void File::hide ( const char * fnm, bool yn )

inline

initTempDir()

bool File::initTempDir

(

)

isDirectory()

bool File::isDirectory

(

const char *

)

isDirEmpty()

bool File::isDirEmpty

(

const char *

)

isEmpty()

bool File::isEmpty

(

const char *

)

isExecutable()

bool File::isExecutable

(

const char *

)

isFile()

bool File::isFile

(

const char *

)

isFileInUse()

bool File::isFileInUse ( const char * fnm )

inline

isHidden()

bool File::isHidden

(

const char *

)

isInUse()

bool File::isInUse

(

const char *

fnm

)

isLink()

bool File::isLink ( const char * fnm )

inline

isLocal()

bool File::isLocal

(

const char *

)

isReadable()

bool File::isReadable

(

const char *

)

isShortcut()

bool File::isShortcut

(

const char *

)

true if the object points to a shortcut

isSymbolicLink()

bool File::isSymbolicLink

(

const char *

)

true if the object points to a symbolic link

isSymLink()

bool File::isSymLink

(

const char *

)

true if the file points to a symbolic link, shortcut (Windows) or alias (macOS)

isSystem()

bool File::isSystem

(

const char *

)

isURI()

bool File::isURI

(

const char *

)

isWritable()

bool File::isWritable

(

const char *

)

launchViewer()

bool File::launchViewer	(	const char *	,
		const ViewPars &	vp = ViewPars() )

linkEnd()

const char * File::linkEnd

(

const char *

linkname

)

'Final' destination of link protected against circular links

linkTarget()

const char * File::linkTarget

(

const char *

)

linkValue()

const char * File::linkValue

(

const char *

linkname

)

listDir()

bool File::listDir	(	const char *	,
		DirListType	,
		BufferStringSet &	fnames,
		const char *	mask = nullptr )

makeExecutable()

bool File::makeExecutable ( const char * fnm, bool yn )

inline

makeReadOnly()

bool File::makeReadOnly ( const char * fnm, bool recursive )

inline

makeRecursiveFileList()

void File::makeRecursiveFileList	(	const char *	dir,
		BufferStringSet &	filelist,
		bool	followlinks = false )

makeWritable()

bool File::makeWritable ( const char * fnm, bool yn, bool recursive )

inline

maxPathLength()

int File::maxPathLength

(

)

parseEnum() [1/4]

bool File::parseEnum	(	const char *	,
		SizeUnit &	)

parseEnum() [2/4]

bool File::parseEnum	(	const char *	,
		ViewStyle &	)

parseEnum() [3/4]

bool File::parseEnum	(	const IOPar &	,
		const char *	,
		SizeUnit &	)

parseEnum() [4/4]

bool File::parseEnum	(	const IOPar &	,
		const char *	,
		ViewStyle &	)

parseEnumSizeUnit() [1/2]

SizeUnit File::parseEnumSizeUnit

(

const char *

)

parseEnumSizeUnit() [2/2]

bool File::parseEnumSizeUnit	(	const char *	,
		SizeUnit &	)

parseEnumViewStyle() [1/2]

ViewStyle File::parseEnumViewStyle

(

const char *

)

parseEnumViewStyle() [2/2]

bool File::parseEnumViewStyle	(	const char *	,
		ViewStyle &	)

putContent() [1/2]

bool File::putContent	(	const char *	buf,
		int	sz,
		const char *	tofnm )

putContent() [2/2]

bool File::putContent	(	const OD::String &	,
		const char *	tofnm )

remove()

bool File::remove

(

const char *

)

removeDir()

bool File::removeDir

(

const char *

)

If path is a link, the target directory is recursively removed, the link remains

rename()

bool File::rename	(	const char *	oldname,
		const char *	newname,
		uiString *	errmsg = nullptr )

resize()

bool File::resize	(	const char *	,
		od_int64	)

saveCopy()

bool File::saveCopy	(	const char *	from,
		const char *	to,
		bool	preserve = true )

setExecutable()

bool File::setExecutable	(	const char *	,
		bool	yn,
		bool	recursive = false )

setHiddenFileAttrib()

bool File::setHiddenFileAttrib	(	const char *	,
		bool	yn )

only Windows local files

setPermissions()

bool File::setPermissions	(	const char *	,
		const Permissions &	)

setReadOnly()

bool File::setReadOnly	(	const char *	fnm,
		bool	recursive = false )

setSystemFileAttrib()

bool File::setSystemFileAttrib	(	const char *	,
		bool	yn )

only Windows local files

setTimes()

bool File::setTimes	(	const char *	filenm,
		const Time::FileTimeSet &	,
		bool	followlink = true )

Set file timestamps (if supported by OS)

setWritable()

bool File::setWritable	(	const char *	,
		bool	yn,
		bool	recursive = false )

SizeUnitDef()

const EnumDefImpl< SizeUnit > & File::SizeUnitDef

(

)

SizeUnitNames()

const char ** File::SizeUnitNames

(

)

textFilesFilter()

const char * File::textFilesFilter

(

)

timeCreated()

const char * File::timeCreated	(	const char *	filenm,
		const char *	fmt = Time::defDateTimeFmt(),
		bool	followlink = true )

timeLastModified()

const char * File::timeLastModified	(	const char *	filenm,
		const char *	fmt = Time::defDateTimeFmt(),
		bool	followlink = true )

toString() [1/2]

const char * File::toString

(

SizeUnit

)

toString() [2/2]

const char * File::toString

(

ViewStyle

)

toUiString() [1/2]

uiString File::toUiString

(

SizeUnit

)

toUiString() [2/2]

uiString File::toUiString

(

ViewStyle

)

ViewStyleDef()

const EnumDefImpl< ViewStyle > & File::ViewStyleDef

(

)

ViewStyleNames()

const char ** File::ViewStyleNames

(

)

waitUntilExists()

bool File::waitUntilExists	(	const char *	fnm,
		double	maxwaittm,
		double *	actualwaited )

Variable Documentation

SizeUnitKeys_

const char* File::SizeUnitKeys_[]

extern

ViewStyleKeys_

const char* File::ViewStyleKeys_[]

extern