libquentier  0.5.0
The library for rich desktop clients of Evernote service
FileSystem.h
1 /*
2  * Copyright 2020 Dmitry Ivanov
3  *
4  * This file is part of libquentier
5  *
6  * libquentier is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation, version 3 of the License.
9  *
10  * libquentier 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 Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
17  */
18 
19 #ifndef LIB_QUENTIER_UTILITY_FILE_SYSTEM_H
20 #define LIB_QUENTIER_UTILITY_FILE_SYSTEM_H
21 
22 #include <quentier/utility/Linkage.h>
23 
24 #include <QString>
25 
26 namespace quentier {
27 
28 QT_FORWARD_DECLARE_CLASS(ErrorString)
29 
30 
44 const QString QUENTIER_EXPORT relativePathFromAbsolutePath(
45  const QString & absolutePath, const QString & relativePathRootFolderPath);
46 
55 bool QUENTIER_EXPORT removeFile(const QString & filePath);
56 
66 bool QUENTIER_EXPORT removeDir(const QString & dirPath);
67 
79 QByteArray QUENTIER_EXPORT
80 readFileContents(const QString & filePath, ErrorString & errorDescription);
81 
96 bool QUENTIER_EXPORT renameFile(
97  const QString & from, const QString & to, ErrorString & errorDescription);
98 
99 } // namespace quentier
100 
101 #endif // LIB_QUENTIER_UTILITY_FILE_SYSTEM_H