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

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

#include <paludis/user_dep_spec-fwd.hh>
#include <paludis/dep_spec.hh>
#include <paludis/slot_requirement.hh>
#include <paludis/filter.hh>
#include <paludis/additional_package_dep_spec_requirement.hh>
#include <paludis/util/pimp.hh>

namespace paludis
{
    /**
     * Create a PackageDepSpec from user input.
     *
     * \ingroup g_dep_spec
     * \since 0.28
     */
    PackageDepSpec parse_user_package_dep_spec(
            const std::string &,
            const Environment * const,
            const UserPackageDepSpecOptions &,
            const Filter & = filter::All()) PALUDIS_VISIBLE;

    /**
     * Create a PackageDepSpec from user input, restricted to not having
     * an Environment available.
     *
     * For use in test cases; should not be used elsewhere.
     *
     * \ingroup g_dep_spec
     * \since 0.61
     */
    PackageDepSpec envless_parse_package_dep_spec_for_tests(
            const std::string &) PALUDIS_VISIBLE;

    class PALUDIS_VISIBLE UserSlotExactFullRequirement :
        public SlotExactFullRequirement
    {
        private:
            const std::pair<SlotName, SlotName> _s;

        public:
            UserSlotExactFullRequirement(const std::pair<SlotName, SlotName> &);

            virtual const std::pair<SlotName, SlotName> slots() const PALUDIS_ATTRIBUTE((warn_unused_result));
            virtual const std::string as_string() const PALUDIS_ATTRIBUTE((warn_unused_result));
            virtual const std::shared_ptr<const SlotRequirement> maybe_original_requirement_if_rewritten() const PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    class PALUDIS_VISIBLE UserSlotExactPartialRequirement :
        public SlotExactPartialRequirement
    {
        private:
            const SlotName _s;

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

            UserSlotExactPartialRequirement(const SlotName &);

            ///\}

            virtual const SlotName slot() const PALUDIS_ATTRIBUTE((warn_unused_result));
            virtual const std::string as_string() const PALUDIS_ATTRIBUTE((warn_unused_result));
            virtual const std::shared_ptr<const SlotRequirement> maybe_original_requirement_if_rewritten() const PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    /**
     * A key requirement for a user PackageDepSpec.
     *
     * \since 0.36
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE UserKeyRequirement :
        public AdditionalPackageDepSpecRequirement
    {
        private:
            Pimp<UserKeyRequirement> _imp;

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

            UserKeyRequirement(const std::string &);
            ~UserKeyRequirement();

            ///\}

            virtual const std::pair<bool, std::string> requirement_met(
                    const Environment * const, const ChangedChoices *,
                    const std::shared_ptr<const PackageID> &,
                    const std::shared_ptr<const PackageID> &,
                    const ChangedChoices * const) const PALUDIS_ATTRIBUTE((warn_unused_result));

            virtual const std::string as_human_string(
                    const std::shared_ptr<const PackageID> &) const PALUDIS_ATTRIBUTE((warn_unused_result));

            virtual const std::string as_raw_string() const PALUDIS_ATTRIBUTE((warn_unused_result));

            virtual Tribool accumulate_changes_to_make_met(
                    const Environment * const,
                    const ChangedChoices * const,
                    const std::shared_ptr<const PackageID> &,
                    const std::shared_ptr<const PackageID> &,
                    ChangedChoices &) const PALUDIS_ATTRIBUTE((warn_unused_result));
    };

    extern template class Pimp<UserKeyRequirement>;

    /**
     * An exclude requirement for a PackageDepSpec.
     *
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE ExcludeRequirement :
        public AdditionalPackageDepSpecRequirement
    {
        private:
            PackageDepSpec _s;

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

            ExcludeRequirement(const PackageDepSpec &);
            ~ExcludeRequirement();

            ///\}

            virtual const std::pair<bool, std::string> requirement_met(
                    const Environment * const, const ChangedChoices *,
                    const std::shared_ptr<const PackageID> &,
                    const std::shared_ptr<const PackageID> &,
                    const ChangedChoices * const) const PALUDIS_ATTRIBUTE((warn_unused_result));

            virtual const std::string as_human_string(
                    const std::shared_ptr<const PackageID> &) const PALUDIS_ATTRIBUTE((warn_unused_result));

            virtual const std::string as_raw_string() const PALUDIS_ATTRIBUTE((warn_unused_result));

            virtual Tribool accumulate_changes_to_make_met(
                    const Environment * const,
                    const ChangedChoices * const,
                    const std::shared_ptr<const PackageID> &,
                    const std::shared_ptr<const PackageID> &,
                    ChangedChoices &) const PALUDIS_ATTRIBUTE((warn_unused_result));
    };
}

#endif