debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-04 08:28:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/util/error_util.h

55 lines
1.6 KiB
C
Raw Permalink Normal View History

xutil.c: remove duplicate copies, create new library libutil.a to contain xutil. We keep the lib/xutil.c version. As a consequence, also factor out _internal_error and associated macros. It might be overkill to make a new file error_util.c for this, but _internal_error does not really belong in database.cc.
2011-10-23 17:05:13 +02:00
/* error_util.h - Provide the INTERNAL_ERROR macro
Move declarations for xutil.c from notmuch-private to new xutil.h. The motivation here is that our top-level notmuch.c main program wants to start using these, but we don't want it to see into notmuch-private.h, (since our main program is a test vehicle for the "public" notmuch interface in notmuch.h).
2009-10-21 22:57:02 +02:00
*
* Copyright © 2009 Carl Worth
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
Use https instead of http where possible Many of the external links found in the notmuch source can be resolved using https instead of http. This changeset addresses as many as i could find, without touching the e-mail corpus or expected outputs found in tests.
2016-06-02 18:26:14 +02:00
* along with this program. If not, see https://www.gnu.org/licenses/ .
Move declarations for xutil.c from notmuch-private to new xutil.h. The motivation here is that our top-level notmuch.c main program wants to start using these, but we don't want it to see into notmuch-private.h, (since our main program is a test vehicle for the "public" notmuch interface in notmuch.h).
2009-10-21 22:57:02 +02:00
*
* Author: Carl Worth <cworth@cworth.org>
*/
xutil.c: remove duplicate copies, create new library libutil.a to contain xutil. We keep the lib/xutil.c version. As a consequence, also factor out _internal_error and associated macros. It might be overkill to make a new file error_util.c for this, but _internal_error does not really belong in database.cc.
2011-10-23 17:05:13 +02:00
#ifndef ERROR_UTIL_H
#define ERROR_UTIL_H
Move declarations for xutil.c from notmuch-private to new xutil.h. The motivation here is that our top-level notmuch.c main program wants to start using these, but we don't want it to see into notmuch-private.h, (since our main program is a test vehicle for the "public" notmuch interface in notmuch.h).
2009-10-21 22:57:02 +02:00
xutil.c: remove duplicate copies, create new library libutil.a to contain xutil. We keep the lib/xutil.c version. As a consequence, also factor out _internal_error and associated macros. It might be overkill to make a new file error_util.c for this, but _internal_error does not really belong in database.cc.
2011-10-23 17:05:13 +02:00
#include <talloc.h>
Add wrappers for regcomp and regexec to xutil.c. These will be handy for some parsing.
2009-10-22 00:06:52 +02:00
Annotate internal_error with the attribute noreturn Annotating functions that do not return with the noreturn attribute (which is understood by both gcc and clang) prevents static analyzers from generating false positives (internal_error is used to terminate the process and is used extensively in error handling code paths). Remove the return statement that was placed there to appease the compiler. Functions annotated with noreturn are not supposed to return any values. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-09-24 17:21:19 +02:00
#include "function-attributes.h"
util: make remaining headers includable from C++ libnotmuch_util.a is supposed to be usable from the library and the CLI, but much the library is compiled as C++. Add in appropriate wrapping to prevent symbol mangling. These wrappers already existed in string-util.h; it seems better to be consistent.
2019-03-02 21:26:06 +01:00
#ifdef __cplusplus
extern "C" {
#endif
xutil.c: remove duplicate copies, create new library libutil.a to contain xutil. We keep the lib/xutil.c version. As a consequence, also factor out _internal_error and associated macros. It might be overkill to make a new file error_util.c for this, but _internal_error does not really belong in database.cc.
2011-10-23 17:05:13 +02:00
/* There's no point in continuing when we've detected that we've done
* something wrong internally (as opposed to the user passing in a
* bogus value).
*
* Note that PRINTF_ATTRIBUTE comes from talloc.h
*/
Annotate internal_error with the attribute noreturn Annotating functions that do not return with the noreturn attribute (which is understood by both gcc and clang) prevents static analyzers from generating false positives (internal_error is used to terminate the process and is used extensively in error handling code paths). Remove the return statement that was placed there to appease the compiler. Functions annotated with noreturn are not supposed to return any values. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-09-24 17:21:19 +02:00
void
_internal_error (const char *format, ...) PRINTF_ATTRIBUTE (1, 2) NORETURN_ATTRIBUTE;
Add wrappers for regcomp and regexec to xutil.c. These will be handy for some parsing.
2009-10-22 00:06:52 +02:00
xutil.c: remove duplicate copies, create new library libutil.a to contain xutil. We keep the lib/xutil.c version. As a consequence, also factor out _internal_error and associated macros. It might be overkill to make a new file error_util.c for this, but _internal_error does not really belong in database.cc.
2011-10-23 17:05:13 +02:00
/* There's no point in continuing when we've detected that we've done
* something wrong internally (as opposed to the user passing in a
* bogus value).
*
* Note that __location__ comes from talloc.h.
*/
util: run uncrustify This is the result of running $ uncrustify --replace --config ../devel/uncrustify.cfg *.c *.h in the util directory
2019-06-13 12:33:13 +02:00
#define INTERNAL_ERROR(format, ...) \
_internal_error (format " (%s).\n", \
xutil.c: remove duplicate copies, create new library libutil.a to contain xutil. We keep the lib/xutil.c version. As a consequence, also factor out _internal_error and associated macros. It might be overkill to make a new file error_util.c for this, but _internal_error does not really belong in database.cc.
2011-10-23 17:05:13 +02:00
##__VA_ARGS__, __location__)
lib: Add GCC visibility(hidden) pragmas to private header files. This prevents any of the private functions from being leaked out through the library interface (at least when compiling with a recent-enough gcc to support the visibility pragma).
2010-11-02 06:01:15 +01:00
util: make remaining headers includable from C++ libnotmuch_util.a is supposed to be usable from the library and the CLI, but much the library is compiled as C++. Add in appropriate wrapping to prevent symbol mangling. These wrappers already existed in string-util.h; it seems better to be consistent.
2019-03-02 21:26:06 +01:00
#ifdef __cplusplus
}
#endif
Move declarations for xutil.c from notmuch-private to new xutil.h. The motivation here is that our top-level notmuch.c main program wants to start using these, but we don't want it to see into notmuch-private.h, (since our main program is a test vehicle for the "public" notmuch interface in notmuch.h).
2009-10-21 22:57:02 +02:00
#endif
Reference in a new issue Copy permalink