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
|
// file : cli/context.hxx
// author : Boris Kolpackov <boris@codesynthesis.com>
// copyright : Copyright (c) 2009-2011 Code Synthesis Tools CC
// license : MIT; see accompanying LICENSE file
#ifndef CLI_CONTEXT_HXX
#define CLI_CONTEXT_HXX
#include <set>
#include <map>
#include <string>
#include <ostream>
#include <cstddef> // std::size_t
#include <cutl/shared-ptr.hxx>
#include "options.hxx"
#include "semantics.hxx"
#include "traversal.hxx"
using std::endl;
class generation_failed {};
enum usage
{
ut_none,
ut_short,
ut_long,
ut_both
};
class context
{
public:
typedef std::size_t size_t;
typedef std::string string;
typedef ::options options_type;
typedef ::usage usage_type;
private:
struct data;
cutl::shared_ptr<data> data_;
public:
std::ostream& os;
semantics::cli_unit& unit;
options_type const& options;
bool modifier;
bool specifier;
usage_type usage;
string const& inl;
string const& opt_prefix;
string const& opt_sep;
string const& cli;
typedef std::map<string, string> reserved_name_map_type;
reserved_name_map_type const& reserved_name_map;
typedef std::set<string> keyword_set_type;
keyword_set_type const& keyword_set;
private:
struct data
{
string inl_;
string cli_;
keyword_set_type keyword_set_;
};
public:
// Escape C++ keywords, reserved names, and illegal characters.
//
string
escape (string const&) const;
// Translate and format the documentation string. Translate converts
// the <arg>-style constructs to \i{arg}. Format converts the string
// to the output format.
//
enum output_type
{
ot_plain,
ot_html,
ot_man
};
static string
translate_arg (string const&, std::set<string>&);
static string
translate (string const&, std::set<string> const&);
// If para is true, start a new paragraph.
//
string
format (output_type, string const&, bool para);
void
format_line (output_type, string&, const char*, size_t);
// Substitute doc variable expansions ($var$).
//
static string
substitute (const string&, semantics::cli_unit&);
string
substitute (const string& s) {return substitute (s, unit);}
public:
static string const&
ename (semantics::nameable& n)
{
return n.context ().get<string> ("name");
}
static string const&
especifier (semantics::nameable& n)
{
return n.context ().get<string> ("specifier");
}
static string const&
emember (semantics::nameable& n)
{
return n.context ().get<string> ("member");
}
static string const&
especifier_member (semantics::nameable& n)
{
return n.context ().get<string> ("specifier-member");
}
public:
// Return fully-qualified C++ or CLI name.
//
string
fq_name (semantics::nameable& n, bool cxx_name = true);
// Open/close namespace. If last is false, then the last name
// component is not treated as a namespace. The open function
// also returns the last name component.
//
public:
string
ns_open (const string& name, bool last = true);
void
ns_close (const string& name, bool last = true);
public:
context (std::ostream&, semantics::cli_unit&, options_type const&);
context (context&);
private:
context&
operator= (context const&);
};
// Checks if scope Y names any of X.
//
template <typename X, typename Y>
bool
has (Y& y)
{
for (semantics::scope::names_iterator i (y.names_begin ()),
e (y.names_end ()); i != e; ++i)
if (i->named (). template is_a<X> ())
return true;
return false;
}
// Standard namespace traverser.
//
struct namespace_: traversal::namespace_, context
{
namespace_ (context& c) : context (c) {}
virtual void
pre (type&);
virtual void
post (type&);
};
#endif // CLI_CONTEXT_HXX
|
