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 "lisp/parser.hpp"
31 #include "lisp/lisp.hpp"
34 #include "renderer.hpp"
35 #include "drawing_context.hpp"
39 bool has_multibyte_mark(unsigned char c);
40 uint32_t decode_utf8(const std::string& text, size_t& p);
44 const std::string& text;
45 std::string::size_type pos;
48 UTF8Iterator(const std::string& text_)
53 chr = decode_utf8(text, pos);
54 } catch (std::exception) {
55 log_debug << "Malformed utf-8 sequence beginning with " << *((uint32_t*)(text.c_str() + pos)) << " found " << std::endl;
62 return pos > text.size();
65 UTF8Iterator& operator++() {
67 chr = decode_utf8(text, pos);
68 } catch (std::exception) {
69 log_debug << "Malformed utf-8 sequence beginning with " << *((uint32_t*)(text.c_str() + pos)) << " found " << std::endl;
77 uint32_t operator*() const {
82 bool vline_empty(SDL_Surface* surface, int x, int start_y, int end_y, Uint8 threshold)
84 Uint8* pixels = (Uint8*)surface->pixels;
86 for(int y = start_y; y < end_y; ++y)
88 const Uint8& p = pixels[surface->pitch*y + x*surface->format->BytesPerPixel + 3];
98 Font::Font(GlyphWidth glyph_width_,
99 const std::string& filename,
100 const std::string& shadowfile,
101 int char_width, int char_height_,
103 : glyph_width(glyph_width_),
104 glyph_surface(0), shadow_glyph_surface(0),
105 char_height(char_height_),
106 shadowsize(shadowsize_)
108 glyph_surface = new Surface(filename);
109 shadow_glyph_surface = new Surface(shadowfile);
112 char_count = ((int) glyph_surface->get_height() / char_height) * 16;
114 if (glyph_width == FIXED)
116 for(uint32_t i = 0; i < char_count; ++i)
118 float x = (i % 16) * char_width;
119 float y = (i / 16) * char_height;
122 glyph.advance = char_width;
123 glyph.offset = Vector(0, 0);
124 glyph.rect = Rect(x, y, x + char_width, y + char_height);
126 glyphs.push_back(glyph);
127 shadow_glyphs.push_back(glyph);
130 else // glyph_width == VARIABLE
132 // Load the surface into RAM and scan the pixel data for characters
133 SDL_Surface* surface = IMG_Load_RW(get_physfs_SDLRWops(filename), 1);
134 if(surface == NULL) {
135 std::ostringstream msg;
136 msg << "Couldn't load image '" << filename << "' :" << SDL_GetError();
137 throw std::runtime_error(msg.str());
140 SDL_LockSurface(surface);
142 for(uint32_t i = 0; i < char_count; ++i)
144 int x = (i % 16) * char_width;
145 int y = (i / 16) * char_height;
148 while (left < x + char_width &&
149 vline_empty(surface, left, y, y + char_height, 64))
152 int right = x + char_width - 1;
153 while (right > left &&
154 vline_empty(surface, right, y, y + char_height, 64))
158 glyph.offset = Vector(0, 0);
161 glyph.rect = Rect(left, y, right+1, y + char_height);
162 else // glyph is completely transparent
163 glyph.rect = Rect(x, y, x + char_width, y + char_height);
165 glyph.advance = glyph.rect.get_width() + 1; // FIXME: might be useful to make spacing configurable
167 glyphs.push_back(glyph);
168 shadow_glyphs.push_back(glyph);
171 SDL_UnlockSurface(surface);
173 SDL_FreeSurface(surface);
179 delete glyph_surface;
180 delete shadow_glyph_surface;
184 Font::get_text_width(const std::string& text) const
186 float curr_width = 0;
187 float last_width = 0;
189 for(UTF8Iterator it(text); !it.done(); ++it)
193 last_width = std::max(last_width, curr_width);
198 int idx = chr2glyph(*it);
199 curr_width += glyphs[idx].advance;
203 return std::max(curr_width, last_width);
207 Font::get_text_height(const std::string& text) const
209 std::string::size_type text_height = char_height;
211 for(std::string::const_iterator it = text.begin(); it != text.end(); ++it)
212 { // since UTF8 multibyte characters are decoded with values
213 // outside the ASCII range there is no risk of overlapping and
214 // thus we don't need to decode the utf-8 string
216 text_height += char_height + 2;
223 Font::get_height() const
229 Font::wrap_to_chars(const std::string& s, int line_length, std::string* overflow)
231 // if text is already smaller, return full text
232 if ((int)s.length() <= line_length) {
233 if (overflow) *overflow = "";
237 // if we can find a whitespace character to break at, return text up to this character
239 while ((i > 0) && (s[i] != ' ')) i--;
241 if (overflow) *overflow = s.substr(i+1);
242 return s.substr(0, i);
245 // FIXME: wrap at line_length, taking care of multibyte characters
246 if (overflow) *overflow = "";
251 Font::wrap_to_width(const std::string& s_, float width, std::string* overflow)
255 // if text is already smaller, return full text
256 if (get_text_width(s) <= width) {
257 if (overflow) *overflow = "";
261 // if we can find a whitespace character to break at, return text up to this character
262 for (int i = s.length()-1; i >= 0; i--) {
263 std::string s2 = s.substr(0,i);
264 if (s[i] != ' ') continue;
265 if (get_text_width(s2) <= width) {
266 if (overflow) *overflow = s.substr(i+1);
267 return s.substr(0, i);
271 // FIXME: hard-wrap at width, taking care of multibyte characters
272 if (overflow) *overflow = "";
277 Font::draw(Renderer *renderer, const std::string& text, const Vector& pos_,
278 FontAlignment alignment, DrawingEffect drawing_effect,
284 std::string::size_type last = 0;
285 for(std::string::size_type i = 0;; ++i)
287 if (text[i] == '\n' || i == text.size())
289 std::string temp = text.substr(last, i - last);
291 // calculate X positions based on the alignment type
292 Vector pos = Vector(x, y);
294 if(alignment == ALIGN_CENTER)
295 pos.x -= get_text_width(temp) / 2;
296 else if(alignment == ALIGN_RIGHT)
297 pos.x -= get_text_width(temp);
299 // Cast font position to integer to get a clean drawing result and
300 // no blurring as we would get with subpixel positions
301 pos.x = static_cast<int>(pos.x);
303 draw_text(renderer, temp, pos, drawing_effect, alpha);
305 if (i == text.size())
308 y += char_height + 2;
315 Font::draw_text(Renderer *renderer, const std::string& text, const Vector& pos,
316 DrawingEffect drawing_effect, float alpha) const
320 // FIXME: shadow_glyph_surface and glyph_surface do currently
321 // share the same glyph array, this is incorrect and should be
322 // fixed, it is however hardly noticeable
323 draw_chars(renderer, shadow_glyph_surface, text,
324 pos + Vector(shadowsize, shadowsize), drawing_effect, alpha);
327 draw_chars(renderer, glyph_surface, text, pos, drawing_effect, alpha);
331 Font::chr2glyph(uint32_t chr) const
333 int glyph_index = chr - first_char;
335 // we don't have the control chars 0x80-0xa0 in the font
336 if (chr >= 0x80) { // non-ascii character
339 log_debug << "Unsupported utf-8 character '" << chr << "' found" << std::endl;
344 if(glyph_index < 0 || glyph_index >= (int) char_count) {
345 log_debug << "Unsupported utf-8 character found" << std::endl;
353 Font::draw_chars(Renderer *renderer, Surface* pchars, const std::string& text,
354 const Vector& pos, DrawingEffect drawing_effect,
359 for(UTF8Iterator it(text); !it.done(); ++it)
361 int font_index = chr2glyph(*it);
366 p.y += char_height + 2;
370 p.x += glyphs[font_index].advance;
374 const Glyph& glyph = glyphs[font_index];
375 DrawingRequest request;
377 request.pos = p + glyph.offset;
378 request.drawing_effect = drawing_effect;
379 request.alpha = alpha;
381 SurfacePartRequest surfacepartrequest;
382 surfacepartrequest.size = glyph.rect.p2 - glyph.rect.p1;
383 surfacepartrequest.source = glyph.rect.p1;
384 surfacepartrequest.surface = pchars;
386 request.request_data = &surfacepartrequest;
387 renderer->draw_surface_part(request);
389 p.x += glyphs[font_index].advance;
398 * 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
400 bool has_multibyte_mark(unsigned char c) {
401 return ((c & 0300) == 0200);
405 * gets unicode character at byte position @a p of UTF-8 encoded @a
406 * text, then advances @a p to the next character.
408 * @throws std::runtime_error if decoding fails.
409 * See unicode standard section 3.10 table 3-5 and 3-6 for details.
411 uint32_t decode_utf8(const std::string& text, size_t& p)
413 uint32_t c1 = (unsigned char) text[p+0];
415 if (has_multibyte_mark(c1)) std::runtime_error("Malformed utf-8 sequence");
417 if ((c1 & 0200) == 0000) {
418 // 0xxx.xxxx: 1 byte sequence
422 else if ((c1 & 0340) == 0300) {
423 // 110x.xxxx: 2 byte sequence
424 if(p+1 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
425 uint32_t c2 = (unsigned char) text[p+1];
426 if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
428 return (c1 & 0037) << 6 | (c2 & 0077);
430 else if ((c1 & 0360) == 0340) {
431 // 1110.xxxx: 3 byte sequence
432 if(p+2 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
433 uint32_t c2 = (unsigned char) text[p+1];
434 uint32_t c3 = (unsigned char) text[p+2];
435 if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
436 if (!has_multibyte_mark(c3)) throw std::runtime_error("Malformed utf-8 sequence");
438 return (c1 & 0017) << 12 | (c2 & 0077) << 6 | (c3 & 0077);
440 else if ((c1 & 0370) == 0360) {
441 // 1111.0xxx: 4 byte sequence
442 if(p+3 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
443 uint32_t c2 = (unsigned char) text[p+1];
444 uint32_t c3 = (unsigned char) text[p+2];
445 uint32_t c4 = (unsigned char) text[p+4];
446 if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
447 if (!has_multibyte_mark(c3)) throw std::runtime_error("Malformed utf-8 sequence");
448 if (!has_multibyte_mark(c4)) throw std::runtime_error("Malformed utf-8 sequence");
450 return (c1 & 0007) << 18 | (c2 & 0077) << 12 | (c3 & 0077) << 6 | (c4 & 0077);
452 throw std::runtime_error("Malformed utf-8 sequence");