gdb/complaints.h

   1 /* Definitions for complaint handling during symbol reading in GDB.
   2
   3    Copyright (C) 1990-2022 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20
  21 #if !defined (COMPLAINTS_H)
  22 #define COMPLAINTS_H
  23
  24 #include <unordered_set>
  25
  26 /* Helper for complaint.  */
  27 extern void complaint_internal (const char *fmt, ...)
  28   ATTRIBUTE_PRINTF (1, 2);
  29
  30 /* This controls whether complaints are emitted.  */
  31
  32 extern int stop_whining;
  33
  34 /* Register a complaint.  This is a macro around complaint_internal to
  35    avoid computing complaint's arguments when complaints are disabled.
  36    Running FMT via gettext [i.e., _(FMT)] can be quite expensive, for
  37    example.  */
  38 #define complaint(FMT, ...)                                     \
  39   do                                                            \
  40     {                                                           \
  41       if (stop_whining > 0)                                     \
  42         complaint_internal (FMT, ##__VA_ARGS__);                \
  43     }                                                           \
  44   while (0)
  45
  46 /* Clear out / initialize all complaint counters that have ever been
  47    incremented.  */
  48
  49 extern void clear_complaints ();
  50
  51 /* A class that can handle calls to complaint from multiple threads.
  52    When this is instantiated, it hooks into the complaint mechanism,
  53    so the 'complaint' macro can continue to be used.  When it is
  54    destroyed, it issues all the complaints that have been stored.  It
  55    should only be instantiated in the main thread.  */
  56
  57 class complaint_interceptor
  58 {
  59 public:
  60
  61   complaint_interceptor ();
  62   ~complaint_interceptor ();
  63
  64   DISABLE_COPY_AND_ASSIGN (complaint_interceptor);
  65
  66 private:
  67
  68   /* The issued complaints.  */
  69   std::unordered_set<std::string> m_complaints;
  70
  71   /* The saved value of deprecated_warning_hook.  */
  72   void (*m_saved_warning_hook) (const char *, va_list)
  73     ATTRIBUTE_FPTR_PRINTF (1,0);
  74
  75   /* A helper function that is used by the 'complaint' implementation
  76      to issue a complaint.  */
  77   static void issue_complaint (const char *, va_list)
  78     ATTRIBUTE_PRINTF (1, 0);
  79
  80   /* This object.  Used by the static callback function.  */
  81   static complaint_interceptor *g_complaint_interceptor;
  82 };
  83
  84 #endif /* !defined (COMPLAINTS_H) */