Merge commit '33b88f2a4ae54d5397c45e39a5326289ebdc7747'
[ffmpeg.git] / libavutil / attributes.h
1 /*
2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * Macro definitions for various function/variable attributes
24  */
25
26 #ifndef AVUTIL_ATTRIBUTES_H
27 #define AVUTIL_ATTRIBUTES_H
28
29 #ifdef __GNUC__
30 #    define AV_GCC_VERSION_AT_LEAST(x,y) (__GNUC__ > x || __GNUC__ == x && __GNUC_MINOR__ >= y)
31 #else
32 #    define AV_GCC_VERSION_AT_LEAST(x,y) 0
33 #endif
34
35 #ifndef av_always_inline
36 #if AV_GCC_VERSION_AT_LEAST(3,1)
37 #    define av_always_inline __attribute__((always_inline)) inline
38 #elif defined(_MSC_VER)
39 #    define av_always_inline __forceinline
40 #else
41 #    define av_always_inline inline
42 #endif
43 #endif
44
45 #ifndef av_extern_inline
46 #if defined(__ICL) && __ICL >= 1210 || defined(__GNUC_STDC_INLINE__)
47 #    define av_extern_inline extern inline
48 #else
49 #    define av_extern_inline inline
50 #endif
51 #endif
52
53 #if AV_GCC_VERSION_AT_LEAST(3,1)
54 #    define av_noinline __attribute__((noinline))
55 #elif defined(_MSC_VER)
56 #    define av_noinline __declspec(noinline)
57 #else
58 #    define av_noinline
59 #endif
60
61 #if AV_GCC_VERSION_AT_LEAST(3,1)
62 #    define av_pure __attribute__((pure))
63 #else
64 #    define av_pure
65 #endif
66
67 #ifndef av_restrict
68 #define av_restrict restrict
69 #endif
70
71 #if AV_GCC_VERSION_AT_LEAST(2,6)
72 #    define av_const __attribute__((const))
73 #else
74 #    define av_const
75 #endif
76
77 #if AV_GCC_VERSION_AT_LEAST(4,3)
78 #    define av_cold __attribute__((cold))
79 #else
80 #    define av_cold
81 #endif
82
83 #if AV_GCC_VERSION_AT_LEAST(4,1)
84 #    define av_flatten __attribute__((flatten))
85 #else
86 #    define av_flatten
87 #endif
88
89 #if AV_GCC_VERSION_AT_LEAST(3,1)
90 #    define attribute_deprecated __attribute__((deprecated))
91 #elif defined(_MSC_VER)
92 #    define attribute_deprecated __declspec(deprecated)
93 #else
94 #    define attribute_deprecated
95 #endif
96
97 /**
98  * Disable warnings about deprecated features
99  * This is useful for sections of code kept for backward compatibility and
100  * scheduled for removal.
101  */
102 #ifndef AV_NOWARN_DEPRECATED
103 #if AV_GCC_VERSION_AT_LEAST(4,6)
104 #    define AV_NOWARN_DEPRECATED(code) \
105         _Pragma("GCC diagnostic push") \
106         _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") \
107         code \
108         _Pragma("GCC diagnostic pop")
109 #elif defined(_MSC_VER)
110 #    define AV_NOWARN_DEPRECATED(code) \
111         __pragma(warning(push)) \
112         __pragma(warning(disable : 4996)) \
113         code; \
114         __pragma(warning(pop))
115 #else
116 #    define AV_NOWARN_DEPRECATED(code) code
117 #endif
118 #endif
119
120
121 #if defined(__GNUC__)
122 #    define av_unused __attribute__((unused))
123 #else
124 #    define av_unused
125 #endif
126
127 /**
128  * Mark a variable as used and prevent the compiler from optimizing it
129  * away.  This is useful for variables accessed only from inline
130  * assembler without the compiler being aware.
131  */
132 #if AV_GCC_VERSION_AT_LEAST(3,1)
133 #    define av_used __attribute__((used))
134 #else
135 #    define av_used
136 #endif
137
138 #if AV_GCC_VERSION_AT_LEAST(3,3)
139 #   define av_alias __attribute__((may_alias))
140 #else
141 #   define av_alias
142 #endif
143
144 #if defined(__GNUC__) && !defined(__INTEL_COMPILER) && !defined(__clang__)
145 #    define av_uninit(x) x=x
146 #else
147 #    define av_uninit(x) x
148 #endif
149
150 #ifdef __GNUC__
151 #    define av_builtin_constant_p __builtin_constant_p
152 #    define av_printf_format(fmtpos, attrpos) __attribute__((__format__(__printf__, fmtpos, attrpos)))
153 #else
154 #    define av_builtin_constant_p(x) 0
155 #    define av_printf_format(fmtpos, attrpos)
156 #endif
157
158 #if AV_GCC_VERSION_AT_LEAST(2,5)
159 #    define av_noreturn __attribute__((noreturn))
160 #else
161 #    define av_noreturn
162 #endif
163
164 #endif /* AVUTIL_ATTRIBUTES_H */