filelist.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef COMMON_FILELIST_H
#define COMMON_FILELIST_H

#include <list>

#include "src/common/ustring.h"

namespace Common {

class FileList {
public:
    typedef std::list<UString>::const_iterator const_iterator;

    FileList();
    FileList(const FileList &list);
    FileList(const UString &directory, int recurseDepth = 0);
    ~FileList();

    FileList &operator=(const FileList &list);
    FileList &operator+=(const FileList &list);

    void clear();

    bool empty() const;
    size_t size() const;

    void sort(bool caseInsensitive);

    void relativize(const Common::UString &basePath);

    const_iterator begin() const;
    const_iterator end() const;

    bool addDirectory(const UString &directory, int recurseDepth = 0);

    bool addSubDirectories(const UString &directory);

    bool getSubList(const UString &str, bool caseInsensitive, FileList &subList) const;

    bool getSubListGlob(const UString &glob, bool caseInsensitive, FileList &subList) const;

    bool contains(const UString &str, bool caseInsensitive) const;

    bool containsGlob(const UString &glob, bool caseInsensitive) const;

    UString findFirst(const UString &str, bool caseInsensitive) const;

    UString findFirstGlob(const UString &glob, bool caseInsensitive) const;

private:
    typedef std::list<UString> Files;

    Files _files;
};

} // End of namespace Common

#endif // COMMON_FILELIST_H