4 // Copyright (C) 2006 Matthias Braun <matze@braunis.de>
5 // Ingo Ruhnke <grumbel@gmx.de>
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License
9 // as published by the Free Software Foundation; either version 2
10 // of the License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 #include <SDL_image.h>
28 #include "physfs/physfs_sdl.hpp"
30 #include "file_system.hpp"
32 #include "lisp/lisp.hpp"
33 #include "lisp/parser.hpp"
34 #include "lisp/list_iterator.hpp"
37 #include "renderer.hpp"
38 #include "drawing_context.hpp"
42 bool has_multibyte_mark(unsigned char c);
43 uint32_t decode_utf8(const std::string& text, size_t& p);
44 std::string encode_utf8(uint32_t code);
48 const std::string& text;
49 std::string::size_type pos;
52 UTF8Iterator(const std::string& text_)
57 chr = decode_utf8(text, pos);
58 } catch (std::exception) {
59 log_debug << "Malformed utf-8 sequence beginning with " << *((uint32_t*)(text.c_str() + pos)) << " found " << std::endl;
66 return pos > text.size();
69 UTF8Iterator& operator++() {
71 chr = decode_utf8(text, pos);
72 } catch (std::exception) {
73 log_debug << "Malformed utf-8 sequence beginning with " << *((uint32_t*)(text.c_str() + pos)) << " found " << std::endl;
81 uint32_t operator*() const {
86 bool vline_empty(SDL_Surface* surface, int x, int start_y, int end_y, Uint8 threshold)
88 Uint8* pixels = (Uint8*)surface->pixels;
90 for(int y = start_y; y < end_y; ++y)
92 const Uint8& p = pixels[surface->pitch*y + x*surface->format->BytesPerPixel + 3];
102 Font::Font(GlyphWidth glyph_width_,
103 const std::string& filename,
105 : glyph_width(glyph_width_),
106 shadowsize(shadowsize_),
109 for(unsigned int i=0; i<65536;i++) glyphs[i].surface_idx = -1;
111 const std::string fontdir = FileSystem::dirname(filename);
112 const std::string fontname = FileSystem::basename(filename);
114 // scan for prefix-filename in addons search path
115 char **rc = PHYSFS_enumerateFiles(fontdir.c_str());
116 for (char **i = rc; *i != NULL; i++) {
117 std::string filename(*i);
118 if( filename.rfind(fontname) != std::string::npos ) {
119 loadFontFile(fontdir + filename);
126 Font::loadFontFile(const std::string &filename)
129 log_debug << "Loading font: " << filename << std::endl;
130 const lisp::Lisp* root = parser.parse(filename);
131 const lisp::Lisp* config_l = root->get_lisp("supertux-font");
134 std::ostringstream msg;
135 msg << "Font file:" << filename << ": is not a supertux-font file";
136 throw std::runtime_error(msg.str());
139 int def_char_width=0;
141 if( !config_l->get("glyph-width",def_char_width) ) {
142 log_warning << "Font:"<< filename << ": misses default glyph-width" << std::endl;
145 if( !config_l->get("glyph-height",char_height) ) {
146 std::ostringstream msg;
147 msg << "Font:" << filename << ": misses glyph-height";
148 throw std::runtime_error(msg.str());
151 lisp::ListIterator iter(config_l);
153 const std::string& token = iter.item();
154 if( token == "surface" ) {
155 const lisp::Lisp * glyphs_val = iter.lisp();
156 int local_char_width;
158 GlyphWidth local_glyph_width;
159 std::string glyph_image;
160 std::string shadow_image;
161 std::vector<std::string> chars;
162 if( ! glyphs_val->get("glyph-width", local_char_width) ) {
163 local_char_width = def_char_width;
165 if( ! glyphs_val->get("monospace", monospaced ) ) {
166 local_glyph_width = glyph_width;
169 if( monospaced ) local_glyph_width = FIXED;
170 else local_glyph_width = VARIABLE;
172 if( ! glyphs_val->get("glyphs", glyph_image) ) {
173 std::ostringstream msg;
174 msg << "Font:" << filename << ": missing glyphs image";
175 throw std::runtime_error(msg.str());
177 if( ! glyphs_val->get("shadows", shadow_image) ) {
178 std::ostringstream msg;
179 msg << "Font:" << filename << ": missing shadows image";
180 throw std::runtime_error(msg.str());
182 if( ! glyphs_val->get_vector("chars", chars) || chars.size() == 0) {
183 std::ostringstream msg;
184 msg << "Font:" << filename << ": missing chars definition";
185 throw std::runtime_error(msg.str());
188 if( local_char_width==0 ) {
189 std::ostringstream msg;
190 msg << "Font:" << filename << ": misses glyph-width for some surface";
191 throw std::runtime_error(msg.str());
194 loadFontSurface(glyph_image, shadow_image, chars,
195 local_glyph_width, local_char_width);
201 Font::loadFontSurface(
202 const std::string &glyphimage,
203 const std::string &shadowimage,
204 const std::vector<std::string> &chars,
205 GlyphWidth glyph_width,
209 Surface glyph_surface = Surface("images/engine/fonts/" + glyphimage);
210 Surface shadow_surface = Surface("images/engine/fonts/" + shadowimage);
212 int surface_idx = glyph_surfaces.size();
213 glyph_surfaces.push_back(glyph_surface);
214 shadow_surfaces.push_back(shadow_surface);
217 int wrap = glyph_surface.get_width() / char_width;
219 SDL_Surface *surface = NULL;
221 if( glyph_width == VARIABLE ) {
222 //this does not work:
223 // surface = ((SDL::Texture *)glyph_surface.get_texture())->get_texture();
224 surface = IMG_Load_RW(get_physfs_SDLRWops("images/engine/fonts/"+glyphimage), 1);
225 if(surface == NULL) {
226 std::ostringstream msg;
227 msg << "Couldn't load image '" << glyphimage << "' :" << SDL_GetError();
228 throw std::runtime_error(msg.str());
230 SDL_LockSurface(surface);
233 for( unsigned int i = 0; i < chars.size(); i++) {
234 for(UTF8Iterator chr(chars[i]); !chr.done(); ++chr) {
235 int y = row * char_height;
236 int x = col * char_width;
237 if( ++col == wrap ) { col=0; row++; }
238 if( *chr == 0x0020 && glyphs[0x20].surface_idx != -1) continue;
241 glyph.surface_idx = surface_idx;
243 if( glyph_width == FIXED ) {
244 glyph.rect = Rect(x, y, x + char_width, y + char_height);
245 glyph.offset = Vector(0, 0);
246 glyph.advance = char_width;
250 while (left < x + char_width && vline_empty(surface, left, y, y + char_height, 64))
252 int right = x + char_width - 1;
253 while (right > left && vline_empty(surface, right, y, y + char_height, 64))
257 glyph.rect = Rect(left, y, right+1, y + char_height);
258 else // glyph is completely transparent
259 glyph.rect = Rect(x, y, x + char_width, y + char_height);
261 glyph.offset = Vector(0, 0);
262 glyph.advance = glyph.rect.get_width() + 1; // FIXME: might be useful to make spacing configurable
265 glyphs[*chr] = glyph;
267 if( col>0 && col <= wrap ) {
273 if( surface != NULL ) {
274 SDL_UnlockSurface(surface);
275 SDL_FreeSurface(surface);
284 Font::get_text_width(const std::string& text) const
286 float curr_width = 0;
287 float last_width = 0;
289 for(UTF8Iterator it(text); !it.done(); ++it)
293 last_width = std::max(last_width, curr_width);
298 if( glyphs.at(*it).surface_idx != -1 )
299 curr_width += glyphs[*it].advance;
301 curr_width += glyphs[0x20].advance;
305 return std::max(curr_width, last_width);
309 Font::get_text_height(const std::string& text) const
311 std::string::size_type text_height = char_height;
313 for(std::string::const_iterator it = text.begin(); it != text.end(); ++it)
314 { // since UTF8 multibyte characters are decoded with values
315 // outside the ASCII range there is no risk of overlapping and
316 // thus we don't need to decode the utf-8 string
318 text_height += char_height + 2;
325 Font::get_height() const
331 Font::wrap_to_chars(const std::string& s, int line_length, std::string* overflow)
333 // if text is already smaller, return full text
334 if ((int)s.length() <= line_length) {
335 if (overflow) *overflow = "";
339 // if we can find a whitespace character to break at, return text up to this character
341 while ((i > 0) && (s[i] != ' ')) i--;
343 if (overflow) *overflow = s.substr(i+1);
344 return s.substr(0, i);
347 // FIXME: wrap at line_length, taking care of multibyte characters
348 if (overflow) *overflow = "";
353 Font::wrap_to_width(const std::string& s_, float width, std::string* overflow)
357 // if text is already smaller, return full text
358 if (get_text_width(s) <= width) {
359 if (overflow) *overflow = "";
363 // if we can find a whitespace character to break at, return text up to this character
364 for (int i = s.length()-1; i >= 0; i--) {
365 std::string s2 = s.substr(0,i);
366 if (s[i] != ' ') continue;
367 if (get_text_width(s2) <= width) {
368 if (overflow) *overflow = s.substr(i+1);
369 return s.substr(0, i);
373 // FIXME: hard-wrap at width, taking care of multibyte characters
374 if (overflow) *overflow = "";
379 Font::draw(Renderer *renderer, const std::string& text, const Vector& pos_,
380 FontAlignment alignment, DrawingEffect drawing_effect, Color color,
386 std::string::size_type last = 0;
387 for(std::string::size_type i = 0;; ++i)
389 if (text[i] == '\n' || i == text.size())
391 std::string temp = text.substr(last, i - last);
393 // calculate X positions based on the alignment type
394 Vector pos = Vector(x, y);
396 if(alignment == ALIGN_CENTER)
397 pos.x -= get_text_width(temp) / 2;
398 else if(alignment == ALIGN_RIGHT)
399 pos.x -= get_text_width(temp);
401 // Cast font position to integer to get a clean drawing result and
402 // no blurring as we would get with subpixel positions
403 pos.x = static_cast<int>(pos.x);
405 draw_text(renderer, temp, pos, drawing_effect, color, alpha);
407 if (i == text.size())
410 y += char_height + 2;
417 Font::draw_text(Renderer *renderer, const std::string& text, const Vector& pos,
418 DrawingEffect drawing_effect, Color color, float alpha) const
421 draw_chars(renderer, false, text,
422 pos + Vector(shadowsize, shadowsize), drawing_effect, Color(1,1,1), alpha);
424 draw_chars(renderer, true, text, pos, drawing_effect, color, alpha);
428 Font::draw_chars(Renderer *renderer, bool notshadow, const std::string& text,
429 const Vector& pos, DrawingEffect drawing_effect, Color color,
434 for(UTF8Iterator it(text); !it.done(); ++it)
439 p.y += char_height + 2;
443 p.x += glyphs[0x20].advance;
448 if( glyphs.at(*it).surface_idx != -1 )
451 glyph = glyphs[0x20];
453 DrawingRequest request;
455 request.pos = p + glyph.offset;
456 request.drawing_effect = drawing_effect;
457 request.color = color;
458 request.alpha = alpha;
460 SurfacePartRequest surfacepartrequest;
461 surfacepartrequest.size = glyph.rect.p2 - glyph.rect.p1;
462 surfacepartrequest.source = glyph.rect.p1;
463 surfacepartrequest.surface = notshadow ? &(glyph_surfaces[glyph.surface_idx]) : &(shadow_surfaces[glyph.surface_idx]);
465 request.request_data = &surfacepartrequest;
466 renderer->draw_surface_part(request);
468 p.x += glyph.advance;
477 * 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
479 bool has_multibyte_mark(unsigned char c) {
480 return ((c & 0300) == 0200);
484 * gets unicode character at byte position @a p of UTF-8 encoded @a
485 * text, then advances @a p to the next character.
487 * @throws std::runtime_error if decoding fails.
488 * See unicode standard section 3.10 table 3-5 and 3-6 for details.
490 uint32_t decode_utf8(const std::string& text, size_t& p)
492 uint32_t c1 = (unsigned char) text[p+0];
494 if (has_multibyte_mark(c1)) std::runtime_error("Malformed utf-8 sequence");
496 if ((c1 & 0200) == 0000) {
497 // 0xxx.xxxx: 1 byte sequence
501 else if ((c1 & 0340) == 0300) {
502 // 110x.xxxx: 2 byte sequence
503 if(p+1 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
504 uint32_t c2 = (unsigned char) text[p+1];
505 if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
507 return (c1 & 0037) << 6 | (c2 & 0077);
509 else if ((c1 & 0360) == 0340) {
510 // 1110.xxxx: 3 byte sequence
511 if(p+2 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
512 uint32_t c2 = (unsigned char) text[p+1];
513 uint32_t c3 = (unsigned char) text[p+2];
514 if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
515 if (!has_multibyte_mark(c3)) throw std::runtime_error("Malformed utf-8 sequence");
517 return (c1 & 0017) << 12 | (c2 & 0077) << 6 | (c3 & 0077);
519 else if ((c1 & 0370) == 0360) {
520 // 1111.0xxx: 4 byte sequence
521 if(p+3 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
522 uint32_t c2 = (unsigned char) text[p+1];
523 uint32_t c3 = (unsigned char) text[p+2];
524 uint32_t c4 = (unsigned char) text[p+4];
525 if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
526 if (!has_multibyte_mark(c3)) throw std::runtime_error("Malformed utf-8 sequence");
527 if (!has_multibyte_mark(c4)) throw std::runtime_error("Malformed utf-8 sequence");
529 return (c1 & 0007) << 18 | (c2 & 0077) << 12 | (c3 & 0077) << 6 | (c4 & 0077);
531 throw std::runtime_error("Malformed utf-8 sequence");