Merge changes from CUPS 1.4svn-r8540.

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

diff --git a/cups/debug.h b/cups/debug.h
index f743580415074df3c927bcd59cd4a29996a8ffdc..e13335bfce523267748582bfa276511356ce9ee7 100644 (file)
--- a/cups/debug.h
+++ b/cups/debug.h
@@ -1,25 +1,16 @@
 /*
- * "$Id: debug.h 177 2006-06-21 00:20:03Z jlovell $"
+ * "$Id: debug.h 7701 2008-06-27 22:37:23Z mike $"
  *
  *   Debugging macros for the Common UNIX Printing System (CUPS).
  *
+ *   Copyright 2007-2009 by Apple Inc.
  *   Copyright 1997-2005 by Easy Software Products.
  *
  *   These coded instructions, statements, and computer programs are the
- *   property of Easy Software Products and are protected by Federal
- *   copyright law.  Distribution and use rights are outlined in the file
- *   "LICENSE.txt" which should have been included with this file.  If this
- *   file is missing or damaged please contact Easy Software Products
- *   at:
- *
- *       Attn: CUPS Licensing Information
- *       Easy Software Products
- *       44141 Airport View Drive, Suite 204
- *       Hollywood, Maryland 20636 USA
- *
- *       Voice: (301) 373-9600
- *       EMail: cups-info@cups.org
- *         WWW: http://www.cups.org
+ *   property of Apple Inc. and are protected by Federal copyright
+ *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
+ *   which should have been included with this file.  If this file is
+ *   file is missing or damaged, see the license at "http://www.cups.org/".
  *
  *   This file is subject to the Apple OS-Developed Software exception.
  */
@@ -28,10 +19,13 @@
 #  define _CUPS_DEBUG_H_
 
 /*
- * Include necessary headers...
+ * C++ magic...
  */
 
-#  include <stdio.h>
+#  ifdef __cplusplus
+extern "C" {
+#  endif /* __cplusplus */
+
 
 /*
  * The debug macros are used if you compile with DEBUG defined.
@@ -42,18 +36,53 @@
  *   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) puts(x)
-#    define DEBUG_printf(x) printf x
+#    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...
+ */
+
+extern int     _cups_debug_fd;
+extern void    _cups_debug_printf(const char *format, ...)
+#ifdef __GNUC__
+__attribute__ ((__format__ (__printf__, 1, 2)))
+#endif /* __GNUC__ */
+;
+extern void    _cups_debug_puts(const char *s);
+
+#  ifdef __cplusplus
+}
+#  endif /* __cplusplus */
+
 #endif /* !_CUPS_DEBUG_H_ */
 
 /*
- * End of "$Id: debug.h 177 2006-06-21 00:20:03Z jlovell $".
+ * End of "$Id: debug.h 7701 2008-06-27 22:37:23Z mike $".
  */