]> git.saurik.com Git - bison.git/blob - src/getargs.c
carets: activate by default
[bison.git] / src / getargs.c
1 /* Parse command line arguments for Bison.
2
3 Copyright (C) 1984, 1986, 1989, 1992, 2000-2012 Free Software
4 Foundation, Inc.
5
6 This file is part of Bison, the GNU Compiler Compiler.
7
8 This program is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20
21 #include <config.h>
22 #include "system.h"
23 #include "output.h"
24
25 #include <argmatch.h>
26 #include <c-strcase.h>
27 #include <configmake.h>
28 #include <error.h>
29 #include <getopt.h>
30 #include <progname.h>
31
32 #include "complain.h"
33 #include "files.h"
34 #include "getargs.h"
35 #include "muscle-tab.h"
36 #include "quote.h"
37 #include "uniqstr.h"
38
39 bool defines_flag;
40 bool graph_flag;
41 bool xml_flag;
42 bool no_lines_flag;
43 bool token_table_flag;
44 bool yacc_flag; /* for -y */
45
46 bool nondeterministic_parser = false;
47 bool glr_parser = false;
48
49 int feature_flag = feature_caret;
50 int report_flag = report_none;
51 int trace_flag = trace_none;
52
53 static struct bison_language const valid_languages[] = {
54 { "c", "c-skel.m4", ".c", ".h", true },
55 { "c++", "c++-skel.m4", ".cc", ".hh", true },
56 { "java", "java-skel.m4", ".java", ".java", false },
57 { "", "", "", "", false }
58 };
59
60 int skeleton_prio = default_prio;
61 const char *skeleton = NULL;
62 int language_prio = default_prio;
63 struct bison_language const *language = &valid_languages[0];
64 const char *include = NULL;
65
66 /** Decode an option's key.
67 *
68 * \param option option being decoded.
69 * \param keys array of valid subarguments.
70 * \param values array of corresponding (int) values.
71 * \param all the all value.
72 * \param flags the flags to update
73 * \param arg the subarguments to decode.
74 * If null, then activate all the flags.
75 * \param no length of the potential "no-" prefix.
76 * Can be 0 or 3. If 3, negate the action of the subargument.
77 * \param err length of a potential "error=".
78 * Can be 0 or 6. If 6, treat the subargument as a CATEGORY
79 *
80 * If VALUE != 0 then KEY sets flags and no-KEY clears them.
81 * If VALUE == 0 then KEY clears all flags from \c all and no-KEY sets all
82 * flags from \c all. Thus no-none = all and no-all = none.
83 */
84 static void
85 flag_argmatch (const char *option,
86 const char * const keys[], const int values[],
87 int all, int *flags, char *arg, size_t no, size_t err)
88 {
89 int value = 0;
90 if (!err || arg[no + err++] != '\0')
91 value = XARGMATCH (option, arg + no + err, keys, values);
92
93 if (value)
94 {
95 if (no)
96 *flags &= ~value;
97 else
98 {
99 if (err)
100 warnings_flag |= value;
101 *flags |= value;
102 }
103 }
104 else
105 {
106 /* With a simpler 'if (no)' version, -Werror means -Werror=all
107 (or rather, -Werror=no-none, but that syntax is invalid).
108 The difference is:
109 - Werror activates all errors, but not the warnings
110 - Werror=all activates errors, and all warnings */
111 if (no ? !err : err)
112 *flags |= all;
113 else
114 *flags &= ~all;
115 }
116 }
117 /** Decode an option's set of keys.
118 *
119 * \param option option being decoded.
120 * \param keys array of valid subarguments.
121 * \param values array of corresponding (int) values.
122 * \param all the all value.
123 * \param flags the flags to update
124 * \param args comma separated list of effective subarguments to decode.
125 * If 0, then activate all the flags.
126 */
127 static void
128 flags_argmatch (const char *option,
129 const char * const keys[], const int values[],
130 int all, int *flags, char *args)
131 {
132 if (args)
133 for (args = strtok (args, ","); args; args = strtok (NULL, ","))
134 {
135 size_t no = STRPREFIX_LIT ("no-", args) ? 3 : 0;
136 size_t err = STRPREFIX_LIT ("error", args + no) ? 5 : 0;
137
138 flag_argmatch (option, keys,
139 values, all, err ? &errors_flag : flags,
140 args, no, err);
141 }
142 else
143 *flags |= all;
144 }
145
146 /** Decode a set of sub arguments.
147 *
148 * \param FlagName the flag familly to update.
149 * \param Args the effective sub arguments to decode.
150 * \param All the "all" value.
151 *
152 * \arg FlagName_args the list of keys.
153 * \arg FlagName_types the list of values.
154 * \arg FlagName_flag the flag to update.
155 */
156 #define FLAGS_ARGMATCH(FlagName, Args, All) \
157 flags_argmatch ("--" #FlagName, FlagName ## _args, FlagName ## _types, \
158 All, &FlagName ## _flag, Args)
159
160
161 /*----------------------.
162 | --report's handling. |
163 `----------------------*/
164
165 static const char * const report_args[] =
166 {
167 /* In a series of synonyms, present the most meaningful first, so
168 that argmatch_valid be more readable. */
169 "none",
170 "state", "states",
171 "itemset", "itemsets",
172 "lookahead", "lookaheads", "look-ahead",
173 "solved",
174 "all",
175 0
176 };
177
178 static const int report_types[] =
179 {
180 report_none,
181 report_states, report_states,
182 report_states | report_itemsets, report_states | report_itemsets,
183 report_states | report_lookahead_tokens,
184 report_states | report_lookahead_tokens,
185 report_states | report_lookahead_tokens,
186 report_states | report_solved_conflicts,
187 report_all
188 };
189
190 ARGMATCH_VERIFY (report_args, report_types);
191
192
193 /*---------------------.
194 | --trace's handling. |
195 `---------------------*/
196
197 static const char * const trace_args[] =
198 {
199 /* In a series of synonyms, present the most meaningful first, so
200 that argmatch_valid be more readable. */
201 "none - no traces",
202 "scan - grammar scanner traces",
203 "parse - grammar parser traces",
204 "automaton - construction of the automaton",
205 "bitsets - use of bitsets",
206 "grammar - reading, reducing the grammar",
207 "resource - memory consumption (where available)",
208 "sets - grammar sets: firsts, nullable etc.",
209 "muscles - m4 definitions passed to the skeleton",
210 "tools - m4 invocation",
211 "m4 - m4 traces",
212 "skeleton - skeleton postprocessing",
213 "time - time consumption",
214 "ielr - IELR conversion",
215 "all - all of the above",
216 0
217 };
218
219 static const int trace_types[] =
220 {
221 trace_none,
222 trace_scan,
223 trace_parse,
224 trace_automaton,
225 trace_bitsets,
226 trace_grammar,
227 trace_resource,
228 trace_sets,
229 trace_muscles,
230 trace_tools,
231 trace_m4,
232 trace_skeleton,
233 trace_time,
234 trace_ielr,
235 trace_all
236 };
237
238 ARGMATCH_VERIFY (trace_args, trace_types);
239
240
241 /*------------------------.
242 | --warnings's handling. |
243 `------------------------*/
244
245 static const char * const warnings_args[] =
246 {
247 /* In a series of synonyms, present the most meaningful first, so
248 that argmatch_valid be more readable. */
249 "none - no warnings",
250 "midrule-values - unset or unused midrule values",
251 "yacc - incompatibilities with POSIX Yacc",
252 "conflicts-sr - S/R conflicts",
253 "conflicts-rr - R/R conflicts",
254 "deprecated - obsolete constructs",
255 "other - all other warnings",
256 "all - all of the above",
257 "error - warnings are errors",
258 0
259 };
260
261 static const int warnings_types[] =
262 {
263 Wnone,
264 Wmidrule_values,
265 Wyacc,
266 Wconflicts_sr,
267 Wconflicts_rr,
268 Wdeprecated,
269 Wother,
270 Wall,
271 Werror
272 };
273
274 ARGMATCH_VERIFY (warnings_args, warnings_types);
275
276 /*-----------------------.
277 | --feature's handling. |
278 `-----------------------*/
279
280 static const char * const feature_args[] =
281 {
282 "none",
283 "caret", "diagnostics-show-caret",
284 "all",
285 0
286 };
287
288 static const int feature_types[] =
289 {
290 feature_none,
291 feature_caret, feature_caret,
292 feature_all
293 };
294
295 ARGMATCH_VERIFY (feature_args, feature_types);
296
297 /*-------------------------------------------.
298 | Display the help message and exit STATUS. |
299 `-------------------------------------------*/
300
301 static void usage (int) ATTRIBUTE_NORETURN;
302
303 static void
304 usage (int status)
305 {
306 if (status != 0)
307 fprintf (stderr, _("Try `%s --help' for more information.\n"),
308 program_name);
309 else
310 {
311 /* For ../build-aux/cross-options.pl to work, use the format:
312 ^ -S, --long[=ARGS] (whitespace)
313 A --long option is required.
314 Otherwise, add exceptions to ../build-aux/cross-options.pl. */
315
316 printf (_("Usage: %s [OPTION]... FILE\n"), program_name);
317 fputs (_("\
318 Generate a deterministic LR or generalized LR (GLR) parser employing\n\
319 LALR(1), IELR(1), or canonical LR(1) parser tables. IELR(1) and\n\
320 canonical LR(1) support is experimental.\n\
321 \n\
322 "), stdout);
323
324 fputs (_("\
325 Mandatory arguments to long options are mandatory for short options too.\n\
326 "), stdout);
327 fputs (_("\
328 The same is true for optional arguments.\n\
329 "), stdout);
330
331 fputs (_("\
332 \n\
333 Operation modes:\n\
334 -h, --help display this help and exit\n\
335 -V, --version output version information and exit\n\
336 --print-localedir output directory containing locale-dependent data\n\
337 --print-datadir output directory containing skeletons and XSLT\n\
338 -y, --yacc emulate POSIX Yacc\n\
339 -W, --warnings[=CATEGORY] report the warnings falling in CATEGORY\n\
340 -f, --feature[=FEATURE] activate miscellaneous features\n\
341 \n\
342 "), stdout);
343
344 fputs (_("\
345 Parser:\n\
346 -L, --language=LANGUAGE specify the output programming language\n\
347 -S, --skeleton=FILE specify the skeleton to use\n\
348 -t, --debug instrument the parser for tracing\n\
349 same as `-Dparse.trace'\n\
350 --locations enable location support\n\
351 -D, --define=NAME[=VALUE] similar to '%define NAME \"VALUE\"'\n\
352 -F, --force-define=NAME[=VALUE] override '%define NAME \"VALUE\"'\n\
353 -p, --name-prefix=PREFIX prepend PREFIX to the external symbols\n\
354 deprecated by '-Dapi.prefix=PREFIX'\n\
355 -l, --no-lines don't generate '#line' directives\n\
356 -k, --token-table include a table of token names\n\
357 "), stdout);
358 putc ('\n', stdout);
359
360 /* Keep -d and --defines separate so that ../build-aux/cross-options.pl
361 * won't assume that -d also takes an argument. */
362 fputs (_("\
363 Output:\n\
364 --defines[=FILE] also produce a header file\n\
365 -d likewise but cannot specify FILE (for POSIX Yacc)\n\
366 -r, --report=THINGS also produce details on the automaton\n\
367 --report-file=FILE write report to FILE\n\
368 -v, --verbose same as `--report=state'\n\
369 -b, --file-prefix=PREFIX specify a PREFIX for output files\n\
370 -o, --output=FILE leave output to FILE\n\
371 -g, --graph[=FILE] also output a graph of the automaton\n\
372 -x, --xml[=FILE] also output an XML report of the automaton\n\
373 (the XML schema is experimental)\n\
374 "), stdout);
375 putc ('\n', stdout);
376
377 fputs (_("\
378 Warning categories include:\n\
379 `midrule-values' unset or unused midrule values\n\
380 `yacc' incompatibilities with POSIX Yacc\n\
381 `conflicts-sr' S/R conflicts (enabled by default)\n\
382 `conflicts-rr' R/R conflicts (enabled by default)\n\
383 `deprecated' obsolete constructs\n\
384 `other' all other warnings (enabled by default)\n\
385 `all' all the warnings\n\
386 `no-CATEGORY' turn off warnings in CATEGORY\n\
387 `none' turn off all the warnings\n\
388 `error[=CATEGORY]' treat warnings as errors\n\
389 "), stdout);
390 putc ('\n', stdout);
391
392 fputs (_("\
393 THINGS is a list of comma separated words that can include:\n\
394 `state' describe the states\n\
395 `itemset' complete the core item sets with their closure\n\
396 `lookahead' explicitly associate lookahead tokens to items\n\
397 `solved' describe shift/reduce conflicts solving\n\
398 `all' include all the above information\n\
399 `none' disable the report\n\
400 "), stdout);
401 putc ('\n', stdout);
402
403 fputs (_("\
404 FEATURE is a list of comma separated words that can include:\n\
405 `caret' show errors with carets\n\
406 `all' all of the above\n\
407 `none' disable all of the above\n\
408 "), stdout);
409
410 putc ('\n', stdout);
411 printf (_("Report bugs to <%s>.\n"), PACKAGE_BUGREPORT);
412 printf (_("%s home page: <%s>.\n"), PACKAGE_NAME, PACKAGE_URL);
413 fputs (_("General help using GNU software: "
414 "<http://www.gnu.org/gethelp/>.\n"),
415 stdout);
416 /* Don't output this redundant message for English locales.
417 Note we still output for 'C' so that it gets included in the
418 man page. */
419 const char *lc_messages = setlocale (LC_MESSAGES, NULL);
420 if (lc_messages && !STREQ (lc_messages, "en_"))
421 /* TRANSLATORS: Replace LANG_CODE in this URL with your language
422 code <http://translationproject.org/team/LANG_CODE.html> to
423 form one of the URLs at http://translationproject.org/team/.
424 Otherwise, replace the entire URL with your translation team's
425 email address. */
426 fputs (_("Report translation bugs to "
427 "<http://translationproject.org/team/>.\n"), stdout);
428 fputs (_("For complete documentation, run: info bison.\n"), stdout);
429 }
430
431 exit (status);
432 }
433
434
435 /*------------------------------.
436 | Display the version message. |
437 `------------------------------*/
438
439 static void
440 version (void)
441 {
442 /* Some efforts were made to ease the translators' task, please
443 continue. */
444 printf (_("bison (GNU Bison) %s"), VERSION);
445 putc ('\n', stdout);
446 fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
447 putc ('\n', stdout);
448
449 fprintf (stdout,
450 _("Copyright (C) %d Free Software Foundation, Inc.\n"),
451 PACKAGE_COPYRIGHT_YEAR);
452
453 fputs (_("\
454 This is free software; see the source for copying conditions. There is NO\n\
455 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
456 "),
457 stdout);
458 }
459
460
461 /*-------------------------------------.
462 | --skeleton and --language handling. |
463 `--------------------------------------*/
464
465 void
466 skeleton_arg (char const *arg, int prio, location loc)
467 {
468 if (prio < skeleton_prio)
469 {
470 skeleton_prio = prio;
471 skeleton = arg;
472 }
473 else if (prio == skeleton_prio)
474 complain (&loc, complaint,
475 _("multiple skeleton declarations are invalid"));
476 }
477
478 void
479 language_argmatch (char const *arg, int prio, location loc)
480 {
481 char const *msg;
482
483 if (prio < language_prio)
484 {
485 int i;
486 for (i = 0; valid_languages[i].language[0]; i++)
487 if (c_strcasecmp (arg, valid_languages[i].language) == 0)
488 {
489 language_prio = prio;
490 language = &valid_languages[i];
491 return;
492 }
493 msg = _("%s: invalid language");
494 }
495 else if (language_prio == prio)
496 msg = _("multiple language declarations are invalid");
497 else
498 return;
499
500 complain (&loc, complaint, msg, quotearg_colon (arg));
501 }
502
503 /*----------------------.
504 | Process the options. |
505 `----------------------*/
506
507 /* Shorts options.
508 Should be computed from long_options. */
509 static char const short_options[] =
510 "D:"
511 "F:"
512 "L:"
513 "S:"
514 "T::"
515 "V"
516 "W::"
517 "b:"
518 "d"
519 "f::"
520 "e"
521 "g::"
522 "h"
523 "k"
524 "l"
525 "n"
526 "o:"
527 "p:"
528 "r:"
529 "t"
530 "v"
531 "x::"
532 "y"
533 ;
534
535 /* Values for long options that do not have single-letter equivalents. */
536 enum
537 {
538 LOCATIONS_OPTION = CHAR_MAX + 1,
539 PRINT_LOCALEDIR_OPTION,
540 PRINT_DATADIR_OPTION,
541 REPORT_FILE_OPTION
542 };
543
544 static struct option const long_options[] =
545 {
546 /* Operation modes. */
547 { "help", no_argument, 0, 'h' },
548 { "version", no_argument, 0, 'V' },
549 { "print-localedir", no_argument, 0, PRINT_LOCALEDIR_OPTION },
550 { "print-datadir", no_argument, 0, PRINT_DATADIR_OPTION },
551 { "warnings", optional_argument, 0, 'W' },
552
553 /* Parser. */
554 { "name-prefix", required_argument, 0, 'p' },
555 { "include", required_argument, 0, 'I' },
556
557 /* Output. */
558 { "file-prefix", required_argument, 0, 'b' },
559 { "output", required_argument, 0, 'o' },
560 { "output-file", required_argument, 0, 'o' },
561 { "graph", optional_argument, 0, 'g' },
562 { "xml", optional_argument, 0, 'x' },
563 { "report", required_argument, 0, 'r' },
564 { "report-file", required_argument, 0, REPORT_FILE_OPTION },
565 { "verbose", no_argument, 0, 'v' },
566
567 /* Hidden. */
568 { "trace", optional_argument, 0, 'T' },
569
570 /* Output. */
571 { "defines", optional_argument, 0, 'd' },
572 { "feature", optional_argument, 0, 'f' },
573
574 /* Operation modes. */
575 { "fixed-output-files", no_argument, 0, 'y' },
576 { "yacc", no_argument, 0, 'y' },
577
578 /* Parser. */
579 { "debug", no_argument, 0, 't' },
580 { "define", required_argument, 0, 'D' },
581 { "force-define", required_argument, 0, 'F' },
582 { "locations", no_argument, 0, LOCATIONS_OPTION },
583 { "no-lines", no_argument, 0, 'l' },
584 { "raw", no_argument, 0, 0 },
585 { "skeleton", required_argument, 0, 'S' },
586 { "language", required_argument, 0, 'L' },
587 { "token-table", no_argument, 0, 'k' },
588
589 {0, 0, 0, 0}
590 };
591
592 /* Under DOS, there is no difference on the case. This can be
593 troublesome when looking for `.tab' etc. */
594 #ifdef MSDOS
595 # define AS_FILE_NAME(File) (strlwr (File), (File))
596 #else
597 # define AS_FILE_NAME(File) (File)
598 #endif
599
600 /* Build a location for the current command line argument. */
601 static
602 location
603 command_line_location (void)
604 {
605 location res;
606 /* "<command line>" is used in GCC's messages about -D. */
607 boundary_set (&res.start, uniqstr_new ("<command line>"), optind - 1, -1);
608 res.end = res.start;
609 return res;
610 }
611
612
613 void
614 getargs (int argc, char *argv[])
615 {
616 int c;
617
618 while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
619 != -1)
620 switch (c)
621 {
622 /* ASCII Sorting for short options (i.e., upper case then
623 lower case), and then long-only options. */
624
625 case 0:
626 /* Certain long options cause getopt_long to return 0. */
627 break;
628
629 case 'D': /* -DNAME[=VALUE]. */
630 case 'F': /* -FNAME[=VALUE]. */
631 {
632 char* name = optarg;
633 char* value = strchr (optarg, '=');
634 if (value)
635 *value++ = 0;
636 muscle_percent_define_insert (name, command_line_location (),
637 value ? value : "",
638 c == 'D' ? MUSCLE_PERCENT_DEFINE_D
639 : MUSCLE_PERCENT_DEFINE_F);
640 }
641 break;
642
643 case 'I':
644 include = AS_FILE_NAME (optarg);
645 break;
646
647 case 'L':
648 language_argmatch (optarg, command_line_prio,
649 command_line_location ());
650 break;
651
652 case 'S':
653 skeleton_arg (AS_FILE_NAME (optarg), command_line_prio,
654 command_line_location ());
655 break;
656
657 case 'T':
658 FLAGS_ARGMATCH (trace, optarg, trace_all);
659 break;
660
661 case 'V':
662 version ();
663 exit (EXIT_SUCCESS);
664
665 case 'f':
666 FLAGS_ARGMATCH (feature, optarg, feature_all);
667 break;
668
669 case 'W':
670 FLAGS_ARGMATCH (warnings, optarg, Wall);
671 break;
672
673 case 'b':
674 spec_file_prefix = AS_FILE_NAME (optarg);
675 break;
676
677 case 'd':
678 /* Here, the -d and --defines options are differentiated. */
679 defines_flag = true;
680 if (optarg)
681 {
682 free (spec_defines_file);
683 spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
684 }
685 break;
686
687 case 'g':
688 graph_flag = true;
689 if (optarg)
690 {
691 free (spec_graph_file);
692 spec_graph_file = xstrdup (AS_FILE_NAME (optarg));
693 }
694 break;
695
696 case 'h':
697 usage (EXIT_SUCCESS);
698
699 case 'k':
700 token_table_flag = true;
701 break;
702
703 case 'l':
704 no_lines_flag = true;
705 break;
706
707 case 'o':
708 spec_outfile = AS_FILE_NAME (optarg);
709 break;
710
711 case 'p':
712 spec_name_prefix = optarg;
713 break;
714
715 case 'r':
716 FLAGS_ARGMATCH (report, optarg, report_all);
717 break;
718
719 case 't':
720 muscle_percent_define_insert ("parse.trace",
721 command_line_location (), "",
722 MUSCLE_PERCENT_DEFINE_D);
723 break;
724
725 case 'v':
726 report_flag |= report_states;
727 break;
728
729 case 'x':
730 xml_flag = true;
731 if (optarg)
732 {
733 free (spec_xml_file);
734 spec_xml_file = xstrdup (AS_FILE_NAME (optarg));
735 }
736 break;
737
738 case 'y':
739 warnings_flag |= Wyacc;
740 errors_flag |= Wyacc;
741 yacc_flag = true;
742 break;
743
744 case LOCATIONS_OPTION:
745 muscle_percent_define_ensure ("locations",
746 command_line_location (), true);
747 break;
748
749 case PRINT_LOCALEDIR_OPTION:
750 printf ("%s\n", LOCALEDIR);
751 exit (EXIT_SUCCESS);
752
753 case PRINT_DATADIR_OPTION:
754 printf ("%s\n", pkgdatadir ());
755 exit (EXIT_SUCCESS);
756
757 case REPORT_FILE_OPTION:
758 free (spec_verbose_file);
759 spec_verbose_file = xstrdup (AS_FILE_NAME (optarg));
760 break;
761
762 default:
763 usage (EXIT_FAILURE);
764 }
765
766 if (argc - optind != 1)
767 {
768 if (argc - optind < 1)
769 error (0, 0, _("%s: missing operand"), quotearg_colon (argv[argc - 1]));
770 else
771 error (0, 0, _("extra operand %s"), quote (argv[optind + 1]));
772 usage (EXIT_FAILURE);
773 }
774
775 current_file = grammar_file = uniqstr_new (argv[optind]);
776 MUSCLE_INSERT_C_STRING ("file_name", grammar_file);
777 }
778
779 void
780 tr (char *s, char from, char to)
781 {
782 for (; *s; s++)
783 if (*s == from)
784 *s = to;
785 }