ae6ab09a62ade77ad9d6f5e318f64096dfe5e45d
[blender.git] / source / blender / editors / interface / interface_region_tooltip.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/interface/interface_region_tooltip.c
27  *  \ingroup edinterface
28  *
29  * ToolTip Region and Construction
30  */
31
32 /* TODO(campbell):
33  * We may want to have a higher level API that initializes a timer,
34  * checks for mouse motion and clears the tool-tip afterwards.
35  * We never want multiple tool-tips at once so this could be handled on the window / window-manager level.
36  *
37  * For now it's not a priority, so leave as-is.
38  */
39
40 #include <stdarg.h>
41 #include <stdlib.h>
42 #include <string.h>
43 #include <assert.h>
44
45 #include "MEM_guardedalloc.h"
46
47 #include "DNA_userdef_types.h"
48
49 #include "BLI_math.h"
50 #include "BLI_string.h"
51 #include "BLI_string_utf8.h"
52 #include "BLI_rect.h"
53 #include "BLI_utildefines.h"
54
55 #include "BKE_context.h"
56 #include "BKE_screen.h"
57
58 #include "WM_api.h"
59 #include "WM_types.h"
60
61 #include "RNA_access.h"
62
63 #include "BIF_gl.h"
64
65 #include "UI_interface.h"
66
67 #include "BLF_api.h"
68 #include "BLT_translation.h"
69
70 #ifdef WITH_PYTHON
71 #  include "BPY_extern.h"
72 #endif
73
74 #include "ED_screen.h"
75
76 #include "interface_intern.h"
77 #include "interface_regions_intern.h"
78
79 #define UI_TIP_PAD_FAC      1.3f
80 #define UI_TIP_PADDING      (int)(UI_TIP_PAD_FAC * UI_UNIT_Y)
81 #define UI_TIP_MAXWIDTH     600
82
83
84 typedef struct uiTooltipFormat {
85         enum {
86                 UI_TIP_STYLE_NORMAL = 0,
87                 UI_TIP_STYLE_HEADER,
88                 UI_TIP_STYLE_MONO,
89         } style : 3;
90         enum {
91                 UI_TIP_LC_MAIN = 0,     /* primary text */
92                 UI_TIP_LC_VALUE,        /* the value of buttons (also shortcuts) */
93                 UI_TIP_LC_ACTIVE,       /* titles of active enum values */
94                 UI_TIP_LC_NORMAL,       /* regular text */
95                 UI_TIP_LC_PYTHON,       /* Python snippet */
96                 UI_TIP_LC_ALERT,        /* description of why operator can't run */
97         } color_id : 4;
98         int is_pad : 1;
99 } uiTooltipFormat;
100
101 typedef struct uiTooltipField {
102         char *text;
103         char *text_suffix;
104         struct {
105                 uint x_pos;     /* x cursor position at the end of the last line */
106                 uint lines;     /* number of lines, 1 or more with word-wrap */
107         } geom;
108         uiTooltipFormat format;
109
110 } uiTooltipField;
111
112 typedef struct uiTooltipData {
113         rcti bbox;
114         uiTooltipField *fields;
115         uint            fields_len;
116         uiFontStyle fstyle;
117         int wrap_width;
118         int toth, lineh;
119 } uiTooltipData;
120
121 #define UI_TIP_LC_MAX 6
122
123 BLI_STATIC_ASSERT(UI_TIP_LC_MAX == UI_TIP_LC_ALERT + 1, "invalid lc-max");
124 BLI_STATIC_ASSERT(sizeof(uiTooltipFormat) <= sizeof(int), "oversize");
125
126 static uiTooltipField *text_field_add_only(
127         uiTooltipData *data)
128 {
129         data->fields_len += 1;
130         data->fields = MEM_recallocN(data->fields, sizeof(*data->fields) * data->fields_len);
131         return &data->fields[data->fields_len - 1];
132 }
133
134 static uiTooltipField *text_field_add(
135         uiTooltipData *data,
136         const uiTooltipFormat *format)
137 {
138         uiTooltipField *field = text_field_add_only(data);
139         field->format = *format;
140         return field;
141 }
142
143 /* -------------------------------------------------------------------- */
144 /** \name ToolTip Callbacks (Draw & Free)
145  * \{ */
146
147 static void rgb_tint(
148         float col[3],
149         float h, float h_strength,
150         float v, float v_strength)
151 {
152         float col_hsv_from[3];
153         float col_hsv_to[3];
154
155         rgb_to_hsv_v(col, col_hsv_from);
156
157         col_hsv_to[0] = h;
158         col_hsv_to[1] = h_strength;
159         col_hsv_to[2] = (col_hsv_from[2] * (1.0f - v_strength)) + (v * v_strength);
160
161         hsv_to_rgb_v(col_hsv_to, col);
162 }
163
164 static void ui_tooltip_region_draw_cb(const bContext *UNUSED(C), ARegion *ar)
165 {
166         const float pad_px = UI_TIP_PADDING;
167         uiTooltipData *data = ar->regiondata;
168         uiWidgetColors *theme = ui_tooltip_get_theme();
169         rcti bbox = data->bbox;
170         float tip_colors[UI_TIP_LC_MAX][3];
171         unsigned char drawcol[4] = {0, 0, 0, 255}; /* to store color in while drawing (alpha is always 255) */
172
173         float *main_color    = tip_colors[UI_TIP_LC_MAIN]; /* the color from the theme */
174         float *value_color   = tip_colors[UI_TIP_LC_VALUE];
175         float *active_color  = tip_colors[UI_TIP_LC_ACTIVE];
176         float *normal_color  = tip_colors[UI_TIP_LC_NORMAL];
177         float *python_color  = tip_colors[UI_TIP_LC_PYTHON];
178         float *alert_color   = tip_colors[UI_TIP_LC_ALERT];
179
180         float background_color[3];
181         float tone_bg;
182         int i;
183
184         wmOrtho2_region_pixelspace(ar);
185
186         /* draw background */
187         ui_draw_tooltip_background(UI_style_get(), NULL, &bbox);
188
189         /* set background_color */
190         rgb_uchar_to_float(background_color, (const unsigned char *)theme->inner);
191
192         /* calculate normal_color */
193         rgb_uchar_to_float(main_color, (const unsigned char *)theme->text);
194         copy_v3_v3(active_color, main_color);
195         copy_v3_v3(normal_color, main_color);
196         copy_v3_v3(python_color, main_color);
197         copy_v3_v3(alert_color, main_color);
198         copy_v3_v3(value_color, main_color);
199
200         /* find the brightness difference between background and text colors */
201
202         tone_bg = rgb_to_grayscale(background_color);
203         /* tone_fg = rgb_to_grayscale(main_color); */
204
205         /* mix the colors */
206         rgb_tint(value_color,  0.0f, 0.0f, tone_bg, 0.2f);  /* light gray */
207         rgb_tint(active_color, 0.6f, 0.2f, tone_bg, 0.2f);  /* light blue */
208         rgb_tint(normal_color, 0.0f, 0.0f, tone_bg, 0.4f);  /* gray       */
209         rgb_tint(python_color, 0.0f, 0.0f, tone_bg, 0.5f);  /* dark gray  */
210         rgb_tint(alert_color,  0.0f, 0.8f, tone_bg, 0.1f);  /* red        */
211
212         /* draw text */
213         BLF_wordwrap(data->fstyle.uifont_id, data->wrap_width);
214         BLF_wordwrap(blf_mono_font, data->wrap_width);
215
216         bbox.xmin += 0.5f * pad_px;  /* add padding to the text */
217         bbox.ymax -= 0.25f * pad_px;
218
219         for (i = 0; i < data->fields_len; i++) {
220                 const uiTooltipField *field = &data->fields[i];
221                 const uiTooltipField *field_next = (i + 1) != data->fields_len ? &data->fields[i + 1] : NULL;
222
223                 bbox.ymin = bbox.ymax - (data->lineh * field->geom.lines);
224                 if (field->format.style == UI_TIP_STYLE_HEADER) {
225                         /* draw header and active data (is done here to be able to change color) */
226                         uiFontStyle fstyle_header = data->fstyle;
227
228                         /* override text-style */
229                         fstyle_header.shadow = 1;
230                         fstyle_header.shadowcolor = rgb_to_grayscale(tip_colors[UI_TIP_LC_MAIN]);
231                         fstyle_header.shadx = fstyle_header.shady = 0;
232                         fstyle_header.shadowalpha = 1.0f;
233                         fstyle_header.word_wrap = true;
234
235                         rgb_float_to_uchar(drawcol, tip_colors[UI_TIP_LC_MAIN]);
236                         UI_fontstyle_set(&fstyle_header);
237                         UI_fontstyle_draw(&fstyle_header, &bbox, field->text, drawcol);
238
239                         fstyle_header.shadow = 0;
240
241                         /* offset to the end of the last line */
242                         if (field->text_suffix) {
243                                 float xofs = field->geom.x_pos;
244                                 float yofs = data->lineh * (field->geom.lines - 1);
245                                 bbox.xmin += xofs;
246                                 bbox.ymax -= yofs;
247
248                                 rgb_float_to_uchar(drawcol, tip_colors[UI_TIP_LC_ACTIVE]);
249                                 UI_fontstyle_draw(&fstyle_header, &bbox, field->text_suffix, drawcol);
250
251                                 /* undo offset */
252                                 bbox.xmin -= xofs;
253                                 bbox.ymax += yofs;
254                         }
255                 }
256                 else if (field->format.style == UI_TIP_STYLE_MONO) {
257                         uiFontStyle fstyle_mono = data->fstyle;
258                         fstyle_mono.uifont_id = blf_mono_font;
259                         fstyle_mono.word_wrap = true;
260
261                         UI_fontstyle_set(&fstyle_mono);
262                         /* XXX, needed because we dont have mono in 'U.uifonts' */
263                         BLF_size(fstyle_mono.uifont_id, fstyle_mono.points * U.pixelsize, U.dpi);
264                         rgb_float_to_uchar(drawcol, tip_colors[field->format.color_id]);
265                         UI_fontstyle_draw(&fstyle_mono, &bbox, field->text, drawcol);
266                 }
267                 else {
268                         uiFontStyle fstyle_normal = data->fstyle;
269                         BLI_assert(field->format.style == UI_TIP_STYLE_NORMAL);
270                         fstyle_normal.word_wrap = true;
271
272                         /* draw remaining data */
273                         rgb_float_to_uchar(drawcol, tip_colors[field->format.color_id]);
274                         UI_fontstyle_set(&fstyle_normal);
275                         UI_fontstyle_draw(&fstyle_normal, &bbox, field->text, drawcol);
276                 }
277
278                 bbox.ymax -= data->lineh * field->geom.lines;
279
280                 if (field_next && field_next->format.is_pad) {
281                         bbox.ymax -= data->lineh * (UI_TIP_PAD_FAC - 1);
282                 }
283         }
284
285         BLF_disable(data->fstyle.uifont_id, BLF_WORD_WRAP);
286         BLF_disable(blf_mono_font, BLF_WORD_WRAP);
287 }
288
289 static void ui_tooltip_region_free_cb(ARegion *ar)
290 {
291         uiTooltipData *data;
292
293         data = ar->regiondata;
294
295         for (int  i = 0; i < data->fields_len; i++) {
296                 const uiTooltipField *field = &data->fields[i];
297                 MEM_freeN(field->text);
298                 if (field->text_suffix) {
299                         MEM_freeN(field->text_suffix);
300                 }
301         }
302         MEM_freeN(data->fields);
303         MEM_freeN(data);
304         ar->regiondata = NULL;
305 }
306
307 /** \} */
308
309 /* -------------------------------------------------------------------- */
310 /** \name ToolTip Creation
311  * \{ */
312
313 static bool ui_tooltip_data_append_from_keymap(
314         bContext *C, uiTooltipData *data,
315         wmKeyMap *keymap)
316 {
317         const int fields_len_init = data->fields_len;
318         char buf[512];
319
320         for (wmKeyMapItem *kmi = keymap->items.first; kmi; kmi = kmi->next) {
321                 wmOperatorType *ot = WM_operatortype_find(kmi->idname, true);
322                 if (ot != NULL) {
323                         /* Tip */
324                         {
325                                 uiTooltipField *field = text_field_add(
326                                         data, &(uiTooltipFormat){
327                                             .style = UI_TIP_STYLE_NORMAL,
328                                             .color_id = UI_TIP_LC_MAIN,
329                                             .is_pad = true,
330                                         });
331                                 field->text = BLI_strdup(ot->description[0] ? ot->description : ot->name);
332                         }
333                         /* Shortcut */
334                         {
335                                 uiTooltipField *field = text_field_add(
336                                         data, &(uiTooltipFormat){
337                                             .style = UI_TIP_STYLE_NORMAL,
338                                             .color_id = UI_TIP_LC_NORMAL,
339                                         });
340                                 bool found = false;
341                                 if (WM_keymap_item_to_string(kmi, false, buf, sizeof(buf))) {
342                                         found = true;
343                                 }
344                                 field->text = BLI_sprintfN(TIP_("Shortcut: %s"), found ? buf : "None");
345                         }
346
347                         /* Python */
348                         if (U.flag & USER_TOOLTIPS_PYTHON) {
349                                 uiTooltipField *field = text_field_add(
350                                         data, &(uiTooltipFormat){
351                                             .style = UI_TIP_STYLE_NORMAL,
352                                             .color_id = UI_TIP_LC_PYTHON,
353                                         });
354                                 char *str = WM_operator_pystring_ex(C, NULL, false, false, ot, kmi->ptr);
355                                 WM_operator_pystring_abbreviate(str, 32);
356                                 field->text = BLI_sprintfN(TIP_("Python: %s"), str);
357                                 MEM_freeN(str);
358                         }
359                 }
360         }
361
362         return (fields_len_init != data->fields_len);
363 }
364
365
366 /**
367  * Special tool-system exception.
368  */
369 static uiTooltipData *ui_tooltip_data_from_tool(bContext *C, uiBut *but)
370 {
371         if (but->optype == NULL) {
372                 return NULL;
373         }
374
375         if (!STREQ(but->optype->idname, "WM_OT_tool_set_by_name")) {
376                 return NULL;
377         }
378
379         char tool_name[MAX_NAME];
380         RNA_string_get(but->opptr, "name", tool_name);
381         BLI_assert(tool_name[0] != '\0');
382
383         /* We have a tool, now extract the info. */
384         uiTooltipData *data = MEM_callocN(sizeof(uiTooltipData), "uiTooltipData");
385
386 #ifdef WITH_PYTHON
387         /* it turns out to be most simple to do this via Python since C
388          * doesn't have access to information about non-active tools.
389          */
390         char expr[256];
391
392         /* Tip */
393         {
394                 SNPRINTF(
395                         expr,
396                         "__import__('bl_ui').space_toolsystem_common.description_from_name("
397                         "__import__('bpy').context, "
398                         "__import__('bpy').context.space_data.type, "
399                         "'%s') + '.'",
400                         tool_name);
401
402                 char *expr_result = NULL;
403                 if (BPY_execute_string_as_string(C, expr, true, &expr_result)) {
404                         if (!STREQ(expr_result, ".")) {
405                                 uiTooltipField *field = text_field_add(
406                                         data, &(uiTooltipFormat){
407                                             .style = UI_TIP_STYLE_NORMAL,
408                                             .color_id = UI_TIP_LC_MAIN,
409                                             .is_pad = true,
410                                         });
411                                 field->text = expr_result;
412                         }
413                         else {
414                                 MEM_freeN(expr_result);
415                         }
416                 }
417         }
418
419         /* Keymap */
420
421         /* This is too handy not to expose somehow, let's be sneaky for now. */
422         if (CTX_wm_window(C)->eventstate->shift) {
423                 SNPRINTF(
424                         expr,
425                         "getattr("
426                         "__import__('bl_ui').space_toolsystem_common.keymap_from_name("
427                         "__import__('bpy').context, "
428                         "__import__('bpy').context.space_data.type, "
429                         "'%s'), "
430                         "'as_pointer', lambda: 0)()",
431                         tool_name);
432
433                 intptr_t expr_result = 0;
434                 if (BPY_execute_string_as_intptr(C, expr, true, &expr_result)) {
435                         if (expr_result != 0) {
436                                 wmKeyMap *keymap = (wmKeyMap *)expr_result;
437                                 ui_tooltip_data_append_from_keymap(C, data, keymap);
438                         }
439                 }
440         }
441 #endif  /* WITH_PYTHON */
442
443         if (data->fields_len == 0) {
444                 MEM_freeN(data);
445                 return NULL;
446         }
447         else {
448                 return data;
449         }
450 }
451
452 static uiTooltipData *ui_tooltip_data_from_button(bContext *C, uiBut *but)
453 {
454         uiStringInfo but_tip = {BUT_GET_TIP, NULL};
455         uiStringInfo enum_label = {BUT_GET_RNAENUM_LABEL, NULL};
456         uiStringInfo enum_tip = {BUT_GET_RNAENUM_TIP, NULL};
457         uiStringInfo op_keymap = {BUT_GET_OP_KEYMAP, NULL};
458         uiStringInfo prop_keymap = {BUT_GET_PROP_KEYMAP, NULL};
459         uiStringInfo rna_struct = {BUT_GET_RNASTRUCT_IDENTIFIER, NULL};
460         uiStringInfo rna_prop = {BUT_GET_RNAPROP_IDENTIFIER, NULL};
461
462         char buf[512];
463
464         /* create tooltip data */
465         uiTooltipData *data = MEM_callocN(sizeof(uiTooltipData), "uiTooltipData");
466
467         UI_but_string_info_get(C, but, &but_tip, &enum_label, &enum_tip, &op_keymap, &prop_keymap, &rna_struct, &rna_prop, NULL);
468
469         /* Tip */
470         if (but_tip.strinfo) {
471                 {
472                         uiTooltipField *field = text_field_add(
473                                 data, &(uiTooltipFormat){
474                                     .style = UI_TIP_STYLE_HEADER,
475                                     .color_id = UI_TIP_LC_NORMAL,
476                                 });
477                         if (enum_label.strinfo) {
478                                 field->text = BLI_sprintfN("%s:  ", but_tip.strinfo);
479                                 field->text_suffix = BLI_strdup(enum_label.strinfo);
480                         }
481                         else {
482                                 field->text = BLI_sprintfN("%s.", but_tip.strinfo);
483                         }
484                 }
485
486                 /* special case enum rna buttons */
487                 if ((but->type & UI_BTYPE_ROW) && but->rnaprop && RNA_property_flag(but->rnaprop) & PROP_ENUM_FLAG) {
488                         uiTooltipField *field = text_field_add(
489                                 data, &(uiTooltipFormat){
490                                     .style = UI_TIP_STYLE_NORMAL,
491                                     .color_id = UI_TIP_LC_NORMAL,
492                                 });
493                         field->text = BLI_strdup(IFACE_("(Shift-Click/Drag to select multiple)"));
494                 }
495
496         }
497         /* Enum field label & tip */
498         if (enum_tip.strinfo) {
499                 uiTooltipField *field = text_field_add(
500                         data, &(uiTooltipFormat){
501                             .style = UI_TIP_STYLE_NORMAL,
502                             .color_id = UI_TIP_LC_VALUE,
503                             .is_pad = true,
504                         });
505                 field->text = BLI_strdup(enum_tip.strinfo);
506         }
507
508         /* Op shortcut */
509         if (op_keymap.strinfo) {
510                 uiTooltipField *field = text_field_add(
511                         data, &(uiTooltipFormat){
512                             .style = UI_TIP_STYLE_NORMAL,
513                             .color_id = UI_TIP_LC_VALUE,
514                             .is_pad = true,
515                         });
516                 field->text = BLI_sprintfN(TIP_("Shortcut: %s"), op_keymap.strinfo);
517         }
518
519         /* Property context-toggle shortcut */
520         if (prop_keymap.strinfo) {
521                 uiTooltipField *field = text_field_add(
522                         data, &(uiTooltipFormat){
523                             .style = UI_TIP_STYLE_NORMAL,
524                             .color_id = UI_TIP_LC_VALUE,
525                             .is_pad = true,
526                         });
527                 field->text = BLI_sprintfN(TIP_("Shortcut: %s"), prop_keymap.strinfo);
528         }
529
530         if (ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU)) {
531                 /* better not show the value of a password */
532                 if ((but->rnaprop && (RNA_property_subtype(but->rnaprop) == PROP_PASSWORD)) == 0) {
533                         /* full string */
534                         ui_but_string_get(but, buf, sizeof(buf));
535                         if (buf[0]) {
536                                 uiTooltipField *field = text_field_add(
537                                         data, &(uiTooltipFormat){
538                                             .style = UI_TIP_STYLE_NORMAL,
539                                             .color_id = UI_TIP_LC_VALUE,
540                                             .is_pad = true,
541                                         });
542                                 field->text = BLI_sprintfN(TIP_("Value: %s"), buf);
543                         }
544                 }
545         }
546
547         if (but->rnaprop) {
548                 int unit_type = UI_but_unit_type_get(but);
549
550                 if (unit_type == PROP_UNIT_ROTATION) {
551                         if (RNA_property_type(but->rnaprop) == PROP_FLOAT) {
552                                 float value = RNA_property_array_check(but->rnaprop) ?
553                                                   RNA_property_float_get_index(&but->rnapoin, but->rnaprop, but->rnaindex) :
554                                                   RNA_property_float_get(&but->rnapoin, but->rnaprop);
555
556                                 uiTooltipField *field = text_field_add(
557                                         data, &(uiTooltipFormat){
558                                             .style = UI_TIP_STYLE_NORMAL,
559                                             .color_id = UI_TIP_LC_VALUE,
560                                         });
561                                 field->text = BLI_sprintfN(TIP_("Radians: %f"), value);
562                         }
563                 }
564
565                 if (but->flag & UI_BUT_DRIVEN) {
566                         if (ui_but_anim_expression_get(but, buf, sizeof(buf))) {
567                                 uiTooltipField *field = text_field_add(
568                                         data, &(uiTooltipFormat){
569                                             .style = UI_TIP_STYLE_NORMAL,
570                                             .color_id = UI_TIP_LC_NORMAL,
571                                         });
572                                 field->text = BLI_sprintfN(TIP_("Expression: %s"), buf);
573                         }
574                 }
575
576                 if (but->rnapoin.id.data) {
577                         const ID *id = but->rnapoin.id.data;
578                         if (ID_IS_LINKED(id)) {
579                                 uiTooltipField *field = text_field_add(
580                                         data, &(uiTooltipFormat){
581                                             .style = UI_TIP_STYLE_NORMAL,
582                                             .color_id = UI_TIP_LC_NORMAL,
583                                         });
584                                 field->text = BLI_sprintfN(TIP_("Library: %s"), id->lib->name);
585                         }
586                 }
587         }
588         else if (but->optype) {
589                 PointerRNA *opptr;
590                 char *str;
591                 opptr = UI_but_operator_ptr_get(but); /* allocated when needed, the button owns it */
592
593                 /* so the context is passed to fieldf functions (some py fieldf functions use it) */
594                 WM_operator_properties_sanitize(opptr, false);
595
596                 str = WM_operator_pystring_ex(C, NULL, false, false, but->optype, opptr);
597
598                 /* avoid overly verbose tips (eg, arrays of 20 layers), exact limit is arbitrary */
599                 WM_operator_pystring_abbreviate(str, 32);
600
601                 /* operator info */
602                 if (U.flag & USER_TOOLTIPS_PYTHON) {
603                         uiTooltipField *field = text_field_add(
604                                 data, &(uiTooltipFormat){
605                                     .style = UI_TIP_STYLE_MONO,
606                                     .color_id = UI_TIP_LC_PYTHON,
607                                     .is_pad = true,
608                                 });
609                         field->text = BLI_sprintfN(TIP_("Python: %s"), str);
610                 }
611
612                 MEM_freeN(str);
613         }
614
615         /* button is disabled, we may be able to tell user why */
616         if (but->flag & UI_BUT_DISABLED) {
617                 const char *disabled_msg = NULL;
618
619                 /* if operator poll check failed, it can give pretty precise info why */
620                 if (but->optype) {
621                         CTX_wm_operator_poll_msg_set(C, NULL);
622                         WM_operator_poll_context(C, but->optype, but->opcontext);
623                         disabled_msg = CTX_wm_operator_poll_msg_get(C);
624                 }
625                 /* alternatively, buttons can store some reasoning too */
626                 else if (but->disabled_info) {
627                         disabled_msg = TIP_(but->disabled_info);
628                 }
629
630                 if (disabled_msg && disabled_msg[0]) {
631                         uiTooltipField *field = text_field_add(
632                                 data, &(uiTooltipFormat){
633                                     .style = UI_TIP_STYLE_NORMAL,
634                                     .color_id = UI_TIP_LC_ALERT,
635                                 });
636                         field->text = BLI_sprintfN(TIP_("Disabled: %s"), disabled_msg);
637                 }
638         }
639
640         if ((U.flag & USER_TOOLTIPS_PYTHON) && !but->optype && rna_struct.strinfo) {
641                 {
642                         uiTooltipField *field = text_field_add(
643                                 data, &(uiTooltipFormat){
644                                     .style = UI_TIP_STYLE_MONO,
645                                     .color_id = UI_TIP_LC_PYTHON,
646                                     .is_pad = true,
647                                 });
648                         if (rna_prop.strinfo) {
649                                 /* Struct and prop */
650                                 field->text = BLI_sprintfN(TIP_("Python: %s.%s"), rna_struct.strinfo, rna_prop.strinfo);
651                         }
652                         else {
653                                 /* Only struct (e.g. menus) */
654                                 field->text = BLI_sprintfN(TIP_("Python: %s"), rna_struct.strinfo);
655                         }
656                 }
657
658                 if (but->rnapoin.id.data) {
659                         uiTooltipField *field = text_field_add(
660                                 data, &(uiTooltipFormat){
661                                     .style = UI_TIP_STYLE_MONO,
662                                     .color_id = UI_TIP_LC_PYTHON,
663                                 });
664
665                         /* this could get its own 'BUT_GET_...' type */
666
667                         /* never fails */
668                         /* move ownership (no need for re-alloc) */
669                         if (but->rnaprop) {
670                                 field->text = RNA_path_full_property_py_ex(&but->rnapoin, but->rnaprop, but->rnaindex, true);
671                         }
672                         else {
673                                 field->text = RNA_path_full_struct_py(&but->rnapoin);
674                         }
675
676                 }
677         }
678
679         /* Free strinfo's... */
680         if (but_tip.strinfo)
681                 MEM_freeN(but_tip.strinfo);
682         if (enum_label.strinfo)
683                 MEM_freeN(enum_label.strinfo);
684         if (enum_tip.strinfo)
685                 MEM_freeN(enum_tip.strinfo);
686         if (op_keymap.strinfo)
687                 MEM_freeN(op_keymap.strinfo);
688         if (prop_keymap.strinfo)
689                 MEM_freeN(prop_keymap.strinfo);
690         if (rna_struct.strinfo)
691                 MEM_freeN(rna_struct.strinfo);
692         if (rna_prop.strinfo)
693                 MEM_freeN(rna_prop.strinfo);
694
695         if (data->fields_len == 0) {
696                 MEM_freeN(data);
697                 return NULL;
698         }
699         else {
700                 return data;
701         }
702 }
703
704 static uiTooltipData *ui_tooltip_data_from_gizmo(bContext *C, wmGizmo *gz)
705 {
706         uiTooltipData *data = MEM_callocN(sizeof(uiTooltipData), "uiTooltipData");
707
708         /* TODO(campbell): a way for gizmos to have their own descriptions (low priority). */
709
710         /* Operator Actions */
711         {
712                 bool use_drag = gz->drag_part != -1 && gz->highlight_part != gz->drag_part;
713
714                 const struct {
715                         int part;
716                         const char *prefix;
717                 } mpop_actions[] = {
718                         {
719                                 .part = gz->highlight_part,
720                                 .prefix = use_drag ? TIP_("Click") : NULL,
721                         }, {
722                                 .part = use_drag ? gz->drag_part : -1,
723                                 .prefix = use_drag ? TIP_("Drag") : NULL,
724                         },
725                 };
726
727                 for (int i = 0; i < ARRAY_SIZE(mpop_actions); i++) {
728                         wmGizmoOpElem *mpop = (mpop_actions[i].part != -1) ? WM_gizmo_operator_get(gz, mpop_actions[i].part) : NULL;
729                         if (mpop != NULL) {
730                                 /* Description */
731                                 const char *info = RNA_struct_ui_description(mpop->type->srna);
732                                 if (!(info && info[0])) {
733                                         info  = RNA_struct_ui_name(mpop->type->srna);
734                                 }
735
736                                 if (info && info[0]) {
737                                         char *text = NULL;
738                                         if (mpop_actions[i].prefix != NULL) {
739                                                 text = BLI_sprintfN("%s: %s", mpop_actions[i].prefix, info);
740                                         }
741                                         else {
742                                                 text = BLI_strdup(info);
743                                         }
744
745                                         if (text != NULL) {
746                                                 uiTooltipField *field = text_field_add(
747                                                         data, &(uiTooltipFormat){
748                                                             .style = UI_TIP_STYLE_HEADER,
749                                                             .color_id = UI_TIP_LC_VALUE,
750                                                             .is_pad = true,
751                                                         });
752                                                 field->text = text;
753                                         }
754                                 }
755
756                                 /* Shortcut */
757                                 {
758                                         bool found = false;
759                                         IDProperty *prop = mpop->ptr.data;
760                                         char buf[128];
761                                         if (WM_key_event_operator_string(
762                                                     C, mpop->type->idname, WM_OP_INVOKE_DEFAULT, prop, true,
763                                                     buf, ARRAY_SIZE(buf)))
764                                         {
765                                                 found = true;
766                                         }
767                                         uiTooltipField *field = text_field_add(
768                                                 data, &(uiTooltipFormat){
769                                                     .style = UI_TIP_STYLE_NORMAL,
770                                                     .color_id = UI_TIP_LC_VALUE,
771                                                     .is_pad = true,
772                                                 });
773                                         field->text = BLI_sprintfN(TIP_("Shortcut: %s"), found ? buf : "None");
774                                 }
775                         }
776                 }
777         }
778
779         /* Property Actions */
780         if (gz->type->target_property_defs_len) {
781                 wmGizmoProperty *gz_prop_array = WM_gizmo_target_property_array(gz);
782                 for (int i = 0; i < gz->type->target_property_defs_len; i++) {
783                         /* TODO(campbell): function callback descriptions. */
784                         wmGizmoProperty *gz_prop = &gz_prop_array[i];
785                         if (gz_prop->prop != NULL) {
786                                 const char *info = RNA_property_ui_description(gz_prop->prop);
787                                 if (info && info[0]) {
788                                         uiTooltipField *field = text_field_add(
789                                                 data, &(uiTooltipFormat){
790                                                     .style = UI_TIP_STYLE_NORMAL,
791                                                     .color_id = UI_TIP_LC_VALUE,
792                                                     .is_pad = true,
793                                                 });
794                                         field->text = BLI_strdup(info);
795                                 }
796                         }
797                 }
798         }
799
800         if (data->fields_len == 0) {
801                 MEM_freeN(data);
802                 return NULL;
803         }
804         else {
805                 return data;
806         }
807 }
808
809
810 static ARegion *ui_tooltip_create_with_data(
811         bContext *C, uiTooltipData *data,
812         const float init_position[2],
813         const float aspect)
814 {
815         const float pad_px = UI_TIP_PADDING;
816         wmWindow *win = CTX_wm_window(C);
817         const int winx = WM_window_pixels_x(win);
818         uiStyle *style = UI_style_get();
819         static ARegionType type;
820         ARegion *ar;
821         int fonth, fontw;
822         int h, i;
823         rctf rect_fl;
824         rcti rect_i;
825         int font_flag = 0;
826
827         /* create area region */
828         ar = ui_region_temp_add(CTX_wm_screen(C));
829
830         memset(&type, 0, sizeof(ARegionType));
831         type.draw = ui_tooltip_region_draw_cb;
832         type.free = ui_tooltip_region_free_cb;
833         type.regionid = RGN_TYPE_TEMPORARY;
834         ar->type = &type;
835
836         /* set font, get bb */
837         data->fstyle = style->widget; /* copy struct */
838         ui_fontscale(&data->fstyle.points, aspect);
839
840         UI_fontstyle_set(&data->fstyle);
841
842         data->wrap_width = min_ii(UI_TIP_MAXWIDTH * U.pixelsize / aspect, winx - (UI_TIP_PADDING * 2));
843
844         font_flag |= BLF_WORD_WRAP;
845         if (data->fstyle.kerning == 1) {
846                 font_flag |= BLF_KERNING_DEFAULT;
847         }
848         BLF_enable(data->fstyle.uifont_id, font_flag);
849         BLF_enable(blf_mono_font, font_flag);
850         BLF_wordwrap(data->fstyle.uifont_id, data->wrap_width);
851         BLF_wordwrap(blf_mono_font, data->wrap_width);
852
853         /* these defines tweaked depending on font */
854 #define TIP_BORDER_X (16.0f / aspect)
855 #define TIP_BORDER_Y (6.0f / aspect)
856
857         h = BLF_height_max(data->fstyle.uifont_id);
858
859         for (i = 0, fontw = 0, fonth = 0; i < data->fields_len; i++) {
860                 uiTooltipField *field = &data->fields[i];
861                 uiTooltipField *field_next = (i + 1) != data->fields_len ? &data->fields[i + 1] : NULL;
862
863                 struct ResultBLF info;
864                 int w, x_pos = 0;
865                 int font_id;
866
867                 if (field->format.style == UI_TIP_STYLE_MONO) {
868                         BLF_size(blf_mono_font, data->fstyle.points * U.pixelsize, U.dpi);
869                         font_id = blf_mono_font;
870                 }
871                 else {
872                         BLI_assert(ELEM(field->format.style, UI_TIP_STYLE_NORMAL, UI_TIP_STYLE_HEADER));
873                         font_id = data->fstyle.uifont_id;
874                 }
875                 w = BLF_width_ex(font_id, field->text, BLF_DRAW_STR_DUMMY_MAX, &info);
876
877                 /* check for suffix (enum label) */
878                 if (field->text_suffix && field->text_suffix[0]) {
879                         x_pos = info.width;
880                         w = max_ii(w, x_pos + BLF_width(font_id, field->text_suffix, BLF_DRAW_STR_DUMMY_MAX));
881                 }
882                 fontw = max_ii(fontw, w);
883
884                 fonth += h * info.lines;
885                 if (field_next && field_next->format.is_pad) {
886                         fonth += h * (UI_TIP_PAD_FAC - 1);
887                 }
888
889                 field->geom.lines = info.lines;
890                 field->geom.x_pos = x_pos;
891         }
892
893         //fontw *= aspect;
894
895         BLF_disable(data->fstyle.uifont_id, font_flag);
896         BLF_disable(blf_mono_font, font_flag);
897
898         ar->regiondata = data;
899
900         data->toth = fonth;
901         data->lineh = h;
902
903         /* compute position */
904
905         rect_fl.xmin = init_position[0] - TIP_BORDER_X;
906         rect_fl.xmax = rect_fl.xmin + fontw + pad_px;
907         rect_fl.ymax = init_position[1] - TIP_BORDER_Y;
908         rect_fl.ymin = rect_fl.ymax - fonth  - TIP_BORDER_Y;
909
910         BLI_rcti_rctf_copy(&rect_i, &rect_fl);
911
912 #undef TIP_BORDER_X
913 #undef TIP_BORDER_Y
914
915         /* clip with window boundaries */
916         if (rect_i.xmax > winx) {
917                 /* super size */
918                 if (rect_i.xmax > winx + rect_i.xmin) {
919                         rect_i.xmax = winx;
920                         rect_i.xmin = 0;
921                 }
922                 else {
923                         rect_i.xmin -= rect_i.xmax - winx;
924                         rect_i.xmax = winx;
925                 }
926         }
927         /* ensure at least 5 px above screen bounds
928          * 25 is just a guess to be above the menu item */
929         if (rect_i.ymin < 5) {
930                 rect_i.ymax += (-rect_i.ymin) + 30;
931                 rect_i.ymin = 30;
932         }
933
934         /* add padding */
935         BLI_rcti_resize(&rect_i,
936                         BLI_rcti_size_x(&rect_i) + pad_px,
937                         BLI_rcti_size_y(&rect_i) + pad_px);
938
939         /* widget rect, in region coords */
940         {
941                 const int margin = UI_POPUP_MARGIN;
942
943                 data->bbox.xmin = margin;
944                 data->bbox.xmax = BLI_rcti_size_x(&rect_i) - margin;
945                 data->bbox.ymin = margin;
946                 data->bbox.ymax = BLI_rcti_size_y(&rect_i);
947
948                 /* region bigger for shadow */
949                 ar->winrct.xmin = rect_i.xmin - margin;
950                 ar->winrct.xmax = rect_i.xmax + margin;
951                 ar->winrct.ymin = rect_i.ymin - margin;
952                 ar->winrct.ymax = rect_i.ymax + margin;
953         }
954
955         /* adds subwindow */
956         ED_region_init(ar);
957
958         /* notify change and redraw */
959         ED_region_tag_redraw(ar);
960
961         return ar;
962 }
963
964 /** \} */
965
966 /* -------------------------------------------------------------------- */
967 /** \name ToolTip Public API
968  * \{ */
969
970
971 ARegion *UI_tooltip_create_from_button(bContext *C, ARegion *butregion, uiBut *but)
972 {
973         wmWindow *win = CTX_wm_window(C);
974         /* aspect values that shrink text are likely unreadable */
975         const float aspect = min_ff(1.0f, but->block->aspect);
976         float init_position[2];
977
978         if (but->drawflag & UI_BUT_NO_TOOLTIP) {
979                 return NULL;
980         }
981         uiTooltipData *data = NULL;
982
983         if (data == NULL) {
984                 data = ui_tooltip_data_from_tool(C, but);
985         }
986
987         if (data == NULL) {
988                 data = ui_tooltip_data_from_button(C, but);
989         }
990
991         if (data == NULL) {
992                 return NULL;
993         }
994
995         init_position[0] = BLI_rctf_cent_x(&but->rect);
996         init_position[1] = but->rect.ymin;
997
998         if (butregion) {
999                 ui_block_to_window_fl(butregion, but->block, &init_position[0], &init_position[1]);
1000                 init_position[0] = win->eventstate->x;
1001         }
1002
1003         return ui_tooltip_create_with_data(C, data, init_position, aspect);
1004 }
1005
1006 ARegion *UI_tooltip_create_from_gizmo(bContext *C, wmGizmo *gz)
1007 {
1008         wmWindow *win = CTX_wm_window(C);
1009         const float aspect = 1.0f;
1010         float init_position[2];
1011
1012         uiTooltipData *data = ui_tooltip_data_from_gizmo(C, gz);
1013         if (data == NULL) {
1014                 return NULL;
1015         }
1016
1017         init_position[0] = win->eventstate->x;
1018         init_position[1] = win->eventstate->y;
1019
1020         return ui_tooltip_create_with_data(C, data, init_position, aspect);
1021 }
1022
1023 void UI_tooltip_free(bContext *C, bScreen *sc, ARegion *ar)
1024 {
1025         ui_region_temp_remove(C, sc, ar);
1026 }
1027
1028 /** \} */