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

/*
 * Copyright (c) 2005, 2006, 2007, 2008, 2010 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_NAME_FWD_HH
#define PALUDIS_GUARD_PALUDIS_NAME_FWD_HH 1

#include <paludis/util/wrapped_value-fwd.hh>
#include <paludis/util/set-fwd.hh>
#include <paludis/util/sequence-fwd.hh>
#include <paludis/util/attributes.hh>
#include <iosfwd>

/** \file
 * Forward declarations for paludis/name.hh .
 *
 * \ingroup g_names
 */

namespace paludis
{
    class PackageNamePartTag;
    class PackageNamePartError;
    template <> struct WrappedValueTraits<PackageNamePartTag>;

    /**
     * A PackageNamePart holds a std::string that is a valid name for the
     * package part of a QualifiedPackageName.
     *
     * \ingroup g_names
     */
    typedef WrappedValue<PackageNamePartTag> PackageNamePart;

    typedef Set<PackageNamePart> PackageNamePartSet;

    class CategoryNamePartTag;
    class CategoryNamePartError;
    template <> struct WrappedValueTraits<CategoryNamePartTag>;

    /**
     * A CategoryNamePart holds a std::string that is a valid name for the
     * category part of a QualifiedPackageName.
     *
     * \ingroup g_names
     */
    typedef WrappedValue<CategoryNamePartTag> CategoryNamePart;

    typedef Set<CategoryNamePart> CategoryNamePartSet;

    class QualifiedPackageName;

    /**
     * Output a QualifiedPackageName to a stream.
     *
     * \ingroup g_names
     */
    std::ostream & operator<< (std::ostream &, const QualifiedPackageName &) PALUDIS_VISIBLE;

    /**
     * A CategoryNamePart plus a PackageNamePart is a QualifiedPackageName.
     *
     * \ingroup g_names
     */
    inline const QualifiedPackageName
    operator+ (const CategoryNamePart & c, const PackageNamePart & p) PALUDIS_ATTRIBUTE((warn_unused_result));

    class SlotNameTag;
    class SlotNameError;
    template <> struct WrappedValueTraits<SlotNameTag>;

    typedef Set<QualifiedPackageName> QualifiedPackageNameSet;

    /**
     * A SlotName holds a std::string that is a valid name for a SLOT.
     *
     * \ingroup g_names
     */
    typedef WrappedValue<SlotNameTag> SlotName;

    class RepositoryNameTag;
    class RepositoryNameError;
    template <> struct WrappedValueTraits<RepositoryNameTag>;

    /**
     * A RepositoryName holds a std::string that is a valid name for a
     * Repository.
     *
     * \ingroup g_names
     */
    typedef WrappedValue<RepositoryNameTag> RepositoryName;

    typedef Set<RepositoryName> RepositoryNameSet;

    class KeywordNameTag;
    class KeywordNameError;
    template <> struct WrappedValueTraits<KeywordNameTag>;

    /**
     * A KeywordName holds a std::string that is a valid name for a KEYWORD.
     *
     * \ingroup g_names
     */
    typedef WrappedValue<KeywordNameTag> KeywordName;

    typedef Set<KeywordName> KeywordNameSet;

    class SetNameTag;
    class SetNameError;
    template <> struct WrappedValueTraits<SetNameTag>;

    /**
     * A SetName holds a std::string that is a valid name for a set.
     *
     * \ingroup g_names
     */
    typedef WrappedValue<SetNameTag> SetName;

    typedef Set<SetName> SetNameSet;
}

#endif