mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-09-20 02:28:10 +08:00
Prefer std::string over std::wstring. (#179)
In the past, FTXUI switched from std::string to std::wstring to support fullwidth characters. The reasons was that fullwidth characters can be stored inside a single wchar_t. Then FTXUI added support for combining characters. A single glygh doesn't even fit a wchar_t. Instead, a glyph can be arbitrary large. The usage of wstring doesn't really fit the new model and have several drawbacks: 1. It doesn't simplify the implementation of FTXUI, because of combining characters. 2. It reduces drawing performance by 2x. 3. It increase Screen's memory allocation by 2x. This patch converts FTXUI to use std::string internally. It now exposes std::string based API. The std::wstring API remains, but is now deprecated. Tests and examples haven't been update to show the breakage is limited. They will be updated in a second set of patches. Bug: https://github.com/ArthurSonzogni/FTXUI/issues/153 Co-authored-by: Tushar Maheshwari <tushar27192@gmail.com>
This commit is contained in:
Arthur Sonzogni
@@ -1,9 +1,291 @@
|
||||
// Most of this code is borrowed from:
|
||||
// Markus Kuhn -- 2007-05-26 (Unicode 5.0)
|
||||
// Latest version: http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
|
||||
// Thanks you!
|
||||
//
|
||||
// Modified by Arthur Sonzogni for FTXUI.
|
||||
|
||||
#include "ftxui/screen/string.hpp"
|
||||
|
||||
#include <codecvt> // for codecvt_utf8_utf16
|
||||
#include <locale> // for wstring_convert
|
||||
#include <stddef.h> // for size_t
|
||||
#include <stdint.h> // for uint32_t, uint8_t
|
||||
#include <codecvt> // for codecvt_utf8_utf16
|
||||
#include <locale> // for wstring_convert
|
||||
#include <string> // for string, basic_string, wstring, allocator
|
||||
|
||||
namespace {
|
||||
|
||||
struct Interval {
|
||||
uint32_t first;
|
||||
uint32_t last;
|
||||
};
|
||||
|
||||
// Sorted list of non-overlapping intervals of non-spacing characters
|
||||
// generated by "uniset +cat=Me +cat=Mn +cat=Cf -00AD +1160-11FF +200B c"
|
||||
static const Interval g_combining_characters[] = {
|
||||
{0x0300, 0x036F}, {0x0483, 0x0486}, {0x0488, 0x0489},
|
||||
{0x0591, 0x05BD}, {0x05BF, 0x05BF}, {0x05C1, 0x05C2},
|
||||
{0x05C4, 0x05C5}, {0x05C7, 0x05C7}, {0x0600, 0x0603},
|
||||
{0x0610, 0x0615}, {0x064B, 0x065E}, {0x0670, 0x0670},
|
||||
{0x06D6, 0x06E4}, {0x06E7, 0x06E8}, {0x06EA, 0x06ED},
|
||||
{0x070F, 0x070F}, {0x0711, 0x0711}, {0x0730, 0x074A},
|
||||
{0x07A6, 0x07B0}, {0x07EB, 0x07F3}, {0x0901, 0x0902},
|
||||
{0x093C, 0x093C}, {0x0941, 0x0948}, {0x094D, 0x094D},
|
||||
{0x0951, 0x0954}, {0x0962, 0x0963}, {0x0981, 0x0981},
|
||||
{0x09BC, 0x09BC}, {0x09C1, 0x09C4}, {0x09CD, 0x09CD},
|
||||
{0x09E2, 0x09E3}, {0x0A01, 0x0A02}, {0x0A3C, 0x0A3C},
|
||||
{0x0A41, 0x0A42}, {0x0A47, 0x0A48}, {0x0A4B, 0x0A4D},
|
||||
{0x0A70, 0x0A71}, {0x0A81, 0x0A82}, {0x0ABC, 0x0ABC},
|
||||
{0x0AC1, 0x0AC5}, {0x0AC7, 0x0AC8}, {0x0ACD, 0x0ACD},
|
||||
{0x0AE2, 0x0AE3}, {0x0B01, 0x0B01}, {0x0B3C, 0x0B3C},
|
||||
{0x0B3F, 0x0B3F}, {0x0B41, 0x0B43}, {0x0B4D, 0x0B4D},
|
||||
{0x0B56, 0x0B56}, {0x0B82, 0x0B82}, {0x0BC0, 0x0BC0},
|
||||
{0x0BCD, 0x0BCD}, {0x0C3E, 0x0C40}, {0x0C46, 0x0C48},
|
||||
{0x0C4A, 0x0C4D}, {0x0C55, 0x0C56}, {0x0CBC, 0x0CBC},
|
||||
{0x0CBF, 0x0CBF}, {0x0CC6, 0x0CC6}, {0x0CCC, 0x0CCD},
|
||||
{0x0CE2, 0x0CE3}, {0x0D41, 0x0D43}, {0x0D4D, 0x0D4D},
|
||||
{0x0DCA, 0x0DCA}, {0x0DD2, 0x0DD4}, {0x0DD6, 0x0DD6},
|
||||
{0x0E31, 0x0E31}, {0x0E34, 0x0E3A}, {0x0E47, 0x0E4E},
|
||||
{0x0EB1, 0x0EB1}, {0x0EB4, 0x0EB9}, {0x0EBB, 0x0EBC},
|
||||
{0x0EC8, 0x0ECD}, {0x0F18, 0x0F19}, {0x0F35, 0x0F35},
|
||||
{0x0F37, 0x0F37}, {0x0F39, 0x0F39}, {0x0F71, 0x0F7E},
|
||||
{0x0F80, 0x0F84}, {0x0F86, 0x0F87}, {0x0F90, 0x0F97},
|
||||
{0x0F99, 0x0FBC}, {0x0FC6, 0x0FC6}, {0x102D, 0x1030},
|
||||
{0x1032, 0x1032}, {0x1036, 0x1037}, {0x1039, 0x1039},
|
||||
{0x1058, 0x1059}, {0x1160, 0x11FF}, {0x135F, 0x135F},
|
||||
{0x1712, 0x1714}, {0x1732, 0x1734}, {0x1752, 0x1753},
|
||||
{0x1772, 0x1773}, {0x17B4, 0x17B5}, {0x17B7, 0x17BD},
|
||||
{0x17C6, 0x17C6}, {0x17C9, 0x17D3}, {0x17DD, 0x17DD},
|
||||
{0x180B, 0x180D}, {0x18A9, 0x18A9}, {0x1920, 0x1922},
|
||||
{0x1927, 0x1928}, {0x1932, 0x1932}, {0x1939, 0x193B},
|
||||
{0x1A17, 0x1A18}, {0x1B00, 0x1B03}, {0x1B34, 0x1B34},
|
||||
{0x1B36, 0x1B3A}, {0x1B3C, 0x1B3C}, {0x1B42, 0x1B42},
|
||||
{0x1B6B, 0x1B73}, {0x1DC0, 0x1DCA}, {0x1DFE, 0x1DFF},
|
||||
{0x200B, 0x200F}, {0x202A, 0x202E}, {0x2060, 0x2063},
|
||||
{0x206A, 0x206F}, {0x20D0, 0x20EF}, {0x302A, 0x302F},
|
||||
{0x3099, 0x309A}, {0xA806, 0xA806}, {0xA80B, 0xA80B},
|
||||
{0xA825, 0xA826}, {0xFB1E, 0xFB1E}, {0xFE00, 0xFE0F},
|
||||
{0xFE20, 0xFE23}, {0xFEFF, 0xFEFF}, {0xFFF9, 0xFFFB},
|
||||
{0x10A01, 0x10A03}, {0x10A05, 0x10A06}, {0x10A0C, 0x10A0F},
|
||||
{0x10A38, 0x10A3A}, {0x10A3F, 0x10A3F}, {0x1D167, 0x1D169},
|
||||
{0x1D173, 0x1D182}, {0x1D185, 0x1D18B}, {0x1D1AA, 0x1D1AD},
|
||||
{0x1D242, 0x1D244}, {0xE0001, 0xE0001}, {0xE0020, 0xE007F},
|
||||
{0xE0100, 0xE01EF},
|
||||
};
|
||||
|
||||
static const Interval g_full_width_characters[] = {
|
||||
{0x1100, 0x115f}, {0x2329, 0x2329}, {0x232a, 0x232a}, {0x2e80, 0x303e},
|
||||
{0x3040, 0xa4cf}, {0xac00, 0xd7a3}, {0xf900, 0xfaff}, {0xfe10, 0xfe19},
|
||||
{0xfe30, 0xfe6f}, {0xff00, 0xff60}, {0xffe0, 0xffe6}, {0x20000, 0x2fffd},
|
||||
{0x30000, 0x3fffd},
|
||||
};
|
||||
|
||||
// Find a codepoint inside a sorted list of Interval.
|
||||
int Bisearch(uint32_t ucs, const Interval* table, int max) {
|
||||
if (ucs < table[0].first || ucs > table[max].last)
|
||||
return 0;
|
||||
|
||||
int min = 0;
|
||||
while (max >= min) {
|
||||
int mid = (min + max) / 2;
|
||||
if (ucs > table[mid].last)
|
||||
min = mid + 1;
|
||||
else if (ucs < table[mid].first)
|
||||
max = mid - 1;
|
||||
else
|
||||
return 1;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
bool IsCombining(uint32_t ucs) {
|
||||
return Bisearch(ucs, g_combining_characters,
|
||||
sizeof(g_combining_characters) / sizeof(Interval) - 1);
|
||||
}
|
||||
|
||||
bool IsFullWidth(uint32_t ucs) {
|
||||
if (ucs < 0x0300) // Quick path:
|
||||
return false;
|
||||
|
||||
return Bisearch(ucs, g_full_width_characters,
|
||||
sizeof(g_full_width_characters) / sizeof(Interval) - 1);
|
||||
}
|
||||
|
||||
bool IsControl(uint32_t ucs) {
|
||||
if (ucs == 0)
|
||||
return true;
|
||||
if (ucs < 32)
|
||||
return true;
|
||||
if (ucs >= 0x7f && ucs < 0xa0)
|
||||
return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
int codepoint_width(uint32_t ucs) {
|
||||
if (IsControl(ucs))
|
||||
return -1;
|
||||
|
||||
if (IsCombining(ucs))
|
||||
return 0;
|
||||
|
||||
if (IsFullWidth(ucs))
|
||||
return 2;
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
// From UTF8 encoded string |input|, eat in between 1 and 4 byte representing
|
||||
// one codepoint. Put the codepoint into |ucs|. Start at |start| and update
|
||||
// |end| to represent the beginning of the next byte to eat for consecutive
|
||||
// executions.
|
||||
bool EatCodePoint(const std::string& input,
|
||||
size_t start,
|
||||
size_t* end,
|
||||
uint32_t* ucs) {
|
||||
if (start >= input.size()) {
|
||||
*end = start + 1;
|
||||
return false;
|
||||
}
|
||||
uint8_t byte_1 = input[start];
|
||||
|
||||
// 1 byte string.
|
||||
if ((byte_1 & 0b1000'0000) == 0b0000'0000) {
|
||||
*ucs = byte_1 & 0b0111'1111;
|
||||
*end = start + 1;
|
||||
return true;
|
||||
}
|
||||
|
||||
// 2 byte string.
|
||||
if ((byte_1 & 0b1110'0000) == 0b1100'0000 && start + 1 < input.size()) {
|
||||
uint8_t byte_2 = input[start + 1];
|
||||
*ucs = 0;
|
||||
*ucs += byte_1 & 0b0001'1111;
|
||||
*ucs <<= 6;
|
||||
*ucs += byte_2 & 0b0011'1111;
|
||||
*end = start + 2;
|
||||
return true;
|
||||
}
|
||||
|
||||
// 3 byte string.
|
||||
if ((byte_1 & 0b1111'0000) == 0b1110'0000 && start + 2 < input.size()) {
|
||||
uint8_t byte_2 = input[start + 1];
|
||||
uint8_t byte_3 = input[start + 2];
|
||||
*ucs = 0;
|
||||
*ucs += byte_1 & 0b0000'1111;
|
||||
*ucs <<= 6;
|
||||
*ucs += byte_2 & 0b0011'1111;
|
||||
*ucs <<= 6;
|
||||
*ucs += byte_3 & 0b0011'1111;
|
||||
*end = start + 3;
|
||||
return true;
|
||||
}
|
||||
|
||||
// 4 byte string.
|
||||
if ((byte_1 & 0b1111'1000) == 0b1111'0000 && start + 3 < input.size()) {
|
||||
uint8_t byte_2 = input[start + 1];
|
||||
uint8_t byte_3 = input[start + 2];
|
||||
uint8_t byte_4 = input[start + 3];
|
||||
*ucs = 0;
|
||||
*ucs += byte_1 & 0b0000'0111;
|
||||
*ucs <<= 6;
|
||||
*ucs += byte_2 & 0b0011'1111;
|
||||
*ucs <<= 6;
|
||||
*ucs += byte_3 & 0b0011'1111;
|
||||
*ucs <<= 6;
|
||||
*ucs += byte_4 & 0b0011'1111;
|
||||
*end = start + 4;
|
||||
return true;
|
||||
}
|
||||
|
||||
*end = start + 1;
|
||||
return false;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
namespace ftxui {
|
||||
int wchar_width(wchar_t ucs) {
|
||||
return codepoint_width(uint32_t(ucs));
|
||||
}
|
||||
|
||||
int wstring_width(const std::wstring& text) {
|
||||
int width = 0;
|
||||
|
||||
for (const wchar_t& it : text) {
|
||||
int w = wchar_width(it);
|
||||
if (w < 0)
|
||||
return -1;
|
||||
width += w;
|
||||
}
|
||||
return width;
|
||||
}
|
||||
|
||||
int string_width(const std::string& input) {
|
||||
int width = 0;
|
||||
size_t start = 0;
|
||||
while (start < input.size()) {
|
||||
uint32_t codepoint = 0;
|
||||
if (!EatCodePoint(input, start, &start, &codepoint))
|
||||
continue;
|
||||
|
||||
if (IsControl(codepoint))
|
||||
continue;
|
||||
|
||||
if (IsCombining(codepoint))
|
||||
continue;
|
||||
|
||||
if (IsFullWidth(codepoint)) {
|
||||
width += 2;
|
||||
continue;
|
||||
}
|
||||
|
||||
width += 1;
|
||||
}
|
||||
return width;
|
||||
}
|
||||
|
||||
std::vector<std::string> Utf8ToGlyphs(const std::string& input) {
|
||||
std::vector<std::string> out;
|
||||
std::string current;
|
||||
out.reserve(input.size());
|
||||
size_t start = 0;
|
||||
size_t end = 0;
|
||||
while (start < input.size()) {
|
||||
uint32_t codepoint;
|
||||
if (!EatCodePoint(input, start, &end, &codepoint)) {
|
||||
start = end;
|
||||
continue;
|
||||
}
|
||||
|
||||
std::string append = input.substr(start, end - start);
|
||||
start = end;
|
||||
|
||||
// Ignore control characters.
|
||||
if (IsControl(codepoint))
|
||||
continue;
|
||||
|
||||
// Combining characters are put with the previous glyph they are modifying.
|
||||
if (IsCombining(codepoint)) {
|
||||
if (out.size() != 0)
|
||||
out.back() += append;
|
||||
continue;
|
||||
}
|
||||
|
||||
// Fullwidth characters take two cells. The second is made of the empty
|
||||
// string to reserve the space the first is taking.
|
||||
if (IsFullWidth(codepoint)) {
|
||||
out.push_back(append);
|
||||
out.push_back("");
|
||||
continue;
|
||||
}
|
||||
|
||||
// Normal characters:
|
||||
out.push_back(append);
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
#ifdef _MSC_VER
|
||||
#pragma warning(push)
|
||||
#pragma warning(disable : 4996) // codecvt_utf8_utf16 is deprecated
|
||||
|
||||
Reference in New Issue
Block a user