svn merge ^/trunk/blender -r42918:42920
[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 /*->subtype */
84
85 /* IDP_STRING */
86 #define IDP_STRING_SUB_UTF8  0 /* default */
87 #define IDP_STRING_SUB_BYTE  1 /* arbitrary byte array, _not_ null terminated */
88
89
90 /* add any future new id property types here.*/
91
92 /* watch it: Sequence has identical beginning. */
93 /**
94  * ID is the first thing included in all serializable types. It
95  * provides a common handle to place all data in double-linked lists.
96  * */
97
98 #define MAX_ID_NAME     24
99
100 /* There's a nasty circular dependency here.... void* to the rescue! I
101  * really wonder why this is needed. */
102 typedef struct ID {
103         void *next, *prev;
104         struct ID *newid;
105         struct Library *lib;
106         char name[24];
107         short us;
108         /**
109          * LIB_... flags report on status of the datablock this ID belongs
110          * to.
111          */
112         short flag;
113         int icon_id;
114         IDProperty *properties;
115 } ID;
116
117 /**
118  * For each library file used, a Library struct is added to Main
119  * WARNING: readfile.c, expand_doit() reads this struct without DNA check!
120  */
121 typedef struct Library {
122         ID id;
123         ID *idblock;
124         struct FileData *filedata;
125         char name[240];                 /* path name used for reading, can be relative and edited in the outliner */
126         char filepath[240];             /* absolute filepath, this is only for convenience,
127                                                          * 'name' is the real path used on file read but in
128                                                          * some cases its useful to access the absolute one,
129                                                          * This is set on file read.
130                                                          * Use BKE_library_filepath_set() rather than
131                                                          * setting 'name' directly and it will be kepk in
132                                                          * sync - campbell */
133         int tot, pad;                   /* tot, idblock and filedata are only fo read and write */
134         struct Library *parent; /* set for indirectly linked libs, used in the outliner and while reading */
135 } Library;
136
137 enum eIconSizes {
138         ICON_SIZE_ICON,
139         ICON_SIZE_PREVIEW
140 };
141 #define NUM_ICON_SIZES (ICON_SIZE_PREVIEW + 1)
142
143 typedef struct PreviewImage {
144         /* All values of 2 are really NUM_ICON_SIZES */
145         unsigned int w[2];
146         unsigned int h[2];
147         short changed[2];
148         short changed_timestamp[2];
149         unsigned int * rect[2];
150 } PreviewImage;
151
152 /**
153  * Defines for working with IDs.
154  *
155  * The tags represent types! This is a dirty way of enabling RTTI. The
156  * sig_byte end endian defines aren't really used much.
157  *
158  **/
159
160 #ifdef __BIG_ENDIAN__
161    /* big endian */
162 #  define MAKE_ID2(c, d)                ( (c)<<8 | (d) )
163 #  define MOST_SIG_BYTE                 0
164 #  define BBIG_ENDIAN
165 #else
166    /* little endian  */
167 #  define MAKE_ID2(c, d)                ( (d)<<8 | (c) )
168 #  define MOST_SIG_BYTE                 1
169 #  define BLITTLE_ENDIAN
170 #endif
171
172 /* ID from database */
173 #define ID_SCE          MAKE_ID2('S', 'C') /* Scene */
174 #define ID_LI           MAKE_ID2('L', 'I') /* Library */
175 #define ID_OB           MAKE_ID2('O', 'B') /* Object */
176 #define ID_ME           MAKE_ID2('M', 'E') /* Mesh */
177 #define ID_CU           MAKE_ID2('C', 'U') /* Curve */
178 #define ID_MB           MAKE_ID2('M', 'B') /* MetaBall */
179 #define ID_MA           MAKE_ID2('M', 'A') /* Material */
180 #define ID_TE           MAKE_ID2('T', 'E') /* Texture */
181 #define ID_IM           MAKE_ID2('I', 'M') /* Image */
182 #define ID_LT           MAKE_ID2('L', 'T') /* Lattice */
183 #define ID_LA           MAKE_ID2('L', 'A') /* Lamp */
184 #define ID_CA           MAKE_ID2('C', 'A') /* Camera */
185 #define ID_IP           MAKE_ID2('I', 'P') /* Ipo (depreciated, replaced by FCurves) */
186 #define ID_KE           MAKE_ID2('K', 'E') /* Key (shape key) */
187 #define ID_WO           MAKE_ID2('W', 'O') /* World */
188 #define ID_SCR          MAKE_ID2('S', 'R') /* Screen */
189 #define ID_SCRN         MAKE_ID2('S', 'N') /* (depreciated?) */
190 #define ID_VF           MAKE_ID2('V', 'F') /* VectorFont */
191 #define ID_TXT          MAKE_ID2('T', 'X') /* Text */
192 #define ID_SPK          MAKE_ID2('S', 'K') /* Speaker */
193 #define ID_SO           MAKE_ID2('S', 'O') /* Sound */
194 #define ID_GR           MAKE_ID2('G', 'R') /* Group */
195 #define ID_ID           MAKE_ID2('I', 'D') /* (internal use only) */
196 #define ID_AR           MAKE_ID2('A', 'R') /* Armature */
197 #define ID_AC           MAKE_ID2('A', 'C') /* Action */
198 #define ID_SCRIPT       MAKE_ID2('P', 'Y') /* Script (depreciated) */
199 #define ID_NT           MAKE_ID2('N', 'T') /* NodeTree */
200 #define ID_BR           MAKE_ID2('B', 'R') /* Brush */
201 #define ID_PA           MAKE_ID2('P', 'A') /* ParticleSettings */
202 #define ID_GD           MAKE_ID2('G', 'D') /* GreasePencil */
203 #define ID_WM           MAKE_ID2('W', 'M') /* WindowManager */
204 #define ID_MC           MAKE_ID2('M', 'C') /* MovieClip */
205
206         /* NOTE! Fake IDs, needed for g.sipo->blocktype or outliner */
207 #define ID_SEQ          MAKE_ID2('S', 'Q')
208                         /* constraint */
209 #define ID_CO           MAKE_ID2('C', 'O')
210                         /* pose (action channel, used to be ID_AC in code, so we keep code for backwards compat) */
211 #define ID_PO           MAKE_ID2('A', 'C')
212                         /* used in outliner... */
213 #define ID_NLA          MAKE_ID2('N', 'L')
214                         /* fluidsim Ipo */
215 #define ID_FLUIDSIM     MAKE_ID2('F', 'S')
216
217 #define ID_REAL_USERS(id) (((ID *)id)->us - ((((ID *)id)->flag & LIB_FAKEUSER) ? 1:0))
218
219 #define ID_CHECK_UNDO(id) ((GS((id)->name) != ID_SCR) && (GS((id)->name) != ID_WM))
220
221 #define ID_BLEND_PATH(_bmain, _id) ((_id)->lib ? (_id)->lib->filepath : (_bmain)->name)
222
223 #ifdef GS
224 #undef GS
225 #endif
226 #define GS(a)   (*((short *)(a)))
227
228 /* id->flag: set frist 8 bits always at zero while reading */
229 #define LIB_LOCAL               0
230 #define LIB_EXTERN              1
231 #define LIB_INDIRECT    2
232 #define LIB_TEST                8
233 #define LIB_TESTEXT             (LIB_TEST | LIB_EXTERN)
234 #define LIB_TESTIND             (LIB_TEST | LIB_INDIRECT)
235 #define LIB_READ                16
236 #define LIB_NEEDLINK    32
237
238 #define LIB_NEW                 256
239 #define LIB_FAKEUSER    512
240 /* free test flag */
241 #define LIB_DOIT                1024
242 /* tag existing data before linking so we know what is new */
243 #define LIB_PRE_EXISTING        2048
244 /* runtime */
245 #define LIB_ID_RECALC           4096
246 #define LIB_ID_RECALC_DATA      8192
247
248 #ifdef __cplusplus
249 }
250 #endif
251
252 #endif
253