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