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 static 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 static int rna_ID_name_length(PointerRNA *ptr)
45 {
46         ID *id= (ID*)ptr->data;
47         return strlen(id->name+2);
48 }
49
50 static 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 static StructRNA *rna_ID_refine(PointerRNA *ptr)
57 {
58         ID *id= (ID*)ptr->data;
59
60         switch(GS(id->name)) {
61                 case ID_AR: return &RNA_Armature;
62                 case ID_BR: return &RNA_Brush;
63                 case ID_CA: return &RNA_Camera;
64                 case ID_CU: return &RNA_Curve;
65                 case ID_GR: return &RNA_Group;
66                 case ID_IM: return &RNA_Image;
67                 case ID_IP: return &RNA_Ipo;
68                 case ID_KE: return &RNA_Key;
69                 case ID_LA: return &RNA_Lamp;
70                 case ID_LI: return &RNA_Library;
71                 case ID_LT: return &RNA_Lattice;
72                 case ID_MA: return &RNA_Material;
73                 case ID_MB: return &RNA_MetaBall;
74                 case ID_NT: return &RNA_NodeTree;
75                 case ID_ME: return &RNA_Mesh;
76                 case ID_OB: return &RNA_Object;
77                 case ID_SCE: return &RNA_Scene;
78                 case ID_SCR: return &RNA_Screen;
79                 case ID_VF: return &RNA_VectorFont;
80                 case ID_WO: return &RNA_World;
81                 case ID_WM: return &RNA_WindowManager;
82                 default: return &RNA_ID;
83         }
84 }
85
86 static void rna_ID_fake_user_set(PointerRNA *ptr, int value)
87 {
88         ID *id= (ID*)ptr->data;
89
90         if(value && !(id->flag & LIB_FAKEUSER)) {
91                 id->flag |= LIB_FAKEUSER;
92                 id->us++;
93         }
94         else if(!value && (id->flag & LIB_FAKEUSER)) {
95                 id->flag &= ~LIB_FAKEUSER;
96                 id->us--;
97         }
98 }
99
100 #else
101
102 static void rna_def_ID_properties(BlenderRNA *brna)
103 {
104         StructRNA *srna;
105         PropertyRNA *prop;
106
107         /* this is struct is used for holding the virtual
108          * PropertyRNA's for ID properties */
109         srna= RNA_def_struct(brna, "IDProperty", NULL, "ID Property");
110
111         /* IDP_STRING */
112         prop= RNA_def_property(srna, "string", PROP_STRING, PROP_NONE);
113         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
114
115         /* IDP_INT */
116         prop= RNA_def_property(srna, "int", PROP_INT, PROP_NONE);
117         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
118
119         prop= RNA_def_property(srna, "intarray", PROP_INT, PROP_NONE);
120         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
121         RNA_def_property_array(prop, 1);
122
123         /* IDP_FLOAT */
124         prop= RNA_def_property(srna, "float", PROP_FLOAT, PROP_NONE);
125         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
126
127         prop= RNA_def_property(srna, "floatarray", PROP_FLOAT, PROP_NONE);
128         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
129         RNA_def_property_array(prop, 1);
130
131         /* IDP_DOUBLE */
132         prop= RNA_def_property(srna, "double", PROP_FLOAT, PROP_NONE);
133         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
134
135         prop= RNA_def_property(srna, "doublearray", PROP_FLOAT, PROP_NONE);
136         RNA_def_property_flag(prop, PROP_EXPORT|PROP_IDPROPERTY);
137         RNA_def_property_array(prop, 1);
138
139         /* IDP_GROUP */
140         prop= RNA_def_property(srna, "group", PROP_POINTER, PROP_NONE);
141         RNA_def_property_flag(prop, PROP_EXPORT|PROP_NOT_EDITABLE|PROP_IDPROPERTY);
142         RNA_def_property_struct_type(prop, "IDPropertyGroup");
143
144         /* IDP_ID -- not implemented yet in id properties */
145
146         /* ID property groups > level 0, since level 0 group is merged
147          * with native RNA properties. the builtin_properties will take
148          * care of the properties here */
149         srna= RNA_def_struct(brna, "IDPropertyGroup", NULL, "ID Property Group");
150 }
151
152 static void rna_def_ID(BlenderRNA *brna)
153 {
154         StructRNA *srna;
155         PropertyRNA *prop;
156
157         srna= RNA_def_struct(brna, "ID", NULL, "ID");
158         RNA_def_struct_flag(srna, STRUCT_ID);
159         RNA_def_struct_funcs(srna, NULL, "rna_ID_refine");
160
161         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
162         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* must be unique */
163         RNA_def_property_ui_text(prop, "Name", "Unique datablock ID name.");
164         RNA_def_property_string_funcs(prop, "rna_ID_name_get", "rna_ID_name_length", "rna_ID_name_set");
165         RNA_def_property_string_maxlength(prop, sizeof(((ID*)NULL)->name)-2);
166         RNA_def_struct_name_property(srna, prop);
167
168         prop= RNA_def_property(srna, "users", PROP_INT, PROP_UNSIGNED);
169         RNA_def_property_int_sdna(prop, NULL, "us");
170         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
171         RNA_def_property_ui_text(prop, "Users", "Number of times this datablock is referenced.");
172
173         prop= RNA_def_property(srna, "fake_user", PROP_BOOLEAN, PROP_NONE);
174         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIB_FAKEUSER);
175         RNA_def_property_ui_text(prop, "Fake User", "Saves this datablock even if it has no users");
176         RNA_def_property_boolean_funcs(prop, NULL, "rna_ID_fake_user_set");
177
178         prop= RNA_def_property(srna, "library", PROP_POINTER, PROP_NONE);
179         RNA_def_property_pointer_sdna(prop, NULL, "lib");
180         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
181         RNA_def_property_ui_text(prop, "Library", "Library file the datablock is linked from.");
182 }
183
184 static void rna_def_library(BlenderRNA *brna)
185 {
186         StructRNA *srna;
187         PropertyRNA *prop;
188
189         srna= RNA_def_struct(brna, "Library", "ID", "Library");
190
191         prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
192         RNA_def_property_string_sdna(prop, NULL, "name");
193         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
194         RNA_def_property_ui_text(prop, "Filename", "Path to the library .blend file.");
195 }
196 void RNA_def_ID(BlenderRNA *brna)
197 {
198         /* simple built-in unknown type */
199         RNA_def_struct(brna, "UnknownType", NULL, "Unknown Type");
200
201         rna_def_ID(brna);
202         rna_def_ID_properties(brna);
203         rna_def_library(brna);
204 }
205
206 #endif
207