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/>.
24 #include <SDL_image.h>
27 #include "lisp/list_iterator.hpp"
28 #include "lisp/parser.hpp"
29 #include "physfs/physfs_sdl.hpp"
30 #include "supertux/screen.hpp"
31 #include "util/file_system.hpp"
32 #include "util/log.hpp"
33 #include "util/utf8_iterator.hpp"
34 #include "video/drawing_context.hpp"
35 #include "video/font.hpp"
36 #include "video/renderer.hpp"
40 bool vline_empty(SDL_Surface* surface, int x, int start_y, int end_y, Uint8 threshold)
42 Uint8* pixels = (Uint8*)surface->pixels;
44 for(int y = start_y; y < end_y; ++y)
46 const Uint8& p = pixels[surface->pitch*y + x*surface->format->BytesPerPixel + 3];
57 Font::Font(GlyphWidth glyph_width_,
58 const std::string& filename,
60 glyph_width(glyph_width_),
64 shadowsize(shadowsize_),
67 for(unsigned int i=0; i<65536;i++) glyphs[i].surface_idx = -1;
69 const std::string fontdir = FileSystem::dirname(filename);
70 const std::string fontname = FileSystem::basename(filename);
72 // scan for prefix-filename in addons search path
73 char **rc = PHYSFS_enumerateFiles(fontdir.c_str());
74 for (char **i = rc; *i != NULL; i++) {
75 std::string filename(*i);
76 if( filename.rfind(fontname) != std::string::npos ) {
77 loadFontFile(fontdir + filename);
84 Font::loadFontFile(const std::string &filename)
87 log_debug << "Loading font: " << filename << std::endl;
88 const lisp::Lisp* root = parser.parse(filename);
89 const lisp::Lisp* config_l = root->get_lisp("supertux-font");
92 std::ostringstream msg;
93 msg << "Font file:" << filename << ": is not a supertux-font file";
94 throw std::runtime_error(msg.str());
99 if( !config_l->get("glyph-width",def_char_width) ) {
100 log_warning << "Font:"<< filename << ": misses default glyph-width" << std::endl;
103 if( !config_l->get("glyph-height",char_height) ) {
104 std::ostringstream msg;
105 msg << "Font:" << filename << ": misses glyph-height";
106 throw std::runtime_error(msg.str());
109 lisp::ListIterator iter(config_l);
111 const std::string& token = iter.item();
112 if( token == "surface" ) {
113 const lisp::Lisp * glyphs_val = iter.lisp();
114 int local_char_width;
116 GlyphWidth local_glyph_width;
117 std::string glyph_image;
118 std::string shadow_image;
119 std::vector<std::string> chars;
120 if( ! glyphs_val->get("glyph-width", local_char_width) ) {
121 local_char_width = def_char_width;
123 if( ! glyphs_val->get("monospace", monospaced ) ) {
124 local_glyph_width = glyph_width;
127 if( monospaced ) local_glyph_width = FIXED;
128 else local_glyph_width = VARIABLE;
130 if( ! glyphs_val->get("glyphs", glyph_image) ) {
131 std::ostringstream msg;
132 msg << "Font:" << filename << ": missing glyphs image";
133 throw std::runtime_error(msg.str());
135 if( ! glyphs_val->get("shadows", shadow_image) ) {
136 std::ostringstream msg;
137 msg << "Font:" << filename << ": missing shadows image";
138 throw std::runtime_error(msg.str());
140 if( ! glyphs_val->get("chars", chars) || chars.size() == 0) {
141 std::ostringstream msg;
142 msg << "Font:" << filename << ": missing chars definition";
143 throw std::runtime_error(msg.str());
146 if( local_char_width==0 ) {
147 std::ostringstream msg;
148 msg << "Font:" << filename << ": misses glyph-width for some surface";
149 throw std::runtime_error(msg.str());
152 loadFontSurface(glyph_image, shadow_image, chars,
153 local_glyph_width, local_char_width);
159 Font::loadFontSurface(
160 const std::string &glyphimage,
161 const std::string &shadowimage,
162 const std::vector<std::string> &chars,
163 GlyphWidth glyph_width,
167 SurfacePtr glyph_surface = Surface::create("images/engine/fonts/" + glyphimage);
168 SurfacePtr shadow_surface = Surface::create("images/engine/fonts/" + shadowimage);
170 int surface_idx = glyph_surfaces.size();
171 glyph_surfaces.push_back(glyph_surface);
172 shadow_surfaces.push_back(shadow_surface);
175 int wrap = glyph_surface->get_width() / char_width;
177 SDL_Surface *surface = NULL;
179 if( glyph_width == VARIABLE ) {
180 //this does not work:
181 // surface = ((SDL::Texture *)glyph_surface.get_texture())->get_texture();
182 surface = IMG_Load_RW(get_physfs_SDLRWops("images/engine/fonts/"+glyphimage), 1);
183 if(surface == NULL) {
184 std::ostringstream msg;
185 msg << "Couldn't load image '" << glyphimage << "' :" << SDL_GetError();
186 throw std::runtime_error(msg.str());
188 SDL_LockSurface(surface);
191 for( unsigned int i = 0; i < chars.size(); i++) {
192 for(UTF8Iterator chr(chars[i]); !chr.done(); ++chr) {
193 int y = row * char_height;
194 int x = col * char_width;
195 if( ++col == wrap ) { col=0; row++; }
196 if( *chr == 0x0020 && glyphs[0x20].surface_idx != -1) continue;
199 glyph.surface_idx = surface_idx;
201 if( glyph_width == FIXED )
203 glyph.rect = Rectf(x, y, x + char_width, y + char_height);
204 glyph.offset = Vector(0, 0);
205 glyph.advance = char_width;
210 while (left < x + char_width && vline_empty(surface, left, y, y + char_height, 64))
212 int right = x + char_width - 1;
213 while (right > left && vline_empty(surface, right, y, y + char_height, 64))
218 glyph.offset = Vector(x-left, 0);
219 glyph.advance = right - left + 1 + 1; // FIXME: might be useful to make spacing configurable
222 { // glyph is completly transparent
223 glyph.offset = Vector(0, 0);
224 glyph.advance = char_width + 1; // FIXME: might be useful to make spacing configurable
227 glyph.rect = Rectf(x, y, x + char_width, y + char_height);
230 glyphs[*chr] = glyph;
232 if( col>0 && col <= wrap ) {
238 if( surface != NULL ) {
239 SDL_UnlockSurface(surface);
240 SDL_FreeSurface(surface);
249 Font::get_text_width(const std::string& text) const
251 float curr_width = 0;
252 float last_width = 0;
254 for(UTF8Iterator it(text); !it.done(); ++it)
258 last_width = std::max(last_width, curr_width);
263 if( glyphs.at(*it).surface_idx != -1 )
264 curr_width += glyphs[*it].advance;
266 curr_width += glyphs[0x20].advance;
270 return std::max(curr_width, last_width);
274 Font::get_text_height(const std::string& text) const
276 std::string::size_type text_height = char_height;
278 for(std::string::const_iterator it = text.begin(); it != text.end(); ++it)
279 { // since UTF8 multibyte characters are decoded with values
280 // outside the ASCII range there is no risk of overlapping and
281 // thus we don't need to decode the utf-8 string
283 text_height += char_height + 2;
290 Font::get_height() const
296 Font::wrap_to_chars(const std::string& s, int line_length, std::string* overflow)
298 // if text is already smaller, return full text
299 if ((int)s.length() <= line_length) {
300 if (overflow) *overflow = "";
304 // if we can find a whitespace character to break at, return text up to this character
306 while ((i > 0) && (s[i] != ' ')) i--;
308 if (overflow) *overflow = s.substr(i+1);
309 return s.substr(0, i);
312 // FIXME: wrap at line_length, taking care of multibyte characters
313 if (overflow) *overflow = "";
318 Font::wrap_to_width(const std::string& s_, float width, std::string* overflow)
322 // if text is already smaller, return full text
323 if (get_text_width(s) <= width) {
324 if (overflow) *overflow = "";
328 // if we can find a whitespace character to break at, return text up to this character
329 for (int i = s.length()-1; i >= 0; i--) {
330 std::string s2 = s.substr(0,i);
331 if (s[i] != ' ') continue;
332 if (get_text_width(s2) <= width) {
333 if (overflow) *overflow = s.substr(i+1);
334 return s.substr(0, i);
338 // FIXME: hard-wrap at width, taking care of multibyte characters
339 if (overflow) *overflow = "";
344 Font::draw(Renderer *renderer, const std::string& text, const Vector& pos_,
345 FontAlignment alignment, DrawingEffect drawing_effect, Color color,
351 std::string::size_type last = 0;
352 for(std::string::size_type i = 0;; ++i)
354 if (text[i] == '\n' || i == text.size())
356 std::string temp = text.substr(last, i - last);
358 // calculate X positions based on the alignment type
359 Vector pos = Vector(x, y);
361 if(alignment == ALIGN_CENTER)
362 pos.x -= get_text_width(temp) / 2;
363 else if(alignment == ALIGN_RIGHT)
364 pos.x -= get_text_width(temp);
366 // Cast font position to integer to get a clean drawing result and
367 // no blurring as we would get with subpixel positions
368 pos.x = static_cast<int>(pos.x);
370 draw_text(renderer, temp, pos, drawing_effect, color, alpha);
372 if (i == text.size())
375 y += char_height + 2;
382 Font::draw_text(Renderer *renderer, const std::string& text, const Vector& pos,
383 DrawingEffect drawing_effect, Color color, float alpha) const
386 draw_chars(renderer, false, text,
387 pos + Vector(shadowsize, shadowsize), drawing_effect, Color(1,1,1), alpha);
389 draw_chars(renderer, true, text, pos, drawing_effect, color, alpha);
393 Font::draw_chars(Renderer *renderer, bool notshadow, const std::string& text,
394 const Vector& pos, DrawingEffect drawing_effect, Color color,
399 for(UTF8Iterator it(text); !it.done(); ++it)
404 p.y += char_height + 2;
408 p.x += glyphs[0x20].advance;
413 if( glyphs.at(*it).surface_idx != -1 )
416 glyph = glyphs[0x20];
418 DrawingRequest request;
420 request.pos = p + glyph.offset;
421 request.drawing_effect = drawing_effect;
422 request.color = color;
423 request.alpha = alpha;
425 SurfacePartRequest surfacepartrequest;
426 surfacepartrequest.size = glyph.rect.p2 - glyph.rect.p1;
427 surfacepartrequest.source = glyph.rect.p1;
428 surfacepartrequest.surface = notshadow ? glyph_surfaces[glyph.surface_idx].get() : shadow_surfaces[glyph.surface_idx].get();
430 request.request_data = &surfacepartrequest;
431 renderer->draw_surface_part(request);
433 p.x += glyph.advance;