Depsgraph/Python: callbacks and properties to detect datablock changes
[blender.git] / source / blender / makesdna / DNA_ID.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef DNA_ID_H
28 #define DNA_ID_H
29
30 /** \file DNA_ID.h
31  *  \ingroup DNA
32  *  \brief ID and Library types, which are fundamental for sdna.
33  */
34
35 #include "DNA_listBase.h"
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 struct Library;
42 struct FileData;
43 struct ID;
44
45 typedef struct IDPropertyData {
46         void *pointer;
47         ListBase group;
48         int val, val2; /*note, we actually fit a double into these two ints*/
49 } IDPropertyData;
50
51 typedef struct IDProperty {
52         struct IDProperty *next, *prev;
53         char type, subtype;
54         short flag;
55         char name[32];
56         int saved; /*saved is used to indicate if this struct has been saved yet.
57                                 seemed like a good idea as a pad var was needed anyway :)*/
58         IDPropertyData data;    /* note, alignment for 64 bits */
59         int len; /* array length, also (this is important!) string length + 1.
60                                 the idea is to be able to reuse array realloc functions on strings.*/
61         /*totallen is total length of allocated array/string, including a buffer.
62           Note that the buffering is mild; the code comes from python's list implementation.*/
63         int totallen; /*strings and arrays are both buffered, though the buffer isn't
64                                         saved.*/
65 } IDProperty;
66
67 #define MAX_IDPROP_NAME 32
68 #define DEFAULT_ALLOC_FOR_NULL_STRINGS  64
69
70 /*->type*/
71 #define IDP_STRING              0
72 #define IDP_INT                 1
73 #define IDP_FLOAT               2
74 #define IDP_ARRAY               5
75 #define IDP_GROUP               6
76 /* the ID link property type hasn't been implemented yet, this will require
77    some cleanup of blenkernel, most likely.*/
78 #define IDP_ID                  7
79 #define IDP_DOUBLE              8
80 #define IDP_IDPARRAY    9
81 #define IDP_NUMTYPES    10
82
83 /* add any future new id property types here.*/
84
85 /* watch it: Sequence has identical beginning. */
86 /**
87  * ID is the first thing included in all serializable types. It
88  * provides a common handle to place all data in double-linked lists.
89  * */
90
91 #define MAX_ID_NAME     24
92
93 /* There's a nasty circular dependency here.... void* to the rescue! I
94  * really wonder why this is needed. */
95 typedef struct ID {
96         void *next, *prev;
97         struct ID *newid;
98         struct Library *lib;
99         char name[24];
100         short us;
101         /**
102          * LIB_... flags report on status of the datablock this ID belongs
103          * to.
104          */
105         short flag;
106         int icon_id;
107         IDProperty *properties;
108 } ID;
109
110 /**
111  * For each library file used, a Library struct is added to Main
112  * WARNING: readfile.c, expand_doit() reads this struct without DNA check!
113  */
114 typedef struct Library {
115         ID id;
116         ID *idblock;
117         struct FileData *filedata;
118         char name[240];                 /* path name used for reading, can be relative and edited in the outliner */
119         char filepath[240];             /* absolute filepath, this is only for convenience,
120                                                          * 'name' is the real path used on file read but in
121                                                          * some cases its useful to access the absolute one,
122                                                          * This is set on file read.
123                                                          * Use BKE_library_filepath_set() rather than
124                                                          * setting 'name' directly and it will be kepk in
125                                                          * sync - campbell */
126         int tot, pad;                   /* tot, idblock and filedata are only fo read and write */
127         struct Library *parent; /* set for indirectly linked libs, used in the outliner and while reading */
128 } Library;
129
130 enum eIconSizes {
131         ICON_SIZE_ICON,
132         ICON_SIZE_PREVIEW
133 };
134 #define NUM_ICON_SIZES (ICON_SIZE_PREVIEW + 1)
135
136 typedef struct PreviewImage {
137         /* All values of 2 are really NUM_ICON_SIZES */
138         unsigned int w[2];
139         unsigned int h[2];
140         short changed[2];
141         short changed_timestamp[2];
142         unsigned int * rect[2];
143 } PreviewImage;
144
145 /**
146  * Defines for working with IDs.
147  *
148  * The tags represent types! This is a dirty way of enabling RTTI. The
149  * sig_byte end endian defines aren't really used much.
150  *
151  **/
152
153 #ifdef __BIG_ENDIAN__
154    /* big endian */
155 #  define MAKE_ID2(c, d)                ( (c)<<8 | (d) )
156 #  define MOST_SIG_BYTE                 0
157 #  define BBIG_ENDIAN
158 #else
159    /* little endian  */
160 #  define MAKE_ID2(c, d)                ( (d)<<8 | (c) )
161 #  define MOST_SIG_BYTE                 1
162 #  define BLITTLE_ENDIAN
163 #endif
164
165 /* ID from database */
166 #define ID_SCE          MAKE_ID2('S', 'C') /* Scene */
167 #define ID_LI           MAKE_ID2('L', 'I') /* Library */
168 #define ID_OB           MAKE_ID2('O', 'B') /* Object */
169 #define ID_ME           MAKE_ID2('M', 'E') /* Mesh */
170 #define ID_CU           MAKE_ID2('C', 'U') /* Curve */
171 #define ID_MB           MAKE_ID2('M', 'B') /* MetaBall */
172 #define ID_MA           MAKE_ID2('M', 'A') /* Material */
173 #define ID_TE           MAKE_ID2('T', 'E') /* Texture */
174 #define ID_IM           MAKE_ID2('I', 'M') /* Image */
175 #define ID_LT           MAKE_ID2('L', 'T') /* Lattice */
176 #define ID_LA           MAKE_ID2('L', 'A') /* Lamp */
177 #define ID_CA           MAKE_ID2('C', 'A') /* Camera */
178 #define ID_IP           MAKE_ID2('I', 'P') /* Ipo (depreciated, replaced by FCurves) */
179 #define ID_KE           MAKE_ID2('K', 'E') /* Key (shape key) */
180 #define ID_WO           MAKE_ID2('W', 'O') /* World */
181 #define ID_SCR          MAKE_ID2('S', 'R') /* Screen */
182 #define ID_SCRN         MAKE_ID2('S', 'N') /* (depreciated?) */
183 #define ID_VF           MAKE_ID2('V', 'F') /* VectorFont */
184 #define ID_TXT          MAKE_ID2('T', 'X') /* Text */
185 #define ID_SPK          MAKE_ID2('S', 'K') /* Speaker */
186 #define ID_SO           MAKE_ID2('S', 'O') /* Sound */
187 #define ID_GR           MAKE_ID2('G', 'R') /* Group */
188 #define ID_ID           MAKE_ID2('I', 'D') /* (internal use only) */
189 #define ID_AR           MAKE_ID2('A', 'R') /* Armature */
190 #define ID_AC           MAKE_ID2('A', 'C') /* Action */
191 #define ID_SCRIPT       MAKE_ID2('P', 'Y') /* Script (depreciated) */
192 #define ID_NT           MAKE_ID2('N', 'T') /* NodeTree */
193 #define ID_BR           MAKE_ID2('B', 'R') /* Brush */
194 #define ID_PA           MAKE_ID2('P', 'A') /* ParticleSettings */
195 #define ID_GD           MAKE_ID2('G', 'D') /* GreasePencil */
196 #define ID_WM           MAKE_ID2('W', 'M') /* WindowManager */
197
198         /* NOTE! Fake IDs, needed for g.sipo->blocktype or outliner */
199 #define ID_SEQ          MAKE_ID2('S', 'Q')
200                         /* constraint */
201 #define ID_CO           MAKE_ID2('C', 'O')
202                         /* pose (action channel, used to be ID_AC in code, so we keep code for backwards compat) */
203 #define ID_PO           MAKE_ID2('A', 'C')
204                         /* used in outliner... */
205 #define ID_NLA          MAKE_ID2('N', 'L')
206                         /* fluidsim Ipo */
207 #define ID_FLUIDSIM     MAKE_ID2('F', 'S')
208
209 #define ID_REAL_USERS(id) (((ID *)id)->us - ((((ID *)id)->flag & LIB_FAKEUSER) ? 1:0))
210
211 #define ID_CHECK_UNDO(id) ((GS((id)->name) != ID_SCR) && (GS((id)->name) != ID_WM))
212
213 #define ID_BLEND_PATH(_bmain, _id) ((_id)->lib ? (_id)->lib->filepath : (_bmain)->name)
214
215 #ifdef GS
216 #undef GS
217 #endif
218 #define GS(a)   (*((short *)(a)))
219
220 /* id->flag: set frist 8 bits always at zero while reading */
221 #define LIB_LOCAL               0
222 #define LIB_EXTERN              1
223 #define LIB_INDIRECT    2
224 #define LIB_TEST                8
225 #define LIB_TESTEXT             (LIB_TEST | LIB_EXTERN)
226 #define LIB_TESTIND             (LIB_TEST | LIB_INDIRECT)
227 #define LIB_READ                16
228 #define LIB_NEEDLINK    32
229
230 #define LIB_NEW                 256
231 #define LIB_FAKEUSER    512
232 /* free test flag */
233 #define LIB_DOIT                1024
234 /* tag existing data before linking so we know what is new */
235 #define LIB_PRE_EXISTING        2048
236 /* runtime */
237 #define LIB_ID_RECALC           4096
238 #define LIB_ID_RECALC_DATA      8192
239
240 #ifdef __cplusplus
241 }
242 #endif
243
244 #endif
245