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

/*
 * API versioning definitions for CUPS.
 *
 * Copyright © 2007-2018 by Apple Inc.
 *
 * 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.
 */

#ifndef _CUPS_VERSIONING_H_
#  define _CUPS_VERSIONING_H_

/*
 * This header defines several constants - _CUPS_DEPRECATED,
 * _CUPS_DEPRECATED_MSG, _CUPS_INTERNAL_MSG, _CUPS_API_major_minor, and
 * _CUPS_API_major_minor_patch - which add compiler-specific attributes that
 * flag functions that are deprecated, added in particular releases, or internal
 * to CUPS.
 *
 * On macOS, the _CUPS_API_* constants are defined based on the values of
 * the MAC_OS_X_VERSION_MIN_ALLOWED and MAC_OS_X_VERSION_MAX_ALLOWED constants
 * provided by the compiler.
 */

#  if defined(__APPLE__) && !defined(_CUPS_SOURCE) && !TARGET_OS_IOS
#    include <AvailabilityMacros.h>
#    ifndef AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER
#      define AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER __attribute__((unavailable))
#    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER */
#    ifndef AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER
#      define AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER __attribute__((unavailable))
#    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER */
#    ifndef AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER
#      define AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER __attribute__((unavailable))
#    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER */
#    ifndef AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER
#      define AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER __attribute__((unavailable))
#    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER */
#    ifndef AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER
#      define AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER __attribute__((unavailable))
#    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER */
#    ifndef AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER
#      define AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER __attribute__((unavailable))
#    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER */
#    ifndef AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER
#      define AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER __attribute__((unavailable))
#    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER */
#    ifndef AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER
#      define AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER __attribute__((unavailable))
#    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER */
#    ifndef AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER
#      define AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER __attribute__((unavailable))
#    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER */
#    ifndef AVAILABLE_MAC_OS_X_VERSION_10_13_AND_LATER
#      define AVAILABLE_MAC_OS_X_VERSION_10_13_AND_LATER __attribute__((unavailable))
#    endif /* !AVAILABLE_MAC_OS_X_VERSION_10_13_AND_LATER */
#    define _CUPS_API_1_1_19 AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER
#    define _CUPS_API_1_1_20 AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER
#    define _CUPS_API_1_1_21 AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER
#    define _CUPS_API_1_2 AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER
#    define _CUPS_API_1_3 AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER
#    define _CUPS_API_1_4 AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER
#    define _CUPS_API_1_5 AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER
#    define _CUPS_API_1_6 AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER
#    define _CUPS_API_1_7 AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER
#    define _CUPS_API_2_0 AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER
#    define _CUPS_API_2_2 AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER
#    define _CUPS_API_2_2_4 AVAILABLE_MAC_OS_X_VERSION_10_13_AND_LATER
#    define _CUPS_API_2_2_7
#  else
#    define _CUPS_API_1_1_19
#    define _CUPS_API_1_1_20
#    define _CUPS_API_1_1_21
#    define _CUPS_API_1_2
#    define _CUPS_API_1_3
#    define _CUPS_API_1_4
#    define _CUPS_API_1_5
#    define _CUPS_API_1_6
#    define _CUPS_API_1_7
#    define _CUPS_API_2_0
#    define _CUPS_API_2_2
#    define _CUPS_API_2_2_4
#    define _CUPS_API_2_2_7
#  endif /* __APPLE__ && !_CUPS_SOURCE */

/*
 * With GCC and Clang we can mark old APIs as "deprecated" or "unavailable" with
 * messages so you get warnings/errors are compile-time...
 */

