API structuring improvements according to design guidelines by Brecht,
[blender-staging.git] / source / blender / makesrna / intern / rna_wm.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
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_windowmanager_types.h"
33
34 #ifdef RNA_RUNTIME
35
36 #include "BKE_idprop.h"
37
38 static wmOperator *rna_OperatorProperties_find_operator(PointerRNA *ptr)
39 {
40         wmWindowManager *wm= ptr->id.data;
41         IDProperty *properties= (IDProperty*)ptr->data;
42         wmOperator *op;
43
44         if(wm)
45                 for(op=wm->operators.first; op; op=op->next)
46                         if(op->properties == properties)
47                                 return op;
48         
49         return NULL;
50 }
51
52 static StructRNA *rna_OperatorProperties_refine(PointerRNA *ptr)
53 {
54         wmOperator *op= rna_OperatorProperties_find_operator(ptr);
55
56         if(op)
57                 return op->type->srna;
58         else
59                 return ptr->type;
60 }
61
62 IDProperty *rna_OperatorProperties_idproperties(PointerRNA *ptr, int create)
63 {
64         if(create && !ptr->data) {
65                 IDPropertyTemplate val = {0};
66                 ptr->data= IDP_New(IDP_GROUP, val, "RNA_OperatorProperties group");
67         }
68
69         return ptr->data;
70 }
71
72 static void rna_Operator_name_get(PointerRNA *ptr, char *value)
73 {
74         wmOperator *op= (wmOperator*)ptr->data;
75         strcpy(value, op->type->name);
76 }
77
78 static int rna_Operator_name_length(PointerRNA *ptr)
79 {
80         wmOperator *op= (wmOperator*)ptr->data;
81         return strlen(op->type->name);
82 }
83
84 static PointerRNA rna_Operator_properties_get(PointerRNA *ptr)
85 {
86         wmOperator *op= (wmOperator*)ptr->data;
87         return rna_pointer_inherit_refine(ptr, &RNA_OperatorProperties, op->properties);
88 }
89
90 #else
91
92 static void rna_def_operator(BlenderRNA *brna)
93 {
94         StructRNA *srna;
95         PropertyRNA *prop;
96
97         srna= RNA_def_struct(brna, "Operator", NULL);
98         RNA_def_struct_ui_text(srna, "Operator", "Storage of an operator being executed, or registered after execution.");
99         RNA_def_struct_sdna(srna, "wmOperator");
100
101         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
102         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
103         RNA_def_property_string_funcs(prop, "rna_Operator_name_get", "rna_Operator_name_length", NULL);
104         RNA_def_property_ui_text(prop, "Name", "");
105         RNA_def_struct_name_property(srna, prop);
106
107         prop= RNA_def_property(srna, "properties", PROP_POINTER, PROP_NEVER_NULL);
108         RNA_def_property_struct_type(prop, "OperatorProperties");
109         RNA_def_property_ui_text(prop, "Properties", "");
110         RNA_def_property_pointer_funcs(prop, "rna_Operator_properties_get", NULL, NULL);
111
112         srna= RNA_def_struct(brna, "OperatorProperties", NULL);
113         RNA_def_struct_ui_text(srna, "Operator Properties", "Input properties of an Operator.");
114         RNA_def_struct_refine_func(srna, "rna_OperatorProperties_refine");
115         RNA_def_struct_idproperties_func(srna, "rna_OperatorProperties_idproperties");
116 }
117
118 static void rna_def_operator_utils(BlenderRNA *brna)
119 {
120         StructRNA *srna;
121         PropertyRNA *prop;
122
123         srna= RNA_def_struct(brna, "OperatorMousePath", "IDPropertyGroup");
124         RNA_def_struct_ui_text(srna, "Operator Mouse Path", "Mouse path values for operators that record such paths.");
125
126         prop= RNA_def_property(srna, "loc", PROP_FLOAT, PROP_VECTOR);
127         RNA_def_property_flag(prop, PROP_IDPROPERTY);
128         RNA_def_property_array(prop, 2);
129         RNA_def_property_ui_text(prop, "Location", "Mouse location.");
130
131         prop= RNA_def_property(srna, "time", PROP_FLOAT, PROP_NONE);
132         RNA_def_property_flag(prop, PROP_IDPROPERTY);
133         RNA_def_property_ui_text(prop, "Time", "Time of mouse location.");
134 }
135
136 static void rna_def_operator_filelist_element(BlenderRNA *brna)
137 {
138         StructRNA *srna;
139         PropertyRNA *prop;
140
141         srna= RNA_def_struct(brna, "OperatorFileListElement", "IDPropertyGroup");
142         RNA_def_struct_ui_text(srna, "Operator File List Element", "");
143         
144         
145         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
146         RNA_def_property_flag(prop, PROP_IDPROPERTY);
147         RNA_def_property_ui_text(prop, "Name", "the name of a file or directory within a file list");
148 }
149
150
151 static void rna_def_windowmanager(BlenderRNA *brna)
152 {
153         StructRNA *srna;
154         PropertyRNA *prop;
155
156         srna= RNA_def_struct(brna, "WindowManager", "ID");
157         RNA_def_struct_ui_text(srna, "Window Manager", "Window manager datablock defining open windows and other user interface data.");
158         RNA_def_struct_sdna(srna, "wmWindowManager");
159
160         prop= RNA_def_property(srna, "operators", PROP_COLLECTION, PROP_NONE);
161         RNA_def_property_struct_type(prop, "Operator");
162         RNA_def_property_ui_text(prop, "Operators", "Operator registry.");
163
164         RNA_api_wm(srna);
165 }
166
167 void RNA_def_wm(BlenderRNA *brna)
168 {
169         rna_def_operator(brna);
170         rna_def_operator_utils(brna);
171         rna_def_operator_filelist_element(brna);
172         rna_def_windowmanager(brna);
173 }
174
175 #endif
176