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_)
52 chr = decode_utf8(text, pos);
57 return pos > text.size();
60 UTF8Iterator& operator++() {
62 chr = decode_utf8(text, pos);
63 } catch (std::runtime_error) {
64 log_debug << "Malformed utf-8 sequence beginning with " << *((uint32_t*)(text.c_str() + pos)) << " found " << std::endl;
72 uint32_t operator*() const {
77 bool vline_empty(SDL_Surface* surface, int x, int start_y, int end_y, Uint8 threshold)
79 Uint8* pixels = (Uint8*)surface->pixels;
81 for(int y = start_y; y < end_y; ++y)
83 const Uint8& p = pixels[surface->pitch*y + x*surface->format->BytesPerPixel + 3];
93 Font::Font(GlyphWidth glyph_width_,
94 const std::string& filename,
95 const std::string& shadowfile,
96 int char_width, int char_height_,
98 : glyph_width(glyph_width_),
99 glyph_surface(0), shadow_glyph_surface(0),
100 char_height(char_height_),
101 shadowsize(shadowsize_)
103 glyph_surface = new Surface(filename);
104 shadow_glyph_surface = new Surface(shadowfile);
107 char_count = ((int) glyph_surface->get_height() / char_height) * 16;
109 if (glyph_width == FIXED)
111 for(uint32_t i = 0; i < char_count; ++i)
113 float x = (i % 16) * char_width;
114 float y = (i / 16) * char_height;
117 glyph.advance = char_width;
118 glyph.offset = Vector(0, 0);
119 glyph.rect = Rect(x, y, x + char_width, y + char_height);
121 glyphs.push_back(glyph);
122 shadow_glyphs.push_back(glyph);
125 else // glyph_width == VARIABLE
127 // Load the surface into RAM and scan the pixel data for characters
128 SDL_Surface* surface = IMG_Load_RW(get_physfs_SDLRWops(filename), 1);
129 if(surface == NULL) {
130 std::ostringstream msg;
131 msg << "Couldn't load image '" << filename << "' :" << SDL_GetError();
132 throw std::runtime_error(msg.str());
135 SDL_LockSurface(surface);
137 for(uint32_t i = 0; i < char_count; ++i)
139 int x = (i % 16) * char_width;
140 int y = (i / 16) * char_height;
143 while (left < x + char_width &&
144 vline_empty(surface, left, y, y + char_height, 64))
147 int right = x + char_width - 1;
148 while (right > left &&
149 vline_empty(surface, right, y, y + char_height, 64))
153 glyph.offset = Vector(0, 0);
156 glyph.rect = Rect(left, y, right+1, y + char_height);
157 else // glyph is completely transparent
158 glyph.rect = Rect(x, y, x + char_width, y + char_height);
160 glyph.advance = glyph.rect.get_width() + 1; // FIXME: might be useful to make spacing configurable
162 glyphs.push_back(glyph);
163 shadow_glyphs.push_back(glyph);
166 SDL_UnlockSurface(surface);
168 SDL_FreeSurface(surface);
174 delete glyph_surface;
175 delete shadow_glyph_surface;
179 Font::get_text_width(const std::string& text) const
181 float curr_width = 0;
182 float last_width = 0;
184 for(UTF8Iterator it(text); !it.done(); ++it)
188 last_width = std::max(last_width, curr_width);
193 int idx = chr2glyph(*it);
194 curr_width += glyphs[idx].advance;
198 return std::max(curr_width, last_width);
202 Font::get_text_height(const std::string& text) const
204 std::string::size_type text_height = char_height;
206 for(std::string::const_iterator it = text.begin(); it != text.end(); ++it)
207 { // since UTF8 multibyte characters are decoded with values
208 // outside the ASCII range there is no risk of overlapping and
209 // thus we don't need to decode the utf-8 string
211 text_height += char_height + 2;
218 Font::get_height() const
224 Font::wrap_to_chars(const std::string& s, int line_length, std::string* overflow)
226 // if text is already smaller, return full text
227 if ((int)s.length() <= line_length) {
228 if (overflow) *overflow = "";
232 // if we can find a whitespace character to break at, return text up to this character
234 while ((i > 0) && (s[i] != ' ')) i--;
236 if (overflow) *overflow = s.substr(i+1);
237 return s.substr(0, i);
240 // FIXME: wrap at line_length, taking care of multibyte characters
241 if (overflow) *overflow = "";
246 Font::wrap_to_width(const std::string& s_, float width, std::string* overflow)
250 // if text is already smaller, return full text
251 if (get_text_width(s) <= width) {
252 if (overflow) *overflow = "";
256 // if we can find a whitespace character to break at, return text up to this character
257 for (int i = s.length()-1; i >= 0; i--) {
258 std::string s2 = s.substr(0,i);
259 if (s[i] != ' ') continue;
260 if (get_text_width(s2) <= width) {
261 if (overflow) *overflow = s.substr(i+1);
262 return s.substr(0, i);
266 // FIXME: hard-wrap at width, taking care of multibyte characters
267 if (overflow) *overflow = "";
272 Font::draw(Renderer *renderer, const std::string& text, const Vector& pos_,
273 FontAlignment alignment, DrawingEffect drawing_effect,
279 std::string::size_type last = 0;
280 for(std::string::size_type i = 0;; ++i)
282 if (text[i] == '\n' || i == text.size())
284 std::string temp = text.substr(last, i - last);
286 // calculate X positions based on the alignment type
287 Vector pos = Vector(x, y);
289 if(alignment == ALIGN_CENTER)
290 pos.x -= get_text_width(temp) / 2;
291 else if(alignment == ALIGN_RIGHT)
292 pos.x -= get_text_width(temp);
294 // Cast font position to integer to get a clean drawing result and
295 // no blurring as we would get with subpixel positions
296 pos.x = static_cast<int>(pos.x);
298 draw_text(renderer, temp, pos, drawing_effect, alpha);
300 if (i == text.size())
303 y += char_height + 2;
310 Font::draw_text(Renderer *renderer, const std::string& text, const Vector& pos,
311 DrawingEffect drawing_effect, float alpha) const
315 // FIXME: shadow_glyph_surface and glyph_surface do currently
316 // share the same glyph array, this is incorrect and should be
317 // fixed, it is however hardly noticeable
318 draw_chars(renderer, shadow_glyph_surface, text,
319 pos + Vector(shadowsize, shadowsize), drawing_effect, alpha);
322 draw_chars(renderer, glyph_surface, text, pos, drawing_effect, alpha);
326 Font::chr2glyph(uint32_t chr) const
328 int glyph_index = chr - first_char;
330 // we don't have the control chars 0x80-0xa0 in the font
331 if (chr >= 0x80) { // non-ascii character
334 log_debug << "Unsupported utf-8 character '" << chr << "' found" << std::endl;
339 if(glyph_index < 0 || glyph_index >= (int) char_count) {
340 log_debug << "Unsupported utf-8 character found" << std::endl;
348 Font::draw_chars(Renderer *renderer, Surface* pchars, const std::string& text,
349 const Vector& pos, DrawingEffect drawing_effect,
354 for(UTF8Iterator it(text); !it.done(); ++it)
356 int font_index = chr2glyph(*it);
361 p.y += char_height + 2;
365 p.x += glyphs[font_index].advance;
369 const Glyph& glyph = glyphs[font_index];
370 DrawingRequest request;
372 request.pos = p + glyph.offset;
373 request.drawing_effect = drawing_effect;
374 request.alpha = alpha;
376 SurfacePartRequest surfacepartrequest;
377 surfacepartrequest.size = glyph.rect.p2 - glyph.rect.p1;
378 surfacepartrequest.source = glyph.rect.p1;
379 surfacepartrequest.surface = pchars;
381 request.request_data = &surfacepartrequest;
382 renderer->draw_surface_part(request);
384 p.x += glyphs[font_index].advance;
393 * 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
395 bool has_multibyte_mark(unsigned char c) {
396 return ((c & 0300) == 0200);
400 * gets unicode character at byte position @a p of UTF-8 encoded @a
401 * text, then advances @a p to the next character.
403 * @throws std::runtime_error if decoding fails.
404 * See unicode standard section 3.10 table 3-5 and 3-6 for details.
406 uint32_t decode_utf8(const std::string& text, size_t& p)
408 uint32_t c1 = (unsigned char) text[p+0];
410 if (has_multibyte_mark(c1)) std::runtime_error("Malformed utf-8 sequence");
412 if ((c1 & 0200) == 0000) {
413 // 0xxx.xxxx: 1 byte sequence
417 else if ((c1 & 0340) == 0300) {
418 // 110x.xxxx: 2 byte sequence
419 if(p+1 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
420 uint32_t c2 = (unsigned char) text[p+1];
421 if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
423 return (c1 & 0037) << 6 | (c2 & 0077);
425 else if ((c1 & 0360) == 0340) {
426 // 1110.xxxx: 3 byte sequence
427 if(p+2 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
428 uint32_t c2 = (unsigned char) text[p+1];
429 uint32_t c3 = (unsigned char) text[p+2];
430 if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
431 if (!has_multibyte_mark(c3)) throw std::runtime_error("Malformed utf-8 sequence");
433 return (c1 & 0017) << 12 | (c2 & 0077) << 6 | (c3 & 0077);
435 else if ((c1 & 0370) == 0360) {
436 // 1111.0xxx: 4 byte sequence
437 if(p+3 >= text.size()) throw std::range_error("Malformed utf-8 sequence");
438 uint32_t c2 = (unsigned char) text[p+1];
439 uint32_t c3 = (unsigned char) text[p+2];
440 uint32_t c4 = (unsigned char) text[p+4];
441 if (!has_multibyte_mark(c2)) throw std::runtime_error("Malformed utf-8 sequence");
442 if (!has_multibyte_mark(c3)) throw std::runtime_error("Malformed utf-8 sequence");
443 if (!has_multibyte_mark(c4)) throw std::runtime_error("Malformed utf-8 sequence");
445 return (c1 & 0007) << 18 | (c2 & 0077) << 12 | (c3 & 0077) << 6 | (c4 & 0077);
447 throw std::runtime_error("Malformed utf-8 sequence");