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