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