A class which provides management for files, e.g. reading contents of directories, deleting files, renaming files, etc. More...

#import <ObjFW/OFFileManager.h>

Inheritance diagram for OFFileManager:

Instance Methods
(OFString *)	- currentDirectoryPath
	Returns the path for the current working directory. More...

(bool)	- fileExistsAtPath:
	Checks whether a file exists at the specified path. More...

(bool)	- directoryExistsAtPath:
	Checks whether a directory exists at the specified path. More...

(bool)	- symbolicLinkExistsAtPath:
	Checks whether a symbolic link exists at the specified path. More...

(void)	- createDirectoryAtPath:
	Creates a directory at the specified path. More...

(void)	- createDirectoryAtPath:createParents:
	Creates a directory at the specified path. More...

(OFArray *)	- contentsOfDirectoryAtPath:
	Returns an array with the items in the specified directory. More...

(void)	- changeCurrentDirectoryPath:
	Changes the current working directory. More...

(of_offset_t)	- sizeOfFileAtPath:
	Returns the size of the specified file. More...

(OFDate *)	- accessTimeOfItemAtPath:
	Returns the last access time of the specified item. More...

(OFDate *)	- modificationTimeOfItemAtPath:
	Returns the last modification time of the specified item. More...

(OFDate *)	- statusChangeTimeOfItemAtPath:
	Returns the last status change time of the specified item. More...

(uint16_t)	- permissionsOfItemAtPath:
	Returns the permissions of the specified item. More...

(void)	- changePermissionsOfItemAtPath:permissions:
	Changes the permissions of an item. More...

(void)	- getOwner:group:ofItemAtPath:
	Get the owner and group of the specified item. More...

(void)	- changeOwnerOfItemAtPath:owner:group:
	Changes the owner of an item. More...

(void)	- copyItemAtPath:toPath:
	Copies a file, directory or symlink (if supported by the OS). More...

(void)	- moveItemAtPath:toPath:
	Moves an item. More...

(void)	- removeItemAtPath:
	Removes the item at the specified path. More...

(void)	- linkItemAtPath:toPath:
	Creates a hard link for the specified item. More...

(void)	- createSymbolicLinkAtPath:withDestinationPath:
	Creates a symbolic link for an item. More...

(OFString *)	- destinationOfSymbolicLinkAtPath:
	Returns the destination of the symbolic link at the specified path. More...

Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object. More...

(OFString *)	- className
	Returns the name of the object's class. More...

(OFString *)	- description
	Returns a description for the object. More...

