Cleanup: reorder report argument for pointer assignment
[blender.git] / source / blender / editors / interface / interface_eyedropper_datablock.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  * The Original Code is Copyright (C) 2009 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup edinterface
22  *
23  * Eyedropper (ID data-blocks)
24  *
25  * Defines:
26  * - #UI_OT_eyedropper_id
27  */
28
29 #include "MEM_guardedalloc.h"
30
31 #include "DNA_space_types.h"
32 #include "DNA_screen_types.h"
33 #include "DNA_object_types.h"
34
35 #include "BLI_string.h"
36
37 #include "BLT_translation.h"
38
39 #include "BKE_context.h"
40 #include "BKE_screen.h"
41 #include "BKE_report.h"
42 #include "BKE_idcode.h"
43
44 #include "RNA_access.h"
45
46 #include "UI_interface.h"
47
48 #include "WM_api.h"
49 #include "WM_types.h"
50
51 #include "ED_space_api.h"
52 #include "ED_screen.h"
53 #include "ED_view3d.h"
54
55 #include "interface_intern.h"
56 #include "interface_eyedropper_intern.h"
57
58 /**
59  * \note #DataDropper is only internal name to avoid confusion with other kinds of eye-droppers.
60  */
61 typedef struct DataDropper {
62   PointerRNA ptr;
63   PropertyRNA *prop;
64   short idcode;
65   const char *idcode_name;
66   bool is_undo;
67
68   ID *init_id; /* for resetting on cancel */
69
70   ARegionType *art;
71   void *draw_handle_pixel;
72   char name[200];
73 } DataDropper;
74
75 static void datadropper_draw_cb(const struct bContext *C, ARegion *ar, void *arg)
76 {
77   DataDropper *ddr = arg;
78   eyedropper_draw_cursor_text(C, ar, ddr->name);
79 }
80
81 static int datadropper_init(bContext *C, wmOperator *op)
82 {
83   int index_dummy;
84   StructRNA *type;
85
86   SpaceType *st;
87   ARegionType *art;
88
89   st = BKE_spacetype_from_id(SPACE_VIEW3D);
90   art = BKE_regiontype_from_id(st, RGN_TYPE_WINDOW);
91
92   DataDropper *ddr = MEM_callocN(sizeof(DataDropper), __func__);
93
94   uiBut *but = UI_context_active_but_prop_get(C, &ddr->ptr, &ddr->prop, &index_dummy);
95
96   if ((ddr->ptr.data == NULL) || (ddr->prop == NULL) ||
97       (RNA_property_editable(&ddr->ptr, ddr->prop) == false) ||
98       (RNA_property_type(ddr->prop) != PROP_POINTER)) {
99     MEM_freeN(ddr);
100     return false;
101   }
102   op->customdata = ddr;
103
104   ddr->is_undo = UI_but_flag_is_set(but, UI_BUT_UNDO);
105
106   ddr->art = art;
107   ddr->draw_handle_pixel = ED_region_draw_cb_activate(
108       art, datadropper_draw_cb, ddr, REGION_DRAW_POST_PIXEL);
109
110   type = RNA_property_pointer_type(&ddr->ptr, ddr->prop);
111   ddr->idcode = RNA_type_to_ID_code(type);
112   BLI_assert(ddr->idcode != 0);
113   /* Note we can translate here (instead of on draw time),
114    * because this struct has very short lifetime. */
115   ddr->idcode_name = TIP_(BKE_idcode_to_name(ddr->idcode));
116
117   PointerRNA ptr = RNA_property_pointer_get(&ddr->ptr, ddr->prop);
118   ddr->init_id = ptr.id.data;
119
120   return true;
121 }
122
123 static void datadropper_exit(bContext *C, wmOperator *op)
124 {
125   WM_cursor_modal_restore(CTX_wm_window(C));
126
127   if (op->customdata) {
128     DataDropper *ddr = (DataDropper *)op->customdata;
129
130     if (ddr->art) {
131       ED_region_draw_cb_exit(ddr->art, ddr->draw_handle_pixel);
132     }
133
134     MEM_freeN(op->customdata);
135
136     op->customdata = NULL;
137   }
138
139   WM_event_add_mousemove(C);
140 }
141
142 /* *** datadropper id helper functions *** */
143 /**
144  * \brief get the ID from the screen.
145  */
146 static void datadropper_id_sample_pt(bContext *C, DataDropper *ddr, int mx, int my, ID **r_id)
147 {
148   /* we could use some clever */
149   bScreen *screen = CTX_wm_screen(C);
150   ScrArea *sa = BKE_screen_find_area_xy(screen, -1, mx, my);
151
152   ScrArea *area_prev = CTX_wm_area(C);
153   ARegion *ar_prev = CTX_wm_region(C);
154
155   ddr->name[0] = '\0';
156
157   if (sa) {
158     if (sa->spacetype == SPACE_VIEW3D) {
159       ARegion *ar = BKE_area_find_region_xy(sa, RGN_TYPE_WINDOW, mx, my);
160       if (ar) {
161         const int mval[2] = {mx - ar->winrct.xmin, my - ar->winrct.ymin};
162         Base *base;
163
164         CTX_wm_area_set(C, sa);
165         CTX_wm_region_set(C, ar);
166
167         /* grr, always draw else we leave stale text */
168         ED_region_tag_redraw(ar);
169
170         base = ED_view3d_give_base_under_cursor(C, mval);
171         if (base) {
172           Object *ob = base->object;
173           ID *id = NULL;
174           if (ddr->idcode == ID_OB) {
175             id = (ID *)ob;
176           }
177           else if (ob->data) {
178             if (GS(((ID *)ob->data)->name) == ddr->idcode) {
179               id = (ID *)ob->data;
180             }
181             else {
182               BLI_snprintf(
183                   ddr->name, sizeof(ddr->name), "Incompatible, expected a %s", ddr->idcode_name);
184             }
185           }
186
187           PointerRNA idptr;
188           RNA_id_pointer_create(id, &idptr);
189
190           if (id && RNA_property_pointer_poll(&ddr->ptr, ddr->prop, &idptr)) {
191             BLI_snprintf(ddr->name, sizeof(ddr->name), "%s: %s", ddr->idcode_name, id->name + 2);
192             *r_id = id;
193           }
194         }
195       }
196     }
197   }
198
199   CTX_wm_area_set(C, area_prev);
200   CTX_wm_region_set(C, ar_prev);
201 }
202
203 /* sets the ID, returns success */
204 static bool datadropper_id_set(bContext *C, DataDropper *ddr, ID *id)
205 {
206   PointerRNA ptr_value;
207
208   RNA_id_pointer_create(id, &ptr_value);
209
210   RNA_property_pointer_set(&ddr->ptr, ddr->prop, ptr_value, NULL);
211
212   RNA_property_update(C, &ddr->ptr, ddr->prop);
213
214   ptr_value = RNA_property_pointer_get(&ddr->ptr, ddr->prop);
215
216   return (ptr_value.id.data == id);
217 }
218
219 /* single point sample & set */
220 static bool datadropper_id_sample(bContext *C, DataDropper *ddr, int mx, int my)
221 {
222   ID *id = NULL;
223
224   datadropper_id_sample_pt(C, ddr, mx, my, &id);
225   return datadropper_id_set(C, ddr, id);
226 }
227
228 static void datadropper_cancel(bContext *C, wmOperator *op)
229 {
230   DataDropper *ddr = op->customdata;
231   datadropper_id_set(C, ddr, ddr->init_id);
232   datadropper_exit(C, op);
233 }
234
235 /* main modal status check */
236 static int datadropper_modal(bContext *C, wmOperator *op, const wmEvent *event)
237 {
238   DataDropper *ddr = (DataDropper *)op->customdata;
239
240   /* handle modal keymap */
241   if (event->type == EVT_MODAL_MAP) {
242     switch (event->val) {
243       case EYE_MODAL_CANCEL:
244         datadropper_cancel(C, op);
245         return OPERATOR_CANCELLED;
246       case EYE_MODAL_SAMPLE_CONFIRM: {
247         const bool is_undo = ddr->is_undo;
248         const bool success = datadropper_id_sample(C, ddr, event->x, event->y);
249         datadropper_exit(C, op);
250         if (success) {
251           /* Could support finished & undo-skip. */
252           return is_undo ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
253         }
254         else {
255           BKE_report(op->reports, RPT_WARNING, "Failed to set value");
256           return OPERATOR_CANCELLED;
257         }
258       }
259     }
260   }
261   else if (event->type == MOUSEMOVE) {
262     ID *id = NULL;
263     datadropper_id_sample_pt(C, ddr, event->x, event->y, &id);
264   }
265
266   return OPERATOR_RUNNING_MODAL;
267 }
268
269 /* Modal Operator init */
270 static int datadropper_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
271 {
272   /* init */
273   if (datadropper_init(C, op)) {
274     WM_cursor_modal_set(CTX_wm_window(C), BC_EYEDROPPER_CURSOR);
275
276     /* add temp handler */
277     WM_event_add_modal_handler(C, op);
278
279     return OPERATOR_RUNNING_MODAL;
280   }
281   else {
282     return OPERATOR_CANCELLED;
283   }
284 }
285
286 /* Repeat operator */
287 static int datadropper_exec(bContext *C, wmOperator *op)
288 {
289   /* init */
290   if (datadropper_init(C, op)) {
291     /* cleanup */
292     datadropper_exit(C, op);
293
294     return OPERATOR_FINISHED;
295   }
296   else {
297     return OPERATOR_CANCELLED;
298   }
299 }
300
301 static bool datadropper_poll(bContext *C)
302 {
303   PointerRNA ptr;
304   PropertyRNA *prop;
305   int index_dummy;
306   uiBut *but;
307
308   /* data dropper only supports object data */
309   if ((CTX_wm_window(C) != NULL) &&
310       (but = UI_context_active_but_prop_get(C, &ptr, &prop, &index_dummy)) &&
311       (but->type == UI_BTYPE_SEARCH_MENU) && (but->flag & UI_BUT_VALUE_CLEAR)) {
312     if (prop && RNA_property_type(prop) == PROP_POINTER) {
313       StructRNA *type = RNA_property_pointer_type(&ptr, prop);
314       const short idcode = RNA_type_to_ID_code(type);
315       if ((idcode == ID_OB) || OB_DATA_SUPPORT_ID(idcode)) {
316         return 1;
317       }
318     }
319   }
320
321   return 0;
322 }
323
324 void UI_OT_eyedropper_id(wmOperatorType *ot)
325 {
326   /* identifiers */
327   ot->name = "Eyedropper Data-Block";
328   ot->idname = "UI_OT_eyedropper_id";
329   ot->description = "Sample a data-block from the 3D View to store in a property";
330
331   /* api callbacks */
332   ot->invoke = datadropper_invoke;
333   ot->modal = datadropper_modal;
334   ot->cancel = datadropper_cancel;
335   ot->exec = datadropper_exec;
336   ot->poll = datadropper_poll;
337
338   /* flags */
339   ot->flag = OPTYPE_UNDO | OPTYPE_BLOCKING | OPTYPE_INTERNAL;
340
341   /* properties */
342 }