common: New function log_debug_with_string.
[gnupg.git] / common / logging.h
index fa5d4cf..ed1d3b9 100644 (file)
@@ -2,40 +2,47 @@
  * Copyright (C) 1999, 2000, 2001, 2004, 2006,
  *               2010 Free Software Foundation, Inc.
  *
- * This file is part of JNLIB.
+ * This file is part of GnuPG.
  *
- * JNLIB is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation; either version 3 of
- * the License, or (at your option) any later version.
+ * GnuPG is free software; you can redistribute it and/or modify it
+ * under the terms of either
  *
- * JNLIB is distributed in the hope that it will be useful, but
+ *   - the GNU Lesser General Public License as published by the Free
+ *     Software Foundation; either version 3 of the License, or (at
+ *     your option) any later version.
+ *
+ * or
+ *
+ *   - the GNU General Public License as published by the Free
+ *     Software Foundation; either version 2 of the License, or (at
+ *     your option) any later version.
+ *
+ * or both in parallel, as here.
+ *
+ * GnuPG 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
- * Lesser General Public License for more details.
+ * General Public License for more details.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copies of the GNU General Public License
+ * and the GNU Lesser General Public License along with this program;
+ * if not, see <https://www.gnu.org/licenses/>.
  */
 
-#ifndef LIBJNLIB_LOGGING_H
-#define LIBJNLIB_LOGGING_H
+#ifndef GNUPG_COMMON_LOGGING_H
+#define GNUPG_COMMON_LOGGING_H
 
 #include <stdio.h>
-#include "estream.h"
+#include <stdarg.h>
+#include <gpg-error.h>
 #include "mischelp.h"
 #include "w32help.h"
 
-/* Flag values for log_set_prefix. */
-#define JNLIB_LOG_WITH_PREFIX  1
-#define JNLIB_LOG_WITH_TIME    2
-#define JNLIB_LOG_WITH_PID     4
-#define JNLIB_LOG_RUN_DETACHED 256
-
 int  log_get_errorcount (int clear);
 void log_inc_errorcount (void);
 void log_set_file( const char *name );
 void log_set_fd (int fd);
+void log_set_socket_dir_cb (const char *(*fnc)(void));
 void log_set_pid_suffix_cb (int (*cb)(unsigned long *r_value));
 void log_set_prefix (const char *text, unsigned int flags);
 const char *log_get_prefix (unsigned int *flags);
@@ -43,40 +50,55 @@ int log_test_fd (int fd);
 int  log_get_fd(void);
 estream_t log_get_stream (void);
 
-#ifdef JNLIB_GCC_M_FUNCTION
-  void bug_at( const char *file, int line, const char *func ) JNLIB_GCC_A_NR;
-# define BUG() bug_at( __FILE__ , __LINE__, __FUNCTION__ )
-#else
-  void bug_at( const char *file, int line );
+#ifdef GPGRT_HAVE_MACRO_FUNCTION
+  void bug_at (const char *file, int line, const char *func)
+               GPGRT_ATTR_NORETURN;
+  void _log_assert (const char *expr, const char *file, int line,
+                    const char *func) GPGRT_ATTR_NORETURN;
+# define BUG() bug_at( __FILE__ , __LINE__, __FUNCTION__)
+# define log_assert(expr)                                       \
+  ((expr)                                                       \
+   ? (void) 0                                                   \
+   : _log_assert (#expr, __FILE__, __LINE__, __FUNCTION__))
+#else /*!GPGRT_HAVE_MACRO_FUNCTION*/
+  void bug_at (const char *file, int line);
+  void _log_assert (const char *expr, const char *file, int line);
 # define BUG() bug_at( __FILE__ , __LINE__ )
-#endif
+# define log_assert(expr)                                       \
+  ((expr)                                                       \
+   ? (void) 0                                                   \
+   : _log_assert (#expr, __FILE__, __LINE__))
+#endif /*!GPGRT_HAVE_MACRO_FUNCTION*/
 
-/* To avoid mandatory inclusion of stdarg and other stuff, do it only
-   if explicitly requested to do so. */
-#ifdef JNLIB_NEED_LOG_LOGV
-#include <stdarg.h>
+/* Flag values for log_set_prefix. */
+#define GPGRT_LOG_WITH_PREFIX  1
+#define GPGRT_LOG_WITH_TIME    2
+#define GPGRT_LOG_WITH_PID     4
+#define GPGRT_LOG_RUN_DETACHED 256
+#define GPGRT_LOG_NO_REGISTRY  512
+
+/* Log levels as used by log_log.  */
 enum jnlib_log_levels {
-    JNLIB_LOG_BEGIN,
-    JNLIB_LOG_CONT,
-    JNLIB_LOG_INFO,
-    JNLIB_LOG_WARN,
-    JNLIB_LOG_ERROR,
-    JNLIB_LOG_FATAL,
-    JNLIB_LOG_BUG,
-    JNLIB_LOG_DEBUG
+    GPGRT_LOG_BEGIN,
+    GPGRT_LOG_CONT,
+    GPGRT_LOG_INFO,
+    GPGRT_LOG_WARN,
+    GPGRT_LOG_ERROR,
+    GPGRT_LOG_FATAL,
+    GPGRT_LOG_BUG,
+    GPGRT_LOG_DEBUG
 };
-void log_log (int level, const char *fmt, ...) JNLIB_GCC_A_PRINTF(2,3);
+void log_log (int level, const char *fmt, ...) GPGRT_ATTR_PRINTF(2,3);
 void log_logv (int level, const char *fmt, va_list arg_ptr);
 void log_string (int level, const char *string);
-#endif /*JNLIB_NEED_LOG_LOGV*/
-
-
-void log_bug( const char *fmt, ... )   JNLIB_GCC_A_NR_PRINTF(1,2);
-void log_fatal( const char *fmt, ... ) JNLIB_GCC_A_NR_PRINTF(1,2);
-void log_error( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
-void log_info( const char *fmt, ... )  JNLIB_GCC_A_PRINTF(1,2);
-void log_debug( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
-void log_printf( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
+void log_bug (const char *fmt, ...)    GPGRT_ATTR_NR_PRINTF(1,2);
+void log_fatal (const char *fmt, ...)  GPGRT_ATTR_NR_PRINTF(1,2);
+void log_error (const char *fmt, ...)  GPGRT_ATTR_PRINTF(1,2);
+void log_info (const char *fmt, ...)   GPGRT_ATTR_PRINTF(1,2);
+void log_debug (const char *fmt, ...)  GPGRT_ATTR_PRINTF(1,2);
+void log_debug_with_string (const char *string, const char *fmt,
+                            ...) GPGRT_ATTR_PRINTF(2,3);
+void log_printf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
 void log_flush (void);
 
 /* Print a hexdump of BUFFER.  With TEXT passes as NULL print just the
@@ -85,5 +107,7 @@ void log_flush (void);
    by the hexdump and a final LF.  */
 void log_printhex (const char *text, const void *buffer, size_t length);
 
+void log_clock (const char *string);
+
 
-#endif /*LIBJNLIB_LOGGING_H*/
+#endif /*GNUPG_COMMON_LOGGING_H*/