File.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the Water library.
   Copyright (c) 2016 ROLI Ltd.
   Copyright (C) 2017-2023 Filipe Coelho <falktx@falktx.com>
 
   Permission is granted to use this software under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license/
 
   Permission to use, copy, modify, and/or distribute this software for any
   purpose with or without fee is hereby granted, provided that the above
   copyright notice and this permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT,
   OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
   USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
   TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
   OF THIS SOFTWARE.
 
  ==============================================================================
*/
 
#ifndef WATER_FILE_H_INCLUDED
#define WATER_FILE_H_INCLUDED
 
#include "../containers/Array.h"
#include "../misc/Result.h"
#include "../text/String.h"
 
#include <vector>
 
namespace water {
 
//==============================================================================
class File
{
public:
    //==============================================================================
    File() noexcept;

    File (const String& absolutePath);

    File (const File&);

    ~File() noexcept  {}

    File& operator= (const String& newAbsolutePath);

    File& operator= (const File& otherFile);
 
    //==============================================================================
    bool exists() const;

    bool existsAsFile() const;

    bool isDirectory() const;

    bool isNull() const;

    bool isNotNull() const;

    int64 getSize() const;

    static String descriptionOfSizeInBytes (int64 bytes);
 
    //==============================================================================
    const String& getFullPathName() const noexcept          { return fullPath; }

    String getFileName() const;

    String getRelativePathFrom (const File& directoryToBeRelativeTo) const;
 
    //==============================================================================
    String getFileExtension() const;

    bool hasFileExtension (StringRef extensionToTest) const;

    File withFileExtension (StringRef newExtension) const;

    String getFileNameWithoutExtension() const;
 
    //==============================================================================
    File getChildFile (StringRef relativeOrAbsolutePath) const;

    File getSiblingFile (StringRef siblingFileName) const;
 
    //==============================================================================
    File getParentDirectory() const;

    bool isAChildOf (const File& potentialParentDirectory) const;
 
    //==============================================================================
    File getNonexistentChildFile (const String& prefix,
                                  const String& suffix,
                                  bool putNumbersInBrackets = true) const;

    File getNonexistentSibling (bool putNumbersInBrackets = true) const;
 
    //==============================================================================
    bool operator== (const File&) const;
    bool operator!= (const File&) const;
    bool operator< (const File&) const;
    bool operator> (const File&) const;
 
    //==============================================================================
    bool hasWriteAccess() const;

    bool isHidden() const;
 
    //==============================================================================
    int64 getLastModificationTime() const;

    int64 getLastAccessTime() const;

    int64 getCreationTime() const;
 
    //==============================================================================
    Result create() const;

    Result createDirectory() const;

    bool deleteFile() const;

    bool deleteRecursively() const;

    bool moveFileTo (const File& targetLocation) const;

    bool copyFileTo (const File& targetLocation) const;

    bool replaceFileIn (const File& targetLocation) const;

    bool copyDirectoryTo (const File& newDirectory) const;
 
    //==============================================================================
    enum TypesOfFileToFind
    {
        findDirectories             = 1,    
        findFiles                   = 2,    
        findFilesAndDirectories     = 3,    
        ignoreHiddenFiles           = 4     
    };

    uint findChildFiles (std::vector<File>& results,
                         int whatToLookFor,
                         bool searchRecursively,
                         const String& wildCardPattern = "*") const;

    uint getNumberOfChildFiles (int whatToLookFor,
                                const String& wildCardPattern = "*") const;

    bool containsSubDirectories() const;
 
    //==============================================================================
    FileInputStream* createInputStream() const;

    FileOutputStream* createOutputStream (size_t bufferSize = 0x8000) const;
 
    //==============================================================================
    bool loadFileAsData (MemoryBlock& result) const;

    String loadFileAsString() const;

    void readLines (StringArray& destLines) const;
 
    //==============================================================================
    bool appendData (const void* dataToAppend,
                     size_t numberOfBytes) const;

    bool replaceWithData (const void* dataToWrite,
                          size_t numberOfBytes) const;

    bool appendText (const String& textToAppend,
                     bool asUnicode = false,
                     bool writeUnicodeHeaderBytes = false) const;

    bool replaceWithText (const String& textToWrite,
                          bool asUnicode = false,
                          bool writeUnicodeHeaderBytes = false) const;

    bool hasIdenticalContentTo (const File& other) const;
 
    //==============================================================================
    enum SpecialLocationType
    {
        userHomeDirectory,

        tempDirectory,

        currentExecutableFile,

        hostApplicationPath,

        winAppData, winProgramFiles, winCommonProgramFiles, winMyDocuments
    };

    static File  getSpecialLocation (const SpecialLocationType type);
 
    //==============================================================================
    static File createTempFile (StringRef fileNameEnding);
 
    //==============================================================================
    static File getCurrentWorkingDirectory();

    bool setAsCurrentWorkingDirectory() const;
 
    //==============================================================================
    static const water_uchar separator;

    static const String separatorString;
 
    //==============================================================================
    static String createLegalFileName (const String& fileNameToFix);

    static String createLegalPathName (const String& pathNameToFix);

    static bool areFileNamesCaseSensitive();

    static bool isAbsolutePath (StringRef path);

    static File createFileWithoutCheckingPath (const String& absolutePath) noexcept;

    static String addTrailingSeparator (const String& path);
 
    //==============================================================================
    bool createSymbolicLink (const File& linkFileToCreate, bool overwriteExisting) const;

    bool isSymbolicLink() const;

    File getLinkedTarget() const;
 
    //==============================================================================
    struct NaturalFileComparator
    {
        NaturalFileComparator (bool shouldPutFoldersFirst) noexcept : foldersFirst (shouldPutFoldersFirst) {}
 
        int compareElements (const File& firstFile, const File& secondFile) const
        {
            if (foldersFirst && (firstFile.isDirectory() != secondFile.isDirectory()))
                return firstFile.isDirectory() ? -1 : 1;
 
            return firstFile.getFullPathName().compareNatural (secondFile.getFullPathName(), File::areFileNamesCaseSensitive());
        }
 
        bool foldersFirst;
    };
 
private:
    //==============================================================================
    String fullPath;
 
    static String parseAbsolutePath (const String&);
    String getPathUpToLastSlash() const;
 
    Result createDirectoryInternal (const String&) const;
    bool copyInternal (const File&) const;
    bool moveInternal (const File&) const;
    bool replaceInternal (const File&) const;
    void getFileTimesInternal (int64& m, int64& a, int64& c) const;
    bool setFileReadOnlyInternal (bool) const;
    bool setFileExecutableInternal (bool) const;
};
 
}
 
#endif // WATER_FILE_H_INCLUDED