attributes.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  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. * @file
  22. * Macro definitions for various function/variable attributes
  23. */
  24. #ifndef AVUTIL_ATTRIBUTES_H
  25. #define AVUTIL_ATTRIBUTES_H
  26. #ifdef __GNUC__
  27. # define AV_GCC_VERSION_AT_LEAST(x,y) (__GNUC__ > (x) || __GNUC__ == (x) && __GNUC_MINOR__ >= (y))
  28. # define AV_GCC_VERSION_AT_MOST(x,y) (__GNUC__ < (x) || __GNUC__ == (x) && __GNUC_MINOR__ <= (y))
  29. #else
  30. # define AV_GCC_VERSION_AT_LEAST(x,y) 0
  31. # define AV_GCC_VERSION_AT_MOST(x,y) 0
  32. #endif
  33. #ifdef __has_builtin
  34. # define AV_HAS_BUILTIN(x) __has_builtin(x)
  35. #else
  36. # define AV_HAS_BUILTIN(x) 0
  37. #endif
  38. #ifndef av_always_inline
  39. #if AV_GCC_VERSION_AT_LEAST(3,1)
  40. # define av_always_inline __attribute__((always_inline)) inline
  41. #elif defined(_MSC_VER)
  42. # define av_always_inline __forceinline
  43. #else
  44. # define av_always_inline inline
  45. #endif
  46. #endif
  47. #ifndef av_extern_inline
  48. #if defined(__ICL) && __ICL >= 1210 || defined(__GNUC_STDC_INLINE__)
  49. # define av_extern_inline extern inline
  50. #else
  51. # define av_extern_inline inline
  52. #endif
  53. #endif
  54. #if AV_GCC_VERSION_AT_LEAST(3,4)
  55. # define av_warn_unused_result __attribute__((warn_unused_result))
  56. #else
  57. # define av_warn_unused_result
  58. #endif
  59. #if AV_GCC_VERSION_AT_LEAST(3,1)
  60. # define av_noinline __attribute__((noinline))
  61. #elif defined(_MSC_VER)
  62. # define av_noinline __declspec(noinline)
  63. #else
  64. # define av_noinline
  65. #endif
  66. #if AV_GCC_VERSION_AT_LEAST(3,1) || defined(__clang__)
  67. # define av_pure __attribute__((pure))
  68. #else
  69. # define av_pure
  70. #endif
  71. #if AV_GCC_VERSION_AT_LEAST(2,6) || defined(__clang__)
  72. # define av_const __attribute__((const))
  73. #else
  74. # define av_const
  75. #endif
  76. #if AV_GCC_VERSION_AT_LEAST(4,3) || defined(__clang__)
  77. # define av_cold __attribute__((cold))
  78. #else
  79. # define av_cold
  80. #endif
  81. #if AV_GCC_VERSION_AT_LEAST(4,1) && !defined(__llvm__)
  82. # define av_flatten __attribute__((flatten))
  83. #else
  84. # define av_flatten
  85. #endif
  86. #if AV_GCC_VERSION_AT_LEAST(3,1)
  87. # define attribute_deprecated __attribute__((deprecated))
  88. #elif defined(_MSC_VER)
  89. # define attribute_deprecated __declspec(deprecated)
  90. #else
  91. # define attribute_deprecated
  92. #endif
  93. /**
  94. * Disable warnings about deprecated features
  95. * This is useful for sections of code kept for backward compatibility and
  96. * scheduled for removal.
  97. */
  98. #ifndef AV_NOWARN_DEPRECATED
  99. #if AV_GCC_VERSION_AT_LEAST(4,6) || defined(__clang__)
  100. # define AV_NOWARN_DEPRECATED(code) \
  101. _Pragma("GCC diagnostic push") \
  102. _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") \
  103. code \
  104. _Pragma("GCC diagnostic pop")
  105. #elif defined(_MSC_VER)
  106. # define AV_NOWARN_DEPRECATED(code) \
  107. __pragma(warning(push)) \
  108. __pragma(warning(disable : 4996)) \
  109. code; \
  110. __pragma(warning(pop))
  111. #else
  112. # define AV_NOWARN_DEPRECATED(code) code
  113. #endif
  114. #endif
  115. #if defined(__GNUC__) || defined(__clang__)
  116. # define av_unused __attribute__((unused))
  117. #else
  118. # define av_unused
  119. #endif
  120. /**
  121. * Mark a variable as used and prevent the compiler from optimizing it
  122. * away. This is useful for variables accessed only from inline
  123. * assembler without the compiler being aware.
  124. */
  125. #if AV_GCC_VERSION_AT_LEAST(3,1) || defined(__clang__)
  126. # define av_used __attribute__((used))
  127. #else
  128. # define av_used
  129. #endif
  130. #if AV_GCC_VERSION_AT_LEAST(3,3) || defined(__clang__)
  131. # define av_alias __attribute__((may_alias))
  132. #else
  133. # define av_alias
  134. #endif
  135. #if (defined(__GNUC__) || defined(__clang__)) && !defined(__INTEL_COMPILER)
  136. # define av_uninit(x) x=x
  137. #else
  138. # define av_uninit(x) x
  139. #endif
  140. #if defined(__GNUC__) || defined(__clang__)
  141. # define av_builtin_constant_p __builtin_constant_p
  142. # define av_printf_format(fmtpos, attrpos) __attribute__((__format__(__printf__, fmtpos, attrpos)))
  143. #else
  144. # define av_builtin_constant_p(x) 0
  145. # define av_printf_format(fmtpos, attrpos)
  146. #endif
  147. #if AV_GCC_VERSION_AT_LEAST(2,5) || defined(__clang__)
  148. # define av_noreturn __attribute__((noreturn))
  149. #else
  150. # define av_noreturn
  151. #endif
  152. #endif /* AVUTIL_ATTRIBUTES_H */