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