Support for right-to-left fonts. Set (rtl #t) in
[supertux.git] / src / video / font.cpp
index c61ee43..90b32af 100644 (file)
@@ -1,12 +1,11 @@
-//  $Id$
-//
 //  SuperTux
 //  Copyright (C) 2006 Matthias Braun <matze@braunis.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 the Free Software Foundation; either version 2
-//  of the License, or (at your option) any later version.
+//  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
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
 //
 //  This program is distributed in the hope that it will be useful,
 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
 //  GNU General Public License for more details.
 //
 //  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.
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #include <config.h>
 
-#include <cstdlib>
-#include <cstring>
+#include <sstream>
+#include <stdlib.h>
+#include <string.h>
 #include <stdexcept>
+#include <SDL_image.h>
+#include <physfs.h>
 
+#include "lisp/list_iterator.hpp"
 #include "lisp/parser.hpp"
-#include "lisp/lisp.hpp"
-#include "screen.hpp"
-#include "font.hpp"
-#include "drawing_context.hpp"
-#include "log.hpp"
-
-Font::Font(const std::string& file, const std::string& shadowfile,
-           int w, int h, int shadowsize)
-    : chars(0), shadow_chars(0), w(w), h(h), shadowsize(shadowsize)
+#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 vline_empty(SDL_Surface* surface, int x, int start_y, int end_y, Uint8 threshold)
 {
-  chars = new Surface(file);
-  shadow_chars = new Surface(shadowfile);
+  Uint8* pixels = (Uint8*)surface->pixels;
 
-  first_char = 32;
-  char_count = ((int) chars->get_height() / h) * 16;
+  for(int y = start_y; y < end_y; ++y)
+  {
+    const Uint8& p = pixels[surface->pitch*y + x*surface->format->BytesPerPixel + 3];
+    if (p > threshold)
+    {
+      return false;
+    }
+  }
+  return true;
 }
 
-Font::~Font()
+} // namespace
+
+Font::Font(GlyphWidth glyph_width_,
+           const std::string& filename,
+           int shadowsize_) :
+  glyph_width(glyph_width_),
+  glyph_surfaces(),
+  shadow_surfaces(),
+  char_height(),
+  shadowsize(shadowsize_),
+  border(0),
+  rtl(false),
+  glyphs(65536)
 {
-  delete chars;
-  delete shadow_chars;
+  for(unsigned int i=0; i<65536;i++) glyphs[i].surface_idx = -1;
+
+  const std::string fontdir = FileSystem::dirname(filename);
+  const std::string fontname = FileSystem::basename(filename);
+
+  // 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_);
+    }
+  }
+  PHYSFS_freeList(rc);
 }
 
-float
-Font::get_text_width(const std::string& text) const
+void
+Font::loadFontFile(const std::string &filename)
 {
-  /** Let's calculate the size of the biggest paragraph */
-  std::string::size_type l, hl, ol;
-  hl = 0; l = 0;
-  while(true)
-    {
-    ol = l;
-    l = text.find("\n", l+1);
-    if(l == std::string::npos)
-      break;
-    if(hl < l-ol)
-      hl = l-ol;
+  lisp::Parser parser;
+  log_debug << "Loading font: " << filename << std::endl;
+  const lisp::Lisp* root = parser.parse(filename);
+  const lisp::Lisp* config_l = root->get_lisp("supertux-font");
+
+  if(!config_l) {
+    std::ostringstream msg;
+    msg << "Font file:" << filename << ": is not a supertux-font file";
+    throw std::runtime_error(msg.str());
+  }
+
+  int def_char_width=0;
+
+  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();
+    if( token == "surface" ) {
+      const lisp::Lisp * glyphs_val = iter.lisp();
+      int local_char_width;
+      bool monospaced;
+      GlyphWidth local_glyph_width;
+      std::string glyph_image;
+      std::string shadow_image;
+      std::vector<std::string> chars;
+      if( ! glyphs_val->get("glyph-width", local_char_width) ) {
+        local_char_width = def_char_width;
+      }
+      if( ! glyphs_val->get("monospace", monospaced ) ) {
+        local_glyph_width = glyph_width;
+      }
+      else {
+        if( monospaced ) local_glyph_width = FIXED;
+        else local_glyph_width = VARIABLE;
+      }
+      if( ! glyphs_val->get("glyphs", glyph_image) ) {
+        std::ostringstream msg;
+        msg << "Font:" << filename << ": missing glyphs image";
+        throw std::runtime_error(msg.str());
+      }
+      if( ! glyphs_val->get("shadows", shadow_image) ) {
+        std::ostringstream msg;
+        msg << "Font:" << filename << ": missing shadows image";
+        throw std::runtime_error(msg.str());
+      }
+      if( ! glyphs_val->get("chars", chars) || chars.size() == 0) {
+        std::ostringstream msg;
+        msg << "Font:" << filename << ": missing chars definition";
+        throw std::runtime_error(msg.str());
+      }
+
+      if( local_char_width==0 ) {
+        std::ostringstream msg;
+        msg << "Font:" << filename << ": misses glyph-width for some surface";
+        throw std::runtime_error(msg.str());
+      }
+
+      loadFontSurface(glyph_image, shadow_image, chars,
+                      local_glyph_width, local_char_width);
+    }
+  }
+}
+
+void
+Font::loadFontSurface(
+  const std::string &glyphimage,
+  const std::string &shadowimage,
+  const std::vector<std::string> &chars,
+  GlyphWidth glyph_width_,
+  int char_width
+  )
+{
+  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;
+
+  SDL_Surface *surface = NULL;
+
+  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);
+    if(surface == NULL) {
+      std::ostringstream msg;
+      msg << "Couldn't load image '" << glyphimage << "' :" << SDL_GetError();
+      throw std::runtime_error(msg.str());
+    }
+    SDL_LockSurface(surface);
+  }
+
+  for( unsigned int i = 0; i < chars.size(); i++) {
+    for(UTF8Iterator chr(chars[i]); !chr.done(); ++chr) {
+      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 || isdigit(*chr) )
+      {
+        glyph.rect    = Rectf(x, y, x + char_width, y + char_height);
+        glyph.offset  = Vector(0, 0);
+        glyph.advance = char_width;
+      }
+      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.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(hl == 0)
-    hl = text.size();
+    if( col>0 && col <= wrap ) {
+      col = 0;
+      row++;
+    }
+  }
+abort:
 
