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

/*
 * Copyright (c) 2005, 2006, 2007 Ciaran McCreesh
 * Copyright (c) 2006 Danny van Dyk
 *
 * 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_GENTOO_LAYOUT_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORIES_GENTOO_LAYOUT_HH 1

#include <paludis/name-fwd.hh>
#include <paludis/version_spec-fwd.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/fs_entry-fwd.hh>
#include <paludis/util/exception.hh>
#include <paludis/util/virtual_constructor.hh>
#include <paludis/util/tr1_memory.hh>
#include <paludis/util/map-fwd.hh>

namespace paludis
{
    class ERepository;

    namespace erepository
    {
        class ERepositoryEntries;

        /**
         * Manages the layout of a ERepository.
         *
         * \ingroup grperepository
         * \nosubgrouping
         */
        class PALUDIS_VISIBLE Layout
        {
            private:
                tr1::shared_ptr<const FSEntry> _master_repository_location;

            protected:
                ///\name Basic operations
                ///\{

                Layout(tr1::shared_ptr<const FSEntry> master_repository_location);

                ///\}

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

                virtual ~Layout() = 0;

                ///\}

                ///\name Configuration information
                ///\{

                tr1::shared_ptr<const FSEntry> master_repository_location() const;

                ///\}

                ///\name Layout operations
                ///\{

                virtual bool has_category_named(const CategoryNamePart &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual bool has_package_named(const QualifiedPackageName &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual tr1::shared_ptr<const CategoryNamePartSet> category_names() const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual tr1::shared_ptr<const QualifiedPackageNameSet> package_names(
                        const CategoryNamePart &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual tr1::shared_ptr<const PackageIDSequence> package_ids(
                        const QualifiedPackageName &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual FSEntry info_packages_file(const FSEntry &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual FSEntry info_variables_file(const FSEntry &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual FSEntry package_directory(const QualifiedPackageName &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual FSEntry category_directory(const CategoryNamePart &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual FSEntry package_file(const PackageID &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual tr1::shared_ptr<const FSEntrySequence> arch_list_files() const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual tr1::shared_ptr<const FSEntrySequence> repository_mask_files() const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual tr1::shared_ptr<const FSEntrySequence> profiles_desc_files() const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual tr1::shared_ptr<const FSEntrySequence> mirror_files() const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual tr1::shared_ptr<const FSEntrySequence> use_desc_dirs() const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual bool eapi_ebuild_suffix() const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual FSEntry profiles_base_dir() const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual tr1::shared_ptr<const FSEntrySequence> exlibsdirs(const QualifiedPackageName &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual tr1::shared_ptr<Map<FSEntry, std::string> > manifest_files(const QualifiedPackageName &) const
                    PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual FSEntry sync_filter_file() const;

                virtual void invalidate_masks() = 0;

                ///\}
        };

        /**
         * Thrown if a layout of the specified type does not exist.
         *
         * \ingroup grpexceptions
         * \ingroup grperepository
         * \nosubgrouping
         */
        class PALUDIS_VISIBLE NoSuchLayoutType :
            public ConfigurationError
        {
            public:
                /**
                 * Constructor.
                 */
                NoSuchLayoutType(const std::string & format) throw ();
        };

        /**
         * Virtual constructor for Layout.
         *
         * \ingroup grperepository
         */
        class PALUDIS_VISIBLE LayoutMaker :
            public VirtualConstructor<std::string,
                tr1::shared_ptr<Layout> (*) (const ERepository * const, const FSEntry &,
                        tr1::shared_ptr<const ERepositoryEntries>,
                        tr1::shared_ptr<const FSEntry>),
                virtual_constructor_not_found::ThrowException<NoSuchLayoutType> >,
            public InstantiationPolicy<LayoutMaker, instantiation_method::SingletonTag>
        {
            friend class InstantiationPolicy<LayoutMaker, instantiation_method::SingletonTag>;

            private:
                LayoutMaker();
        };
    }
}

#endif