blf - further shrink drawing functions & some style changes.
[blender.git] / source / blender / blenfont / intern / blf.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/blenfont/intern/blf.c
30  *  \ingroup blf
31  */
32
33
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <math.h>
38
39 #include <ft2build.h>
40
41 #include FT_FREETYPE_H
42 #include FT_GLYPH_H
43
44 #include "MEM_guardedalloc.h"
45
46 #include "DNA_listBase.h"
47 #include "DNA_vec_types.h"
48
49 #include "BIF_gl.h"
50 #include "BLF_api.h"
51
52 #include "blf_internal_types.h"
53 #include "blf_internal.h"
54
55
56 /* Max number of font in memory.
57  * Take care that now every font have a glyph cache per size/dpi,
58  * so we don't need load the same font with different size, just
59  * load one and call BLF_size.
60  */
61 #define BLF_MAX_FONT 16
62
63 /* Font array. */
64 static FontBLF *global_font[BLF_MAX_FONT];
65
66 /* Number of font. */
67 static int global_font_num= 0;
68
69 /* Default size and dpi, for BLF_draw_default. */
70 static int global_font_default= -1;
71 static int global_font_points= 11;
72 static int global_font_dpi= 72;
73
74 // XXX, should these be made into global_font_'s too?
75 int blf_mono_font= -1;
76 int blf_mono_font_render= -1;
77
78 static FontBLF *BLF_get(int fontid)
79 {
80         if (fontid >= 0 && fontid < BLF_MAX_FONT)
81                 return global_font[fontid];
82         return NULL;
83 }
84
85 int BLF_init(int points, int dpi)
86 {
87         int i;
88
89         for (i= 0; i < BLF_MAX_FONT; i++)
90                 global_font[i]= NULL;
91
92         global_font_points= points;
93         global_font_dpi= dpi;
94         return blf_font_init();
95 }
96
97 void BLF_exit(void)
98 {
99         FontBLF *font;
100         int i;
101
102         for (i= 0; i < global_font_num; i++) {
103                 font= global_font[i];
104                 if (font)
105                         blf_font_free(font);
106         }
107
108         blf_font_exit();
109 }
110
111 void BLF_cache_clear(void)
112 {
113         FontBLF *font;
114         int i;
115
116         for (i= 0; i < global_font_num; i++) {
117                 font= global_font[i];
118                 if (font)
119                         blf_glyph_cache_clear(font);
120         }
121 }
122
123 static int blf_search(const char *name)
124 {
125         FontBLF *font;
126         int i;
127
128         for (i= 0; i < BLF_MAX_FONT; i++) {
129                 font= global_font[i];
130                 if (font && (!strcmp(font->name, name)))
131                         return i;
132         }
133         return -1;
134 }
135
136 int BLF_load(const char *name)
137 {
138         FontBLF *font;
139         char *filename;
140         int i;
141
142         if (!name)
143                 return -1;
144
145         /* check if we already load this font. */
146         i= blf_search(name);
147         if (i >= 0) {
148                 /*font= global_font[i];*/ /*UNUSED*/
149                 return i;
150         }
151
152         if (global_font_num+1 >= BLF_MAX_FONT) {
153                 printf("Too many fonts!!!\n");
154                 return -1;
155         }
156
157         filename= blf_dir_search(name);
158         if (!filename) {
159                 printf("Can't find font: %s\n", name);
160                 return -1;
161         }
162
163         font= blf_font_new(name, filename);
164         MEM_freeN(filename);
165
166         if (!font) {
167                 printf("Can't load font: %s\n", name);
168                 return -1;
169         }
170
171         global_font[global_font_num]= font;
172         i= global_font_num;
173         global_font_num++;
174         return i;
175 }
176
177 int BLF_load_unique(const char *name)
178 {
179         FontBLF *font;
180         char *filename;
181         int i;
182
183         if (!name)
184                 return -1;
185
186         /* Don't search in the cache!! make a new
187          * object font, this is for keep fonts threads safe.
188          */
189         if (global_font_num+1 >= BLF_MAX_FONT) {
190                 printf("Too many fonts!!!\n");
191                 return -1;
192         }
193
194         filename= blf_dir_search(name);
195         if (!filename) {
196                 printf("Can't find font: %s\n", name);
197                 return -1;
198         }
199
200         font= blf_font_new(name, filename);
201         MEM_freeN(filename);
202
203         if (!font) {
204                 printf("Can't load font: %s\n", name);
205                 return -1;
206         }
207
208         global_font[global_font_num]= font;
209         i= global_font_num;
210         global_font_num++;
211         return i;
212 }
213
214 void BLF_metrics_attach(int fontid, unsigned char *mem, int mem_size)
215 {
216         FontBLF *font;
217
218         font= BLF_get(fontid);
219         if (font)
220                 blf_font_attach_from_mem(font, mem, mem_size);
221 }
222
223 int BLF_load_mem(const char *name, unsigned char *mem, int mem_size)
224 {
225         FontBLF *font;
226         int i;
227
228         if (!name)
229                 return -1;
230
231         i= blf_search(name);
232         if (i >= 0) {
233                 /*font= global_font[i];*/ /*UNUSED*/
234                 return i;
235         }
236
237         if (global_font_num+1 >= BLF_MAX_FONT) {
238                 printf("Too many fonts!!!\n");
239                 return -1;
240         }
241
242         if (!mem || !mem_size) {
243                 printf("Can't load font: %s from memory!!\n", name);
244                 return -1;
245         }
246
247         font= blf_font_new_from_mem(name, mem, mem_size);
248         if (!font) {
249                 printf("Can't load font: %s from memory!!\n", name);
250                 return -1;
251         }
252
253         global_font[global_font_num]= font;
254         i= global_font_num;
255         global_font_num++;
256         return i;
257 }
258
259 int BLF_load_mem_unique(const char *name, unsigned char *mem, int mem_size)
260 {
261         FontBLF *font;
262         int i;
263
264         if (!name)
265                 return -1;
266
267         /*
268          * Don't search in the cache, make a new object font!
269          * this is to keep the font thread safe.
270          */
271         if (global_font_num+1 >= BLF_MAX_FONT) {
272                 printf("Too many fonts!!!\n");
273                 return -1;
274         }
275
276         if (!mem || !mem_size) {
277                 printf("Can't load font: %s from memory!!\n", name);
278                 return -1;
279         }
280
281         font= blf_font_new_from_mem(name, mem, mem_size);
282         if (!font) {
283                 printf("Can't load font: %s from memory!!\n", name);
284                 return -1;
285         }
286
287         global_font[global_font_num]= font;
288         i= global_font_num;
289         global_font_num++;
290         return i;
291 }
292
293 void BLF_enable(int fontid, int option)
294 {
295         FontBLF *font;
296
297         font= BLF_get(fontid);
298         if (font)
299                 font->flags |= option;
300 }
301
302 void BLF_disable(int fontid, int option)
303 {
304         FontBLF *font;
305
306         font= BLF_get(fontid);
307         if (font)
308                 font->flags &= ~option;
309 }
310
311 void BLF_enable_default(int option)
312 {
313         FontBLF *font;
314
315         font= BLF_get(global_font_default);
316         if (font)
317                 font->flags |= option;
318 }
319
320 void BLF_disable_default(int option)
321 {
322         FontBLF *font;
323
324         font= BLF_get(global_font_default);
325         if (font)
326                 font->flags &= ~option;
327 }
328
329 void BLF_aspect(int fontid, float x, float y, float z)
330 {
331         FontBLF *font;
332
333         font= BLF_get(fontid);
334         if (font) {
335                 font->aspect[0]= x;
336                 font->aspect[1]= y;
337                 font->aspect[2]= z;
338         }
339 }
340
341 void BLF_matrix(int fontid, const double m[16])
342 {
343         FontBLF *font;
344
345         font= BLF_get(fontid);
346         if (font) {
347                 memcpy(font->m, m, sizeof(font->m));
348         }
349 }
350
351 void BLF_position(int fontid, float x, float y, float z)
352 {
353         FontBLF *font;
354
355         font= BLF_get(fontid);
356         if (font) {
357                 float xa, ya, za;
358                 float remainder;
359
360                 if (font->flags & BLF_ASPECT) {
361                         xa= font->aspect[0];
362                         ya= font->aspect[1];
363                         za= font->aspect[2];
364                 }
365                 else {
366                         xa= 1.0f;
367                         ya= 1.0f;
368                         za= 1.0f;
369                 }
370
371                 remainder= x - floorf(x);
372                 if (remainder > 0.4f && remainder < 0.6f) {
373                         if (remainder < 0.5f)
374                                 x -= 0.1f * xa;
375                         else
376                                 x += 0.1f * xa;
377                 }
378
379                 remainder= y - floorf(y);
380                 if (remainder > 0.4f && remainder < 0.6f) {
381                         if (remainder < 0.5f)
382                                 y -= 0.1f * ya;
383                         else
384                                 y += 0.1f * ya;
385                 }
386
387                 remainder= z - floorf(z);
388                 if (remainder > 0.4f && remainder < 0.6f) {
389                         if (remainder < 0.5f)
390                                 z -= 0.1f * za;
391                         else
392                                 z += 0.1f * za;
393                 }
394
395                 font->pos[0]= x;
396                 font->pos[1]= y;
397                 font->pos[2]= z;
398         }
399 }
400
401 void BLF_size(int fontid, int size, int dpi)
402 {
403         FontBLF *font;
404
405         font= BLF_get(fontid);
406         if (font)
407                 blf_font_size(font, size, dpi);
408 }
409
410 void BLF_blur(int fontid, int size)
411 {
412         FontBLF *font;
413         
414         font= BLF_get(fontid);
415         if (font)
416                 font->blur= size;
417 }
418
419 void BLF_draw_default(float x, float y, float z, const char *str, size_t len)
420 {
421         if (!str)
422                 return;
423
424         if (global_font_default == -1)
425                 global_font_default= blf_search("default");
426
427         if (global_font_default == -1) {
428                 printf("Warning: Can't found default font!!\n");
429                 return;
430         }
431
432         BLF_size(global_font_default, global_font_points, global_font_dpi);
433         BLF_position(global_font_default, x, y, z);
434         BLF_draw(global_font_default, str, len);
435 }
436
437 /* same as above but call 'BLF_draw_ascii' */
438 void BLF_draw_default_ascii(float x, float y, float z, const char *str, size_t len)
439 {
440         if (!str)
441                 return;
442
443         if (global_font_default == -1)
444                 global_font_default= blf_search("default");
445
446         if (global_font_default == -1) {
447                 printf("Warning: Can't found default font!!\n");
448                 return;
449         }
450
451         BLF_size(global_font_default, global_font_points, global_font_dpi);
452         BLF_position(global_font_default, x, y, z);
453         BLF_draw_ascii(global_font_default, str, len); /* XXX, use real length */
454 }
455
456 void BLF_rotation_default(float angle)
457 {
458         FontBLF *font;
459
460         font= BLF_get(global_font_default);
461         if (font)
462                 font->angle= angle;
463 }
464
465 static void blf_draw__start(FontBLF *font)
466 {
467         /*
468          * The pixmap alignment hack is handle
469          * in BLF_position (old ui_rasterpos_safe).
470          */
471
472         glEnable(GL_BLEND);
473         glEnable(GL_TEXTURE_2D);
474         glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
475
476         glPushMatrix();
477
478         if (font->flags & BLF_MATRIX)
479                 glMultMatrixd((GLdouble *)&font->m);
480
481         glTranslatef(font->pos[0], font->pos[1], font->pos[2]);
482
483         if (font->flags & BLF_ASPECT)
484                 glScalef(font->aspect[0], font->aspect[1], font->aspect[2]);
485
486         if (font->flags & BLF_ROTATION)
487                 glRotatef(font->angle, 0.0f, 0.0f, 1.0f);
488
489         if(font->shadow || font->blur)
490                 glGetFloatv(GL_CURRENT_COLOR, font->orig_col);
491
492         /* always bind the texture for the first glyph */
493         font->tex_bind_state= -1;
494
495 }
496
497 static void blf_draw__end(void)
498 {
499         glPopMatrix();
500         glDisable(GL_BLEND);
501         glDisable(GL_TEXTURE_2D);
502 }
503
504 void BLF_draw(int fontid, const char *str, size_t len)
505 {
506         FontBLF *font= BLF_get(fontid);
507         if (font && font->glyph_cache) {
508                 blf_draw__start(font);
509                 blf_font_draw(font, str, len);
510                 blf_draw__end();
511         }
512 }
513
514 void BLF_draw_ascii(int fontid, const char *str, size_t len)
515 {
516         FontBLF *font= BLF_get(fontid);
517         if (font && font->glyph_cache) {
518                 blf_draw__start(font);
519                 blf_font_draw_ascii(font, str, len);
520                 blf_draw__end();
521         }
522 }
523
524 void BLF_boundbox(int fontid, const char *str, rctf *box)
525 {
526         FontBLF *font;
527
528         font= BLF_get(fontid);
529         if (font)
530                 blf_font_boundbox(font, str, box);
531 }
532
533 void BLF_width_and_height(int fontid, const char *str, float *width, float *height)
534 {
535         FontBLF *font;
536
537         font= BLF_get(fontid);
538         if (font && font->glyph_cache)
539                 blf_font_width_and_height(font, str, width, height);
540 }
541
542 float BLF_width(int fontid, const char *str)
543 {
544         FontBLF *font;
545
546         font= BLF_get(fontid);
547         if (font && font->glyph_cache)
548                 return blf_font_width(font, str);
549         return 0.0f;
550 }
551
552 float BLF_fixed_width(int fontid)
553 {
554         FontBLF *font;
555
556         font= BLF_get(fontid);
557         if (font && font->glyph_cache)
558                 return blf_font_fixed_width(font);
559         return 0.0f;
560 }
561
562 float BLF_width_default(const char *str)
563 {
564         if (global_font_default == -1)
565                 global_font_default= blf_search("default");
566
567         if (global_font_default == -1) {
568                 printf("Error: Can't found default font!!\n");
569                 return 0.0f;
570         }
571
572         BLF_size(global_font_default, global_font_points, global_font_dpi);
573         return BLF_width(global_font_default, str);
574 }
575
576 float BLF_height(int fontid, const char *str)
577 {
578         FontBLF *font;
579
580         font= BLF_get(fontid);
581         if (font && font->glyph_cache)
582                 return blf_font_height(font, str);
583         return 0.0f;
584 }
585
586 float BLF_height_max(int fontid)
587 {
588         FontBLF *font;
589
590         font= BLF_get(fontid);
591         if (font && font->glyph_cache)
592                 return font->glyph_cache->max_glyph_height;
593         return 0.0f;
594 }
595
596 float BLF_width_max(int fontid)
597 {
598         FontBLF *font;
599
600         font= BLF_get(fontid);
601         if (font && font->glyph_cache) {
602                 return font->glyph_cache->max_glyph_width;
603         }
604         return 0.0f;
605 }
606
607 float BLF_descender(int fontid)
608 {
609         FontBLF *font;
610
611         font= BLF_get(fontid);
612         if (font && font->glyph_cache) {
613                 return font->glyph_cache->descender;
614         }
615         return 0.0f;
616 }
617
618 float BLF_ascender(int fontid)
619 {
620         FontBLF *font;
621
622         font= BLF_get(fontid);
623         if (font && font->glyph_cache) {
624                 return font->glyph_cache->ascender;
625         }
626         return 0.0f;
627 }
628
629 float BLF_height_default(const char *str)
630 {
631         if (global_font_default == -1)
632                 global_font_default= blf_search("default");
633
634         if (global_font_default == -1) {
635                 printf("Error: Can't found default font!!\n");
636                 return 0.0f;
637         }
638
639         BLF_size(global_font_default, global_font_points, global_font_dpi);
640
641         return BLF_height(global_font_default, str);
642 }
643
644 void BLF_rotation(int fontid, float angle)
645 {
646         FontBLF *font;
647
648         font= BLF_get(fontid);
649         if (font)
650                 font->angle= angle;
651 }
652
653 void BLF_clipping(int fontid, float xmin, float ymin, float xmax, float ymax)
654 {
655         FontBLF *font;
656
657         font= BLF_get(fontid);
658         if (font) {
659                 font->clip_rec.xmin= xmin;
660                 font->clip_rec.ymin= ymin;
661                 font->clip_rec.xmax= xmax;
662                 font->clip_rec.ymax= ymax;
663         }
664 }
665
666 void BLF_clipping_default(float xmin, float ymin, float xmax, float ymax)
667 {
668         FontBLF *font;
669
670         font= BLF_get(global_font_default);
671         if (font) {
672                 font->clip_rec.xmin= xmin;
673                 font->clip_rec.ymin= ymin;
674                 font->clip_rec.xmax= xmax;
675                 font->clip_rec.ymax= ymax;
676         }
677 }
678
679 void BLF_shadow(int fontid, int level, float r, float g, float b, float a)
680 {
681         FontBLF *font;
682
683         font= BLF_get(fontid);
684         if (font) {
685                 font->shadow= level;
686                 font->shadow_col[0]= r;
687                 font->shadow_col[1]= g;
688                 font->shadow_col[2]= b;
689                 font->shadow_col[3]= a;
690         }
691 }
692
693 void BLF_shadow_offset(int fontid, int x, int y)
694 {
695         FontBLF *font;
696
697         font= BLF_get(fontid);
698         if (font) {
699                 font->shadow_x= x;
700                 font->shadow_y= y;
701         }
702 }
703
704 void BLF_buffer(int fontid, float *fbuf, unsigned char *cbuf, int w, int h, int nch)
705 {
706         FontBLF *font;
707
708         font= BLF_get(fontid);
709         if (font) {
710                 font->b_fbuf= fbuf;
711                 font->b_cbuf= cbuf;
712                 font->bw= w;
713                 font->bh= h;
714                 font->bch= nch;
715         }
716 }
717
718 void BLF_buffer_col(int fontid, float r, float g, float b, float a)
719 {
720         FontBLF *font;
721
722         font= BLF_get(fontid);
723         if (font) {
724                 font->b_col[0]= r;
725                 font->b_col[1]= g;
726                 font->b_col[2]= b;
727                 font->b_col[3]= a;
728         }
729 }
730
731 void BLF_draw_buffer(int fontid, const char *str)
732 {
733         FontBLF *font= BLF_get(fontid);
734         if (font && font->glyph_cache && (font->b_fbuf || font->b_cbuf)) {
735                 blf_font_buffer(font, str);
736         }
737 }