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 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
|
#include "OSDText.hh"
#include "TTFFont.hh"
#include "SDLImage.hh"
#include "Display.hh"
#include "CommandException.hh"
#include "FileContext.hh"
#include "FileOperations.hh"
#include "TclObject.hh"
#include "StringOp.hh"
#include "join.hh"
#include "stl.hh"
#include "unreachable.hh"
#include "utf8_core.hh"
#include "components.hh"
#include <cassert>
#include <cmath>
#include <memory>
#if COMPONENT_GL
#include "GLImage.hh"
#endif
using std::string;
using std::string_view;
using std::vector;
using namespace gl;
namespace openmsx {
OSDText::OSDText(Display& display_, const TclObject& name_)
: OSDImageBasedWidget(display_, name_)
, fontfile(DEFAULT_FONT)
, size(12)
, wrapMode(NONE), wrapw(0.0), wraprelw(1.0)
{
}
vector<string_view> OSDText::getProperties() const
{
auto result = OSDImageBasedWidget::getProperties();
static constexpr const char* const vals[] = {
"-text", "-font", "-size", "-wrap", "-wrapw", "-wraprelw",
"-query-size",
};
append(result, vals);
return result;
}
void OSDText::setProperty(
Interpreter& interp, string_view propName, const TclObject& value)
{
if (propName == "-text") {
string_view val = value.getString();
if (text != val) {
text = val;
// note: don't invalidate font (don't reopen font file)
OSDImageBasedWidget::invalidateLocal();
invalidateChildren();
}
} else if (propName == "-font") {
string val(value.getString());
if (fontfile != val) {
string file = systemFileContext().resolve(val);
if (!FileOperations::isRegularFile(file)) {
throw CommandException("Not a valid font file: ", val);
}
fontfile = val;
invalidateRecursive();
}
} else if (propName == "-size") {
int size2 = value.getInt(interp);
if (size != size2) {
size = size2;
invalidateRecursive();
}
} else if (propName == "-wrap") {
string_view val = value.getString();
WrapMode wrapMode2;
if (val == "none") {
wrapMode2 = NONE;
} else if (val == "word") {
wrapMode2 = WORD;
} else if (val == "char") {
wrapMode2 = CHAR;
} else {
throw CommandException("Not a valid value for -wrap, "
"expected one of 'none word char', but got '",
val, "'.");
}
if (wrapMode != wrapMode2) {
wrapMode = wrapMode2;
invalidateRecursive();
}
} else if (propName == "-wrapw") {
float wrapw2 = value.getDouble(interp);
if (wrapw != wrapw2) {
wrapw = wrapw2;
invalidateRecursive();
}
} else if (propName == "-wraprelw") {
float wraprelw2 = value.getDouble(interp);
if (wraprelw != wraprelw2) {
wraprelw = wraprelw2;
invalidateRecursive();
}
} else if (propName == "-query-size") {
throw CommandException("-query-size property is readonly");
} else {
OSDImageBasedWidget::setProperty(interp, propName, value);
}
}
void OSDText::getProperty(string_view propName, TclObject& result) const
{
if (propName == "-text") {
result = text;
} else if (propName == "-font") {
result = fontfile;
} else if (propName == "-size") {
result = size;
} else if (propName == "-wrap") {
string wrapString;
switch (wrapMode) {
case NONE: wrapString = "none"; break;
case WORD: wrapString = "word"; break;
case CHAR: wrapString = "char"; break;
default: UNREACHABLE;
}
result = wrapString;
} else if (propName == "-wrapw") {
result = wrapw;
} else if (propName == "-wraprelw") {
result = wraprelw;
} else if (propName == "-query-size") {
auto [w, h] = getRenderedSize();
result.addListElement(w, h);
} else {
OSDImageBasedWidget::getProperty(propName, result);
}
}
void OSDText::invalidateLocal()
{
font = TTFFont(); // clear font
OSDImageBasedWidget::invalidateLocal();
}
string_view OSDText::getType() const
{
return "text";
}
vec2 OSDText::getSize(const OutputSurface& /*output*/) const
{
if (image) {
return vec2(image->getSize());
} else {
// we don't know the dimensions, must be because of an error
assert(hasError());
return {};
}
}
uint8_t OSDText::getFadedAlpha() const
{
return byte((getRGBA(0) & 0xff) * getRecursiveFadeValue());
}
template <typename IMAGE> std::unique_ptr<BaseImage> OSDText::create(
OutputSurface& output)
{
if (text.empty()) {
return std::make_unique<IMAGE>(output, ivec2(), 0);
}
int scale = getScaleFactor(output);
if (font.empty()) {
try {
string file = systemFileContext().resolve(fontfile);
int ptSize = size * scale;
font = TTFFont(file, ptSize);
} catch (MSXException& e) {
throw MSXException("Couldn't open font: ", e.getMessage());
}
}
try {
vec2 pSize = getParent()->getSize(output);
int maxWidth = lrintf(wrapw * scale + wraprelw * pSize[0]);
// Width can't be negative, if it is make it zero instead.
// This will put each character on a different line.
maxWidth = std::max(0, maxWidth);
// TODO gradient???
unsigned textRgba = getRGBA(0);
string wrappedText;
if (wrapMode == NONE) {
wrappedText = text; // don't wrap
} else if (wrapMode == WORD) {
wrappedText = getWordWrappedText(text, maxWidth);
} else if (wrapMode == CHAR) {
wrappedText = getCharWrappedText(text, maxWidth);
} else {
UNREACHABLE;
}
// An alternative is to pass vector<string> to TTFFont::render().
// That way we can avoid join() (in the wrap functions)
// followed by // StringOp::split() (in TTFFont::render()).
SDLSurfacePtr surface(font.render(wrappedText,
(textRgba >> 24) & 0xff, (textRgba >> 16) & 0xff, (textRgba >> 8) & 0xff));
if (surface) {
return std::make_unique<IMAGE>(output, std::move(surface));
} else {
return std::make_unique<IMAGE>(output, ivec2(), 0);
}
} catch (MSXException& e) {
throw MSXException("Couldn't render text: ", e.getMessage());
}
}
// Search for a position strictly between min and max which also points to the
// start of a (possibly multi-byte) utf8-character. If no such position exits,
// this function returns 'min'.
static size_t findCharSplitPoint(const string& line, size_t min, size_t max)
{
auto pos = (min + max) / 2;
auto beginIt = line.data();
auto posIt = beginIt + pos;
auto fwdIt = utf8::sync_forward(posIt);
auto maxIt = beginIt + max;
assert(fwdIt <= maxIt);
if (fwdIt != maxIt) {
return fwdIt - beginIt;
}
auto bwdIt = utf8::sync_backward(posIt);
auto minIt = beginIt + min;
assert(minIt <= bwdIt); (void)minIt;
return bwdIt - beginIt;
}
// Search for a position that's strictly between min and max and which points
// to a character directly following a delimiter character. if no such position
// exits, this function returns 'min'.
// This function works correctly with multi-byte utf8-encoding as long as
// all delimiter characters are single byte chars.
static size_t findWordSplitPoint(string_view line, size_t min, size_t max)
{
static constexpr const char* const delimiters = " -/";
// initial guess for a good position
assert(min < max);
size_t pos = (min + max) / 2;
if (pos == min) {
// can't reduce further
return min;
}
// try searching backward (this also checks current position)
assert(pos > min);
auto pos2 = line.substr(min, pos - min).find_last_of(delimiters);
if (pos2 != string_view::npos) {
pos2 += min + 1;
assert(min < pos2);
assert(pos2 <= pos);
return pos2;
}
// try searching forward
auto pos3 = line.substr(pos, max - pos).find_first_of(delimiters);
if (pos3 != string_view::npos) {
pos3 += pos;
assert(pos3 < max);
pos3 += 1; // char directly after a delimiter;
if (pos3 < max) {
return pos3;
}
}
return min;
}
static size_t takeSingleChar(const string& /*line*/, unsigned /*maxWidth*/)
{
return 1;
}
template<typename FindSplitPointFunc, typename CantSplitFunc>
size_t OSDText::split(const string& line, unsigned maxWidth,
FindSplitPointFunc findSplitPoint,
CantSplitFunc cantSplit,
bool removeTrailingSpaces) const
{
if (line.empty()) {
// empty line always fits (explicitly handle this because
// SDL_TTF can't handle empty strings)
return 0;
}
unsigned width, height;
font.getSize(line, width, height);
if (width <= maxWidth) {
// whole line fits
return line.size();
}
// binary search till we found the largest initial substring that is
// not wider than maxWidth
size_t min = 0;
size_t max = line.size();
// invariant: line.substr(0, min) DOES fit
// line.substr(0, max) DOES NOT fit
size_t cur = findSplitPoint(line, min, max);
if (cur == 0) {
// Could not find a valid split point, then split on char
// (this also handles the case of a single too wide char)
return cantSplit(line, maxWidth);
}
while (true) {
assert(min < cur);
assert(cur < max);
string curStr = line.substr(0, cur);
if (removeTrailingSpaces) {
StringOp::trimRight(curStr, ' ');
}
font.getSize(curStr, width, height);
if (width <= maxWidth) {
// still fits, try to enlarge
size_t next = findSplitPoint(line, cur, max);
if (next == cur) {
return cur;
}
min = cur;
cur = next;
} else {
// doesn't fit anymore, try to shrink
size_t next = findSplitPoint(line, min, cur);
if (next == min) {
if (min == 0) {
// even the first word does not fit,
// split on char (see above)
return cantSplit(line, maxWidth);
}
return min;
}
max = cur;
cur = next;
}
}
}
size_t OSDText::splitAtChar(const std::string& line, unsigned maxWidth) const
{
return split(line, maxWidth, findCharSplitPoint, takeSingleChar, false);
}
struct SplitAtChar {
explicit SplitAtChar(const OSDText& osdText_) : osdText(osdText_) {}
size_t operator()(const string& line, unsigned maxWidth) {
return osdText.splitAtChar(line, maxWidth);
}
const OSDText& osdText;
};
size_t OSDText::splitAtWord(const std::string& line, unsigned maxWidth) const
{
return split(line, maxWidth, findWordSplitPoint, SplitAtChar(*this), true);
}
string OSDText::getCharWrappedText(const string& txt, unsigned maxWidth) const
{
vector<string_view> wrappedLines;
for (auto& line : StringOp::split(txt, '\n')) {
do {
auto p = splitAtChar(string(line), maxWidth);
wrappedLines.push_back(line.substr(0, p));
line = line.substr(p);
} while (!line.empty());
}
return join(wrappedLines, '\n');
}
string OSDText::getWordWrappedText(const string& txt, unsigned maxWidth) const
{
vector<string_view> wrappedLines;
for (auto& line : StringOp::split(txt, '\n')) {
do {
auto p = splitAtWord(string(line), maxWidth);
string_view first = line.substr(0, p);
StringOp::trimRight(first, ' '); // remove trailing spaces
wrappedLines.push_back(first);
line = line.substr(p);
StringOp::trimLeft(line, ' '); // remove leading spaces
} while (!line.empty());
}
return join(wrappedLines, '\n');
}
vec2 OSDText::getRenderedSize() const
{
auto* output = getDisplay().getOutputSurface();
if (!output) {
throw CommandException(
"Can't query size: no window visible");
}
// force creating image (does not yet draw it on screen)
const_cast<OSDText*>(this)->createImage(*output);
vec2 imageSize = image ? vec2(image->getSize()) : vec2();
return imageSize / float(getScaleFactor(*output));
}
std::unique_ptr<BaseImage> OSDText::createSDL(OutputSurface& output)
{
return create<SDLImage>(output);
}
std::unique_ptr<BaseImage> OSDText::createGL(OutputSurface& output)
{
#if COMPONENT_GL
return create<GLImage>(output);
#else
(void)&output;
return nullptr;
#endif
}
} // namespace openmsx
|