src/base/path.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2022  Vladimir Golovnev <glassez@yandex.ru>
   4  * Copyright (C) 2012  Christophe Dumez <chris@qbittorrent.org>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  *
  20  * In addition, as a special exception, the copyright holders give permission to
  21  * link this program with the OpenSSL project's "OpenSSL" library (or with
  22  * modified versions of it that use the same license as the "OpenSSL" library),
  23  * and distribute the linked executables. You must obey the GNU General Public
  24  * License in all respects for all of the code used other than "OpenSSL".  If you
  25  * modify file(s), you may extend this exception to your version of the file(s),
  26  * but you are not obligated to do so. If you do not wish to do so, delete this
  27  * exception statement from your version.
  28  */
  29
  30 #pragma once
  31
  32 #include <filesystem>
  33
  34 #include <QtGlobal>
  35 #include <QMetaType>
  36 #include <QString>
  37
  38 #include "pathfwd.h"
  39
  40 #include "base/interfaces/istringable.h"
  41
  42 class Path final : public IStringable
  43 {
  44 public:
  45     Path() = default;
  46
  47     explicit Path(const QString &pathStr);
  48     explicit Path(const std::string &pathStr);
  49
  50     bool isValid() const;
  51     bool isEmpty() const;
  52     bool isAbsolute() const;
  53     bool isRelative() const;
  54
  55     bool exists() const;
  56
  57     Path rootItem() const;
  58     Path parentPath() const;
  59
  60     QString filename() const;
  61
  62     QString extension() const;
  63     bool hasExtension(QStringView ext) const;
  64     void removeExtension();
  65     Path removedExtension() const;
  66     void removeExtension(QStringView ext);
  67     Path removedExtension(QStringView ext) const;
  68
  69     bool hasAncestor(const Path &other) const;
  70     Path relativePathOf(const Path &childPath) const;
  71
  72     QString data() const;
  73     QString toString() const override;
  74     std::filesystem::path toStdFsPath() const;
  75
  76     Path &operator/=(const Path &other);
  77     Path &operator+=(QStringView str);
  78
  79     static Path commonPath(const Path &left, const Path &right);
  80
  81     static Path findRootFolder(const PathList &filePaths);
  82     static void stripRootFolder(PathList &filePaths);
  83     static void addRootFolder(PathList &filePaths, const Path &rootFolder);
  84
  85     friend Path operator/(const Path &lhs, const Path &rhs);
  86
  87 private:
  88     // this constructor doesn't perform any checks
  89     // so it's intended for internal use only
  90     static Path createUnchecked(const QString &pathStr);
  91
  92     QString m_pathStr;
  93 };
  94
  95 Q_DECLARE_METATYPE(Path)
  96
  97 bool operator==(const Path &lhs, const Path &rhs);
  98 bool operator!=(const Path &lhs, const Path &rhs);
  99 Path operator+(const Path &lhs, QStringView rhs);
 100
 101 QDataStream &operator<<(QDataStream &out, const Path &path);
 102 QDataStream &operator>>(QDataStream &in, Path &path);
 103
 104 #if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
 105 std::size_t qHash(const Path &key, std::size_t seed = 0);
 106 #else
 107 uint qHash(const Path &key, uint seed = 0);
 108 #endif