RNA
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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_define.h"
29 #include "RNA_types.h"
30
31 #include "DNA_ID.h"
32
33 #ifdef RNA_RUNTIME
34
35 #include "BKE_idprop.h"
36
37 /* name functions that ignore the first two ID characters */
38 void rna_ID_name_get(PointerRNA *ptr, char *value)
39 {
40         ID *id= (ID*)ptr->data;
41         BLI_strncpy(value, id->name+2, sizeof(id->name)-2);
42 }
43
44 int rna_ID_name_length(PointerRNA *ptr)
45 {
46         ID *id= (ID*)ptr->data;
47         return strlen(id->name+2);
48 }
49
50 void rna_ID_name_set(PointerRNA *ptr, const char *value)
51 {
52         ID *id= (ID*)ptr->data;
53         BLI_strncpy(id->name+2, value, sizeof(id->name)-2);
54 }
55
56 StructRNA *rna_ID_refine(PointerRNA *ptr)
57 {
58         ID *id= (ID*)ptr->data;
59
60         switch(GS(id->name)) {
61                 case ID_AC: return &RNA_Action;
62                 case ID_AR: return &RNA_Armature;
63                 case ID_BR: return &RNA_Brush;
64                 case ID_CA: return &RNA_Camera;
65                 case ID_CU: return &RNA_Curve;
66                 case ID_GR: return &RNA_Group;
67                 case ID_IM: return &RNA_Image;
68                 case ID_IP: return &RNA_Ipo;
69                 case ID_KE: return &RNA_Key;
70                 case ID_LA: return &RNA_Lamp;
71                 case ID_LI: return &RNA_Library;
72                 case ID_LT: return &RNA_Lattice;
73                 case ID_MA: return &RNA_Material;
74                 case ID_MB: return &RNA_MetaBall;
75                 case ID_NT: return &RNA_NodeTree;
76                 case ID_ME: return &RNA_Mesh;
77                 case ID_OB: return &RNA_Object;
78                 case ID_SCE: return &RNA_Scene;
79                 case ID_SCR: return &RNA_Screen;
80                 case ID_SO: return &RNA_Sound;
81                 case ID_TXT: return &RNA_Text;
82                 case ID_TE: return &RNA_Texture;
83                 case ID_VF: return &RNA_VectorFont;
84                 case ID_WO: return &RNA_World;
85                 case ID_WM: return &RNA_WindowManager;
86                 default: return &RNA_ID;
87         }
88 }
89
90 void rna_ID_fake_user_set(PointerRNA *ptr, int value)
91 {
92         ID *id= (ID*)ptr->data;
93
94         if(value && !(id->flag & LIB_FAKEUSER)) {
95                 id->flag |= LIB_FAKEUSER;
96                 id->us++;
97         }
98         else if(!value && (id->flag & LIB_FAKEUSER)) {
99                 id->flag &= ~LIB_FAKEUSER;
100                 id->us--;
101         }
102 }
103
104 #else
105
106 static void rna_def_ID_properties(BlenderRNA *brna)
107 {
108         StructRNA *srna;
109         PropertyRNA *prop;
110
111         /* this is struct is used for holding the virtual
112          * PropertyRNA's for ID properties */
113         srna= RNA_def_struct(brna, "IDProperty", NULL);
114         RNA_def_struct_ui_text(srna, "ID Property", "Property that stores arbitrary, user defined properties.");
115         
116         /* IDP_STRING */
117         prop= RNA_def_property(srna, "string", PROP_STRING, PROP_NONE);
118         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
119
120         /* IDP_INT */
121         prop= RNA_def_property(srna, "int", PROP_INT, PROP_NONE);
122         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
123
124         prop= RNA_def_property(srna, "int_array", PROP_INT, PROP_NONE);
125         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
126         RNA_def_property_array(prop, 1);
127
128         /* IDP_FLOAT */
129         prop= RNA_def_property(srna, "float", PROP_FLOAT, PROP_NONE);
130         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
131
132         prop= RNA_def_property(srna, "float_array", PROP_FLOAT, PROP_NONE);
133         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
134         RNA_def_property_array(prop, 1);
135
136         /* IDP_DOUBLE */
137         prop= RNA_def_property(srna, "double", PROP_FLOAT, PROP_NONE);
138         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
139
140         prop= RNA_def_property(srna, "double_array", PROP_FLOAT, PROP_NONE);
141         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
142         RNA_def_property_array(prop, 1);
143
144         /* IDP_GROUP */
145         prop= RNA_def_property(srna, "group", PROP_POINTER, PROP_NONE);
146         RNA_def_property_flag(prop, PROP_EXPORT|PROP_NOT_EDITABLE|PROP_IDPROPERTY);
147         RNA_def_property_struct_type(prop, "IDPropertyGroup");
148
149         prop= RNA_def_property(srna, "collection", PROP_COLLECTION, PROP_NONE);
150         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
151         RNA_def_property_struct_type(prop, "IDPropertyGroup");
152
153         /* IDP_ID -- not implemented yet in id properties */
154
155         /* ID property groups > level 0, since level 0 group is merged
156          * with native RNA properties. the builtin_properties will take
157          * care of the properties here */
158         srna= RNA_def_struct(brna, "IDPropertyGroup", NULL);
159         RNA_def_struct_ui_text(srna, "ID Property Group", "Group of ID properties.");
160 }
161
162 static void rna_def_ID(BlenderRNA *brna)
163 {
164         StructRNA *srna;
165         PropertyRNA *prop;
166
167         srna= RNA_def_struct(brna, "ID", NULL);
168         RNA_def_struct_ui_text(srna, "ID", "Base type for datablocks, defining a unique name, linking from other libraries and garbage collection.");
169         RNA_def_struct_flag(srna, STRUCT_ID);
170         RNA_def_struct_refine_func(srna, "rna_ID_refine");
171
172         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
173         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* must be unique */
174         RNA_def_property_ui_text(prop, "Name", "Unique datablock ID name.");
175         RNA_def_property_string_funcs(prop, "rna_ID_name_get", "rna_ID_name_length", "rna_ID_name_set");
176         RNA_def_property_string_maxlength(prop, sizeof(((ID*)NULL)->name)-2);
177         RNA_def_struct_name_property(srna, prop);
178
179         prop= RNA_def_property(srna, "users", PROP_INT, PROP_UNSIGNED);
180         RNA_def_property_int_sdna(prop, NULL, "us");
181         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
182         RNA_def_property_ui_text(prop, "Users", "Number of times this datablock is referenced.");
183
184         prop= RNA_def_property(srna, "fake_user", PROP_BOOLEAN, PROP_NONE);
185         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_FAKEUSER);
186         RNA_def_property_ui_text(prop, "Fake User", "Saves this datablock even if it has no users");
187         RNA_def_property_boolean_funcs(prop, NULL, "rna_ID_fake_user_set");
188
189         prop= RNA_def_property(srna, "library", PROP_POINTER, PROP_NONE);
190         RNA_def_property_pointer_sdna(prop, NULL, "lib");
191         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
192         RNA_def_property_ui_text(prop, "Library", "Library file the datablock is linked from.");
193 }
194
195 static void rna_def_library(BlenderRNA *brna)
196 {
197         StructRNA *srna;
198         PropertyRNA *prop;
199
200         srna= RNA_def_struct(brna, "Library", "ID");
201         RNA_def_struct_ui_text(srna, "Library", "External .blend file from which data is linked.");
202
203         prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
204         RNA_def_property_string_sdna(prop, NULL, "name");
205         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
206         RNA_def_property_ui_text(prop, "Filename", "Path to the library .blend file.");
207 }
208 void RNA_def_ID(BlenderRNA *brna)
209 {
210         StructRNA *srna;
211
212         /* simple built-in unknown type */
213         srna= RNA_def_struct(brna, "UnknownType", NULL);
214         RNA_def_struct_ui_text(srna, "Unknown Type", "Stub RNA type used for pointers to unknown or internal data.");
215
216         rna_def_ID(brna);
217         rna_def_ID_properties(brna);
218         rna_def_library(brna);
219 }
220
221 #endif
222