summaryrefslogtreecommitdiff
path: root/cli/cli/runtime-header.cxx
blob: c6e06dc33455361925b73a541ad6899b8f232006 (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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
// file      : cli/runtime-header.cxx
// author    : Boris Kolpackov <boris@codesynthesis.com>
// license   : MIT; see accompanying LICENSE file

#include <cli/runtime-header.hxx>

using namespace std;

void
generate_runtime_header (context& ctx)
{
  ostream& os (ctx.os);

  if (ctx.options.generate_file_scanner ())
    os << "#include <list>" << endl
       << "#include <deque>" << endl;

  if (ctx.options.generate_description ())
    os << "#include <map>" << endl;

  if (ctx.options.generate_description ()  ||
      ctx.options.generate_vector_scanner ())
    os << "#include <vector>" << endl;

  os << "#include <iosfwd>" << endl
     << "#include <string>" << endl
     << "#include <cstddef>" << endl
     << "#include <exception>" << endl
     << endl;

  // VC++ and xlC don't like the (void)x expression if x is a reference
  // to an incomplete type. On the other hand, GCC warns that (void*)&x
  // doesn't have any effect.
  //
  os << "#ifndef CLI_POTENTIALLY_UNUSED" << endl
     << "#  if defined(_MSC_VER) || defined(__xlC__)" << endl
     << "#    define CLI_POTENTIALLY_UNUSED(x) (void*)&x" << endl
     << "#  else" << endl
     << "#    define CLI_POTENTIALLY_UNUSED(x) (void)x" << endl
     << "#  endif" << endl
     << "#endif" << endl
     << endl;

  ctx.ns_open (ctx.cli);

  string const& exp (ctx.exp);
  string const& exp_inl (ctx.exp_inl);

  // usage_para
  //
  if (!ctx.options.suppress_usage ())
    os << "class " << exp_inl << "usage_para"
       << "{"
       << "public:" << endl
       << "enum value"
       << "{"
       << "none," << endl
       << "text," << endl
       << "option" << endl
       << "};"
       << "usage_para (value);"
       << endl
       << "operator value () const {return v_;}" // Can't generate outside.
       << "private:" << endl
       << "value v_;"
       << "};";

  // unknown_mode
  //
  os << "class " << exp_inl << "unknown_mode"
     << "{"
     << "public:" << endl
     << "enum value"
     << "{"
     << "skip," << endl
     << "stop," << endl
     << "fail" << endl
     << "};"
     << "unknown_mode (value);"
     << endl
     << "operator value () const {return v_;}" // Can't generate outside.
     << "private:" << endl
     << "value v_;"
     << "};";

  // Exceptions.
  //

  string const& os_type (ctx.options.ostream_type ());

  os << "// Exceptions." << endl
     << "//" << endl
     << endl;

  os << "class " << exp << "exception: public std::exception"
     << "{"
     << "public:" << endl
     << "virtual void" << endl
     << "print (" << os_type << "&) const = 0;"
     << "};";

  os << exp_inl << os_type << "&" << endl
     << "operator<< (" << os_type << "&, const exception&);"
     << endl;

  os << "class " << exp << "unknown_option: public exception"
     << "{"
     << "public:" << endl
     << "virtual" << endl
     << "~unknown_option () throw ();"
     << endl
     << "unknown_option (const std::string& option);"
     << endl
     << "const std::string&" << endl
     << "option () const;"
     << endl
     << "virtual void" << endl
     << "print (" << os_type << "&) const;"
     << endl
     << "virtual const char*" << endl
     << "what () const throw ();"
     << endl
     << "private:" << endl
     << "std::string option_;"
     << "};";

  os << "class " << exp << "unknown_argument: public exception"
     << "{"
     << "public:" << endl
     << "virtual" << endl
     << "~unknown_argument () throw ();"
     << endl
     << "unknown_argument (const std::string& argument);"
     << endl
     << "const std::string&" << endl
     << "argument () const;"
     << endl
     << "virtual void" << endl
     << "print (" << os_type << "&) const;"
     << endl
     << "virtual const char*" << endl
     << "what () const throw ();"
     << endl
     << "private:" << endl
     << "std::string argument_;"
     << "};";

  os << "class " << exp << "missing_value: public exception"
     << "{"
     << "public:" << endl
     << "virtual" << endl
     << "~missing_value () throw ();"
     << endl
     << "missing_value (const std::string& option);"
     << endl
     << "const std::string&" << endl
     << "option () const;"
     << endl
     << "virtual void" << endl
     << "print (" << os_type << "&) const;"
     << endl
     << "virtual const char*" << endl
     << "what () const throw ();"
     << endl
     << "private:" << endl
     << "std::string option_;"
     << "};";

  os << "class " << exp << "invalid_value: public exception"
     << "{"
     << "public:" << endl
     << "virtual" << endl
     << "~invalid_value () throw ();"
     << endl
     << "invalid_value (const std::string& option," << endl
     << "const std::string& value," << endl
     << "const std::string& message = std::string ());"
     << endl
     << "const std::string&" << endl
     << "option () const;"
     << endl
     << "const std::string&" << endl
     << "value () const;"
     << endl
     << "const std::string&" << endl
     << "message () const;"
     << endl
     << "virtual void" << endl
     << "print (" << os_type << "&) const;"
     << endl
     << "virtual const char*" << endl
     << "what () const throw ();"
     << endl
     << "private:" << endl
     << "std::string option_;"
     << "std::string value_;"
     << "std::string message_;"
     << "};";

  os << "class " << exp << "eos_reached: public exception"
     << "{"
     << "public:" << endl
     << "virtual void" << endl
     << "print (" << os_type << "&) const;"
     << endl
     << "virtual const char*" << endl
     << "what () const throw ();"
     << "};";

  if (ctx.options.generate_file_scanner ())
  {
    os << "class " << exp << "file_io_failure: public exception"
       << "{"
       << "public:" << endl
       << "virtual" << endl
       << "~file_io_failure () throw ();"
       << endl
       << "file_io_failure (const std::string& file);"
       << endl
       << "const std::string&" << endl
       << "file () const;"
       << endl
       << "virtual void" << endl
       << "print (" << os_type << "&) const;"
       << endl
       << "virtual const char*" << endl
       << "what () const throw ();"
       << endl
       << "private:" << endl
       << "std::string file_;"
       << "};";

    os << "class " << exp << "unmatched_quote: public exception"
       << "{"
       << "public:" << endl
       << "virtual" << endl
       << "~unmatched_quote () throw ();"
       << endl
       << "unmatched_quote (const std::string& argument);"
       << endl
       << "const std::string&" << endl
       << "argument () const;"
       << endl
       << "virtual void" << endl
       << "print (" << os_type << "&) const;"
       << endl
       << "virtual const char*" << endl
       << "what () const throw ();"
       << endl
       << "private:" << endl
       << "std::string argument_;"
       << "};";
  }

  if (ctx.options.generate_group_scanner ())
  {
    os << "class " << exp << "unexpected_group: public exception"
       << "{"
       << "public:" << endl
       << "virtual" << endl
       << "~unexpected_group () throw ();"
       << endl
       << "unexpected_group (const std::string& argument," << endl
       <<                   "const std::string& group);"
       << endl
       << "const std::string&" << endl
       << "argument () const;"
       << endl
       << "const std::string&" << endl
       << "group () const;"
       << endl
       << "virtual void" << endl
       << "print (std::ostream&) const;"
       << endl
       << "virtual const char*" << endl
       << "what () const throw ();"
       << endl
       << "private:" << endl
       << "std::string argument_;"
       << "std::string group_;"
       << "};";

    os << "class " << exp << "group_separator: public exception" << endl
       << "{"
       << "public:" << endl
       << "virtual" << endl
       << "~group_separator () throw ();"
       << endl
       << "// Note: either (but not both) can be empty." << endl
       << "//" << endl
       << "group_separator (const std::string& encountered," << endl
       <<                  "const std::string& expected);"
       << endl
       << "const std::string&" << endl
       << "encountered () const;"
       << endl
       << "const std::string&" << endl
       << "expected () const;"
       << endl
       << "virtual void" << endl
       << "print (std::ostream&) const;"
       << endl
       << "virtual const char*" << endl
       << "what () const throw ();"
       << endl
       << "private:" << endl
       << "std::string encountered_;"
       << "std::string expected_;"
       << "};";
  }

  // scanner
  //
  os << "// Command line argument scanner interface."                   << endl
     << "//"                                                            << endl
     << "// The values returned by next() are guaranteed to be valid"   << endl
     << "// for the two previous arguments up until a call to a third"  << endl
     << "// peek() or next()."                                          << endl
     << "//"                                                            << endl
     << "// The position() function returns a monotonically-increasing" << endl
     << "// number which, if stored, can later be used to determine the"<< endl
     << "// relative position of the argument returned by the following"<< endl
     << "// call to next(). Note that if multiple scanners are used to" << endl
     << "// extract arguments from multiple sources, then the end"      << endl
     << "// position of the previous scanner should be used as the"     << endl
     << "// start position of the next."                                << endl
     << "//"                                                            << endl
     << "class " << exp << "scanner"
     << "{"
     << "public:" << endl
     << "virtual" << endl
     << "~scanner ();"
     << endl
     << "virtual bool" << endl
     << "more () = 0;"
     << endl
     << "virtual const char*" << endl
     << "peek () = 0;"
     << endl
     << "virtual const char*" << endl
     << "next () = 0;"
     << endl
     << "virtual void" << endl
     << "skip () = 0;"
     << endl
     << "virtual std::size_t" << endl
     << "position () = 0;"
     << "};";

  // argv_scanner
  //
  os << "class " << exp << "argv_scanner: public scanner"
     << "{"
     << "public:" << endl
     << "argv_scanner (int& argc," << endl
     << "char** argv," << endl
     << "bool erase = false," << endl
     << "std::size_t start_position = 0);"
     << endl
     << "argv_scanner (int start," << endl
     << "int& argc," << endl
     << "char** argv," << endl
     << "bool erase = false," << endl
     << "std::size_t start_position = 0);"
     << endl
     << "int" << endl
     << "end () const;"
     << endl
     << "virtual bool" << endl
     << "more ();"
     << endl
     << "virtual const char*" << endl
     << "peek ();"
     << endl
     << "virtual const char*" << endl
     << "next ();"
     << endl
     << "virtual void" << endl
     << "skip ();"
     << endl
     << "virtual std::size_t" << endl
     << "position ();"
     << endl
     << "protected:" << endl
     << "std::size_t start_position_;"
     << "int i_;"
     << "int& argc_;"
     << "char** argv_;"
     << "bool erase_;"
     << "};";

  // vector_scanner
  //
  if (ctx.options.generate_vector_scanner ())
  {
    os << "class " << exp << "vector_scanner: public scanner"
       << "{"
       << "public:" << endl
       << "vector_scanner (const std::vector<std::string>&," << endl
       << "std::size_t start = 0," << endl
       << "std::size_t start_position = 0);"
       << endl
       << "std::size_t" << endl
       << "end () const;"
       << endl
       << "void" << endl
       << "reset (std::size_t start = 0, std::size_t start_position = 0);"
       << endl
       << "virtual bool" << endl
       << "more ();"
       << endl
       << "virtual const char*" << endl
       << "peek ();"
       << endl
       << "virtual const char*" << endl
       << "next ();"
       << endl
       << "virtual void" << endl
       << "skip ();"
       << endl
       << "virtual std::size_t" << endl
       << "position ();"
       << endl
       << "private:" << endl
       << "std::size_t start_position_;"
       << "const std::vector<std::string>& v_;"
       << "std::size_t i_;"
       << "};";
  }

  // argv_file_scanner
  //
  if (ctx.options.generate_file_scanner ())
  {
    os << "class " << exp << "argv_file_scanner: public argv_scanner"
       << "{"
       << "public:" << endl
       << "argv_file_scanner (int& argc," << endl
       << "char** argv," << endl
       << "const std::string& option," << endl
       << "bool erase = false," << endl
       << "std::size_t start_position = 0);"
       << endl
       << "argv_file_scanner (int start," << endl
       << "int& argc," << endl
       << "char** argv," << endl
       << "const std::string& option," << endl
       << "bool erase = false," << endl
       << "std::size_t start_position = 0);"
       << endl
       << "argv_file_scanner (const std::string& file," << endl
       << "const std::string& option," << endl
       << "std::size_t start_position = 0);"
       << endl
       << "struct option_info"
       << "{"
       << "// If search_func is not NULL, it is called, with the arg" << endl
       << "// value as the second argument, to locate the options file." << endl
       << "// If it returns an empty string, then the file is ignored." << endl
       << "//" << endl
       << "const char* option;"
       << "std::string (*search_func) (const char*, void* arg);"
       << "void* arg;"
       << "};"
       << "argv_file_scanner (int& argc," << endl
       << "char** argv," << endl
       << "const option_info* options," << endl
       << "std::size_t options_count," << endl
       << "bool erase = false," << endl
       << "std::size_t start_position = 0);"
       << endl
       << "argv_file_scanner (int start," << endl
       << "int& argc," << endl
       << "char** argv," << endl
       << "const option_info* options," << endl
       << "std::size_t options_count," << endl
       << "bool erase = false," << endl
       << "std::size_t start_position = 0);"
       << endl
       << "argv_file_scanner (const std::string& file," << endl
       << "const option_info* options = 0," << endl
       << "std::size_t options_count = 0," << endl
       << "std::size_t start_position = 0);"
       << endl
       << "virtual bool" << endl
       << "more ();"
       << endl
       << "virtual const char*" << endl
       << "peek ();"
       << endl
       << "virtual const char*" << endl
       << "next ();"
       << endl
       << "virtual void" << endl
       << "skip ();"
       << endl
       << "virtual std::size_t" << endl
       << "position ();"
       << endl
       << "// Return the file path if the peeked at argument came from a file and" << endl
       << "// the empty string otherwise. The reference is guaranteed to be valid" << endl
       << "// till the end of the scanner lifetime." << endl
       << "//" << endl
       << "const std::string&" << endl
       << "peek_file ();"
       << endl
       << "// Return the 1-based line number if the peeked at argument came from" << endl
       << "// a file and zero otherwise." << endl
       << "//" << endl
       << "std::size_t" << endl
       << "peek_line ();"
       << endl
       << "private:" << endl
       << "const option_info*" << endl
       << "find (const char*) const;"
       << endl
       << "void" << endl
       << "load (const std::string& file);"
       << endl
       << "typedef argv_scanner base;"
       << endl
       << "const std::string option_;"
       << "option_info option_info_;"
       << "const option_info* options_;"
       << "std::size_t options_count_;"
       << endl
       << "struct arg"
       << "{"
       << "std::string value;"
       << "const std::string* file;"
       << "std::size_t line;"
       << "};"
       << "std::deque<arg> args_;"
       << "std::list<std::string> files_;"
       << endl
       << "// Circular buffer of two arguments." << endl
       << "//" << endl
       << "std::string hold_[2];"
       << "std::size_t i_;";

    if (!ctx.opt_sep.empty ())
      os << endl
         << "bool skip_;";

    os << endl
       << "static int zero_argc_;"
       << "static std::string empty_string_;"
       << "};";
  }

  // group_scanner
  //
  if (ctx.options.generate_group_scanner ())
  {
    os << "class " << exp << "group_scanner: public scanner"
       << "{"
       << "public:" << endl
       << "group_scanner (scanner&);"
       << endl
       << "virtual bool" << endl
       << "more ();"
       << endl
       << "virtual const char*" << endl
       << "peek ();"
       << endl
       << "virtual const char*" << endl
       << "next ();"
       << endl
       << "virtual void" << endl
       << "skip ();"
       << endl
       << "virtual std::size_t" << endl
       << "position ();"
       << endl
       << "// The group is only available after the call to next()"     << endl
       << "// (and skip() -- in case one needs to make sure the group"  << endl
       << "// was empty, or some such) and is only valid (and must be"  << endl
       << "// handled) until the next call to any of the scanner"       << endl
       << "// functions (including more())."                            << endl
       << "//"                                                          << endl
       << "// Note also that argument positions within each group start"<< endl
       << "// from 0."                                                  << endl
       << "//"                                                          << endl
       << "scanner&" << endl
       << "group ();"
       << endl
       << "// Escape an argument that is a group separator. Return the" << endl
       << "// passed string if no escaping is required."                << endl
       << "//" << endl
       << "static const char*" << endl
       << "escape (const char*);"
       << endl
       << "private:" << endl
       << "enum state"
       << "{"
       << "peeked,  // Argument peeked at with peek()."       << endl
       << "scanned, // Argument scanned with next()."         << endl
       << "skipped, // Argument skipped with skip()/initial." << endl
       << "};"
       << "enum separator"
       << "{"
       << "none,"            << endl
       << "open,      // {"  << endl
       << "close,     // }"  << endl
       << "open_plus, // +{" << endl
       << "close_plus // }+" << endl
       << "};"
       << "static separator" << endl
       << "sense (const char*);"
       << endl

       << "// Scan the leading groups, the next argument/argument pack,"<< endl
       << "// and the trailing groups."                                 << endl
       << "//"                                                          << endl
       << "void" << endl
       << "scan_group ();"
       << endl
       << "scanner& scan_;"
       << "state state_;"
       << endl
       << "// Circular buffer of two arguments." << endl
       << "//" << endl
       << "std::vector<std::string> arg_[2];"
       << "std::size_t i_, j_, pos_;"
       << endl
       << "std::vector<std::string> group_;"
       << "vector_scanner group_scan_;"
       << "};";
  }

  // Option description.
  //
  if (ctx.options.generate_description ())
  {
    os << "typedef std::vector<std::string> option_names;"
       << endl;

    os << "class " << exp_inl << "option"
       << "{"
       << "public:" << endl
       << endl
       << "const std::string&" << endl
       << "name () const;"
       << endl
       << "const option_names&" << endl
       << "aliases () const;"
       << endl
       << "bool" << endl
       << "flag () const;"
       << endl
       << "const std::string&" << endl
       << "default_value () const;"
       << endl
       << "public:"
       << "option ();"
       << "option (const std::string& name," << endl
       << "const option_names& aliases," << endl
       << "bool flag," << endl
       << "const std::string& default_value);"
       << endl
       << "private:" << endl
       << "std::string name_;"
       << "option_names aliases_;"
       << "bool flag_;"
       << "std::string default_value_;"
       << "};";

    os << "class " << exp << "options: public std::vector<option>"
       << "{"
       << "public:" << endl
       << "typedef std::vector<option> container_type;"
       << endl
       << "container_type::const_iterator" << endl
       << "find (const std::string& name) const;"
       << endl
       << "void" << endl
       << "push_back (const option&);"
       << "private:" << endl
       << "typedef std::map<std::string, container_type::size_type> map_type;"
       << "map_type map_;"
       << "};";
  }

  // Parser class template. Provide a forward declaration to allow
  // custom specializations.
  //
  os << "template <typename X>" << endl
     << "struct parser;"
     << endl;

  ctx.ns_close (ctx.cli);
}