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

/*
 * Copyright (c) 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
 *
 * 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_PACKAGE_ID_HH
#define PALUDIS_GUARD_PALUDIS_PACKAGE_ID_HH 1

#include <paludis/package_id-fwd.hh>
#include <paludis/metadata_key-fwd.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/tr1_memory.hh>
#include <paludis/util/operators.hh>
#include <paludis/name-fwd.hh>
#include <paludis/version_spec-fwd.hh>
#include <paludis/dep_spec-fwd.hh>
#include <paludis/eapi-fwd.hh>
#include <paludis/repository-fwd.hh>

namespace paludis
{
    class PackageDatabase;

    class PALUDIS_VISIBLE PackageID :
        private InstantiationPolicy<PackageID, instantiation_method::NonCopyableTag>,
        private PrivateImplementationPattern<PackageID>,
        public equality_operators::HasEqualityOperators
    {
        protected:
            virtual void add_key(const tr1::shared_ptr<const MetadataKey> &) const;
            virtual void need_keys_added() const = 0;

        public:
            PackageID();
            virtual ~PackageID() = 0;

            virtual const std::string canonical_form(const PackageIDCanonicalForm) const = 0;

            virtual const QualifiedPackageName name() const = 0;
            virtual const VersionSpec version() const = 0;
            virtual const SlotName slot() const = 0;
            virtual const tr1::shared_ptr<const Repository> repository() const = 0;
            virtual const tr1::shared_ptr<const EAPI> eapi() const = 0;

            ///\name Specific keys
            ///\{

            virtual const tr1::shared_ptr<const MetadataPackageIDKey> virtual_for_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSetKey<KeywordNameSet> > keywords_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSetKey<UseFlagNameSet> > use_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSetKey<IUseFlagSet> > iuse_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSetKey<InheritedSet> > inherited_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSpecTreeKey<LicenseSpecTree> > license_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSpecTreeKey<ProvideSpecTree> > provide_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSpecTreeKey<DependencySpecTree> > build_dependencies_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSpecTreeKey<DependencySpecTree> > run_dependencies_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSpecTreeKey<DependencySpecTree> > post_dependencies_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSpecTreeKey<DependencySpecTree> > suggested_dependencies_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSpecTreeKey<RestrictSpecTree> > restrict_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSpecTreeKey<URISpecTree> > src_uri_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSpecTreeKey<URISpecTree> > bin_uri_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataSpecTreeKey<URISpecTree> > homepage_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataStringKey> short_description_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataStringKey> long_description_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataContentsKey> contents_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataTimeKey> installed_time_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataStringKey> source_origin_key() const = 0;
            virtual const tr1::shared_ptr<const MetadataStringKey> binary_origin_key() const = 0;

            ///\}

            ///\name Finding and iterating over keys
            ///\{

            typedef libwrapiter::ForwardIterator<PackageID, const MetadataKey> Iterator;
            Iterator begin() const PALUDIS_ATTRIBUTE((warn_unused_result));
            Iterator end() const PALUDIS_ATTRIBUTE((warn_unused_result));
            Iterator find(const std::string &) const PALUDIS_ATTRIBUTE((warn_unused_result));

            ///\}

            ///\name Extra comparisons
            ///\{

            /**
             * Perform an arbitrary less than comparison on another PackageID.
             *
             * Used by PackageIDSetComparator and operator==. This function
             * should not be used by anything else.
             *
             * This function will only be called if the other PackageID has the
             * same name, version and repository as this. If this is not enough
             * to uniquely identify an ID (e.g. if there is an affix, or if multiple
             * slots per version are allowed), then this function's
             * implementation must differentiate appropriately.
             */
            virtual bool arbitrary_less_than_comparison(const PackageID &) const
                PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

            /**
             * Provide any additional hash information for a PackageID.
             *
             * The standard PackageID hash incorporates the repository name, the
             * package name and the version of the package. If this function is
             * defined, its value is also used when determining a hash. This can
             * provide increased performance if a repository uses affixes or
             * multiple slots per version.
             */
            virtual std::size_t extra_hash_value() const
                PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

            ///\}
    };

    bool operator== (const PackageID &, const PackageID &) PALUDIS_ATTRIBUTE((warn_unused_result)) PALUDIS_VISIBLE;

    class PALUDIS_VISIBLE PackageIDSetComparator
    {
        public:
            bool operator() (const tr1::shared_ptr<const PackageID> &,
                    const tr1::shared_ptr<const PackageID> &) const;
    };

    class PALUDIS_VISIBLE PackageIDComparator :
        private PrivateImplementationPattern<PackageIDComparator>
    {
        public:
            typedef bool result_type;

            PackageIDComparator(const PackageDatabase * const);
            ~PackageIDComparator();

            bool operator() (const tr1::shared_ptr<const PackageID> &,
                    const tr1::shared_ptr<const PackageID> &) const;
    };
}

#endif