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

/*
 * Copyright (c) 2006, 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_PALUDIS_REPOSITORIES_PORTAGE_USE_DESC_HH
#define PALUDIS_GUARD_PALUDIS_PALUDIS_REPOSITORIES_PORTAGE_USE_DESC_HH 1

#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/name.hh>

namespace paludis
{
    class FSEntry;
    class PackageDatabaseEntry;

    /**
     * Implements use.desc options for PortageRepository.
     *
     * \ingroup grpportagerepository
     */
    class UseDesc :
        private PrivateImplementationPattern<UseDesc>,
        private InstantiationPolicy<UseDesc, instantiation_method::NonCopyableTag>
    {
        public:
            ///\name Basic operations
            ///\{

            UseDesc(const FSEntry &);
            ~UseDesc();

            ///\}

            /**
             * Describe the given use flag, possibly for the specified package.
             *
             * May return an empty string.
             */
            std::string describe(const UseFlagName &, const PackageDatabaseEntry * const) const;
    };
}

#endif