1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
|
/*
* Copyright (C) 2002-2011 by the Widelands Development Team
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Some Methods taken from Wesnoth.
* http://www.wesnoth.org
*/
#include "graphic/font_handler.h"
#include <list>
#include <memory>
#include <SDL_ttf.h>
#include <boost/algorithm/string.hpp>
#include <boost/format.hpp>
#include "base/log.h"
#include "base/wexception.h"
#include "graphic/font_handler1.h" // We need the fontset for the BiDi algorithm
#include "graphic/graphic.h"
#include "graphic/rendertarget.h"
#include "graphic/text/bidi.h"
#include "graphic/texture.h"
#include "graphic/wordwrap.h"
namespace UI {
namespace {
/**
* Draw the caret for the given text rendered exactly at the given point
* (including \ref LINE_MARGIN).
*/
void draw_caret(RenderTarget& dst,
const TextStyle& style,
const Point& dstpoint,
const std::string& text,
uint32_t caret_offset) {
int caret_x = style.calc_bare_width(text.substr(0, caret_offset));
const Image* caret_image = g_gr->images().get("images/ui_basic/caret.png");
Point caretpt;
caretpt.x = dstpoint.x + caret_x + LINE_MARGIN - caret_image->width();
caretpt.y = dstpoint.y + (style.font->height() - caret_image->height()) / 2;
dst.blit(caretpt, caret_image);
}
} // namespace
/// The global unique \ref FontHandler object
FontHandler* g_fh = nullptr;
/**
* The line cache stores unprocessed rendered lines of text.
*/
struct LineCacheEntry {
/*@{*/
TextStyle style;
std::string text;
/*@}*/
/*@{*/
std::unique_ptr<const Image> image;
uint32_t width;
uint32_t height;
/*@}*/
};
using LineCache = std::list<LineCacheEntry>;
static const unsigned MaxLineCacheSize = 500;
/**
* Internal data of the \ref FontHandler.
*/
struct FontHandler::Data {
LineCache linecache;
const LineCacheEntry& get_line(const TextStyle& style, const std::string& text);
~Data() {
while (!linecache.empty()) {
linecache.pop_back();
}
}
private:
void render_line(LineCacheEntry& lce);
};
/**
* Plain Constructor
*/
FontHandler::FontHandler() : d(new Data) {
}
FontHandler::~FontHandler() {
flush();
Font::shutdown();
}
void FontHandler::flush() {
d.reset(new Data);
}
/*
* Returns the height of the font, in pixels.
*/
uint32_t FontHandler::get_fontheight(const std::string& name, int32_t const size) {
TTF_Font* const f = Font::get(name, size)->get_ttf_font();
const int32_t fontheight = TTF_FontHeight(f);
if (fontheight < 0)
throw wexception("TTF_FontHeight returned a negative value, which does not have a "
"known meaning.");
return fontheight;
}
/**
* Get a cache entry for the given text (without linebreaks!) rendered
* in the given style.
*
* If there is no pre-existing cache entry, a new one is created.
*/
const LineCacheEntry& FontHandler::Data::get_line(const UI::TextStyle& style,
const std::string& text) {
for (LineCache::iterator it = linecache.begin(); it != linecache.end(); ++it) {
if (it->style != style || it->text != text)
continue;
// Found a hit, move to front
if (it != linecache.begin())
linecache.splice(linecache.begin(), linecache, it);
return *it;
}
// Cache miss; render a new image.
LineCache::iterator it = linecache.insert(linecache.begin(), LineCacheEntry());
it->style = style;
it->text = text;
it->image = nullptr;
render_line(*it);
while (linecache.size() > MaxLineCacheSize) {
linecache.pop_back();
}
return *it;
}
/**
* Render the image of a \ref LineCacheEntry whose key data has
* already been filled in.
*/
void FontHandler::Data::render_line(LineCacheEntry& lce) {
TTF_Font* font = lce.style.font->get_ttf_font();
SDL_Color sdl_fg = {lce.style.fg.r, lce.style.fg.g, lce.style.fg.b, SDL_ALPHA_OPAQUE};
std::string renderme = i18n::make_ligatures(lce.text.c_str());
if (i18n::has_rtl_character(lce.text.c_str())) {
renderme = i18n::line2bidi(renderme.c_str());
}
// Work around an Issue in SDL_TTF that dies when the surface
// has zero width
int width = 0;
if (TTF_SizeUTF8(font, renderme.c_str(), &width, nullptr) < 0 || !width) {
lce.width = 0;
lce.height = TTF_FontHeight(font);
return;
}
lce.style.setup();
SDL_Surface* text_surface = TTF_RenderUTF8_Blended(font, renderme.c_str(), sdl_fg);
if (!text_surface) {
log("FontHandler::render_line, an error : %s\n", TTF_GetError());
log("Text was: '%s'\n", renderme.c_str());
return;
}
lce.image.reset(new Texture(text_surface));
lce.width = lce.image->width();
lce.height = lce.image->height();
}
/**
* Draw unwrapped, single-line text (i.e. no line breaks).
*/
void FontHandler::draw_text(RenderTarget& dst,
const TextStyle& style,
Point dstpoint,
const std::string& text,
Align align,
uint32_t caret) {
// Erase every backslash in front of brackets
std::string copytext = boost::replace_all_copy(text, "\\<", "<");
boost::replace_all(copytext, "\\>", ">");
copytext = i18n::make_ligatures(copytext.c_str());
const LineCacheEntry& lce = d->get_line(style, copytext);
UI::correct_for_align(align, lce.width + 2 * LINE_MARGIN, lce.height, &dstpoint);
if (lce.image)
dst.blit(Point(dstpoint.x + LINE_MARGIN, dstpoint.y), lce.image.get());
if (caret <= copytext.size())
draw_caret(dst, style, dstpoint, copytext, caret);
}
/**
* Draw unwrapped, un-aligned single-line text at the given point, and return the width of the text.
*/
uint32_t FontHandler::draw_text_raw(RenderTarget& dst,
const UI::TextStyle& style,
Point dstpoint,
const std::string& text) {
const LineCacheEntry& lce = d->get_line(style, text);
if (lce.image)
dst.blit(dstpoint, lce.image.get());
return lce.width;
}
/**
* Compute the total size of the given text, when wrapped to the given
* maximum width and rendered in the given text style.
*/
void FontHandler::get_size(
const TextStyle& textstyle, const std::string& text, uint32_t& w, uint32_t& h, uint32_t wrap) {
WordWrap ww(textstyle, wrap);
ww.wrap(text);
w = ww.width();
h = ww.height();
}
/**
* Calculates size of a given text.
*/
void FontHandler::get_size(const std::string& fontname,
int32_t const fontsize,
const std::string& text,
uint32_t& w,
uint32_t& h,
uint32_t const wrap) {
// use bold style by default for historical reasons
get_size(TextStyle::makebold(Font::get(fontname, fontsize), RGBColor(255, 255, 255)), text, w, h,
wrap);
}
} // namespace UI
|