directoryutils.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2016 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_DIRECTORYUTILS_H
#define SWIFT_MISC_DIRECTORYUTILS_H
 
#include <QDir>
#include <QFileInfoList>
#include <QSet>
#include <QString>
 
#include "misc/swiftmiscexport.h"
 
namespace swift::misc
{
    class SWIFT_MISC_EXPORT CDirectoryUtils
    {
    public:
        static bool isInApplicationDirectory(const QString &path);
 
        static bool isMacOSAppBundle();
 
        static QString decodeNormalizedDirectory(const QString &directory);
 
        static QStringList getRelativeSubDirectories(const QString &rootDir);
 
        static bool containsFileInDir(const QString &dir, const QString &filter, bool recursively);
 
        static bool existsUnemptyDirectory(const QString &testDir);
 
        static bool mkPathIfNotExisting(const QString &dir);
 
        static int copyDirectoryRecursively(const QString &fromDir, const QString &toDir, bool replaceOnConflict);
 
        static QStringList getExistingUnemptyDirectories(const QStringList &directories);
 
        static bool isDirExisting(const QString &path);
        static bool isDirExisting(const QDir &dir);
 
        static bool isSameExistingDirectory(const QString &dir1, const QString &dir2);
 
        static bool isSameOrSubDirectoryOf(const QString &testDir, const QString &parentDir);
 
        static bool isSameOrSubDirectoryOf(const QString &testDir, const QDir &parentDir);
 
        static bool isSameOrSubDirectoryOfStringBased(const QString &testDir, const QString &parentDir);
 
        struct DirComparison
        {
            bool ok = false; 
            QSet<QString> source; 
            QSet<QString> missingInSource; 
            QSet<QString> missingInTarget; 
            QSet<QString> newerInSource; 
            QSet<QString> newerInTarget; 
            QSet<QString> sameNameInSource; 
            QSet<QString> sameNameInTarget; 
 
            void insert(const DirComparison &otherComparison);
        };
 
        static DirComparison compareTwoDirectories(const QString &dirSource, const QString &dirTarget, bool nestedDirs);
 
    private:
        static QSet<QString> fileNamesToQSet(const QFileInfoList &fileInfoList);
 
        static QSet<QString> canonicalFileNamesToQSet(const QFileInfoList &fileInfoList);
 
        static QSet<QString> filesToCanonicalNames(const QSet<QString> &fileNames,
                                                   const QSet<QString> &canonicalFileNames);
 
        static bool canPingUncMachine(const QString &machine);
    };
} // namespace swift::misc
 
#endif // SWIFT_MISC_DIRECTORYUTILS_H