fixincludes/fixtests.c

   1
   2 /*
   3
   4    Test to see if a particular fix should be applied to a header file.
   5
   6    Copyright (C) 1997, 1998, 1999, 2000, 2009, 2012
   7    Free Software Foundation, Inc.
   8
   9 = = = = = = = = = = = = = = = = = = = = = = = = =
  10
  11 NOTE TO DEVELOPERS
  12
  13 The routines you write here must work closely with fixincl.c.
  14
  15 Here are the rules:
  16
  17 1.  Every test procedure name must be suffixed with "_test".
  18     These routines will be referenced from inclhack.def, sans the suffix.
  19
  20 2.  Use the "TEST_FOR_FIX_PROC_HEAD()" macro _with_ the "_test" suffix
  21     (I cannot use the ## magic from ANSI C) for defining your entry point.
  22
  23 3.  Put your test name into the FIX_TEST_TABLE
  24
  25 4.  Do not write anything to stdout.  It may be closed.
  26
  27 5.  Write to stderr only in the event of a reportable error
  28     In such an event, call "exit(1)".
  29
  30 = = = = = = = = = = = = = = = = = = = = = = = = =
  31
  32 This file is part of GCC.
  33
  34 GCC is free software; you can redistribute it and/or modify
  35 it under the terms of the GNU General Public License as published by
  36 the Free Software Foundation; either version 3, or (at your option)
  37 any later version.
  38
  39 GCC is distributed in the hope that it will be useful,
  40 but WITHOUT ANY WARRANTY; without even the implied warranty of
  41 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  42 GNU General Public License for more details.
  43
  44 You should have received a copy of the GNU General Public License
  45 along with GCC; see the file COPYING3.  If not see
  46 <http://www.gnu.org/licenses/>.  */
  47
  48 #include "fixlib.h"
  49
  50 #define _ENV_(v,m,n,t)   extern char const * v;
  51 ENV_TABLE
  52 #undef _ENV_
  53
  54 typedef apply_fix_p_t t_test_proc ( tCC* file, tCC* text );
  55
  56 typedef struct {
  57     tCC*         test_name;
  58     t_test_proc* test_proc;
  59 } test_entry_t;
  60
  61 #define FIX_TEST_TABLE                                                  \
  62   _FT_( "machine_name",     machine_name_test )                         \
  63   _FT_( "stdc_0_in_system_headers",    stdc_0_in_system_headers_test )
  64
  65 #define TEST_FOR_FIX_PROC_HEAD( test ) \
  66 static apply_fix_p_t test ( tCC* fname ATTRIBUTE_UNUSED, \
  67                             tCC* text  ATTRIBUTE_UNUSED )
  68
  69 TEST_FOR_FIX_PROC_HEAD( machine_name_test )
  70 {
  71   regex_t *label_re, *name_re;
  72   regmatch_t match[2];
  73   tCC *base, *limit;
  74   IGNORE_ARG(fname);
  75
  76   if (!mn_get_regexps (&label_re, &name_re, "machine_name_test"))
  77     return SKIP_FIX;
  78
  79   for (base = text;
  80        xregexec (label_re, base, 2, match, 0) == 0;
  81        base = limit)
  82     {
  83       base += match[0].rm_eo;
  84       /* We're looking at an #if or #ifdef.  Scan forward for the
  85          next non-escaped newline.  */
  86       limit = base;
  87       do
  88         {
  89           limit++;
  90           limit = strchr (limit, '\n');
  91           if (!limit)
  92             return SKIP_FIX;
  93         }
  94       while (limit[-1] == '\\');
  95
  96       /* If the 'name_pat' matches in between base and limit, we have
  97          a bogon.  It is not worth the hassle of excluding comments,
  98          because comments on #if/#ifdef/#ifndef lines are rare,
  99          and strings on such lines are illegal.
 100
 101          REG_NOTBOL means 'base' is not at the beginning of a line, which
 102          shouldn't matter since the name_re has no ^ anchor, but let's
 103          be accurate anyway.  */
 104
 105       if (xregexec (name_re, base, 1, match, REG_NOTBOL))
 106         return SKIP_FIX;  /* No match in file - no fix needed */
 107
 108       /* Match; is it on the line?  */
 109       if (match[0].rm_eo <= limit - base)
 110         return APPLY_FIX;  /* Yup */
 111
 112       /* Otherwise, keep looking... */
 113     }
 114   return SKIP_FIX;
 115 }
 116
 117
 118 TEST_FOR_FIX_PROC_HEAD( stdc_0_in_system_headers_test )
 119 {
 120 #ifdef STDC_0_IN_SYSTEM_HEADERS
 121   return (pz_machine == NULL) ? APPLY_FIX : SKIP_FIX;
 122 #else
 123   return APPLY_FIX;
 124 #endif
 125 }
 126
 127
 128 /* = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
 129
 130      test for fix selector
 131
 132      THIS IS THE ONLY EXPORTED ROUTINE
 133
 134 */
 135 apply_fix_p_t
 136 run_test( tCC* tname, tCC* fname, tCC* text )
 137 {
 138 #define _FT_(n,p) { n, p },
 139   static test_entry_t test_table[] = { FIX_TEST_TABLE { NULL, NULL }};
 140 #undef _FT_
 141 #define TEST_TABLE_CT (ARRAY_SIZE (test_table)-1)
 142
 143   int ct = TEST_TABLE_CT;
 144   test_entry_t* pte = test_table;
 145
 146   do
 147     {
 148       if (strcmp( pte->test_name, tname ) == 0)
 149         return (*pte->test_proc)( fname, text );
 150       pte++;
 151     } while (--ct > 0);
 152   fprintf( stderr, "fixincludes error:  the `%s' fix test is unknown\n",
 153            tname );
 154   exit( 3 );
 155 }