-  for (unsigned int i = 0; i < text.size(); i++)
-    if ((unsigned char) text[i] > 0xC2 && (unsigned char) text[i] < 0xC6)
-      hl--;  // control characters are a WASTE.
+  if( surface != NULL ) {
+    SDL_UnlockSurface(surface);
+    SDL_FreeSurface(surface);
+  }
+}
 
-  return hl * w;
+Font::~Font()
+{
 }
 
 float
-Font::get_text_height(const std::string& text) const
+Font::get_text_width(const std::string& text) const
 {
-  /** Let's calculate height of the text */
-  std::string::size_type l, hh;
-  hh = h; l = 0;
-  while(true)
+  float curr_width = 0;
+  float last_width = 0;
+
+  for(UTF8Iterator it(text); !it.done(); ++it)
+  {
+    if (*it == '\n')
     {
-    l = text.find("\n", l+1);
-    if(l == std::string::npos)
-      break;
-    hh += h + 2;
+      last_width = std::max(last_width, curr_width);
+      curr_width = 0;
     }
+    else
+    {
+      if( glyphs.at(*it).surface_idx != -1 )
+        curr_width += glyphs[*it].advance;
+      else
+        curr_width += glyphs[0x20].advance;
+    }
+  }
 
-  return hh;
+  return std::max(curr_width, last_width);
 }
 
 float
-Font::get_height() const
+Font::get_text_height(const std::string& text) const
 {
-  return h;
+  std::string::size_type text_height = char_height;
+
+  for(std::string::const_iterator it = text.begin(); it != text.end(); ++it)
+  { // since UTF8 multibyte characters are decoded with values
+    // outside the ASCII range there is no risk of overlapping and
+    // thus we don't need to decode the utf-8 string
+    if (*it == '\n')
+      text_height += char_height + 2;
+  }
+
+  return text_height;
 }
 
-std::string
-Font::wrap_to_width(const std::string& s, int max_width, std::string* overflow) const
+float
+Font::get_height() const
 {
-  return wrap_to_chars(s, max_width / w, overflow);
+  return char_height;
 }
 
 std::string
@@ -123,164 +327,125 @@ Font::wrap_to_chars(const std::string& s, int line_length, std::string* overflow
   return s;
 }
 
