Merge changes from CUPS 1.5svn-r8950.

[thirdparty/cups.git] / cups / debug.h

diff --git a/cups/debug.h b/cups/debug.h
index 756c4773d5b39437e8a6bf9c77fb08726f098953..e051be4f78f7de4aa84472450d33bfa91f60f308 100644 (file)
--- a/cups/debug.h
+++ b/cups/debug.h
@@ -1,9 +1,9 @@
 /*
- * "$Id: debug.h 6649 2007-07-11 21:46:42Z mike $"
+ * "$Id: debug.h 7701 2008-06-27 22:37:23Z mike $"
  *
  *   Debugging macros for the Common UNIX Printing System (CUPS).
  *
- *   Copyright 2007-2008 by Apple Inc.
+ *   Copyright 2007-2009 by Apple Inc.
  *   Copyright 1997-2005 by Easy Software Products.
  *
  *   These coded instructions, statements, and computer programs are the
@@ -18,6 +18,15 @@
 #ifndef _CUPS_DEBUG_H_
 #  define _CUPS_DEBUG_H_
 
+/*
+ * C++ magic...
+ */
+
+#  ifdef __cplusplus
+extern "C" {
+#  endif /* __cplusplus */
+
+
 /*
  * The debug macros are used if you compile with DEBUG defined.
  *
@@ -27,6 +36,24 @@
  *   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
@@ -42,6 +69,8 @@
  * Prototypes...
  */
 
+extern int     _cups_debug_fd;
+extern int     _cups_debug_level;
 extern void    _cups_debug_printf(const char *format, ...)
 #ifdef __GNUC__
 __attribute__ ((__format__ (__printf__, 1, 2)))
@@ -49,9 +78,12 @@ __attribute__ ((__format__ (__printf__, 1, 2)))
 ;
 extern void    _cups_debug_puts(const char *s);
 
+#  ifdef __cplusplus
+}
+#  endif /* __cplusplus */
 
 #endif /* !_CUPS_DEBUG_H_ */
 
 /*
- * End of "$Id: debug.h 6649 2007-07-11 21:46:42Z mike $".
+ * End of "$Id: debug.h 7701 2008-06-27 22:37:23Z mike $".
  */