Vuo
1.2.3
|
Functions for dealing with files.
Classes | |
class | File |
A file in either a directory or an archive. More... | |
Static Public Member Functions | |
static void | splitPath (string path, string &dir, string &file, string &extension) |
Splits path into its directory, file name, and file extension. | |
static string | makeTmpFile (string file, string extension, string directory="/tmp") |
Creates a new temporary file, avoiding any name conflicts with existing files. | |
static string | makeTmpDir (string dir) |
Creates a new temporary directory, avoiding any name conflicts with existing files. | |
static string | makeTmpDirOnSameVolumeAsPath (string path) |
Creates a new temporary directory, avoiding any name conflicts with existing files. | |
static string | getTmpDir (void) |
Returns the path of the default temporary directory. | |
static void | makeDir (string path) |
Creates a new directory (and parent directories if needed), if it doesn't already exist. | |
static string | getVuoFrameworkPath (void) |
Returns the absolute path of Vuo.framework (without a trailing slash), or an empty string if Vuo.framework cannot be located. | |
static string | getUserModulesPath (void) |
Returns the filesystem path to the user-specific Vuo Modules folder (without a trailing slash). | |
static string | getSystemModulesPath (void) |
Returns the filesystem path to the system-wide Vuo Modules folder (without a trailing slash). | |
static string | getCachePath (void) |
Returns the filesystem path to the folder that Vuo uses to cache data (without a trailing slash). | |
static void | preserveOriginalFileName (string &fileContents, string originalFileName) |
Saves originalFileName into fileContents so that, when fileContents is written to some other file path, originalFileName will still be the name that shows up in compile errors/warnings and in the FILE macro. | |
static size_t | getFirstInsertionIndex (string s) |
Returns the first index at which content can be inserted into a string that was read from a file. | |
static string | readStdinToString (void) |
Reads from standard input into a string until the end-of-file is reached. | |
static string | readFileToString (string path) |
Reads the whole contents of the file into a string. | |
static void | writeRawDataToFile (const char *data, size_t numBytes, string file) |
Writes the array of bytes to the file. | |
static void | writeStringToFile (string s, string file) |
Writes the string to the file. | |
static bool | fileExists (string path) |
Returns true if the file exists. | |
static bool | dirExists (string path) |
Returns true if the file exists and is a directory. | |
static bool | fileIsReadable (string path) |
Returns true if the file is readable. | |
static bool | fileContainsReadableData (string path) |
Returns true if the file exists, can be opened, and has a size of more than 0 bytes. | |
static void | createFile (string path) |
Creates the file if it does not exist already; otherwise, has no effect on the file. | |
static void | deleteFile (string path) |
Deletes the file if it exists; otherwise, has no effect. | |
static void | moveFile (string fromPath, string toPath) |
Moves the file from fromPath to toPath. | |
static void | moveFileToTrash (string filePath) |
Moves the specified file to the user's trash folder. | |
static void | copyFile (string fromPath, string toPath) |
Copies the file from fromPath to toPath. | |
static unsigned long | getFileLastModifiedInSeconds (string path) |
Returns the time that the file was last modified, in seconds from a reference date. | |
static set< File * > | findAllFilesInDirectory (string dirPath, set< string > archiveExtensions=set< string >(), bool shouldSearchRecursively=false) |
Searches a directory for files. | |
static set< File * > | findFilesInDirectory (string dirPath, set< string > extensions, set< string > archiveExtensions=set< string >()) |
Searches a directory for files with a given extension. | |
static set< File * > | findAllFilesInArchive (string archivePath) |
Recursively searches an archive for files. | |
static set< File * > | findFilesInArchive (string archivePath, string dirPath, set< string > extensions) |
Recursively searches an archive for files within a given directory and with a given extension. | |
static string | getArchiveFileContentsAsString (string archivePath, string filePath) |
Returns the contents of a file within an archive. | |
static size_t | getAvailableSpaceOnVolumeContainingPath (string path) |
Returns the available space, in bytes, on the volume containing the specified path. | |
|
static |
Copies the file from fromPath to toPath.
std::runtime_error | The file couldn't be copied. |
|
static |
Creates the file if it does not exist already; otherwise, has no effect on the file.
|
static |
Deletes the file if it exists; otherwise, has no effect.
|
static |
Returns true if the file exists and is a directory.
|
static |
Returns true if the file exists, can be opened, and has a size of more than 0 bytes.
|
static |
Returns true if the file exists.
|
static |
Returns true if the file is readable.
|
static |
Recursively searches an archive for files.
archivePath | The archive to search in. |
|
static |
Searches a directory for files.
dirPath | The directory to search in. Only the top level is searched. |
archiveExtensions | The file extensions for archives to search in. Any archive with one of these extensions found in the top level of the directory will be searched recursively. |
shouldSearchRecursively | If true, the directory will be searched searched recursively. |
std::runtime_error | The directory couldn't be read. |
|
static |
Recursively searches an archive for files within a given directory and with a given extension.
archivePath | The archive to search in. |
dirPath | The directory to search in within the archive. The path should be relative to the archive's root. The path should omit the trailing file separator (e.g. "examples" not "examples/"). |
extensions | The file extensions to search for, without the '.' character (e.g. "bc" not ".bc"). |
|
static |
Searches a directory for files with a given extension.
dirPath | The directory to search in. Only the top level is searched. |
archiveExtensions | The file extensions for archives to search in. Any archive with one of these extensions found in the top level of the directory will be searched recursively. |
extensions | The file extensions to search for, without the '.' character (e.g. "bc" not ".bc"). |
|
static |
Returns the contents of a file within an archive.
If the file doesn't exist, returns an empty string.
archivePath | The archive containing the file. |
filePath | The file. The path should be relative to the archive's root. |
|
static |
Returns the available space, in bytes, on the volume containing the specified path.
path
should be an absolute POSIX path. Its last few path components needn't exist.
std::runtime_error |
|
static |
Returns the filesystem path to the folder that Vuo uses to cache data (without a trailing slash).
|
static |
Returns the time that the file was last modified, in seconds from a reference date.
This is useful for checking which of two files was modified more recently.
|
static |
Returns the first index at which content can be inserted into a string that was read from a file.
This comes after the Unicode BOM, if present.
|
static |
Returns the filesystem path to the system-wide Vuo Modules folder (without a trailing slash).
|
static |
Returns the path of the default temporary directory.
|
static |
Returns the filesystem path to the user-specific Vuo Modules folder (without a trailing slash).
|
static |
Returns the absolute path of Vuo.framework (without a trailing slash), or an empty string if Vuo.framework cannot be located.
|
static |
Creates a new directory (and parent directories if needed), if it doesn't already exist.
std::runtime_error | The directory couldn't be created. |
|
static |
Creates a new temporary directory, avoiding any name conflicts with existing files.
Returns the path of the directory (without a trailing slash).
|
static |
Creates a new temporary directory, avoiding any name conflicts with existing files.
The temporary directory will be on the same filesystem as the specified path, to facilitate using rename()
(for example). onSameVolumeAsPath
needn't already exist.
Returns the path of the directory (without a trailing slash).
|
static |
Creates a new temporary file, avoiding any name conflicts with existing files.
Creates the file in the specified directory
if one is provided, or in "/tmp" otherwise.
Returns the path of the file.
|
static |
Moves the file from fromPath to toPath.
std::runtime_error | The file couldn't be moved. |
|
static |
Moves the specified file to the user's trash folder.
std::runtime_error | The file couldn't be moved. |
|
static |
Saves originalFileName into fileContents so that, when fileContents is written to some other file path, originalFileName will still be the name that shows up in compile errors/warnings and in the FILE
macro.
This function inserts a preprocessor directive at the beginning of fileContents. Any modifications to fileContents after this function is called should keep the preprocessor directive on the first line.
|
static |
Reads the whole contents of the file into a string.
std::runtime_error | The file couldn't be read. |
|
static |
Reads from standard input into a string until the end-of-file is reached.
|
static |
Splits path
into its directory, file name, and file extension.
[in] | path | The path to split. |
[out] | dir | The directory in path , if any. Ends with a file separator (e.g. '/') if there was one in path . |
[out] | file | The file name in path , if any. |
[out] | extension | The file extension in path , if any. Does not include the '.' character. |
|
static |
Writes the array of bytes to the file.
If the file already exists, it gets overwritten.
std::runtime_error | The file couldn't be written. |
|
static |
Writes the string to the file.
If the file already exists, it gets overwritten.
std::runtime_error | The file couldn't be written. |