summaryrefslogtreecommitdiff
path: root/modules/CIAO/CCF/CCF/CodeGenerationKit/CommandLineDescriptor.hpp
blob: a7c6961cf1fea4880cea8622fe631b56a52fd374 (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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
// file      : CCF/CodeGenerationKit/CommandLineDescriptor.hpp
// author    : Boris Kolpackov <boris@dre.vanderbilt.edu>
// cvs-id    : $Id$

#ifndef COMMAND_LINE_DESCRIPTOR_H
#define COMMAND_LINE_DESCRIPTOR_H

#include <map>
#include <list>
#include <vector>
#include <string>
#include <ostream>
#include <cassert>


namespace CL
{
  struct OptionType
  {
    enum Value
    {
      flag,
      value
    };

    OptionType (Value v)
        : v_ (v)
    {
    }

    operator Value () const
    {
      return v_;
    }

  private:
    Value v_;
  };


  class OptionDescription
  {
  public:
    OptionDescription (std::string name,
                       std::string description,
                       OptionType type,
                       bool optional = true)
        : optional_ (optional),
          type_ (type),
          name_ (name),
          value_synopsis_ (),
          description_ (description)
    {
      // There should be value_synopsis for non-flag options.
      //
      assert (type == OptionType::flag);
    }


    OptionDescription (std::string name,
                       std::string value_synopsis,
                       std::string description,
                       OptionType type,
                       bool optional = true)
        : optional_ (optional),
          type_ (type),
          name_ (name),
          value_synopsis_ (value_synopsis),
          description_ (description)
    {
    }

  public:
    bool
    optional () const
    {
      return optional_;
    }

    OptionType
    type () const
    {
      return type_;
    }

    std::string
    name () const
    {
      return name_;
    }

    std::string
    value_synopsis () const
    {
      return value_synopsis_;
    }

    std::string
    description () const
    {
      return description_;
    }


  private:
    bool optional_;
    OptionType type_;
    std::string name_;
    std::string value_synopsis_;
    std::string description_;
  };


  class Description
  {
  public:
    Description (std::string command)
        : command_ (command)
    {
    }

  private:
    Description (Description const&);

    Description&
    operator= (Description const&);

  private:
    // We are storing pointer to elements in this list in the map below.
    // To prevent element moving we will use list instead of vector.
    //
    typedef
    std::list<OptionDescription>
    OptionDescriptionList;

    typedef
    std::map<std::string, OptionDescription*>
    OptionDescriptionMap;

  public:

    std::string
    command () const
    {
      return command_;
    }


  public:
    typedef
    OptionDescriptionList::const_iterator
    OptionIterator;

    OptionIterator
    begin_option () const
    {
      return options_.begin ();
    }

    OptionIterator
    end_option () const
    {
      return options_.end ();
    }

    typedef
    OptionDescriptionMap::const_iterator
    OptionMapIterator;

    OptionDescription const*
    find_option (std::string const& option) const
    {
      OptionDescriptionMap::const_iterator i  (
        option_map_.find (option));

      return i == option_map_.end () ? 0 : i->second;
    }

    void
    add_option (OptionDescription const& od)
    {
      options_.push_back (od);
      option_map_[od.name ()] = &options_.back ();
    }

  private:
    typedef
    std::vector<std::string>
    ArgumentDescriptionList;

  public:
    typedef
    ArgumentDescriptionList::const_iterator
    ArgumentIterator;

    ArgumentIterator
    begin_argument () const
    {
      return arguments_.begin ();
    }

    ArgumentIterator
    end_argument () const
    {
      return arguments_.end ();
    }

    void
    add_argument (std::string arg)
    {
      arguments_.push_back (arg);
    }

  private:
    std::string command_;
    OptionDescriptionList options_;
    OptionDescriptionMap option_map_;
    ArgumentDescriptionList arguments_;
  };

  inline void
  print_text (std::ostream& os, Description const& d)
  {
    using std::endl;

    os << d.command ();

    Description::OptionIterator ob = d.begin_option ();
    Description::OptionIterator oe = d.end_option ();

    if (ob != oe)
    {
      os << " { OPTIONS }";
    }

    Description::ArgumentIterator ab = d.begin_argument ();
    Description::ArgumentIterator ae = d.end_argument ();

    for (; ab != ae; ab++)
    {
      os << " <" << *ab << ">";
    }

    os << endl << endl;

    for (; ob != oe; ob++)
    {
      bool flag (ob->type () == OptionType::flag);
      bool optional (ob->optional ());
      std::string prefix (ob->name ().length () == 1 ? "-" : "--");

      os << (optional ? "[" : "") << prefix << ob->name ()
         << (flag ? "" : " ") << ob->value_synopsis ()
         << (optional ? "]" : "")
         << endl;

      os << "\t\t" << ob->description () << endl << endl;
    }

  }


  inline void
  print_html (std::ostream& os, Description const& d)
  {
    using std::endl;

    os << "<html>" << endl
       << "<body>" << endl
       << "<div align=\"center\">" << endl
       << "<table width=\"700\" border=\"0\" cellspacing=\"0\" "
       << "cellpadding=\"0\">" << endl
       << "<tr>" << endl
       << "<td>" << endl;

    os << "<p>" << endl
       << "<code>" << endl;

    os << d.command ();

    Description::OptionIterator ob = d.begin_option ();
    Description::OptionIterator oe = d.end_option ();

    if (ob != oe)
    {
      os << " { OPTIONS }";
    }

    Description::ArgumentIterator ab = d.begin_argument ();
    Description::ArgumentIterator ae = d.end_argument ();

    for (; ab != ae; ab++)
    {
      os << " &lt;" << *ab << "&gt;";
    }

    os << endl
       << "</code>" << endl
       << "</p>" << endl;


    os << "<dl>" << endl;

    for (; ob != oe; ob++)
    {
      bool flag (ob->type () == OptionType::flag);
      bool optional (ob->optional ());
      std::string prefix (ob->name ().length () == 1 ? "-" : "--");

      os << "<dt>" << endl
         << "<code>" << endl
         << (optional ? "[" : "") << prefix << ob->name ()
         << (flag ? "" : " ") << ob->value_synopsis ()
         << (optional ? "]" : "") << endl
         << "</code>" << endl
         << "</dt>" << endl;

      os << "<dd>" << endl
         << "<p>" << endl
         << ob->description () << endl
         << "</p>" << endl
         << "</dd>" << endl;
    }

    os << "</dl>" << endl;

    os << "</td>" << endl
       << "</tr>" << endl
       << "</table>" << endl
       << "</div>" << endl
       << "</body>" << endl
       << "</html>" << endl;

  }
}


#endif  // COMMAND_LINE_DESCRIPTOR_H