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

/*
 * Copyright (c) 2006, 2007 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_UNINSTALL_TASK_HH
#define PALUDIS_GUARD_PALUDIS_UNINSTALL_TASK_HH 1

#include <paludis/dep_spec-fwd.hh>
#include <paludis/dep_tree.hh>
#include <paludis/package_id.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/exception.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>

/** \file
 * Declarations for UninstallTask.
 *
 * \ingroup g_tasks
 *
 * \section Examples
 *
 * - None at this time.
 */

namespace paludis
{
    class Environment;
    class UninstallListEntry;

    /**
     * Thrown if an ambiguous unmerge target is supplied.
     *
     * \ingroup g_exceptions
     * \ingroup g_tasks
     */
    class PALUDIS_VISIBLE AmbiguousUnmergeTargetError :
        public Exception
    {
        private:
            const std::string _t;
            const tr1::shared_ptr<const PackageIDSequence> _p;

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

            AmbiguousUnmergeTargetError(const std::string & our_target,
                    const tr1::shared_ptr<const PackageIDSequence> matches) throw ();

            ~AmbiguousUnmergeTargetError() throw ();

            ///\}

            ///\name Iterate over our entries
            ///\{

            typedef WrappedForwardIterator<enum ConstIteratorTag { }, const tr1::shared_ptr<const PackageID> > ConstIterator;
            ConstIterator begin() const;
            ConstIterator end() const;

            ///\}

            /**
             * What was our target?
             */
            std::string target() const;
    };

    /**
     * Task used to uninstall one or more targets.
     *
     * \ingroup g_tasks
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE UninstallTask :
        PrivateImplementationPattern<UninstallTask>,
        InstantiationPolicy<UninstallTask, instantiation_method::NonCopyableTag>
    {
        protected:
            ///\name Basic operations
            ///\{

            UninstallTask(Environment * const env);

            ///\}

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

            virtual ~UninstallTask();

            ///\}

            ///\name Behaviour options
            ///\{

            void set_no_config_protect(const bool value);
            void set_pretend(const bool value);
            void set_preserve_world(const bool value);
            void set_all_versions(const bool value);
            void set_with_unused_dependencies(const bool value);
            void set_with_dependencies(const bool value);
            void set_check_safety(const bool value);

            ///\}

            ///\name Add targets
            ///\{

            void add_target(const std::string &);
            void add_unused();

            ///\}

            ///\name Event callbacks
            ///\{

            virtual void on_build_unmergelist_pre() = 0;
            virtual void on_build_unmergelist_post() = 0;

            virtual void on_display_unmerge_list_pre() = 0;
            virtual void on_display_unmerge_list_post() = 0;
            virtual void on_display_unmerge_list_entry(const UninstallListEntry &) = 0;

            virtual void on_uninstall_all_pre() = 0;
            virtual void on_uninstall_pre(const UninstallListEntry &) = 0;
            virtual void on_uninstall_post(const UninstallListEntry &) = 0;
            virtual void on_uninstall_all_post() = 0;

            virtual void on_not_continuing_due_to_errors() = 0;

            virtual void on_update_world_pre() = 0;
            virtual void on_update_world(const PackageDepSpec &) = 0;
            virtual void on_update_world(const SetName &) = 0;
            virtual void on_update_world_post() = 0;
            virtual void on_preserve_world() = 0;

            ///\}

            ///\name Logic
            ///\{

            virtual void world_remove_set(const SetName &);
            virtual void world_remove_packages(tr1::shared_ptr<const SetSpecTree::ConstItem>);

            ///\}

            /**
             * Run the task.
             */
            void execute();
    };
}

#endif