aboutsummaryrefslogtreecommitdiff
path: root/paludis/legacy/dep_list_exceptions.hh
blob: 7552602e0fb1638490a8b915cde795de10f4dc4e (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
210
211
212
213
214
215
216
217
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006, 2007, 2008, 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_DEP_LIST_EXCEPTIONS_HH
#define PALUDIS_GUARD_PALUDIS_DEP_LIST_EXCEPTIONS_HH 1

#include <paludis/util/exception.hh>
#include <paludis/package_database.hh>
#include <paludis/environment.hh>

/** \file
 * Declarations for DepList exceptions.
 *
 * \ingroup g_dep_spec
 *
 * \section Examples
 *
 * - None at this time.
 */

namespace paludis
{
    /**
     * Thrown if an error occurs whilst building a DepList.
     *
     * \ingroup g_dep_list
     * \ingroup g_exceptions
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE DepListError : public Exception
    {
        protected:
            ///\name Basic operations
            ///\{

            DepListError(const std::string &) throw ();

            ///\}
    };

    /**
     * Thrown if all versions of a particular spec are masked.
     *
     * \ingroup g_dep_list
     * \ingroup g_exceptions
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE AllMaskedError : public DepListError
    {
        private:
            const PackageDepSpec _query;
            const std::shared_ptr<const PackageID> _from_id;

        public:
            ///\name Basic operations
            ///\{

            AllMaskedError(const PackageDepSpec & query, const std::shared_ptr<const PackageID> & id) throw ();

            virtual ~AllMaskedError() throw ()
            {
            }

            ///\}

            /**
             * Our query.
             */
            const PackageDepSpec query() const
            {
                return _query;
            }

            const std::shared_ptr<const PackageID> from_id() const
            {
                return _from_id;
            }
    };

    /**
     * Thrown if all versions of a particular spec are masked,
     * but would not be if additional requirements were not in effect.
     *
     * \ingroup g_dep_list
     * \ingroup g_exceptions
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE AdditionalRequirementsNotMetError : public DepListError
    {
        private:
            PackageDepSpec _query;
            const std::shared_ptr<const PackageID> _id;

        public:
            ///\name Basic operations
            ///\{

            AdditionalRequirementsNotMetError(
                    const PackageDepSpec & query,
                    const std::shared_ptr<const PackageID> & id) throw ();

            virtual ~AdditionalRequirementsNotMetError() throw ();

            ///\}

            /**
             * Our query.
             */
            const PackageDepSpec query() const
            {
                return _query;
            }

            /**
             * Our ID of choice.
             *
             * \since 0.44
             */
            const std::shared_ptr<const PackageID> package_id() const
            {
                return _id;
            }
    };

    /**
     * Thrown if a downgrade is forced and we're not allowed to downgrade.
     *
     * \ingroup g_exceptions
     * \ingroup g_dep_list
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE DowngradeNotAllowedError : public DepListError
    {
        public:
            ///\name Basic operations
            ///\{

            DowngradeNotAllowedError(const std::string & to, const std::string & from) throw ();

            virtual ~DowngradeNotAllowedError() throw ();

            ///\}
    };

    /**
     * Thrown if a block is encountered.
     *
     * \ingroup g_exceptions
     * \ingroup g_dep_list
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE BlockError : public DepListError
    {
        public:
            ///\name Basic operations
            ///\{

            BlockError(const std::string & msg) throw ();

            ///\}
    };

    /**
     * Thrown if a circular dependency is encountered.
     *
     * \ingroup g_dep_list
     * \ingroup g_exceptions
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE CircularDependencyError : public DepListError
    {
        public:
            ///\name Basic operations
            ///\{

            CircularDependencyError(const std::string & msg) throw ();

            ///\}
    };

    /**
     * Thrown if no destination can be found.
     *
     * \ingroup g_dep_list
     * \ingroup g_exceptions
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE NoDestinationError : public DepListError
    {
        public:
            ///\name Basic operations
            ///\{

            NoDestinationError(const std::shared_ptr<const PackageID> &,
                    const std::shared_ptr<const DestinationsSet> &) throw ();

            ///\}
    };
}

#endif