gcc/substring-locations.c

   1 /* Source locations within string literals.
   2    Copyright (C) 2016 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #include "config.h"
  21 #include "system.h"
  22 #include "coretypes.h"
  23 #include "diagnostic.h"
  24 #include "cpplib.h"
  25 #include "tree.h"
  26 #include "langhooks.h"
  27 #include "substring-locations.h"
  28
  29 /* Emit a warning governed by option OPT, using GMSGID as the format
  30    string and AP as its arguments.
  31
  32    Attempt to obtain precise location information within a string
  33    literal from FMT_LOC.
  34
  35    Case 1: if substring location is available, and is within the range of
  36    the format string itself, the primary location of the
  37    diagnostic is the substring range obtained from FMT_LOC, with the
  38    caret at the *end* of the substring range.
  39
  40    For example:
  41
  42      test.c:90:10: warning: problem with '%i' here [-Wformat=]
  43      printf ("hello %i", msg);
  44                     ~^
  45
  46    Case 2: if the substring location is available, but is not within
  47    the range of the format string, the primary location is that of the
  48    format string, and an note is emitted showing the substring location.
  49
  50    For example:
  51      test.c:90:10: warning: problem with '%i' here [-Wformat=]
  52      printf("hello " INT_FMT " world", msg);
  53             ^~~~~~~~~~~~~~~~~~~~~~~~~
  54      test.c:19: note: format string is defined here
  55      #define INT_FMT "%i"
  56                       ~^
  57
  58    Case 3: if precise substring information is unavailable, the primary
  59    location is that of the whole string passed to FMT_LOC's constructor.
  60    For example:
  61
  62      test.c:90:10: warning: problem with '%i' here [-Wformat=]
  63      printf(fmt, msg);
  64             ^~~
  65
  66    For each of cases 1-3, if param_range is non-NULL, then it is used
  67    as a secondary range within the warning.  For example, here it
  68    is used with case 1:
  69
  70      test.c:90:16: warning: '%s' here but arg 2 has 'long' type [-Wformat=]
  71      printf ("foo %s bar", long_i + long_j);
  72                   ~^       ~~~~~~~~~~~~~~~
  73
  74    and here with case 2:
  75
  76      test.c:90:16: warning: '%s' here but arg 2 has 'long' type [-Wformat=]
  77      printf ("foo " STR_FMT " bar", long_i + long_j);
  78              ^~~~~~~~~~~~~~~~~~~~~  ~~~~~~~~~~~~~~~
  79      test.c:89:16: note: format string is defined here
  80      #define STR_FMT "%s"
  81                       ~^
  82
  83    and with case 3:
  84
  85      test.c:90:10: warning: '%i' here, but arg 2 is "const char *' [-Wformat=]
  86      printf(fmt, msg);
  87             ^~~  ~~~
  88
  89    If CORRECTED_SUBSTRING is non-NULL, use it for cases 1 and 2 to provide
  90    a fix-it hint, suggesting that it should replace the text within the
  91    substring range.  For example:
  92
  93      test.c:90:10: warning: problem with '%i' here [-Wformat=]
  94      printf ("hello %i", msg);
  95                     ~^
  96                     %s
  97
  98    Return true if a warning was emitted, false otherwise.  */
  99
 100 ATTRIBUTE_GCC_DIAG (5,0)
 101 bool
 102 format_warning_va (const substring_loc &fmt_loc,
 103                    const source_range *param_range,
 104                    const char *corrected_substring,
 105                    int opt, const char *gmsgid, va_list *ap)
 106 {
 107   bool substring_within_range = false;
 108   location_t primary_loc;
 109   location_t fmt_substring_loc = UNKNOWN_LOCATION;
 110   source_range fmt_loc_range
 111     = get_range_from_loc (line_table, fmt_loc.get_fmt_string_loc ());
 112   const char *err = fmt_loc.get_location (&fmt_substring_loc);
 113   source_range fmt_substring_range
 114     = get_range_from_loc (line_table, fmt_substring_loc);
 115   if (err)
 116     /* Case 3: unable to get substring location.  */
 117     primary_loc = fmt_loc.get_fmt_string_loc ();
 118   else
 119     {
 120       if (fmt_substring_range.m_start >= fmt_loc_range.m_start
 121           && fmt_substring_range.m_finish <= fmt_loc_range.m_finish)
 122         /* Case 1.  */
 123         {
 124           substring_within_range = true;
 125           primary_loc = fmt_substring_loc;
 126         }
 127       else
 128         /* Case 2.  */
 129         {
 130           substring_within_range = false;
 131           primary_loc = fmt_loc.get_fmt_string_loc ();
 132         }
 133     }
 134
 135   rich_location richloc (line_table, primary_loc);
 136
 137   if (param_range)
 138     {
 139       location_t param_loc = make_location (param_range->m_start,
 140                                             param_range->m_start,
 141                                             param_range->m_finish);
 142       richloc.add_range (param_loc, false);
 143     }
 144
 145   if (!err && corrected_substring && substring_within_range)
 146     richloc.add_fixit_replace (fmt_substring_range, corrected_substring);
 147
 148   diagnostic_info diagnostic;
 149   diagnostic_set_info (&diagnostic, gmsgid, ap, &richloc, DK_WARNING);
 150   diagnostic.option_index = opt;
 151   bool warned = report_diagnostic (&diagnostic);
 152
 153   if (!err && fmt_substring_loc && !substring_within_range)
 154     /* Case 2.  */
 155     if (warned)
 156       {
 157         rich_location substring_richloc (line_table, fmt_substring_loc);
 158         if (corrected_substring)
 159           substring_richloc.add_fixit_replace (fmt_substring_range,
 160                                                corrected_substring);
 161         inform_at_rich_loc (&substring_richloc,
 162                             "format string is defined here");
 163       }
 164
 165   return warned;
 166 }
 167
 168 /* Variadic call to format_warning_va.  */
 169
 170 bool
 171 format_warning_at_substring (const substring_loc &fmt_loc,
 172                              const source_range *param_range,
 173                              const char *corrected_substring,
 174                              int opt, const char *gmsgid, ...)
 175 {
 176   va_list ap;
 177   va_start (ap, gmsgid);
 178   bool warned = format_warning_va (fmt_loc, param_range, corrected_substring,
 179                                    opt, gmsgid, &ap);
 180   va_end (ap);
 181
 182   return warned;
 183 }
 184
 185 /* Attempt to determine the source location of the substring.
 186    If successful, return NULL and write the source location to *OUT_LOC.
 187    Otherwise return an error message.  Error messages are intended
 188    for GCC developers (to help debugging) rather than for end-users.  */
 189
 190 const char *
 191 substring_loc::get_location (location_t *out_loc) const
 192 {
 193   gcc_assert (out_loc);
 194   return lang_hooks.get_substring_location (*this, out_loc);
 195 }