style cleanup: follow style guide for formatting of if/for/while loops, and else...
[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_math.h"
42 #include "BLI_listbase.h"
43 #include "BLI_rect.h"
44 #include "BLI_string.h"
45 #include "BLI_utildefines.h"
46
47 #include "BKE_global.h"
48
49
50 #include "BLF_api.h"
51 #include "BLF_translation.h"
52
53 #include "UI_interface.h"
54
55 #include "ED_datafiles.h"
56
57 #include "interface_intern.h"
58
59
60 /* style + theme + layout-engine = UI */
61
62 /* 
63  * This is a complete set of layout rules, the 'state' of the Layout 
64  * Engine. Multiple styles are possible, defined via C or Python. Styles 
65  * get a name, and will typically get activated per region type, like 
66  * "Header", or "Listview" or "Toolbar". Properties of Style definitions 
67  * are:
68  *
69  * - default column properties, internal spacing, aligning, min/max width
70  * - button alignment rules (for groups)
71  * - label placement rules
72  * - internal labeling or external labeling default
73  * - default minimum widths for buttons/labels (in amount of characters)
74  * - font types, styles and relative sizes for Panel titles, labels, etc.
75  */
76
77
78 /* ********************************************** */
79
80 static uiStyle *ui_style_new(ListBase *styles, const char *name, short uifont_id)
81 {
82         uiStyle *style= MEM_callocN(sizeof(uiStyle), "new style");
83         
84         BLI_addtail(styles, style);
85         BLI_strncpy(style->name, name, MAX_STYLE_NAME);
86         
87         style->panelzoom= 1.0; /* unused */
88
89         style->paneltitle.uifont_id= uifont_id;
90         style->paneltitle.points= 12;
91         style->paneltitle.kerning= 1;
92         style->paneltitle.shadow= 1;
93         style->paneltitle.shadx= 0;
94         style->paneltitle.shady= -1;
95         style->paneltitle.shadowalpha= 0.15f;
96         style->paneltitle.shadowcolor= 1.0f;
97         
98         style->grouplabel.uifont_id= uifont_id;
99         style->grouplabel.points= 12;
100         style->grouplabel.kerning= 1;
101         style->grouplabel.shadow= 3;
102         style->grouplabel.shadx= 0;
103         style->grouplabel.shady= -1;
104         style->grouplabel.shadowalpha= 0.25f;
105         
106         style->widgetlabel.uifont_id= uifont_id;
107         style->widgetlabel.points= 11;
108         style->widgetlabel.kerning= 1;
109         style->widgetlabel.shadow= 3;
110         style->widgetlabel.shadx= 0;
111         style->widgetlabel.shady= -1;
112         style->widgetlabel.shadowalpha= 0.15f;
113         style->widgetlabel.shadowcolor= 1.0f;
114         
115         style->widget.uifont_id= uifont_id;
116         style->widget.points= 11;
117         style->widget.kerning= 1;
118         style->widget.shadowalpha= 0.25f;
119
120         style->columnspace= 8;
121         style->templatespace= 5;
122         style->boxspace= 5;
123         style->buttonspacex= 8;
124         style->buttonspacey= 2;
125         style->panelspace= 8;
126         style->panelouter= 4;
127         
128         return style;
129 }
130
131 static uiFont *uifont_to_blfont(int id)
132 {
133         uiFont *font= U.uifonts.first;
134         
135         for (; font; font= font->next) {
136                 if (font->uifont_id==id) {
137                         return font;
138                 }
139         }
140         return U.uifonts.first;
141 }
142
143 /* *************** draw ************************ */
144
145
146 void uiStyleFontDrawExt(uiFontStyle *fs, rcti *rect, const char *str,
147         float *r_xofs, float *r_yofs)
148 {
149         float height;
150         int xofs=0, yofs;
151         
152         uiStyleFontSet(fs);
153
154         height= BLF_ascender(fs->uifont_id);
155         yofs= ceil( 0.5f*(rect->ymax - rect->ymin - height));
156
157         if (fs->align==UI_STYLE_TEXT_CENTER) {
158                 xofs= floor( 0.5f*(rect->xmax - rect->xmin - BLF_width(fs->uifont_id, str)));
159                 /* don't center text if it chops off the start of the text, 2 gives some margin */
160                 if (xofs < 2) {
161                         xofs= 2;
162                 }
163         }
164         else if (fs->align==UI_STYLE_TEXT_RIGHT) {
165                 xofs= rect->xmax - rect->xmin - BLF_width(fs->uifont_id, str) - 1;
166         }
167         
168         /* clip is very strict, so we give it some space */
169         BLF_clipping(fs->uifont_id, rect->xmin-1, rect->ymin-4, rect->xmax+1, rect->ymax+4);
170         BLF_enable(fs->uifont_id, BLF_CLIPPING);
171         BLF_position(fs->uifont_id, rect->xmin+xofs, rect->ymin+yofs, 0.0f);
172
173         if (fs->shadow) {
174                 BLF_enable(fs->uifont_id, BLF_SHADOW);
175                 BLF_shadow(fs->uifont_id, fs->shadow, fs->shadowcolor, fs->shadowcolor, fs->shadowcolor, fs->shadowalpha);
176                 BLF_shadow_offset(fs->uifont_id, fs->shadx, fs->shady);
177         }
178
179         if (fs->kerning == 1)
180                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
181
182         BLF_draw(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
183         BLF_disable(fs->uifont_id, BLF_CLIPPING);
184         if (fs->shadow)
185                 BLF_disable(fs->uifont_id, BLF_SHADOW);
186         if (fs->kerning == 1)
187                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
188
189         *r_xofs= xofs;
190         *r_yofs= yofs;
191 }
192
193 void uiStyleFontDraw(uiFontStyle *fs, rcti *rect, const char *str)
194 {
195         float xofs, yofs;
196         uiStyleFontDrawExt(fs, rect, str,
197                 &xofs, &yofs);
198 }
199
200 /* drawn same as above, but at 90 degree angle */
201 void uiStyleFontDrawRotated(uiFontStyle *fs, rcti *rect, const char *str)
202 {
203         float height;
204         int xofs, yofs;
205         float angle;
206         rcti txtrect;
207
208         uiStyleFontSet(fs);
209
210         height= BLF_ascender(fs->uifont_id);
211         /* becomes x-offset when rotated */
212         xofs= ceil( 0.5f*(rect->ymax - rect->ymin - height));
213
214         /* ignore UI_STYLE, always aligned to top */
215
216         /* rotate counter-clockwise for now (assumes left-to-right language)*/
217         xofs+= height;
218         yofs= BLF_width(fs->uifont_id, str) + 5;
219         angle= 90.0f;
220
221         /* translate rect to vertical */
222         txtrect.xmin = rect->xmin - (rect->ymax - rect->ymin);
223         txtrect.ymin = rect->ymin - (rect->xmax - rect->xmin);
224         txtrect.xmax = rect->xmin;
225         txtrect.ymax = rect->ymin;
226
227         /* clip is very strict, so we give it some space */
228         /* clipping is done without rotation, so make rect big enough to contain both positions */
229         BLF_clipping(fs->uifont_id, txtrect.xmin-1, txtrect.ymin-yofs-xofs-4, rect->xmax+1, rect->ymax+4);
230         BLF_enable(fs->uifont_id, BLF_CLIPPING);
231         BLF_position(fs->uifont_id, txtrect.xmin+xofs, txtrect.ymax-yofs, 0.0f);
232
233         BLF_enable(fs->uifont_id, BLF_ROTATION);
234         BLF_rotation(fs->uifont_id, angle);
235
236         if (fs->shadow) {
237                 BLF_enable(fs->uifont_id, BLF_SHADOW);
238                 BLF_shadow(fs->uifont_id, fs->shadow, fs->shadowcolor, fs->shadowcolor, fs->shadowcolor, fs->shadowalpha);
239                 BLF_shadow_offset(fs->uifont_id, fs->shadx, fs->shady);
240         }
241
242         if (fs->kerning == 1)
243                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
244
245         BLF_draw(fs->uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
246         BLF_disable(fs->uifont_id, BLF_ROTATION);
247         BLF_disable(fs->uifont_id, BLF_CLIPPING);
248         if (fs->shadow)
249                 BLF_disable(fs->uifont_id, BLF_SHADOW);
250         if (fs->kerning == 1)
251                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
252 }
253
254 /* ************** helpers ************************ */
255 /* XXX: read a style configure */
256 uiStyle* UI_GetStyle(void)
257 {
258         uiStyle *style = NULL;
259         /* offset is two struct uiStyle pointers */
260         /* style = BLI_findstring( &U.uistyles, "Unifont Style", sizeof(style)*2 ) */;
261         return (style != NULL) ? style : U.uistyles.first;
262 }
263
264 /* temporarily, does widget font */
265 int UI_GetStringWidth(const char *str)
266 {
267         uiStyle *style= UI_GetStyle();
268         uiFontStyle *fstyle= &style->widget;
269         int width;
270         
271         if (fstyle->kerning==1) /* for BLF_width */
272                 BLF_enable(fstyle->uifont_id, BLF_KERNING_DEFAULT);
273         
274         uiStyleFontSet(fstyle);
275         width= BLF_width(fstyle->uifont_id, str);       
276         
277         if (fstyle->kerning==1)
278                 BLF_disable(fstyle->uifont_id, BLF_KERNING_DEFAULT);
279         
280         return width;
281 }
282
283 /* temporarily, does widget font */
284 void UI_DrawString(float x, float y, const char *str)
285 {
286         uiStyle *style= UI_GetStyle();
287         
288         if (style->widget.kerning == 1)
289                 BLF_enable(style->widget.uifont_id, BLF_KERNING_DEFAULT);
290
291         uiStyleFontSet(&style->widget);
292         BLF_position(style->widget.uifont_id, x, y, 0.0f);
293         BLF_draw(style->widget.uifont_id, str, BLF_DRAW_STR_DUMMY_MAX);
294
295         if (style->widget.kerning == 1)
296                 BLF_disable(style->widget.uifont_id, BLF_KERNING_DEFAULT);
297 }
298
299 /* ************** init exit ************************ */
300
301 /* called on each startup.blend read */
302 /* reading without uifont will create one */
303 void uiStyleInit(void)
304 {
305         uiFont *font= U.uifonts.first;
306         uiStyle *style= U.uistyles.first;
307         
308         /* recover from uninitialized dpi */
309         if (U.dpi == 0)
310                 U.dpi= 72;
311         CLAMP(U.dpi, 48, 128);
312         
313         /* default builtin */
314         if (font==NULL) {
315                 font= MEM_callocN(sizeof(uiFont), "ui font");
316                 BLI_addtail(&U.uifonts, font);
317                 
318                 BLI_strncpy(font->filename, "default", sizeof(font->filename));
319                 font->uifont_id= UIFONT_DEFAULT;
320         }
321         
322         for (font= U.uifonts.first; font; font= font->next) {
323                 
324                 if (font->uifont_id==UIFONT_DEFAULT) {
325 #ifdef WITH_INTERNATIONAL
326                         int font_size= datatoc_bfont_ttf_size;
327                         unsigned char *font_ttf= (unsigned char*)datatoc_bfont_ttf;
328                         static int last_font_size = 0;
329
330                         /* use unicode font for translation */
331                         if (U.transopts & USER_DOTRANSLATE) {
332                                 font_ttf= BLF_get_unifont(&font_size);
333
334                                 if (!font_ttf) {
335                                         /* fall back if not found */
336                                         font_size= datatoc_bfont_ttf_size;
337                                         font_ttf= (unsigned char*)datatoc_bfont_ttf;
338                                 }
339                         }
340
341                         /* relload only if needed */
342                         if (last_font_size != font_size) {
343                                 BLF_unload("default");
344                                 last_font_size = font_size;
345                         }
346
347                         font->blf_id= BLF_load_mem("default", font_ttf, font_size);
348 #else
349                         font->blf_id= BLF_load_mem("default", (unsigned char*)datatoc_bfont_ttf, datatoc_bfont_ttf_size);
350 #endif
351                 }               
352                 else {
353                         font->blf_id= BLF_load(font->filename);
354                         if (font->blf_id == -1)
355                                 font->blf_id= BLF_load_mem("default", (unsigned char*)datatoc_bfont_ttf, datatoc_bfont_ttf_size);
356                 }
357
358                 if (font->blf_id == -1) {
359                         if (G.f & G_DEBUG)
360                                 printf("%s: error, no fonts available\n", __func__);
361                 }
362                 else {
363                         /* ? just for speed to initialize?
364                          * Yes, this build the glyph cache and create
365                          * the texture.
366                          */
367                         BLF_size(font->blf_id, 11, U.dpi);
368                         BLF_size(font->blf_id, 12, U.dpi);
369                         BLF_size(font->blf_id, 14, U.dpi);
370                 }
371         }
372         
373         if (style==NULL) {
374                 ui_style_new(&U.uistyles, "Default Style", UIFONT_DEFAULT );
375         }
376         
377         // XXX, this should be moved into a style, but for now best only load the monospaced font once.
378         if (blf_mono_font == -1)
379                 blf_mono_font= BLF_load_mem_unique("monospace", (unsigned char *)datatoc_bmonofont_ttf, datatoc_bmonofont_ttf_size);
380
381         BLF_size(blf_mono_font, 12, 72);
382         
383         /* second for rendering else we get threading problems */
384         if (blf_mono_font_render == -1)
385                 blf_mono_font_render= BLF_load_mem_unique("monospace", (unsigned char *)datatoc_bmonofont_ttf, datatoc_bmonofont_ttf_size);
386
387         BLF_size(blf_mono_font_render, 12, 72);
388 }
389
390 void uiStyleFontSet(uiFontStyle *fs)
391 {
392         uiFont *font= uifont_to_blfont(fs->uifont_id);
393         
394         BLF_size(font->blf_id, fs->points, U.dpi);
395 }
396