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

/*
 * Copyright (c) 2007 Mike Kelly
 *
 * 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_MANIFEST2_READER_HH
#define PALUDIS_GUARD_PALUDIS_MANIFEST2_READER_HH 1

#include <paludis/action.hh>
#include <paludis/util/fs_entry-fwd.hh>
#include <paludis/util/stringify.hh>
#include <paludis/util/sr.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>

#include <paludis/repositories/e/manifest2_entry-sr.hh>

#include <string>

/** \file
 * Declarations for the Manifest2Reader class
 *
 * \ingroup grpmanifest2reader
 */

namespace paludis
{

    namespace erepository
    {
        /**
         * Thrown if a Manifest2 file cannot be read properly.
         *
         * \ingroup grpexceptions
         * \nosubgrouping
         */
        class PALUDIS_VISIBLE Manifest2Error :
            public ActionError
        {
            public:
                Manifest2Error(const std::string & msg) throw ();
        };

        /**
         * Gives an ConstIterator of Manifest2Entrys from a given Manifest 2 style
         * file.
         *
         * \ingroup grpmanifest2reader
         */
        class PALUDIS_VISIBLE Manifest2Reader :
            private PrivateImplementationPattern<Manifest2Reader>
        {
            public:
                ///\name Basic operations

                Manifest2Reader(const FSEntry & f);
                ~Manifest2Reader();

                ///}

                /// \name Iterator functions

                struct ConstIteratorTag;
                typedef WrappedForwardIterator<ConstIteratorTag, const Manifest2Entry> ConstIterator;
                ConstIterator begin() const PALUDIS_ATTRIBUTE((warn_unused_result));
                ConstIterator end() const PALUDIS_ATTRIBUTE((warn_unused_result));

                ///}
        };
    }
}

#endif