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