aboutsummaryrefslogtreecommitdiff
path: root/paludis/repository_factory.hh
blob: 52018feb25d16ff888009c8b97c71bc24531ec09 (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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2008, 2009, 2010, 2011 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_REPOSITORY_FACTORY_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORY_FACTORY_HH 1

#include <paludis/repository_factory-fwd.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/singleton.hh>
#include <paludis/util/wrapped_forward_iterator.hh>
#include <paludis/util/no_type.hh>
#include <paludis/environment-fwd.hh>
#include <paludis/repository-fwd.hh>
#include <paludis/name-fwd.hh>
#include <functional>
#include <memory>

namespace paludis
{
    extern template class PALUDIS_VISIBLE Singleton<RepositoryFactory>;

    class PALUDIS_VISIBLE RepositoryFactory :
        public Singleton<RepositoryFactory>
    {
        friend class Singleton<RepositoryFactory>;

        private:
            Pimp<RepositoryFactory> _imp;

            RepositoryFactory();
            ~RepositoryFactory();

        public:
            typedef std::function<std::string (const std::string &)> KeyFunction;

            typedef std::function<const std::shared_ptr<Repository>(
                    Environment * const,
                    const KeyFunction &
                    )> CreateFunction;

            typedef std::function<const std::shared_ptr<const RepositoryNameSet> (
                    const Environment * const,
                    const KeyFunction &
                    )> DependenciesFunction;

            typedef std::function<const RepositoryName (
                    const Environment * const,
                    const KeyFunction &
                    )> NameFunction;

            typedef std::function<int (
                    const Environment * const,
                    const KeyFunction &
                    )> ImportanceFunction;

            /**
             * Construct a given repository, or throw ConfigurationError.
             *
             * If the repository to be created has dependencies upon another
             * repository, that repository must have been created and added
             * to the environment's package database first.
             *
             * The returned repository is <em>not</em> added to the Environment's
             * package database.
             *
             * \param key_function should return the value for a given key. The
             * 'format' key must return a value (e.g. 'ebuild'), which is used
             * to select the return type. The 'repo_name' key's value should be
             * the file that best describes the location of the file containing
             * the repository config, if such a file exists. Other key names are
             * repository defined, but typically include things like 'location'
             * and 'sync'.
             */
            const std::shared_ptr<Repository> create(
                    Environment * const env,
                    const KeyFunction & key_function
                    ) const PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * Find the name of the repository that would be constructed if the
             * supplied parameters were passed to RepositoryFactory::create.
             *
             * \see RepositoryFactory::create for parameter documentation.
             */
            const RepositoryName name(
                    const Environment * const env,
                    const KeyFunction & key_function
                    ) const PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * Find the importance of the repository that would be constructed if the
             * supplied parameters were passed to RepositoryFactory::create.
             *
             * \see RepositoryFactory::create for parameter documentation.
             */
            int importance(
                    const Environment * const env,
                    const KeyFunction & key_function
                    ) const PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * Fetch the names of any repositories depended upon by a particular
             * repository.
             *
             * \see RepositoryFactory::create for parameter documentation.
             */
            const std::shared_ptr<const RepositoryNameSet> dependencies(
                    const Environment * const env,
                    const KeyFunction & key_function
                    ) const PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * Add a repository format.
             *
             * \param formats must have at least one value, and no value may be
             * specified more than once across all invocations.
             *
             * \param name_function is used to implement RepositoryFactory::name.
             *
             * \param importance_function is used to implement RepositoryFactory::importance.
             *
             * \param create_function is used to implement RepositoryFactory::create.
             *
             * \param dependencies_function is used to implement
             * RepositoryFactory::dependencies.
             */
            void add_repository_format(
                    const std::shared_ptr<const Set<std::string> > & formats,
                    const NameFunction & name_function,
                    const ImportanceFunction & importance_function,
                    const CreateFunction & create_function,
                    const DependenciesFunction & dependencies_function
                    );

            struct ConstIteratorTag;
            typedef WrappedForwardIterator<ConstIteratorTag, const std::string> ConstIterator;
            ConstIterator begin_keys() const PALUDIS_ATTRIBUTE((warn_unused_result));
            ConstIterator end_keys() const PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    template <typename RepositoryClass_>
    void register_repositories(const RepositoryClass_ * const, RepositoryFactory * const);

    extern template class Pimp<RepositoryFactory>;
    extern template class PALUDIS_VISIBLE WrappedForwardIterator<RepositoryFactory::ConstIteratorTag, const std::string>;
}

#endif