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

/*
 * API versioning definitions for CUPS.
 *
 * Copyright © 2007-2018 by Apple Inc.
 *
 * Licensed under Apache License v2.0.  See the file "LICENSE" for more
 * information.
 */

#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
#    define _CUPS_API_2_3
#  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
#    define _CUPS_API_2_3
#  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	*
f1b7e563	4	* Copyright © 2007-2018 by Apple Inc.
e94d2f10	5	*
f1b7e563 MS	6	* Licensed under Apache License v2.0. See the file "LICENSE" for more
f1b7e563 MS	7	* information.
e94d2f10 MS	8	*/
	9
	10	#ifndef _CUPS_VERSIONING_H_
	11	# define _CUPS_VERSIONING_H_
	12
	13	/*
	14	* This header defines several constants - _CUPS_DEPRECATED,
0d7cb94a MS	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.
749b1e90	19	*
8072030b	20	* On macOS, the _CUPS_API_* constants are defined based on the values of
749b1e90	21	* the MAC_OS_X_VERSION_MIN_ALLOWED and MAC_OS_X_VERSION_MAX_ALLOWED constants
e94d2f10 MS	22	* provided by the compiler.
	23	*/
	24
503b54c9	25	# if defined(__APPLE__) && !defined(_CUPS_SOURCE) && !TARGET_OS_IOS
749b1e90 MS	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 */
7cf5915e MS	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 */
85dda01c MS	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 */
a469f8a5 MS	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 */
3ae465e7 MS	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 */
b2e6c325 MS	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 */
0d7cb94a MS	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 */
749b1e90 MS	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
7cf5915e	63	# define _CUPS_API_1_5 AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER
c41769ff MS	64	# define _CUPS_API_1_6 AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER
c41769ff MS	65	# define _CUPS_API_1_7 AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER
3ae465e7	66	# define _CUPS_API_2_0 AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER
b2e6c325	67	# define _CUPS_API_2_2 AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER
0d7cb94a	68	# define _CUPS_API_2_2_4 AVAILABLE_MAC_OS_X_VERSION_10_13_AND_LATER
f1b7e563	69	# define _CUPS_API_2_2_7
7ec11630	70	# define _CUPS_API_2_3
e94d2f10 MS	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
c7017ecc	78	# define _CUPS_API_1_5
85dda01c	79	# define _CUPS_API_1_6
a469f8a5	80	# define _CUPS_API_1_7
38bb3cf4	81	# define _CUPS_API_2_0
5ae9fbb3	82	# define _CUPS_API_2_2
0d7cb94a	83	# define _CUPS_API_2_2_4
f1b7e563	84	# define _CUPS_API_2_2_7
7ec11630	85	# define _CUPS_API_2_3
5bd77a73	86	# endif /* __APPLE__ && !_CUPS_SOURCE */
e94d2f10 MS	87
e94d2f10 MS	88	/*
0fa6c7fa MS	89	* With GCC and Clang we can mark old APIs as "deprecated" or "unavailable" with
0fa6c7fa MS	90	* messages so you get warnings/errors are compile-time...
e94d2f10 MS	91	*/
e94d2f10 MS	92
0fa6c7fa MS	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	*/
e94d2f10	118	# define _CUPS_DEPRECATED
a469f8a5	119	# define _CUPS_DEPRECATED_MSG(m)
e666fe5e MS	120	# define _CUPS_DEPRECATED_1_6_MSG(m)
e666fe5e MS	121	# define _CUPS_DEPRECATED_1_7_MSG(m)
0fa6c7fa MS	122	# define _CUPS_INTERNAL_MSG(m)
	123	# elif defined(_CUPS_HAS_UNAVAILABLE_WITH_MESSAGE) && defined(_CUPS_NO_DEPRECATED)
	124	/*
e666fe5e	125	* Compiler supports the unavailable attribute, so use it when the code
0fa6c7fa MS	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)))
e666fe5e MS	130	# define _CUPS_DEPRECATED_1_6_MSG(m) __attribute__ ((unavailable(m)))
e666fe5e MS	131	# define _CUPS_DEPRECATED_1_7_MSG(m) __attribute__ ((unavailable(m)))
0fa6c7fa MS	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 */
e666fe5e MS	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 */
0fa6c7fa MS	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) */
e94d2f10	163
aaf19ab0 MS	164	# ifndef __GNUC__
	165	# define __attribute__(x)
	166	# endif /* !__GNUC__ */
	167
e94d2f10	168	#endif /* !_CUPS_VERSIONING_H_ */