Merge remote-tracking branch 'qatar/master'
[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 #ifndef av_noreturn
54 #if AV_GCC_VERSION_AT_LEAST(2,5)
55 #    define av_noreturn __attribute__((noreturn))
56 #else
57 #    define av_noreturn
58 #endif
59 #endif
60
61 #ifndef av_noinline
62 #if AV_GCC_VERSION_AT_LEAST(3,1)
63 #    define av_noinline __attribute__((noinline))
64 #else
65 #    define av_noinline
66 #endif
67 #endif
68
69 #ifndef av_pure
70 #if AV_GCC_VERSION_AT_LEAST(3,1)
71 #    define av_pure __attribute__((pure))
72 #else
73 #    define av_pure
74 #endif
75 #endif
76
77 #ifndef av_restrict
78 #define av_restrict restrict
79 #endif
80
81 #ifndef av_const
82 #if AV_GCC_VERSION_AT_LEAST(2,6)
83 #    define av_const __attribute__((const))
84 #else
85 #    define av_const
86 #endif
87 #endif
88
89 #ifndef av_cold
90 #if AV_GCC_VERSION_AT_LEAST(4,3)
91 #    define av_cold __attribute__((cold))
92 #else
93 #    define av_cold
94 #endif
95 #endif
96
97 #ifndef av_flatten
98 #if AV_GCC_VERSION_AT_LEAST(4,1)
99 #    define av_flatten __attribute__((flatten))
100 #else
101 #    define av_flatten
102 #endif
103 #endif
104
105 #ifndef attribute_deprecated
106 #if AV_GCC_VERSION_AT_LEAST(3,1)
107 #    define attribute_deprecated __attribute__((deprecated))
108 #else
109 #    define attribute_deprecated
110 #endif
111 #endif
112
113 /**
114  * Disable warnings about deprecated features
115  * This is useful for sections of code kept for backward compatibility and
116  * scheduled for removal.
117  */
118 #ifndef AV_NOWARN_DEPRECATED
119 #if AV_GCC_VERSION_AT_LEAST(4,6)
120 #    define AV_NOWARN_DEPRECATED(code) \
121         _Pragma("GCC diagnostic push") \
122         _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") \
123         code \
124         _Pragma("GCC diagnostic pop")
125 #else
126 #    define AV_NOWARN_DEPRECATED(code) code
127 #endif
128 #endif
129
130
131 #ifndef av_unused
132 #if defined(__GNUC__)
133 #    define av_unused __attribute__((unused))
134 #else
135 #    define av_unused
136 #endif
137 #endif
138
139 /**
140  * Mark a variable as used and prevent the compiler from optimizing it
141  * away.  This is useful for variables accessed only from inline
142  * assembler without the compiler being aware.
143  */
144 #ifndef av_used
145 #if AV_GCC_VERSION_AT_LEAST(3,1)
146 #    define av_used __attribute__((used))
147 #else
148 #    define av_used
149 #endif
150 #endif
151
152 #ifndef av_alias
153 #if AV_GCC_VERSION_AT_LEAST(3,3)
154 #   define av_alias __attribute__((may_alias))
155 #else
156 #   define av_alias
157 #endif
158 #endif
159
160 #ifndef av_uninit
161 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
162 #    define av_uninit(x) x=x
163 #else
164 #    define av_uninit(x) x
165 #endif
166 #endif
167
168 #ifdef __GNUC__
169 #    define av_builtin_constant_p __builtin_constant_p
170 #    define av_printf_format(fmtpos, attrpos) __attribute__((__format__(__printf__, fmtpos, attrpos)))
171 #else
172 #    define av_builtin_constant_p(x) 0
173 #    define av_printf_format(fmtpos, attrpos)
174 #endif
175
176 #endif /* AVUTIL_ATTRIBUTES_H */