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