1 /*
2  * Bittorrent Client using Qt and libtorrent.
3  * Copyright (C) 2012  Christophe Dumez <chris@qbittorrent.org>
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
18  *
19  * In addition, as a special exception, the copyright holders give permission to
20  * link this program with the OpenSSL project's "OpenSSL" library (or with
21  * modified versions of it that use the same license as the "OpenSSL" library),
22  * and distribute the linked executables. You must obey the GNU General Public
23  * License in all respects for all of the code used other than "OpenSSL".  If you
24  * modify file(s), you may extend this exception to your version of the file(s),
25  * but you are not obligated to do so. If you do not wish to do so, delete this
26  * exception statement from your version.
27  */
28 
29 #pragma once
30 
31 /**
32  * Utility functions related to file system.
33  */
34 
35 #include <QString>
36 
37 namespace Utils::Fs
38 {
39     /**
40      * Converts a path to a string suitable for display.
41      * This function makes sure the directory separator used is consistent
42      * with the OS being run.
43      */
44     QString toNativePath(const QString &path);
45     /**
46      * Converts a path to a string suitable for processing.
47      * This function makes sure the directory separator used is independent
48      * from the OS being run so it is the same on all supported platforms.
49      * Slash ('/') is used as "uniform" directory separator.
50      */
51     QString toUniformPath(const QString &path);
52 
53     QString fileExtension(const QString &filename);
54     QString fileName(const QString &filePath);
55     QString folderName(const QString &filePath);
56     qint64 computePathSize(const QString &path);
57     bool sameFiles(const QString &path1, const QString &path2);
58     QString toValidFileSystemName(const QString &name, bool allowSeparators = false
59             , const QString &pad = QLatin1String(" "));
60     bool isValidFileSystemName(const QString &name, bool allowSeparators = false);
61     qint64 freeDiskSpaceOnPath(const QString &path);
62     QString branchPath(const QString &filePath, QString *removed = nullptr);
63     bool sameFileNames(const QString &first, const QString &second);
64     QString expandPath(const QString &path);
65     QString expandPathAbs(const QString &path);
66     bool isRegularFile(const QString &path);
67 
68     bool smartRemoveEmptyFolderTree(const QString &path);
69     bool forceRemove(const QString &filePath);
70     void removeDirRecursive(const QString &path);
71 
72     QString tempPath();
73 
74 #if !defined Q_OS_HAIKU
75     bool isNetworkFileSystem(const QString &path);
76 #endif
77 }
78