aboutsummaryrefslogtreecommitdiff
path: root/paludis/args/man.hh
blob: 3ea947a4b39e9bd607167de9b7dfba48aff14210 (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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2006, 2007, 2009, 2010 Ciaran McCreesh
 * Copyright (c) 2011 Ingmar Vanhassel
 *
 * 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_ARGS_MAN_HH
#define PALUDIS_GUARD_PALUDIS_ARGS_MAN_HH 1

#include <paludis/args/args_handler.hh>
#include <iosfwd>

namespace paludis
{
    namespace args
    {
        class DocWriter;

        /**
         * Write docs to an ostream.
         *
         * \ingroup grplibpaludisargs
         */
        void generate_doc(DocWriter & dw, const ArgsHandler * const h) PALUDIS_VISIBLE;

        /**
         * Write docs from args classes in a particular format.
         *
         * \ingroup grplibpaludisargs
         * \nosubgrouping
         */
        class PALUDIS_VISIBLE DocWriter
        {
            public:
                ///\name Basic operations
                ///\{

                virtual ~DocWriter() = 0;

                ///\}

                ///\name Output routines
                ///\{

                virtual void heading(const std::string & name, const std::string & section,
                        const std::string & synopsis) = 0;
                virtual void start_usage_lines() = 0;
                virtual void usage_line(const std::string & name, const std::string & line) = 0;

                virtual void start_description(const std::string & description) = 0;
                virtual void extra_description(const std::string & description) = 0;
                virtual void end_description() = 0;

                virtual void start_options(const std::string &) = 0;
                virtual void start_arg_group(const std::string & name, const std::string & description) = 0;
                virtual void arg_group_item(const char & short_name, const std::string & long_name,
                        const std::string & negated_long_name, const std::string & description) = 0;
                virtual void start_extra_arg() = 0;
                virtual void extra_arg_enum(const AllowedEnumArg &, const std::string & default_arg) = 0;
                virtual void extra_arg_string_set(const std::string & first, const std::string & second) = 0;
                virtual void end_extra_arg() = 0;
                virtual void end_arg_group() = 0;
                virtual void end_options() = 0;

                virtual void start_environment() = 0;
                virtual void environment_line(const std::string & first, const std::string & second) = 0;
                virtual void end_environment() = 0;

                virtual void start_examples() = 0;
                virtual void example(const std::string &, const std::string &) = 0;
                virtual void end_examples() = 0;

                virtual void start_notes() = 0;
                virtual void note(const std::string &) = 0;
                virtual void end_notes() = 0;

                virtual void section(const std::string & title) = 0;
                virtual void subsection(const std::string & title) = 0;
                virtual void paragraph(const std::string & text) = 0;

                virtual void start_see_alsos() = 0;
                virtual void see_also(const std::string &, const int, const bool first) = 0;
                virtual void end_see_alsos() = 0;

                ///\}
        };

        /**
         * Create Asciidoc documentation from args classes.
         *
         * \ingroup grplibpaludisargs
         * \nosubgrouping
         */
        class PALUDIS_VISIBLE AsciidocWriter :
            public DocWriter
        {
            private:
                std::ostream & _os;

            public:
                ///\name Basic operations
                ///\{
                AsciidocWriter(std::ostream & os);
                ~AsciidocWriter();
                ///\}

                void heading(const std::string & name, const std::string & section,
                        const std::string & synopis);
                void start_usage_lines();
                void usage_line(const std::string & name, const std::string & line);

                void start_description(const std::string & description);
                void extra_description(const std::string & description);
                void end_description();

                void start_options(const std::string & s);
                void start_arg_group(const std::string & name, const std::string & description);
                void arg_group_item(const char & short_name, const std::string & long_name,
                        const std::string & negated_long_name, const std::string & description);
                void start_extra_arg();
                void extra_arg_enum(const AllowedEnumArg &, const std::string & default_arg);
                void extra_arg_string_set(const std::string & first, const std::string & second);
                void end_extra_arg();
                void end_arg_group();
                void end_options();

                void start_environment();
                void environment_line(const std::string & first, const std::string & second);
                void end_environment();

                void start_examples();
                void example(const std::string &, const std::string &);
                void end_examples();

                void start_notes();
                void note(const std::string &);
                void end_notes();

                void section(const std::string & title);
                void subsection(const std::string & title);
                void paragraph(const std::string & text);

                void start_see_alsos();
                void see_also(const std::string &, const int, const bool first);
                void end_see_alsos();
        };

        /**
         * Create HTML documentation from args classes.
         *
         * \ingroup grplibpaludisargs
         * \nosubgrouping
         */
        class PALUDIS_VISIBLE HtmlWriter :
            public DocWriter
        {
            private:
                std::ostream & _os;

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

                HtmlWriter(std::ostream & os);
                ~HtmlWriter();

                ///\}

                void heading(const std::string & name, const std::string & section,
                        const std::string & synopis);
                void start_usage_lines();
                void usage_line(const std::string & name, const std::string & line);

                void start_description(const std::string & description);
                void extra_description(const std::string & description);
                void end_description();

                void start_options(const std::string &);
                void start_arg_group(const std::string & name, const std::string & description);
                void arg_group_item(const char & short_name, const std::string & long_name,
                        const std::string & negated_long_name, const std::string & description);
                void start_extra_arg();
                void extra_arg_enum(const AllowedEnumArg &, const std::string & default_arg);
                void extra_arg_string_set(const std::string & first, const std::string & second);
                void end_extra_arg();
                void end_arg_group();
                void end_options();

                void start_environment();
                void environment_line(const std::string & first, const std::string & second);
                void end_environment();

                void start_examples();
                void example(const std::string &, const std::string &);
                void end_examples();

                void start_notes();
                void note(const std::string &);
                void end_notes();

                void section(const std::string & title);
                void subsection(const std::string & title);
                void paragraph(const std::string & text);

                void start_see_alsos();
                void see_also(const std::string &, const int, const bool first);
                void end_see_alsos();
        };

        /**
         * Create man documentation from args classes.
         *
         * \ingroup grplibpaludisargs
         * \nosubgrouping
         */
        class PALUDIS_VISIBLE ManWriter :
            public DocWriter
        {
            private:
                std::ostream & _os;

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

                ManWriter(std::ostream & os);
                ~ManWriter();

                ///\}

                void heading(const std::string & name, const std::string & section,
                        const std::string & synopis);
                void start_usage_lines();
                void usage_line(const std::string & name, const std::string & line);

                void start_description(const std::string & description);
                void extra_description(const std::string & description);
                void end_description();

                void start_options(const std::string &);
                void start_arg_group(const std::string & name, const std::string & description);
                void arg_group_item(const char & short_name, const std::string & long_name,
                        const std::string & negated_long_name, const std::string & description);
                void start_extra_arg();
                void extra_arg_enum(const AllowedEnumArg &, const std::string & default_arg);
                void extra_arg_string_set(const std::string & first, const std::string & second);
                void end_extra_arg();
                void end_arg_group();
                void end_options();

                void start_environment();
                void environment_line(const std::string & first, const std::string & second);
                void end_environment();

                void start_examples();
                void example(const std::string &, const std::string &);
                void end_examples();

                void start_notes();
                void note(const std::string &);
                void end_notes();

                void section(const std::string & title);
                void subsection(const std::string & title);
                void paragraph(const std::string & text);

                void start_see_alsos();
                void see_also(const std::string &, const int, const bool first);
                void end_see_alsos();
        };

    }
}

#endif