fileutils.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_CFILEUTILS_H
#define SWIFT_MISC_CFILEUTILS_H
 
#include <functional>
 
#include <QDir>
#include <QFileInfo>
#include <QFileInfoList>
#include <QLockFile>
#include <QString>
#include <QStringList>
#include <Qt>
 
#include "misc/swiftmiscexport.h"
 
class QDateTime;
 
namespace swift::misc
{
    class SWIFT_MISC_EXPORT CFileUtils
    {
    public:
        static const QString &jsonAppendix();
 
        static const QString &jsonWildcardAppendix();
 
        static bool writeStringToFile(const QString &content, const QString &fileNameAndPath);
 
        static bool writeStringToLockedFile(const QString &content, const QString &fileNameAndPath);
 
        static QString readFileToString(const QString &fileNameAndPath);
 
        static QString readLockedFileToString(const QString &fileNameAndPath);
 
        static QString readFileToString(const QString &filePath, const QString &fileName);
 
        static QString readLockedFileToString(const QString &filePath, const QString &fileName);
 
        static bool writeByteArrayToFile(const QByteArray &data, const QString &fileNameAndPath);
 
        static QString appendFilePaths(const QString &path1, const QString &path2);
 
        static QString appendFilePathsAndFixUnc(const QString &path1, const QString &path2);
 
        static QString appendFilePaths(const QString &path1, const QString &path2, const QString &path3);
 
        static QString appendFilePathsAndFixUnc(const QString &path1, const QString &path2, const QString &path3);
 
        static QString pathUp(const QString &path);
 
        static QString stripFileFromPath(const QString &path);
 
        static QString stripFirstSlashPart(const QString &path);
 
        static QStringList stripFirstSlashParts(const QStringList &paths);
 
        static QString stripLeadingSlashOrDriveLetter(const QString &path);
 
        static QStringList stripLeadingSlashOrDriveLetters(const QStringList &paths);
 
        static QString lastPathSegment(const QString &path);
 
        static QString normalizeFilePathToQtStandard(const QString &filePath);
 
        static QStringList makeDirectoriesRelative(const QStringList &directories, const QString &rootDirectory,
                                                   Qt::CaseSensitivity cs = osFileNameCaseSensitivity());
 
        static bool sameDirectories(const QStringList &dirs1, const QStringList &dirs2,
                                    Qt::CaseSensitivity cs = osFileNameCaseSensitivity());
 
        static Qt::CaseSensitivity osFileNameCaseSensitivity();
 
        static bool isFileNameCaseSensitive();
 
        static bool matchesExcludeDirectory(const QString &directoryPath, const QString &excludePattern,
                                            Qt::CaseSensitivity cs = osFileNameCaseSensitivity());
 
        static bool isExcludedDirectory(const QDir &directory, const QStringList &excludeDirectories,
                                        Qt::CaseSensitivity cs = osFileNameCaseSensitivity());
 
        static bool isExcludedDirectory(const QFileInfo &fileInfo, const QStringList &excludeDirectories,
                                        Qt::CaseSensitivity cs = osFileNameCaseSensitivity());
 
        static bool isExcludedDirectory(const QString &directoryPath, const QStringList &excludeDirectories,
                                        Qt::CaseSensitivity cs = osFileNameCaseSensitivity());
 
        static QStringList removeSubDirectories(const QStringList &directories,
                                                Qt::CaseSensitivity cs = osFileNameCaseSensitivity());
 
        static QString findFirstExisting(const QStringList &filesOrDirectory);
 
        static QString findFirstFile(const QDir &dir, bool recursive, const QStringList &nameFilters = {},
                                     const QStringList &excludeDirectories = {},
                                     std::function<bool(const QFileInfo &)> predicate = {});
 
        static bool containsFile(const QDir &dir, bool recursive, const QStringList &nameFilters = {},
                                 const QStringList &excludeDirectories = {},
                                 std::function<bool(const QFileInfo &)> predicate = {});
 
        static QString findFirstNewerThan(const QDateTime &time, const QDir &dir, bool recursive,
                                          const QStringList &nameFilters = {},
                                          const QStringList &excludeDirectories = {});
 
        static bool containsFileNewerThan(const QDateTime &time, const QDir &dir, bool recursive,
                                          const QStringList &nameFilters = {},
                                          const QStringList &excludeDirectories = {});
 
        static QFileInfoList enumerateFiles(const QDir &dir, bool recursive, const QStringList &nameFilters = {},
                                            const QStringList &excludeDirectories = {},
                                            std::function<bool(const QFileInfo &)> predicate = {});
 
        static QFileInfo findLastModified(const QDir &dir, bool recursive, const QStringList &nameFilters = {},
                                          const QStringList &excludeDirectories = {});
 
        static QFileInfo findLastCreated(const QDir &dir, bool recursive, const QStringList &nameFilters = {},
                                         const QStringList &excludeDirectories = {});
 
        static const QStringList &getSwiftExecutables();
 
        static QStringList getBaseNamesOnly(const QStringList &fileNames);
 
        static QStringList getFileNamesOnly(const QStringList &fileNames);
 
        static QString lockFileError(const QLockFile &lockFile);
 
        static QString fixWindowsUncPath(const QString &filePath);
 
        static QStringList fixWindowsUncPaths(const QStringList &filePaths);
 
        static bool isWindowsUncPath(const QString &filePath);
 
        static QString windowsUncMachine(const QString &filePath);
 
        static QSet<QString> windowsUncMachines(const QSet<QString> &paths);
 
        static QString toWindowsLocalPath(const QString &path);
 
        static QString humanReadableFileSize(qint64 size);
 
        static const QStringList &executableSuffixes();
 
        static bool isExecutableFile(const QString &fileName);
 
        static bool isSwiftInstaller(const QString &fileName);
    };
} // namespace swift::misc
 
#endif // SWIFT_MISC_CFILEUTILS_H