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
|
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
* Copyright (c) 2008, 2009, 2010 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_ENVIRONMENT_FACTORY_HH
#define PALUDIS_GUARD_PALUDIS_ENVIRONMENT_FACTORY_HH 1
#include <paludis/environment_factory-fwd.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/set-fwd.hh>
#include <paludis/util/no_type.hh>
#include <paludis/util/singleton.hh>
#include <paludis/environment-fwd.hh>
#include <memory>
#include <functional>
namespace paludis
{
class PALUDIS_VISIBLE FallBackToAnotherFormatError
{
};
/**
* Factory for Environment creation.
*
* \ingroup g_environment
* \since 0.30
*/
class PALUDIS_VISIBLE EnvironmentFactory :
private Pimp<EnvironmentFactory>,
public Singleton<EnvironmentFactory>
{
friend class Singleton<EnvironmentFactory>;
private:
EnvironmentFactory();
~EnvironmentFactory();
public:
typedef std::function<const std::shared_ptr<Environment>(const std::string &)> CreateFunction;
/**
* Create an Environment subclass from the specified spec.
*
* \param spec The environment spec, which is in the form
* env:suffix, where env is the string representing an
* Environment's kind (e.g. "paludis", "portage") and
* suffix is the information to pass to the constructing
* function (for paludis, a config suffix, and for portage,
* a location). If env is not specified, it defaults to
* trying paludis then portage. If suffix is not specified,
* it defaults to an empty string. If no colon is present,
* the supplied string is taken as env (this includes an
* empty string).
*/
const std::shared_ptr<Environment> create(const std::string & spec) 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 create_function is used to implement EnvironmentFactory::create.
*/
void add_environment_format(
const std::shared_ptr<const Set<std::string> > & formats,
const CreateFunction & create_function
);
};
template <typename EnvironmentClass_>
void register_environment(const EnvironmentClass_ * const, EnvironmentFactory * const);
extern template class Pimp<EnvironmentFactory>;
extern template class Singleton<EnvironmentFactory>;
}
#endif
|
