Directory.h

/*
 * Copyright (C) 2006-2008 Marc Boris Duerner
 * 
 * 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.
 * 
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 * 
 * 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
 */

#ifndef PT_SYSTEM_DIRECTORY_H
#define PT_SYSTEM_DIRECTORY_H

#include <Pt/System/Api.h>
#include <iterator>

namespace Pt {

namespace System {

class Path;
class FileInfo;

class PT_SYSTEM_API DirectoryIterator
{
    public:
        typedef FileInfo value_type;
        typedef std::ptrdiff_t difference_type;
        typedef std::forward_iterator_tag iterator_category;
        typedef const FileInfo* pointer;
        typedef const FileInfo& reference;

    public:
        DirectoryIterator()
        : _impl(0)
        { }

        explicit DirectoryIterator(const Path& path);

        explicit DirectoryIterator(const FileInfo& fi);

        DirectoryIterator(const DirectoryIterator& it);

        ~DirectoryIterator();

        DirectoryIterator& operator++();

        DirectoryIterator& operator=(const DirectoryIterator& it);

        bool operator==(const DirectoryIterator& it) const
        { return _impl == it._impl; }

        bool operator!=(const DirectoryIterator& it) const
        { return _impl != it._impl; }

        const FileInfo& operator*() const;

        const FileInfo* operator->() const;

    private:
        class DirectoryIteratorImpl* _impl;
};

} // namespace System

} // namespace Pt

#endif // PT_SYSTEM_DIRECTORY_H