2 // Copyright (C) 2006 Matthias Braun <matze@braunis.de>
3 // Ingo Ruhnke <grumbel@gmx.de>
5 // This program is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <SDL_image.h>
26 #include "lisp/list_iterator.hpp"
27 #include "lisp/parser.hpp"
28 #include "physfs/physfs_sdl.hpp"
29 #include "supertux/screen.hpp"
30 #include "util/file_system.hpp"
31 #include "util/log.hpp"
32 #include "util/utf8_iterator.hpp"
33 #include "video/drawing_context.hpp"
34 #include "video/font.hpp"
35 #include "video/renderer.hpp"
39 bool vline_empty(SDL_Surface* surface, int x, int start_y, int end_y, Uint8 threshold)
41 Uint8* pixels = (Uint8*)surface->pixels;
43 for(int y = start_y; y < end_y; ++y)
45 const Uint8& p = pixels[surface->pitch*y + x*surface->format->BytesPerPixel + 3];
56 Font::Font(GlyphWidth glyph_width_,
57 const std::string& filename,
59 glyph_width(glyph_width_),
63 shadowsize(shadowsize_),
66 for(unsigned int i=0; i<65536;i++) glyphs[i].surface_idx = -1;
68 const std::string fontdir = FileSystem::dirname(filename);
69 const std::string fontname = FileSystem::basename(filename);
71 // scan for prefix-filename in addons search path
72 char **rc = PHYSFS_enumerateFiles(fontdir.c_str());
73 for (char **i = rc; *i != NULL; i++) {
74 std::string filename(*i);
75 if( filename.rfind(fontname) != std::string::npos ) {
76 loadFontFile(fontdir + filename);
83 Font::loadFontFile(const std::string &filename)
86 log_debug << "Loading font: " << filename << std::endl;
87 const lisp::Lisp* root = parser.parse(filename);
88 const lisp::Lisp* config_l = root->get_lisp("supertux-font");
91 std::ostringstream msg;
92 msg << "Font file:" << filename << ": is not a supertux-font file";
93 throw std::runtime_error(msg.str());
98 if( !config_l->get("glyph-width",def_char_width) ) {
99 log_warning << "Font:"<< filename << ": misses default glyph-width" << std::endl;
102 if( !config_l->get("glyph-height",char_height) ) {
103 std::ostringstream msg;
104 msg << "Font:" << filename << ": misses glyph-height";
105 throw std::runtime_error(msg.str());
108 lisp::ListIterator iter(config_l);
110 const std::string& token = iter.item();
111 if( token == "surface" ) {
112 const lisp::Lisp * glyphs_val = iter.lisp();
113 int local_char_width;
115 GlyphWidth local_glyph_width;
116 std::string glyph_image;
117 std::string shadow_image;
118 std::vector<std::string> chars;
119 if( ! glyphs_val->get("glyph-width", local_char_width) ) {
120 local_char_width = def_char_width;
122 if( ! glyphs_val->get("monospace", monospaced ) ) {
123 local_glyph_width = glyph_width;
126 if( monospaced ) local_glyph_width = FIXED;
127 else local_glyph_width = VARIABLE;
129 if( ! glyphs_val->get("glyphs", glyph_image) ) {
130 std::ostringstream msg;
131 msg << "Font:" << filename << ": missing glyphs image";
132 throw std::runtime_error(msg.str());
134 if( ! glyphs_val->get("shadows", shadow_image) ) {
135 std::ostringstream msg;
136 msg << "Font:" << filename << ": missing shadows image";
137 throw std::runtime_error(msg.str());
139 if( ! glyphs_val->get("chars", chars) || chars.size() == 0) {
140 std::ostringstream msg;
141 msg << "Font:" << filename << ": missing chars definition";
142 throw std::runtime_error(msg.str());
145 if( local_char_width==0 ) {
146 std::ostringstream msg;
147 msg << "Font:" << filename << ": misses glyph-width for some surface";
148 throw std::runtime_error(msg.str());
151 loadFontSurface(glyph_image, shadow_image, chars,
152 local_glyph_width, local_char_width);
158 Font::loadFontSurface(
159 const std::string &glyphimage,
160 const std::string &shadowimage,
161 const std::vector<std::string> &chars,
162 GlyphWidth glyph_width,
166 Surface glyph_surface("images/engine/fonts/" + glyphimage);
167 Surface shadow_surface("images/engine/fonts/" + shadowimage);
169 int surface_idx = glyph_surfaces.size();
170 glyph_surfaces.push_back(glyph_surface);
171 shadow_surfaces.push_back(shadow_surface);
174 int wrap = glyph_surface.get_width() / char_width;
176 SDL_Surface *surface = NULL;
178 if( glyph_width == VARIABLE ) {
179 //this does not work:
180 // surface = ((SDL::Texture *)glyph_surface.get_texture())->get_texture();
181 surface = IMG_Load_RW(get_physfs_SDLRWops("images/engine/fonts/"+glyphimage), 1);
182 if(surface == NULL) {
183 std::ostringstream msg;
184 msg << "Couldn't load image '" << glyphimage << "' :" << SDL_GetError();
185 throw std::runtime_error(msg.str());
187 SDL_LockSurface(surface);
190 for( unsigned int i = 0; i < chars.size(); i++) {
191 for(UTF8Iterator chr(chars[i]); !chr.done(); ++chr) {
192 int y = row * char_height;
193 int x = col * char_width;
194 if( ++col == wrap ) { col=0; row++; }
195 if( *chr == 0x0020 && glyphs[0x20].surface_idx != -1) continue;
198 glyph.surface_idx = surface_idx;
200 if( glyph_width == FIXED )
202 glyph.rect = Rectf(x, y, x + char_width, y + char_height);
203 glyph.offset = Vector(0, 0);
204 glyph.advance = char_width;
209 while (left < x + char_width && vline_empty(surface, left, y, y + char_height, 64))
211 int right = x + char_width - 1;
212 while (right > left && vline_empty(surface, right, y, y + char_height, 64))
217 glyph.offset = Vector(x-left, 0);
218 glyph.advance = right - left + 1 + 1; // FIXME: might be useful to make spacing configurable
221 { // glyph is completly transparent
222 glyph.offset = Vector(0, 0);
223 glyph.advance = char_width + 1; // FIXME: might be useful to make spacing configurable
226 glyph.rect = Rectf(x, y, x + char_width, y + char_height);
229 glyphs[*chr] = glyph;
231 if( col>0 && col <= wrap ) {
237 if( surface != NULL ) {
238 SDL_UnlockSurface(surface);
239 SDL_FreeSurface(surface);
248 Font::get_text_width(const std::string& text) const
250 float curr_width = 0;
251 float last_width = 0;
253 for(UTF8Iterator it(text); !it.done(); ++it)
257 last_width = std::max(last_width, curr_width);
262 if( glyphs.at(*it).surface_idx != -1 )
263 curr_width += glyphs[*it].advance;
265 curr_width += glyphs[0x20].advance;
269 return std::max(curr_width, last_width);
273 Font::get_text_height(const std::string& text) const
275 std::string::size_type text_height = char_height;
277 for(std::string::const_iterator it = text.begin(); it != text.end(); ++it)
278 { // since UTF8 multibyte characters are decoded with values
279 // outside the ASCII range there is no risk of overlapping and
280 // thus we don't need to decode the utf-8 string
282 text_height += char_height + 2;
289 Font::get_height() const
295 Font::wrap_to_chars(const std::string& s, int line_length, std::string* overflow)
297 // if text is already smaller, return full text
298 if ((int)s.length() <= line_length) {
299 if (overflow) *overflow = "";
303 // if we can find a whitespace character to break at, return text up to this character
305 while ((i > 0) && (s[i] != ' ')) i--;
307 if (overflow) *overflow = s.substr(i+1);
308 return s.substr(0, i);
311 // FIXME: wrap at line_length, taking care of multibyte characters
312 if (overflow) *overflow = "";
317 Font::wrap_to_width(const std::string& s_, float width, std::string* overflow)
321 // if text is already smaller, return full text
322 if (get_text_width(s) <= width) {
323 if (overflow) *overflow = "";
327 // if we can find a whitespace character to break at, return text up to this character
328 for (int i = s.length()-1; i >= 0; i--) {
329 std::string s2 = s.substr(0,i);
330 if (s[i] != ' ') continue;
331 if (get_text_width(s2) <= width) {
332 if (overflow) *overflow = s.substr(i+1);
333 return s.substr(0, i);
337 // FIXME: hard-wrap at width, taking care of multibyte characters
338 if (overflow) *overflow = "";
343 Font::draw(Renderer *renderer, const std::string& text, const Vector& pos_,
344 FontAlignment alignment, DrawingEffect drawing_effect, Color color,
350 std::string::size_type last = 0;
351 for(std::string::size_type i = 0;; ++i)
353 if (text[i] == '\n' || i == text.size())
355 std::string temp = text.substr(last, i - last);
357 // calculate X positions based on the alignment type
358 Vector pos = Vector(x, y);
360 if(alignment == ALIGN_CENTER)
361 pos.x -= get_text_width(temp) / 2;
362 else if(alignment == ALIGN_RIGHT)
363 pos.x -= get_text_width(temp);
365 // Cast font position to integer to get a clean drawing result and
366 // no blurring as we would get with subpixel positions
367 pos.x = static_cast<int>(pos.x);
369 draw_text(renderer, temp, pos, drawing_effect, color, alpha);
371 if (i == text.size())
374 y += char_height + 2;
381 Font::draw_text(Renderer *renderer, const std::string& text, const Vector& pos,
382 DrawingEffect drawing_effect, Color color, float alpha) const
385 draw_chars(renderer, false, text,
386 pos + Vector(shadowsize, shadowsize), drawing_effect, Color(1,1,1), alpha);
388 draw_chars(renderer, true, text, pos, drawing_effect, color, alpha);
392 Font::draw_chars(Renderer *renderer, bool notshadow, const std::string& text,
393 const Vector& pos, DrawingEffect drawing_effect, Color color,
398 for(UTF8Iterator it(text); !it.done(); ++it)
403 p.y += char_height + 2;
407 p.x += glyphs[0x20].advance;
412 if( glyphs.at(*it).surface_idx != -1 )
415 glyph = glyphs[0x20];
417 DrawingRequest request;
419 request.pos = p + glyph.offset;
420 request.drawing_effect = drawing_effect;
421 request.color = color;
422 request.alpha = alpha;
424 SurfacePartRequest surfacepartrequest;
425 surfacepartrequest.size = glyph.rect.p2 - glyph.rect.p1;
426 surfacepartrequest.source = glyph.rect.p1;
427 surfacepartrequest.surface = notshadow ? &(glyph_surfaces[glyph.surface_idx]) : &(shadow_surfaces[glyph.surface_idx]);
429 request.request_data = &surfacepartrequest;
430 renderer->draw_surface_part(request);
432 p.x += glyph.advance;