VuoFileUtilities.hh

Go to the documentation of this file.

 
#pragma once
 
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunreachable-code"
#include "miniz.h"
#pragma clang diagnostic pop
 
#import <string>
#import <set>
using namespace std;
 
#include "VuoHeap.h"
 
class VuoFileUtilities
{
public:
    class Archive
    {
    public:
        mz_zip_archive *zipArchive;  
        int referenceCount;  
        string path;  
        Archive(string path);
        ~Archive(void);
    };
 
    class File
    {
    private:
        string filePath;  
        string dirPath;  
        Archive *archive;  
        int fileDescriptor;
 
        friend class VuoFileUtilities;
 
    public:
        File();
        File(string dirPath, string filePath);
        File(Archive *archive, string filePath);
        ~File(void);
 
        File fileWithDifferentExtension(string extension);
 
        bool isInArchive(void);
        string getArchivePath(void);
        string getRelativePath(void);
        string path();
        string dir();
        string basename();
        string extension();
 
        bool exists();
        char * getContentsAsRawData(size_t &numBytes);
        string getContentsAsString(void);
 
        bool lockForReading(bool nonBlocking=false) VuoWarnUnusedResult;
        bool lockForWriting(bool nonBlocking=false) VuoWarnUnusedResult;
        void unlock(void);
    };
 
    static void splitPath(string path, string &dir, string &file, string &extension);
    static void canonicalizePath(string &path);
    static bool arePathsEqual(string path1, string path2);
    static string getAbsolutePath(const string &path);
    static string makeTmpFile(string file, string extension, string directory="");
    static string makeTmpDir(string prefix);
    static string makeTmpDirOnSameVolumeAsPath(string path);
    static string getTmpDir(void);
    static void makeDir(string path);
    static string getVuoFrameworkPath(void);
    static string getVuoRunnerFrameworkPath(void);
    static string getCompositionLocalModulesPath(const string &compositionPath);
    static string getUserModulesPath(void);
    static string getSystemModulesPath(void);
    static string getCachePath(void);
    static bool isInstalledAsModule(const string &path);
    static void preserveOriginalFileName(string &fileContents, string originalFileName);
    static size_t getFirstInsertionIndex(string s);
    static string readStdinToString(void);
    static string readFileToString(string path);
    static void writeRawDataToFile(const char *data, size_t numBytes, string file);
    static void writeStringToFile(string s, string file);
    static void writeStringToFileSafely(string s, string path);
    static bool fileExists(string path);
    static bool dirExists(string path);
    static bool isSymlink(string path);
    static bool fileIsReadable(string path);
    static bool fileContainsReadableData(string path);
    static void createFile(string path);
    static void deleteFile(string path);
    static void deleteDir(string path);
    static void moveFile(string fromPath, string toPath);
    static void moveFileToTrash(string filePath);
    static void copyFile(string fromPath, string toPath, bool preserveMetadata = false);
    static void copyDirectory(string fromPath, string toPath);
    static string calculateFileSHA256(const string &path);
    static unsigned long getFileLastModifiedInSeconds(string path);
    static unsigned long getSecondsSinceFileLastAccessed(string path);
    static set<File *> findAllFilesInDirectory(string dirPath, set<string> archiveExtensions = set<string>(), bool shouldSearchRecursively = false);
    static set<File *> findFilesInDirectory(string dirPath, set<string> extensions, set<string> archiveExtensions = set<string>());
    static set<File *> findAllFilesInArchive(string archivePath);
    static set<File *> findFilesInArchive(string archivePath, string dirPath, set<string> extensions);
    static string getArchiveFileContentsAsString(string archivePath, string filePath);
    static size_t getAvailableSpaceOnVolumeContainingPath(string path);
 
    static void focusProcess(pid_t pid, bool force=false);
    static void executeProcess(vector<string> processAndArgs, vector<string> environment = {});
 
    static bool isCompositionExtension(string extension);
    static set<string> getCSourceExtensions(void);
    static bool isCSourceExtension(string extension);
    static bool isIsfSourceExtension(string extension);
 
    static string buildModuleCacheDescription(const string &moduleCachePath, bool generated);
    static string buildModuleCacheIndexPath(const string &moduleCachePath, bool builtIn, bool generated);
    static string buildModuleCacheDylibPath(const string &moduleCachePath, bool builtIn, bool generated);
    static string findLatestRevisionOfModuleCacheDylib(const string &moduleCachePath, bool builtIn, bool generated, unsigned long &lastModified);
    static void deleteOtherRevisionsOfModuleCacheDylib(const string &dylibPath);
    static bool areDifferentRevisionsOfSameModuleCacheDylib(const string &dylibPath1, const string &dylibPath2);
};