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

/*
 * Copyright (c) 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_REPOSITORIES_UNPACKAGED_NDBAM_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORIES_UNPACKAGED_NDBAM_HH 1

#include <paludis/ndbam-fwd.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/fs_path.hh>
#include <paludis/util/sequence-fwd.hh>
#include <paludis/util/mutex.hh>
#include <paludis/util/named_value.hh>
#include <paludis/name.hh>
#include <paludis/version_spec.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/contents-fwd.hh>
#include <functional>

namespace paludis
{
    namespace n
    {
        typedef Name<struct name_fs_location> fs_location;
        typedef Name<struct name_magic> magic;
        typedef Name<struct name_mutex> mutex;
        typedef Name<struct name_name> name;
        typedef Name<struct name_package_id> package_id;
        typedef Name<struct name_slot> slot;
        typedef Name<struct name_version> version;
    }

    struct NDBAMEntry
    {
        NamedValue<n::fs_location, FSPath> fs_location;
        NamedValue<n::magic, std::string> magic;
        NamedValue<n::mutex, std::shared_ptr<Mutex> > mutex;
        NamedValue<n::name, QualifiedPackageName> name;
        NamedValue<n::package_id, std::shared_ptr<PackageID> > package_id;
        NamedValue<n::slot, SlotName> slot;
        NamedValue<n::version, VersionSpec> version;
    };

    /**
     * NDBAM provides a partial implementation of a Repository for installed packages using
     * a Paludis-defined on-disk format. It is used by unpackaged repositories and exndbam,
     * where the format can be defined by us. NDBAM is designed to reduce unnecessary disk
     * access and to reduce the need for global locking.
     *
     * \ingroup g_ndbam
     * \since 0.26
     */
    class PALUDIS_VISIBLE NDBAM
    {
        private:
            Pimp<NDBAM> _imp;

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

            /**
             * Constructor.
             *
             * \param version_options \since 0.38
             */
            NDBAM(const FSPath &,
                    const std::function<bool (const std::string &)> & check_format,
                    const std::string & preferred_format, const VersionSpecOptions & version_options);
            ~NDBAM();

            ///\}

            ///\name Repository method implementations
            ///\{

            std::shared_ptr<const CategoryNamePartSet> category_names()
                PALUDIS_ATTRIBUTE((warn_unused_result));

            std::shared_ptr<const QualifiedPackageNameSet> package_names(
                    const CategoryNamePart & c)
                PALUDIS_ATTRIBUTE((warn_unused_result));

            std::shared_ptr<const CategoryNamePartSet> category_names_containing_package(
                    const PackageNamePart &) const
                PALUDIS_ATTRIBUTE((warn_unused_result));

            bool has_package_named(const QualifiedPackageName &)
                PALUDIS_ATTRIBUTE((warn_unused_result));

            bool has_category_named(const CategoryNamePart &)
                PALUDIS_ATTRIBUTE((warn_unused_result));

            std::shared_ptr<NDBAMEntrySequence> entries(const QualifiedPackageName &)
                PALUDIS_ATTRIBUTE((warn_unused_result));

            void add_entry(const QualifiedPackageName &, const FSPath &);
            void remove_entry(const QualifiedPackageName &, const FSPath &);

            ///\}

            /**
             * Parse the contents file for a given ID, using the provided callbacks.
             */
            void parse_contents(const PackageID &,
                    const std::function<void (const std::shared_ptr<const ContentsEntry> &)> & on_file,
                    const std::function<void (const std::shared_ptr<const ContentsEntry> &)> & on_dir,
                    const std::function<void (const std::shared_ptr<const ContentsEntry> &)> & on_sym
                    ) const;

            /**
             * Index a newly added QualifiedPackageName, using the provided data directory
             * name part.
             */
            void index(const QualifiedPackageName &, const std::string &) const;

            /**
             * Deindex a QualifiedPackageName that no longer has any versions installed.
             */
            void deindex(const QualifiedPackageName &) const;
    };
}

#endif