Vuo  0.7.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Static Public Member Functions | List of all members
VuoFileUtilities Class Reference

Description

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 getTmpDir (void)
 Returns the path of the default temporary directory.
 
static string getVuoFrameworkPath (void)
 Returns the path of Vuo.framework, or an empty string if Vuo.framework cannot be located.
 
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 set< File * > findAllFilesInDirectory (string dirPath, set< string > archiveExtensions=set< string >())
 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.
 

Member Function Documentation

bool VuoFileUtilities::fileExists ( string  path)
static

Returns true if the file exists.

set< VuoFileUtilities::File * > VuoFileUtilities::findAllFilesInArchive ( string  archivePath)
static

Recursively searches an archive for files.

Parameters
archivePathThe archive to search in.
Returns
All files found.
set< VuoFileUtilities::File * > VuoFileUtilities::findAllFilesInDirectory ( string  dirPath,
set< string >  archiveExtensions = set<string>() 
)
static

Searches a directory for files.

Parameters
dirPathThe directory to search in. Only the top level is searched.
archiveExtensionsThe 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.
Returns
All files found.
Todo:
Search recursively - https://b33p.net/kosada/node/2468
set< VuoFileUtilities::File * > VuoFileUtilities::findFilesInArchive ( string  archivePath,
string  dirPath,
set< string >  extensions 
)
static

Recursively searches an archive for files within a given directory and with a given extension.

Parameters
archivePathThe archive to search in.
dirPathThe 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/").
extensionsThe file extensions to search for, without the '.' character (e.g. "bc" not ".bc").
Returns
All files found.
set< VuoFileUtilities::File * > VuoFileUtilities::findFilesInDirectory ( string  dirPath,
set< string >  extensions,
set< string >  archiveExtensions = set<string>() 
)
static

Searches a directory for files with a given extension.

Parameters
dirPathThe directory to search in. Only the top level is searched.
archiveExtensionsThe 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.
extensionsThe file extensions to search for, without the '.' character (e.g. "bc" not ".bc").
Returns
All files found.
string VuoFileUtilities::getArchiveFileContentsAsString ( string  archivePath,
string  filePath 
)
static

Returns the contents of a file within an archive.

If the file doesn't exist, returns an empty string.

Parameters
archivePathThe archive containing the file.
filePathThe file. The path should be relative to the archive's root.
Returns
The file's contents.
size_t VuoFileUtilities::getFirstInsertionIndex ( string  s)
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.

string VuoFileUtilities::getTmpDir ( void  )
static

Returns the path of the default temporary directory.

string VuoFileUtilities::getVuoFrameworkPath ( void  )
static

Returns the path of Vuo.framework, or an empty string if Vuo.framework cannot be located.

string VuoFileUtilities::makeTmpDir ( string  dir)
static

Creates a new temporary directory, avoiding any name conflicts with existing files.

Returns the path of the directory.

string VuoFileUtilities::makeTmpFile ( string  file,
string  extension,
string  directory = "/tmp" 
)
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.

Todo:
Keep file open and return file handle. (https://b33p.net/kosada/node/4987)
string VuoFileUtilities::readFileToString ( string  path)
static

Reads the whole contents of the file into a string.

string VuoFileUtilities::readStdinToString ( void  )
static

Reads from standard input into a string until the end-of-file is reached.

void VuoFileUtilities::splitPath ( string  path,
string &  dir,
string &  file,
string &  extension 
)
static

Splits path into its directory, file name, and file extension.

Parameters
[in]pathThe path to split.
[out]dirThe directory in path, if any. Ends with a file separator (e.g. '/') if there was one in path.
[out]fileThe file name in path, if any.
[out]extensionThe file extension in path, if any. Does not include the '.' character.
void VuoFileUtilities::writeRawDataToFile ( const char *  data,
size_t  numBytes,
string  file 
)
static

Writes the array of bytes to the file.

If the file already exists, it gets overwritten.

void VuoFileUtilities::writeStringToFile ( string  s,
string  file 
)
static

Writes the string to the file.

If the file already exists, it gets overwritten.


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