UI: disable new text hinting from D3201 by default for now.
[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,
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
200         BLF_draw(fs->uifont_id, str, len);
201
202         BLF_disable(fs->uifont_id, font_flag);
203
204         *r_xofs = xofs;
205         *r_yofs = yofs;
206 }
207
208 void UI_fontstyle_draw(const uiFontStyle *fs, const rcti *rect, const char *str)
209 {
210         float xofs, yofs;
211
212         UI_fontstyle_draw_ex(
213                 fs, rect, str,
214                 BLF_DRAW_STR_DUMMY_MAX, &xofs, &yofs);
215 }
216
217 /* drawn same as above, but at 90 degree angle */
218 void UI_fontstyle_draw_rotated(const uiFontStyle *fs, const rcti *rect, const char *str)
219 {
220         float height;
221         int xofs, yofs;
222         float angle;
223         rcti txtrect;
224
225         UI_fontstyle_set(fs);
226
227         height = BLF_ascender(fs->uifont_id);
228         /* becomes x-offset when rotated */
229         xofs = ceil(0.5f * (BLI_rcti_size_y(rect) - height));
230
231         /* ignore UI_STYLE, always aligned to top */
232
233         /* rotate counter-clockwise for now (assumes left-to-right language)*/
234         xofs += height;
235         yofs = BLF_width(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX) + 5;
236         angle = M_PI_2;
237
238         /* translate rect to vertical */
239         txtrect.xmin = rect->xmin - BLI_rcti_size_y(rect);
240         txtrect.ymin = rect->ymin - BLI_rcti_size_x(rect);
241         txtrect.xmax = rect->xmin;
242         txtrect.ymax = rect->ymin;
243
244         /* clip is very strict, so we give it some space */
245         /* clipping is done without rotation, so make rect big enough to contain both positions */
246         BLF_clipping(fs->uifont_id, txtrect.xmin - 1, txtrect.ymin - yofs - xofs - 4, rect->xmax + 1, rect->ymax + 4);
247         BLF_enable(fs->uifont_id, BLF_CLIPPING);
248         BLF_position(fs->uifont_id, txtrect.xmin + xofs, txtrect.ymax - yofs, 0.0f);
249
250         BLF_enable(fs->uifont_id, BLF_ROTATION);
251         BLF_rotation(fs->uifont_id, angle);
252
253         if (fs->shadow) {
254                 BLF_enable(fs->uifont_id, BLF_SHADOW);
255                 const float shadow_color[4] = {fs->shadowcolor, fs->shadowcolor, fs->shadowcolor, fs->shadowalpha};
256                 BLF_shadow(fs->uifont_id, fs->shadow, shadow_color);
257                 BLF_shadow_offset(fs->uifont_id, fs->shadx, fs->shady);
258         }
259
260         if (fs->kerning == 1)
261                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
262
263         BLF_draw(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
264         BLF_disable(fs->uifont_id, BLF_ROTATION);
265         BLF_disable(fs->uifont_id, BLF_CLIPPING);
266         if (fs->shadow)
267                 BLF_disable(fs->uifont_id, BLF_SHADOW);
268         if (fs->kerning == 1)
269                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
270 }
271
272 /**
273  * Similar to #UI_fontstyle_draw
274  * but ignore alignment, shadow & no clipping rect.
275  *
276  * For drawing on-screen labels.
277  */
278 void UI_fontstyle_draw_simple(const uiFontStyle *fs, float x, float y, const char *str)
279 {
280         if (fs->kerning == 1)
281                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
282
283         UI_fontstyle_set(fs);
284         BLF_position(fs->uifont_id, x, y, 0.0f);
285         BLF_draw(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
286
287         if (fs->kerning == 1)
288                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
289 }
290
291 /**
292  * Same as #UI_fontstyle_draw but draw a colored backdrop.
293  */
294 void UI_fontstyle_draw_simple_backdrop(
295         const uiFontStyle *fs, float x, float y, const char *str,
296         const unsigned char fg[4], const unsigned char bg[4])
297 {
298         if (fs->kerning == 1)
299                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
300
301         UI_fontstyle_set(fs);
302
303         {
304                 const float width = BLF_width(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
305                 const float height = BLF_height_max(fs->uifont_id);
306                 const float decent = BLF_descender(fs->uifont_id);
307                 const float margin = height / 4.0f;
308
309                 /* backdrop */
310                 glColor4ubv(bg);
311
312                 UI_draw_roundbox_corner_set(UI_CNR_ALL | UI_RB_ALPHA);
313                 UI_draw_roundbox(
314                         x - margin,
315                         (y + decent) - margin,
316                         x + width + margin,
317                         (y + decent) + height + margin,
318                         margin);
319
320                 glColor4ubv(fg);
321         }
322
323
324         BLF_position(fs->uifont_id, x, y, 0.0f);
325         BLF_draw(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
326
327         if (fs->kerning == 1)
328                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
329 }
330
331
332 /* ************** helpers ************************ */
333 /* XXX: read a style configure */
334 uiStyle *UI_style_get(void)
335 {
336 #if 0
337         uiStyle *style = NULL;
338         /* offset is two struct uiStyle pointers */
339         style = BLI_findstring(&U.uistyles, "Unifont Style", sizeof(style) * 2);
340         return (style != NULL) ? style : U.uistyles.first;
341 #else
342         return U.uistyles.first;
343 #endif
344 }
345
346 /* for drawing, scaled with DPI setting */
347 uiStyle *UI_style_get_dpi(void)
348 {
349         uiStyle *style = UI_style_get();
350         static uiStyle _style;
351
352         _style = *style;
353
354         _style.paneltitle.shadx = (short)(UI_DPI_FAC * _style.paneltitle.shadx);
355         _style.paneltitle.shady = (short)(UI_DPI_FAC * _style.paneltitle.shady);
356         _style.grouplabel.shadx = (short)(UI_DPI_FAC * _style.grouplabel.shadx);
357         _style.grouplabel.shady = (short)(UI_DPI_FAC * _style.grouplabel.shady);
358         _style.widgetlabel.shadx = (short)(UI_DPI_FAC * _style.widgetlabel.shadx);
359         _style.widgetlabel.shady = (short)(UI_DPI_FAC * _style.widgetlabel.shady);
360
361         _style.columnspace = (short)(UI_DPI_FAC * _style.columnspace);
362         _style.templatespace = (short)(UI_DPI_FAC * _style.templatespace);
363         _style.boxspace = (short)(UI_DPI_FAC * _style.boxspace);
364         _style.buttonspacex = (short)(UI_DPI_FAC * _style.buttonspacex);
365         _style.buttonspacey = (short)(UI_DPI_FAC * _style.buttonspacey);
366         _style.panelspace = (short)(UI_DPI_FAC * _style.panelspace);
367         _style.panelouter = (short)(UI_DPI_FAC * _style.panelouter);
368
369         return &_style;
370 }
371
372 int UI_fontstyle_string_width(const uiFontStyle *fs, const char *str)
373 {
374         int width;
375
376         if (fs->kerning == 1) /* for BLF_width */
377                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
378
379         UI_fontstyle_set(fs);
380         width = BLF_width(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
381
382         if (fs->kerning == 1)
383                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
384
385         return width;
386 }
387
388 int UI_fontstyle_height_max(const uiFontStyle *fs)
389 {
390         UI_fontstyle_set(fs);
391         return BLF_height_max(fs->uifont_id);
392 }
393
394
395 /* ************** init exit ************************ */
396
397 /* called on each startup.blend read */
398 /* reading without uifont will create one */
399 void uiStyleInit(void)
400 {
401         uiFont *font;
402         uiStyle *style = U.uistyles.first;
403         int monofont_size = datatoc_bmonofont_ttf_size;
404         unsigned char *monofont_ttf = (unsigned char *)datatoc_bmonofont_ttf;
405
406         /* recover from uninitialized dpi */
407         if (U.dpi == 0)
408                 U.dpi = 72;
409         CLAMP(U.dpi, 48, 144);
410
411         for (font = U.uifonts.first; font; font = font->next) {
412                 BLF_unload_id(font->blf_id);
413         }
414
415         if (blf_mono_font != -1) {
416                 BLF_unload_id(blf_mono_font);
417                 blf_mono_font = -1;
418         }
419
420         if (blf_mono_font_render != -1) {
421                 BLF_unload_id(blf_mono_font_render);
422                 blf_mono_font_render = -1;
423         }
424
425         font = U.uifonts.first;
426
427         /* default builtin */
428         if (font == NULL) {
429                 font = MEM_callocN(sizeof(uiFont), "ui font");
430                 BLI_addtail(&U.uifonts, font);
431         }
432
433         if (U.font_path_ui[0]) {
434                 BLI_strncpy(font->filename, U.font_path_ui, sizeof(font->filename));
435                 font->uifont_id = UIFONT_CUSTOM1;
436         }
437         else {
438                 BLI_strncpy(font->filename, "default", sizeof(font->filename));
439                 font->uifont_id = UIFONT_DEFAULT;
440         }
441
442         for (font = U.uifonts.first; font; font = font->next) {
443
444                 if (font->uifont_id == UIFONT_DEFAULT) {
445 #ifdef WITH_INTERNATIONAL
446                         int font_size = datatoc_bfont_ttf_size;
447                         unsigned char *font_ttf = (unsigned char *)datatoc_bfont_ttf;
448                         static int last_font_size = 0;
449
450                         /* use unicode font for translation */
451                         if (U.transopts & USER_DOTRANSLATE) {
452                                 font_ttf = BLF_get_unifont(&font_size);
453
454                                 if (!font_ttf) {
455                                         /* fall back if not found */
456                                         font_size = datatoc_bfont_ttf_size;
457                                         font_ttf = (unsigned char *)datatoc_bfont_ttf;
458                                 }
459                         }
460
461                         /* relload only if needed */
462                         if (last_font_size != font_size) {
463                                 BLF_unload("default");
464                                 last_font_size = font_size;
465                         }
466
467                         font->blf_id = BLF_load_mem("default", font_ttf, font_size);
468 #else
469                         font->blf_id = BLF_load_mem("default", (unsigned char *)datatoc_bfont_ttf, datatoc_bfont_ttf_size);
470 #endif
471                 }
472                 else {
473                         font->blf_id = BLF_load(font->filename);
474                         if (font->blf_id == -1) {
475                                 font->blf_id = BLF_load_mem("default", (unsigned char *)datatoc_bfont_ttf, datatoc_bfont_ttf_size);
476                         }
477                 }
478
479                 BLF_default_set(font->blf_id);
480
481                 if (font->blf_id == -1) {
482                         if (G.debug & G_DEBUG)
483                                 printf("%s: error, no fonts available\n", __func__);
484                 }
485                 else {
486                         /* ? just for speed to initialize?
487                          * Yes, this build the glyph cache and create
488                          * the texture.
489                          */
490                         BLF_size(font->blf_id, 11 * U.pixelsize, U.dpi);
491                         BLF_size(font->blf_id, 12 * U.pixelsize, U.dpi);
492                         BLF_size(font->blf_id, 14 * U.pixelsize, U.dpi);
493                 }
494         }
495
496         if (style == NULL) {
497                 ui_style_new(&U.uistyles, "Default Style", UIFONT_DEFAULT);
498         }
499
500 #ifdef WITH_INTERNATIONAL
501         /* use unicode font for text editor and interactive console */
502         if (U.transopts & USER_DOTRANSLATE) {
503                 monofont_ttf = BLF_get_unifont_mono(&monofont_size);
504
505                 if (!monofont_ttf) {
506                         /* fall back if not found */
507                         monofont_size = datatoc_bmonofont_ttf_size;
508                         monofont_ttf = (unsigned char *)datatoc_bmonofont_ttf;
509                 }
510         }
511 #endif
512
513         /* XXX, this should be moved into a style, but for now best only load the monospaced font once. */
514         BLI_assert(blf_mono_font == -1);
515         if (U.font_path_ui_mono[0]) {
516                 blf_mono_font = BLF_load_unique(U.font_path_ui_mono);
517         }
518         if (blf_mono_font == -1) {
519                 blf_mono_font = BLF_load_mem_unique("monospace", monofont_ttf, monofont_size);
520         }
521
522         BLF_size(blf_mono_font, 12 * U.pixelsize, 72);
523
524         /* Set default flags based on UI preferences (not render fonts) */
525         {
526                 int flag_disable = BLF_MONOCHROME |
527                                    BLF_HINTING_NONE |
528                                    BLF_HINTING_SLIGHT |
529                                    BLF_HINTING_FULL;
530                 int flag_enable = 0;
531
532                 if (U.text_render & USER_TEXT_HINTING_NONE) {
533                         flag_enable |= BLF_HINTING_NONE;
534                 }
535                 else if (U.text_render & USER_TEXT_HINTING_SLIGHT) {
536                         flag_enable |= BLF_HINTING_SLIGHT;
537                 }
538                 else if (U.text_render & USER_TEXT_HINTING_FULL) {
539                         flag_enable |= BLF_HINTING_FULL;
540                 }
541
542                 if (U.text_render & USER_TEXT_DISABLE_AA) {
543                         flag_enable |= BLF_MONOCHROME;
544                 }
545
546                 for (font = U.uifonts.first; font; font = font->next) {
547                         if (font->blf_id != -1) {
548                                 BLF_disable(font->blf_id, flag_disable);
549                                 BLF_enable(font->blf_id, flag_enable);
550                         }
551                 }
552                 if (blf_mono_font != -1) {
553                         BLF_disable(blf_mono_font, flag_disable);
554                         BLF_enable(blf_mono_font, flag_enable);
555                 }
556         }
557
558         /**
559          * Second for rendering else we get threading problems,
560          *
561          * \note This isn't good that the render font depends on the preferences,
562          * keep for now though, since without this there is no way to display many unicode chars.
563          */
564         if (blf_mono_font_render == -1)
565                 blf_mono_font_render = BLF_load_mem_unique("monospace", monofont_ttf, monofont_size);
566
567         BLF_size(blf_mono_font_render, 12 * U.pixelsize, 72);
568 }
569
570 void UI_fontstyle_set(const uiFontStyle *fs)
571 {
572         uiFont *font = uifont_to_blfont(fs->uifont_id);
573
574         BLF_size(font->blf_id, fs->points * U.pixelsize, U.dpi);
575 }