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

/*
 * API versioning definitions for CUPS.
 *
 * Copyright 2007-2016 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_1_1, _CUPS_API_1_1_19,
 * _CUPS_API_1_1_20, _CUPS_API_1_1_21, _CUPS_API_1_2, _CUPS_API_1_3,
 * _CUPS_API_1_4, _CUPS_API_1_5, _CUPS_API_1_6, _CUPS_API_1_7, and
 * _CUPS_API_2_0 - 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 */
#    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
#  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
#  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	*
503b54c9	4	* Copyright 2007-2016 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,
0fa6c7fa MS	20	* _CUPS_DEPRECATED_MSG, _CUPS_INTERNAL_MSG, _CUPS_API_1_1, _CUPS_API_1_1_19,
0fa6c7fa MS	21	* _CUPS_API_1_1_20, _CUPS_API_1_1_21, _CUPS_API_1_2, _CUPS_API_1_3,
38bb3cf4 MS	22	* _CUPS_API_1_4, _CUPS_API_1_5, _CUPS_API_1_6, _CUPS_API_1_7, and
	23	* _CUPS_API_2_0 - which add compiler-specific attributes that flag functions
	24	* that are deprecated, added in particular releases, or internal to CUPS.
749b1e90	25	*
8072030b	26	* On macOS, the _CUPS_API_* constants are defined based on the values of
749b1e90	27	* the MAC_OS_X_VERSION_MIN_ALLOWED and MAC_OS_X_VERSION_MAX_ALLOWED constants
e94d2f10 MS	28	* provided by the compiler.
	29	*/
	30
503b54c9	31	# if defined(__APPLE__) && !defined(_CUPS_SOURCE) && !TARGET_OS_IOS
749b1e90 MS	32	# include <AvailabilityMacros.h>
	33	# ifndef AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER
	34	# define AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER __attribute__((unavailable))
	35	# endif /* !AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER */
	36	# ifndef AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER
	37	# define AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER __attribute__((unavailable))
	38	# endif /* !AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER */
	39	# ifndef AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER
	40	# define AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER __attribute__((unavailable))
	41	# endif /* !AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER */
	42	# ifndef AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER
	43	# define AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER __attribute__((unavailable))
	44	# endif /* !AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER */
7cf5915e MS	45	# ifndef AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER
	46	# define AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER __attribute__((unavailable))
	47	# endif /* !AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER */
85dda01c MS	48	# ifndef AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER
	49	# define AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER __attribute__((unavailable))
	50	# endif /* !AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER */
a469f8a5 MS	51	# ifndef AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER
	52	# define AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER __attribute__((unavailable))
	53	# endif /* !AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER */
3ae465e7 MS	54	# ifndef AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER
	55	# define AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER __attribute__((unavailable))
	56	# endif /* !AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER */
b2e6c325 MS	57	# ifndef AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER
	58	# define AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER __attribute__((unavailable))
	59	# endif /* !AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER */
749b1e90 MS	60	# define _CUPS_API_1_1_19 AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER
	61	# define _CUPS_API_1_1_20 AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER
	62	# define _CUPS_API_1_1_21 AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER
	63	# define _CUPS_API_1_2 AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER
	64	# define _CUPS_API_1_3 AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER
	65	# define _CUPS_API_1_4 AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER
7cf5915e	66	# define _CUPS_API_1_5 AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER
c41769ff MS	67	# define _CUPS_API_1_6 AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER
c41769ff MS	68	# define _CUPS_API_1_7 AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER
3ae465e7	69	# define _CUPS_API_2_0 AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER
b2e6c325	70	# define _CUPS_API_2_2 AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER
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
5bd77a73	83	# endif /* __APPLE__ && !_CUPS_SOURCE */
e94d2f10 MS	84
e94d2f10 MS	85	/*
0fa6c7fa MS	86	* With GCC and Clang we can mark old APIs as "deprecated" or "unavailable" with
0fa6c7fa MS	87	* messages so you get warnings/errors are compile-time...
e94d2f10 MS	88	*/
e94d2f10 MS	89
0fa6c7fa MS	90	# ifdef __has_extension /* Clang */
	91	# define _CUPS_HAS_DEPRECATED
	92	# if __has_extension(attribute_deprecated_with_message)
	93	# define _CUPS_HAS_DEPRECATED_WITH_MESSAGE
	94	# endif
	95	# if __has_extension(attribute_unavailable_with_message)
	96	# define _CUPS_HAS_UNAVAILABLE_WITH_MESSAGE
	97	# endif
	98	# elif defined(__GNUC__) /* GCC and compatible */
	99	# if __GNUC__ >= 3 /* GCC 3.0 or higher */
	100	# define _CUPS_HAS_DEPRECATED
	101	# endif /* __GNUC__ >= 3 */
	102	# if __GNUC__ >= 5 /* GCC 5.x */
	103	# define _CUPS_HAS_DEPRECATED_WITH_MESSAGE
	104	# elif __GNUC__ == 4 && __GNUC_MINOR__ >= 5
	105	/* GCC 4.5 or higher */
	106	# define _CUPS_HAS_DEPRECATED_WITH_MESSAGE
	107	# endif /* __GNUC__ >= 5 */
	108	# endif /* __has_extension */
	109
	110	# if !defined(_CUPS_HAS_DEPRECATED) \|\| (defined(_CUPS_SOURCE) && !defined(_CUPS_NO_DEPRECATED))
	111	/*
	112	* Don't mark functions deprecated if the compiler doesn't support it
	113	* or we are building CUPS source that doesn't care.
	114	*/
