gdbsupport/gdb_assert.h

   1 /* GDB-friendly replacement for <assert.h>.
   2    Copyright (C) 2000-2023 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef COMMON_GDB_ASSERT_H
  20 #define COMMON_GDB_ASSERT_H
  21
  22 #include "errors.h"
  23
  24 /* A static assertion.  This will cause a compile-time error if EXPR,
  25    which must be a compile-time constant, is false.  */
  26
  27 #define gdb_static_assert(expr) static_assert (expr, "")
  28
  29 /* PRAGMATICS: "gdb_assert.h":gdb_assert() is a lower case (rather
  30    than upper case) macro since that provides the closest fit to the
  31    existing lower case macro <assert.h>:assert() that it is
  32    replacing.  */
  33
  34 #define gdb_assert(expr)                                                      \
  35   ((void) ((expr) ? 0 :                                                       \
  36            (gdb_assert_fail (#expr, __FILE__, __LINE__, __func__), 0)))
  37
  38 /* This prints an "Assertion failed" message, asking the user if they
  39    want to continue, dump core, or just exit.  */
  40 #define gdb_assert_fail(assertion, file, line, function)                      \
  41   internal_error_loc (file, line, _("%s: Assertion `%s' failed."),                \
  42                       function, assertion)
  43
  44 /* The canonical form of gdb_assert (0).
  45    MESSAGE is a string to include in the error message.  */
  46
  47 #define gdb_assert_not_reached(message, ...) \
  48   internal_error_loc (__FILE__, __LINE__, _("%s: " message), __func__, \
  49                       ##__VA_ARGS__)
  50
  51 #endif /* COMMON_GDB_ASSERT_H */