src/video/font.cpp

   1 //  $Id: font.cpp 2298 2005-03-30 12:01:02Z matzebraun $
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2004 Tobias Glaesser <tobi.web@gmx.de>
   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
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 //  02111-1307, USA.
  20 #include <config.h>
  21
  22 #include <cstdlib>
  23 #include <cstring>
  24 #include <stdexcept>
  25
  26 #include "lisp/parser.hpp"
  27 #include "lisp/lisp.hpp"
  28 #include "screen.hpp"
  29 #include "font.hpp"
  30 #include "drawing_context.hpp"
  31 #include "log.hpp"
  32
  33 Font::Font(const std::string& file, const std::string& shadowfile,
  34            int w, int h, int shadowsize)
  35     : chars(0), shadow_chars(0), w(w), h(h), shadowsize(shadowsize)
  36 {
  37   chars = new Surface(file);
  38   shadow_chars = new Surface(shadowfile);
  39
  40   first_char = 32;
  41   char_count = ((int) chars->get_height() / h) * 16;
  42 }
  43
  44 Font::~Font()
  45 {
  46   delete chars;
  47   delete shadow_chars;
  48 }
  49
  50 float
  51 Font::get_text_width(const std::string& text) const
  52 {
  53   /** Let's calculate the size of the biggest paragraph */
  54   std::string::size_type l, hl, ol;
  55   hl = 0; l = 0;
  56   while(true)
  57     {
  58     ol = l;
  59     l = text.find("\n", l+1);
  60     if(l == std::string::npos)
  61       break;
  62     if(hl < l-ol)
  63       hl = l-ol;
  64     }
  65   if(hl == 0)
  66     hl = text.size();
  67
  68   for (unsigned int i = 0; i < text.size(); i++)
  69     if ((unsigned char) text[i] > 0xC2 && (unsigned char) text[i] < 0xC6)
  70       hl--;  // control characters are a WASTE.
  71
  72   return hl * w;
  73 }
  74
  75 float
  76 Font::get_text_height(const std::string& text) const
  77 {
  78   /** Let's calculate height of the text */
  79   std::string::size_type l, hh;
  80   hh = h; l = 0;
  81   while(true)
  82     {
  83     l = text.find("\n", l+1);
  84     if(l == std::string::npos)
  85       break;
  86     hh += h + 2;
  87     }
  88
  89   return hh;
  90 }
  91
  92 float
  93 Font::get_height() const
  94 {
  95   return h;
  96 }
  97
  98 void
  99 Font::draw(const std::string& text, const Vector& pos_, FontAlignment alignment,
 100            DrawingEffect drawing_effect, float alpha) const
 101 {
 102   /* Cut lines changes into seperate strings, needed to support center/right text
 103      alignments with break lines.
 104      Feel free to replace this hack with a more elegant solution
 105   */
 106   char temp[1024];
 107   std::string::size_type l, i, y;
 108   bool done = false;
 109   i = y = 0;
 110
 111   while(!done) {
 112     l = text.find("\n", i);
 113     if(l == std::string::npos) {
 114       l = text.size();
 115       done = true;
 116     }
 117
 118     if(l > sizeof(temp)-1)
 119       l = sizeof(temp)-1;
 120
 121     temp[text.copy(temp, l - i, i)] = '\0';
 122
 123     // calculate X positions based on the alignment type
 124     Vector pos = Vector(pos_);
 125     if(alignment == CENTER_ALLIGN)
 126       pos.x -= get_text_width(temp) / 2;
 127     else if(alignment == RIGHT_ALLIGN)
 128       pos.x -= get_text_width(temp);
 129
 130     draw_text(temp, pos + Vector(0,y), drawing_effect, alpha);
 131
 132     i = l+1;
 133     y += h + 2;
 134   }
 135 }
 136
 137 void
 138 Font::draw_text(const std::string& text, const Vector& pos,
 139                 DrawingEffect drawing_effect, float alpha) const
 140 {
 141   if(shadowsize > 0)
 142     draw_chars(shadow_chars, text, pos + Vector(shadowsize, shadowsize),
 143                drawing_effect, alpha);
 144
 145   draw_chars(chars, text, pos, drawing_effect, alpha);
 146 }
 147
 148 /** decoding of a byte stream to a single unicode character.
 149  * This should be correct for well formed utf-8 sequences but doesn't check for
 150  * all forms of illegal sequences.
 151  * (see unicode standard section 3.10 table 3-5 and 3-6 for details)
 152  */
 153 uint32_t decode_utf8(const std::string& text, size_t& p)
 154 {
 155   // 1 byte sequence
 156   uint32_t c = (unsigned char) text[p++];
 157   if(c <= 0x7F) {
 158     return c;
 159   }
 160
 161   // 2 byte sequence
 162   if(p >= text.size())
 163     throw std::runtime_error("Malformed utf-8 sequence");
 164   uint32_t c2 = (unsigned char) text[p++];
 165   if(c <= 0xDF) {
 166     if(c < 0xC2)
 167       throw std::runtime_error("Malformed utf-8 sequence");
 168     return (c & 0x1F) << 6 | (c2 & 0x3F);
 169   }
 170
 171   // 3 byte sequence
 172   if(p >= text.size())
 173     throw std::runtime_error("Malformed utf-8 sequence");
 174   uint32_t c3 = (unsigned char) text[p++];
 175   if(c <= 0xEF) {
 176     return (c & 0x0F) << 12 | (c2 & 0x3F) << 6 | (c3 & 0x3F);
 177   }
 178
 179   // 4 byte sequence
 180   if(p >= text.size())
 181     throw std::runtime_error("Malformed utf-8 sequence");
 182   uint32_t c4 = (unsigned char) text[p++];
 183   if(c <= 0xF4) {
 184     return (c & 0x07) << 18 | (c2 & 0x3F) << 12 | (c3 & 0x3F) << 6
 185       | (c4 & 0x3F);
 186   }
 187
 188   throw std::runtime_error("Malformed utf-8 sequence");
 189 }
 190
 191 void
 192 Font::draw_chars(Surface* pchars, const std::string& text, const Vector& pos,
 193                  DrawingEffect drawing_effect, float alpha) const
 194 {
 195   Vector p = pos;
 196   size_t i = 0;
 197   while(i < text.size()) {
 198     uint32_t c = decode_utf8(text, i);
 199     ssize_t font_index;
 200
 201     // a non-printable character?
 202     if(c == '\n') {
 203       p.x = pos.x;
 204       p.y += h + 2;
 205       continue;
 206     }
 207     if(c == ' ') {
 208       p.x += w;
 209       continue;
 210     }
 211
 212     font_index = c - first_char;
 213     // we don't have the control chars 0x80-0xa0 in the font
 214     if(c >= 0x80) {
 215       font_index -= 32;
 216       if(c <= 0xa0) {
 217         log_debug << "Unsupported utf-8 character '" << c << "' found" << std::endl;
 218         font_index = 0;
 219       }
 220     }
 221
 222     if(font_index < 0 || font_index >= (ssize_t) char_count) {
 223       log_debug << "Unsupported utf-8 character found" << std::endl;
 224       font_index = 0;
 225     }
 226
 227     int source_x = (font_index % 16) * w;
 228     int source_y = (font_index / 16) * h;
 229     pchars->draw_part(source_x, source_y, p.x, p.y, w, h, alpha,
 230                       drawing_effect);
 231     p.x += w;
 232   }
 233 }