From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by arlo.cworth.org (Postfix) with ESMTP id 900CD6DE028C for ; Mon, 30 Jul 2018 15:46:51 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at cworth.org X-Spam-Flag: NO X-Spam-Score: 0.001 X-Spam-Level: X-Spam-Status: No, score=0.001 tagged_above=-999 required=5 tests=[AWL=0.012, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled Received: from arlo.cworth.org ([127.0.0.1]) by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id pc0twb9bOEXw for ; Mon, 30 Jul 2018 15:46:50 -0700 (PDT) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by arlo.cworth.org (Postfix) with ESMTPS id 321166DE098A for ; Mon, 30 Jul 2018 15:46:40 -0700 (PDT) Received: from remotemail by fethera.tethera.net with local (Exim 4.89) (envelope-from ) id 1fkGw3-0002DL-Am; Mon, 30 Jul 2018 18:46:39 -0400 Received: (nullmailer pid 28720 invoked by uid 1000); Mon, 30 Jul 2018 22:45:56 -0000 From: David Bremner To: notmuch@notmuchmail.org Subject: [PATCH 01/15] util: add DEBUG_PRINTF, rename error_util.h -> debug_print.h Date: Tue, 31 Jul 2018 06:45:41 +0800 Message-Id: <20180730224555.26047-2-david@tethera.net> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20180730224555.26047-1-david@tethera.net> References: <20180730224555.26047-1-david@tethera.net> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.26 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 30 Jul 2018 22:46:51 -0000 It seemed silly to have two headers that were almost copies. The new macro is intended for debugging, and probably should not be left in released code. --- command-line-arguments.c | 2 +- lib/notmuch-private.h | 2 +- util/Makefile.local | 4 +-- util/debug_print.c | 26 ++++++++++++++++++ util/{error_util.h => debug_print.h} | 22 ++++++++++++--- util/error_util.c | 40 ---------------------------- util/hex-escape.c | 2 +- util/util.c | 2 +- util/xutil.c | 2 +- 9 files changed, 51 insertions(+), 51 deletions(-) create mode 100644 util/debug_print.c rename util/{error_util.h => debug_print.h} (75%) delete mode 100644 util/error_util.c diff --git a/command-line-arguments.c b/command-line-arguments.c index d64aa85b..90d69453 100644 --- a/command-line-arguments.c +++ b/command-line-arguments.c @@ -1,7 +1,7 @@ #include #include #include -#include "error_util.h" +#include "debug_print.h" #include "command-line-arguments.h" typedef enum { diff --git a/lib/notmuch-private.h b/lib/notmuch-private.h index 3764a6a9..499d73d4 100644 --- a/lib/notmuch-private.h +++ b/lib/notmuch-private.h @@ -50,7 +50,7 @@ NOTMUCH_BEGIN_DECLS #include "gmime-extra.h" #include "xutil.h" -#include "error_util.h" +#include "debug_print.h" #include "string-util.h" #include "crypto.h" diff --git a/util/Makefile.local b/util/Makefile.local index ba03230e..ccf1bd79 100644 --- a/util/Makefile.local +++ b/util/Makefile.local @@ -3,9 +3,9 @@ dir := util extra_cflags += -I$(srcdir)/$(dir) -libnotmuch_util_c_srcs := $(dir)/xutil.c $(dir)/error_util.c $(dir)/hex-escape.c \ +libnotmuch_util_c_srcs := $(dir)/xutil.c $(dir)/hex-escape.c \ $(dir)/string-util.c $(dir)/talloc-extra.c $(dir)/zlib-extra.c \ - $(dir)/util.c $(dir)/gmime-extra.c $(dir)/crypto.c + $(dir)/util.c $(dir)/gmime-extra.c $(dir)/crypto.c $(dir)/debug_print.c libnotmuch_util_modules := $(libnotmuch_util_c_srcs:.c=.o) diff --git a/util/debug_print.c b/util/debug_print.c new file mode 100644 index 00000000..9f00f69b --- /dev/null +++ b/util/debug_print.c @@ -0,0 +1,26 @@ +#include "debug_print.h" + +void +_debug_printf (const char *format, ...) +{ + va_list va_args; + + va_start (va_args, format); + vfprintf (stderr, format, va_args); + va_end (va_args); + +} + +void +_internal_error (const char *format, ...) +{ + va_list va_args; + + va_start (va_args, format); + + fprintf (stderr, "Internal error: "); + vfprintf (stderr, format, va_args); + + va_end (va_args); + exit (1); +} diff --git a/util/error_util.h b/util/debug_print.h similarity index 75% rename from util/error_util.h rename to util/debug_print.h index 4bb338a2..4a096945 100644 --- a/util/error_util.h +++ b/util/debug_print.h @@ -1,6 +1,7 @@ -/* error_util.h - Provide the INTERNAL_ERROR macro +/* debug_print.h - Provide the INTERNAL_ERROR and DEBUG_PRINTF macros * * Copyright © 2009 Carl Worth + * Copyright © 2018 David Bremner * * 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 @@ -18,13 +19,26 @@ * Author: Carl Worth */ -#ifndef ERROR_UTIL_H -#define ERROR_UTIL_H +#ifndef DEBUG_PRINT_H +#define DEBUG_PRINT_H #include - #include "function-attributes.h" +void +_debug_printf (const char *format, ...) PRINTF_ATTRIBUTE (1, 2); + +/* + * Provide a quick way to silence debugging output. + */ + +#ifdef DEBUG_PRINT +#define DEBUG_PRINTF(format, ...) _debug_printf(format " (%s).\n", \ + ##__VA_ARGS__, __location__) +#else +#define DEBUG_PRINTF(format, ...) /* ignored */ +#endif + /* 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). diff --git a/util/error_util.c b/util/error_util.c deleted file mode 100644 index e64162c7..00000000 --- a/util/error_util.c +++ /dev/null @@ -1,40 +0,0 @@ -/* error_util.c - internal error utilities for notmuch. - * - * 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 - * along with this program. If not, see https://www.gnu.org/licenses/ . - * - * Author: Carl Worth - */ - -#include -#include -#include - -#include "error_util.h" - -void -_internal_error (const char *format, ...) -{ - va_list va_args; - - va_start (va_args, format); - - fprintf (stderr, "Internal error: "); - vfprintf (stderr, format, va_args); - - va_end (va_args); - exit (1); -} - diff --git a/util/hex-escape.c b/util/hex-escape.c index 8883ff90..ff20c702 100644 --- a/util/hex-escape.c +++ b/util/hex-escape.c @@ -22,7 +22,7 @@ #include #include #include -#include "error_util.h" +#include "debug_print.h" #include "hex-escape.h" static const char *output_charset = diff --git a/util/util.c b/util/util.c index 06659b35..75df0ead 100644 --- a/util/util.c +++ b/util/util.c @@ -1,5 +1,5 @@ #include "util.h" -#include "error_util.h" +#include "debug_print.h" #include #include diff --git a/util/xutil.c b/util/xutil.c index f211eaaa..11042c9e 100644 --- a/util/xutil.c +++ b/util/xutil.c @@ -22,7 +22,7 @@ #include #include "xutil.h" -#include "error_util.h" +#include "debug_print.h" void * xcalloc (size_t nmemb, size_t size) -- 2.18.0