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

/*
 * Copyright (c) 2005, 2006, 2007 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_REPOSITORY_INFO_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORY_INFO_HH 1

#include <paludis/repository_info-fwd.hh>

namespace paludis
{
    /**
     * A section of information about a Repository.
     *
     * \see RepositoryInfo
     * \ingroup grprepository
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE RepositoryInfoSection :
        private PrivateImplementationPattern<RepositoryInfoSection>
    {
        public:
            ///\name Basic operations
            ///\{

            RepositoryInfoSection(const std::string & heading);

            ~RepositoryInfoSection();

            ///\}

            /// Our heading.
            std::string heading() const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            ///\name Iterate over our key/values
            ///\{

            typedef libwrapiter::ForwardIterator<RepositoryInfoSection,
                    const std::pair<const std::string, std::string> > KeyValueIterator;

            KeyValueIterator begin_kvs() const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            KeyValueIterator end_kvs() const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            ///\}

            /// Add a key/value pair.
            RepositoryInfoSection & add_kv(const std::string &, const std::string &);

            /// Fetch a value, with default.
            std::string get_key_with_default(const std::string &, const std::string &) const;
    };

    /**
     * Information about a Repository, for the end user.
     *
     * \ingroup grprepository
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE RepositoryInfo :
        private PrivateImplementationPattern<RepositoryInfo>
    {
        public:
            ///\name Basic operations
            ///\{

            RepositoryInfo();
            ~RepositoryInfo();

            ///\}

            ///\name Iterator over our sections
            ///\{

            typedef libwrapiter::ForwardIterator<RepositoryInfo,
                    const tr1::shared_ptr<const RepositoryInfoSection> > SectionIterator;

            SectionIterator begin_sections() const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            SectionIterator end_sections() const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            ///\}

            /// Add a section.
            RepositoryInfo & add_section(tr1::shared_ptr<const RepositoryInfoSection>);

            /// Fetch a value from any of our sections, with default.
            std::string get_key_with_default(const std::string &, const std::string &) const;
    };
}

#endif