-void
-Font::draw(const std::string& text, const Vector& pos_, FontAlignment alignment,
-           DrawingEffect drawing_effect, float alpha) const
+std::string
+Font::wrap_to_width(const std::string& s_, float width, std::string* overflow)
 {
-  /* Cut lines changes into seperate strings, needed to support center/right text
-     alignments with break lines.
-     Feel free to replace this hack with a more elegant solution
-  */
-  char temp[1024];
-  std::string::size_type l, i, y;
-  bool done = false;
-  i = y = 0;
-
-  while(!done) {
-    l = text.find("\n", i);
-    if(l == std::string::npos) {
-      l = text.size();
-      done = true;
-    }
+  std::string s = s_;
 
-    if(l > sizeof(temp)-1)
-      l = sizeof(temp)-1;
-
-    temp[text.copy(temp, l - i, i)] = '\0';
-
-    // calculate X positions based on the alignment type
-    Vector pos = Vector(pos_);
-    if(alignment == CENTER_ALLIGN)
-      pos.x -= get_text_width(temp) / 2;
-    else if(alignment == RIGHT_ALLIGN)
-      pos.x -= get_text_width(temp);
-
-    draw_text(temp, pos + Vector(0,y), drawing_effect, alpha);
+  // if text is already smaller, return full text
+  if (get_text_width(s) <= width) {
+    if (overflow) *overflow = "";
+    return s;
+  }
 
-    i = l+1;
-    y += h + 2;
+  // if we can find a whitespace character to break at, return text up to this character
+  for (int i = s.length()-1; i >= 0; i--) {
+    std::string s2 = s.substr(0,i);
+    if (s[i] != ' ') continue;
+    if (get_text_width(s2) <= width) {
+      if (overflow) *overflow = s.substr(i+1);
+      return s.substr(0, i);
+    }
   }
+
+  // FIXME: hard-wrap at width, taking care of multibyte characters
+  if (overflow) *overflow = "";
+  return s;
 }
 
 void
-Font::draw_text(const std::string& text, const Vector& pos,
-                DrawingEffect drawing_effect, float alpha) const
+Font::draw(Renderer *renderer, const std::string& text, const Vector& pos_,
+           FontAlignment alignment, DrawingEffect drawing_effect, Color color,
+           float alpha) const
 {
-  if(shadowsize > 0)
-    draw_chars(shadow_chars, text, pos + Vector(shadowsize, shadowsize),
-               drawing_effect, alpha);
+  float x = pos_.x;
+  float y = pos_.y;
 
-  draw_chars(chars, text, pos, drawing_effect, alpha);
-}
+  std::string::size_type last = 0;
+  for(std::string::size_type i = 0;; ++i)
+  {
+    if (text[i] == '\n' || i == text.size())
+    {
+      std::string temp = text.substr(last, i - last);
 
-namespace {
+      // calculate X positions based on the alignment type
+      Vector pos = Vector(x, y);
 
-/**
- * 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);
-}
+      if(alignment == ALIGN_CENTER)
+        pos.x -= get_text_width(temp) / 2;
+      else if(alignment == ALIGN_RIGHT)
+        pos.x -= get_text_width(temp);
 
-/**
- * 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];
+      // Cast font position to integer to get a clean drawing result and
+      // no blurring as we would get with subpixel positions
+      pos.x = static_cast<int>(pos.x);
 
-  if (has_multibyte_mark(c1)) std::runtime_error("Malformed utf-8 sequence");
+      draw_text(renderer, temp, pos, drawing_effect, color, alpha);
 
-  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);
+      if (i == text.size())
+        break;
+
+      y += char_height + 2;
+      last = i + 1;
+    }
   }
-  throw std::runtime_error("Malformed utf-8 sequence");
 }
 
+void
+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, rtl ? std::string(text.rbegin(), text.rend()) : text,
+               pos + Vector(shadowsize, shadowsize), drawing_effect, Color(1,1,1), alpha);
+
+  draw_chars(renderer, true, rtl ? std::string(text.rbegin(), text.rend()) : text, pos, drawing_effect, color, alpha);
 }
 
 void
-Font::draw_chars(Surface* pchars, const std::string& text, const Vector& pos,
-                 DrawingEffect drawing_effect, float alpha) const
+Font::draw_chars(Renderer *renderer, bool notshadow, const std::string& text,
+                 const Vector& pos, DrawingEffect drawing_effect, Color color,
+                 float alpha) const
 {
   Vector p = pos;
-  size_t i = 0;
-  while(i < text.size()) {
-    uint32_t c;
-    try {
-     c = decode_utf8(text, i);
-    }
-    catch (std::runtime_error) {
-     log_debug << "Malformed utf-8 sequence beginning with " << *((uint32_t*)(text.c_str() + i)) << " found " << std::endl;
-     c = 0;
-     i++;
-    }
-    ssize_t font_index;
 
-    // a non-printable character?
-    if(c == '\n') {
+  for(UTF8Iterator it(text); !it.done(); ++it)
+  {
+    if(*it == '\n')
+    {
       p.x = pos.x;
-      p.y += h + 2;
-      continue;
+      p.y += char_height + 2;
     }
-    if(c == ' ') {
-      p.x += w;
-      continue;
+    else if(*it == ' ')
+    {
+      p.x += glyphs[0x20].advance;
     }
+    else
+    {
+      Glyph glyph;
+      if( glyphs.at(*it).surface_idx != -1 )
+        glyph = glyphs[*it];
+      else
+        glyph = glyphs[0x20];
 
-    font_index = c - first_char;
-    // we don't have the control chars 0x80-0xa0 in the font
-    if(c >= 0x80) {
-      font_index -= 32;
-      if(c <= 0xa0) {
-        log_debug << "Unsupported utf-8 character '" << c << "' found" << std::endl;
-        font_index = 0;
-      }
-    }
+      DrawingRequest request;
 
-    if(font_index < 0 || font_index >= (ssize_t) char_count) {
-      log_debug << "Unsupported utf-8 character found" << std::endl;
-      font_index = 0;
-    }
+      request.pos = p + glyph.offset;
+      request.drawing_effect = drawing_effect;
+      request.color = color;
+      request.alpha = alpha;
+
+      SurfacePartRequest surfacepartrequest;
+      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();
 
-    int source_x = (font_index % 16) * w;
-    int source_y = (font_index / 16) * h;
-    pchars->draw_part(source_x, source_y, p.x, p.y, w, h, alpha,
-                      drawing_effect);
-    p.x += w;
+      request.request_data = &surfacepartrequest;
+      renderer->draw_surface_part(request);
+
+      p.x += glyph.advance;
+    }
   }
 }
+
+/* EOF */