More "data types" for the Operator property system.
[blender.git] / source / blender / windowmanager / intern / wm_operators.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  * The Original Code is Copyright (C) 2007 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <string.h>
30
31 #include "DNA_ID.h"
32 #include "DNA_windowmanager_types.h"
33
34 #include "MEM_guardedalloc.h"
35
36 #include "BLI_blenlib.h"
37
38 #include "BKE_blender.h"
39 #include "BKE_global.h"
40 #include "BKE_library.h"
41 #include "BKE_main.h"
42 #include "BKE_idprop.h"
43
44 #include "WM_api.h"
45 #include "WM_types.h"
46 #include "wm_window.h"
47 #include "wm_event_system.h"
48
49 static ListBase global_ops= {NULL, NULL};
50
51 /* ************ operator API, exported ********** */
52
53 wmOperatorType *WM_operatortype_find(const char *idname)
54 {
55         wmOperatorType *ot;
56         
57         for(ot= global_ops.first; ot; ot= ot->next) {
58                 if(strncmp(ot->idname, idname, OP_MAX_TYPENAME)==0)
59                    return ot;
60         }
61         return NULL;
62 }
63
64 /* all ops in 1 list (for time being... needs evaluation later) */
65 void WM_operatortypelist_append(ListBase *lb)
66 {
67         addlisttolist(&global_ops, lb);
68 }
69
70 /* ************ default ops, exported *********** */
71
72 int WM_operator_confirm(bContext *C, wmOperator *op, wmEvent *event)
73 {
74 //      if(okee(op->type->name)) {
75 //              return op->type->exec(C, op);
76 //      }
77         return 0;
78 }
79 int WM_operator_winactive(bContext *C)
80 {
81         if(C->window==NULL) return 0;
82         return 1;
83 }
84
85 /* ************ window / screen operator definitions ************** */
86
87 static void WM_OT_window_duplicate(wmOperatorType *ot)
88 {
89         ot->name= "Duplicate Window";
90         ot->idname= "WM_OT_window_duplicate";
91         
92         ot->invoke= NULL; //WM_operator_confirm;
93         ot->exec= wm_window_duplicate_op;
94         ot->poll= WM_operator_winactive;
95 }
96
97 static void WM_OT_save_homefile(wmOperatorType *ot)
98 {
99         ot->name= "Save User Settings";
100         ot->idname= "WM_OT_save_homefile";
101         
102         ot->invoke= NULL; //WM_operator_confirm;
103         ot->exec= WM_write_homefile;
104         ot->poll= WM_operator_winactive;
105         
106         ot->flag= OPTYPE_REGISTER;
107 }
108
109 static void WM_OT_window_fullscreen_toggle(wmOperatorType *ot)
110 {
111     ot->name= "Toggle Fullscreen";
112     ot->idname= "WM_OT_window_fullscreen_toggle";
113
114     ot->invoke= NULL;
115     ot->exec= wm_window_fullscreen_toggle_op;
116     ot->poll= WM_operator_winactive;
117 }
118
119
120 #define ADD_OPTYPE(opfunc)      ot= MEM_callocN(sizeof(wmOperatorType), "operatortype"); \
121                                                         opfunc(ot);  \
122                                                         BLI_addtail(&global_ops, ot)
123
124
125 /* called on initialize WM_exit() */
126 void wm_operatortype_free(void)
127 {
128         BLI_freelistN(&global_ops);
129 }
130
131 /* called on initialize WM_init() */
132 void wm_operatortype_init(void)
133 {
134         wmOperatorType *ot;
135         
136         ADD_OPTYPE(WM_OT_window_duplicate);
137         ADD_OPTYPE(WM_OT_save_homefile);
138     ADD_OPTYPE(WM_OT_window_fullscreen_toggle);
139 }
140
141 /* wrapped to get property from a operator. */
142 IDProperty *op_get_property(wmOperator *op, char *name)
143 {
144         IDProperty *prop= IDP_GetPropertyFromGroup(op->properties, name);
145         return(prop);
146 }
147
148 /*
149  * We need create a "group" to store the operator properties.
150  * We don't have a WM_operator_new or some thing like that,
151  * so this function is called by all the OP_set_* function
152  * in case that op->properties is equal to NULL.
153  */
154 void op_init_property(wmOperator *op)
155 {
156         IDPropertyTemplate val;
157         op->properties= IDP_New(IDP_GROUP, val, "property");
158 }
159
160 /* ***** Property API, exported ***** */
161 void OP_free_property(wmOperator *op)
162 {
163         IDP_FreeProperty(op->properties);
164         /*
165          * This need change, when the idprop code only
166          * need call IDP_FreeProperty. (check BKE_idprop.h)
167          */
168         MEM_freeN(op->properties);
169         op->properties= NULL;
170 }
171
172 void OP_set_int(wmOperator *op, char *name, int value)
173 {
174         IDPropertyTemplate val;
175         IDProperty *prop;
176
177         if(!op->properties)
178                 op_init_property(op);
179
180         val.i= value;
181         prop= IDP_New(IDP_INT, val, name);
182         IDP_ReplaceInGroup(op->properties, prop);
183 }
184
185 void OP_set_float(wmOperator *op, char *name, float value)
186 {
187         IDPropertyTemplate val;
188         IDProperty *prop;
189
190         if(!op->properties)
191                 op_init_property(op);
192
193         val.f= value;
194         prop= IDP_New(IDP_FLOAT, val, name);
195         IDP_ReplaceInGroup(op->properties, prop);
196 }
197
198 void OP_set_int_array(wmOperator *op, char *name, int *array, short len)
199 {
200         IDPropertyTemplate val;
201         IDProperty *prop;
202         short i;
203         int *pointer;
204
205         if(!op->properties)
206                 op_init_property(op);
207
208         val.array.len= len;
209         val.array.type= IDP_INT;
210         prop= IDP_New(IDP_ARRAY, val, name);
211
212         pointer= (int *)prop->data.pointer;
213         for(i= 0; i < len; i++)
214                 pointer[i]= array[i];
215         IDP_ReplaceInGroup(op->properties, prop);
216 }
217
218 void OP_set_float_array(wmOperator *op, char *name, float *array, short len)
219 {
220         IDPropertyTemplate val;
221         IDProperty *prop;
222         short i;
223         float *pointer;
224
225         if(!op->properties)
226                 op_init_property(op);
227
228         val.array.len= len;
229         val.array.type= IDP_FLOAT;
230         prop= IDP_New(IDP_ARRAY, val, name);
231
232         pointer= (float *) prop->data.pointer;
233         for(i= 0; i < len; i++)
234                 pointer[i]= array[i];
235         IDP_ReplaceInGroup(op->properties, prop);
236 }
237
238 void OP_set_string(wmOperator *op, char *name, char *str)
239 {
240         IDPropertyTemplate val;
241         IDProperty *prop;
242
243         if(!op->properties)
244                 op_init_property(op);
245
246         val.str= str;
247         prop= IDP_New(IDP_STRING, val, name);
248         IDP_ReplaceInGroup(op->properties, prop);
249 }
250
251 int OP_get_int(wmOperator *op, char *name, int *value)
252 {
253         IDProperty *prop= op_get_property(op, name);
254         int status= 1;
255
256         if ((prop) && (prop->type == IDP_INT)) {
257                 (*value)= prop->data.val;
258                 status= 0;
259         }
260         return (status);
261 }
262
263 int OP_get_float(wmOperator *op, char *name, float *value)
264 {
265         IDProperty *prop= op_get_property(op, name);
266         int status= 1;
267
268         if ((prop) && (prop->type == IDP_FLOAT)) {
269                 (*value)= *(float*)&prop->data.val;
270                 status= 0;
271         }
272         return (status);
273 }
274
275 int OP_get_int_array(wmOperator *op, char *name, int *array, short *len)
276 {
277         IDProperty *prop= op_get_property(op, name);
278         short i;
279         int status= 1;
280         int *pointer;
281
282         if ((prop) && (prop->type == IDP_ARRAY)) {
283                 pointer= (int *) prop->data.pointer;
284
285                 for(i= 0; (i < prop->len) && (i < *len); i++)
286                         array[i]= pointer[i];
287
288                 (*len)= i;
289                 status= 0;
290         }
291         return (status);
292 }
293
294 int OP_get_float_array(wmOperator *op, char *name, float *array, short *len)
295 {
296         IDProperty *prop= op_get_property(op, name);
297         short i;
298         float *pointer;
299         int status= 1;
300
301         if ((prop) && (prop->type == IDP_ARRAY)) {
302                 pointer= (float *) prop->data.pointer;
303
304                 for(i= 0; (i < prop->len) && (i < *len); i++)
305                         array[i]= pointer[i];
306
307                 (*len)= i;
308                 status= 0;
309         }
310         return (status);
311 }
312
313 char *OP_get_string(wmOperator *op, char *name)
314 {
315         IDProperty *prop= op_get_property(op, name);
316         if ((prop) && (prop->type == IDP_STRING))
317                 return ((char *) prop->data.pointer);
318         return (NULL);
319 }