(nullable void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool. More...

(nullable void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool. More...

(nullable void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size. More...

(nullable void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size. More...

(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool. More...

(void)	- dealloc
	Deallocates the object. More...

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay. More...

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay. More...

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay. More...

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread. More...

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object. More...

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects. More...

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread. More...

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object. More...

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects. More...

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay. More...

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay. More...

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay. More...

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. More...

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver. More...

(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver. More...

Instance Methods inherited from <OFObject>
(bool)	- isKindOfClass:
	Returns a boolean whether the object of the specified kind. More...

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class. More...

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector. More...

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector. More...

(nullable const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector. More...

(nullable id)	- performSelector:
	Performs the specified selector. More...

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object. More...

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects. More...

(bool)	- isEqual:
	Checks two objects for equality. More...

(uint32_t)	- hash
	Calculates a hash for the object. More...

(id)	- retain
	Increases the retain count. More...

(unsigned int)	- retainCount
	Returns the retain count. More...

(void)	- release
	Decreases the retain count. More...

(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...

(id)	- self
	Returns the receiver. More...

(bool)	- isProxy
	Returns whether the object is a proxy object. More...

(bool)	- allowsWeakReference
	Returns whether the class allows weak references. More...

(bool)	- retainWeakReference
	Retain a weak reference to this object. More...

Class Methods
(OFFileManager *)	+ defaultManager
	Returns the default file manager.

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime. More...

(void)	+ unload
	A method which is called when the class is unloaded from the runtime. More...

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made. More...

(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object. More...

(id)	+ new
	Allocates memory for a new instance and calls init on it. More...

(Class)	+ class
	Returns the class. More...

(OFString *)	+ className
	Returns the name of the class as a string. More...

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class. More...

(nullable Class)	+ superclass
	Returns the superclass of the class. More...

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector. More...

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol. More...

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector. More...

(nullable const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector. More...

(OFString *)	+ description
	Returns a description for the class, which is usually the class name. More...

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class. More...

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class. More...

(nullable IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method. More...

(nullable IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method. More...

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver. More...

(BOOL)	+ resolveClassMethod:
	Try to resolve the specified class method. More...

(BOOL)	+ resolveInstanceMethod:
	Try to resolve the specified instance method. More...

(id)	+ copy
	Returns the class. More...

Detailed Description

A class which provides management for files, e.g. reading contents of directories, deleting files, renaming files, etc.

Method Documentation

◆ accessTimeOfItemAtPath:()

- (OFDate *) accessTimeOfItemAtPath: (OFString *) path

Returns the last access time of the specified item.

Parameters

path	The path to the item whose last access time should be returned

Returns: The last access time of the specified item

◆ changeCurrentDirectoryPath:()

- (void) changeCurrentDirectoryPath: (OFString *) path

Changes the current working directory.

Parameters

path	The new directory to change to

◆ changeOwnerOfItemAtPath:owner:group:()

- (void) changeOwnerOfItemAtPath:	(OFString *)	path
owner:	(OFString *)	owner
group:	(OFString *)	group

Changes the owner of an item.

This method is not available on some systems, most notably Windows.

Parameters

path	The path to the item whose owner should be changed
owner	The new owner for the item
group	The new group for the item

◆ changePermissionsOfItemAtPath:permissions:()

- (void) changePermissionsOfItemAtPath:	(OFString *)	path
permissions:	(uint16_t)	permissions

Changes the permissions of an item.

This only changes the permissions, meaning read, write and execute for owner, user and group. For security reasons, it ignores all other bits. In other words, the permissions are masked with 0777.

This method only changes the read-only flag on Windows.

Parameters

path	The path to the item whose permissions should be changed
permissions	The new permissions for the item

◆ contentsOfDirectoryAtPath:()

- (OFArray *) contentsOfDirectoryAtPath: (OFString *) path

Returns an array with the items in the specified directory.

Note: . and .. are not part of the returned array.

Parameters

path	The path to the directory whose items should be returned

Returns: An array of OFString with the items in the specified directory

◆ copyItemAtPath:toPath:()

- (void) copyItemAtPath:	(OFString *)	source
toPath:	(OFString *)	destination

Copies a file, directory or symlink (if supported by the OS).

The destination path must be a full path, which means it must include the name of the item.

If an item already exists, the copy operation fails. This is also the case if a directory is copied and an item already exists in the destination directory.

Parameters

source	The file, directory or symlink to copy
destination	The destination path

◆ createDirectoryAtPath:()

- (void) createDirectoryAtPath: (OFString *) path

Creates a directory at the specified path.

Parameters

path	The path of the directory to create

◆ createDirectoryAtPath:createParents:()

- (void) createDirectoryAtPath:	(OFString *)	path
createParents:	(bool)	createParents

Creates a directory at the specified path.

Parameters

path	The path of the directory to create
createParents	Whether to create the parents of the directory

◆ createSymbolicLinkAtPath:withDestinationPath:()

- (void) createSymbolicLinkAtPath:	(OFString *)	destination
withDestinationPath:	(OFString *)	source

Creates a symbolic link for an item.

The destination path must be a full path, which means it must include the name of the item.

This method is not available on some systems.

Note: On Windows, this requires at least Windows Vista and administrator privileges!

Parameters

destination	The path to the item which should symbolically link to the source
source	The path to the item for which a symbolic link should be created

◆ currentDirectoryPath()

- (OFString *) currentDirectoryPath

Returns the path for the current working directory.

Returns: The path of the current working directory

◆ destinationOfSymbolicLinkAtPath:()

- (OFString *) destinationOfSymbolicLinkAtPath: (OFString *) path

Returns the destination of the symbolic link at the specified path.

Parameters

path	The path to the symbolic link

Note: On Windows, at least Windows Vista is required.

Returns: The destination of the symbolic link at the specified path

◆ directoryExistsAtPath:()

- (bool) directoryExistsAtPath: (OFString *) path

Checks whether a directory exists at the specified path.

Parameters

path	The path to check

Returns: A boolean whether there is a directory at the specified path

◆ fileExistsAtPath:()

- (bool) fileExistsAtPath: (OFString *) path

Checks whether a file exists at the specified path.

Parameters

path	The path to check

Returns: A boolean whether there is a file at the specified path

◆ getOwner:group:ofItemAtPath:()

- (void) getOwner:	(OFString __autoreleasing _Nonnull _Nullable)	owner
group:	(OFString __autoreleasing _Nonnull _Nullable)	group
ofItemAtPath:	(OFString *)	path

Get the owner and group of the specified item.

Parameters

owner	A pointer to an `OFString *` to store the owner, or nil
group	A pointer to an `OFString *` to store the group, or nil
path	The path to the item whose owner and group should be retrieved

◆ linkItemAtPath:toPath:()

- (void) linkItemAtPath:	(OFString *)	source
toPath:	(OFString *)	destination

Creates a hard link for the specified item.

The destination path must be a full path, which means it must include the name of the item.

This method is not available on some systems.

Parameters

source	The path to the item for which a link should be created
destination	The path to the item which should link to the source

◆ modificationTimeOfItemAtPath:()

- (OFDate *) modificationTimeOfItemAtPath: (OFString *) path

Returns the last modification time of the specified item.

Parameters

path	The path to the item whose last modification time should be returned

Returns: The last modification time of the specified item

◆ moveItemAtPath:toPath:()

- (void) moveItemAtPath:	(OFString *)	source
toPath:	(OFString *)	destination

Moves an item.

The destination path must be a full path, which means it must include the name of the item.

If the destination is on a different logical device, the source will be copied to the destination using copyItemAtPath:toPath: and the source removed using removeItemAtPath:.

Parameters

source	The item to rename
destination	The new name for the item

◆ permissionsOfItemAtPath:()

- (uint16_t) permissionsOfItemAtPath: (OFString *) path

Returns the permissions of the specified item.

This returns only the permissions, meaning read, write and execute for owner, user and group, along with the sticky, setuid and setgid bit. In other words, only bits that match the mask 07777.

Parameters

path	The path to the item whose permissions should be returned

Returns: The permissions of the specified item

◆ removeItemAtPath:()

- (void) removeItemAtPath: (OFString *) path

Removes the item at the specified path.

If the item at the specified path is a directory, it is removed recursively.

Parameters

path	The path to the item which should be removed

◆ sizeOfFileAtPath:()

- (of_offset_t) sizeOfFileAtPath: (OFString *) path

Returns the size of the specified file.

Parameters

path	The path to the file whose size should be returned

Returns: The size of the specified file

◆ statusChangeTimeOfItemAtPath:()

- (OFDate *) statusChangeTimeOfItemAtPath: (OFString *) path

Returns the last status change time of the specified item.

Parameters

path	The path to the item whose last status change time should be returned

Returns: The last status change time of the specified item

◆ symbolicLinkExistsAtPath:()

- (bool) symbolicLinkExistsAtPath: (OFString *) path

Checks whether a symbolic link exists at the specified path.

Parameters

path	The path to check

Returns: A boolean whether there is a symbolic link at the specified path

The documentation for this class was generated from the following files:

src/OFFileManager.h
src/OFFileManager.m

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ accessTimeOfItemAtPath:()

◆ changeCurrentDirectoryPath:()

◆ changeOwnerOfItemAtPath:owner:group:()

◆ changePermissionsOfItemAtPath:permissions:()

◆ contentsOfDirectoryAtPath:()

◆ copyItemAtPath:toPath:()

◆ createDirectoryAtPath:()

◆ createDirectoryAtPath:createParents:()

◆ createSymbolicLinkAtPath:withDestinationPath:()

◆ currentDirectoryPath()

◆ destinationOfSymbolicLinkAtPath:()

◆ directoryExistsAtPath:()

◆ fileExistsAtPath:()

◆ getOwner:group:ofItemAtPath:()

◆ linkItemAtPath:toPath:()

◆ modificationTimeOfItemAtPath:()

◆ moveItemAtPath:toPath:()

◆ permissionsOfItemAtPath:()

◆ removeItemAtPath:()

◆ sizeOfFileAtPath:()

◆ statusChangeTimeOfItemAtPath:()

◆ symbolicLinkExistsAtPath:()