#  ifdef __has_extension		/* Clang */
#    define _CUPS_HAS_DEPRECATED
#    if __has_extension(attribute_deprecated_with_message)
#      define _CUPS_HAS_DEPRECATED_WITH_MESSAGE
#    endif
#    if __has_extension(attribute_unavailable_with_message)
#      define _CUPS_HAS_UNAVAILABLE_WITH_MESSAGE
#    endif
#  elif defined(__GNUC__)		/* GCC and compatible */
#    if __GNUC__ >= 3			/* GCC 3.0 or higher */
#      define _CUPS_HAS_DEPRECATED
#    endif /* __GNUC__ >= 3 */
#    if __GNUC__ >= 5			/* GCC 5.x */
#      define _CUPS_HAS_DEPRECATED_WITH_MESSAGE
#    elif __GNUC__ == 4 && __GNUC_MINOR__ >= 5
					/* GCC 4.5 or higher */
#      define _CUPS_HAS_DEPRECATED_WITH_MESSAGE
#    endif /* __GNUC__ >= 5 */
#  endif /* __has_extension */

#  if !defined(_CUPS_HAS_DEPRECATED) || (defined(_CUPS_SOURCE) && !defined(_CUPS_NO_DEPRECATED))
    /*
     * Don't mark functions deprecated if the compiler doesn't support it
     * or we are building CUPS source that doesn't care.
     */
#    define _CUPS_DEPRECATED
#    define _CUPS_DEPRECATED_MSG(m)
#    define _CUPS_DEPRECATED_1_6_MSG(m)
#    define _CUPS_DEPRECATED_1_7_MSG(m)
#    define _CUPS_INTERNAL_MSG(m)
#  elif defined(_CUPS_HAS_UNAVAILABLE_WITH_MESSAGE) && defined(_CUPS_NO_DEPRECATED)
    /*
     * Compiler supports the unavailable attribute, so use it when the code
     * wants to exclude the use of deprecated API.
     */
#    define _CUPS_DEPRECATED __attribute__ ((unavailable))
#    define _CUPS_DEPRECATED_MSG(m) __attribute__ ((unavailable(m)))
#    define _CUPS_DEPRECATED_1_6_MSG(m) __attribute__ ((unavailable(m)))
#    define _CUPS_DEPRECATED_1_7_MSG(m) __attribute__ ((unavailable(m)))
#    define _CUPS_INTERNAL_MSG(m) __attribute__ ((unavailable(m)))
#  else
    /*
     * Compiler supports the deprecated attribute, so use it.
     */
#    define _CUPS_DEPRECATED __attribute__ ((deprecated))
#    ifdef _CUPS_HAS_DEPRECATED_WITH_MESSAGE
#      define _CUPS_DEPRECATED_MSG(m) __attribute__ ((deprecated(m)))
#    else
#      define _CUPS_DEPRECATED_MSG(m) __attribute__ ((deprecated))
#    endif /* _CUPS_HAS_DEPRECATED_WITH_MESSAGE */
#    if defined(MAC_OS_X_VERSION_10_8) && MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_8
#      define _CUPS_DEPRECATED_1_6_MSG(m) _CUPS_DEPRECATED_MSG(m)
#    else
#      define _CUPS_DEPRECATED_1_6_MSG(m)
#    endif /* MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_8 */
#    if defined(MAC_OS_X_VERSION_10_9) && MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_9
#      define _CUPS_DEPRECATED_1_7_MSG(m) _CUPS_DEPRECATED_MSG(m)
#    else
#      define _CUPS_DEPRECATED_1_7_MSG(m)
#    endif /* MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_9 */
#    ifdef _CUPS_SOURCE
#      define _CUPS_INTERNAL_MSG(m)
#    elif defined(_CUPS_HAS_UNAVAILABLE_WITH_MESSAGE)
#      define _CUPS_INTERNAL_MSG(m) __attribute__ ((unavailable(m)))
#    elif defined(_CUPS_HAS_DEPRECATED_WITH_MESSAGE)
#      define _CUPS_INTERNAL_MSG(m) __attribute__ ((deprecated(m)))
#    else
#      define _CUPS_INTERNAL_MSG(m) __attribute__ ((deprecated))
#    endif /* _CUPS_SOURCE */
#  endif /* !_CUPS_HAS_DEPRECATED || (_CUPS_SOURCE && !_CUPS_NO_DEPRECATED) */

#  ifndef __GNUC__
#    define __attribute__(x)
#  endif /* !__GNUC__ */

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