Cleanup: GPencil Clarify comment
[blender.git] / source / blender / makesdna / DNA_defs.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup DNA
19  *
20  * Group generic defines for all DNA headers may use in this file.
21  */
22
23 #ifndef __DNA_DEFS_H__
24 #define __DNA_DEFS_H__
25
26 /* makesdna ignores */
27 #ifdef DNA_DEPRECATED_ALLOW
28 /* allow use of deprecated items */
29 #  define DNA_DEPRECATED
30 #else
31 #  ifndef DNA_DEPRECATED
32 #    ifdef __GNUC__
33 #      define DNA_DEPRECATED __attribute__((deprecated))
34 #    else
35 /* TODO, msvc & others */
36 #      define DNA_DEPRECATED
37 #    endif
38 #  endif
39 #endif
40
41 #ifdef __GNUC__
42 #  define DNA_PRIVATE_ATTR __attribute__((deprecated))
43 #else
44 #  define DNA_PRIVATE_ATTR
45 #endif
46
47 /* poison pragma */
48 #ifdef DNA_DEPRECATED_ALLOW
49 #  define DNA_DEPRECATED_GCC_POISON 0
50 #else
51 /* enable the pragma if we can */
52 #  ifdef __GNUC__
53 #    define DNA_DEPRECATED_GCC_POISON 1
54 #  else
55 #    define DNA_DEPRECATED_GCC_POISON 0
56 #  endif
57 #endif
58
59 /* hrmf, we need a better include then this */
60 #include "../blenlib/BLI_sys_types.h" /* needed for int64_t only! */
61
62 /* non-id name variables should use this length */
63 #define MAX_NAME 64
64
65 #endif /* __DNA_DEFS_H__ */