git.notmuchmail.org Git - notmuch/blob - util/error_util.h

   1 /* error_util.h - Provide the INTERNAL_ERROR macro
   2  *
   3  * Copyright © 2009 Carl Worth
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see https://www.gnu.org/licenses/ .
  17  *
  18  * Author: Carl Worth <cworth@cworth.org>
  19  */
  20
  21 #ifndef ERROR_UTIL_H
  22 #define ERROR_UTIL_H
  23
  24 #include <talloc.h>
  25
  26 #include "function-attributes.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /* There's no point in continuing when we've detected that we've done
  33  * something wrong internally (as opposed to the user passing in a
  34  * bogus value).
  35  *
  36  * Note that PRINTF_ATTRIBUTE comes from talloc.h
  37  */
  38 void
  39 _internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2) NORETURN_ATTRIBUTE;
  40
  41 /* There's no point in continuing when we've detected that we've done
  42  * something wrong internally (as opposed to the user passing in a
  43  * bogus value).
  44  *
  45  * Note that __location__ comes from talloc.h.
  46  */
  47 #define INTERNAL_ERROR(format, ...)                     \
  48     _internal_error (format " (%s).\n",                 \
  49                      ##__VA_ARGS__, __location__)
  50
  51 #ifdef __cplusplus
  52 }
  53 #endif
  54 #endif