filesearchpath.h

//------------------------------------------------------------------------------
// filesearchpath.h
//------------------------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301  USA
//
//------------------------------------------------------------------------------
// Copyright (C) 2013 "Zalewa" <zalewapl@gmail.com>
//------------------------------------------------------------------------------
#ifndef idD5CA37A7_5FD3_4151_8316AB0B1F9974E5
#define idD5CA37A7_5FD3_4151_8316AB0B1F9974E5

#include <QList>
#include <QSet>
#include <QString>
#include <QVariant>

class TemplatedPathResolver;

class FileSearchPath
{
public:
        static QList<FileSearchPath> fromStringList(const QStringList &collection);
        static FileSearchPath fromVariant(const QVariant &var);
        static QList<FileSearchPath> fromVariantList(const QVariantList &collection);
        static QVariantList toVariantList(const QList<FileSearchPath> &collection);
        static FileSearchPath resolveTemplated(TemplatedPathResolver &resolver,
                const FileSearchPath &path);
        static QList<FileSearchPath> resolveTemplated(TemplatedPathResolver &resolver,
                const QList<FileSearchPath> &paths);

        static void merge(QList<FileSearchPath> &paths);

        FileSearchPath();
        FileSearchPath(const QString &path);

        bool isRecursive() const
        {
                return recursive_;
        }

        bool isValid() const;
        QVariant toVariant() const;

        const QString &path() const
        {
                return path_;
        }

        void setPath(const QString &path)
        {
                path_ = path;
        }

        void setRecursive(bool b)
        {
                recursive_ = b;
        }

        void setCache(const QMap<QString, QString> &files);
        bool hasCache();
        const QMap<QString, QString> &getCache();

        bool contains(const QString &path) const;
private:
        QString path_;
        bool recursive_;
        QMap<QString, QString> cacheFiles_;
};

#endif