aboutsummaryrefslogtreecommitdiff
path: root/paludis/repositories/e/e_repository_mask_file.hh
blob: ce64a224e0c2a940f9c7ea60be888cae5d51359c (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2007 David Leverton
 *
 * 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_REPOSITORIES_E_E_REPOSITORY_MASK_FILE_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORIES_E_E_REPOSITORY_MASK_FILE_HH 1

#include <paludis/util/pimp.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/config_file.hh>
#include <paludis/util/wrapped_forward_iterator.hh>
#include <paludis/mask-fwd.hh>
#include <paludis/repositories/e/mask_info.hh>

namespace paludis
{
    namespace erepository
    {
        class EAPI;

        /**
         * A file listing masks in an ERepository.
         *
         * Handles parsing mask reasons from the comments.
         *
         * \ingroup grperepository
         */
        class PALUDIS_VISIBLE MaskFile
        {
            private:
                Pimp<MaskFile> _imp;

            public:
                ///\name Basic operations
                ///\{

                MaskFile(const FSPath &, const LineConfigFileOptions &, const EAPI &);
                ~MaskFile();

                ///\}

                ///\name Iterate over our mask lines.
                ///\{

                struct ConstIteratorTag;
                typedef WrappedForwardIterator<ConstIteratorTag,
                        const std::pair<const std::string, std::shared_ptr<const MaskInfo> > > ConstIterator;
                ConstIterator begin() const;
                ConstIterator end() const;

                ///\}
        };
    }

    extern template class WrappedForwardIterator<erepository::MaskFile::ConstIteratorTag,
             const std::pair<const std::string, std::shared_ptr<const erepository::MaskInfo> > >;
}

#endif