paths.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Boost Software License - Version 1.0 - August 17th, 2003
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 **********************************************************************/

#pragma once

#include <functional>
#include <QStringList>
#include <QFileInfo>
#include "sysconfig.h"

class QDir;
class QUrl;

namespace LeechCraft
{
namespace Util
{
    enum class SysPath
    {
        QML,

        Share
    };

    UTIL_SYS_API QStringList GetPathCandidates (SysPath path, QString subfolder);

    UTIL_SYS_API QString GetSysPath (SysPath path, const QString& subfolder, const QString& filename);

    UTIL_SYS_API QUrl GetSysPathUrl (SysPath path, const QString& subfolder, const QString& filename);

    UTIL_SYS_API QStringList GetSystemPaths ();

    UTIL_SYS_API QString FindInSystemPath (const QString& name, const QStringList& paths,
            const std::function<bool (QFileInfo)>& filter = std::function<bool (QFileInfo)> ());

    enum class UserDir
    {
        Cache,

        LC
    };

    UTIL_SYS_API QDir GetUserDir (UserDir dir, const QString& subpath);

    UTIL_SYS_API QDir CreateIfNotExists (QString path);

    UTIL_SYS_API QString GetTemporaryName (const QString& pattern = QString ("lc_temp.XXXXXX"));

    struct SpaceInfo
    {
        quint64 Capacity_;

        quint64 Free_;

        quint64 Available_;
    };

    UTIL_SYS_API SpaceInfo GetSpaceInfo (const QString& path);
}
}