1 /* misc - miscellaneous flex routines */
3 /* Copyright (c) 1990 The Regents of the University of California. */
4 /* All rights reserved. */
6 /* This code is derived from software contributed to Berkeley by */
9 /* The United States Government has rights in this work pursuant */
10 /* to contract no. DE-AC03-76SF00098 between the United States */
11 /* Department of Energy and the University of California. */
13 /* This file is part of flex. */
15 /* Redistribution and use in source and binary forms, with or without */
16 /* modification, are permitted provided that the following conditions */
19 /* 1. Redistributions of source code must retain the above copyright */
20 /* notice, this list of conditions and the following disclaimer. */
21 /* 2. Redistributions in binary form must reproduce the above copyright */
22 /* notice, this list of conditions and the following disclaimer in the */
23 /* documentation and/or other materials provided with the distribution. */
25 /* Neither the name of the University nor the names of its contributors */
26 /* may be used to endorse or promote products derived from this software */
27 /* without specific prior written permission. */
29 /* THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR */
30 /* IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED */
31 /* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR */
37 #define CMD_IF_TABLES_SER "%if-tables-serialization"
38 #define CMD_TABLES_YYDMAP "%tables-yydmap"
39 #define CMD_DEFINE_YYTABLES "%define-yytables"
40 #define CMD_IF_CPP_ONLY "%if-c++-only"
41 #define CMD_IF_C_ONLY "%if-c-only"
42 #define CMD_IF_C_OR_CPP "%if-c-or-c++"
43 #define CMD_NOT_FOR_HEADER "%not-for-header"
44 #define CMD_OK_FOR_HEADER "%ok-for-header"
45 #define CMD_PUSH "%push"
46 #define CMD_POP "%pop"
47 #define CMD_IF_REENTRANT "%if-reentrant"
48 #define CMD_IF_NOT_REENTRANT "%if-not-reentrant"
49 #define CMD_IF_BISON_BRIDGE "%if-bison-bridge"
50 #define CMD_IF_NOT_BISON_BRIDGE "%if-not-bison-bridge"
51 #define CMD_ENDIF "%endif"
53 /* we allow the skeleton to push and pop. */
55 bool dc
; /**< do_copy */
57 static struct sko_state
*sko_stack
=0;
58 static int sko_len
=0,sko_sz
=0;
59 static void sko_push(bool dc
)
63 sko_stack
= (struct sko_state
*)flex_alloc(sizeof(struct sko_state
)*sko_sz
);
65 flexfatal(_("allocation of sko_stack failed"));
68 if(sko_len
>= sko_sz
){
70 sko_stack
= (struct sko_state
*)flex_realloc(sko_stack
,sizeof(struct sko_state
)*sko_sz
);
73 /* initialize to zero and push */
74 sko_stack
[sko_len
].dc
= dc
;
77 static void sko_peek(bool *dc
)
80 flex_die("peek attempt when sko stack is empty");
82 *dc
= sko_stack
[sko_len
-1].dc
;
84 static void sko_pop(bool* dc
)
89 flex_die("popped too many times in skeleton.");
92 /* Append "#define defname value\n" to the running buffer. */
93 void action_define (defname
, value
)
100 if ((int) strlen (defname
) > MAXLINE
/ 2) {
101 format_pinpoint_message (_
102 ("name \"%s\" ridiculously long"),
107 snprintf (buf
, sizeof(buf
), "#define %s %d\n", defname
, value
);
110 /* track #defines so we can undef them when we're done. */
111 cpy
= copy_string (defname
);
112 buf_append (&defs_buf
, &cpy
, 1);
117 /** Append "m4_define([[defname]],[[value]])m4_dnl\n" to the running buffer.
118 * @param defname The macro name.
119 * @param value The macro value, can be NULL, which is the same as the empty string.
121 void action_m4_define (const char *defname
, const char * value
)
125 flexfatal ("DO NOT USE THIS FUNCTION!");
127 if ((int) strlen (defname
) > MAXLINE
/ 2) {
128 format_pinpoint_message (_
129 ("name \"%s\" ridiculously long"),
134 snprintf (buf
, sizeof(buf
), "m4_define([[%s]],[[%s]])m4_dnl\n", defname
, value
?value
:"");
139 /* Append "new_text" to the running buffer. */
140 void add_action (new_text
)
141 const char *new_text
;
143 int len
= strlen (new_text
);
145 while (len
+ action_index
>= action_size
- 10 /* slop */ ) {
146 int new_size
= action_size
* 2;
149 /* Increase just a little, to try to avoid overflow
150 * on 16-bit machines.
152 action_size
+= action_size
/ 8;
154 action_size
= new_size
;
157 reallocate_character_array (action_array
,
161 strcpy (&action_array
[action_index
], new_text
);
167 /* allocate_array - allocate memory for an integer array of the given size */
169 void *allocate_array (size
, element_size
)
174 size_t num_bytes
= element_size
* size
;
176 mem
= flex_alloc (num_bytes
);
179 ("memory allocation failed in allocate_array()"));
185 /* all_lower - true if a string is all lower-case */
191 if (!isascii ((Char
) * str
) || !islower ((Char
) * str
))
200 /* all_upper - true if a string is all upper-case */
206 if (!isascii ((Char
) * str
) || !isupper ((Char
) * str
))
215 /* intcmp - compares two integers for use by qsort. */
217 int intcmp (const void *a
, const void *b
)
219 return *(const int *) a
- *(const int *) b
;
223 /* check_char - checks a character to make sure it's within the range
224 * we're expecting. If not, generates fatal error message
232 lerrsf (_("bad character '%s' detected in check_char()"),
237 ("scanner requires -8 flag to use the character %s"),
243 /* clower - replace upper-case letter to lower-case */
248 return (Char
) ((isascii (c
) && isupper (c
)) ? tolower (c
) : c
);
252 /* copy_string - returns a dynamically allocated copy of a string */
254 char *copy_string (str
)
263 for (c1
= str
; *c1
; ++c1
) ;
265 size
= (c1
- str
+ 1) * sizeof (char);
267 copy
= (char *) flex_alloc (size
);
270 flexfatal (_("dynamic memory failure in copy_string()"));
272 for (c2
= copy
; (*c2
++ = *str
++) != 0;) ;
278 /* copy_unsigned_string -
279 * returns a dynamically allocated copy of a (potentially) unsigned string
282 Char
*copy_unsigned_string (str
)
289 for (c
= str
; *c
; ++c
) ;
291 copy
= allocate_Character_array (c
- str
+ 1);
293 for (c
= copy
; (*c
++ = *str
++) != 0;) ;
299 /* cclcmp - compares two characters for use by qsort with '\0' sorting last. */
301 int cclcmp (const void *a
, const void *b
)
303 if (!*(const Char
*) a
)
306 if (!*(const Char
*) b
)
309 return *(const Char
*) a
- *(const Char
*) b
;
313 /* dataend - finish up a block of data declarations */
317 /* short circuit any output */
323 /* add terminator for initialization; { for vi */
331 /* dataflush - flush generated data statements */
335 /* short circuit any output */
341 if (++dataline
>= NUMDATALINES
) {
342 /* Put out a blank line so that the table is grouped into
343 * large blocks that enable the user to find elements easily.
349 /* Reset the number of characters written on the current line. */
354 /* flexerror - report an error message and terminate */
359 fprintf (stderr
, "%s: %s\n", program_name
, msg
);
364 /* flexfatal - report a fatal error message and terminate */
369 fprintf (stderr
, _("%s: fatal internal error, %s\n"),
375 /* htoi - convert a hexadecimal digit string to an integer value */
382 (void) sscanf ((char *) str
, "%x", &result
);
388 /* lerrif - report an error message formatted with one integer argument */
390 void lerrif (msg
, arg
)
394 char errmsg
[MAXLINE
];
396 snprintf (errmsg
, sizeof(errmsg
), msg
, arg
);
401 /* lerrsf - report an error message formatted with one string argument */
403 void lerrsf (msg
, arg
)
404 const char *msg
, arg
[];
406 char errmsg
[MAXLINE
];
408 snprintf (errmsg
, sizeof(errmsg
)-1, msg
, arg
);
409 errmsg
[sizeof(errmsg
)-1] = 0; /* ensure NULL termination */
414 /* lerrsf_fatal - as lerrsf, but call flexfatal */
416 void lerrsf_fatal (msg
, arg
)
417 const char *msg
, arg
[];
419 char errmsg
[MAXLINE
];
421 snprintf (errmsg
, sizeof(errmsg
)-1, msg
, arg
);
422 errmsg
[sizeof(errmsg
)-1] = 0; /* ensure NULL termination */
427 /* line_directive_out - spit out a "#line" statement */
429 void line_directive_out (output_file
, do_infile
)
433 char directive
[MAXLINE
], filename
[MAXLINE
];
435 static const char *line_fmt
= "#line %d \"%s\"\n";
440 s1
= do_infile
? infilename
: "M4_YY_OUTFILE_NAME";
442 if (do_infile
&& !s1
)
446 s3
= &filename
[sizeof (filename
) - 2];
448 while (s2
< s3
&& *s1
) {
459 snprintf (directive
, sizeof(directive
), line_fmt
, linenum
, filename
);
461 snprintf (directive
, sizeof(directive
), line_fmt
, 0, filename
);
464 /* If output_file is nil then we should put the directive in
465 * the accumulated actions.
468 fputs (directive
, output_file
);
471 add_action (directive
);
475 /* mark_defs1 - mark the current position in the action array as
476 * representing where the user's section 1 definitions end
477 * and the prolog begins
482 action_array
[action_index
++] = '\0';
483 action_offset
= prolog_offset
= action_index
;
484 action_array
[action_index
] = '\0';
488 /* mark_prolog - mark the current position in the action array as
489 * representing the end of the action prolog
493 action_array
[action_index
++] = '\0';
494 action_offset
= action_index
;
495 action_array
[action_index
] = '\0';
499 /* mk2data - generate a data statement for a two-dimensional array
501 * Generates a data statement initializing the current 2-D array to "value".
506 /* short circuit any output */
510 if (datapos
>= NUMDATAITEMS
) {
524 out_dec ("%5d", value
);
528 /* mkdata - generate a data statement
530 * Generates a data statement initializing the current array element to
536 /* short circuit any output */
540 if (datapos
>= NUMDATAITEMS
) {
553 out_dec ("%5d", value
);
557 /* myctoi - return the integer represented by a string of digits */
564 (void) sscanf (array
, "%d", &val
);
570 /* myesc - return character corresponding to escape sequence */
589 #if defined (__STDC__)
612 while (isascii (array
[sptr
]) &&
613 isdigit (array
[sptr
]))
614 /* Don't increment inside loop control
615 * because if isdigit() is a macro it might
616 * expand into multiple increments ...
623 esc_char
= otoi (array
+ 1);
634 while (isascii (array
[sptr
]) &&
635 isxdigit (array
[sptr
]))
636 /* Don't increment inside loop control
637 * because if isdigit() is a macro it might
638 * expand into multiple increments ...
645 esc_char
= htoi (array
+ 2);
658 /* otoi - convert an octal digit string to an integer value */
665 (void) sscanf ((char *) str
, "%o", &result
);
670 /* out - various flavors of outputing a (possibly formatted) string for the
671 * generated scanner, keeping track of the line count.
680 void out_dec (fmt
, n
)
684 fprintf (stdout
, fmt
, n
);
687 void out_dec2 (fmt
, n1
, n2
)
691 fprintf (stdout
, fmt
, n1
, n2
);
694 void out_hex (fmt
, x
)
698 fprintf (stdout
, fmt
, x
);
701 void out_str (fmt
, str
)
702 const char *fmt
, str
[];
704 fprintf (stdout
,fmt
, str
);
707 void out_str3 (fmt
, s1
, s2
, s3
)
708 const char *fmt
, s1
[], s2
[], s3
[];
710 fprintf (stdout
,fmt
, s1
, s2
, s3
);
713 void out_str_dec (fmt
, str
, n
)
714 const char *fmt
, str
[];
717 fprintf (stdout
,fmt
, str
, n
);
733 /** Print "m4_define( [[def]], [[val]])m4_dnl\n".
734 * @param def The m4 symbol to define.
735 * @param val The definition; may be NULL.
738 void out_m4_define (const char* def
, const char* val
)
740 const char * fmt
= "m4_define( [[%s]], [[%s]])m4_dnl\n";
741 fprintf(stdout
, fmt
, def
, val
?val
:"");
745 /* readable_form - return the human-readable form of a character
747 * The returned string is in static storage.
750 char *readable_form (c
)
753 static char rform
[10];
755 if ((c
>= 0 && c
< 32) || c
>= 127) {
768 #if defined (__STDC__)
776 snprintf (rform
, sizeof(rform
), "\\%.3o", (unsigned int) c
);
793 /* reallocate_array - increase the size of a dynamic array */
795 void *reallocate_array (array
, size
, element_size
)
801 size_t num_bytes
= element_size
* size
;
803 new_array
= flex_realloc (array
, num_bytes
);
805 flexfatal (_("attempt to increase array size failed"));
811 /* skelout - write out one section of the skeleton file
814 * Copies skelfile or skel array to stdout until a line beginning with
815 * "%%" or EOF is found.
819 char buf_storage
[MAXLINE
];
820 char *buf
= buf_storage
;
823 /* "reset" the state by clearing the buffer and pushing a '1' */
827 sko_push(do_copy
=true);
830 /* Loop pulling lines either from the skelfile, if we're using
831 * one, or from the skel[] array.
834 (fgets (buf
, MAXLINE
, skelfile
) != NULL
) :
835 ((buf
= (char *) skel
[skel_ind
++]) != 0)) {
840 /* copy from skel array */
841 if (buf
[0] == '%') { /* control line */
842 /* print the control line as a comment. */
843 if (ddebug
&& buf
[1] != '#') {
844 if (buf
[strlen (buf
) - 1] == '\\')
845 out_str ("/* %s */\\\n", buf
);
847 out_str ("/* %s */\n", buf
);
850 /* We've been accused of using cryptic markers in the skel.
851 * So we'll use emacs-style-hyphenated-commands.
852 * We might consider a hash if this if-else-if-else
853 * chain gets too large.
855 #define cmd_match(s) (strncmp(buf,(s),strlen(s))==0)
858 /* %% is a break point for skelout() */
861 else if (cmd_match (CMD_PUSH
)){
864 out_str("/*(state = (%s) */",do_copy
?"true":"false");
866 out_str("%s\n", buf
[strlen (buf
) - 1] =='\\' ? "\\" : "");
868 else if (cmd_match (CMD_POP
)){
871 out_str("/*(state = (%s) */",do_copy
?"true":"false");
873 out_str("%s\n", buf
[strlen (buf
) - 1] =='\\' ? "\\" : "");
875 else if (cmd_match (CMD_IF_REENTRANT
)){
877 do_copy
= reentrant
&& do_copy
;
879 else if (cmd_match (CMD_IF_NOT_REENTRANT
)){
881 do_copy
= !reentrant
&& do_copy
;
883 else if (cmd_match(CMD_IF_BISON_BRIDGE
)){
885 do_copy
= bison_bridge_lval
&& do_copy
;
887 else if (cmd_match(CMD_IF_NOT_BISON_BRIDGE
)){
889 do_copy
= !bison_bridge_lval
&& do_copy
;
891 else if (cmd_match (CMD_ENDIF
)){
894 else if (cmd_match (CMD_IF_TABLES_SER
)) {
895 do_copy
= do_copy
&& tablesext
;
897 else if (cmd_match (CMD_TABLES_YYDMAP
)) {
898 if (tablesext
&& yydmap_buf
.elts
)
899 outn ((char *) (yydmap_buf
.elts
));
901 else if (cmd_match (CMD_DEFINE_YYTABLES
)) {
902 out_str("#define YYTABLES_NAME \"%s\"\n",
903 tablesname
?tablesname
:"yytables");
905 else if (cmd_match (CMD_IF_CPP_ONLY
)) {
908 do_copy
= C_plus_plus
;
910 else if (cmd_match (CMD_IF_C_ONLY
)) {
913 do_copy
= !C_plus_plus
;
915 else if (cmd_match (CMD_IF_C_OR_CPP
)) {
916 /* %* for C and C++ */
920 else if (cmd_match (CMD_NOT_FOR_HEADER
)) {
921 /* %c begin linkage-only (non-header) code. */
924 else if (cmd_match (CMD_OK_FOR_HEADER
)) {
925 /* %e end linkage-only code. */
928 else if (buf
[1] == '#') {
929 /* %# a comment in the skel. ignore. */
932 flexfatal (_("bad line in skeleton file"));
942 /* transition_struct_out - output a yy_trans_info structure
944 * outputs the yy_trans_info structure with the two elements, element_v and
945 * element_n. Formats the output with spaces and carriage returns.
948 void transition_struct_out (element_v
, element_n
)
949 int element_v
, element_n
;
952 /* short circuit any output */
956 out_dec2 (" {%4d,%4d },", element_v
, element_n
);
958 datapos
+= TRANS_STRUCT_PRINT_LENGTH
;
960 if (datapos
>= 79 - TRANS_STRUCT_PRINT_LENGTH
) {
963 if (++dataline
% 10 == 0)
971 /* The following is only needed when building flex's parser using certain
972 * broken versions of bison.
974 void *yy_flex_xmalloc (size
)
977 void *result
= flex_alloc ((size_t) size
);
981 ("memory allocation failed in yy_flex_xmalloc()"));
987 /* zero_out - set a region of memory to 0
989 * Sets region_ptr[0] through region_ptr[size_in_bytes - 1] to zero.
992 void zero_out (region_ptr
, size_in_bytes
)
994 size_t size_in_bytes
;
999 rp_end
= region_ptr
+ size_in_bytes
;
1005 /* Remove all '\n' and '\r' characters, if any, from the end of str.
1006 * str can be any null-terminated string, or NULL.
1013 if (!str
|| !*str
) /* s is null or empty string */
1016 /* find end of string minus one */
1022 while (p
>= str
&& (*p
== '\r' || *p
== '\n'))