Cleanup: comment line length (windowmanager)
[blender.git] / source / blender / windowmanager / intern / wm_operator_type.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup wm
19  *
20  * Operator Registry.
21  */
22
23 #include "MEM_guardedalloc.h"
24
25 #include "CLG_log.h"
26
27 #include "DNA_ID.h"
28 #include "DNA_screen_types.h"
29 #include "DNA_scene_types.h"
30 #include "DNA_userdef_types.h"
31 #include "DNA_windowmanager_types.h"
32
33 #include "BLT_translation.h"
34
35 #include "BLI_blenlib.h"
36 #include "BLI_utildefines.h"
37 #include "BLI_ghash.h"
38
39 #include "BKE_context.h"
40 #include "BKE_idprop.h"
41
42 #include "RNA_access.h"
43 #include "RNA_define.h"
44 #include "RNA_enum_types.h"
45
46 #include "WM_api.h"
47 #include "WM_types.h"
48
49 #include "wm.h"
50 #include "wm_event_system.h"
51
52 #define UNDOCUMENTED_OPERATOR_TIP N_("(undocumented operator)")
53
54 static void wm_operatortype_free_macro(wmOperatorType *ot);
55
56 /* -------------------------------------------------------------------- */
57 /** \name Operator Type Registry
58  * \{ */
59
60 static GHash *global_ops_hash = NULL;
61 /** Counter for operator-properties that should not be tagged with #OP_PROP_TAG_ADVANCED. */
62 static int ot_prop_basic_count = -1;
63
64 wmOperatorType *WM_operatortype_find(const char *idname, bool quiet)
65 {
66   if (idname[0]) {
67     wmOperatorType *ot;
68
69     /* needed to support python style names without the _OT_ syntax */
70     char idname_bl[OP_MAX_TYPENAME];
71     WM_operator_bl_idname(idname_bl, idname);
72
73     ot = BLI_ghash_lookup(global_ops_hash, idname_bl);
74     if (ot) {
75       return ot;
76     }
77
78     if (!quiet) {
79       CLOG_INFO(
80           WM_LOG_OPERATORS, 0, "search for unknown operator '%s', '%s'\n", idname_bl, idname);
81     }
82   }
83   else {
84     if (!quiet) {
85       CLOG_INFO(WM_LOG_OPERATORS, 0, "search for empty operator");
86     }
87   }
88
89   return NULL;
90 }
91
92 /* caller must free */
93 void WM_operatortype_iter(GHashIterator *ghi)
94 {
95   BLI_ghashIterator_init(ghi, global_ops_hash);
96 }
97
98 /** \name Operator Type Append
99  * \{ */
100
101 static wmOperatorType *wm_operatortype_append__begin(void)
102 {
103   wmOperatorType *ot = MEM_callocN(sizeof(wmOperatorType), "operatortype");
104
105   BLI_assert(ot_prop_basic_count == -1);
106
107   ot->srna = RNA_def_struct_ptr(&BLENDER_RNA, "", &RNA_OperatorProperties);
108   RNA_def_struct_property_tags(ot->srna, rna_enum_operator_property_tags);
109   /* Set the default i18n context now, so that opfunc can redefine it if needed! */
110   RNA_def_struct_translation_context(ot->srna, BLT_I18NCONTEXT_OPERATOR_DEFAULT);
111   ot->translation_context = BLT_I18NCONTEXT_OPERATOR_DEFAULT;
112
113   return ot;
114 }
115 static void wm_operatortype_append__end(wmOperatorType *ot)
116 {
117   if (ot->name == NULL) {
118     CLOG_ERROR(WM_LOG_OPERATORS, "Operator '%s' has no name property", ot->idname);
119   }
120   BLI_assert((ot->description == NULL) || (ot->description[0]));
121
122   /* Allow calling _begin without _end in operatortype creation. */
123   WM_operatortype_props_advanced_end(ot);
124
125   /* XXX All ops should have a description but for now allow them not to. */
126   RNA_def_struct_ui_text(
127       ot->srna, ot->name, ot->description ? ot->description : UNDOCUMENTED_OPERATOR_TIP);
128   RNA_def_struct_identifier(&BLENDER_RNA, ot->srna, ot->idname);
129
130   BLI_ghash_insert(global_ops_hash, (void *)ot->idname, ot);
131 }
132
133 /* all ops in 1 list (for time being... needs evaluation later) */
134 void WM_operatortype_append(void (*opfunc)(wmOperatorType *))
135 {
136   wmOperatorType *ot = wm_operatortype_append__begin();
137   opfunc(ot);
138   wm_operatortype_append__end(ot);
139 }
140
141 void WM_operatortype_append_ptr(void (*opfunc)(wmOperatorType *, void *), void *userdata)
142 {
143   wmOperatorType *ot = wm_operatortype_append__begin();
144   opfunc(ot, userdata);
145   wm_operatortype_append__end(ot);
146 }
147
148 /** \} */
149
150 /* called on initialize WM_exit() */
151 void WM_operatortype_remove_ptr(wmOperatorType *ot)
152 {
153   BLI_assert(ot == WM_operatortype_find(ot->idname, false));
154
155   RNA_struct_free(&BLENDER_RNA, ot->srna);
156
157   if (ot->last_properties) {
158     IDP_FreeProperty(ot->last_properties);
159     MEM_freeN(ot->last_properties);
160   }
161
162   if (ot->macro.first) {
163     wm_operatortype_free_macro(ot);
164   }
165
166   BLI_ghash_remove(global_ops_hash, ot->idname, NULL, NULL);
167
168   WM_keyconfig_update_operatortype();
169
170   MEM_freeN(ot);
171 }
172
173 bool WM_operatortype_remove(const char *idname)
174 {
175   wmOperatorType *ot = WM_operatortype_find(idname, 0);
176
177   if (ot == NULL) {
178     return false;
179   }
180
181   WM_operatortype_remove_ptr(ot);
182
183   return true;
184 }
185
186 /* called on initialize WM_init() */
187 void wm_operatortype_init(void)
188 {
189   /* reserve size is set based on blender default setup */
190   global_ops_hash = BLI_ghash_str_new_ex("wm_operatortype_init gh", 2048);
191 }
192
193 static void operatortype_ghash_free_cb(wmOperatorType *ot)
194 {
195   if (ot->last_properties) {
196     IDP_FreeProperty(ot->last_properties);
197     MEM_freeN(ot->last_properties);
198   }
199
200   if (ot->macro.first) {
201     wm_operatortype_free_macro(ot);
202   }
203
204   if (ot->ext.srna) {
205     /* python operator, allocs own string */
206     MEM_freeN((void *)ot->idname);
207   }
208
209   MEM_freeN(ot);
210 }
211
212 void wm_operatortype_free(void)
213 {
214   BLI_ghash_free(global_ops_hash, NULL, (GHashValFreeFP)operatortype_ghash_free_cb);
215   global_ops_hash = NULL;
216 }
217
218 /**
219  * Tag all operator-properties of \a ot defined after calling this, until
220  * the next #WM_operatortype_props_advanced_end call (if available), with
221  * #OP_PROP_TAG_ADVANCED. Previously defined ones properties not touched.
222  *
223  * Calling this multiple times without a call to #WM_operatortype_props_advanced_end,
224  * all calls after the first one are ignored. Meaning all propereties defined after the
225  * first call are tagged as advanced.
226  *
227  * This doesn't do the actual tagging, #WM_operatortype_props_advanced_end does which is
228  * called for all operators during registration (see #wm_operatortype_append__end).
229  */
230 void WM_operatortype_props_advanced_begin(wmOperatorType *ot)
231 {
232   if (ot_prop_basic_count ==
233       -1) { /* Don't do anything if _begin was called before, but not _end  */
234     ot_prop_basic_count = RNA_struct_count_properties(ot->srna);
235   }
236 }
237
238 /**
239  * Tags all operator-properties of \a ot defined since the first
240  * #WM_operatortype_props_advanced_begin call,
241  * or the last #WM_operatortype_props_advanced_end call, with #OP_PROP_TAG_ADVANCED.
242  *
243  * \note This is called for all operators during registration (see #wm_operatortype_append__end).
244  * So it does not need to be explicitly called in operator-type definition.
245  */
246 void WM_operatortype_props_advanced_end(wmOperatorType *ot)
247 {
248   PointerRNA struct_ptr;
249   int counter = 0;
250
251   if (ot_prop_basic_count == -1) {
252     /* WM_operatortype_props_advanced_begin was not called. Don't do anything. */
253     return;
254   }
255
256   RNA_pointer_create(NULL, ot->srna, NULL, &struct_ptr);
257
258   RNA_STRUCT_BEGIN (&struct_ptr, prop) {
259     counter++;
260     if (counter > ot_prop_basic_count) {
261       WM_operatortype_prop_tag(prop, OP_PROP_TAG_ADVANCED);
262     }
263   }
264   RNA_STRUCT_END;
265
266   ot_prop_basic_count = -1;
267 }
268
269 /**
270  * Remove memory of all previously executed tools.
271  */
272 void WM_operatortype_last_properties_clear_all(void)
273 {
274   GHashIterator iter;
275
276   for (WM_operatortype_iter(&iter); (!BLI_ghashIterator_done(&iter));
277        (BLI_ghashIterator_step(&iter))) {
278     wmOperatorType *ot = BLI_ghashIterator_getValue(&iter);
279
280     if (ot->last_properties) {
281       IDP_FreeProperty(ot->last_properties);
282       MEM_freeN(ot->last_properties);
283       ot->last_properties = NULL;
284     }
285   }
286 }
287
288 /** \} */
289
290 /* -------------------------------------------------------------------- */
291 /** \name Operator Macro Type
292  * \{ */
293
294 typedef struct {
295   int retval;
296 } MacroData;
297
298 static void wm_macro_start(wmOperator *op)
299 {
300   if (op->customdata == NULL) {
301     op->customdata = MEM_callocN(sizeof(MacroData), "MacroData");
302   }
303 }
304
305 static int wm_macro_end(wmOperator *op, int retval)
306 {
307   if (retval & OPERATOR_CANCELLED) {
308     MacroData *md = op->customdata;
309
310     if (md->retval & OPERATOR_FINISHED) {
311       retval |= OPERATOR_FINISHED;
312       retval &= ~OPERATOR_CANCELLED;
313     }
314   }
315
316   /* if modal is ending, free custom data */
317   if (retval & (OPERATOR_FINISHED | OPERATOR_CANCELLED)) {
318     if (op->customdata) {
319       MEM_freeN(op->customdata);
320       op->customdata = NULL;
321     }
322   }
323
324   return retval;
325 }
326
327 /* macro exec only runs exec calls */
328 static int wm_macro_exec(bContext *C, wmOperator *op)
329 {
330   wmOperator *opm;
331   int retval = OPERATOR_FINISHED;
332
333   wm_macro_start(op);
334
335   for (opm = op->macro.first; opm; opm = opm->next) {
336
337     if (opm->type->exec) {
338       retval = opm->type->exec(C, opm);
339       OPERATOR_RETVAL_CHECK(retval);
340
341       if (retval & OPERATOR_FINISHED) {
342         MacroData *md = op->customdata;
343         md->retval = OPERATOR_FINISHED; /* keep in mind that at least one operator finished */
344       }
345       else {
346         break; /* operator didn't finish, end macro */
347       }
348     }
349     else {
350       CLOG_WARN(WM_LOG_OPERATORS, "'%s' cant exec macro", opm->type->idname);
351     }
352   }
353
354   return wm_macro_end(op, retval);
355 }
356
357 static int wm_macro_invoke_internal(bContext *C,
358                                     wmOperator *op,
359                                     const wmEvent *event,
360                                     wmOperator *opm)
361 {
362   int retval = OPERATOR_FINISHED;
363
364   /* start from operator received as argument */
365   for (; opm; opm = opm->next) {
366     if (opm->type->invoke) {
367       retval = opm->type->invoke(C, opm, event);
368     }
369     else if (opm->type->exec) {
370       retval = opm->type->exec(C, opm);
371     }
372
373     OPERATOR_RETVAL_CHECK(retval);
374
375     BLI_movelisttolist(&op->reports->list, &opm->reports->list);
376
377     if (retval & OPERATOR_FINISHED) {
378       MacroData *md = op->customdata;
379       md->retval = OPERATOR_FINISHED; /* keep in mind that at least one operator finished */
380     }
381     else {
382       break; /* operator didn't finish, end macro */
383     }
384   }
385
386   return wm_macro_end(op, retval);
387 }
388
389 static int wm_macro_invoke(bContext *C, wmOperator *op, const wmEvent *event)
390 {
391   wm_macro_start(op);
392   return wm_macro_invoke_internal(C, op, event, op->macro.first);
393 }
394
395 static int wm_macro_modal(bContext *C, wmOperator *op, const wmEvent *event)
396 {
397   wmOperator *opm = op->opm;
398   int retval = OPERATOR_FINISHED;
399
400   if (opm == NULL) {
401     CLOG_ERROR(WM_LOG_OPERATORS, "macro error, calling NULL modal()");
402   }
403   else {
404     retval = opm->type->modal(C, opm, event);
405     OPERATOR_RETVAL_CHECK(retval);
406
407     /* if we're halfway through using a tool and cancel it, clear the options [#37149] */
408     if (retval & OPERATOR_CANCELLED) {
409       WM_operator_properties_clear(opm->ptr);
410     }
411
412     /* if this one is done but it's not the last operator in the macro */
413     if ((retval & OPERATOR_FINISHED) && opm->next) {
414       MacroData *md = op->customdata;
415
416       md->retval = OPERATOR_FINISHED; /* keep in mind that at least one operator finished */
417
418       retval = wm_macro_invoke_internal(C, op, event, opm->next);
419
420       /* if new operator is modal and also added its own handler */
421       if (retval & OPERATOR_RUNNING_MODAL && op->opm != opm) {
422         wmWindow *win = CTX_wm_window(C);
423         wmEventHandler_Op *handler;
424
425         handler = BLI_findptr(&win->modalhandlers, op, offsetof(wmEventHandler_Op, op));
426         if (handler) {
427           BLI_remlink(&win->modalhandlers, handler);
428           wm_event_free_handler(&handler->head);
429         }
430
431         /* if operator is blocking, grab cursor
432          * This may end up grabbing twice, but we don't care.
433          * */
434         if (op->opm->type->flag & OPTYPE_BLOCKING) {
435           int bounds[4] = {-1, -1, -1, -1};
436           const bool wrap = ((U.uiflag & USER_CONTINUOUS_MOUSE) &&
437                              ((op->opm->flag & OP_IS_MODAL_GRAB_CURSOR) ||
438                               (op->opm->type->flag & OPTYPE_GRAB_CURSOR)));
439
440           if (wrap) {
441             ARegion *ar = CTX_wm_region(C);
442             if (ar) {
443               bounds[0] = ar->winrct.xmin;
444               bounds[1] = ar->winrct.ymax;
445               bounds[2] = ar->winrct.xmax;
446               bounds[3] = ar->winrct.ymin;
447             }
448           }
449
450           WM_cursor_grab_enable(win, wrap, false, bounds);
451         }
452       }
453     }
454   }
455
456   return wm_macro_end(op, retval);
457 }
458
459 static void wm_macro_cancel(bContext *C, wmOperator *op)
460 {
461   /* call cancel on the current modal operator, if any */
462   if (op->opm && op->opm->type->cancel) {
463     op->opm->type->cancel(C, op->opm);
464   }
465
466   wm_macro_end(op, OPERATOR_CANCELLED);
467 }
468
469 /* Names have to be static for now */
470 wmOperatorType *WM_operatortype_append_macro(const char *idname,
471                                              const char *name,
472                                              const char *description,
473                                              int flag)
474 {
475   wmOperatorType *ot;
476   const char *i18n_context;
477
478   if (WM_operatortype_find(idname, true)) {
479     CLOG_ERROR(WM_LOG_OPERATORS, "operator %s exists, cannot create macro", idname);
480     return NULL;
481   }
482
483   ot = MEM_callocN(sizeof(wmOperatorType), "operatortype");
484   ot->srna = RNA_def_struct_ptr(&BLENDER_RNA, "", &RNA_OperatorProperties);
485
486   ot->idname = idname;
487   ot->name = name;
488   ot->description = description;
489   ot->flag = OPTYPE_MACRO | flag;
490
491   ot->exec = wm_macro_exec;
492   ot->invoke = wm_macro_invoke;
493   ot->modal = wm_macro_modal;
494   ot->cancel = wm_macro_cancel;
495   ot->poll = NULL;
496
497   if (!ot->description) {
498     /* XXX All ops should have a description but for now allow them not to. */
499     ot->description = UNDOCUMENTED_OPERATOR_TIP;
500   }
501
502   RNA_def_struct_ui_text(ot->srna, ot->name, ot->description);
503   RNA_def_struct_identifier(&BLENDER_RNA, ot->srna, ot->idname);
504   /* Use i18n context from ext.srna if possible (py operators). */
505   i18n_context = ot->ext.srna ? RNA_struct_translation_context(ot->ext.srna) :
506                                 BLT_I18NCONTEXT_OPERATOR_DEFAULT;
507   RNA_def_struct_translation_context(ot->srna, i18n_context);
508   ot->translation_context = i18n_context;
509
510   BLI_ghash_insert(global_ops_hash, (void *)ot->idname, ot);
511
512   return ot;
513 }
514
515 void WM_operatortype_append_macro_ptr(void (*opfunc)(wmOperatorType *, void *), void *userdata)
516 {
517   wmOperatorType *ot;
518
519   ot = MEM_callocN(sizeof(wmOperatorType), "operatortype");
520   ot->srna = RNA_def_struct_ptr(&BLENDER_RNA, "", &RNA_OperatorProperties);
521
522   ot->flag = OPTYPE_MACRO;
523   ot->exec = wm_macro_exec;
524   ot->invoke = wm_macro_invoke;
525   ot->modal = wm_macro_modal;
526   ot->cancel = wm_macro_cancel;
527   ot->poll = NULL;
528
529   if (!ot->description) {
530     ot->description = UNDOCUMENTED_OPERATOR_TIP;
531   }
532
533   /* Set the default i18n context now, so that opfunc can redefine it if needed! */
534   RNA_def_struct_translation_context(ot->srna, BLT_I18NCONTEXT_OPERATOR_DEFAULT);
535   ot->translation_context = BLT_I18NCONTEXT_OPERATOR_DEFAULT;
536   opfunc(ot, userdata);
537
538   RNA_def_struct_ui_text(ot->srna, ot->name, ot->description);
539   RNA_def_struct_identifier(&BLENDER_RNA, ot->srna, ot->idname);
540
541   BLI_ghash_insert(global_ops_hash, (void *)ot->idname, ot);
542 }
543
544 wmOperatorTypeMacro *WM_operatortype_macro_define(wmOperatorType *ot, const char *idname)
545 {
546   wmOperatorTypeMacro *otmacro = MEM_callocN(sizeof(wmOperatorTypeMacro), "wmOperatorTypeMacro");
547
548   BLI_strncpy(otmacro->idname, idname, OP_MAX_TYPENAME);
549
550   /* do this on first use, since operatordefinitions might have been not done yet */
551   WM_operator_properties_alloc(&(otmacro->ptr), &(otmacro->properties), idname);
552   WM_operator_properties_sanitize(otmacro->ptr, 1);
553
554   BLI_addtail(&ot->macro, otmacro);
555
556   {
557     /* operator should always be found but in the event its not. don't segfault */
558     wmOperatorType *otsub = WM_operatortype_find(idname, 0);
559     if (otsub) {
560       RNA_def_pointer_runtime(
561           ot->srna, otsub->idname, otsub->srna, otsub->name, otsub->description);
562     }
563   }
564
565   return otmacro;
566 }
567
568 static void wm_operatortype_free_macro(wmOperatorType *ot)
569 {
570   wmOperatorTypeMacro *otmacro;
571
572   for (otmacro = ot->macro.first; otmacro; otmacro = otmacro->next) {
573     if (otmacro->ptr) {
574       WM_operator_properties_free(otmacro->ptr);
575       MEM_freeN(otmacro->ptr);
576     }
577   }
578   BLI_freelistN(&ot->macro);
579 }
580
581 /** \} */