CFLogUtilities.h

   1 /*
   2  * Copyright (c) 2009 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*      CFLogUtilities.h
  25         Copyright (c) 2004-2009, Apple Inc. All rights reserved.
  26 */
  27
  28 /*
  29         APPLE SPI:  NOT TO BE USED OUTSIDE APPLE!
  30 */
  31
  32 #if !defined(__COREFOUNDATION_CFLOGUTILITIES__)
  33 #define __COREFOUNDATION_CFLOGUTILITIES__ 1
  34
  35 #include <CoreFoundation/CFBase.h>
  36 #include <CoreFoundation/CFString.h>
  37
  38 CF_EXTERN_C_BEGIN
  39
  40
  41 enum {  // Legal level values for CFLog()
  42     kCFLogLevelEmergency = 0,
  43     kCFLogLevelAlert = 1,
  44     kCFLogLevelCritical = 2,
  45     kCFLogLevelError = 3,
  46     kCFLogLevelWarning = 4,
  47     kCFLogLevelNotice = 5,
  48     kCFLogLevelInfo = 6,
  49     kCFLogLevelDebug = 7,
  50 };
  51
  52 CF_EXPORT void CFLog(int32_t level, CFStringRef format, ...);
  53 /*      Passing in a level value which is outside the range of 0-7 will cause the the call to do nothing.
  54         CFLog() logs the message using the asl.h API, and uses the level parameter as the log level.
  55         Note that the asl subsystem ignores some log levels by default.
  56         CFLog() is not fast, and is not going to be guaranteed to be fast.
  57         Even "no-op" CFLogs are not necessarily fast.
  58         If you care about performance, you shouldn't be logging.
  59 */
  60
  61 CF_EXTERN_C_END
  62
  63 #endif /* ! __COREFOUNDATION_CFLOGUTILITIES__ */
  64