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