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

/*
 * "$Id$"
 *
 *   API versioning definitions for CUPS.
 *
 *   Copyright 2007-2015 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
 *   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 OS X, 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)
#    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 */
#    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
#  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_ */

/*
 * End of "$Id$".
 */
Commit	Line	Data
e94d2f10 MS	1	/*
	2	* "$Id$"
	3	*
aaf19ab0	4	* API versioning definitions for CUPS.
e94d2f10	5	*
5ae9fbb3	6	* Copyright 2007-2015 by Apple Inc.
e94d2f10 MS	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,
0fa6c7fa MS	22	* _CUPS_DEPRECATED_MSG, _CUPS_INTERNAL_MSG, _CUPS_API_1_1, _CUPS_API_1_1_19,
0fa6c7fa MS	23	* _CUPS_API_1_1_20, _CUPS_API_1_1_21, _CUPS_API_1_2, _CUPS_API_1_3,
38bb3cf4 MS	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.
749b1e90	27	*
f3c17241	28	* On OS X, the _CUPS_API_* constants are defined based on the values of
749b1e90	29	* the MAC_OS_X_VERSION_MIN_ALLOWED and MAC_OS_X_VERSION_MAX_ALLOWED constants
e94d2f10 MS	30	* provided by the compiler.
	31	*/
	32
	33	# if defined(__APPLE__) && !defined(_CUPS_SOURCE)
749b1e90 MS	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 */
7cf5915e MS	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 */
85dda01c MS	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 */
a469f8a5 MS	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 */
3ae465e7 MS	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 */
749b1e90 MS	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
7cf5915e	65	# define _CUPS_API_1_5 AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER
c41769ff MS	66	# define _CUPS_API_1_6 AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER
c41769ff MS	67	# define _CUPS_API_1_7 AVAILABLE_MAC_OS_X_VERSION_10_9_AND_LATER
3ae465e7	68	# define _CUPS_API_2_0 AVAILABLE_MAC_OS_X_VERSION_10_10_AND_LATER
5ae9fbb3	69	# define _CUPS_API_2_2
e94d2f10 MS	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
c7017ecc	77	# define _CUPS_API_1_5
85dda01c	78	# define _CUPS_API_1_6
a469f8a5	79	# define _CUPS_API_1_7
38bb3cf4	80	# define _CUPS_API_2_0
5ae9fbb3	81	# define _CUPS_API_2_2
5bd77a73	82	# endif /* __APPLE__ && !_CUPS_SOURCE */
e94d2f10 MS	83
e94d2f10 MS	84	/*
0fa6c7fa MS	85	* With GCC and Clang we can mark old APIs as "deprecated" or "unavailable" with
0fa6c7fa MS	86	* messages so you get warnings/errors are compile-time...
e94d2f10 MS	87	*/
e94d2f10 MS	88
0fa6c7fa MS	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	*/
e94d2f10	114	# define _CUPS_DEPRECATED
a469f8a5	115	# define _CUPS_DEPRECATED_MSG(m)
e666fe5e MS	116	# define _CUPS_DEPRECATED_1_6_MSG(m)
e666fe5e MS	117	# define _CUPS_DEPRECATED_1_7_MSG(m)
0fa6c7fa MS	118	# define _CUPS_INTERNAL_MSG(m)
	119	# elif defined(_CUPS_HAS_UNAVAILABLE_WITH_MESSAGE) && defined(_CUPS_NO_DEPRECATED)
	120	/*
e666fe5e	121	* Compiler supports the unavailable attribute, so use it when the code
0fa6c7fa MS	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)))
e666fe5e MS	126	# define _CUPS_DEPRECATED_1_6_MSG(m) __attribute__ ((unavailable(m)))
e666fe5e MS	127	# define _CUPS_DEPRECATED_1_7_MSG(m) __attribute__ ((unavailable(m)))
0fa6c7fa MS	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 */
e666fe5e MS	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 */
0fa6c7fa MS	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) */
e94d2f10	159
aaf19ab0 MS	160	# ifndef __GNUC__
	161	# define __attribute__(x)
	162	# endif /* !__GNUC__ */
	163
e94d2f10 MS	164	#endif /* !_CUPS_VERSIONING_H_ */
	165
	166	/*
	167	* End of "$Id$".
	168	*/