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 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
|
/* mkbuiltins.c - Create builtins.c, builtext.h, and builtdoc.c from
a single source file called builtins.def. */
/* Copyright (C) 1987, 1989, 1991 Free Software Foundation, Inc.
This file is part of GNU Bash, the Bourne Again SHell.
Bash is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.
Bash is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License along
with Bash; see the file COPYING. If not, write to the Free Software
Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
#include <config.h>
#if defined (HAVE_UNISTD_H)
# ifdef _MINIX
# include <sys/types.h>
# endif
# include <unistd.h>
#endif
#ifndef _MINIX
#include "../bashtypes.h"
#include <sys/file.h>
#endif
#include "posixstat.h"
#include "filecntl.h"
#include "../bashansi.h"
#include <stdio.h>
#include "stdc.h"
#define DOCFILE "builtins.texi"
static char *xmalloc (), *xrealloc ();
#if !defined (__STDC__) && !defined (strcpy)
extern char *strcpy ();
#endif /* !__STDC__ && !strcpy */
#define savestring(x) strcpy (xmalloc (1 + strlen (x)), (x))
#define whitespace(c) (((c) == ' ') || ((c) == '\t'))
/* Flag values that builtins can have. */
#define BUILTIN_FLAG_SPECIAL 0x01
#define BUILTIN_FLAG_ASSIGNMENT 0x02
/* If this stream descriptor is non-zero, then write
texinfo documentation to it. */
FILE *documentation_file = (FILE *)NULL;
/* Non-zero means to only produce documentation. */
int only_documentation = 0;
/* Non-zero means to not do any productions. */
int inhibit_production = 0;
#if !defined (OLDCODE)
int no_long_document = 0;
#endif /* !OLDCODE */
/* The name of a directory to precede the filename when reporting
errors. */
char *error_directory = (char *)NULL;
/* The name of the structure file. */
char *struct_filename = (char *)NULL;
/* The name of the external declaration file. */
char *extern_filename = (char *)NULL;
/* Here is a structure for manipulating arrays of data. */
typedef struct {
int size; /* Number of slots allocated to array. */
int sindex; /* Current location in array. */
int width; /* Size of each element. */
int growth_rate; /* How fast to grow. */
char **array; /* The array itself. */
} ARRAY;
/* Here is a structure defining a single BUILTIN. */
typedef struct {
char *name; /* The name of this builtin. */
char *function; /* The name of the function to call. */
char *shortdoc; /* The short documentation for this builtin. */
char *docname; /* Possible name for documentation string. */
ARRAY *longdoc; /* The long documentation for this builtin. */
ARRAY *dependencies; /* Null terminated array of #define names. */
int flags; /* Flags for this builtin. */
} BUILTIN_DESC;
/* Here is a structure which defines a DEF file. */
typedef struct {
char *filename; /* The name of the input def file. */
ARRAY *lines; /* The contents of the file. */
int line_number; /* The current line number. */
char *production; /* The name of the production file. */
FILE *output; /* Open file stream for PRODUCTION. */
ARRAY *builtins; /* Null terminated array of BUILTIN_DESC *. */
} DEF_FILE;
/* The array of all builtins encountered during execution of this code. */
ARRAY *saved_builtins = (ARRAY *)NULL;
/* The Posix.2 so-called `special' builtins. */
char *special_builtins[] =
{
":", ".", "source", "break", "continue", "eval", "exec", "exit",
"export", "readonly", "return", "set", "shift", "trap", "unset",
(char *)NULL
};
/* The builtin commands that take assignment statements as arguments. */
char *assignment_builtins[] =
{
"alias", "declare", "export", "local", "readonly", "typeset",
(char *)NULL
};
/* Forward declarations. */
static int is_special_builtin ();
static int is_assignment_builtin ();
#if !defined (HAVE_RENAME)
static int rename ();
#endif
void extract_info ();
void file_error ();
void line_error ();
void write_file_headers ();
void write_file_footers ();
void write_ifdefs ();
void write_endifs ();
void write_documentation ();
void write_longdocs ();
void write_builtins ();
void free_defs ();
void add_documentation ();
void must_be_building ();
void remove_trailing_whitespace ();
/* For each file mentioned on the command line, process it and
write the information to STRUCTFILE and EXTERNFILE, while
creating the production file if neccessary. */
int
main (argc, argv)
int argc;
char **argv;
{
int arg_index = 1;
FILE *structfile, *externfile;
char *documentation_filename, *temp_struct_filename;
structfile = externfile = (FILE *)NULL;
documentation_filename = DOCFILE;
temp_struct_filename = (char *)NULL;
while (arg_index < argc && argv[arg_index][0] == '-')
{
char *arg = argv[arg_index++];
if (strcmp (arg, "-externfile") == 0)
extern_filename = argv[arg_index++];
else if (strcmp (arg, "-structfile") == 0)
struct_filename = argv[arg_index++];
else if (strcmp (arg, "-noproduction") == 0)
inhibit_production = 1;
else if (strcmp (arg, "-document") == 0)
documentation_file = fopen (documentation_filename, "w");
else if (strcmp (arg, "-D") == 0)
{
int len;
if (error_directory)
free (error_directory);
error_directory = xmalloc (2 + strlen (argv[arg_index]));
strcpy (error_directory, argv[arg_index]);
len = strlen (error_directory);
if (len && error_directory[len - 1] != '/')
strcat (error_directory, "/");
arg_index++;
}
else if (strcmp (arg, "-documentonly") == 0)
{
only_documentation = 1;
documentation_file = fopen (documentation_filename, "w");
}
#if !defined (OLDCODE)
else if (strcmp (arg, "-nodocument") == 0)
no_long_document = 1;
#endif /* !OLDCODE */
else
{
fprintf (stderr, "%s: Unknown flag %s.\n", argv[0], arg);
exit (2);
}
}
/* If there are no files to process, just quit now. */
if (arg_index == argc)
exit (0);
if (!only_documentation)
{
/* Open the files. */
if (struct_filename)
{
temp_struct_filename = xmalloc (15);
sprintf (temp_struct_filename, "mk-%ld", (long) getpid ());
structfile = fopen (temp_struct_filename, "w");
if (!structfile)
file_error (temp_struct_filename);
}
if (extern_filename)
{
externfile = fopen (extern_filename, "w");
if (!externfile)
file_error (extern_filename);
}
/* Write out the headers. */
write_file_headers (structfile, externfile);
}
if (documentation_file)
{
fprintf (documentation_file, "@c Table of builtins created with %s.\n",
argv[0]);
fprintf (documentation_file, "@ftable @asis\n");
}
/* Process the .def files. */
while (arg_index < argc)
{
register char *arg;
arg = argv[arg_index++];
extract_info (arg, structfile, externfile);
}
/* Close the files. */
if (!only_documentation)
{
/* Write the footers. */
write_file_footers (structfile, externfile);
if (structfile)
{
write_longdocs (structfile, saved_builtins);
fclose (structfile);
rename (temp_struct_filename, struct_filename);
}
if (externfile)
fclose (externfile);
}
if (documentation_file)
{
fprintf (documentation_file, "@end ftable\n");
fclose (documentation_file);
}
exit (0);
}
/* **************************************************************** */
/* */
/* Array Functions and Manipulators */
/* */
/* **************************************************************** */
/* Make a new array, and return a pointer to it. The array will
contain elements of size WIDTH, and is initialized to no elements. */
ARRAY *
array_create (width)
int width;
{
ARRAY *array;
array = (ARRAY *)xmalloc (sizeof (ARRAY));
array->size = 0;
array->sindex = 0;
array->width = width;
/* Default to increasing size in units of 20. */
array->growth_rate = 20;
array->array = (char **)NULL;
return (array);
}
/* Copy the array of strings in ARRAY. */
ARRAY *
copy_string_array (array)
ARRAY *array;
{
register int i;
ARRAY *copy;
if (!array)
return (ARRAY *)NULL;
copy = array_create (sizeof (char *));
copy->size = array->size;
copy->sindex = array->sindex;
copy->width = array->width;
copy->array = (char **)xmalloc ((1 + array->sindex) * sizeof (char *));
for (i = 0; i < array->sindex; i++)
copy->array[i] = savestring (array->array[i]);
copy->array[i] = (char *)NULL;
return (copy);
}
/* Add ELEMENT to ARRAY, growing the array if neccessary. */
void
array_add (element, array)
char *element;
ARRAY *array;
{
if (array->sindex + 2 > array->size)
array->array = (char **)xrealloc
(array->array, (array->size += array->growth_rate) * array->width);
#if defined (HAVE_BCOPY)
bcopy (&element, (char *) &(array->array[array->sindex]), array->width);
array->sindex++;
bzero ((char *) &(array->array[array->sindex]), array->width);
#else
array->array[array->sindex++] = element;
array->array[array->sindex] = (char *)NULL;
#endif /* !HAVE_BCOPY */
}
/* Free an allocated array and data pointer. */
void
array_free (array)
ARRAY *array;
{
if (array->array)
free (array->array);
free (array);
}
/* **************************************************************** */
/* */
/* Processing a DEF File */
/* */
/* **************************************************************** */
/* The definition of a function. */
typedef int Function ();
typedef int mk_handler_func_t __P((char *, DEF_FILE *, char *));
/* Structure handles processor directives. */
typedef struct {
char *directive;
mk_handler_func_t *function;
} HANDLER_ENTRY;
extern int builtin_handler __P((char *, DEF_FILE *, char *));
extern int function_handler __P((char *, DEF_FILE *, char *));
extern int short_doc_handler __P((char *, DEF_FILE *, char *));
extern int comment_handler __P((char *, DEF_FILE *, char *));
extern int depends_on_handler __P((char *, DEF_FILE *, char *));
extern int produces_handler __P((char *, DEF_FILE *, char *));
extern int end_handler __P((char *, DEF_FILE *, char *));
extern int docname_handler __P((char *, DEF_FILE *, char *));
HANDLER_ENTRY handlers[] = {
{ "BUILTIN", builtin_handler },
{ "DOCNAME", docname_handler },
{ "FUNCTION", function_handler },
{ "SHORT_DOC", short_doc_handler },
{ "$", comment_handler },
{ "COMMENT", comment_handler },
{ "DEPENDS_ON", depends_on_handler },
{ "PRODUCES", produces_handler },
{ "END", end_handler },
{ (char *)NULL, (mk_handler_func_t *)NULL }
};
/* Return the entry in the table of handlers for NAME. */
HANDLER_ENTRY *
find_directive (directive)
char *directive;
{
register int i;
for (i = 0; handlers[i].directive; i++)
if (strcmp (handlers[i].directive, directive) == 0)
return (&handlers[i]);
return ((HANDLER_ENTRY *)NULL);
}
/* Non-zero indicates that a $BUILTIN has been seen, but not
the corresponding $END. */
static int building_builtin = 0;
/* Non-zero means to output cpp line and file information before
printing the current line to the production file. */
int output_cpp_line_info = 0;
/* The main function of this program. Read FILENAME and act on what is
found. Lines not starting with a dollar sign are copied to the
$PRODUCES target, if one is present. Lines starting with a dollar sign
are directives to this program, specifying the name of the builtin, the
function to call, the short documentation and the long documentation
strings. FILENAME can contain multiple $BUILTINs, but only one $PRODUCES
target. After the file has been processed, write out the names of
builtins found in each $BUILTIN. Plain text found before the $PRODUCES
is ignored, as is "$$ comment text". */
void
extract_info (filename, structfile, externfile)
char *filename;
FILE *structfile, *externfile;
{
register int i;
DEF_FILE *defs;
struct stat finfo;
size_t file_size;
char *buffer, *line;
int fd, nr;
if (stat (filename, &finfo) == -1)
file_error (filename);
fd = open (filename, O_RDONLY, 0666);
if (fd == -1)
file_error (filename);
file_size = (size_t)finfo.st_size;
buffer = xmalloc (1 + file_size);
if ((nr = read (fd, buffer, file_size)) < 0)
file_error (filename);
/* This is needed on WIN32, and does not hurt on Unix. */
if (nr < file_size)
file_size = nr;
close (fd);
if (nr == 0)
{
fprintf (stderr, "mkbuiltins: %s: skipping zero-length file\n", filename);
return;
}
/* Create and fill in the initial structure describing this file. */
defs = (DEF_FILE *)xmalloc (sizeof (DEF_FILE));
defs->filename = filename;
defs->lines = array_create (sizeof (char *));
defs->line_number = 0;
defs->production = (char *)NULL;
defs->output = (FILE *)NULL;
defs->builtins = (ARRAY *)NULL;
/* Build the array of lines. */
i = 0;
while (i < file_size)
{
array_add (&buffer[i], defs->lines);
while (buffer[i] != '\n' && i < file_size)
i++;
buffer[i++] = '\0';
}
/* Begin processing the input file. We don't write any output
until we have a file to write output to. */
output_cpp_line_info = 1;
/* Process each line in the array. */
for (i = 0; line = defs->lines->array[i]; i++)
{
defs->line_number = i;
if (*line == '$')
{
register int j;
char *directive;
HANDLER_ENTRY *handler;
/* Isolate the directive. */
for (j = 0; line[j] && !whitespace (line[j]); j++);
directive = xmalloc (j);
strncpy (directive, line + 1, j - 1);
directive[j -1] = '\0';
/* Get the function handler and call it. */
handler = find_directive (directive);
if (!handler)
{
line_error (defs, "Unknown directive `%s'", directive);
free (directive);
continue;
}
else
{
/* Advance to the first non-whitespace character. */
while (whitespace (line[j]))
j++;
/* Call the directive handler with the FILE, and ARGS. */
(*(handler->function)) (directive, defs, line + j);
}
free (directive);
}
else
{
if (building_builtin)
add_documentation (defs, line);
else if (defs->output)
{
if (output_cpp_line_info)
{
/* If we're handed an absolute pathname, don't prepend
the directory name. */
if (defs->filename[0] == '/')
fprintf (defs->output, "#line %d \"%s\"\n",
defs->line_number + 1, defs->filename);
else
fprintf (defs->output, "#line %d \"%s%s\"\n",
defs->line_number + 1,
error_directory ? error_directory : "./",
defs->filename);
output_cpp_line_info = 0;
}
fprintf (defs->output, "%s\n", line);
}
}
}
/* Close the production file. */
if (defs->output)
fclose (defs->output);
/* The file has been processed. Write the accumulated builtins to
the builtins.c file, and write the extern definitions to the
builtext.h file. */
write_builtins (defs, structfile, externfile);
free (buffer);
free_defs (defs);
}
#define free_safely(x) if (x) free (x)
static void
free_builtin (builtin)
BUILTIN_DESC *builtin;
{
register int i;
free_safely (builtin->name);
free_safely (builtin->function);
free_safely (builtin->shortdoc);
free_safely (builtin->docname);
if (builtin->longdoc)
array_free (builtin->longdoc);
if (builtin->dependencies)
{
for (i = 0; builtin->dependencies->array[i]; i++)
free (builtin->dependencies->array[i]);
array_free (builtin->dependencies);
}
}
/* Free all of the memory allocated to a DEF_FILE. */
void
free_defs (defs)
DEF_FILE *defs;
{
register int i;
register BUILTIN_DESC *builtin;
if (defs->production)
free (defs->production);
if (defs->lines)
array_free (defs->lines);
if (defs->builtins)
{
for (i = 0; builtin = (BUILTIN_DESC *)defs->builtins->array[i]; i++)
{
free_builtin (builtin);
free (builtin);
}
array_free (defs->builtins);
}
free (defs);
}
/* **************************************************************** */
/* */
/* The Handler Functions Themselves */
/* */
/* **************************************************************** */
/* Strip surrounding whitespace from STRING, and
return a pointer to the start of it. */
char *
strip_whitespace (string)
char *string;
{
while (whitespace (*string))
string++;
remove_trailing_whitespace (string);
return (string);
}
/* Remove only the trailing whitespace from STRING. */
void
remove_trailing_whitespace (string)
char *string;
{
register int i;
i = strlen (string) - 1;
while (i > 0 && whitespace (string[i]))
i--;
string[++i] = '\0';
}
/* Ensure that there is a argument in STRING and return it.
FOR_WHOM is the name of the directive which needs the argument.
DEFS is the DEF_FILE in which the directive is found.
If there is no argument, produce an error. */
char *
get_arg (for_whom, defs, string)
char *for_whom, *string;
DEF_FILE *defs;
{
char *new;
new = strip_whitespace (string);
if (!*new)
line_error (defs, "%s requires an argument", for_whom);
return (savestring (new));
}
/* Error if not building a builtin. */
void
must_be_building (directive, defs)
char *directive;
DEF_FILE *defs;
{
if (!building_builtin)
line_error (defs, "%s must be inside of a $BUILTIN block", directive);
}
/* Return the current builtin. */
BUILTIN_DESC *
current_builtin (directive, defs)
char *directive;
DEF_FILE *defs;
{
must_be_building (directive, defs);
if (defs->builtins)
return ((BUILTIN_DESC *)defs->builtins->array[defs->builtins->sindex - 1]);
else
return ((BUILTIN_DESC *)NULL);
}
/* Add LINE to the long documentation for the current builtin.
Ignore blank lines until the first non-blank line has been seen. */
void
add_documentation (defs, line)
DEF_FILE *defs;
char *line;
{
register BUILTIN_DESC *builtin;
builtin = current_builtin ("(implied LONGDOC)", defs);
remove_trailing_whitespace (line);
if (!*line && !builtin->longdoc)
return;
if (!builtin->longdoc)
builtin->longdoc = array_create (sizeof (char *));
array_add (line, builtin->longdoc);
}
/* How to handle the $BUILTIN directive. */
int
builtin_handler (self, defs, arg)
char *self;
DEF_FILE *defs;
char *arg;
{
BUILTIN_DESC *new;
char *name;
/* If we are already building a builtin, we cannot start a new one. */
if (building_builtin)
{
line_error (defs, "%s found before $END", self);
return (-1);
}
output_cpp_line_info++;
/* Get the name of this builtin, and stick it in the array. */
name = get_arg (self, defs, arg);
/* If this is the first builtin, create the array to hold them. */
if (!defs->builtins)
defs->builtins = array_create (sizeof (BUILTIN_DESC *));
new = (BUILTIN_DESC *)xmalloc (sizeof (BUILTIN_DESC));
new->name = name;
new->function = (char *)NULL;
new->shortdoc = (char *)NULL;
new->docname = (char *)NULL;
new->longdoc = (ARRAY *)NULL;
new->dependencies = (ARRAY *)NULL;
new->flags = 0;
if (is_special_builtin (name))
new->flags |= BUILTIN_FLAG_SPECIAL;
if (is_assignment_builtin (name))
new->flags |= BUILTIN_FLAG_ASSIGNMENT;
array_add ((char *)new, defs->builtins);
building_builtin = 1;
return (0);
}
/* How to handle the $FUNCTION directive. */
int
function_handler (self, defs, arg)
char *self;
DEF_FILE *defs;
char *arg;
{
register BUILTIN_DESC *builtin;
builtin = current_builtin (self, defs);
if (builtin == 0)
{
line_error (defs, "syntax error: no current builtin for $FUNCTION directive");
exit (1);
}
if (builtin->function)
line_error (defs, "%s already has a function (%s)",
builtin->name, builtin->function);
else
builtin->function = get_arg (self, defs, arg);
return (0);
}
/* How to handle the $DOCNAME directive. */
int
docname_handler (self, defs, arg)
char *self;
DEF_FILE *defs;
char *arg;
{
register BUILTIN_DESC *builtin;
builtin = current_builtin (self, defs);
if (builtin->docname)
line_error (defs, "%s already had a docname (%s)",
builtin->name, builtin->docname);
else
builtin->docname = get_arg (self, defs, arg);
return (0);
}
/* How to handle the $SHORT_DOC directive. */
int
short_doc_handler (self, defs, arg)
char *self;
DEF_FILE *defs;
char *arg;
{
register BUILTIN_DESC *builtin;
builtin = current_builtin (self, defs);
if (builtin->shortdoc)
line_error (defs, "%s already has short documentation (%s)",
builtin->name, builtin->shortdoc);
else
builtin->shortdoc = get_arg (self, defs, arg);
return (0);
}
/* How to handle the $COMMENT directive. */
int
comment_handler (self, defs, arg)
char *self;
DEF_FILE *defs;
char *arg;
{
return (0);
}
/* How to handle the $DEPENDS_ON directive. */
int
depends_on_handler (self, defs, arg)
char *self;
DEF_FILE *defs;
char *arg;
{
register BUILTIN_DESC *builtin;
char *dependent;
builtin = current_builtin (self, defs);
dependent = get_arg (self, defs, arg);
if (!builtin->dependencies)
builtin->dependencies = array_create (sizeof (char *));
array_add (dependent, builtin->dependencies);
return (0);
}
/* How to handle the $PRODUCES directive. */
int
produces_handler (self, defs, arg)
char *self;
DEF_FILE *defs;
char *arg;
{
/* If just hacking documentation, don't change any of the production
files. */
if (only_documentation)
return (0);
output_cpp_line_info++;
if (defs->production)
line_error (defs, "%s already has a %s definition", defs->filename, self);
else
{
defs->production = get_arg (self, defs, arg);
if (inhibit_production)
return (0);
defs->output = fopen (defs->production, "w");
if (!defs->output)
file_error (defs->production);
fprintf (defs->output, "/* %s, created from %s. */\n",
defs->production, defs->filename);
}
return (0);
}
/* How to handle the $END directive. */
int
end_handler (self, defs, arg)
char *self;
DEF_FILE *defs;
char *arg;
{
must_be_building (self, defs);
building_builtin = 0;
return (0);
}
/* **************************************************************** */
/* */
/* Error Handling Functions */
/* */
/* **************************************************************** */
/* Produce an error for DEFS with FORMAT and ARGS. */
void
line_error (defs, format, arg1, arg2)
DEF_FILE *defs;
char *format, *arg1, *arg2;
{
if (defs->filename[0] != '/')
fprintf (stderr, "%s", error_directory ? error_directory : "./");
fprintf (stderr, "%s:%d:", defs->filename, defs->line_number + 1);
fprintf (stderr, format, arg1, arg2);
fprintf (stderr, "\n");
fflush (stderr);
}
/* Print error message for FILENAME. */
void
file_error (filename)
char *filename;
{
perror (filename);
exit (2);
}
/* **************************************************************** */
/* */
/* xmalloc and xrealloc () */
/* */
/* **************************************************************** */
static void memory_error_and_abort ();
static char *
xmalloc (bytes)
int bytes;
{
char *temp = (char *)malloc (bytes);
if (!temp)
memory_error_and_abort ();
return (temp);
}
static char *
xrealloc (pointer, bytes)
char *pointer;
int bytes;
{
char *temp;
if (!pointer)
temp = (char *)malloc (bytes);
else
temp = (char *)realloc (pointer, bytes);
if (!temp)
memory_error_and_abort ();
return (temp);
}
static void
memory_error_and_abort ()
{
fprintf (stderr, "mkbuiltins: out of virtual memory\n");
abort ();
}
/* **************************************************************** */
/* */
/* Creating the Struct and Extern Files */
/* */
/* **************************************************************** */
/* Return a pointer to a newly allocated builtin which is
an exact copy of BUILTIN. */
BUILTIN_DESC *
copy_builtin (builtin)
BUILTIN_DESC *builtin;
{
BUILTIN_DESC *new;
new = (BUILTIN_DESC *)xmalloc (sizeof (BUILTIN_DESC));
new->name = savestring (builtin->name);
new->shortdoc = savestring (builtin->shortdoc);
new->longdoc = copy_string_array (builtin->longdoc);
new->dependencies = copy_string_array (builtin->dependencies);
new->function =
builtin->function ? savestring (builtin->function) : (char *)NULL;
new->docname =
builtin->docname ? savestring (builtin->docname) : (char *)NULL;
return (new);
}
/* How to save away a builtin. */
void
save_builtin (builtin)
BUILTIN_DESC *builtin;
{
BUILTIN_DESC *newbuiltin;
newbuiltin = copy_builtin (builtin);
/* If this is the first builtin to be saved, create the array
to hold it. */
if (!saved_builtins)
saved_builtins = array_create (sizeof (BUILTIN_DESC *));
array_add ((char *)newbuiltin, saved_builtins);
}
/* Flags that mean something to write_documentation (). */
#define STRING_ARRAY 1
#define TEXINFO 2
char *structfile_header[] = {
"/* builtins.c -- the built in shell commands. */",
"",
"/* This file is manufactured by ./mkbuiltins, and should not be",
" edited by hand. See the source to mkbuiltins for details. */",
"",
"/* Copyright (C) 1987, 1991, 1992 Free Software Foundation, Inc.",
"",
" This file is part of GNU Bash, the Bourne Again SHell.",
"",
" Bash is free software; you can redistribute it and/or modify it",
" under the terms of the GNU General Public License as published by",
" the Free Software Foundation; either version 2, or (at your option)",
" any later version.",
"",
" Bash is distributed in the hope that it will be useful, but WITHOUT",
" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY",
" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public",
" License for more details.",
"",
" You should have received a copy of the GNU General Public License",
" along with Bash; see the file COPYING. If not, write to the Free",
" Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */",
"",
"/* The list of shell builtins. Each element is name, function, flags,",
" long-doc, short-doc. The long-doc field contains a pointer to an array",
" of help lines. The function takes a WORD_LIST *; the first word in the",
" list is the first arg to the command. The list has already had word",
" expansion performed.",
"",
" Functions which need to look at only the simple commands (e.g.",
" the enable_builtin ()), should ignore entries where",
" (array[i].function == (sh_builtin_func_t *)NULL). Such entries are for",
" the list of shell reserved control structures, like `if' and `while'.",
" The end of the list is denoted with a NULL name field. */",
"",
"#include \"../builtins.h\"",
(char *)NULL
};
char *structfile_footer[] = {
" { (char *)0x0, (sh_builtin_func_t *)0x0, 0, (char **)0x0, (char *)0x0 }",
"};",
"",
"struct builtin *shell_builtins = static_shell_builtins;",
"struct builtin *current_builtin;",
"",
"int num_shell_builtins =",
"\tsizeof (static_shell_builtins) / sizeof (struct builtin) - 1;",
(char *)NULL
};
/* Write out any neccessary opening information for
STRUCTFILE and EXTERNFILE. */
void
write_file_headers (structfile, externfile)
FILE *structfile, *externfile;
{
register int i;
if (structfile)
{
for (i = 0; structfile_header[i]; i++)
fprintf (structfile, "%s\n", structfile_header[i]);
fprintf (structfile, "#include \"%s\"\n",
extern_filename ? extern_filename : "builtext.h");
fprintf (structfile, "\nstruct builtin static_shell_builtins[] = {\n");
}
if (externfile)
fprintf (externfile,
"/* %s - The list of builtins found in libbuiltins.a. */\n",
extern_filename ? extern_filename : "builtext.h");
}
/* Write out any necessary closing information for
STRUCTFILE and EXTERNFILE. */
void
write_file_footers (structfile, externfile)
FILE *structfile, *externfile;
{
register int i;
/* Write out the footers. */
if (structfile)
{
for (i = 0; structfile_footer[i]; i++)
fprintf (structfile, "%s\n", structfile_footer[i]);
}
}
/* Write out the information accumulated in DEFS to
STRUCTFILE and EXTERNFILE. */
void
write_builtins (defs, structfile, externfile)
DEF_FILE *defs;
FILE *structfile, *externfile;
{
register int i;
/* Write out the information. */
if (defs->builtins)
{
register BUILTIN_DESC *builtin;
for (i = 0; i < defs->builtins->sindex; i++)
{
builtin = (BUILTIN_DESC *)defs->builtins->array[i];
/* Write out any #ifdefs that may be there. */
if (!only_documentation)
{
if (builtin->dependencies)
{
write_ifdefs (externfile, builtin->dependencies->array);
write_ifdefs (structfile, builtin->dependencies->array);
}
/* Write the extern definition. */
if (externfile)
{
if (builtin->function)
fprintf (externfile, "extern int %s __P((WORD_LIST *));\n",
builtin->function);
fprintf (externfile, "extern char *%s_doc[];\n",
builtin->docname ? builtin->docname : builtin->name);
}
/* Write the structure definition. */
if (structfile)
{
fprintf (structfile, " { \"%s\", ", builtin->name);
if (builtin->function)
fprintf (structfile, "%s, ", builtin->function);
else
fprintf (structfile, "(sh_builtin_func_t *)0x0, ");
fprintf (structfile, "%s%s%s, %s_doc,\n",
"BUILTIN_ENABLED | STATIC_BUILTIN",
(builtin->flags & BUILTIN_FLAG_SPECIAL) ? " | SPECIAL_BUILTIN" : "",
(builtin->flags & BUILTIN_FLAG_ASSIGNMENT) ? " | ASSIGNMENT_BUILTIN" : "",
builtin->docname ? builtin->docname : builtin->name);
fprintf
(structfile, " \"%s\", (char *)NULL },\n",
builtin->shortdoc ? builtin->shortdoc : builtin->name);
/* Save away this builtin for later writing of the
long documentation strings. */
save_builtin (builtin);
}
/* Write out the matching #endif, if neccessary. */
if (builtin->dependencies)
{
if (externfile)
write_endifs (externfile, builtin->dependencies->array);
if (structfile)
write_endifs (structfile, builtin->dependencies->array);
}
}
if (documentation_file)
{
fprintf (documentation_file, "@item %s\n", builtin->name);
write_documentation
(documentation_file, builtin->longdoc->array, 0, TEXINFO);
}
}
}
}
/* Write out the long documentation strings in BUILTINS to STREAM. */
void
write_longdocs (stream, builtins)
FILE *stream;
ARRAY *builtins;
{
register int i;
register BUILTIN_DESC *builtin;
for (i = 0; i < builtins->sindex; i++)
{
builtin = (BUILTIN_DESC *)builtins->array[i];
if (builtin->dependencies)
write_ifdefs (stream, builtin->dependencies->array);
/* Write the long documentation strings. */
fprintf (stream, "char *%s_doc[] =",
builtin->docname ? builtin->docname : builtin->name);
write_documentation (stream, builtin->longdoc->array, 0, STRING_ARRAY);
if (builtin->dependencies)
write_endifs (stream, builtin->dependencies->array);
}
}
/* Write an #ifdef string saying what needs to be defined (or not defined)
in order to allow compilation of the code that will follow.
STREAM is the stream to write the information to,
DEFINES is a null terminated array of define names.
If a define is preceded by an `!', then the sense of the test is
reversed. */
void
write_ifdefs (stream, defines)
FILE *stream;
char **defines;
{
register int i;
if (!stream)
return;
fprintf (stream, "#if ");
for (i = 0; defines[i]; i++)
{
char *def = defines[i];
if (*def == '!')
fprintf (stream, "!defined (%s)", def + 1);
else
fprintf (stream, "defined (%s)", def);
if (defines[i + 1])
fprintf (stream, " && ");
}
fprintf (stream, "\n");
}
/* Write an #endif string saying what defines controlled the compilation
of the immediately preceding code.
STREAM is the stream to write the information to.
DEFINES is a null terminated array of define names. */
void
write_endifs (stream, defines)
FILE *stream;
char **defines;
{
register int i;
if (!stream)
return;
fprintf (stream, "#endif /* ");
for (i = 0; defines[i]; i++)
{
fprintf (stream, "%s", defines[i]);
if (defines[i + 1])
fprintf (stream, " && ");
}
fprintf (stream, " */\n");
}
/* Write DOCUMENTAION to STREAM, perhaps surrounding it with double-quotes
and quoting special characters in the string. */
void
write_documentation (stream, documentation, indentation, flags)
FILE *stream;
char **documentation;
int indentation, flags;
{
register int i, j;
register char *line;
int string_array, texinfo;
if (!stream)
return;
string_array = flags & STRING_ARRAY;
if (string_array)
fprintf (stream, " {\n#if defined (HELP_BUILTIN)\n");
#if !defined (OLDCODE)
/* XXX -- clean me up; for experiment only */
if (no_long_document)
goto end_of_document;
#endif /* !OLDCODE */
for (i = 0, texinfo = (flags & TEXINFO); line = documentation[i]; i++)
{
/* Allow #ifdef's to be written out verbatim. */
if (*line == '#')
{
if (string_array)
fprintf (stream, "%s\n", line);
continue;
}
if (string_array)
fprintf (stream, " \"");
if (indentation)
for (j = 0; j < indentation; j++)
fprintf (stream, " ");
if (string_array)
{
for (j = 0; line[j]; j++)
{
switch (line[j])
{
case '\\':
case '"':
fprintf (stream, "\\%c", line[j]);
break;
default:
fprintf (stream, "%c", line[j]);
}
}
fprintf (stream, "\",\n");
}
else if (texinfo)
{
for (j = 0; line[j]; j++)
{
switch (line[j])
{
case '@':
case '{':
case '}':
fprintf (stream, "@%c", line[j]);
break;
default:
fprintf (stream, "%c", line[j]);
}
}
fprintf (stream, "\n");
}
else
fprintf (stream, "%s\n", line);
}
#if !defined (OLDCODE)
end_of_document:
#endif /* !OLDCODE */
if (string_array)
fprintf (stream, "#endif /* HELP_BUILTIN */\n (char *)NULL\n};\n");
}
static int
_find_in_table (name, name_table)
char *name, *name_table[];
{
register int i;
for (i = 0; name_table[i]; i++)
if (strcmp (name, name_table[i]) == 0)
return 1;
return 0;
}
static int
is_special_builtin (name)
char *name;
{
return (_find_in_table (name, special_builtins));
}
static int
is_assignment_builtin (name)
char *name;
{
return (_find_in_table (name, assignment_builtins));
}
#if !defined (HAVE_RENAME)
static int
rename (from, to)
char *from, *to;
{
unlink (to);
if (link (from, to) < 0)
return (-1);
unlink (from);
return (0);
}
#endif /* !HAVE_RENAME */
|