Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / interface / interface_style.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) 2009 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_style.c
27  *  \ingroup edinterface
28  */
29
30
31 #include <limits.h>
32 #include <math.h>
33 #include <stdlib.h>
34 #include <string.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "DNA_screen_types.h"
39 #include "DNA_userdef_types.h"
40
41 #include "BLI_listbase.h"
42 #include "BLI_rect.h"
43 #include "BLI_string.h"
44 #include "BLI_utildefines.h"
45
46 #include "BKE_global.h"
47
48 #include "BIF_gl.h"
49
50 #include "BLF_api.h"
51 #ifdef WITH_INTERNATIONAL
52 #  include "BLT_translation.h"
53 #endif
54
55 #include "UI_interface.h"
56
57 #include "ED_datafiles.h"
58
59 #include "interface_intern.h"
60
61 #ifdef WIN32
62 #  include "BLI_math_base.h" /* M_PI */
63 #endif
64
65 /* style + theme + layout-engine = UI */
66
67 /**
68  * This is a complete set of layout rules, the 'state' of the Layout
69  * Engine. Multiple styles are possible, defined via C or Python. Styles
70  * get a name, and will typically get activated per region type, like
71  * "Header", or "Listview" or "Toolbar". Properties of Style definitions
72  * are:
73  *
74  * - default column properties, internal spacing, aligning, min/max width
75  * - button alignment rules (for groups)
76  * - label placement rules
77  * - internal labeling or external labeling default
78  * - default minimum widths for buttons/labels (in amount of characters)
79  * - font types, styles and relative sizes for Panel titles, labels, etc.
80  */
81
82
83 /* ********************************************** */
84
85 static uiStyle *ui_style_new(ListBase *styles, const char *name, short uifont_id)
86 {
87         uiStyle *style = MEM_callocN(sizeof(uiStyle), "new style");
88
89         BLI_addtail(styles, style);
90         BLI_strncpy(style->name, name, MAX_STYLE_NAME);
91
92         style->panelzoom = 1.0; /* unused */
93
94         style->paneltitle.uifont_id = uifont_id;
95         style->paneltitle.points = 12;
96         style->paneltitle.kerning = 1;
97         style->paneltitle.shadow = 1;
98         style->paneltitle.shadx = 0;
99         style->paneltitle.shady = -1;
100         style->paneltitle.shadowalpha = 0.15f;
101         style->paneltitle.shadowcolor = 1.0f;
102
103         style->grouplabel.uifont_id = uifont_id;
104         style->grouplabel.points = 12;
105         style->grouplabel.kerning = 1;
106         style->grouplabel.shadow = 3;
107         style->grouplabel.shadx = 0;
108         style->grouplabel.shady = -1;
109         style->grouplabel.shadowalpha = 0.25f;
110
111         style->widgetlabel.uifont_id = uifont_id;
112         style->widgetlabel.points = 11;
113         style->widgetlabel.kerning = 1;
114         style->widgetlabel.shadow = 3;
115         style->widgetlabel.shadx = 0;
116         style->widgetlabel.shady = -1;
117         style->widgetlabel.shadowalpha = 0.15f;
118         style->widgetlabel.shadowcolor = 1.0f;
119
120         style->widget.uifont_id = uifont_id;
121         style->widget.points = 11;
122         style->widget.kerning = 1;
123         style->widget.shadowalpha = 0.25f;
124
125         style->columnspace = 8;
126         style->templatespace = 5;
127         style->boxspace = 5;
128         style->buttonspacex = 8;
129         style->buttonspacey = 2;
130         style->panelspace = 8;
131         style->panelouter = 4;
132
133         return style;
134 }
135
136 static uiFont *uifont_to_blfont(int id)
137 {
138         uiFont *font = U.uifonts.first;
139
140         for (; font; font = font->next) {
141                 if (font->uifont_id == id) {
142                         return font;
143                 }
144         }
145         return U.uifonts.first;
146 }
147
148 /* *************** draw ************************ */
149
150
151 void UI_fontstyle_draw_ex(
152         const uiFontStyle *fs, const rcti *rect, const char *str, const unsigned char col[4],
153         size_t len, float *r_xofs, float *r_yofs)
154 {
155         int xofs = 0, yofs;
156         int font_flag = BLF_CLIPPING;
157
158         UI_fontstyle_set(fs);
159
160         /* set the flag */
161         if (fs->shadow) {
162                 font_flag |= BLF_SHADOW;
163                 const float shadow_color[4] = {fs->shadowcolor, fs->shadowcolor, fs->shadowcolor, fs->shadowalpha};
164                 BLF_shadow(fs->uifont_id, fs->shadow, shadow_color);
165                 BLF_shadow_offset(fs->uifont_id, fs->shadx, fs->shady);
166         }
167         if (fs->kerning == 1) {
168                 font_flag |= BLF_KERNING_DEFAULT;
169         }
170         if (fs->word_wrap == 1) {
171                 font_flag |= BLF_WORD_WRAP;
172         }
173
174         BLF_enable(fs->uifont_id, font_flag);
175
176         if (fs->word_wrap == 1) {
177                 /* draw from boundbox top */
178                 yofs = BLI_rcti_size_y(rect) - BLF_height_max(fs->uifont_id);
179         }
180         else {
181                 /* draw from boundbox center */
182                 yofs = ceil(0.5f * (BLI_rcti_size_y(rect) - BLF_ascender(fs->uifont_id)));
183         }
184
185         if (fs->align == UI_STYLE_TEXT_CENTER) {
186                 xofs = floor(0.5f * (BLI_rcti_size_x(rect) - BLF_width(fs->uifont_id, str, len)));
187                 /* don't center text if it chops off the start of the text, 2 gives some margin */
188                 if (xofs < 2) {
189                         xofs = 2;
190                 }
191         }
192         else if (fs->align == UI_STYLE_TEXT_RIGHT) {
193                 xofs = BLI_rcti_size_x(rect) - BLF_width(fs->uifont_id, str, len) - 0.1f * U.widget_unit;
194         }
195
196         /* clip is very strict, so we give it some space */
197         BLF_clipping(fs->uifont_id, rect->xmin - 2, rect->ymin - 4, rect->xmax + 1, rect->ymax + 4);
198         BLF_position(fs->uifont_id, rect->xmin + xofs, rect->ymin + yofs, 0.0f);
199         BLF_color4ubv(fs->uifont_id, col);
200
201         BLF_draw(fs->uifont_id, str, len);
202
203         BLF_disable(fs->uifont_id, font_flag);
204
205         *r_xofs = xofs;
206         *r_yofs = yofs;
207 }
208
209 void UI_fontstyle_draw(const uiFontStyle *fs, const rcti *rect, const char *str, const unsigned char col[4])
210 {
211         float xofs, yofs;
212
213         UI_fontstyle_draw_ex(
214                 fs, rect, str, col,
215                 BLF_DRAW_STR_DUMMY_MAX, &xofs, &yofs);
216 }
217
218 /* drawn same as above, but at 90 degree angle */
219 void UI_fontstyle_draw_rotated(const uiFontStyle *fs, const rcti *rect, const char *str, const unsigned char col[4])
220 {
221         float height;
222         int xofs, yofs;
223         float angle;
224         rcti txtrect;
225
226         UI_fontstyle_set(fs);
227
228         height = BLF_ascender(fs->uifont_id);
229         /* becomes x-offset when rotated */
230         xofs = ceil(0.5f * (BLI_rcti_size_y(rect) - height));
231
232         /* ignore UI_STYLE, always aligned to top */
233
234         /* rotate counter-clockwise for now (assumes left-to-right language)*/
235         xofs += height;
236         yofs = BLF_width(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX) + 5;
237         angle = M_PI_2;
238
239         /* translate rect to vertical */
240         txtrect.xmin = rect->xmin - BLI_rcti_size_y(rect);
241         txtrect.ymin = rect->ymin - BLI_rcti_size_x(rect);
242         txtrect.xmax = rect->xmin;
243         txtrect.ymax = rect->ymin;
244
245         /* clip is very strict, so we give it some space */
246         /* clipping is done without rotation, so make rect big enough to contain both positions */
247         BLF_clipping(fs->uifont_id, txtrect.xmin - 1, txtrect.ymin - yofs - xofs - 4, rect->xmax + 1, rect->ymax + 4);
248         BLF_enable(fs->uifont_id, BLF_CLIPPING);
249         BLF_position(fs->uifont_id, txtrect.xmin + xofs, txtrect.ymax - yofs, 0.0f);
250
251         BLF_enable(fs->uifont_id, BLF_ROTATION);
252         BLF_rotation(fs->uifont_id, angle);
253         BLF_color4ubv(fs->uifont_id, col);
254
255         if (fs->shadow) {
256                 BLF_enable(fs->uifont_id, BLF_SHADOW);
257                 const float shadow_color[4] = {fs->shadowcolor, fs->shadowcolor, fs->shadowcolor, fs->shadowalpha};
258                 BLF_shadow(fs->uifont_id, fs->shadow, shadow_color);
259                 BLF_shadow_offset(fs->uifont_id, fs->shadx, fs->shady);
260         }
261
262         if (fs->kerning == 1)
263                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
264
265         BLF_draw(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
266         BLF_disable(fs->uifont_id, BLF_ROTATION);
267         BLF_disable(fs->uifont_id, BLF_CLIPPING);
268         if (fs->shadow)
269                 BLF_disable(fs->uifont_id, BLF_SHADOW);
270         if (fs->kerning == 1)
271                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
272 }
273
274 /**
275  * Similar to #UI_fontstyle_draw
276  * but ignore alignment, shadow & no clipping rect.
277  *
278  * For drawing on-screen labels.
279  */
280 void UI_fontstyle_draw_simple(const uiFontStyle *fs, float x, float y, const char *str, const unsigned char col[4])
281 {
282         if (fs->kerning == 1)
283                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
284
285         UI_fontstyle_set(fs);
286         BLF_position(fs->uifont_id, x, y, 0.0f);
287         BLF_color4ubv(fs->uifont_id, col);
288         BLF_draw(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
289
290         if (fs->kerning == 1)
291                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
292 }
293
294 /**
295  * Same as #UI_fontstyle_draw but draw a colored backdrop.
296  */
297 void UI_fontstyle_draw_simple_backdrop(
298         const uiFontStyle *fs, float x, float y, const char *str,
299         const float col_fg[4], const float col_bg[4])
300 {
301         if (fs->kerning == 1)
302                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
303
304         UI_fontstyle_set(fs);
305
306         {
307                 const float width = BLF_width(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
308                 const float height = BLF_height_max(fs->uifont_id);
309                 const float decent = BLF_descender(fs->uifont_id);
310                 const float margin = height / 4.0f;
311
312                 /* backdrop */
313                 float color[4] = { col_bg[0], col_bg[1], col_bg[2], 0.5f };
314
315                 UI_draw_roundbox_corner_set(UI_CNR_ALL);
316                 UI_draw_roundbox_aa(true,
317                         x - margin,
318                         (y + decent) - margin,
319                         x + width + margin,
320                         (y + decent) + height + margin,
321                         margin, color);
322         }
323
324         BLF_position(fs->uifont_id, x, y, 0.0f);
325         BLF_color4fv(fs->uifont_id, col_fg);
326         BLF_draw(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
327
328         if (fs->kerning == 1)
329                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
330 }
331
332
333 /* ************** helpers ************************ */
334 /* XXX: read a style configure */
335 uiStyle *UI_style_get(void)
336 {
337 #if 0
338         uiStyle *style = NULL;
339         /* offset is two struct uiStyle pointers */
340         style = BLI_findstring(&U.uistyles, "Unifont Style", sizeof(style) * 2);
341         return (style != NULL) ? style : U.uistyles.first;
342 #else
343         return U.uistyles.first;
344 #endif
345 }
346
347 /* for drawing, scaled with DPI setting */
348 uiStyle *UI_style_get_dpi(void)
349 {
350         uiStyle *style = UI_style_get();
351         static uiStyle _style;
352
353         _style = *style;
354
355         _style.paneltitle.shadx = (short)(UI_DPI_FAC * _style.paneltitle.shadx);
356         _style.paneltitle.shady = (short)(UI_DPI_FAC * _style.paneltitle.shady);
357         _style.grouplabel.shadx = (short)(UI_DPI_FAC * _style.grouplabel.shadx);
358         _style.grouplabel.shady = (short)(UI_DPI_FAC * _style.grouplabel.shady);
359         _style.widgetlabel.shadx = (short)(UI_DPI_FAC * _style.widgetlabel.shadx);
360         _style.widgetlabel.shady = (short)(UI_DPI_FAC * _style.widgetlabel.shady);
361
362         _style.columnspace = (short)(UI_DPI_FAC * _style.columnspace);
363         _style.templatespace = (short)(UI_DPI_FAC * _style.templatespace);
364         _style.boxspace = (short)(UI_DPI_FAC * _style.boxspace);
365         _style.buttonspacex = (short)(UI_DPI_FAC * _style.buttonspacex);
366         _style.buttonspacey = (short)(UI_DPI_FAC * _style.buttonspacey);
367         _style.panelspace = (short)(UI_DPI_FAC * _style.panelspace);
368         _style.panelouter = (short)(UI_DPI_FAC * _style.panelouter);
369
370         return &_style;
371 }
372
373 int UI_fontstyle_string_width(const uiFontStyle *fs, const char *str)
374 {
375         int width;
376
377         if (fs->kerning == 1) /* for BLF_width */
378                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
379
380         UI_fontstyle_set(fs);
381         width = BLF_width(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
382
383         if (fs->kerning == 1)
384                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
385
386         return width;
387 }
388
389 int UI_fontstyle_height_max(const uiFontStyle *fs)
390 {
391         UI_fontstyle_set(fs);
392         return BLF_height_max(fs->uifont_id);
393 }
394
395
396 /* ************** init exit ************************ */
397
398 /* called on each startup.blend read */
399 /* reading without uifont will create one */
400 void uiStyleInit(void)
401 {
402         uiFont *font;
403         uiStyle *style = U.uistyles.first;
404         int monofont_size = datatoc_bmonofont_ttf_size;
405         unsigned char *monofont_ttf = (unsigned char *)datatoc_bmonofont_ttf;
406
407         /* recover from uninitialized dpi */
408         if (U.dpi == 0)
409                 U.dpi = 72;
410         CLAMP(U.dpi, 48, 144);
411
412         for (font = U.uifonts.first; font; font = font->next) {
413                 BLF_unload_id(font->blf_id);
414         }
415
416         if (blf_mono_font != -1) {
417                 BLF_unload_id(blf_mono_font);
418                 blf_mono_font = -1;
419         }
420
421         if (blf_mono_font_render != -1) {
422                 BLF_unload_id(blf_mono_font_render);
423                 blf_mono_font_render = -1;
424         }
425
426         font = U.uifonts.first;
427
428         /* default builtin */
429         if (font == NULL) {
430                 font = MEM_callocN(sizeof(uiFont), "ui font");
431                 BLI_addtail(&U.uifonts, font);
432         }
433
434         if (U.font_path_ui[0]) {
435                 BLI_strncpy(font->filename, U.font_path_ui, sizeof(font->filename));
436                 font->uifont_id = UIFONT_CUSTOM1;
437         }
438         else {
439                 BLI_strncpy(font->filename, "default", sizeof(font->filename));
440                 font->uifont_id = UIFONT_DEFAULT;
441         }
442
443         for (font = U.uifonts.first; font; font = font->next) {
444
445                 if (font->uifont_id == UIFONT_DEFAULT) {
446 #ifdef WITH_INTERNATIONAL
447                         int font_size = datatoc_bfont_ttf_size;
448                         unsigned char *font_ttf = (unsigned char *)datatoc_bfont_ttf;
449                         static int last_font_size = 0;
450
451                         /* use unicode font for translation */
452                         if (U.transopts & USER_DOTRANSLATE) {
453                                 font_ttf = BLF_get_unifont(&font_size);
454
455                                 if (!font_ttf) {
456                                         /* fall back if not found */
457                                         font_size = datatoc_bfont_ttf_size;
458                                         font_ttf = (unsigned char *)datatoc_bfont_ttf;
459                                 }
460                         }
461
462                         /* relload only if needed */
463                         if (last_font_size != font_size) {
464                                 BLF_unload("default");
465                                 last_font_size = font_size;
466                         }
467
468                         font->blf_id = BLF_load_mem("default", font_ttf, font_size);
469 #else
470                         font->blf_id = BLF_load_mem("default", (unsigned char *)datatoc_bfont_ttf, datatoc_bfont_ttf_size);
471 #endif
472                 }
473                 else {
474                         font->blf_id = BLF_load(font->filename);
475                         if (font->blf_id == -1) {
476                                 font->blf_id = BLF_load_mem("default", (unsigned char *)datatoc_bfont_ttf, datatoc_bfont_ttf_size);
477                         }
478                 }
479
480                 BLF_default_set(font->blf_id);
481
482                 if (font->blf_id == -1) {
483                         if (G.debug & G_DEBUG)
484                                 printf("%s: error, no fonts available\n", __func__);
485                 }
486                 else {
487                         /* ? just for speed to initialize?
488                          * Yes, this build the glyph cache and create
489                          * the texture.
490                          */
491                         BLF_size(font->blf_id, 11 * U.pixelsize, U.dpi);
492                         BLF_size(font->blf_id, 12 * U.pixelsize, U.dpi);
493                         BLF_size(font->blf_id, 14 * U.pixelsize, U.dpi);
494                 }
495         }
496
497         if (style == NULL) {
498                 ui_style_new(&U.uistyles, "Default Style", UIFONT_DEFAULT);
499         }
500
501 #ifdef WITH_INTERNATIONAL
502         /* use unicode font for text editor and interactive console */
503         if (U.transopts & USER_DOTRANSLATE) {
504                 monofont_ttf = BLF_get_unifont_mono(&monofont_size);
505
506                 if (!monofont_ttf) {
507                         /* fall back if not found */
508                         monofont_size = datatoc_bmonofont_ttf_size;
509                         monofont_ttf = (unsigned char *)datatoc_bmonofont_ttf;
510                 }
511         }
512 #endif
513
514         /* XXX, this should be moved into a style, but for now best only load the monospaced font once. */
515         BLI_assert(blf_mono_font == -1);
516         if (U.font_path_ui_mono[0]) {
517                 blf_mono_font = BLF_load_unique(U.font_path_ui_mono);
518         }
519         if (blf_mono_font == -1) {
520                 blf_mono_font = BLF_load_mem_unique("monospace", monofont_ttf, monofont_size);
521         }
522
523         BLF_size(blf_mono_font, 12 * U.pixelsize, 72);
524
525         /* Set default flags based on UI preferences (not render fonts) */
526         {
527                 int flag_disable = BLF_MONOCHROME |
528                                    BLF_HINTING_NONE |
529                                    BLF_HINTING_SLIGHT |
530                                    BLF_HINTING_FULL;
531                 int flag_enable = 0;
532
533                 if (U.text_render & USER_TEXT_HINTING_NONE) {
534                         flag_enable |= BLF_HINTING_NONE;
535                 }
536                 else if (U.text_render & USER_TEXT_HINTING_SLIGHT) {
537                         flag_enable |= BLF_HINTING_SLIGHT;
538                 }
539                 else if (U.text_render & USER_TEXT_HINTING_FULL) {
540                         flag_enable |= BLF_HINTING_FULL;
541                 }
542
543                 if (U.text_render & USER_TEXT_DISABLE_AA) {
544                         flag_enable |= BLF_MONOCHROME;
545                 }
546
547                 for (font = U.uifonts.first; font; font = font->next) {
548                         if (font->blf_id != -1) {
549                                 BLF_disable(font->blf_id, flag_disable);
550                                 BLF_enable(font->blf_id, flag_enable);
551                         }
552                 }
553                 if (blf_mono_font != -1) {
554                         BLF_disable(blf_mono_font, flag_disable);
555                         BLF_enable(blf_mono_font, flag_enable);
556                 }
557         }
558
559         /**
560          * Second for rendering else we get threading problems,
561          *
562          * \note This isn't good that the render font depends on the preferences,
563          * keep for now though, since without this there is no way to display many unicode chars.
564          */
565         if (blf_mono_font_render == -1)
566                 blf_mono_font_render = BLF_load_mem_unique("monospace", monofont_ttf, monofont_size);
567
568         BLF_size(blf_mono_font_render, 12 * U.pixelsize, 72);
569 }
570
571 void UI_fontstyle_set(const uiFontStyle *fs)
572 {
573         uiFont *font = uifont_to_blfont(fs->uifont_id);
574
575         BLF_size(font->blf_id, fs->points * U.pixelsize, U.dpi);
576 }