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

/*
 * Copyright (c) 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
 *
 * 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_HANDLED_INFORMATION_HH
#define PALUDIS_GUARD_PALUDIS_HANDLED_INFORMATION_HH 1

#include <paludis/handled_information-fwd.hh>
#include <paludis/util/visitor.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/dep_spec-fwd.hh>

/** \file
 * Declarations for DepListEntryHandled classes, which are used by DepList and
 * InstallTask to keep track of whether a DepListEntry has been handled yet.
 *
 * \ingroup g_dep_list
 *
 * \section Examples
 *
 * - None at this time.
 */

namespace paludis
{
    /**
     * Types for a visitor that can visit a DepListEntry subclass.
     *
     * \ingroup g_dep_list
     * \since 0.26
     * \nosubgrouping
     */
    struct DepListEntryHandledVisitorTypes :
        VisitorTypes<
            DepListEntryHandledVisitorTypes,
            DepListEntryHandled,
            DepListEntryHandledSuccess,
            DepListEntryHandledSkippedUnsatisfied,
            DepListEntryHandledFailed,
            DepListEntryUnhandled,
            DepListEntryNoHandlingRequired
        >
    {
    };

    /**
     * Represents a DepListEntry that has been handled.
     *
     * \ingroup g_dep_list
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE DepListEntryHandled :
        public virtual ConstAcceptInterface<DepListEntryHandledVisitorTypes>
    {
        public:
            virtual ~DepListEntryHandled() = 0;
    };

    /**
     * Represents a DepListEntry that has not been handled.
     *
     * \ingroup g_dep_list
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE DepListEntryUnhandled :
        public DepListEntryHandled,
        public ConstAcceptInterfaceVisitsThis<DepListEntryHandledVisitorTypes, DepListEntryUnhandled>
    {
    };

    /**
     * Represents a DepListEntry that requires no handling.
     *
     * \ingroup g_dep_list
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE DepListEntryNoHandlingRequired :
        public DepListEntryHandled,
        public ConstAcceptInterfaceVisitsThis<DepListEntryHandledVisitorTypes, DepListEntryNoHandlingRequired>
    {
    };

    /**
     * Represents a DepListEntry that has been handled successfully.
     *
     * \ingroup g_dep_list
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE DepListEntryHandledSuccess :
        public DepListEntryHandled,
        public ConstAcceptInterfaceVisitsThis<DepListEntryHandledVisitorTypes, DepListEntryHandledSuccess>
    {
    };

    /**
     * Represents a DepListEntry that was skipped because of unsatisfied
     * dependencies.
     *
     * \ingroup g_dep_list
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE DepListEntryHandledSkippedUnsatisfied :
        public DepListEntryHandled,
        public ConstAcceptInterfaceVisitsThis<DepListEntryHandledVisitorTypes, DepListEntryHandledSkippedUnsatisfied>,
        private PrivateImplementationPattern<DepListEntryHandledSkippedUnsatisfied>
    {
        public:
            ///\name Basic operations
            ///\{

            DepListEntryHandledSkippedUnsatisfied(const PackageDepSpec &);
            ~DepListEntryHandledSkippedUnsatisfied();

            ///\}

            /**
             * What PackageDepSpec was unsatisfied? If multiple specs were
             * unsatisfied, returns one of them.
             */
            const PackageDepSpec spec() const PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    /**
     * Represents a DepListEntry that failed.
     *
     * \ingroup g_dep_list
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE DepListEntryHandledFailed :
        public DepListEntryHandled,
        public ConstAcceptInterfaceVisitsThis<DepListEntryHandledVisitorTypes, DepListEntryHandledFailed>
    {
    };
}

#endif