2b6baa0d67b0bc94bbaf5c6dafc428f2f0b82014
[blender.git] / source / blender / blenlib / BLI_compiler_attrs.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2013 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Campbell Barton
24  *                 Sergey Sharybin
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #ifndef __BLI_COMPILER_ATTRS_H__
30 #define __BLI_COMPILER_ATTRS_H__
31
32 /** \file BLI_compiler_attrs.h
33  *  \ingroup bli
34  */
35
36 /* hint to make sure function result is actually used */
37 #ifdef __GNUC__
38 #  define ATTR_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
39 #else
40 #  define ATTR_WARN_UNUSED_RESULT
41 #endif
42
43 /* hint to mark function arguments expected to be non-null
44  * if no arguments are given to the macro, all of pointer
45  * arguments would be expected to be non-null
46  */
47 #ifdef __GNUC__
48 #  define ATTR_NONNULL(args ...) __attribute__((nonnull(args)))
49 #else
50 #  define ATTR_NONNULL(...)
51 #endif
52
53 /* never returns NULL */
54 #  if (__GNUC__ * 100 + __GNUC_MINOR__) >= 409  /* gcc4.9+ only */
55 #  define ATTR_RETURNS_NONNULL __attribute__((returns_nonnull))
56 #else
57 #  define ATTR_RETURNS_NONNULL
58 #endif
59
60 /* hint to mark function as it wouldn't return */
61 #if defined(__GNUC__) || defined(__clang__)
62 #  define ATTR_NORETURN __attribute__((noreturn))
63 #else
64 #  define ATTR_NORETURN
65 #endif
66
67 /* hint to treat any non-null function return value cannot alias any other pointer */
68 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 403))
69 #  define ATTR_MALLOC __attribute__((malloc))
70 #else
71 #  define ATTR_MALLOC
72 #endif
73
74 /* the function return value points to memory (2 args for 'size * tot') */
75 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 403))
76 #  define ATTR_ALLOC_SIZE(args ...) __attribute__((alloc_size(args)))
77 #else
78 #  define ATTR_ALLOC_SIZE(...)
79 #endif
80
81 /* ensures a NULL terminating argument as the n'th last argument of a variadic function */
82 #ifdef __GNUC__
83 #  define ATTR_SENTINEL(arg_pos) __attribute__((sentinel(arg_pos)))
84 #else
85 #  define ATTR_SENTINEL(arg_pos)
86 #endif
87
88 /* hint to compiler that function uses printf-style format string */
89 #ifdef __GNUC__
90 #  define ATTR_PRINTF_FORMAT(format_param, dots_param) __attribute__((format(printf, format_param, dots_param)))
91 #else
92 #  define ATTR_PRINTF_FORMAT(format_param, dots_param)
93 #endif
94
95 /* Use to suppress '-Wimplicit-fallthrough' (in place of 'break'). */
96 #if defined(__GNUC__) && (__GNUC__ >= 7)  /* gcc7.0+ only */
97 #  define ATTR_FALLTHROUGH __attribute__((fallthrough))
98 #else
99 #  define ATTR_FALLTHROUGH ((void)0)
100 #endif
101
102 /* Declare the memory alignment in Bytes. */
103 #if defined(_WIN32) && !defined(FREE_WINDOWS)
104 #  define ATTR_ALIGN(x) __declspec(align(x))
105 #else
106 #  define ATTR_ALIGN(x) __attribute__((aligned(x)))
107 #endif
108
109 #endif  /* __BLI_COMPILER_ATTRS_H__ */