* add exit app with CTRLKEY+QKEY.
[blender-staging.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 static void WM_OT_exit_blender(wmOperatorType *ot)
120 {
121         ot->name= "Exit Blender";
122         ot->idname= "WM_OT_exit_blender";
123
124         ot->invoke= NULL; /* do confirm stuff */
125         ot->exec= wm_exit_blender_op;
126         ot->poll= WM_operator_winactive;
127 }
128
129
130 #define ADD_OPTYPE(opfunc)      ot= MEM_callocN(sizeof(wmOperatorType), "operatortype"); \
131                                                         opfunc(ot);  \
132                                                         BLI_addtail(&global_ops, ot)
133
134
135 /* called on initialize WM_exit() */
136 void wm_operatortype_free(void)
137 {
138         BLI_freelistN(&global_ops);
139 }
140
141 /* called on initialize WM_init() */
142 void wm_operatortype_init(void)
143 {
144         wmOperatorType *ot;
145         
146         ADD_OPTYPE(WM_OT_window_duplicate);
147         ADD_OPTYPE(WM_OT_save_homefile);
148     ADD_OPTYPE(WM_OT_window_fullscreen_toggle);
149         ADD_OPTYPE(WM_OT_exit_blender);
150 }
151
152 /* wrapped to get property from a operator. */
153 IDProperty *op_get_property(wmOperator *op, char *name)
154 {
155         IDProperty *prop= IDP_GetPropertyFromGroup(op->properties, name);
156         return(prop);
157 }
158
159 /*
160  * We need create a "group" to store the operator properties.
161  * We don't have a WM_operator_new or some thing like that,
162  * so this function is called by all the OP_set_* function
163  * in case that op->properties is equal to NULL.
164  */
165 void op_init_property(wmOperator *op)
166 {
167         IDPropertyTemplate val;
168         op->properties= IDP_New(IDP_GROUP, val, "property");
169 }
170
171 /* ***** Property API, exported ***** */
172 void OP_free_property(wmOperator *op)
173 {
174         IDP_FreeProperty(op->properties);
175         /*
176          * This need change, when the idprop code only
177          * need call IDP_FreeProperty. (check BKE_idprop.h)
178          */
179         MEM_freeN(op->properties);
180         op->properties= NULL;
181 }
182
183 void OP_set_int(wmOperator *op, char *name, int value)
184 {
185         IDPropertyTemplate val;
186         IDProperty *prop;
187
188         if(!op->properties)
189                 op_init_property(op);
190
191         val.i= value;
192         prop= IDP_New(IDP_INT, val, name);
193         IDP_ReplaceInGroup(op->properties, prop);
194 }
195
196 void OP_set_float(wmOperator *op, char *name, float value)
197 {
198         IDPropertyTemplate val;
199         IDProperty *prop;
200
201         if(!op->properties)
202                 op_init_property(op);
203
204         val.f= value;
205         prop= IDP_New(IDP_FLOAT, val, name);
206         IDP_ReplaceInGroup(op->properties, prop);
207 }
208
209 void OP_set_int_array(wmOperator *op, char *name, int *array, short len)
210 {
211         IDPropertyTemplate val;
212         IDProperty *prop;
213         short i;
214         int *pointer;
215
216         if(!op->properties)
217                 op_init_property(op);
218
219         val.array.len= len;
220         val.array.type= IDP_INT;
221         prop= IDP_New(IDP_ARRAY, val, name);
222
223         pointer= (int *)prop->data.pointer;
224         for(i= 0; i < len; i++)
225                 pointer[i]= array[i];
226         IDP_ReplaceInGroup(op->properties, prop);
227 }
228
229 void OP_set_float_array(wmOperator *op, char *name, float *array, short len)
230 {
231         IDPropertyTemplate val;
232         IDProperty *prop;
233         short i;
234         float *pointer;
235
236         if(!op->properties)
237                 op_init_property(op);
238
239         val.array.len= len;
240         val.array.type= IDP_FLOAT;
241         prop= IDP_New(IDP_ARRAY, val, name);
242
243         pointer= (float *) prop->data.pointer;
244         for(i= 0; i < len; i++)
245                 pointer[i]= array[i];
246         IDP_ReplaceInGroup(op->properties, prop);
247 }
248
249 void OP_set_string(wmOperator *op, char *name, char *str)
250 {
251         IDPropertyTemplate val;
252         IDProperty *prop;
253
254         if(!op->properties)
255                 op_init_property(op);
256
257         val.str= str;
258         prop= IDP_New(IDP_STRING, val, name);
259         IDP_ReplaceInGroup(op->properties, prop);
260 }
261
262 int OP_get_int(wmOperator *op, char *name, int *value)
263 {
264         IDProperty *prop= op_get_property(op, name);
265         int status= 1;
266
267         if ((prop) && (prop->type == IDP_INT)) {
268                 (*value)= prop->data.val;
269                 status= 0;
270         }
271         return (status);
272 }
273
274 int OP_get_float(wmOperator *op, char *name, float *value)
275 {
276         IDProperty *prop= op_get_property(op, name);
277         int status= 1;
278
279         if ((prop) && (prop->type == IDP_FLOAT)) {
280                 (*value)= *(float*)&prop->data.val;
281                 status= 0;
282         }
283         return (status);
284 }
285
286 int OP_get_int_array(wmOperator *op, char *name, int *array, short *len)
287 {
288         IDProperty *prop= op_get_property(op, name);
289         short i;
290         int status= 1;
291         int *pointer;
292
293         if ((prop) && (prop->type == IDP_ARRAY)) {
294                 pointer= (int *) prop->data.pointer;
295
296                 for(i= 0; (i < prop->len) && (i < *len); i++)
297                         array[i]= pointer[i];
298
299                 (*len)= i;
300                 status= 0;
301         }
302         return (status);
303 }
304
305 int OP_get_float_array(wmOperator *op, char *name, float *array, short *len)
306 {
307         IDProperty *prop= op_get_property(op, name);
308         short i;
309         float *pointer;
310         int status= 1;
311
312         if ((prop) && (prop->type == IDP_ARRAY)) {
313                 pointer= (float *) prop->data.pointer;
314
315                 for(i= 0; (i < prop->len) && (i < *len); i++)
316                         array[i]= pointer[i];
317
318                 (*len)= i;
319                 status= 0;
320         }
321         return (status);
322 }
323
324 char *OP_get_string(wmOperator *op, char *name)
325 {
326         IDProperty *prop= op_get_property(op, name);
327         if ((prop) && (prop->type == IDP_STRING))
328                 return ((char *) prop->data.pointer);
329         return (NULL);
330 }