doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / blenfont / intern / blf_font.c
index 8721e49..7333522 100644 (file)
@@ -1,5 +1,5 @@
-/**
- * $Id:
+/*
+ * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
@@ -15,7 +15,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2009 Blender Foundation.
  * All rights reserved.
 
 #include "MEM_guardedalloc.h"
 
-#include "DNA_listBase.h"
 #include "DNA_vec_types.h"
 
-#include "BKE_utildefines.h"
 
 #include "BLI_blenlib.h"
 #include "BLI_linklist.h"      /* linknode */
-#include "BLI_string.h"
-#include "BLI_arithb.h"
+#include "BLI_math.h"
 
 #include "BIF_gl.h"
 #include "BLF_api.h"
 #include "blf_internal.h"
 
 
-/* freetype2 handle. */
-FT_Library global_ft_lib;
+/* freetype2 handle ONLY for this file!. */
+static FT_Library ft_lib;
 
 int blf_font_init(void)
 {
-       return(FT_Init_FreeType(&global_ft_lib));
+       return(FT_Init_FreeType(&ft_lib));
 }
 
 void blf_font_exit(void)
 {
-       FT_Done_FreeType(global_ft_lib);
+       FT_Done_FreeType(ft_lib);
 }
 
 void blf_font_size(FontBLF *font, int size, int dpi)
@@ -95,7 +92,7 @@ void blf_font_size(FontBLF *font, int size, int dpi)
        }
 }
 
