aboutsummaryrefslogtreecommitdiff
path: root/paludis/resolver/reason.hh
blob: 0c6745ba802ef63492f21fc4b05d55b7d077f88e (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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/* 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_RESOLVER_REASON_HH
#define PALUDIS_GUARD_PALUDIS_RESOLVER_REASON_HH 1

#include <paludis/resolver/reason-fwd.hh>
#include <paludis/resolver/resolvent-fwd.hh>
#include <paludis/resolver/sanitised_dependencies-fwd.hh>
#include <paludis/resolver/change_by_resolvent-fwd.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/visitor.hh>
#include <paludis/util/type_list.hh>
#include <paludis/util/tribool.hh>
#include <paludis/name-fwd.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/serialise-fwd.hh>
#include <paludis/changed_choices-fwd.hh>
#include <memory>

namespace paludis
{
    namespace resolver
    {
        class Reason :
            public virtual DeclareAbstractAcceptMethods<Reason, MakeTypeList<
                TargetReason, DependencyReason, DependentReason, WasUsedByReason, PresetReason,
                SetReason, LikeOtherDestinationTypeReason, ViaBinaryReason>::Type>
        {
            public:
                virtual ~Reason() = 0;

                virtual void serialise(Serialiser &) const = 0;

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

        class TargetReason :
            public Reason,
            public ImplementAcceptMethods<Reason, TargetReason>
        {
            private:
                Pimp<TargetReason> _imp;

            public:
                TargetReason(const std::string &);
                ~TargetReason();

                const std::string extra_information() const PALUDIS_ATTRIBUTE((warn_unused_result));

                virtual void serialise(Serialiser &) const;
        };

        class DependencyReason :
            public Reason,
            public ImplementAcceptMethods<Reason, DependencyReason>
        {
            private:
                Pimp<DependencyReason> _imp;

            public:
                DependencyReason(
                        const std::shared_ptr<const PackageID> & id,
                        const std::shared_ptr<const ChangedChoices> &,
                        const Resolvent &,
                        const SanitisedDependency & s,
                        const Tribool already_met);

                ~DependencyReason();

                const std::shared_ptr<const PackageID> from_id() const;
                const std::shared_ptr<const ChangedChoices> from_id_changed_choices() const;
                const Resolvent from_resolvent() const;
                const SanitisedDependency & sanitised_dependency() const;
                Tribool already_met() const PALUDIS_ATTRIBUTE((warn_unused_result));

                virtual void serialise(Serialiser &) const;
        };

        class DependentReason :
            public Reason,
            public ImplementAcceptMethods<Reason, DependentReason>
        {
            private:
                Pimp<DependentReason> _imp;

            public:
                DependentReason(const ChangeByResolvent &);
                ~DependentReason();

                const ChangeByResolvent id_and_resolvent_being_removed() const;

                virtual void serialise(Serialiser &) const;
        };

        class WasUsedByReason :
            public Reason,
            public ImplementAcceptMethods<Reason, WasUsedByReason>
        {
            private:
                Pimp<WasUsedByReason> _imp;

            public:
                WasUsedByReason(const std::shared_ptr<const ChangeByResolventSequence> & ids);
                ~WasUsedByReason();

                const std::shared_ptr<const ChangeByResolventSequence> ids_and_resolvents_being_removed() const;

                virtual void serialise(Serialiser &) const;
        };

        class PresetReason :
            public Reason,
            public ImplementAcceptMethods<Reason, PresetReason>
        {
            private:
                Pimp<PresetReason> _imp;

            public:
                PresetReason(
                        const std::string &,
                        const std::shared_ptr<const Reason> &);
                ~PresetReason();

                const std::shared_ptr<const Reason> maybe_reason_for_preset() const PALUDIS_ATTRIBUTE((warn_unused_result));

                const std::string maybe_explanation() const PALUDIS_ATTRIBUTE((warn_unused_result));

                virtual void serialise(Serialiser &) const;
        };

        class SetReason :
            public Reason,
            public ImplementAcceptMethods<Reason, SetReason>
        {
            private:
                Pimp<SetReason> _imp;

            public:
                SetReason(const SetName &, const std::shared_ptr<const Reason> &);
                ~SetReason();

                const SetName set_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
                const std::shared_ptr<const Reason> reason_for_set() const PALUDIS_ATTRIBUTE((warn_unused_result));

                virtual void serialise(Serialiser &) const;
        };

        class LikeOtherDestinationTypeReason :
            public Reason,
            public ImplementAcceptMethods<Reason, LikeOtherDestinationTypeReason>
        {
            private:
                Pimp<LikeOtherDestinationTypeReason> _imp;

            public:
                LikeOtherDestinationTypeReason(const Resolvent &, const std::shared_ptr<const Reason> &);
                ~LikeOtherDestinationTypeReason();

                const Resolvent other_resolvent() const PALUDIS_ATTRIBUTE((warn_unused_result));
                const std::shared_ptr<const Reason> reason_for_other() const PALUDIS_ATTRIBUTE((warn_unused_result));

                virtual void serialise(Serialiser &) const;
        };

        class ViaBinaryReason :
            public Reason,
            public ImplementAcceptMethods<Reason, ViaBinaryReason>
        {
            private:
                Pimp<ViaBinaryReason> _imp;

            public:
                ViaBinaryReason(const Resolvent &);
                ~ViaBinaryReason();

                const Resolvent other_resolvent() const PALUDIS_ATTRIBUTE((warn_unused_result));

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

    extern template class Pimp<resolver::TargetReason>;
    extern template class Pimp<resolver::DependencyReason>;
    extern template class Pimp<resolver::DependentReason>;
    extern template class Pimp<resolver::WasUsedByReason>;
    extern template class Pimp<resolver::SetReason>;
    extern template class Pimp<resolver::ViaBinaryReason>;

}

#endif