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