gdb/common/gdb_assert.h - gdb

Macros defined

Source code

  1. /* GDB-friendly replacement for <assert.h>.
  2.    Copyright (C) 2000-2015 Free Software Foundation, Inc.

  4.    This file is part of GDB.

  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.

  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.

  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/>.  */

  19. #ifndef GDB_ASSERT_H
  20. ‌#define GDB_ASSERT_H

  22. /* A static assertion.  This will cause a compile-time error if EXPR,
  23.    which must be a compile-time constant, is false.  */

  25. ‌#define gdb_static_assert(expr) \
  26.   extern int never_defined_just_used_for_checking[(expr) ? 1 : -1]

  28. /* PRAGMATICS: "gdb_assert.h":gdb_assert() is a lower case (rather
  29.    than upper case) macro since that provides the closest fit to the
  30.    existing lower case macro <assert.h>:assert() that it is
  31.    replacing.  */

  33. ‌#define gdb_assert(expr)                                                      \
  34.   ((void) ((expr) ? 0 :                                                       \
  35.            (gdb_assert_fail (#expr, __FILE__, __LINE__, FUNCTION_NAME), 0)))

  37. /* This prints an "Assertion failed" message, asking the user if they
  38.    want to continue, dump core, or just exit.  */
  39. #if defined (FUNCTION_NAME)
  40. ‌#define gdb_assert_fail(assertion, file, line, function)                      \
  41.   internal_error (file, line, _("%s: Assertion `%s' failed."),                \
  42.                   function, assertion)
  43. #else
  44. ‌#define gdb_assert_fail(assertion, file, line, function)                      \
  45.   internal_error (file, line, _("Assertion `%s' failed."),                    \
  46.                   assertion)
  47. #endif

  49. /* The canonical form of gdb_assert (0).
  50.    MESSAGE is a string to include in the error message.  */

  52. #if defined (FUNCTION_NAME)
  53. ‌#define gdb_assert_not_reached(message) \
  54.   internal_error (__FILE__, __LINE__, "%s: %s", FUNCTION_NAME, _(message))
  55. #else
  56. ‌#define gdb_assert_not_reached(message) \
  57.   internal_error (__FILE__, __LINE__, _(message))
  58. #endif

  60. #endif /* gdb_assert.h */