aboutsummaryrefslogtreecommitdiff
path: root/0.8.0/paludis/util/dir_iterator.hh
blob: 3892ae4017b3c0cd1d592c8e7809bbec1f66b495 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis 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
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef PALUDIS_GUARD_PALUDIS_DIR_ITERATOR_HH
#define PALUDIS_GUARD_PALUDIS_DIR_ITERATOR_HH 1

#include <iterator>
#include <paludis/util/counted_ptr.hh>
#include <paludis/util/fs_entry.hh>
#include <paludis/util/private_implementation_pattern.hh>

/** \file
 * Declarations for paludis::DirIterator.
 *
 * \ingroup grpfilesystem
 */

namespace paludis
{
    /**
     * Raised when a directory open fails.
     *
     * \ingroup grpfilesystem
     * \ingroup grpexceptions
     */
    class PALUDIS_VISIBLE DirOpenError :
        public FSError
    {
        public:
            ///\name Basic operations
            ///\{

            DirOpenError(const FSEntry & location, const int errno_value) throw ();

            ///\}
    };

    /**
     * An iterator that iterates over the contents of a directory. At present,
     * we read in all the entries at creation time and maintain a CountedPtr
     * to an ordered set of FSEntry instances. This may change at some point,
     * if it turns out that it's quicker to use opendir and seekdir for each
     * instance.
     *
     * \ingroup grpfilesystem
     */
    class PALUDIS_VISIBLE DirIterator :
        public std::iterator<std::forward_iterator_tag, FSEntry>,
        private PrivateImplementationPattern<DirIterator>
    {
        public:
            ///\name Basic operations
            ///\{

            /**
             * Constructor, to an FSEntry which must be a directory, with an
             * option to not ignore dotfiles.
             */
            explicit DirIterator(const FSEntry & base, bool ignore_dotfiles = true);

            DirIterator(const DirIterator & other);

            /**
             * Constructor, creates an end() iterator.
             */
            DirIterator();

            ~DirIterator();

            const DirIterator & operator= (const DirIterator & other);

            ///\}

            ///\name Dereference operators
            ///\{

            const FSEntry & operator* () const;

            const FSEntry * operator-> () const;

            ///\}

            ///\name Increment, decrement operators
            ///\{

            DirIterator & operator++ ();
            DirIterator operator++ (int);

            ///\}

            ///\name Comparison operators
            ///\{

            bool operator== (const DirIterator & other) const;
            bool operator!= (const DirIterator & other) const;

            ///\}
    };
}

#endif