remove unused includes
[blender-staging.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 #include <limits.h>
27 #include <math.h>
28 #include <stdlib.h>
29 #include <string.h>
30
31 #include "MEM_guardedalloc.h"
32
33 #include "DNA_screen_types.h"
34 #include "DNA_userdef_types.h"
35
36 #include "BLI_math.h"
37 #include "BLI_listbase.h"
38 #include "BLI_rect.h"
39 #include "BLI_string.h"
40
41 #include "BKE_global.h"
42
43 #include "BIF_gl.h"
44 #include "BIF_glutil.h"
45
46 #include "BLF_api.h"
47
48 #include "UI_interface.h"
49
50 #include "ED_datafiles.h"
51
52 #include "interface_intern.h"
53
54
55 /* style + theme + layout-engine = UI */
56
57 /* 
58  This is a complete set of layout rules, the 'state' of the Layout 
59  Engine. Multiple styles are possible, defined via C or Python. Styles 
60  get a name, and will typically get activated per region type, like 
61  "Header", or "Listview" or "Toolbar". Properties of Style definitions 
62  are:
63  
64  - default collumn properties, internal spacing, aligning, min/max width
65  - button alignment rules (for groups)
66  - label placement rules
67  - internal labeling or external labeling default
68  - default minimum widths for buttons/labels (in amount of characters)
69  - font types, styles and relative sizes for Panel titles, labels, etc.
70
71 */
72
73
74 /* ********************************************** */
75
76 static uiStyle *ui_style_new(ListBase *styles, const char *name)
77 {
78         uiStyle *style= MEM_callocN(sizeof(uiStyle), "new style");
79         
80         BLI_addtail(styles, style);
81         BLI_strncpy(style->name, name, MAX_STYLE_NAME);
82         
83         style->panelzoom= 1.0;
84
85         style->paneltitle.uifont_id= UIFONT_DEFAULT;
86         style->paneltitle.points= 12;
87         style->paneltitle.kerning= 1;
88         style->paneltitle.shadow= 1;
89         style->paneltitle.shadx= 0;
90         style->paneltitle.shady= -1;
91         style->paneltitle.shadowalpha= 0.15f;
92         style->paneltitle.shadowcolor= 1.0f;
93         
94         style->grouplabel.uifont_id= UIFONT_DEFAULT;
95         style->grouplabel.points= 12;
96         style->grouplabel.kerning= 1;
97         style->grouplabel.shadow= 3;
98         style->grouplabel.shadx= 0;
99         style->grouplabel.shady= -1;
100         style->grouplabel.shadowalpha= 0.25f;
101         
102         style->widgetlabel.uifont_id= UIFONT_DEFAULT;
103         style->widgetlabel.points= 11;
104         style->widgetlabel.kerning= 1;
105         style->widgetlabel.shadow= 3;
106         style->widgetlabel.shadx= 0;
107         style->widgetlabel.shady= -1;
108         style->widgetlabel.shadowalpha= 0.15f;
109         style->widgetlabel.shadowcolor= 1.0f;
110         
111         style->widget.uifont_id= UIFONT_DEFAULT;
112         style->widget.points= 11;
113         style->widget.kerning= 1;
114         style->widget.shadowalpha= 0.25f;
115
116         style->columnspace= 8;
117         style->templatespace= 5;
118         style->boxspace= 5;
119         style->buttonspacex= 8;
120         style->buttonspacey= 2;
121         style->panelspace= 8;
122         style->panelouter= 4;
123         
124         return style;
125 }
126
127 static uiFont *uifont_to_blfont(int id)
128 {
129         uiFont *font= U.uifonts.first;
130         
131         for(; font; font= font->next) {
132                 if(font->uifont_id==id) {
133                         return font;
134                 }
135         }
136         return U.uifonts.first;
137 }
138
139 /* *************** draw ************************ */
140
141 void uiStyleFontDraw(uiFontStyle *fs, rcti *rect, char *str)
142 {
143         float height;
144         int xofs=0, yofs;
145         
146         uiStyleFontSet(fs);
147         
148         height= BLF_height(fs->uifont_id, "2"); /* correct offset is on baseline, the j is below that */
149         yofs= floor( 0.5f*(rect->ymax - rect->ymin - height));
150
151         if(fs->align==UI_STYLE_TEXT_CENTER)
152                 xofs= floor( 0.5f*(rect->xmax - rect->xmin - BLF_width(fs->uifont_id, str)));
153         else if(fs->align==UI_STYLE_TEXT_RIGHT)
154                 xofs= rect->xmax - rect->xmin - BLF_width(fs->uifont_id, str) - 1;
155         
156         /* clip is very strict, so we give it some space */
157         BLF_clipping(fs->uifont_id, rect->xmin-1, rect->ymin-4, rect->xmax+1, rect->ymax+4);
158         BLF_enable(fs->uifont_id, BLF_CLIPPING);
159         BLF_position(fs->uifont_id, rect->xmin+xofs, rect->ymin+yofs, 0.0f);
160
161         if (fs->shadow) {
162                 BLF_enable(fs->uifont_id, BLF_SHADOW);
163                 BLF_shadow(fs->uifont_id, fs->shadow, fs->shadowcolor, fs->shadowcolor, fs->shadowcolor, fs->shadowalpha);
164                 BLF_shadow_offset(fs->uifont_id, fs->shadx, fs->shady);
165         }
166
167         if (fs->kerning == 1)
168                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
169
170         BLF_draw(fs->uifont_id, str);
171         BLF_disable(fs->uifont_id, BLF_CLIPPING);
172         if (fs->shadow)
173                 BLF_disable(fs->uifont_id, BLF_SHADOW);
174         if (fs->kerning == 1)
175                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
176 }
177
178 /* drawn same as above, but at 90 degree angle */
179 void uiStyleFontDrawRotated(uiFontStyle *fs, rcti *rect, char *str)
180 {
181         float height;
182         int xofs, yofs;
183         float angle;
184         rcti txtrect;
185
186         uiStyleFontSet(fs);
187
188         height= BLF_height(fs->uifont_id, "2"); /* correct offset is on baseline, the j is below that */
189         /* becomes x-offset when rotated */
190         xofs= floor( 0.5f*(rect->ymax - rect->ymin - height)) + 1;
191
192         /* ignore UI_STYLE, always aligned to top */
193
194         /* rotate counter-clockwise for now (assumes left-to-right language)*/
195         xofs+= height;
196         yofs= BLF_width(fs->uifont_id, str) + 5;
197         angle= 90.0f;
198
199         /* translate rect to vertical */
200         txtrect.xmin= rect->xmin - (rect->ymax - rect->ymin);
201         txtrect.ymin= rect->ymin - (rect->xmax - rect->xmin);
202         txtrect.xmax= rect->xmin;
203         txtrect.ymax= rect->ymin;
204
205         /* clip is very strict, so we give it some space */
206         /* clipping is done without rotation, so make rect big enough to contain both positions */
207         BLF_clipping(fs->uifont_id, txtrect.xmin-1, txtrect.ymin-yofs-xofs-4, rect->xmax+1, rect->ymax+4);
208         BLF_enable(fs->uifont_id, BLF_CLIPPING);
209         BLF_position(fs->uifont_id, txtrect.xmin+xofs, txtrect.ymax-yofs, 0.0f);
210
211         BLF_enable(fs->uifont_id, BLF_ROTATION);
212         BLF_rotation(fs->uifont_id, angle);
213
214         if (fs->shadow) {
215                 BLF_enable(fs->uifont_id, BLF_SHADOW);
216                 BLF_shadow(fs->uifont_id, fs->shadow, fs->shadowcolor, fs->shadowcolor, fs->shadowcolor, fs->shadowalpha);
217                 BLF_shadow_offset(fs->uifont_id, fs->shadx, fs->shady);
218         }
219
220         if (fs->kerning == 1)
221                 BLF_enable(fs->uifont_id, BLF_KERNING_DEFAULT);
222
223         BLF_draw(fs->uifont_id, str);
224         BLF_disable(fs->uifont_id, BLF_ROTATION);
225         BLF_disable(fs->uifont_id, BLF_CLIPPING);
226         if (fs->shadow)
227                 BLF_disable(fs->uifont_id, BLF_SHADOW);
228         if (fs->kerning == 1)
229                 BLF_disable(fs->uifont_id, BLF_KERNING_DEFAULT);
230 }
231
232 /* ************** helpers ************************ */
233
234 /* temporarily, does widget font */
235 int UI_GetStringWidth(char *str)
236 {
237         uiStyle *style= U.uistyles.first;
238         uiFontStyle *fstyle= &style->widget;
239         int width;
240         
241         if (fstyle->kerning==1) /* for BLF_width */
242                 BLF_enable(fstyle->uifont_id, BLF_KERNING_DEFAULT);
243         
244         uiStyleFontSet(fstyle);
245         width= BLF_width(fstyle->uifont_id, str);       
246         
247         if (fstyle->kerning==1)
248                 BLF_disable(fstyle->uifont_id, BLF_KERNING_DEFAULT);
249         
250         return width;
251 }
252
253 /* temporarily, does widget font */
254 void UI_DrawString(float x, float y, char *str)
255 {
256         uiStyle *style= U.uistyles.first;
257         
258         uiStyleFontSet(&style->widget);
259         BLF_position(style->widget.uifont_id, x, y, 0.0f);
260         BLF_draw(style->widget.uifont_id, str);
261 }
262
263 /* ************** init exit ************************ */
264
265 /* called on each startup.blend read */
266 /* reading without uifont will create one */
267 void uiStyleInit(void)
268 {
269         uiFont *font= U.uifonts.first;
270         uiStyle *style= U.uistyles.first;
271         
272         /* recover from uninitialized dpi */
273         CLAMP(U.dpi, 72, 240);
274         
275         /* default builtin */
276         if(font==NULL) {
277                 font= MEM_callocN(sizeof(uiFont), "ui font");
278                 BLI_addtail(&U.uifonts, font);
279                 
280                 strcpy(font->filename, "default");
281                 font->uifont_id= UIFONT_DEFAULT;
282         }
283         
284         for(font= U.uifonts.first; font; font= font->next) {
285                 
286                 if(font->uifont_id==UIFONT_DEFAULT) {
287                         font->blf_id= BLF_load_mem("default", (unsigned char*)datatoc_bfont_ttf, datatoc_bfont_ttf_size);
288                 }               
289                 else {
290                         font->blf_id= BLF_load(font->filename);
291                         if(font->blf_id == -1)
292                                 font->blf_id= BLF_load_mem("default", (unsigned char*)datatoc_bfont_ttf, datatoc_bfont_ttf_size);
293                 }
294
295                 if (font->blf_id == -1) {
296                         if (G.f & G_DEBUG)
297                                 printf("uiStyleInit error, no fonts available\n");
298                 }
299                 else {
300                         /* ? just for speed to initialize?
301                          * Yes, this build the glyph cache and create
302                          * the texture.
303                          */
304                         BLF_size(font->blf_id, 11, U.dpi);
305                         BLF_size(font->blf_id, 12, U.dpi);
306                         BLF_size(font->blf_id, 14, U.dpi);
307                 }
308         }
309         
310         if(style==NULL) {
311                 ui_style_new(&U.uistyles, "Default Style");
312         }
313 }
314
315 void uiStyleFontSet(uiFontStyle *fs)
316 {
317         uiFont *font= uifont_to_blfont(fs->uifont_id);
318         
319         BLF_size(font->blf_id, fs->points, U.dpi);
320 }
321