aboutsummaryrefslogtreecommitdiff
path: root/paludis/output_manager_factory.hh
diff options
context:
space:
mode:
Diffstat (limited to 'paludis/output_manager_factory.hh')
-rw-r--r--paludis/output_manager_factory.hh89
1 files changed, 89 insertions, 0 deletions
diff --git a/paludis/output_manager_factory.hh b/paludis/output_manager_factory.hh
new file mode 100644
index 0000000..124a26d
--- /dev/null
+++ b/paludis/output_manager_factory.hh
@@ -0,0 +1,89 @@
+/* vim: set sw=4 sts=4 et foldmethod=syntax : */
+
+/*
+ * Copyright (c) 2009 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_OUTPUT_MANAGER_FACTORY_HH
+#define PALUDIS_GUARD_PALUDIS_OUTPUT_MANAGER_FACTORY_HH 1
+
+#include <paludis/output_manager_factory-fwd.hh>
+#include <paludis/util/attributes.hh>
+#include <paludis/util/private_implementation_pattern.hh>
+#include <paludis/util/instantiation_policy.hh>
+#include <paludis/util/wrapped_forward_iterator-fwd.hh>
+#include <paludis/output_manager-fwd.hh>
+#include <paludis/util/set-fwd.hh>
+#include <tr1/functional>
+#include <tr1/memory>
+
+namespace paludis
+{
+ class PALUDIS_VISIBLE OutputManagerFactory :
+ private PrivateImplementationPattern<OutputManagerFactory>,
+ public InstantiationPolicy<OutputManagerFactory, instantiation_method::SingletonTag>
+ {
+ friend class InstantiationPolicy<OutputManagerFactory, instantiation_method::SingletonTag>;
+
+ private:
+ OutputManagerFactory();
+ ~OutputManagerFactory();
+
+ public:
+ typedef std::tr1::function<std::string (const std::string &)> KeyFunction;
+
+ typedef std::tr1::function<const std::tr1::shared_ptr<OutputManager>(
+ const KeyFunction &
+ )> CreateFunction;
+
+ /**
+ * Construct a given OutputManager, or throw ConfigurationError.
+ *
+ * \param key_function should return the value for a given key. The
+ * 'manager' key must return a value (e.g. 'standard'), which is used
+ * to select the return type. Other key names are manager defined,
+ * but typically include things like 'location' and 'keep_on_success'.
+ */
+ const std::tr1::shared_ptr<OutputManager> create(
+ const KeyFunction & key_function
+ ) const PALUDIS_ATTRIBUTE((warn_unused_result));
+
+ /**
+ * Add a manager.
+ *
+ * \param managers 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 OutputManagerFactory::create.
+ */
+ void add_manager(
+ const std::tr1::shared_ptr<const Set<std::string> > & managers,
+ const CreateFunction & create_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));
+ };
+
+#ifdef PALUDIS_HAVE_EXTERN_TEMPLATE
+ extern template class PrivateImplementationPattern<OutputManagerFactory>;
+ extern template class InstantiationPolicy<OutputManagerFactory, instantiation_method::SingletonTag>;
+#endif
+}
+
+#endif