LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
paths.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2014 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #pragma once
31 
32 #include <functional>
33 #include <QStringList>
34 #include <QFileInfo>
35 #include "sysconfig.h"
36 
37 class QDir;
38 class QUrl;
39 
40 namespace LeechCraft
41 {
42 namespace Util
43 {
48  enum class SysPath
49  {
55  QML,
56 
62  Share
63  };
64 
91  UTIL_SYS_API QStringList GetPathCandidates (SysPath path, QString subfolder);
92 
121  UTIL_SYS_API QString GetSysPath (SysPath path, const QString& subfolder, const QString& filename);
122 
138  UTIL_SYS_API QUrl GetSysPathUrl (SysPath path, const QString& subfolder, const QString& filename);
139 
149  UTIL_SYS_API QStringList GetSystemPaths ();
150 
165  UTIL_SYS_API QString FindInSystemPath (const QString& name, const QStringList& paths,
166  const std::function<bool (QFileInfo)>& filter = std::function<bool (QFileInfo)> ());
167 
170  enum class UserDir
171  {
174  Cache,
175 
178  LC
179  };
180 
181  UTIL_SYS_API QDir GetUserDir (UserDir dir, const QString& subpath);
182 
194  UTIL_SYS_API QDir CreateIfNotExists (QString path);
195 
204  UTIL_SYS_API QString GetTemporaryName (const QString& pattern = QString ("lc_temp.XXXXXX"));
205 
208  struct SpaceInfo
209  {
212  quint64 Capacity_;
213 
218  quint64 Free_;
219 
225  quint64 Available_;
226  };
227 
236  UTIL_SYS_API SpaceInfo GetSpaceInfo (const QString& path);
237 }
238 }
QStringList GetPathCandidates(SysPath path, QString suffix)
Returns possible full paths for the path and subfolder.
Definition: paths.cpp:48
QDir CreateIfNotExists(QString path)
Creates a path if it doesn&#39;t exist.
Definition: paths.cpp:149
SysPath
Describes various root paths recognized by GetSysPath().
Definition: paths.h:48
QString GetSysPath(SysPath path, const QString &suffix, const QString &filename)
Returns path to the file in the given root path and subfolder.
Definition: paths.cpp:79
QStringList GetSystemPaths()
Returns the components of the system PATH variable.
Definition: paths.cpp:97
quint64 Available_
How much space is available to the current user.
Definition: paths.h:225
QUrl GetSysPathUrl(SysPath path, const QString &subfolder, const QString &filename)
Returns path to the file in the given root path and subfolder.
Definition: paths.cpp:92
quint64 Capacity_
The capacity of the partition.
Definition: paths.h:212
Directory with shared data files.
Contains information about a partition&#39;s disk space.
Definition: paths.h:208
QString FindInSystemPath(const QString &name, const QStringList &paths, const std::function< bool(QFileInfo)> &filter)
Searches for a file in system paths according to a filter.
Definition: paths.cpp:102
quint64 Free_
How much free space there is.
Definition: paths.h:218
QString GetTemporaryName(const QString &pattern)
Returns a temporary filename.
Definition: paths.cpp:166
#define UTIL_SYS_API
Definition: sysconfig.h:37
QDir GetUserDir(UserDir dir, const QString &subpath)
Definition: paths.cpp:120
Root path for QML files.
Root LeechCraft directory (something like ~/.leechcraft).
Cache for volatile data.
SpaceInfo GetSpaceInfo(const QString &path)
Returns the disk space info of the partition containing path.
Definition: paths.cpp:176
UserDir
Describes various user-specific paths.
Definition: paths.h:170