summaryrefslogtreecommitdiff
path: root/cups/debug-internal.h
diff options
context:
space:
mode:
authorMichael R Sweet <michael.r.sweet@gmail.com>2018-10-18 14:25:09 -0400
committerMichael R Sweet <michael.r.sweet@gmail.com>2018-10-18 14:25:09 -0400
commitfb863569eb4f51ae62a066dc8049d3ffc0efb0bb (patch)
tree8a209d6684fc82600cbc303ffceedff8fb1d7b58 /cups/debug-internal.h
parent941a5490cfa02953d2adcacb1838fd3d3e21976b (diff)
downloadcups-fb863569eb4f51ae62a066dc8049d3ffc0efb0bb.tar.gz
Move debug printfs to internal usage only.
Also, old MD5 code is internal-only.
Diffstat (limited to 'cups/debug-internal.h')
-rw-r--r--cups/debug-internal.h84
1 files changed, 84 insertions, 0 deletions
diff --git a/cups/debug-internal.h b/cups/debug-internal.h
new file mode 100644
index 000000000..2b57854e9
--- /dev/null
+++ b/cups/debug-internal.h
@@ -0,0 +1,84 @@
+/*
+ * Internal debugging macros for CUPS.
+ *
+ * Copyright © 2007-2018 by Apple Inc.
+ * Copyright © 1997-2005 by Easy Software Products.
+ *
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
+ */
+
+#ifndef _CUPS_DEBUG_INTERNAL_H_
+# define _CUPS_DEBUG_INTERNAL_H_
+
+
+/*
+ * Include necessary headers...
+ */
+
+# include "debug-private.h"
+
+
+/*
+ * C++ magic...
+ */
+
+# ifdef __cplusplus
+extern "C" {
+# endif /* __cplusplus */
+
+
+/*
+ * The debug macros are used if you compile with DEBUG defined.
+ *
+ * Usage:
+ *
+ * DEBUG_puts("string")
+ * DEBUG_printf(("format string", arg, arg, ...));
+ *
+ * Note the extra parenthesis around the DEBUG_printf macro...
+ *
+ * Newlines are not required on the end of messages, as both add one when
+ * writing the output.
+ *
+ * If the first character is a digit, then it represents the "log level" of the
+ * message from 0 to 9. The default level is 1. The following defines the
+ * current levels we use:
+ *
+ * 0 = public APIs, other than value accessor functions
+ * 1 = return values for public APIs
+ * 2 = public value accessor APIs, progress for public APIs
+ * 3 = return values for value accessor APIs
+ * 4 = private APIs, progress for value accessor APIs
+ * 5 = return values for private APIs
+ * 6 = progress for private APIs
+ * 7 = static functions
+ * 8 = return values for static functions
+ * 9 = progress for static functions
+ */
+
+# ifdef DEBUG
+# define DEBUG_puts(x) _cups_debug_puts(x)
+# define DEBUG_printf(x) _cups_debug_printf x
+# else
+# define DEBUG_puts(x)
+# define DEBUG_printf(x)
+# endif /* DEBUG */
+
+
+/*
+ * Prototypes...
+ */
+
+# ifdef DEBUG
+extern int _cups_debug_fd _CUPS_INTERNAL;
+extern int _cups_debug_level _CUPS_INTERNAL;
+extern void _cups_debug_printf(const char *format, ...) _CUPS_FORMAT(1,2) _CUPS_INTERNAL;
+extern void _cups_debug_puts(const char *s) _CUPS_INTERNAL;
+# endif /* DEBUG */
+
+# ifdef __cplusplus
+}
+# endif /* __cplusplus */
+
+#endif /* !_CUPS_DEBUG_INTERNAL_H_ */