aboutsummaryrefslogtreecommitdiff
path: root/paludis/repositories/e/e_repository_news.hh
blob: 2c212a0620caa0cbbe62e75330769f3d758a696b (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
118
119
120
121
122
123
124
125
126
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2006, 2007 Ciaran McCreesh
 *
 * 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_NEWS_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORIES_E_E_REPOSITORY_NEWS_HH 1

#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/config_file.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>

/** \file
 * Declaration for the ERepositoryNews class.
 *
 * \ingroup grperepository
 */

namespace paludis
{
    class Environment;
    class FSEntry;
    class ERepository;

    /**
     * Holds the news/ data for a ERepository instance.
     *
     * \ingroup grperepository
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE ERepositoryNews :
        private PrivateImplementationPattern<ERepositoryNews>,
        private InstantiationPolicy<ERepositoryNews, instantiation_method::NonCopyableTag>
    {
        public:
            ///\name Basic operations
            ///\{

            ERepositoryNews(const Environment * const, const ERepository * const,
                    const ERepositoryParams &);
            ~ERepositoryNews();

            ///\}

            void update_news() const;
    };

    /**
     * A NewsFile represents a GLEP 42 news file.
     *
     * \ingroup grpnewsconfigfile
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE NewsFile :
        private PrivateImplementationPattern<NewsFile>
    {
        public:
            ///\name Basic operations
            ///\{

            /**
             * Constructor, from a filename.
             */
            NewsFile(const FSEntry & filename);

            ~NewsFile();

            ///\}

            ///\name Iterate over our Display-If-Installed headers
            ///\{

            struct DisplayIfInstalledConstIteratorTag;
            typedef WrappedForwardIterator<DisplayIfInstalledConstIteratorTag,
                    const std::string> DisplayIfInstalledConstIterator;

            DisplayIfInstalledConstIterator begin_display_if_installed() const;

            DisplayIfInstalledConstIterator end_display_if_installed() const;

            ///\}

            ///\name Iterate over our Display-If-Keyword headers
            ///\{

            struct DisplayIfKeywordConstIteratorTag;
            typedef WrappedForwardIterator<DisplayIfKeywordConstIteratorTag,
                    const std::string> DisplayIfKeywordConstIterator;

            DisplayIfKeywordConstIterator begin_display_if_keyword() const;

            DisplayIfKeywordConstIterator end_display_if_keyword() const;

            ///\}

            ///\name Iterate over our Display-If-Profile headers
            ///\{

            struct DisplayIfProfileConstIteratorTag;
            typedef WrappedForwardIterator<DisplayIfProfileConstIteratorTag,
                    const std::string> DisplayIfProfileConstIterator;

            DisplayIfProfileConstIterator begin_display_if_profile() const;

            DisplayIfProfileConstIterator end_display_if_profile() const;

            ///\}
    };
}

#endif