cups/versioning.h

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