Support for right-to-left fonts. Set (rtl #t) in
[supertux.git] / src / video / font.cpp
index 4aac58a..90b32af 100644 (file)
@@ -1,6 +1,6 @@
 //  SuperTux
 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
-//                     Ingo Ruhnke <grumbel@gmx.de>
+//                     Ingo Ruhnke <grumbel@gmail.com>
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
 
 #include <config.h>
 
+#include <sstream>
 #include <stdlib.h>
 #include <string.h>
 #include <stdexcept>
 #include <SDL_image.h>
 #include <physfs.h>
 
-#include "physfs/physfs_sdl.hpp"
-
-#include "util/file_system.hpp"
-
 #include "lisp/list_iterator.hpp"
 #include "lisp/parser.hpp"
+#include "physfs/physfs_sdl.hpp"
 #include "supertux/screen.hpp"
+#include "util/file_system.hpp"
 #include "util/log.hpp"
+#include "util/utf8_iterator.hpp"
 #include "video/drawing_context.hpp"
+#include "video/drawing_request.hpp"
 #include "video/font.hpp"
 #include "video/renderer.hpp"
 
 namespace {
-bool     has_multibyte_mark(unsigned char c);
-uint32_t decode_utf8(const std::string& text, size_t& p);
-std::string encode_utf8(uint32_t code);
-
-struct UTF8Iterator
-{
-  const std::string&     text;
-  std::string::size_type pos;
-  uint32_t chr;
-
-  UTF8Iterator(const std::string& text_) :
-    text(text_),
-    pos(0),
-    chr()
-  {
-    try {
-      chr = decode_utf8(text, pos);
-    } catch (std::exception) {
-      log_debug << "Malformed utf-8 sequence beginning with " << *((uint32_t*)(text.c_str() + pos)) << " found " << std::endl;
-      chr = 0;
-    }
-  }
-
-  bool done() const
-  {
-    return pos > text.size();
-  }
-
-  UTF8Iterator& operator++() {
-    try {
-      chr = decode_utf8(text, pos);
-    } catch (std::exception) {
-      log_debug << "Malformed utf-8 sequence beginning with " << *((uint32_t*)(text.c_str() + pos)) << " found " << std::endl;
-      chr = 0;
-      ++pos;
-    }
-
-    return *this;
-  }
-
-  uint32_t operator*() const {
-    return chr;
-  }
-};
 
 bool vline_empty(SDL_Surface* surface, int x, int start_y, int end_y, Uint8 threshold)
 {
@@ -95,6 +52,7 @@ bool vline_empty(SDL_Surface* surface, int x, int start_y, int end_y, Uint8 thre
   }
   return true;
 }
+
 } // namespace
 
 Font::Font(GlyphWidth glyph_width_,
@@ -105,6 +63,8 @@ Font::Font(GlyphWidth glyph_width_,
   shadow_surfaces(),
   char_height(),
   shadowsize(shadowsize_),
+  border(0),
+  rtl(false),
   glyphs(65536)
 {
   for(unsigned int i=0; i<65536;i++) glyphs[i].surface_idx = -1;
@@ -115,15 +75,15 @@ Font::Font(GlyphWidth glyph_width_,
   // scan for prefix-filename in addons search path
   char **rc = PHYSFS_enumerateFiles(fontdir.c_str());
   for (char **i = rc; *i != NULL; i++) {
-    std::string filename(*i);
-    if( filename.rfind(fontname) != std::string::npos ) {
-      loadFontFile(fontdir + filename);
+    std::string filename_(*i);
+    if( filename_.rfind(fontname) != std::string::npos ) {
+      loadFontFile(fontdir + filename_);
     }
   }
   PHYSFS_freeList(rc);
 }
 
-void 
+void
 Font::loadFontFile(const std::string &filename)
 {
   lisp::Parser parser;
@@ -142,13 +102,16 @@ Font::loadFontFile(const std::string &filename)
   if( !config_l->get("glyph-width",def_char_width) ) {
     log_warning << "Font:"<< filename << ": misses default glyph-width" << std::endl;
   }
-  
+
   if( !config_l->get("glyph-height",char_height) ) {
     std::ostringstream msg;
     msg << "Font:" << filename << ": misses glyph-height";
     throw std::runtime_error(msg.str());
   }
 
+  config_l->get("glyph-border", border);
+  config_l->get("rtl", rtl);
+
   lisp::ListIterator iter(config_l);
   while(iter.next()) {
     const std::string& token = iter.item();
@@ -198,28 +161,28 @@ Font::loadFontFile(const std::string &filename)
   }
 }
 
-void 
+void
 Font::loadFontSurface(
   const std::string &glyphimage,
   const std::string &shadowimage,
   const std::vector<std::string> &chars,
-  GlyphWidth glyph_width,
+  GlyphWidth glyph_width_,
   int char_width
   )
 {
-  Surface glyph_surface("images/engine/fonts/" + glyphimage);
-  Surface shadow_surface("images/engine/fonts/" + shadowimage);
+  SurfacePtr glyph_surface  = Surface::create("images/engine/fonts/" + glyphimage);
+  SurfacePtr shadow_surface = Surface::create("images/engine/fonts/" + shadowimage);
 
   int surface_idx = glyph_surfaces.size();
   glyph_surfaces.push_back(glyph_surface);
   shadow_surfaces.push_back(shadow_surface);
 
   int row=0, col=0;
-  int wrap = glyph_surface.get_width() / char_width;
+  int wrap = glyph_surface->get_width() / char_width;
+
   SDL_Surface *surface = NULL;
-  
-  if( glyph_width == VARIABLE ) {
+
+  if( glyph_width_ == VARIABLE ) {
     //this does not work:
     // surface = ((SDL::Texture *)glyph_surface.get_texture())->get_texture();
     surface = IMG_Load_RW(get_physfs_SDLRWops("images/engine/fonts/"+glyphimage), 1);
@@ -233,44 +196,58 @@ Font::loadFontSurface(
 
   for( unsigned int i = 0; i < chars.size(); i++) {
     for(UTF8Iterator chr(chars[i]); !chr.done(); ++chr) {
-      int y = row * char_height;
-      int x = col * char_width;
+      int y = row * (char_height + 2*border) + border;
+      int x = col * (char_width + 2*border) + border;
       if( ++col == wrap ) { col=0; row++; }
       if( *chr == 0x0020 && glyphs[0x20].surface_idx != -1) continue;
-        
+
       Glyph glyph;
       glyph.surface_idx   = surface_idx;
-      
-      if( glyph_width == FIXED ) {
-        glyph.rect    = Rect(x, y, x + char_width, y + char_height);
+
+      if( glyph_width_ == FIXED || isdigit(*chr) )
+      {
+        glyph.rect    = Rectf(x, y, x + char_width, y + char_height);
         glyph.offset  = Vector(0, 0);
         glyph.advance = char_width;
       }
-      else {
+      else
+      {
+        if (y + char_height > surface->h)
+        {
+          log_warning << "error: font definition contains more letter then the images: " << glyphimage << std::endl;
+          goto abort;
+        }
+
         int left = x;
         while (left < x + char_width && vline_empty(surface, left, y, y + char_height, 64))
           left += 1;
         int right = x + char_width - 1;
         while (right > left && vline_empty(surface, right, y, y + char_height, 64))
           right -= 1;
-          
+
         if (left <= right)
-          glyph.rect = Rect(left,  y, right+1, y + char_height);
-        else // glyph is completely transparent
-          glyph.rect = Rect(x,  y, x + char_width, y + char_height);
-        
-        glyph.offset  = Vector(0, 0);
-        glyph.advance = glyph.rect.get_width() + 1; // FIXME: might be useful to make spacing configurable
+        {
+          glyph.offset  = Vector(x-left, 0);
+          glyph.advance = right - left + 1 + 1; // FIXME: might be useful to make spacing configurable
+        }
+        else
+        { // glyph is completly transparent
+          glyph.offset  = Vector(0, 0);
+          glyph.advance = char_width + 1; // FIXME: might be useful to make spacing configurable
+        }
+
+        glyph.rect = Rectf(x,  y, x + char_width, y + char_height);
       }
 
       glyphs[*chr] = glyph;
     }
-    if( col>0 && col <= wrap ) { 
+    if( col>0 && col <= wrap ) {
       col = 0;
       row++;
     }
   }
-  
+abort:
+
   if( surface != NULL ) {
     SDL_UnlockSurface(surface);
     SDL_FreeSurface(surface);
@@ -298,7 +275,7 @@ Font::get_text_width(const std::string& text) const
     {
       if( glyphs.at(*it).surface_idx != -1 )
         curr_width += glyphs[*it].advance;
-      else 
+      else
         curr_width += glyphs[0x20].advance;
     }
   }
@@ -370,7 +347,7 @@ Font::wrap_to_width(const std::string& s_, float width, std::string* overflow)
       return s.substr(0, i);
     }
   }
-  
+
   // FIXME: hard-wrap at width, taking care of multibyte characters
   if (overflow) *overflow = "";
   return s;
@@ -419,10 +396,10 @@ Font::draw_text(Renderer *renderer, const std::string& text, const Vector& pos,
                 DrawingEffect drawing_effect, Color color, float alpha) const
 {
   if(shadowsize > 0)
-    draw_chars(renderer, false, text, 
+    draw_chars(renderer, false, rtl ? std::string(text.rbegin(), text.rend()) : text,
                pos + Vector(shadowsize, shadowsize), drawing_effect, Color(1,1,1), alpha);
 
-  draw_chars(renderer, true, text, pos, drawing_effect, color, alpha);
+  draw_chars(renderer, true, rtl ? std::string(text.rbegin(), text.rend()) : text, pos, drawing_effect, color, alpha);
 }
 
 void
@@ -448,7 +425,7 @@ Font::draw_chars(Renderer *renderer, bool notshadow, const std::string& text,
       Glyph glyph;
       if( glyphs.at(*it).surface_idx != -1 )
         glyph = glyphs[*it];
-      else 
+      else
         glyph = glyphs[0x20];
 
       DrawingRequest request;
@@ -459,9 +436,9 @@ Font::draw_chars(Renderer *renderer, bool notshadow, const std::string& text,
       request.alpha = alpha;
 
       SurfacePartRequest surfacepartrequest;
-      surfacepartrequest.size = glyph.rect.p2 - glyph.rect.p1;
-      surfacepartrequest.source = glyph.rect.p1;
-      surfacepartrequest.surface = notshadow ? &(glyph_surfaces[glyph.surface_idx]) : &(shadow_surfaces[glyph.surface_idx]);
+      surfacepartrequest.srcrect = glyph.rect;
+      surfacepartrequest.dstsize = glyph.rect.get_size();
+      surfacepartrequest.surface = notshadow ? glyph_surfaces[glyph.surface_idx].get() : shadow_surfaces[glyph.surface_idx].get();
 
       request.request_data = &surfacepartrequest;
       renderer->draw_surface_part(request);
@@ -471,66 +448,4 @@ Font::draw_chars(Renderer *renderer, bool notshadow, const std::string& text,
   }
 }
 
-namespace {
-
-/**
- * returns true if this byte matches a bitmask of 10xx.xxxx, i.e. it is the 2nd, 3rd or 4th byte of a multibyte utf8 string
- */
-bool has_multibyte_mark(unsigned char c) {
-  return ((c & 0300) == 0200);
-}
-
-/**
- * gets unicode character at byte position @a p of UTF-8 encoded @a
- * text, then advances @a p to the next character.
- *
- * @throws std::runtime_error if decoding fails.
- * See unicode standard section 3.10 table 3-5 and 3-6 for details.
- */
-uint32_t decode_utf8(const std::string& text, size_t& p)
-{
-  uint32_t c1 = (unsigned char) text[p+0];
-
-  if (has_multibyte_mark(c1)) std::runtime_error("Malformed utf-8 sequence");
-
-  if ((c1 & 0200) == 0000) {
-    // 0xxx.xxxx: 1 byte sequence
-    p+=1;
-    return c1;
-  }
-  else if ((c1 & 0340) == 0300) {
-    // 110x.xxxx: 2 byte sequence
-    if(p+1 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
-    uint32_t c2 = (unsigned char) text[p+1];
-    if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
-    p+=2;
-    return (c1 & 0037) << 6 | (c2 & 0077);
-  }
-  else if ((c1 & 0360) == 0340) {
-    // 1110.xxxx: 3 byte sequence
-    if(p+2 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
-    uint32_t c2 = (unsigned char) text[p+1];
-    uint32_t c3 = (unsigned char) text[p+2];
-    if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
-    if (!has_multibyte_mark(c3)) throw std::runtime_error("Malformed utf-8 sequence");
-    p+=3;
-    return (c1 & 0017) << 12 | (c2 & 0077) << 6 | (c3 & 0077);
-  }
-  else if ((c1 & 0370) == 0360) {
-    // 1111.0xxx: 4 byte sequence
-    if(p+3 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
-    uint32_t c2 = (unsigned char) text[p+1];
-    uint32_t c3 = (unsigned char) text[p+2];
-    uint32_t c4 = (unsigned char) text[p+4];
-    if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
-    if (!has_multibyte_mark(c3)) throw std::runtime_error("Malformed utf-8 sequence");
-    if (!has_multibyte_mark(c4)) throw std::runtime_error("Malformed utf-8 sequence");
-    p+=4;
-    return (c1 & 0007) << 18 | (c2 & 0077) << 12 | (c3 & 0077) << 6 | (c4 & 0077);
-  }
-  throw std::runtime_error("Malformed utf-8 sequence");
-}
-
-} // namespace
-
 /* EOF */