aboutsummaryrefslogtreecommitdiff
path: root/paludis/uninstall_list.hh
blob: 7f268be2e19ef71232f09bf92b4640e59a839db0 (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
/* 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_UNUSED_LIST_HH
#define PALUDIS_GUARD_PALUDIS_UNUSED_LIST_HH 1

#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/sr.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/dep_tag-fwd.hh>

/** \file
 * Declarations for UninstallList and related classes.
 *
 * \ingroup g_dep_list
 *
 * \section Examples
 *
 * - None at this time. Use UninstallTask if you need to uninstall things.
 */

namespace paludis
{

#include <paludis/uninstall_list-se.hh>
#include <paludis/uninstall_list-sr.hh>

    class Environment;

    /**
     * Work out uninstall ordering for packages.
     *
     * \ingroup g_dep_list
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE UninstallList :
        private PrivateImplementationPattern<UninstallList>,
        public InstantiationPolicy<UninstallList, instantiation_method::NonCopyableTag>
    {
        private:
            void add_package(const tr1::shared_ptr<const PackageID> &, tr1::shared_ptr<DepTag>,
                    const UninstallListEntryKind k);
            void real_add(const tr1::shared_ptr<const PackageID> &,
                    tr1::shared_ptr<DepTag>, const bool);
            void move_package_to_end(const tr1::shared_ptr<const PackageID> &);
            void add_unused_dependencies();
            void add_dependencies(const PackageID &, const bool);

            tr1::shared_ptr<const PackageIDSet> collect_depped_upon(
                    const tr1::shared_ptr<const PackageIDSet> targets) const;

            tr1::shared_ptr<const PackageIDSet> collect_all_installed() const;

            tr1::shared_ptr<const PackageIDSet> collect_world() const;

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

            UninstallList(const Environment * const, const UninstallListOptions &);
            virtual ~UninstallList();

            ///\}

            /**
             * Our options.
             */
            UninstallListOptions & options;

            /**
             * Add a package, optionally with a reason.
             */
            void add(const tr1::shared_ptr<const PackageID> &,
                    tr1::shared_ptr<DepTag> = tr1::shared_ptr<DepTag>());

            /**
             * Add any unused packages that are dependencies of packages to uninstall.
             */
            void add_unused();

            /**
             * Whether we have any errors.
             */
            bool has_errors() const;

            ///\name Iterate over our items to remove
            ///\{

            struct UninstallListTag;
            typedef WrappedForwardIterator<UninstallListTag, const UninstallListEntry> ConstIterator;
            ConstIterator begin() const;
            ConstIterator end() const;

            ///\}
    };
}

#endif