4 Test to see if a particular fix should be applied to a header file.
6 Copyright (C) 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
8 = = = = = = = = = = = = = = = = = = = = = = = = =
12 The routines you write here must work closely with fixincl.c.
16 1. Every test procedure name must be suffixed with "_fix".
17 These routines will be referenced from inclhack.def, sans the suffix.
19 2. Use the "FIX_PROC_HEAD()" macro _with_ the "_fix" suffix
20 (I cannot use the ## magic from ANSI C) for defining your entry point.
22 3. Put your test name into the FIXUP_TABLE.
24 4. Do not read anything from stdin. It is closed.
26 5. Write to stderr only in the event of a reportable error
27 In such an event, call "exit (EXIT_FAILURE)".
29 6. You have access to the fixDescList entry for the fix in question.
30 This may be useful, for example, if there are interesting strings
31 or pre-compiled regular expressions stored there.
33 It is also possible to access fix descriptions by using the
34 index of a known fix, "my_fix_name" for example:
36 tFixDesc* p_desc = fixDescList + MY_FIX_NAME_FIXIDX;
37 tTestDesc* p_tlist = p_desc->p_test_desc;
39 regexec (p_tlist->p_test_regex, ...)
41 = = = = = = = = = = = = = = = = = = = = = = = = =
43 This file is part of GNU CC.
45 GNU CC is free software; you can redistribute it and/or modify
46 it under the terms of the GNU General Public License as published by
47 the Free Software Foundation; either version 2, or (at your option)
50 GNU CC is distributed in the hope that it will be useful,
51 but WITHOUT ANY WARRANTY; without even the implied warranty of
52 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
53 GNU General Public License for more details.
55 You should have received a copy of the GNU General Public License
56 along with GNU CC; see the file COPYING. If not, write to
57 the Free Software Foundation, 59 Temple Place - Suite 330,
58 Boston, MA 02111-1307, USA. */
63 #ifdef SEPARATE_FIX_PROC
67 tSCC zNeedsArg[] = "fixincl error: `%s' needs %s argument (c_fix_arg[%d])\n";
69 typedef void t_fix_proc PARAMS ((const char *, const char *, tFixDesc *));
76 _FT_( "char_macro_def", char_macro_def_fix ) \
77 _FT_( "char_macro_use", char_macro_use_fix ) \
78 _FT_( "format", format_fix ) \
79 _FT_( "machine_name", machine_name_fix ) \
80 _FT_( "wrap", wrap_fix ) \
81 _FT_( "gnu_type", gnu_type_fix )
84 #define FIX_PROC_HEAD( fix ) \
85 static void fix PARAMS ((const char *, const char *, tFixDesc *)); /* avoid warning */ \
86 static void fix ( filname, text, p_fixd ) \
87 const char* filname; \
91 #ifdef NEED_PRINT_QUOTE
93 * Skip over a quoted string. Single quote strings may
94 * contain multiple characters if the first character is
95 * a backslash. Especially a backslash followed by octal digits.
96 * We are not doing a correctness syntax check here.
99 print_quote( q, text )
116 fputc( *(text++), stdout );
133 #endif /* NEED_PRINT_QUOTE */
137 * Emit the GNU standard type wrapped up in such a way that
138 * this thing can be encountered countless times during a compile
139 * and not cause even a warning.
141 static const char *emit_gnu_type PARAMS ((const char *, regmatch_t *));
143 emit_gnu_type ( text, rm )
150 fwrite (text, rm[0].rm_so, 1, stdout);
153 const char* ps = text + rm[1].rm_so;
154 const char* pe = text + rm[1].rm_eo;
159 *(pD++) = toupper( *(pd++) = *(ps++) );
165 * Now print out the reformed typedef,
166 * with a C++ guard for WCHAR
170 #if !defined(_GCC_%s_T)%s\n\
172 typedef __%s_TYPE__ %s_t;\n\
175 const char* pz_guard = (strcmp (z_type, "wchar") == 0)
176 ? " && ! defined(__cplusplus)" : "";
178 printf (z_fmt, z_TYPE, pz_guard, z_TYPE, z_TYPE, z_type);
181 return text += rm[0].rm_eo;
186 * Copy the `format' string to std out, replacing `%n' expressions
187 * with the matched text from a regular expression evaluation.
188 * Doubled '%' characters will be replaced with a single copy.
189 * '%' characters in other contexts and all other characters are
190 * copied out verbatim.
192 static void format_write PARAMS ((tCC *, tCC *, regmatch_t[]));
194 format_write (format, text, av)
201 while ((c = (unsigned)*(format++)) != NUL) {
209 c = (unsigned)*(format++);
212 * IF the character following a '%' is not a digit,
213 * THEN we will always emit a '%' and we may or may
214 * not emit the following character. We will end on
215 * a NUL and we will emit only one of a pair of '%'.
231 * Emit the matched subexpression numbered 'c'.
232 * IF, of course, there was such a match...
235 regmatch_t* pRM = av + (c - (unsigned)'0');
241 len = pRM->rm_eo - pRM->rm_so;
243 fwrite(text + pRM->rm_so, len, 1, stdout);
250 * Search for multiple copies of a regular expression. Each block
251 * of matched text is replaced with the format string, as described
252 * above in `format_write'.
254 FIX_PROC_HEAD( format_fix )
256 tCC* pz_pat = p_fixd->patch_args[2];
257 tCC* pz_fmt = p_fixd->patch_args[1];
262 * We must have a format
264 if (pz_fmt == (tCC*)NULL)
266 fprintf( stderr, zNeedsArg, p_fixd->fix_name, "replacement format", 0 );
271 * IF we don't have a search text, then go find the first
272 * regular expression among the tests.
274 if (pz_pat == (tCC*)NULL)
276 tTestDesc* pTD = p_fixd->p_test_desc;
277 int ct = p_fixd->test_ct;
282 fprintf( stderr, zNeedsArg, p_fixd->fix_name, "search text", 1 );
286 if (pTD->type == TT_EGREP)
288 pz_pat = pTD->pz_test_text;
297 * Replace every copy of the text we find
299 compile_re (pz_pat, &re, 1, "format search-text", "format_fix" );
300 while (regexec (&re, text, 10, rm, 0) == 0)
302 fwrite( text, rm[0].rm_so, 1, stdout );
303 format_write( pz_fmt, text, rm );
308 * Dump out the rest of the file
310 fputs (text, stdout);
314 /* Scan the input file for all occurrences of text like this:
316 #define TIOCCONS _IO(T, 12)
318 and change them to read like this:
320 #define TIOCCONS _IO('T', 12)
322 which is the required syntax per the C standard. (The definition of
323 _IO also has to be tweaked - see below.) 'IO' is actually whatever you
324 provide as the `c_fix_arg' argument. */
326 FIX_PROC_HEAD( char_macro_use_fix )
328 /* This regexp looks for a traditional-syntax #define (# in column 1)
329 of an object-like macro. */
330 static const char pat[] =
331 "^#[ \t]*define[ \t]+[_A-Za-z][_A-Za-z0-9]*[ \t]+";
334 const char* str = p_fixd->patch_args[1];
336 const char *p, *limit;
341 fprintf (stderr, zNeedsArg, p_fixd->fix_name, "ioctl type", 0);
346 compile_re (pat, &re, 1, "macro pattern", "char_macro_use_fix");
349 regexec (&re, p, 1, rm, 0) == 0;
352 /* p + rm[0].rm_eo is the first character of the macro replacement.
353 Find the end of the macro replacement, and the STR we were
354 sent to look for within the replacement. */
359 limit = strchr (limit + 1, '\n');
363 while (limit[-1] == '\\');
367 if (*p == str[0] && !strncmp (p+1, str+1, len-1))
370 while (++p < limit - len);
371 /* Hit end of line. */
375 /* Found STR on this line. If the macro needs fixing,
376 the next few chars will be whitespace or uppercase,
377 then an open paren, then a single letter. */
378 while ((ISSPACE (*p) || ISUPPER (*p)) && p < limit) p++;
383 if (ISALNUM (p[1]) || p[1] == '_')
386 /* Splat all preceding text into the output buffer,
387 quote the character at p, then proceed. */
388 fwrite (text, 1, p - text, stdout);
395 fputs (text, stdout);
399 /* Scan the input file for all occurrences of text like this:
401 #define xxxIOxx(x, y) (....'x'<<16....)
403 and change them to read like this:
405 #define xxxIOxx(x, y) (....x<<16....)
407 which is the required syntax per the C standard. (The uses of _IO
408 also has to be tweaked - see above.) 'IO' is actually whatever
409 you provide as the `c_fix_arg' argument. */
410 FIX_PROC_HEAD( char_macro_def_fix )
412 /* This regexp looks for any traditional-syntax #define (# in column 1). */
413 static const char pat[] =
414 "^#[ \t]*define[ \t]+";
417 const char* str = p_fixd->patch_args[1];
419 const char *p, *limit;
425 fprintf (stderr, zNeedsArg, p_fixd->fix_name, "ioctl type", 0);
430 compile_re (pat, &re, 1, "macro pattern", "fix_char_macro_defines");
433 regexec (&re, p, 1, rm, 0) == 0;
436 /* p + rm[0].rm_eo is the first character of the macro name.
437 Find the end of the macro replacement, and the STR we were
438 sent to look for within the name. */
443 limit = strchr (limit + 1, '\n');
447 while (limit[-1] == '\\');
451 if (*p == str[0] && !strncmp (p+1, str+1, len-1))
455 while (ISALPHA (*p) || ISALNUM (*p) || *p == '_');
456 /* Hit end of macro name without finding the string. */
460 /* Found STR in this macro name. If the macro needs fixing,
461 there may be a few uppercase letters, then there will be an
462 open paren with _no_ intervening whitespace, and then a
464 while (ISUPPER (*p) && p < limit) p++;
469 if (ISALNUM (p[1]) || p[1] == '_')
472 /* The character at P is the one to look for in the following
479 if (p[-1] == '\'' && p[0] == arg && p[1] == '\'')
481 /* Remove the quotes from this use of ARG. */
483 fwrite (text, 1, p - text, stdout);
493 fputs (text, stdout);
496 /* Fix for machine name #ifdefs that are not in the namespace reserved
497 by the C standard. They won't be defined if compiling with -ansi,
498 and the headers will break. We go to some trouble to only change
499 #ifdefs where the macro is defined by GCC in non-ansi mode; this
500 minimizes the number of headers touched. */
502 #define SCRATCHSZ 64 /* hopefully long enough */
504 FIX_PROC_HEAD( machine_name_fix )
507 fputs( "The target machine has no needed machine name fixes\n", stderr );
510 const char *line, *base, *limit, *p, *q;
511 regex_t *label_re, *name_re;
512 char scratch[SCRATCHSZ];
515 mn_get_regexps (&label_re, &name_re, "machine_name_fix");
521 regexec (label_re, base, 2, match, 0) == 0;
524 base += match[0].rm_eo;
525 /* We're looking at an #if or #ifdef. Scan forward for the
526 next non-escaped newline. */
531 limit = strchr (limit, '\n');
535 while (limit[-1] == '\\');
537 /* If the 'name_pat' matches in between base and limit, we have
538 a bogon. It is not worth the hassle of excluding comments
539 because comments on #if/#ifdef lines are rare, and strings on
540 such lines are illegal.
542 REG_NOTBOL means 'base' is not at the beginning of a line, which
543 shouldn't matter since the name_re has no ^ anchor, but let's
544 be accurate anyway. */
552 if (regexec (name_re, base, 1, match, REG_NOTBOL))
553 goto done; /* No remaining match in this file */
555 /* Match; is it on the line? */
556 if (match[0].rm_eo > limit - base)
559 p = base + match[0].rm_so;
560 base += match[0].rm_eo;
562 /* One more test: if on the same line we have the same string
563 with the appropriate underscores, then leave it alone.
564 We want exactly two leading and trailing underscores. */
567 len = base - p - ((*base == '_') ? 2 : 1);
572 len = base - p - ((*base == '_') ? 1 : 0);
575 if (len + 4 > SCRATCHSZ)
577 memcpy (&scratch[2], q, len);
579 scratch[len++] = '_';
580 scratch[len++] = '_';
582 for (q = line; q <= limit - len; q++)
583 if (*q == '_' && !strncmp (q, scratch, len))
586 fwrite (text, 1, p - text, stdout);
587 fwrite (scratch, 1, len, stdout);
594 fputs (text, stdout);
598 FIX_PROC_HEAD( wrap_fix )
600 tSCC z_no_wrap_pat[] = "^#if.*__need_";
601 static regex_t no_wrapping_re = { NULL, 0, 0 };
603 char z_fixname[ 64 ];
604 tCC* pz_src = p_fixd->fix_name;
605 tCC* pz_name = z_fixname;
606 char* pz_dst = z_fixname;
610 if (no_wrapping_re.allocated == 0)
611 compile_re( z_no_wrap_pat, &no_wrapping_re, 0, "no-wrap pattern",
615 char ch = *(pz_src++);
618 *(pz_dst++) = TOUPPER ( ch );
620 else if (ISALNUM ( ch ))
623 else if (ch == NUL) {
630 if (++len >= sizeof( z_fixname )) {
631 void* p = xmalloc( len + strlen( pz_src ) + 1 );
632 memcpy( p, (void*)z_fixname, len );
634 pz_dst = (char*)pz_name + len;
639 * IF we do *not* match the no-wrap re, then we have a double negative.
640 * A double negative means YES.
642 if (regexec (&no_wrapping_re, text, 0, NULL, 0) != 0)
644 printf( "#ifndef FIXINC_%s_CHECK\n", pz_name );
645 printf( "#define FIXINC_%s_CHECK 1\n\n", pz_name );
649 if (p_fixd->patch_args[1] == (tCC*)NULL)
650 fputs( text, stdout );
653 fputs( p_fixd->patch_args[1], stdout );
654 fputs( text, stdout );
655 if (p_fixd->patch_args[2] != (tCC*)NULL)
656 fputs( p_fixd->patch_args[2], stdout );
660 printf( "\n#endif /* FIXINC_%s_CHECK */\n", pz_name );
662 if (pz_name != z_fixname)
663 free( (void*)pz_name );
668 * Search for multiple copies of a regular expression. Each block
669 * of matched text is replaced with the format string, as described
670 * above in `format_write'.
672 FIX_PROC_HEAD( gnu_type_fix )
676 regmatch_t rm[GTYPE_SE_CT+1];
679 tTestDesc* pTD = p_fixd->p_test_desc;
680 int ct = p_fixd->test_ct;
685 fprintf (stderr, zNeedsArg, p_fixd->fix_name, "search text", 1);
689 if (pTD->type == TT_EGREP)
691 pz_pat = pTD->pz_test_text;
699 compile_re (pz_pat, &re, 1, "gnu type typedef", "gnu_type_fix");
701 while (regexec (&re, text, GTYPE_SE_CT+1, rm, 0) == 0)
703 text = emit_gnu_type (text, rm);
707 * Dump out the rest of the file
709 fputs (text, stdout);
713 /* = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
715 test for fix selector
717 THIS IS THE ONLY EXPORTED ROUTINE
721 apply_fix( p_fixd, filname )
725 #define _FT_(n,p) { n, p },
726 static fix_entry_t fix_table[] = { FIXUP_TABLE { NULL, NULL }};
728 #define FIX_TABLE_CT (ARRAY_SIZE (fix_table)-1)
730 tCC* fixname = p_fixd->patch_args[0];
732 int ct = FIX_TABLE_CT;
733 fix_entry_t* pfe = fix_table;
737 if (strcmp (pfe->fix_name, fixname) == 0)
741 fprintf (stderr, "fixincl error: the `%s' fix is unknown\n",
748 buf = load_file_data (stdin);
749 (*pfe->fix_proc)( filname, buf, p_fixd );
752 #ifdef SEPARATE_FIX_PROC
754 "USAGE: applyfix <fix-name> <file-to-fix> <file-source> <file-destination>\n";
756 "FS error %d (%s) reopening %s as std%s\n";
771 fputs (z_usage, stderr);
779 if (! ISDIGIT ( *pz ))
782 idx = strtol (pz, &pz, 10);
783 if ((*pz != NUL) || ((unsigned)idx >= FIX_COUNT))
785 pFix = fixDescList + idx;
788 if (freopen (argv[3], "r", stdin) != stdin)
790 fprintf (stderr, z_reopen, errno, strerror( errno ), argv[3], "in");
794 pz_tmptmp = (char*)xmalloc( strlen( argv[4] ) + 5 );
795 strcpy( pz_tmptmp, argv[4] );
797 /* Don't lose because "12345678" and "12345678X" map to the same
798 file under DOS restricted 8+3 file namespace. Note that DOS
799 doesn't allow more than one dot in the trunk of a file name. */
800 pz_tmp_base = basename( pz_tmptmp );
801 pz_tmp_dot = strchr( pz_tmp_base, '.' );
802 if (pathconf( pz_tmptmp, _PC_NAME_MAX ) <= 12 /* is this DOS or Windows9X? */
803 && pz_tmp_dot != (char*)NULL)
804 strcpy (pz_tmp_dot+1, "X"); /* nuke the original extension */
806 strcat (pz_tmptmp, ".X");
807 if (freopen (pz_tmptmp, "w", stdout) != stdout)
809 fprintf (stderr, z_reopen, errno, strerror( errno ), pz_tmptmp, "out");
813 apply_fix (pFix, argv[1]);
817 if (rename (pz_tmptmp, argv[4]) != 0)
819 fprintf (stderr, "error %d (%s) renaming %s to %s\n", errno,
820 strerror( errno ), pz_tmptmp, argv[4]);