2 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 2000, 2001,
4 Free Software Foundation, Inc.
5 Contributed by steve chamberlain @cygnus
7 This file is part of BFD, the Binary File Descriptor library.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
23 /* Yet another way of extracting documentation from source.
24 No, I haven't finished it yet, but I hope you people like it better
29 Basically, this is a sort of string forth, maybe we should call it
32 You define new words thus:
33 : <newword> <oldwords> ;
37 /* Primitives provided by the program:
39 Two stacks are provided, a string stack and an integer stack.
41 Internal state variables:
42 internal_wanted - indicates whether `-i' was passed
43 internal_mode - user-settable
47 ! - pop top of integer stack for address, pop next for value; store
48 @ - treat value on integer stack as the address of an integer; push
49 that integer on the integer stack after popping the "address"
50 hello - print "hello\n" to stdout
51 stdout - put stdout marker on TOS
52 stderr - put stderr marker on TOS
53 print - print TOS-1 on TOS (eg: "hello\n" stdout print)
56 copy_past_newline - append input, up to and including newline into TOS
60 remchar - delete last character from TOS
62 do_fancy_stuff - translate <<foo>> to @code{foo} in TOS
63 bulletize - if "o" lines found, prepend @itemize @bullet to TOS
64 and @item to each "o" line; append @end itemize
65 courierize - put @example around . and | lines, translate {* *} { }
68 outputdots - strip out lines without leading dots
69 paramstuff - convert full declaration into "PARAMS" form if not already
70 maybecatstr - do catstr if internal_mode == internal_wanted, discard
72 translatecomments - turn {* and *} into comment delimiters
73 kill_bogus_lines - get rid of extra newlines
75 internalmode - pop from integer stack, set `internalmode' to that value
76 print_stack_level - print current stack depth to stderr
77 strip_trailing_newlines - go ahead, guess...
78 [quoted string] - push string onto string stack
79 [word starting with digit] - push atol(str) onto integer stack
81 A command must be all upper-case, and alone on a line.
99 /* Here is a string type ... */
101 typedef struct buffer
104 unsigned long write_idx;
109 static void init_string_with_size (string_type *, unsigned int);
110 static void init_string (string_type *);
111 static int find (string_type *, char *);
112 static void write_buffer (string_type *, FILE *);
113 static void delete_string (string_type *);
114 static char *addr (string_type *, unsigned int);
115 static char at (string_type *, unsigned int);
116 static void catchar (string_type *, int);
117 static void overwrite_string (string_type *, string_type *);
118 static void catbuf (string_type *, char *, unsigned int);
119 static void cattext (string_type *, char *);
120 static void catstr (string_type *, string_type *);
124 init_string_with_size (buffer, size)
128 buffer->write_idx = 0;
130 buffer->ptr = malloc (size);
137 init_string_with_size (buffer, DEF_SIZE);
148 for (i = 0; i < str->write_idx && *p; i++)
150 if (*p == str->ptr[i])
159 write_buffer (buffer, f)
163 fwrite (buffer->ptr, buffer->write_idx, 1, f);
167 delete_string (buffer)
178 return buffer->ptr + idx;
186 if (pos >= buffer->write_idx)
188 return buffer->ptr[pos];
196 if (buffer->write_idx == buffer->size)
199 buffer->ptr = realloc (buffer->ptr, buffer->size);
202 buffer->ptr[buffer->write_idx++] = ch;
206 overwrite_string (dst, src)
211 dst->size = src->size;
212 dst->write_idx = src->write_idx;
217 catbuf (buffer, buf, len)
222 if (buffer->write_idx + len >= buffer->size)
224 while (buffer->write_idx + len >= buffer->size)
226 buffer->ptr = realloc (buffer->ptr, buffer->size);
228 memcpy (buffer->ptr + buffer->write_idx, buf, len);
229 buffer->write_idx += len;
233 cattext (buffer, string)
237 catbuf (buffer, string, (unsigned int) strlen (string));
245 catbuf (dst, src->ptr, src->write_idx);
249 skip_white_and_stars (src, idx)
254 while ((c = at (src, idx)),
255 isspace ((unsigned char) c)
257 /* Don't skip past end-of-comment or star as first
258 character on its line. */
259 && at (src, idx +1) != '/'
260 && at (src, idx -1) != '\n'))
265 /***********************************************************************/
267 string_type stack[STACK];
270 unsigned int idx = 0; /* Pos in input buffer */
271 string_type *ptr; /* and the buffer */
272 typedef void (*stinst_type)();
274 stinst_type sstack[STACK];
275 stinst_type *ssp = &sstack[0];
277 long *isp = &istack[0];
279 typedef int *word_type;
284 struct dict_struct *next;
291 typedef struct dict_struct dict_type;
297 fprintf (stderr, "%s\n", msg);
305 die ("underflow in string stack");
306 if (tos >= stack + STACK)
307 die ("overflow in string stack");
314 die ("underflow in integer stack");
315 if (isp >= istack + STACK)
316 die ("overflow in integer stack");
320 static void exec (dict_type *);
321 static void call (void);
322 static void remchar (void), strip_trailing_newlines (void), push_number (void);
323 static void push_text (void);
324 static void remove_noncomments (string_type *, string_type *);
325 static void print_stack_level (void);
326 static void paramstuff (void), translatecomments (void);
327 static void outputdots (void), courierize (void), bulletize (void);
328 static void do_fancy_stuff (void);
329 static int iscommand (string_type *, unsigned int);
330 static int copy_past_newline (string_type *, unsigned int, string_type *);
331 static void icopy_past_newline (void), kill_bogus_lines (void), indent (void);
332 static void get_stuff_in_command (void), swap (void), other_dup (void);
333 static void drop (void), idrop (void);
334 static void icatstr (void), skip_past_newline (void), internalmode (void);
335 static void maybecatstr (void);
336 static char *nextword (char *, char **);
337 dict_type *lookup_word (char *);
338 static void perform (void);
339 dict_type *newentry (char *);
340 unsigned int add_to_definition (dict_type *, stinst_type);
341 void add_intrinsic (char *, void (*)());
342 void add_var (char *);
343 void compile (char *);
344 static void bang (void);
345 static void atsign (void);
346 static void hello (void);
347 static void stdout_ (void);
348 static void stderr_ (void);
349 static void print (void);
350 static void read_in (string_type *, FILE *);
351 static void usage (void);
352 static void chew_exit (void);
367 stinst_type *oldpc = pc;
369 e = (dict_type *) (pc[1]);
383 strip_trailing_newlines ()
385 while ((isspace ((unsigned char) at (tos, tos->write_idx - 1))
386 || at (tos, tos->write_idx - 1) == '\n')
387 && tos->write_idx > 0)
409 cattext (tos, *((char **) pc));
413 /* This function removes everything not inside comments starting on
414 the first char of the line from the string, also when copying
415 comments, removes blank space and leading *'s.
416 Blank lines are turned into one blank line. */
419 remove_noncomments (src, dst)
423 unsigned int idx = 0;
425 while (at (src, idx))
427 /* Now see if we have a comment at the start of the line. */
428 if (at (src, idx) == '\n'
429 && at (src, idx + 1) == '/'
430 && at (src, idx + 2) == '*')
434 idx = skip_white_and_stars (src, idx);
436 /* Remove leading dot */
437 if (at (src, idx) == '.')
440 /* Copy to the end of the line, or till the end of the
442 while (at (src, idx))
444 if (at (src, idx) == '\n')
446 /* end of line, echo and scrape of leading blanks */
447 if (at (src, idx + 1) == '\n')
451 idx = skip_white_and_stars (src, idx);
453 else if (at (src, idx) == '*' && at (src, idx + 1) == '/')
456 cattext (dst, "\nENDDD\n");
461 catchar (dst, at (src, idx));
474 fprintf (stderr, "current string stack depth = %d, ", tos - stack);
475 fprintf (stderr, "current integer stack depth = %d\n", isp - istack);
483 name PARAMS ((stuff));
497 /* Make sure that it's not already param'd or proto'd. */
498 if (find (tos, "PARAMS") || find (tos, "PROTO") || !find (tos, "("))
504 /* Find the open paren. */
505 for (openp = 0; at (tos, openp) != '(' && at (tos, openp); openp++)
509 /* Step back to the fname. */
511 while (fname && isspace ((unsigned char) at (tos, fname)))
514 && !isspace ((unsigned char) at (tos,fname))
515 && at (tos,fname) != '*')
520 /* Output type, omitting trailing whitespace character(s), if
522 for (len = fname; 0 < len; len--)
524 if (!isspace ((unsigned char) at (tos, len - 1)))
527 for (idx = 0; idx < len; idx++)
528 catchar (&out, at (tos, idx));
530 cattext (&out, "\n"); /* Insert a newline between type and fnname */
532 /* Output function name, omitting trailing whitespace
533 character(s), if any. */
534 for (len = openp; 0 < len; len--)
536 if (!isspace ((unsigned char) at (tos, len - 1)))
539 for (idx = fname; idx < len; idx++)
540 catchar (&out, at (tos, idx));
542 cattext (&out, " PARAMS (");
544 for (idx = openp; at (tos, idx) && at (tos, idx) != ';'; idx++)
545 catchar (&out, at (tos, idx));
547 cattext (&out, ");\n\n");
549 overwrite_string (tos, &out);
555 and *} into comments */
560 unsigned int idx = 0;
564 while (at (tos, idx))
566 if (at (tos, idx) == '{' && at (tos, idx + 1) == '*')
568 cattext (&out, "/*");
571 else if (at (tos, idx) == '*' && at (tos, idx + 1) == '}')
573 cattext (&out, "*/");
578 catchar (&out, at (tos, idx));
583 overwrite_string (tos, &out);
590 /* This is not currently used. */
592 /* turn everything not starting with a . into a comment */
597 unsigned int idx = 0;
601 while (at (tos, idx))
603 if (at (tos, idx) == '\n' && at (tos, idx + 1) == '*')
605 cattext (&out, " /*");
608 else if (at (tos, idx) == '*' && at (tos, idx + 1) == '}')
610 cattext (&out, "*/");
615 catchar (&out, at (tos, idx));
620 overwrite_string (tos, &out);
627 /* Mod tos so that only lines with leading dots remain */
631 unsigned int idx = 0;
635 while (at (tos, idx))
637 if (at (tos, idx) == '\n' && at (tos, idx + 1) == '.')
642 while ((c = at (tos, idx)) && c != '\n')
644 if (c == '{' && at (tos, idx + 1) == '*')
646 cattext (&out, "/*");
649 else if (c == '*' && at (tos, idx + 1) == '}')
651 cattext (&out, "*/");
660 catchar (&out, '\n');
668 overwrite_string (tos, &out);
672 /* Find lines starting with . and | and put example around them on tos */
677 unsigned int idx = 0;
682 while (at (tos, idx))
684 if (at (tos, idx) == '\n'
685 && (at (tos, idx +1 ) == '.'
686 || at (tos, idx + 1) == '|'))
688 cattext (&out, "\n@example\n");
693 while (at (tos, idx) && at (tos, idx) != '\n')
697 /* We are inside {} parameters of some command;
698 Just pass through until matching brace. */
699 if (at (tos, idx) == '{')
701 else if (at (tos, idx) == '}')
704 else if (command != 0)
706 if (at (tos, idx) == '{')
708 else if (!islower ((unsigned char) at (tos, idx)))
711 else if (at (tos, idx) == '@'
712 && islower ((unsigned char) at (tos, idx + 1)))
716 else if (at (tos, idx) == '{' && at (tos, idx + 1) == '*')
718 cattext (&out, "/*");
722 else if (at (tos, idx) == '*' && at (tos, idx + 1) == '}')
724 cattext (&out, "*/");
728 else if (at (tos, idx) == '{'
729 || at (tos, idx) == '}')
734 catchar (&out, at (tos, idx));
737 catchar (&out, '\n');
739 while (at (tos, idx) == '\n'
740 && ((at (tos, idx + 1) == '.')
741 || (at (tos, idx + 1) == '|')))
743 cattext (&out, "@end example");
747 catchar (&out, at (tos, idx));
752 overwrite_string (tos, &out);
756 /* Finds any lines starting with "o ", if there are any, then turns
757 on @itemize @bullet, and @items each of them. Then ends with @end
758 itemize, inplace at TOS*/
763 unsigned int idx = 0;
768 while (at (tos, idx))
770 if (at (tos, idx) == '@'
771 && at (tos, idx + 1) == '*')
776 else if (at (tos, idx) == '\n'
777 && at (tos, idx + 1) == 'o'
778 && isspace ((unsigned char) at (tos, idx + 2)))
782 cattext (&out, "\n@itemize @bullet\n");
786 cattext (&out, "\n@item\n");
791 catchar (&out, at (tos, idx));
792 if (on && at (tos, idx) == '\n'
793 && at (tos, idx + 1) == '\n'
794 && at (tos, idx + 2) != 'o')
796 cattext (&out, "@end itemize");
805 cattext (&out, "@end itemize\n");
813 /* Turn <<foo>> into @code{foo} in place at TOS*/
818 unsigned int idx = 0;
821 while (at (tos, idx))
823 if (at (tos, idx) == '<'
824 && at (tos, idx + 1) == '<'
825 && !isspace ((unsigned char) at (tos, idx + 2)))
827 /* This qualifies as a << startup. */
829 cattext (&out, "@code{");
831 && at (tos, idx) != '>' )
833 catchar (&out, at (tos, idx));
842 catchar (&out, at (tos, idx));
852 /* A command is all upper case,and alone on a line. */
859 unsigned int len = 0;
860 while (at (ptr, idx))
862 if (isupper ((unsigned char) at (ptr, idx))
863 || at (ptr, idx) == ' ' || at (ptr, idx) == '_')
868 else if (at (ptr, idx) == '\n')
881 copy_past_newline (ptr, idx, dst)
888 while (at (ptr, idx) && at (ptr, idx) != '\n')
890 if (at (ptr, idx) == '\t')
892 /* Expand tabs. Neither makeinfo nor TeX can cope well with
896 while (++column & 7);
900 catchar (dst, at (ptr, idx));
906 catchar (dst, at (ptr, idx));
913 icopy_past_newline ()
918 idx = copy_past_newline (ptr, idx, tos);
923 Take the string at the top of the stack, do some prettying. */
936 /* Drop leading nl. */
937 while (at (tos, idx) == '\n')
943 /* If the first char is a '.' prepend a newline so that it is
944 recognized properly later. */
945 if (at (tos, idx) == '.')
946 catchar (&out, '\n');
948 /* Find the last char. */
949 while (at (tos, idx))
954 /* Find the last non white before the nl. */
957 while (idx && isspace ((unsigned char) at (tos, idx)))
961 /* Copy buffer upto last char, but blank lines before and after
967 if (at (tos, c) == '\n'
968 && at (tos, c + 1) == '\n'
969 && at (tos, c + 2) == '.')
971 /* Ignore two newlines before a dot. */
974 else if (at (tos, c) == '.' && sl)
976 /* remember that this line started with a dot. */
979 else if (at (tos, c) == '\n'
980 && at (tos, c + 1) == '\n'
984 /* Ignore two newlines when last line was dot. */
987 catchar (&out, at (tos, c));
988 if (at (tos, c) == '\n')
1005 catchar (&out, '\n');
1007 delete_string (tos);
1020 while (at (tos, idx))
1022 switch (at (tos, idx))
1025 cattext (&out, "\n");
1027 if (tab && at (tos, idx))
1029 cattext (&out, " ");
1036 cattext (&out, " ");
1038 cattext (&out, "(");
1043 cattext (&out, ")");
1049 catchar (&out, at (tos, idx));
1058 delete_string (tos);
1064 get_stuff_in_command ()
1070 while (at (ptr, idx))
1072 if (iscommand (ptr, idx))
1074 idx = copy_past_newline (ptr, idx, tos);
1096 catstr (tos, tos - 1);
1121 catstr (tos, tos + 1);
1122 delete_string (tos + 1);
1127 skip_past_newline ()
1129 while (at (ptr, idx)
1130 && at (ptr, idx) != '\n')
1139 internal_mode = *(isp);
1148 if (internal_wanted == internal_mode)
1150 catstr (tos - 1, tos);
1152 delete_string (tos);
1159 nextword (string, word)
1170 while (isspace ((unsigned char) *string) || *string == '-')
1174 while (*string && *string != '\n')
1186 word_start = string;
1193 if (*string == '\\')
1199 while (*string != '"');
1203 while (!isspace ((unsigned char) *string))
1211 *word = malloc (length + 1);
1216 for (idx = 0; idx < length; idx++)
1218 if (src[idx] == '\\')
1219 switch (src[idx + 1])
1227 *dst++ = src[idx + 1];
1251 dict_type *ptr = root;
1254 if (strcmp (ptr->word, word) == 0)
1259 fprintf (stderr, "Can't find %s\n", word);
1268 while (at (ptr, idx))
1270 /* It's worth looking through the command list. */
1271 if (iscommand (ptr, idx))
1276 (void) nextword (addr (ptr, idx), &next);
1278 word = lookup_word (next);
1287 fprintf (stderr, "warning, %s is not recognised\n", next);
1288 skip_past_newline ();
1293 skip_past_newline ();
1301 dict_type *new = (dict_type *) malloc (sizeof (dict_type));
1305 new->code = (stinst_type *) malloc (sizeof (stinst_type));
1306 new->code_length = 1;
1312 add_to_definition (entry, word)
1316 if (entry->code_end == entry->code_length)
1318 entry->code_length += 2;
1320 (stinst_type *) realloc ((char *) (entry->code),
1321 entry->code_length * sizeof (word_type));
1323 entry->code[entry->code_end] = word;
1325 return entry->code_end++;
1329 add_intrinsic (name, func)
1333 dict_type *new = newentry (name);
1334 add_to_definition (new, func);
1335 add_to_definition (new, 0);
1342 dict_type *new = newentry (name);
1343 add_to_definition (new, push_number);
1344 add_to_definition (new, (stinst_type) (&(new->var)));
1345 add_to_definition (new, 0);
1352 /* Add words to the dictionary. */
1354 string = nextword (string, &word);
1355 while (string && *string && word[0])
1357 if (strcmp (word, "var") == 0)
1359 string = nextword (string, &word);
1362 string = nextword (string, &word);
1364 else if (word[0] == ':')
1367 /* Compile a word and add to dictionary. */
1368 string = nextword (string, &word);
1370 ptr = newentry (word);
1371 string = nextword (string, &word);
1372 while (word[0] != ';')
1377 /* got a string, embed magic push string
1379 add_to_definition (ptr, push_text);
1380 add_to_definition (ptr, (stinst_type) (word + 1));
1392 /* Got a number, embedd the magic push number
1394 add_to_definition (ptr, push_number);
1395 add_to_definition (ptr, (stinst_type) atol (word));
1398 add_to_definition (ptr, call);
1399 add_to_definition (ptr, (stinst_type) lookup_word (word));
1402 string = nextword (string, &word);
1404 add_to_definition (ptr, 0);
1405 string = nextword (string, &word);
1409 fprintf (stderr, "syntax error at %s\n", string - 1);
1417 *(long *) ((isp[0])) = isp[-1];
1426 isp[0] = *(long *) (isp[0]);
1459 write_buffer (tos, stdout);
1461 write_buffer (tos, stderr);
1463 fprintf (stderr, "print: illegal print destination `%ld'\n", *isp);
1480 r = fread (buff, 1, sizeof (buff), file);
1481 catbuf (str, buff, r);
1486 catbuf (str, buff, 1);
1492 fprintf (stderr, "usage: -[d|i|g] <file >file\n");
1496 /* There is no reliable way to declare exit. Sometimes it returns
1497 int, and sometimes it returns void. Sometimes it changes between
1498 OS releases. Trying to get it declared correctly in the hosts file
1499 is a pointless waste of time. */
1516 init_string (&buffer);
1517 init_string (&pptr);
1518 init_string (stack + 0);
1522 add_intrinsic ("push_text", push_text);
1523 add_intrinsic ("!", bang);
1524 add_intrinsic ("@", atsign);
1525 add_intrinsic ("hello", hello);
1526 add_intrinsic ("stdout", stdout_);
1527 add_intrinsic ("stderr", stderr_);
1528 add_intrinsic ("print", print);
1529 add_intrinsic ("skip_past_newline", skip_past_newline);
1530 add_intrinsic ("catstr", icatstr);
1531 add_intrinsic ("copy_past_newline", icopy_past_newline);
1532 add_intrinsic ("dup", other_dup);
1533 add_intrinsic ("drop", drop);
1534 add_intrinsic ("idrop", idrop);
1535 add_intrinsic ("remchar", remchar);
1536 add_intrinsic ("get_stuff_in_command", get_stuff_in_command);
1537 add_intrinsic ("do_fancy_stuff", do_fancy_stuff);
1538 add_intrinsic ("bulletize", bulletize);
1539 add_intrinsic ("courierize", courierize);
1540 /* If the following line gives an error, exit() is not declared in the
1541 ../hosts/foo.h file for this host. Fix it there, not here! */
1542 /* No, don't fix it anywhere; see comment on chew_exit--Ian Taylor. */
1543 add_intrinsic ("exit", chew_exit);
1544 add_intrinsic ("swap", swap);
1545 add_intrinsic ("outputdots", outputdots);
1546 add_intrinsic ("paramstuff", paramstuff);
1547 add_intrinsic ("maybecatstr", maybecatstr);
1548 add_intrinsic ("translatecomments", translatecomments);
1549 add_intrinsic ("kill_bogus_lines", kill_bogus_lines);
1550 add_intrinsic ("indent", indent);
1551 add_intrinsic ("internalmode", internalmode);
1552 add_intrinsic ("print_stack_level", print_stack_level);
1553 add_intrinsic ("strip_trailing_newlines", strip_trailing_newlines);
1555 /* Put a nl at the start. */
1556 catchar (&buffer, '\n');
1558 read_in (&buffer, stdin);
1559 remove_noncomments (&buffer, ptr);
1560 for (i = 1; i < (unsigned int) ac; i++)
1562 if (av[i][0] == '-')
1564 if (av[i][1] == 'f')
1570 f = fopen (av[i + 1], "r");
1573 fprintf (stderr, "Can't open the input file %s\n",
1582 else if (av[i][1] == 'i')
1584 internal_wanted = 1;
1586 else if (av[i][1] == 'w')
1594 write_buffer (stack + 0, stdout);
1597 fprintf (stderr, "finishing with current stack level %d\n",