cups/versioning.h

   1 /*
   2  * "$Id$"
   3  *
   4  *   API versioning definitions for CUPS.
   5  *
   6  *   Copyright 2007-2015 by Apple Inc.
   7  *
   8  *   These coded instructions, statements, and computer programs are the
   9  *   property of Apple Inc. and are protected by Federal copyright
  10  *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  11  *   which should have been included with this file.  If this file is
  12  *   file is missing or damaged, see the license at "http://www.cups.org/".
  13  *
  14  *   This file is subject to the Apple OS-Developed Software exception.
  15  */
  16
  17 #ifndef _CUPS_VERSIONING_H_
  18 #  define _CUPS_VERSIONING_H_
  19
  20 /*
  21  * This header defines several constants - _CUPS_DEPRECATED,
  22  * _CUPS_DEPRECATED_MSG, _CUPS_INTERNAL_MSG, _CUPS_API_1_1, _CUPS_API_1_1_19,
  23  * _CUPS_API_1_1_20, _CUPS_API_1_1_21, _CUPS_API_1_2, _CUPS_API_1_3,
  24  * _CUPS_API_1_4, _CUPS_API_1_5, _CUPS_API_1_6, _CUPS_API_1_7, and
  25  * _CUPS_API_2_0 - which add compiler-specific attributes that flag functions
  26  * that are deprecated, added in particular releases, or internal to CUPS.
  27  *
  28  * On OS X, the _CUPS_API_* constants are defined based on the values of
  29  * the MAC_OS_X_VERSION_MIN_ALLOWED and MAC_OS_X_VERSION_MAX_ALLOWED constants
  30  * provided by the compiler.
  31  */
  32
  33 #  if defined(__APPLE__) && !defined(_CUPS_SOURCE)
  34 #    include <AvailabilityMacros.h>
  35 #    ifndef AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER
  36 #      define AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER __attribute__((unavailable))
  37 #    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER */
  38 #    ifndef AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER
  39 #      define AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER __attribute__((unavailable))
  40 #    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER */
  41 #    ifndef AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER
  42 #      define AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER __attribute__((unavailable))
  43 #    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER */
  44 #    ifndef AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER
  45 #      define AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER __attribute__((unavailable))
  46 #    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER */
  47 #    ifndef AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER
  48 #      define AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER __attribute__((unavailable))
  49 #    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER */
  50 #    ifndef AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER
  51 #      define AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER __attribute__((unavailable))
  52 #    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER */
  53 #    ifndef AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER
  54 #      define AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER __attribute__((unavailable))
  55 #    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER */
  56 #    ifndef AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER
  57 #      define AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER __attribute__((unavailable))
  58 #    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER */
  59 #    define _CUPS_API_1_1_19 AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER
  60 #    define _CUPS_API_1_1_20 AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER
  61 #    define _CUPS_API_1_1_21 AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER
  62 #    define _CUPS_API_1_2 AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER
  63 #    define _CUPS_API_1_3 AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER
  64 #    define _CUPS_API_1_4 AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER
  65 #    define _CUPS_API_1_5 AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER
  66 #    define _CUPS_API_1_6 AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER
  67 #    define _CUPS_API_1_7 AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER
  68 #    define _CUPS_API_2_0 AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER
  69 #    define _CUPS_API_2_2
  70 #  else
  71 #    define _CUPS_API_1_1_19
  72 #    define _CUPS_API_1_1_20
  73 #    define _CUPS_API_1_1_21
  74 #    define _CUPS_API_1_2
  75 #    define _CUPS_API_1_3
  76 #    define _CUPS_API_1_4
  77 #    define _CUPS_API_1_5
  78 #    define _CUPS_API_1_6
  79 #    define _CUPS_API_1_7
  80 #    define _CUPS_API_2_0
  81 #    define _CUPS_API_2_2
  82 #  endif /* __APPLE__ && !_CUPS_SOURCE */
  83
  84 /*
  85  * With GCC and Clang we can mark old APIs as "deprecated" or "unavailable" with
  86  * messages so you get warnings/errors are compile-time...
  87  */
  88
  89 #  ifdef __has_extension                /* Clang */
  90 #    define _CUPS_HAS_DEPRECATED
  91 #    if __has_extension(attribute_deprecated_with_message)
  92 #      define _CUPS_HAS_DEPRECATED_WITH_MESSAGE
  93 #    endif
  94 #    if __has_extension(attribute_unavailable_with_message)
  95 #      define _CUPS_HAS_UNAVAILABLE_WITH_MESSAGE
  96 #    endif
  97 #  elif defined(__GNUC__)               /* GCC and compatible */
  98 #    if __GNUC__ >= 3                   /* GCC 3.0 or higher */
  99 #      define _CUPS_HAS_DEPRECATED
 100 #    endif /* __GNUC__ >= 3 */
 101 #    if __GNUC__ >= 5                   /* GCC 5.x */
 102 #      define _CUPS_HAS_DEPRECATED_WITH_MESSAGE
 103 #    elif __GNUC__ == 4 && __GNUC_MINOR__ >= 5
 104                                         /* GCC 4.5 or higher */
 105 #      define _CUPS_HAS_DEPRECATED_WITH_MESSAGE
 106 #    endif /* __GNUC__ >= 5 */
 107 #  endif /* __has_extension */
 108
 109 #  if !defined(_CUPS_HAS_DEPRECATED) || (defined(_CUPS_SOURCE) && !defined(_CUPS_NO_DEPRECATED))
 110     /*
 111      * Don't mark functions deprecated if the compiler doesn't support it
 112      * or we are building CUPS source that doesn't care.
 113      */
 114 #    define _CUPS_DEPRECATED
 115 #    define _CUPS_DEPRECATED_MSG(m)
 116 #    define _CUPS_DEPRECATED_1_6_MSG(m)
 117 #    define _CUPS_DEPRECATED_1_7_MSG(m)
 118 #    define _CUPS_INTERNAL_MSG(m)
 119 #  elif defined(_CUPS_HAS_UNAVAILABLE_WITH_MESSAGE) && defined(_CUPS_NO_DEPRECATED)
 120     /*
 121      * Compiler supports the unavailable attribute, so use it when the code
 122      * wants to exclude the use of deprecated API.
 123      */
 124 #    define _CUPS_DEPRECATED __attribute__ ((unavailable))
 125 #    define _CUPS_DEPRECATED_MSG(m) __attribute__ ((unavailable(m)))
 126 #    define _CUPS_DEPRECATED_1_6_MSG(m) __attribute__ ((unavailable(m)))
 127 #    define _CUPS_DEPRECATED_1_7_MSG(m) __attribute__ ((unavailable(m)))
 128 #    define _CUPS_INTERNAL_MSG(m) __attribute__ ((unavailable(m)))
 129 #  else
 130     /*
 131      * Compiler supports the deprecated attribute, so use it.
 132      */
 133 #    define _CUPS_DEPRECATED __attribute__ ((deprecated))
 134 #    ifdef _CUPS_HAS_DEPRECATED_WITH_MESSAGE
 135 #      define _CUPS_DEPRECATED_MSG(m) __attribute__ ((deprecated(m)))
 136 #    else
 137 #      define _CUPS_DEPRECATED_MSG(m) __attribute__ ((deprecated))
 138 #    endif /* _CUPS_HAS_DEPRECATED_WITH_MESSAGE */
 139 #    if defined(MAC_OS_X_VERSION_10_8) && MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_8
 140 #      define _CUPS_DEPRECATED_1_6_MSG(m) _CUPS_DEPRECATED_MSG(m)
 141 #    else
 142 #      define _CUPS_DEPRECATED_1_6_MSG(m)
 143 #    endif /* MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_8 */
 144 #    if defined(MAC_OS_X_VERSION_10_9) && MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_9
 145 #      define _CUPS_DEPRECATED_1_7_MSG(m) _CUPS_DEPRECATED_MSG(m)
 146 #    else
 147 #      define _CUPS_DEPRECATED_1_7_MSG(m)
 148 #    endif /* MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_9 */
 149 #    ifdef _CUPS_SOURCE
 150 #      define _CUPS_INTERNAL_MSG(m)
 151 #    elif defined(_CUPS_HAS_UNAVAILABLE_WITH_MESSAGE)
 152 #      define _CUPS_INTERNAL_MSG(m) __attribute__ ((unavailable(m)))
 153 #    elif defined(_CUPS_HAS_DEPRECATED_WITH_MESSAGE)
 154 #      define _CUPS_INTERNAL_MSG(m) __attribute__ ((deprecated(m)))
 155 #    else
 156 #      define _CUPS_INTERNAL_MSG(m) __attribute__ ((deprecated))
 157 #    endif /* _CUPS_SOURCE */
 158 #  endif /* !_CUPS_HAS_DEPRECATED || (_CUPS_SOURCE && !_CUPS_NO_DEPRECATED) */
 159
 160 #  ifndef __GNUC__
 161 #    define __attribute__(x)
 162 #  endif /* !__GNUC__ */
 163
 164 #endif /* !_CUPS_VERSIONING_H_ */
 165
 166 /*
 167  * End of "$Id$".
 168  */