remove unused rna includes
[blender.git] / source / blender / makesrna / intern / rna_ID.c
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  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26 #include <stdio.h>
27
28 #include "RNA_access.h"
29 #include "RNA_define.h"
30
31 #include "DNA_ID.h"
32
33 #include "WM_types.h"
34
35 #include "rna_internal.h"
36
37 /* enum of ID-block types 
38  * NOTE: need to keep this in line with the other defines for these
39  */
40 EnumPropertyItem id_type_items[] = {
41         {ID_AC, "ACTION", ICON_ACTION, "Action", ""},
42         {ID_AR, "ARMATURE", ICON_ARMATURE_DATA, "Armature", ""},
43         {ID_BR, "BRUSH", ICON_BRUSH_DATA, "Brush", ""},
44         {ID_CA, "CAMERA", ICON_CAMERA_DATA, "Camera", ""},
45         {ID_CU, "CURVE", ICON_CURVE_DATA, "Curve", ""},
46         {ID_VF, "FONT", ICON_FONT_DATA, "Font", ""},
47         {ID_GD, "GREASEPENCIL", ICON_GREASEPENCIL, "Grease Pencil", ""},
48         {ID_GR, "GROUP", ICON_GROUP, "Group", ""},
49         {ID_IM, "IMAGE", ICON_IMAGE_DATA, "Image", ""},
50         {ID_KE, "KEY", ICON_SHAPEKEY_DATA, "Key", ""},
51         {ID_LA, "LAMP", ICON_LAMP_DATA, "Lamp", ""},
52         {ID_LI, "LIBRARY", ICON_LIBRARY_DATA_DIRECT, "Library", ""},
53         {ID_LT, "LATTICE", ICON_LATTICE_DATA, "Lattice", ""},
54         {ID_MA, "MATERIAL", ICON_MATERIAL_DATA, "Material", ""},
55         {ID_MB, "META", ICON_META_DATA, "MetaBall", ""},
56         {ID_ME, "MESH", ICON_MESH_DATA, "Mesh", ""},
57         {ID_NT, "NODETREE", ICON_NODETREE, "NodeTree", ""},
58         {ID_OB, "OBJECT", ICON_OBJECT_DATA, "Object", ""},
59         {ID_PA, "PARTICLE", ICON_PARTICLE_DATA, "Particle", ""},
60         {ID_SCE, "SCENE", ICON_SCENE_DATA, "Scene", ""},
61         {ID_SCR, "SCREEN", ICON_SPLITSCREEN, "Screen", ""},
62         {ID_SO, "SOUND", ICON_PLAY_AUDIO, "Sound", ""},
63         {ID_TXT, "TEXT", ICON_TEXT, "Text", ""},
64         {ID_TE, "TEXTURE", ICON_TEXTURE_DATA, "Texture", ""},
65         {ID_WO, "WORLD", ICON_WORLD_DATA, "World", ""},
66         {ID_WM, "WINDOWMANAGER", ICON_FULLSCREEN, "Window Manager", ""},
67         {0, NULL, 0, NULL, NULL}};
68
69 #ifdef RNA_RUNTIME
70
71 #include "BKE_idprop.h"
72 #include "BKE_library.h"
73 #include "BKE_animsys.h"
74
75 /* name functions that ignore the first two ID characters */
76 void rna_ID_name_get(PointerRNA *ptr, char *value)
77 {
78         ID *id= (ID*)ptr->data;
79         BLI_strncpy(value, id->name+2, sizeof(id->name)-2);
80 }
81
82 int rna_ID_name_length(PointerRNA *ptr)
83 {
84         ID *id= (ID*)ptr->data;
85         return strlen(id->name+2);
86 }
87
88 void rna_ID_name_set(PointerRNA *ptr, const char *value)
89 {
90         ID *id= (ID*)ptr->data;
91         BLI_strncpy(id->name+2, value, sizeof(id->name)-2);
92         test_idbutton(id->name+2);
93 }
94
95 static int rna_ID_name_editable(PointerRNA *ptr)
96 {
97         ID *id= (ID*)ptr->data;
98         
99         if (GS(id->name) == ID_VF) {
100                 if (strcmp(id->name+2, "<builtin>")==0)
101                         return 0;
102         }
103         
104         return 1;
105 }
106
107 short RNA_type_to_ID_code(StructRNA *type)
108 {
109         if(RNA_struct_is_a(type, &RNA_Action)) return ID_AC;
110         if(RNA_struct_is_a(type, &RNA_Armature)) return ID_AR;
111         if(RNA_struct_is_a(type, &RNA_Brush)) return ID_BR;
112         if(RNA_struct_is_a(type, &RNA_Camera)) return ID_CA;
113         if(RNA_struct_is_a(type, &RNA_Curve)) return ID_CU;
114         if(RNA_struct_is_a(type, &RNA_GreasePencil)) return ID_GD;
115         if(RNA_struct_is_a(type, &RNA_Group)) return ID_GR;
116         if(RNA_struct_is_a(type, &RNA_Image)) return ID_IM;
117         if(RNA_struct_is_a(type, &RNA_Key)) return ID_KE;
118         if(RNA_struct_is_a(type, &RNA_Lamp)) return ID_LA;
119         if(RNA_struct_is_a(type, &RNA_Library)) return ID_LI;
120         if(RNA_struct_is_a(type, &RNA_Lattice)) return ID_LT;
121         if(RNA_struct_is_a(type, &RNA_Material)) return ID_MA;
122         if(RNA_struct_is_a(type, &RNA_MetaBall)) return ID_MB;
123         if(RNA_struct_is_a(type, &RNA_NodeTree)) return ID_NT;
124         if(RNA_struct_is_a(type, &RNA_Mesh)) return ID_ME;
125         if(RNA_struct_is_a(type, &RNA_Object)) return ID_OB;
126         if(RNA_struct_is_a(type, &RNA_ParticleSettings)) return ID_PA;
127         if(RNA_struct_is_a(type, &RNA_Scene)) return ID_SCE;
128         if(RNA_struct_is_a(type, &RNA_Screen)) return ID_SCR;
129         if(RNA_struct_is_a(type, &RNA_Sound)) return ID_SO;
130         if(RNA_struct_is_a(type, &RNA_Text)) return ID_TXT;
131         if(RNA_struct_is_a(type, &RNA_Texture)) return ID_TE;
132         if(RNA_struct_is_a(type, &RNA_VectorFont)) return ID_VF;
133         if(RNA_struct_is_a(type, &RNA_World)) return ID_WO;
134         if(RNA_struct_is_a(type, &RNA_WindowManager)) return ID_WM;
135
136         return 0;
137 }
138
139 StructRNA *ID_code_to_RNA_type(short idcode)
140 {
141         switch(idcode) {
142                 case ID_AC: return &RNA_Action;
143                 case ID_AR: return &RNA_Armature;
144                 case ID_BR: return &RNA_Brush;
145                 case ID_CA: return &RNA_Camera;
146                 case ID_CU: return &RNA_Curve;
147                 case ID_GD: return &RNA_GreasePencil;
148                 case ID_GR: return &RNA_Group;
149                 case ID_IM: return &RNA_Image;
150                 case ID_KE: return &RNA_Key;
151                 case ID_LA: return &RNA_Lamp;
152                 case ID_LI: return &RNA_Library;
153                 case ID_LT: return &RNA_Lattice;
154                 case ID_MA: return &RNA_Material;
155                 case ID_MB: return &RNA_MetaBall;
156                 case ID_NT: return &RNA_NodeTree;
157                 case ID_ME: return &RNA_Mesh;
158                 case ID_OB: return &RNA_Object;
159                 case ID_PA: return &RNA_ParticleSettings;
160                 case ID_SCE: return &RNA_Scene;
161                 case ID_SCR: return &RNA_Screen;
162                 case ID_SO: return &RNA_Sound;
163                 case ID_TXT: return &RNA_Text;
164                 case ID_TE: return &RNA_Texture;
165                 case ID_VF: return &RNA_VectorFont;
166                 case ID_WO: return &RNA_World;
167                 case ID_WM: return &RNA_WindowManager;
168                 default: return &RNA_ID;
169         }
170 }
171
172 StructRNA *rna_ID_refine(PointerRNA *ptr)
173 {
174         ID *id= (ID*)ptr->data;
175
176         return ID_code_to_RNA_type(GS(id->name));
177 }
178
179 IDProperty *rna_ID_idproperties(PointerRNA *ptr, int create)
180 {
181         return IDP_GetProperties(ptr->data, create);
182 }
183
184 void rna_ID_fake_user_set(PointerRNA *ptr, int value)
185 {
186         ID *id= (ID*)ptr->data;
187
188         if(value && !(id->flag & LIB_FAKEUSER)) {
189                 id->flag |= LIB_FAKEUSER;
190                 id->us++;
191         }
192         else if(!value && (id->flag & LIB_FAKEUSER)) {
193                 id->flag &= ~LIB_FAKEUSER;
194                 id->us--;
195         }
196 }
197
198 IDProperty *rna_IDPropertyGroup_idproperties(PointerRNA *ptr, int create)
199 {
200         return ptr->data;
201 }
202
203 void rna_IDPropertyGroup_unregister(const bContext *C, StructRNA *type)
204 {
205         RNA_struct_free(&BLENDER_RNA, type);
206 }
207
208 StructRNA *rna_IDPropertyGroup_register(const bContext *C, ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
209 {
210         PointerRNA dummyptr;
211
212         /* create dummy pointer */
213         RNA_pointer_create(NULL, &RNA_IDPropertyGroup, NULL, &dummyptr);
214
215         /* validate the python class */
216         if(validate(&dummyptr, data, NULL) != 0)
217                 return NULL;
218
219         /* note: it looks like there is no length limit on the srna id since its
220          * just a char pointer, but take care here, also be careful that python
221          * owns the string pointer which it could potentually free while blender
222          * is running. */
223         if(strlen(identifier) >= sizeof(((IDProperty *)NULL)->name)) {
224                 BKE_reportf(reports, RPT_ERROR, "registering id property class: '%s' is too long, maximum length is %d.", identifier, sizeof(((IDProperty *)NULL)->name));
225                 return NULL;
226         }
227
228         return RNA_def_struct(&BLENDER_RNA, identifier, "IDPropertyGroup");  // XXX
229 }
230
231 StructRNA* rna_IDPropertyGroup_refine(PointerRNA *ptr)
232 {
233         return ptr->type;
234 }
235
236 ID *rna_ID_copy(ID *id)
237 {
238         ID *newid;
239
240         if(id_copy(id, &newid, 0)) {
241                 if(newid) newid->us--;
242                 return newid;
243         }
244         
245         return NULL;
246 }
247
248 void rna_ID_user_clear(ID *id)
249 {
250         id->us= 0; /* dont save */
251         id->flag &= ~LIB_FAKEUSER;
252 }
253
254 #else
255
256 static void rna_def_ID_properties(BlenderRNA *brna)
257 {
258         StructRNA *srna;
259         PropertyRNA *prop;
260
261         /* this is struct is used for holding the virtual
262          * PropertyRNA's for ID properties */
263         srna= RNA_def_struct(brna, "IDProperty", NULL);
264         RNA_def_struct_ui_text(srna, "ID Property", "Property that stores arbitrary, user defined properties");
265         
266         /* IDP_STRING */
267         prop= RNA_def_property(srna, "string", PROP_STRING, PROP_NONE);
268         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
269
270         /* IDP_INT */
271         prop= RNA_def_property(srna, "int", PROP_INT, PROP_NONE);
272         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
273
274         prop= RNA_def_property(srna, "int_array", PROP_INT, PROP_NONE);
275         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
276         RNA_def_property_array(prop, 1);
277
278         /* IDP_FLOAT */
279         prop= RNA_def_property(srna, "float", PROP_FLOAT, PROP_NONE);
280         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
281
282         prop= RNA_def_property(srna, "float_array", PROP_FLOAT, PROP_NONE);
283         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
284         RNA_def_property_array(prop, 1);
285
286         /* IDP_DOUBLE */
287         prop= RNA_def_property(srna, "double", PROP_FLOAT, PROP_NONE);
288         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
289
290         prop= RNA_def_property(srna, "double_array", PROP_FLOAT, PROP_NONE);
291         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
292         RNA_def_property_array(prop, 1);
293
294         /* IDP_GROUP */
295         prop= RNA_def_property(srna, "group", PROP_POINTER, PROP_NONE);
296         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
297         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
298         RNA_def_property_struct_type(prop, "IDPropertyGroup");
299
300         prop= RNA_def_property(srna, "collection", PROP_COLLECTION, PROP_NONE);
301         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
302         RNA_def_property_struct_type(prop, "IDPropertyGroup");
303
304         // never tested, maybe its useful to have this?
305 #if 0
306         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
307         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
308         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
309         RNA_def_property_ui_text(prop, "Name", "Unique name used in the code and scripting");
310         RNA_def_struct_name_property(srna, prop);
311 #endif
312
313         /* IDP_ID -- not implemented yet in id properties */
314
315         /* ID property groups > level 0, since level 0 group is merged
316          * with native RNA properties. the builtin_properties will take
317          * care of the properties here */
318         srna= RNA_def_struct(brna, "IDPropertyGroup", NULL);
319         RNA_def_struct_ui_text(srna, "ID Property Group", "Group of ID properties");
320         RNA_def_struct_idproperties_func(srna, "rna_IDPropertyGroup_idproperties");
321         RNA_def_struct_register_funcs(srna, "rna_IDPropertyGroup_register", "rna_IDPropertyGroup_unregister");
322         RNA_def_struct_refine_func(srna, "rna_IDPropertyGroup_refine");
323
324         /* important so python types can have their name used in list views
325          * however this isnt prefect because it overrides how python would set the name
326          * when we only really want this so RNA_def_struct_name_property() is set to something useful */
327         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
328         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
329         //RNA_def_property_clear_flag(prop, PROP_EDITABLE);
330         RNA_def_property_ui_text(prop, "Name", "Unique name used in the code and scripting");
331         RNA_def_struct_name_property(srna, prop);
332 }
333
334 static void rna_def_ID(BlenderRNA *brna)
335 {
336         StructRNA *srna;
337         FunctionRNA *func;
338         PropertyRNA *prop, *parm;
339
340         srna= RNA_def_struct(brna, "ID", NULL);
341         RNA_def_struct_ui_text(srna, "ID", "Base type for datablocks, defining a unique name, linking from other libraries and garbage collection");
342         RNA_def_struct_flag(srna, STRUCT_ID|STRUCT_ID_REFCOUNT);
343         RNA_def_struct_refine_func(srna, "rna_ID_refine");
344         RNA_def_struct_idproperties_func(srna, "rna_ID_idproperties");
345
346         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
347         RNA_def_property_ui_text(prop, "Name", "Unique datablock ID name");
348         RNA_def_property_string_funcs(prop, "rna_ID_name_get", "rna_ID_name_length", "rna_ID_name_set");
349         RNA_def_property_string_maxlength(prop, sizeof(((ID*)NULL)->name)-2);
350         RNA_def_property_editable_func(prop, "rna_ID_name_editable");
351         RNA_def_property_update(prop, NC_ID|NA_RENAME, NULL);
352         RNA_def_struct_name_property(srna, prop);
353
354         prop= RNA_def_property(srna, "users", PROP_INT, PROP_UNSIGNED);
355         RNA_def_property_int_sdna(prop, NULL, "us");
356         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
357         RNA_def_property_ui_text(prop, "Users", "Number of times this datablock is referenced");
358
359         prop= RNA_def_property(srna, "fake_user", PROP_BOOLEAN, PROP_NONE);
360         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_FAKEUSER);
361         RNA_def_property_ui_text(prop, "Fake User", "Saves this datablock even if it has no users");
362         RNA_def_property_boolean_funcs(prop, NULL, "rna_ID_fake_user_set");
363
364         prop= RNA_def_property(srna, "tag", PROP_BOOLEAN, PROP_NONE);
365         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_DOIT);
366         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
367         RNA_def_property_ui_text(prop, "Tag", "Tools can use this to tag data, (initial state is undefined)");
368
369         prop= RNA_def_property(srna, "library", PROP_POINTER, PROP_NONE);
370         RNA_def_property_pointer_sdna(prop, NULL, "lib");
371         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
372         RNA_def_property_ui_text(prop, "Library", "Library file the datablock is linked from");
373
374         /* functions */
375         func= RNA_def_function(srna, "copy", "rna_ID_copy");
376         RNA_def_function_ui_description(func, "Create a copy of this datablock (not supported for all datablocks).");
377         parm= RNA_def_pointer(func, "id", "ID", "", "New copy of the ID.");
378         RNA_def_function_return(func, parm);
379
380         func= RNA_def_function(srna, "user_clear", "rna_ID_user_clear");
381         RNA_def_function_ui_description(func, "Clears the user count of a datablock so its not saved, on reload the data will be removed.");
382
383         func= RNA_def_function(srna, "animation_data_create", "BKE_id_add_animdata");
384         RNA_def_function_ui_description(func, "Create animation data to this ID, note that not all ID types support this.");
385         parm= RNA_def_pointer(func, "anim_data", "AnimData", "", "New animation data or NULL.");
386         RNA_def_function_return(func, parm);
387
388         func= RNA_def_function(srna, "animation_data_clear", "BKE_free_animdata");
389         RNA_def_function_ui_description(func, "Clear animation on this this ID.");
390
391 }
392
393 static void rna_def_library(BlenderRNA *brna)
394 {
395         StructRNA *srna;
396         PropertyRNA *prop;
397
398         srna= RNA_def_struct(brna, "Library", "ID");
399         RNA_def_struct_ui_text(srna, "Library", "External .blend file from which data is linked");
400         RNA_def_struct_ui_icon(srna, ICON_LIBRARY_DATA_DIRECT);
401
402         prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
403         RNA_def_property_string_sdna(prop, NULL, "name");
404         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
405         RNA_def_property_ui_text(prop, "Filename", "Path to the library .blend file");
406 }
407 void RNA_def_ID(BlenderRNA *brna)
408 {
409         StructRNA *srna;
410
411         /* built-in unknown type */
412         srna= RNA_def_struct(brna, "UnknownType", NULL);
413         RNA_def_struct_ui_text(srna, "Unknown Type", "Stub RNA type used for pointers to unknown or internal data");
414
415         /* built-in any type */
416         srna= RNA_def_struct(brna, "AnyType", NULL);
417         RNA_def_struct_ui_text(srna, "Any Type", "RNA type used for pointers to any possible data");
418
419         rna_def_ID(brna);
420         rna_def_ID_properties(brna);
421         rna_def_library(brna);
422 }
423
424 #endif
425