]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - cups/debug-private.h
Move debug printfs to internal usage only.
[thirdparty/cups.git] / cups / debug-private.h
index 23a0ae1795a9285506666fb70991cf6e5c6ebb14..fb84a2f74ed586e047b601f93a1744b5bbb5196e 100644 (file)
@@ -1,16 +1,11 @@
 /*
- * Private debugging macros for CUPS.
+ * Private debugging APIs for CUPS.
  *
- * Copyright 2007-2012 by Apple Inc.
- * Copyright 1997-2005 by Easy Software Products.
+ * Copyright © 2007-2018 by Apple Inc.
+ * Copyright © 1997-2005 by Easy Software Products.
  *
- * These coded instructions, statements, and computer programs are the
- * 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
- * missing or damaged, see the license at "http://www.cups.org/".
- *
- * This file is subject to the Apple OS-Developed Software exception.
+ * Licensed under Apache License v2.0.  See the file "LICENSE" for more
+ * information.
  */
 
 #ifndef _CUPS_DEBUG_PRIVATE_H_
@@ -38,51 +33,17 @@ extern "C" {
  *
  * 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
+ *   DEBUG_set("logfile", "level", "filter", 1)
  *
  * The DEBUG_set macro allows an application to programmatically enable (or
  * disable) debug logging.  The arguments correspond to the CUPS_DEBUG_LOG,
- * CUPS_DEBUG_LEVEL, and CUPS_DEBUG_FILTER environment variables.
+ * CUPS_DEBUG_LEVEL, and CUPS_DEBUG_FILTER environment variables.  The 1 on the
+ * end forces the values to override the environment.
  */
 
 #  ifdef DEBUG
-#    ifdef WIN32
-#      ifdef LIBCUPS2_EXPORTS
-#        define DLLExport __declspec(dllexport)
-#      else
-#        define DLLExport
-#      endif /* LIBCUPS2_EXPORTS */
-#    else
-#      define DLLExport
-#    endif /* WIN32 */
-#    define DEBUG_puts(x) _cups_debug_puts(x)
-#    define DEBUG_printf(x) _cups_debug_printf x
 #    define DEBUG_set(logfile,level,filter) _cups_debug_set(logfile,level,filter,1)
 #  else
-#    define DLLExport
-#    define DEBUG_puts(x)
-#    define DEBUG_printf(x)
 #    define DEBUG_set(logfile,level,filter)
 #  endif /* DEBUG */
 
@@ -91,18 +52,11 @@ extern "C" {
  * Prototypes...
  */
 
-extern int     _cups_debug_fd;
-extern int     _cups_debug_level;
-extern void    DLLExport _cups_debug_printf(const char *format, ...)
-               __attribute__ ((__format__ (__printf__, 1, 2)));
-extern void    DLLExport _cups_debug_puts(const char *s);
-extern void    DLLExport _cups_debug_set(const char *logfile,
-                                         const char *level, const char *filter,
-                                         int force);
-#  ifdef WIN32
-extern int     _cups_gettimeofday(struct timeval *tv, void *tz);
+extern void    _cups_debug_set(const char *logfile, const char *level, const char *filter, int force) _CUPS_PRIVATE;
+#  ifdef _WIN32
+extern int     _cups_gettimeofday(struct timeval *tv, void *tz) _CUPS_PRIVATE;
 #    define gettimeofday(a,b) _cups_gettimeofday(a, b)
-#  endif /* WIN32 */
+#  endif /* _WIN32 */
 
 #  ifdef __cplusplus
 }