e94d2f10	115	# define _CUPS_DEPRECATED
a469f8a5	116	# define _CUPS_DEPRECATED_MSG(m)
e666fe5e MS	117	# define _CUPS_DEPRECATED_1_6_MSG(m)
e666fe5e MS	118	# define _CUPS_DEPRECATED_1_7_MSG(m)
0fa6c7fa MS	119	# define _CUPS_INTERNAL_MSG(m)
	120	# elif defined(_CUPS_HAS_UNAVAILABLE_WITH_MESSAGE) && defined(_CUPS_NO_DEPRECATED)
	121	/*
e666fe5e	122	* Compiler supports the unavailable attribute, so use it when the code
0fa6c7fa MS	123	* wants to exclude the use of deprecated API.
	124	*/
	125	# define _CUPS_DEPRECATED __attribute__ ((unavailable))
	126	# define _CUPS_DEPRECATED_MSG(m) __attribute__ ((unavailable(m)))
e666fe5e MS	127	# define _CUPS_DEPRECATED_1_6_MSG(m) __attribute__ ((unavailable(m)))
e666fe5e MS	128	# define _CUPS_DEPRECATED_1_7_MSG(m) __attribute__ ((unavailable(m)))
0fa6c7fa MS	129	# define _CUPS_INTERNAL_MSG(m) __attribute__ ((unavailable(m)))
	130	# else
	131	/*
	132	* Compiler supports the deprecated attribute, so use it.
	133	*/
	134	# define _CUPS_DEPRECATED __attribute__ ((deprecated))
	135	# ifdef _CUPS_HAS_DEPRECATED_WITH_MESSAGE
	136	# define _CUPS_DEPRECATED_MSG(m) __attribute__ ((deprecated(m)))
	137	# else
	138	# define _CUPS_DEPRECATED_MSG(m) __attribute__ ((deprecated))
	139	# endif /* _CUPS_HAS_DEPRECATED_WITH_MESSAGE */
e666fe5e MS	140	# if defined(MAC_OS_X_VERSION_10_8) && MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_8
	141	# define _CUPS_DEPRECATED_1_6_MSG(m) _CUPS_DEPRECATED_MSG(m)
	142	# else
	143	# define _CUPS_DEPRECATED_1_6_MSG(m)
	144	# endif /* MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_8 */
	145	# if defined(MAC_OS_X_VERSION_10_9) && MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_9
	146	# define _CUPS_DEPRECATED_1_7_MSG(m) _CUPS_DEPRECATED_MSG(m)
	147	# else
	148	# define _CUPS_DEPRECATED_1_7_MSG(m)
	149	# endif /* MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_9 */
0fa6c7fa MS	150	# ifdef _CUPS_SOURCE
	151	# define _CUPS_INTERNAL_MSG(m)
	152	# elif defined(_CUPS_HAS_UNAVAILABLE_WITH_MESSAGE)
	153	# define _CUPS_INTERNAL_MSG(m) __attribute__ ((unavailable(m)))
	154	# elif defined(_CUPS_HAS_DEPRECATED_WITH_MESSAGE)
	155	# define _CUPS_INTERNAL_MSG(m) __attribute__ ((deprecated(m)))
	156	# else
	157	# define _CUPS_INTERNAL_MSG(m) __attribute__ ((deprecated))
	158	# endif /* _CUPS_SOURCE */
	159	# endif /* !_CUPS_HAS_DEPRECATED \|\| (_CUPS_SOURCE && !_CUPS_NO_DEPRECATED) */
e94d2f10	160
aaf19ab0 MS	161	# ifndef __GNUC__
	162	# define __attribute__(x)
	163	# endif /* !__GNUC__ */
	164
e94d2f10	165	#endif /* !_CUPS_VERSIONING_H_ */