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

/*
 * Copyright (c) 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_CREATE_OUTPUT_MANAGER_INFO_HH
#define PALUDIS_GUARD_PALUDIS_CREATE_OUTPUT_MANAGER_INFO_HH 1

#include <paludis/create_output_manager_info-fwd.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/visitor.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/type_list.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/repository-fwd.hh>
#include <paludis/serialise-fwd.hh>
#include <paludis/action-fwd.hh>
#include <paludis/name-fwd.hh>

namespace paludis
{
    /**
     * Information for Environment::create_output_manager.
     *
     * \since 0.36
     * \ingroup g_environment
     * \see Environment::create_output_manager
     */
    class PALUDIS_VISIBLE CreateOutputManagerInfo :
        public virtual DeclareAbstractAcceptMethods<CreateOutputManagerInfo, MakeTypeList<
            CreateOutputManagerForPackageIDActionInfo,
            CreateOutputManagerForRepositorySyncInfo
        >::Type>
    {
        public:
            static const std::shared_ptr<CreateOutputManagerInfo> deserialise(
                    Deserialisation & d) PALUDIS_ATTRIBUTE((warn_unused_result));

            virtual void serialise(Serialiser &) const = 0;
    };

    /**
     * Information for Environment::create_output_manager, if we're performing a
     * PackageID action.
     *
     * \since 0.36
     * \ingroup g_environment
     * \see Environment::create_output_manager
     */
    class PALUDIS_VISIBLE CreateOutputManagerForPackageIDActionInfo :
        public CreateOutputManagerInfo,
        public ImplementAcceptMethods<CreateOutputManagerInfo, CreateOutputManagerForPackageIDActionInfo>
    {
        private:
            Pimp<CreateOutputManagerForPackageIDActionInfo> _imp;

        public:
            /**
             * \since 0.46
             */
            CreateOutputManagerForPackageIDActionInfo(
                    const std::shared_ptr<const PackageID> & id,
                    const std::string & action_name,
                    const std::shared_ptr<const Set<std::string> > & action_flags,
                    const OutputExclusivity output_exclusivity,
                    const ClientOutputFeatures & output_features);

            /**
             * \since 0.46
             */
            CreateOutputManagerForPackageIDActionInfo(
                    const std::shared_ptr<const PackageID> & id,
                    const Action &,
                    const OutputExclusivity output_exclusivity,
                    const ClientOutputFeatures & output_features);

            ~CreateOutputManagerForPackageIDActionInfo();

            const std::shared_ptr<const PackageID> package_id() const PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * \since 0.44
             */
            const std::string action_name() const PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * \since 0.44
             */
            const std::shared_ptr<const Set<std::string> > action_flags() const PALUDIS_ATTRIBUTE((warn_unused_result));

            OutputExclusivity output_exclusivity() const PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * \since 0.46
             */
            const ClientOutputFeatures client_output_features() const PALUDIS_ATTRIBUTE((warn_unused_result));

            virtual void serialise(Serialiser &) const;

            static const std::shared_ptr<CreateOutputManagerForPackageIDActionInfo> deserialise(
                    Deserialisation & d) PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    /**
     * Information for Environment::create_output_manager, if we're performing a
     * Repository sync.
     *
     * \since 0.36
     * \ingroup g_environment
     * \see Environment::create_output_manager
     */
    class PALUDIS_VISIBLE CreateOutputManagerForRepositorySyncInfo :
        public CreateOutputManagerInfo,
        public ImplementAcceptMethods<CreateOutputManagerInfo, CreateOutputManagerForRepositorySyncInfo>
    {
        private:
            Pimp<CreateOutputManagerForRepositorySyncInfo> _imp;

        public:
            /**
             * \since 0.46
             */
            CreateOutputManagerForRepositorySyncInfo(
                    const RepositoryName & repo_name,
                    const OutputExclusivity,
                    const ClientOutputFeatures &);

            ~CreateOutputManagerForRepositorySyncInfo();

            /**
             * \since 0.44
             */
            const RepositoryName repository_name() const PALUDIS_ATTRIBUTE((warn_unused_result));

            OutputExclusivity output_exclusivity() const PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * \since 0.46
             */
            const ClientOutputFeatures client_output_features() const PALUDIS_ATTRIBUTE((warn_unused_result));

            virtual void serialise(Serialiser &) const;

            static const std::shared_ptr<CreateOutputManagerForRepositorySyncInfo> deserialise(
                    Deserialisation & d) PALUDIS_ATTRIBUTE((warn_unused_result));
    };
}

#endif