scummvm/graphics/macgui/mactext-md.cpp
Eugene Sandulenko ed4ec96b44
GRAPHICS: MACGUI: Fix links with Unicode characters
If there are unicode characters in the link, it was leading to
wrong length calculation.

Example of such link:

  ![Menü-Symbol](menu.png \"Menü-Symbol\"){w=10em}

The problem is that for simplicity, we are working with UTF8 in
Markdown, but still with U32String in MacTextCanvas. This led to
the string length be calculated for UTF8, which is a multibyte
encoding. As a result, we were overshooting the link parsing
and reading texts as numbers.

This is kind of a hacky solution: we convert text to U32 before
caluclating the string length
2024-01-07 00:39:25 +01:00

383 lines
11 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
* 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
#include "common/formats/markdown.h"
#include "graphics/macgui/mactext.h"
namespace Graphics {
#define PR(x) ((x && x->data) ? Common::toPrintable(Common::String((const char *)(x)->data , (x)->size)).c_str() : "(null)")
struct MDState {
Common::List<int> listNum;
uint32 linkr = 0, linkg = 0, linkb = 0;
};
void render_blockcode(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, const Common::SDDataBuffer *lang, void *opaque) {
if (!text)
return;
Common::String res = Common::String::format("\n\001\016+0001" "\001\016t%04x" "%s" "\001\016tffff" "\n\001\016-0001",
kMacFontMonaco, Common::String((const char *)text->data , text->size).c_str());
sd_bufput(ob, res.c_str(), res.size());
debug(1, "render_blockcode(%s, %s)", PR(text), PR(lang));
}
void render_blockquote(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, void *opaque) {
if (!text)
return;
warning("STUB: render_blockquote(%s)", PR(text));
}
void render_blockhtml(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, void *opaque) {
if (!text)
return;
warning("STUB: render_blockhtml(%s)", PR(text));
}
void render_header(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, int level, void *opaque) {
if (!text)
return;
debug(1, "render_header(%s)", PR(text));
Common::String res = Common::String::format("\001\016+00%01x0" "%s" "\001\016-00f0\n", level, Common::String((const char *)text->data , text->size).c_str());
sd_bufput(ob, res.c_str(), res.size());
}
void render_hrule(Common::SDDataBuffer *ob, void *opaque) {
warning("STUB: render_hrule()");
}
void render_list_start(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, int flags, void *opaque) {
MDState *mdstate = (MDState *)opaque;
mdstate->listNum.push_back(flags & MKD_LIST_ORDERED ? 1 : -1);
sd_bufput(ob, "\001\016+0001", 7);
debug(1, "render_list_start(%s, %d)", PR(text), flags);
}
void render_list(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, int flags, void *opaque) {
MDState *mdstate = (MDState *)opaque;
mdstate->listNum.pop_back();
sd_bufput(ob, text->data, text->size);
sd_bufput(ob, "\n\001\016-0001", 8);
debug(1, "render_list(%s, %d)", PR(text), flags);
}
void render_listitem(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, int flags, void *opaque) {
MDState *mdstate = (MDState *)opaque;
int listNum = mdstate->listNum.back();
Common::String prefix;
if (flags & MKD_LIST_ORDERED) {
prefix = Common::String::format("%d. ", listNum);
mdstate->listNum.back()++;
} else {
prefix = "* ";
}
Common::String res = Common::String::format("\001\016*%02x%s", prefix.size(), prefix.c_str());
sd_bufput(ob, res.c_str(), res.size());
sd_bufput(ob, prefix.c_str(), prefix.size());
sd_bufput(ob, text->data, text->size);
debug(1, "render_listitem(%s, %d)", PR(text), flags);
}
void render_paragraph(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, void *opaque) {
if (!text)
return;
debug(1, "render_paragraph(%s)", PR(text));
sd_bufput(ob, text->data, text->size);
sd_bufput(ob, "\n\n", 2);
}
void render_table(Common::SDDataBuffer *ob, const Common::SDDataBuffer *header, const Common::SDDataBuffer *body, void *opaque) {
if (!body)
return;
Common::String res = Common::String::format("\001\016Th" "%s" "\001\016Tb" "%s" "\001\016TB",
Common::String((const char *)header->data , header->size).c_str(), Common::String((const char *)body->data , body->size).c_str());
sd_bufput(ob, res.c_str(), res.size());
debug(1, "render_table(%s, %s)", PR(header), PR(body));
}
void render_table_row(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, void *opaque) {
if (!text)
return;
Common::String res = Common::String::format("\001\016Tr" "%s\n", Common::String((const char *)text->data , text->size).c_str());
sd_bufput(ob, res.c_str(), res.size());
debug(1, "render_table_row(%s)", PR(text));
}
void render_table_cell(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, int flags, void *opaque) {
if (!text)
return;
TextAlign align;
switch (flags) {
case Common::MKD_TABLE_ALIGN_R:
align = kTextAlignRight;
break;
case Common::MKD_TABLE_ALIGN_CENTER:
align = kTextAlignCenter;
break;
case Common::MKD_TABLE_ALIGN_L:
default:
align = kTextAlignLeft;
}
Common::String res = Common::String((const char *)text->data, text->size);
if (flags & Common::MKD_TABLE_HEADER)
res = Common::String::format("\001\016+%02x00" "%s" "\001\016-%02x00", kMacFontBold, res.c_str(), kMacFontBold);
res = Common::String::format("\001\016Tc%02x" "%s" "\001\016TC", align, res.c_str());
sd_bufput(ob, res.c_str(), res.size());
debug(1, "render_table_cell(%s), flags: %d", PR(text), flags);
}
int render_autolink(Common::SDDataBuffer *ob, const Common::SDDataBuffer *link, Common::MKDAutolink type, void *opaque) {
if (!link)
return 0;
warning("STUB: render_autolink(%s)", PR(link));
return 1;
}
int render_codespan(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, void *opaque) {
if (!text)
return 0;
Common::String res = Common::String::format("\001\016t%04x" "%s" "\001\016tffff",
kMacFontMonaco, Common::String((const char *)text->data , text->size).c_str());
sd_bufput(ob, res.c_str(), res.size());
debug(1, "render_codespan(%s)", PR(text));
return 1;
}
int render_double_emphasis(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, void *opaque) {
if (!text || !text->size)
return 0;
debug(1, "render_double_emphasis(%s)", PR(text));
Common::String res = Common::String::format("\001\016+%02x00" "%s" "\001\016-%02x00", kMacFontBold, Common::String((const char *)text->data , text->size).c_str(), kMacFontBold);
sd_bufput(ob, res.c_str(), res.size());
return 1;
}
int render_emphasis(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, void *opaque) {
if (!text || !text->size)
return 0;
debug(1, "render_emphasis(%s)", PR(text));
Common::String res = Common::String::format("\001\016+%02x00" "%s" "\001\016-%02x00", kMacFontItalic, Common::String((const char *)text->data , text->size).c_str(), kMacFontItalic);
sd_bufput(ob, res.c_str(), res.size());
return 1;
}
int render_image(Common::SDDataBuffer *ob, const Common::SDDataBuffer *link, const Common::SDDataBuffer *title, const Common::SDDataBuffer *alt, const Common::SDDataBuffer *ext, void *opaque) {
if (!link)
return 0;
Common::String res = Common::String::format("\001" "\016i%02x" "%02x%s",
80, (uint)link->size, Common::String((const char *)link->data, link->size).c_str());
if (alt) {
uint32 len = Common::U32String((const char *)alt->data, alt->size).size();
res += Common::String::format("%02x%s", len, Common::String((const char *)alt->data, alt->size).c_str());
} else {
res += "00";
}
if (title) {
uint32 len = Common::U32String((const char *)title->data, title->size).size();
res += Common::String::format("%02x%s", len, Common::String((const char *)title->data, title->size).c_str());
} else {
res += "00";
}
if (ext) {
uint32 len = Common::U32String((const char *)ext->data, ext->size).size();
res += Common::String::format("%02x%s", len, Common::String((const char *)ext->data, ext->size).c_str());
} else {
res += "00";
}
res += "\n";
sd_bufput(ob, res.c_str(), res.size());
debug(1, "render_image(%s, %s, %s, %s)", PR(link), PR(title), PR(alt), PR(ext));
return 1;
}
int render_linebreak(Common::SDDataBuffer *ob, void *opaque) {
debug(1, "render_linebreak()");
sd_bufput(ob, "\n", 1);
return 1;
}
int render_link(Common::SDDataBuffer *ob, const Common::SDDataBuffer *link, const Common::SDDataBuffer *title, const Common::SDDataBuffer *content, void *opaque) {
if (!link)
return 0;
MDState *mdstate = (MDState *)opaque;
const Common::SDDataBuffer *text = content ? content : link;
uint32 linklen = Common::U32String((const char *)link->data, link->size).size();
Common::String res = Common::String::format("\001" "\016+%02x00" "\001\016[%04x%04x%04x"
"\001\016l%02x%s" "%s" "\001\016l00" "\001\016]" "\001\016-%02x00", kMacFontUnderline,
mdstate->linkr, mdstate->linkg, mdstate->linkb,
linklen, Common::String((const char *)link->data , link->size).c_str(),
Common::String((const char *)text->data , text->size).c_str(), kMacFontUnderline);
sd_bufput(ob, res.c_str(), res.size());
debug(1, "render_link(%s, %s, %s)", PR(link), PR(title), PR(content));
return 1;
}
int render_raw_html_tag(Common::SDDataBuffer *ob, const Common::SDDataBuffer *tag, void *opaque) {
if (!tag)
return 0;
sd_bufput(ob, tag->data, tag->size);
debug(1, "render_raw_html_tag(%s)", PR(tag));
return 1;
}
int render_triple_emphasis(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, void *opaque) {
if (!text)
return 0;
warning("STUB: render_triple_emphasis(%s)", PR(text));
return 1;
}
int render_strikethrough(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, void *opaque) {
if (!text)
return 0;
warning("STUB: render_strikethrough(%s)", PR(text));
return 1;
}
int render_superscript(Common::SDDataBuffer *ob, const Common::SDDataBuffer *text, void *opaque) {
if (!text)
return 0;
warning("STUB: render_superscript(%s)", PR(text));
return 1;
}
void MacText::setMarkdownText(const Common::U32String &str) {
const Common::SDCallbacks cb = {
/* block level callbacks - NULL skips the block */
render_blockcode,
render_blockquote,
render_blockhtml,
render_header,
render_hrule,
render_list_start,
render_list,
render_listitem,
render_paragraph,
render_table,
render_table_row,
render_table_cell,
/* span level callbacks - NULL or return 0 prints the span verbatim */
render_autolink,
render_codespan,
render_double_emphasis,
render_emphasis,
render_image,
render_linebreak,
render_link,
render_raw_html_tag,
render_triple_emphasis,
render_strikethrough,
render_superscript,
/* low level callbacks - NULL copies input directly into the output */
NULL,
NULL,
/* header and footer */
NULL,
NULL,
};
Common::String input = str.encode(); // Encode to UTF8
MDState mdState;
// Set link color to blue
mdState.linkr = 0;
mdState.linkg = 0;
mdState.linkb = 0xff;
Common::SDMarkdown md(Common::MKDEXT_TABLES, 16, &cb, &mdState);
Common::String rendered = md.render((const byte *)input.c_str(), input.size());
setText(rendered);
}
} // End of namespace Graphics