2 /* Copyright (C) 1989, 1990, 1991, 1992, 2001, 2002, 2004
3 Free Software Foundation, Inc.
4 Written by James Clark (jjc@jclark.com)
6 This file is part of groff.
8 groff is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
13 groff is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License along
19 with groff; see the file COPYING. If not, write to the Free Software
20 Foundation, 51 Franklin St - Fifth Floor, Boston, MA 02110-1301, USA. */
27 cset cs_field_name = csalpha;
37 input_item(string &, const char *, int = 1);
42 int get_location(const char **, int *);
44 friend class input_stack;
47 input_item::input_item(string &s, const char *fn, int ln)
48 : filename(strsave(fn)), first_lineno(ln)
51 ptr = buffer.contents();
52 end = ptr + buffer.length();
55 input_item::~input_item()
60 inline int input_item::peek_char()
65 return (unsigned char)*ptr;
68 inline int input_item::get_char()
73 return (unsigned char)*ptr++;
76 inline void input_item::skip_char()
81 int input_item::get_location(const char **filenamep, int *linenop)
83 *filenamep = filename;
84 if (ptr == buffer.contents())
85 *linenop = first_lineno;
87 int ln = first_lineno;
88 const char *e = ptr - 1;
89 for (const char *p = buffer.contents(); p < e; p++)
98 static input_item *top;
101 static int get_char();
102 static int peek_char();
103 static void skip_char() { top->skip_char(); }
104 static void push_file(const char *);
105 static void push_string(string &, const char *, int);
106 static void error(const char *format,
107 const errarg &arg1 = empty_errarg,
108 const errarg &arg2 = empty_errarg,
109 const errarg &arg3 = empty_errarg);
112 input_item *input_stack::top = 0;
114 void input_stack::init()
117 input_item *tem = top;
123 int input_stack::get_char()
126 int c = top->get_char();
129 input_item *tem = top;
136 int input_stack::peek_char()
139 int c = top->peek_char();
142 input_item *tem = top;
149 void input_stack::push_file(const char *fn)
152 if (strcmp(fn, "-") == 0) {
154 fn = "<standard input>";
160 error("can't open `%1': %2", fn, strerror(errno));
169 if (bol && c == '.') {
170 // replace lines beginning with .R1 or .R2 with a blank line
174 if (c == '1' || c == '2') {
177 if (compatible_flag || c == ' ' || c == '\n' || c == EOF) {
178 while (c != '\n' && c != EOF)
197 if (invalid_input_char(c))
198 error_with_file_and_line(fn, lineno,
199 "invalid input character code %1", int(c));
212 if (buf.length() > 0 && buf[buf.length() - 1] != '\n')
214 input_item *it = new input_item(buf, fn);
219 void input_stack::push_string(string &s, const char *filename, int lineno)
221 input_item *it = new input_item(s, filename, lineno);
226 void input_stack::error(const char *format, const errarg &arg1,
227 const errarg &arg2, const errarg &arg3)
229 const char *filename;
231 for (input_item *it = top; it; it = it->next)
232 if (it->get_location(&filename, &lineno)) {
233 error_with_file_and_line(filename, lineno, format, arg1, arg2, arg3);
236 ::error(format, arg1, arg2, arg3);
239 void command_error(const char *format, const errarg &arg1,
240 const errarg &arg2, const errarg &arg3)
242 input_stack::error(format, arg1, arg2, arg3);
245 // # not recognized in ""
246 // \<newline> is recognized in ""
247 // # does not conceal newline
248 // if missing closing quote, word extends to end of line
249 // no special treatment of \ other than before newline
250 // \<newline> not recognized after #
251 // ; allowed as alternative to newline
252 // ; not recognized in ""
253 // don't clear word_buffer; just append on
254 // return -1 for EOF, 0 for newline, 1 for word
256 int get_word(string &word_buffer)
258 int c = input_stack::get_char();
262 c = input_stack::get_char();
263 } while (c != '\n' && c != EOF);
266 if (c == '\\' && input_stack::peek_char() == '\n')
267 input_stack::skip_char();
268 else if (c != ' ' && c != '\t')
270 c = input_stack::get_char();
274 if (c == '\n' || c == ';')
278 c = input_stack::peek_char();
279 if (c == EOF || c == '\n')
281 input_stack::skip_char();
283 int d = input_stack::peek_char();
285 input_stack::skip_char();
289 else if (c == '\\') {
290 int d = input_stack::peek_char();
292 input_stack::skip_char();
303 c = input_stack::peek_char();
304 if (c == ' ' || c == '\t' || c == '\n' || c == '#' || c == ';')
306 input_stack::skip_char();
308 int d = input_stack::peek_char();
310 input_stack::skip_char();
325 // This is for debugging.
327 static void echo_command(int argc, argument *argv)
329 for (int i = 0; i < argc; i++)
330 fprintf(stderr, "%s\n", argv[i].s);
333 static void include_command(int argc, argument *argv)
336 input_stack::push_file(argv[0].s);
339 static void capitalize_command(int argc, argument *argv)
342 capitalize_fields = argv[0].s;
344 capitalize_fields.clear();
347 static void accumulate_command(int, argument *)
352 static void no_accumulate_command(int, argument *)
357 static void move_punctuation_command(int, argument *)
359 move_punctuation = 1;
362 static void no_move_punctuation_command(int, argument *)
364 move_punctuation = 0;
367 static void sort_command(int argc, argument *argv)
372 sort_fields = argv[0].s;
376 static void no_sort_command(int, argument *)
381 static void articles_command(int argc, argument *argv)
385 for (i = 0; i < argc; i++) {
386 articles += argv[i].s;
389 int len = articles.length();
390 for (i = 0; i < len; i++)
391 articles[i] = cmlower(articles[i]);
394 static void database_command(int argc, argument *argv)
396 for (int i = 0; i < argc; i++)
397 database_list.add_file(argv[i].s);
400 static void default_database_command(int, argument *)
405 static void no_default_database_command(int, argument *)
410 static void bibliography_command(int argc, argument *argv)
412 const char *saved_filename = current_filename;
413 int saved_lineno = current_lineno;
414 int saved_label_in_text = label_in_text;
417 fputs(".]<\n", stdout);
418 for (int i = 0; i < argc; i++)
423 fputs(".]>\n", stdout);
424 current_filename = saved_filename;
425 current_lineno = saved_lineno;
426 label_in_text = saved_label_in_text;
429 static void annotate_command(int argc, argument *argv)
432 annotation_field = argv[0].s[0];
434 annotation_field = 'X';
436 annotation_macro = argv[1].s;
438 annotation_macro = "AP";
441 static void no_annotate_command(int, argument *)
443 annotation_macro.clear();
444 annotation_field = -1;
447 static void reverse_command(int, argument *argv)
449 reverse_fields = argv[0].s;
452 static void no_reverse_command(int, argument *)
454 reverse_fields.clear();
457 static void abbreviate_command(int argc, argument *argv)
459 abbreviate_fields = argv[0].s;
460 period_before_initial = argc > 1 ? argv[1].s : ". ";
461 period_before_last_name = argc > 2 ? argv[2].s : ". ";
462 period_before_other = argc > 3 ? argv[3].s : ". ";
463 period_before_hyphen = argc > 4 ? argv[4].s : ".";
466 static void no_abbreviate_command(int, argument *)
468 abbreviate_fields.clear();
471 string search_ignore_fields;
473 static void search_ignore_command(int argc, argument *argv)
476 search_ignore_fields = argv[0].s;
478 search_ignore_fields = "XYZ";
479 search_ignore_fields += '\0';
480 linear_ignore_fields = search_ignore_fields.contents();
483 static void no_search_ignore_command(int, argument *)
485 linear_ignore_fields = "";
488 static void search_truncate_command(int argc, argument *argv)
491 linear_truncate_len = argv[0].n;
493 linear_truncate_len = 6;
496 static void no_search_truncate_command(int, argument *)
498 linear_truncate_len = -1;
501 static void discard_command(int argc, argument *argv)
504 discard_fields = "XYZ";
506 discard_fields = argv[0].s;
510 static void no_discard_command(int, argument *)
512 discard_fields.clear();
515 static void label_command(int, argument *argv)
517 set_label_spec(argv[0].s);
520 static void abbreviate_label_ranges_command(int argc, argument *argv)
522 abbreviate_label_ranges = 1;
523 label_range_indicator = argc > 0 ? argv[0].s : "-";
526 static void no_abbreviate_label_ranges_command(int, argument *)
528 abbreviate_label_ranges = 0;
531 static void label_in_reference_command(int, argument *)
533 label_in_reference = 1;
536 static void no_label_in_reference_command(int, argument *)
538 label_in_reference = 0;
541 static void label_in_text_command(int, argument *)
546 static void no_label_in_text_command(int, argument *)
551 static void sort_adjacent_labels_command(int, argument *)
553 sort_adjacent_labels = 1;
556 static void no_sort_adjacent_labels_command(int, argument *)
558 sort_adjacent_labels = 0;
561 static void date_as_label_command(int argc, argument *argv)
563 if (set_date_label_spec(argc > 0 ? argv[0].s : "D%a*"))
567 static void no_date_as_label_command(int, argument *)
572 static void short_label_command(int, argument *argv)
574 if (set_short_label_spec(argv[0].s))
575 short_label_flag = 1;
578 static void no_short_label_command(int, argument *)
580 short_label_flag = 0;
583 static void compatible_command(int, argument *)
588 static void no_compatible_command(int, argument *)
593 static void join_authors_command(int argc, argument *argv)
595 join_authors_exactly_two = argv[0].s;
596 join_authors_default = argc > 1 ? argv[1].s : argv[0].s;
597 join_authors_last_two = argc == 3 ? argv[2].s : argv[0].s;
600 static void bracket_label_command(int, argument *argv)
602 pre_label = argv[0].s;
603 post_label = argv[1].s;
604 sep_label = argv[2].s;
607 static void separate_label_second_parts_command(int, argument *argv)
609 separate_label_second_parts = argv[0].s;
612 static void et_al_command(int argc, argument *argv)
615 et_al_min_elide = argv[1].n;
616 if (et_al_min_elide < 1)
618 et_al_min_total = argc >= 3 ? argv[2].n : 0;
621 static void no_et_al_command(int, argument *)
627 typedef void (*command_t)(int, argument *);
629 /* arg_types is a string describing the numbers and types of arguments.
630 s means a string, i means an integer, f is a list of fields, F is
632 ? means that the previous argument is optional, * means that the
633 previous argument can occur any number of times. */
638 const char *arg_types;
639 } command_table[] = {
640 { "include", include_command, "s" },
641 { "echo", echo_command, "s*" },
642 { "capitalize", capitalize_command, "f?" },
643 { "accumulate", accumulate_command, "" },
644 { "no-accumulate", no_accumulate_command, "" },
645 { "move-punctuation", move_punctuation_command, "" },
646 { "no-move-punctuation", no_move_punctuation_command, "" },
647 { "sort", sort_command, "s?" },
648 { "no-sort", no_sort_command, "" },
649 { "articles", articles_command, "s*" },
650 { "database", database_command, "ss*" },
651 { "default-database", default_database_command, "" },
652 { "no-default-database", no_default_database_command, "" },
653 { "bibliography", bibliography_command, "ss*" },
654 { "annotate", annotate_command, "F?s?" },
655 { "no-annotate", no_annotate_command, "" },
656 { "reverse", reverse_command, "s" },
657 { "no-reverse", no_reverse_command, "" },
658 { "abbreviate", abbreviate_command, "ss?s?s?s?" },
659 { "no-abbreviate", no_abbreviate_command, "" },
660 { "search-ignore", search_ignore_command, "f?" },
661 { "no-search-ignore", no_search_ignore_command, "" },
662 { "search-truncate", search_truncate_command, "i?" },
663 { "no-search-truncate", no_search_truncate_command, "" },
664 { "discard", discard_command, "f?" },
665 { "no-discard", no_discard_command, "" },
666 { "label", label_command, "s" },
667 { "abbreviate-label-ranges", abbreviate_label_ranges_command, "s?" },
668 { "no-abbreviate-label-ranges", no_abbreviate_label_ranges_command, "" },
669 { "label-in-reference", label_in_reference_command, "" },
670 { "no-label-in-reference", no_label_in_reference_command, "" },
671 { "label-in-text", label_in_text_command, "" },
672 { "no-label-in-text", no_label_in_text_command, "" },
673 { "sort-adjacent-labels", sort_adjacent_labels_command, "" },
674 { "no-sort-adjacent-labels", no_sort_adjacent_labels_command, "" },
675 { "date-as-label", date_as_label_command, "s?" },
676 { "no-date-as-label", no_date_as_label_command, "" },
677 { "short-label", short_label_command, "s" },
678 { "no-short-label", no_short_label_command, "" },
679 { "compatible", compatible_command, "" },
680 { "no-compatible", no_compatible_command, "" },
681 { "join-authors", join_authors_command, "sss?" },
682 { "bracket-label", bracket_label_command, "sss" },
683 { "separate-label-second-parts", separate_label_second_parts_command, "s" },
684 { "et-al", et_al_command, "sii?" },
685 { "no-et-al", no_et_al_command, "" },
688 static int check_args(const char *types, const char *name,
689 int argc, argument *argv)
696 else if (types[1] == '*') {
697 assert(types[2] == '\0');
701 input_stack::error("missing argument for command `%1'", name);
711 long n = strtol(argv->s, &ptr, 10);
712 if ((n == 0 && ptr == argv->s)
714 input_stack::error("argument %1 for command `%2' must be an integer",
723 for (const char *ptr = argv->s; *ptr != '\0'; ptr++)
724 if (!cs_field_name(*ptr)) {
725 input_stack::error("argument %1 for command `%2' must be a list of fields",
732 if (argv->s[0] == '\0' || argv->s[1] != '\0'
733 || !cs_field_name(argv->s[0])) {
734 input_stack::error("argument %1 for command `%2' must be a field name",
744 else if (types[1] != '*')
751 input_stack::error("too many arguments for command `%1'", name);
757 static void execute_command(const char *name, int argc, argument *argv)
759 for (unsigned int i = 0;
760 i < sizeof(command_table)/sizeof(command_table[0]); i++)
761 if (strcmp(name, command_table[i].name) == 0) {
762 if (check_args(command_table[i].arg_types, name, argc, argv))
763 (*command_table[i].func)(argc, argv);
766 input_stack::error("unknown command `%1'", name);
769 static void command_loop()
774 int res = get_word(command);
782 while ((res = get_word(command)) == 1) {
786 argument *argv = new argument[argc];
787 const char *ptr = command.contents();
788 for (int i = 0; i < argc; i++)
789 argv[i].s = ptr = strchr(ptr, '\0') + 1;
790 execute_command(command.contents(), argc, argv);
797 void process_commands(const char *file)
800 input_stack::push_file(file);
804 void process_commands(string &s, const char *file, int lineno)
807 input_stack::push_string(s, file, lineno);