-void blf_font_draw(FontBLF *font, char *str)
+void blf_font_draw(FontBLF *font, const char *str, unsigned int len)
 {
        unsigned int c;
        GlyphBLF *g, *g_prev;
@@ -113,7 +110,7 @@ void blf_font_draw(FontBLF *font, char *str)
        has_kerning= FT_HAS_KERNING(font->face);
        g_prev= NULL;
 
-       while (str[i]) {
+       while (str[i] && i < len) {
                c= blf_utf8_next((unsigned char *)str, &i);
                if (c == 0)
                        break;
@@ -149,27 +146,90 @@ void blf_font_draw(FontBLF *font, char *str)
        }
 }
 
-void blf_font_buffer(FontBLF *font, char *str)
+/* faster version of blf_font_draw, ascii only for view dimensions */
+void blf_font_draw_ascii(FontBLF *font, const char *str, unsigned int len)
 {
-       unsigned char *data, *cbuf;
+       char c;
+       GlyphBLF *g, *g_prev;
+       FT_Vector delta;
+       FT_UInt glyph_index;
+       int pen_x, pen_y;
+       int i, has_kerning, st;
+
+       if (!font->glyph_cache)
+               return;
+
+       pen_x= 0;
+       pen_y= 0;
+       has_kerning= FT_HAS_KERNING(font->face);
+       g_prev= NULL;
+
+       /* build ascii on demand */
+       if(font->glyph_ascii_table['0']==NULL) {
+               for(i=0; i<256; i++) {
+                       g= blf_glyph_search(font->glyph_cache, i);
+                       if (!g) {
+                               glyph_index= FT_Get_Char_Index(font->face, i);
+                               g= blf_glyph_add(font, glyph_index, i);
+                       }
+                       font->glyph_ascii_table[i]= g;
+               }
+       }
+       
+       while ((c= *(str++)) && len--) {
+               g= font->glyph_ascii_table[c];
+
+               /* if we don't found a glyph, skip it. */
+               if (!g)
+                       continue;
+
+               if (has_kerning && g_prev) {
+                       delta.x= 0;
+                       delta.y= 0;
+
+                       if (font->flags & BLF_KERNING_DEFAULT)
+                               st= FT_Get_Kerning(font->face, g_prev->idx, g->idx, ft_kerning_default, &delta);
+                       else
+                               st= FT_Get_Kerning(font->face, g_prev->idx, g->idx, FT_KERNING_UNFITTED, &delta);
+
+                       if (st == 0)
+                               pen_x += delta.x >> 6;
+               }
+
+               /* do not return this loop if clipped, we want every character tested */
+               blf_glyph_render(font, g, (float)pen_x, (float)pen_y);
+
+               pen_x += g->advance;
+               g_prev= g;
+       }
+}
+
+void blf_font_buffer(FontBLF *font, const char *str)
+{
+       unsigned char *cbuf;
        unsigned int c;
+       unsigned char b_col_char[3];
        GlyphBLF *g, *g_prev;
        FT_Vector delta;
        FT_UInt glyph_index;
        float a, *fbuf;
-       int pen_x, pen_y, y, x, yb, diff;
+       int pen_x, y, x, yb;
        int i, has_kerning, st, chx, chy;
 
-       if (!font->glyph_cache)
+       if (!font->glyph_cache || (!font->b_fbuf && !font->b_cbuf))
                return;
-
+       
        i= 0;
        pen_x= (int)font->pos[0];
-       pen_y= (int)font->pos[1];
        has_kerning= FT_HAS_KERNING(font->face);
        g_prev= NULL;
+       
+       b_col_char[0]= font->b_col[0] * 255;
+       b_col_char[1]= font->b_col[1] * 255;
+       b_col_char[2]= font->b_col[2] * 255;
 
        while (str[i]) {
+               int pen_y;
                c= blf_utf8_next((unsigned char *)str, &i);
                if (c == 0)
                        break;
@@ -198,47 +258,43 @@ void blf_font_buffer(FontBLF *font, char *str)
                }
 
                chx= pen_x + ((int)g->pos_x);
-               diff= g->height - ((int)g->pos_y);
-               if (diff > 0) {
-                       if (g->pitch < 0)
-                               pen_y += diff;
-                       else
-                               pen_y -= diff;
+               chy= (int)font->pos[1] + g->height;
+
+               if (g->pitch < 0) {
+                       pen_y = (int)font->pos[1] + (g->height - (int)g->pos_y);
                }
-               else if (diff < 0) {
-                       if (g->pitch < 0)
-                               pen_y -= diff;
-                       else
-                               pen_y += diff;
+               else {
+                       pen_y = (int)font->pos[1] - (g->height - (int)g->pos_y);
                }
 
-               if (g->pitch < 0)
-                       chy= pen_y - ((int)g->pos_y);
-               else
-                       chy= pen_y + ((int)g->pos_y);
-
-               if (font->b_fbuf) {
-                       if (chx >= 0 && chx < font->bw && pen_y >= 0 && pen_y < font->bh) {
-                               if (g->pitch < 0)
-                                       yb= 0;
-                               else
-                                       yb= g->height-1;
-
-                               for (y= 0; y < g->height; y++) {
-                                       for (x= 0; x < g->width; x++) {
-                                               fbuf= font->b_fbuf + font->bch * ((chx + x) + ((pen_y + y)*font->bw));
-                                               data= g->bitmap + x + (yb * g->pitch);
-                                               a= data[0]/255.0f;
-
-                                               if (a == 1.0) {
-                                                       fbuf[0]= font->b_col[0];
-                                                       fbuf[1]= font->b_col[1];
-                                                       fbuf[2]= font->b_col[2];
-                                               }
-                                               else {
-                                                       fbuf[0]= (font->b_col[0]*a) + (fbuf[0] * (1-a));
-                                                       fbuf[1]= (font->b_col[1]*a) + (fbuf[1] * (1-a));
-                                                       fbuf[2]= (font->b_col[2]*a) + (fbuf[2] * (1-a));
+               if ((chx + g->width) >= 0 && chx < font->bw && (pen_y + g->height) >= 0 && pen_y < font->bh) {
+                       /* dont draw beyond the buffer bounds */
+                       int width_clip= g->width;
+                       int height_clip= g->height;
+
+                       if (width_clip + chx > font->bw)        width_clip  -= chx + width_clip - font->bw;
+                       if (height_clip + pen_y > font->bh) height_clip -= pen_y + height_clip - font->bh;
+
+                       yb= g->pitch < 0 ? 0 : g->height-1;
+                       
+                       if (font->b_fbuf) {
+                               for (y=(chy >= 0 ? 0:-chy); y < height_clip; y++) {
+                                       for (x=(chx >= 0 ? 0:-chx); x < width_clip; x++) {
+                                               
+                                               a= *(g->bitmap + x + (yb * g->pitch)) / 255.0f;
+
+                                               if(a > 0.0f) {
+                                                       fbuf= font->b_fbuf + font->bch * ((chx + x) + ((pen_y + y)*font->bw));
+                                                       if (a >= 1.0f) {
+                                                               fbuf[0]= font->b_col[0];
+                                                               fbuf[1]= font->b_col[1];
+                                                               fbuf[2]= font->b_col[2];
+                                                       }
+                                                       else {
+                                                               fbuf[0]= (font->b_col[0]*a) + (fbuf[0] * (1-a));
+                                                               fbuf[1]= (font->b_col[1]*a) + (fbuf[1] * (1-a));
+                                                               fbuf[2]= (font->b_col[2]*a) + (fbuf[2] * (1-a));
+                                                       }
                                                }
                                        }
 
@@ -248,30 +304,24 @@ void blf_font_buffer(FontBLF *font, char *str)
                                                yb--;
                                }
                        }
-               }
 
-               if (font->b_cbuf) {
-                       if (chx >= 0 && chx < font->bw && pen_y >= 0 && pen_y < font->bh) {
-                               if (g->pitch < 0)
-                                       yb= 0;
-                               else
-                                       yb= g->height-1;
-
-                               for (y= 0; y < g->height; y++) {
-                                       for (x= 0; x < g->width; x++) {
-                                               cbuf= font->b_cbuf + font->bch * ((chx + x) + ((pen_y + y)*font->bw));
-                                               data= g->bitmap + x + (yb * g->pitch);
-                                               a= data[0];
-
-                                               if (a == 256) {
-                                                       cbuf[0]= font->b_col[0];
-                                                       cbuf[1]= font->b_col[1];
-                                                       cbuf[2]= font->b_col[2];
-                                               }
-                                               else {
-                                                       cbuf[0]= (font->b_col[0]*a) + (cbuf[0] * (256-a));
-                                                       cbuf[1]= (font->b_col[1]*a) + (cbuf[1] * (256-a));
-                                                       cbuf[2]= (font->b_col[2]*a) + (cbuf[2] * (256-a));
+                       if (font->b_cbuf) {
+                               for (y= 0; y < height_clip; y++) {
+                                       for (x= 0; x < width_clip; x++) {
+                                               a= *(g->bitmap + x + (yb * g->pitch)) / 255.0f;
+
+                                               if(a > 0.0f) {
+                                                       cbuf= font->b_cbuf + font->bch * ((chx + x) + ((pen_y + y)*font->bw));
+                                                       if (a >= 1.0f) {
+                                                               cbuf[0]= b_col_char[0];
+                                                               cbuf[1]= b_col_char[1];
+                                                               cbuf[2]= b_col_char[2];
+                                                       }
+                                                       else {
+                                                               cbuf[0]= (b_col_char[0]*a) + (cbuf[0] * (1-a));
+                                                               cbuf[1]= (b_col_char[1]*a) + (cbuf[1] * (1-a));
+                                                               cbuf[2]= (b_col_char[2]*a) + (cbuf[2] * (1-a));
+                                                       }
                                                }
                                        }
 
@@ -283,25 +333,12 @@ void blf_font_buffer(FontBLF *font, char *str)
                        }
                }
 
-               if (diff > 0) {
-                       if (g->pitch < 0)
-                               pen_x -= diff;
-                       else
-                               pen_y += diff;
-               }
-               else if (diff < 0) {
-                       if (g->pitch < 0)
-                               pen_x += diff;
-                       else
-                               pen_y -= diff;
-               }
-
                pen_x += g->advance;
                g_prev= g;
        }
 }
 
-void blf_font_boundbox(FontBLF *font, char *str, rctf *box)
+void blf_font_boundbox(FontBLF *font, const char *str, rctf *box)
 {
        unsigned int c;
        GlyphBLF *g, *g_prev;
@@ -380,37 +417,59 @@ void blf_font_boundbox(FontBLF *font, char *str, rctf *box)
        }
 }
 
-void blf_font_width_and_height(FontBLF *font, char *str, float *width, float *height)
+void blf_font_width_and_height(FontBLF *font, const char *str, float *width, float *height)
 {
+       float xa, ya;
        rctf box;
 
        if (font->glyph_cache) {
+               if (font->flags & BLF_ASPECT) {
+                       xa= font->aspect[0];
+                       ya= font->aspect[1];
+               }
+               else {
+                       xa= 1.0f;
+                       ya= 1.0f;
+               }
+
                blf_font_boundbox(font, str, &box);
-               *width= ((box.xmax - box.xmin) * font->aspect);
-               *height= ((box.ymax - box.ymin) * font->aspect);
+               *width= ((box.xmax - box.xmin) * xa);
+               *height= ((box.ymax - box.ymin) * ya);
        }
 }
 
-float blf_font_width(FontBLF *font, char *str)
+float blf_font_width(FontBLF *font, const char *str)
 {
+       float xa;
        rctf box;
 
        if (!font->glyph_cache)
                return(0.0f);
 
+       if (font->flags & BLF_ASPECT)
+               xa= font->aspect[0];
+       else
+               xa= 1.0f;
+
        blf_font_boundbox(font, str, &box);
-       return((box.xmax - box.xmin) * font->aspect);
+       return((box.xmax - box.xmin) * xa);
 }
 
-float blf_font_height(FontBLF *font, char *str)
+float blf_font_height(FontBLF *font, const char *str)
 {
+       float ya;
        rctf box;
 
        if (!font->glyph_cache)
                return(0.0f);
 
+       if (font->flags & BLF_ASPECT)
+               ya= font->aspect[1];
+       else
+               ya= 1.0f;
+
        blf_font_boundbox(font, str, &box);
-       return((box.ymax - box.ymin) * font->aspect);
+       return((box.ymax - box.ymin) * ya);
 }
 
 float blf_font_fixed_width(FontBLF *font)
@@ -455,11 +514,18 @@ void blf_font_free(FontBLF *font)
 
 static void blf_font_fill(FontBLF *font)
 {
-       font->aspect= 1.0f;
+       int i;
+
+       font->aspect[0]= 1.0f;
+       font->aspect[1]= 1.0f;
+       font->aspect[2]= 1.0f;
        font->pos[0]= 0.0f;
        font->pos[1]= 0.0f;
        font->angle= 0.0f;
-       Mat4One(font->mat);
+
+       for (i= 0; i < 16; i++)
+               font->m[i]= 0;
+
        font->clip_rec.xmin= 0.0f;
        font->clip_rec.xmax= 0.0f;
        font->clip_rec.ymin= 0.0f;
@@ -481,16 +547,19 @@ static void blf_font_fill(FontBLF *font)
        font->b_col[1]= 0;
        font->b_col[2]= 0;
        font->b_col[3]= 0;
+       font->ft_lib= ft_lib;
+
+       memset(font->glyph_ascii_table, 0, sizeof(font->glyph_ascii_table));
 }
 
-FontBLF *blf_font_new(char *name, char *filename)
+FontBLF *blf_font_new(const char *name, const char *filename)
 {
        FontBLF *font;
        FT_Error err;
        char *mfile;
 
        font= (FontBLF *)MEM_mallocN(sizeof(FontBLF), "blf_font_new");
-       err= FT_New_Face(global_ft_lib, filename, 0, &font->face);
+       err= FT_New_Face(ft_lib, filename, 0, &font->face);
        if (err) {
                MEM_freeN(font);
                return(NULL);
@@ -526,13 +595,13 @@ void blf_font_attach_from_mem(FontBLF *font, const unsigned char *mem, int mem_s
        FT_Attach_Stream(font->face, &open);
 }
 
-FontBLF *blf_font_new_from_mem(char *name, unsigned char *mem, int mem_size)
+FontBLF *blf_font_new_from_mem(const char *name, unsigned char *mem, int mem_size)
 {
        FontBLF *font;
        FT_Error err;
 
        font= (FontBLF *)MEM_mallocN(sizeof(FontBLF), "blf_font_new_from_mem");
-       err= FT_New_Memory_Face(global_ft_lib, mem, mem_size, 0, &font->face);
+       err= FT_New_Memory_Face(ft_lib, mem, mem_size, 0, &font->face);
        if (err) {
                MEM_freeN(font);
                return(NULL);