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

/*
 * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaran.mccreesh@blueyonder.co.uk>
 *
 * 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_DATABASE_ENTRY_HH
#define PALUDIS_GUARD_PALUDIS_PACKAGE_DATABASE_ENTRY_HH 1

#include <paludis/util/smart_record.hh>
#include <paludis/name.hh>
#include <paludis/version_spec.hh>

namespace paludis
{
    /**
     * Keys in a PackageDatabaseEntry.
     */
    enum PackageDatabaseEntryKeys
    {
        pde_name,              ///< Our package
        pde_version,           ///< Our version
        pde_repository,        ///< Our repository
        last_pde               ///< Number of items
    };

    /**
     * Tag for a PackageDatabaseEntry.
     */
    struct PackageDatabaseEntryTag :
        SmartRecordTag<comparison_mode::FullComparisonTag, comparison_method::SmartRecordCompareByAllTag>,
        SmartRecordKeys<PackageDatabaseEntryKeys, last_pde>,
        SmartRecordKey<pde_name, QualifiedPackageName>,
        SmartRecordKey<pde_version, VersionSpec>,
        SmartRecordKey<pde_repository, RepositoryName>
    {
    };

    /**
     * A PackageDatabaseEntry holds a QualifiedPackageName, a VersionSpec and a
     * RepositoryName, and is fully comparable.
     */
    typedef MakeSmartRecord<PackageDatabaseEntryTag>::Type PackageDatabaseEntry;

    /**
     * A collection of PackageDatabaseEntry instances.
     */
    typedef SortedCollection<PackageDatabaseEntry> PackageDatabaseEntryCollection;

    /**
     * A PackageDatabaseEntry can be written to a stream.
     */
    std::ostream & operator<< (std::ostream &, const PackageDatabaseEntry &);
}

#endif