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

/*
 * Copyright (c) 2007, 2008, 2009, 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_STRINGIFY_FORMATTER_HH
#define PALUDIS_GUARD_PALUDIS_STRINGIFY_FORMATTER_HH 1

#include <paludis/stringify_formatter-fwd.hh>
#include <paludis/formatter.hh>
#include <paludis/name.hh>
#include <paludis/dep_spec-fwd.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/fs_path-fwd.hh>

/** \file
 * Declarations for the StringifyFormatter class.
 *
 * \ingroup g_formatters
 *
 * \section Examples
 *
 * - \ref example_stringify_formatter.cc "example_stringify_formatter.cc"
 * - \ref example_formatter.cc "example_formatter.cc"
 */

namespace paludis
{
    /**
     * A StringifyFormatter is a Formatter that implements every format function
     * by calling paludis::stringify().
     *
     * A StringifyFormatter can also act as a wrapper class around another
     * Formatter. Any CanFormat<> interface implemented by that other formatter
     * is used; any not implemented by the other formatter is implemented using
     * paludis::stringify().
     *
     * Indenting is done via simple spaces; newlines are done via a newline
     * character. Again, when used as a wrapper, this can be overridden by the
     * wrapped class.
     *
     * \ingroup g_formatters
     * \since 0.26
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE StringifyFormatter :
        private Pimp<StringifyFormatter>,
        public CanFormat<std::string>,
        public CanFormat<ChoiceValue>,
        public CanFormat<KeywordName>,
        public CanFormat<PackageDepSpec>,
        public CanFormat<BlockDepSpec>,
        public CanFormat<FetchableURIDepSpec>,
        public CanFormat<SimpleURIDepSpec>,
        public CanFormat<DependenciesLabelsDepSpec>,
        public CanFormat<URILabelsDepSpec>,
        public CanFormat<PlainTextDepSpec>,
        public CanFormat<LicenseDepSpec>,
        public CanFormat<ConditionalDepSpec>,
        public CanFormat<NamedSetDepSpec>,
        public CanFormat<FSPath>,
        public CanFormat<PackageID>,
        public CanFormat<PlainTextLabelDepSpec>,
        public CanSpace
    {
        private:
            StringifyFormatter(const StringifyFormatter &);

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

            StringifyFormatter();

            /**
             * StringifyFormatter can be constructed as a wrapper around another
             * formatter.
             */
            template <typename T_> explicit StringifyFormatter(const T_ &);

            ~StringifyFormatter();

            ///\}

            virtual std::string format(const std::string &, const format::Plain &) const;

            virtual std::string format(const ChoiceValue &, const format::Enabled &) const;
            virtual std::string format(const ChoiceValue &, const format::Disabled &) const;
            virtual std::string format(const ChoiceValue &, const format::Forced &) const;
            virtual std::string format(const ChoiceValue &, const format::Masked &) const;
            virtual std::string format(const ChoiceValue &, const format::Plain &) const;
            virtual std::string decorate(const ChoiceValue &, const std::string &, const format::Changed &) const;
            virtual std::string decorate(const ChoiceValue &, const std::string &, const format::Added &) const;

            virtual std::string format(const KeywordName &, const format::Accepted &) const;
            virtual std::string format(const KeywordName &, const format::Unaccepted &) const;
            virtual std::string format(const KeywordName &, const format::Plain &) const;

            virtual std::string format(const PackageDepSpec &, const format::Plain &) const;
            virtual std::string format(const PackageDepSpec &, const format::Installed &) const;
            virtual std::string format(const PackageDepSpec &, const format::Installable &) const;

            virtual std::string format(const BlockDepSpec &, const format::Plain &) const;

            virtual std::string format(const FetchableURIDepSpec &, const format::Plain &) const;

            virtual std::string format(const SimpleURIDepSpec &, const format::Plain &) const;

            virtual std::string format(const DependenciesLabelsDepSpec &, const format::Plain &) const;

            virtual std::string format(const NamedSetDepSpec &, const format::Plain &) const;

            virtual std::string format(const URILabelsDepSpec &, const format::Plain &) const;

            virtual std::string format(const PlainTextDepSpec &, const format::Plain &) const;

            virtual std::string format(const LicenseDepSpec &, const format::Plain &) const;
            virtual std::string format(const LicenseDepSpec &, const format::Accepted &) const;
            virtual std::string format(const LicenseDepSpec &, const format::Unaccepted &) const;

            virtual std::string format(const ConditionalDepSpec &, const format::Enabled &) const;
            virtual std::string format(const ConditionalDepSpec &, const format::Disabled &) const;
            virtual std::string format(const ConditionalDepSpec &, const format::Forced &) const;
            virtual std::string format(const ConditionalDepSpec &, const format::Masked &) const;
            virtual std::string format(const ConditionalDepSpec &, const format::Plain &) const;
            virtual std::string decorate(const ConditionalDepSpec &, const std::string &, const format::Changed &) const;
            virtual std::string decorate(const ConditionalDepSpec &, const std::string &, const format::Added &) const;

            virtual std::string format(const FSPath &, const format::Plain &) const;

            virtual std::string format(const PackageID &, const format::Plain &) const;
            virtual std::string format(const PackageID &, const format::Installed &) const;
            virtual std::string format(const PackageID &, const format::Installable &) const;

            virtual std::string format(const PlainTextLabelDepSpec &, const format::Plain &) const;

            virtual std::string newline() const;
            virtual std::string indent(const int) const;
    };
}

#endif