Skip to content

Commit b2d88cb

Browse files
drvosslhecker
authored and
DHowett
committed
Fix Korean IME overlay hiding characters to the right of cursor (#20041)
This commit fixes a regression in v1.24, where composing Korean text in-between existing characters causes text to the right to be hidden. This is problematic for the Korean IME, because it commonly inserts the composed syllable between existing characters. The fix compresses (removes/absorbs) available whitespace to the right of the composition to make space for any existing text. This means that a composition now virtually acts in insert mode. Closes #20040 Refs #19738 Refs #20039 ## Validation Steps Performed 1. Korean IME: compose `ㄷ` between `가` and `나` → display shows `가ㄷ나`, `나` visible. 2. TUI box (vim prompt with padding): compose inside padded text box → border preserved in place. 3. Composition at end of line (no chars to right): unaffected. 4. English and other IME input: not affected (no active composition row). Co-authored-by: jason <drvoss@users.noreply.github.com> Co-authored-by: Leonard Hecker <lhecker@microsoft.com> (cherry picked from commit 7a83c0f) Service-Card-Id: PVTI_lADOAF3p4s4BQX0-zgo0JpY Service-Version: 1.25
1 parent fcc614e commit b2d88cb

File tree

4 files changed

+111
-32
lines changed

4 files changed

+111
-32
lines changed

‎src/buffer/out/Row.cpp‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1143,6 +1143,13 @@ til::CoordType ROW::GetTrailingColumnAtCharOffset(const ptrdiff_t offset) const
11431143
return _createCharToColumnMapper(offset).GetTrailingColumnAt(offset);
11441144
}
11451145

1146+
uint16_t ROW::GetCharOffset(til::CoordType col) const noexcept
1147+
{
1148+
const auto columns = GetReadableColumnCount();
1149+
const auto colBeg = clamp(col, 0, columns);
1150+
return _uncheckedCharOffset(gsl::narrow_cast<size_t>(colBeg));
1151+
}
1152+
11461153
DelimiterClass ROW::DelimiterClassAt(til::CoordType column, const std::wstring_view& wordDelimiters) const noexcept
11471154
{
11481155
const auto col = _clampedColumn(column);

‎src/buffer/out/Row.hpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@ class ROW final
172172
std::wstring_view GetText(til::CoordType columnBegin, til::CoordType columnEnd) const noexcept;
173173
til::CoordType GetLeadingColumnAtCharOffset(ptrdiff_t offset) const noexcept;
174174
til::CoordType GetTrailingColumnAtCharOffset(ptrdiff_t offset) const noexcept;
175+
uint16_t GetCharOffset(til::CoordType col) const noexcept;
175176
DelimiterClass DelimiterClassAt(til::CoordType column, const std::wstring_view& wordDelimiters) const noexcept;
176177

177178
auto AttrBegin() const noexcept { return _attr.begin(); }

‎src/renderer/base/renderer.cpp‎

Lines changed: 102 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1072,38 +1072,7 @@ void Renderer::_PaintBufferOutput(_In_ IRenderEngine* const pEngine)
10721072
ROW* rowBackup = nullptr;
10731073
if (row == compositionRow)
10741074
{
1075-
auto& scratch = buffer.GetScratchpadRow();
1076-
scratch.CopyFrom(r);
1077-
rowBackup = &scratch;
1078-
1079-
std::wstring_view text{ activeComposition.text };
1080-
RowWriteState state{
1081-
.columnLimit = r.GetReadableColumnCount(),
1082-
.columnEnd = _compositionCache->absoluteOrigin.x,
1083-
};
1084-
1085-
size_t off = 0;
1086-
for (const auto& range : activeComposition.attributes)
1087-
{
1088-
const auto len = range.len;
1089-
auto attr = range.attr;
1090-
1091-
// Use the color at the cursor if TSF didn't specify any explicit color.
1092-
if (attr.GetBackground().IsDefault())
1093-
{
1094-
attr.SetBackground(_compositionCache->baseAttribute.GetBackground());
1095-
}
1096-
if (attr.GetForeground().IsDefault())
1097-
{
1098-
attr.SetForeground(_compositionCache->baseAttribute.GetForeground());
1099-
}
1100-
1101-
state.text = text.substr(off, len);
1102-
state.columnBegin = state.columnEnd;
1103-
const_cast<ROW&>(r).ReplaceText(state);
1104-
const_cast<ROW&>(r).ReplaceAttributes(state.columnBegin, state.columnEnd, attr);
1105-
off += len;
1106-
}
1075+
rowBackup = _PaintBufferOutputComposition(buffer, r, activeComposition);
11071076
}
11081077
const auto restore = wil::scope_exit([&] {
11091078
if (rowBackup)
@@ -1143,6 +1112,107 @@ void Renderer::_PaintBufferOutput(_In_ IRenderEngine* const pEngine)
11431112
}
11441113
}
11451114

1115+
ROW* Renderer::_PaintBufferOutputComposition(TextBuffer& buffer, const ROW& r, const Composition& activeComposition)
1116+
{
1117+
auto& scratch = buffer.GetScratchpadRow();
1118+
scratch.CopyFrom(r);
1119+
1120+
// *Overwrite* the original text with the active composition...
1121+
til::CoordType compositionEnd = 0;
1122+
{
1123+
std::wstring_view text{ activeComposition.text };
1124+
RowWriteState state{
1125+
.columnLimit = r.GetReadableColumnCount(),
1126+
.columnEnd = _compositionCache->absoluteOrigin.x,
1127+
};
1128+
1129+
size_t off = 0;
1130+
for (const auto& range : activeComposition.attributes)
1131+
{
1132+
const auto len = range.len;
1133+
auto attr = range.attr;
1134+
1135+
// Use the color at the cursor if TSF didn't specify any explicit color.
1136+
if (attr.GetBackground().IsDefault())
1137+
{
1138+
attr.SetBackground(_compositionCache->baseAttribute.GetBackground());
1139+
}
1140+
if (attr.GetForeground().IsDefault())
1141+
{
1142+
attr.SetForeground(_compositionCache->baseAttribute.GetForeground());
1143+
}
1144+
1145+
state.text = text.substr(off, len);
1146+
state.columnBegin = state.columnEnd;
1147+
const_cast<ROW&>(r).ReplaceText(state);
1148+
const_cast<ROW&>(r).ReplaceAttributes(state.columnBegin, state.columnEnd, attr);
1149+
off += len;
1150+
}
1151+
1152+
compositionEnd = state.columnEnd;
1153+
}
1154+
1155+
// The text we've overwritten may have been crucial to the user,
1156+
// so copy it back by absorbing available whitespace to the right
1157+
// and re-inserting the non-whitespace characters instead.
1158+
const auto compositionWidth = compositionEnd - _compositionCache->absoluteOrigin.x;
1159+
const auto colLimit = r.GetReadableColumnCount();
1160+
if (compositionWidth > 0 && compositionEnd < colLimit)
1161+
{
1162+
const auto text = scratch.GetText();
1163+
auto srcCol = _compositionCache->absoluteOrigin.x;
1164+
auto dstCol = compositionEnd;
1165+
auto remaining = compositionWidth;
1166+
size_t i = scratch.GetCharOffset(srcCol);
1167+
1168+
while (i < text.size() && dstCol < colLimit)
1169+
{
1170+
// Treat whitespace we encounter as a credit towards our composition width.
1171+
// This loop essentially absorbs the whitespace.
1172+
while (i < text.size() && til::at(text, i) == L' ' && remaining > 0)
1173+
{
1174+
remaining--;
1175+
srcCol++;
1176+
i++;
1177+
}
1178+
if (remaining <= 0)
1179+
{
1180+
break;
1181+
}
1182+
1183+
// Find the end of the non-whitespace span: Our span of text to insert.
1184+
auto spanEnd = i;
1185+
while (spanEnd < text.size() && til::at(text, spanEnd) != L' ')
1186+
{
1187+
spanEnd++;
1188+
}
1189+
1190+
// Copy the non-whitespace segment from the original text (scratch) back in.
1191+
RowCopyTextFromState state{
1192+
.source = scratch,
1193+
.columnBegin = dstCol,
1194+
.columnLimit = colLimit,
1195+
.sourceColumnBegin = srcCol,
1196+
.sourceColumnLimit = scratch.GetLeadingColumnAtCharOffset(spanEnd),
1197+
};
1198+
const_cast<ROW&>(r).CopyTextFrom(state);
1199+
1200+
const auto srcBeg = gsl::narrow_cast<uint16_t>(srcCol);
1201+
const auto srcEnd = gsl::narrow_cast<uint16_t>(state.sourceColumnEnd);
1202+
const auto attr = scratch.Attributes().slice(srcBeg, srcEnd);
1203+
const auto dstBeg = gsl::narrow_cast<uint16_t>(dstCol);
1204+
const auto dstEnd = gsl::narrow_cast<uint16_t>(dstCol + attr.size());
1205+
const_cast<ROW&>(r).Attributes().replace(dstBeg, dstEnd, attr);
1206+
1207+
dstCol = state.columnEnd;
1208+
srcCol = state.sourceColumnEnd;
1209+
i = spanEnd;
1210+
}
1211+
}
1212+
1213+
return &scratch;
1214+
}
1215+
11461216
static bool _IsAllSpaces(const std::wstring_view v)
11471217
{
11481218
// first non-space char is not found (is npos)

‎src/renderer/base/renderer.hpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ namespace Microsoft::Console::Render
121121
void _scheduleRenditionBlink();
122122
[[nodiscard]] HRESULT _PaintBackground(_In_ IRenderEngine* const pEngine);
123123
void _PaintBufferOutput(_In_ IRenderEngine* const pEngine);
124+
ROW* _PaintBufferOutputComposition(TextBuffer& buffer, const ROW& r, const Composition& activeComposition);
124125
void _PaintBufferOutputHelper(_In_ IRenderEngine* const pEngine, TextBufferCellIterator it, const til::point target);
125126
void _PaintBufferOutputGridLineHelper(_In_ IRenderEngine* const pEngine, const TextAttribute textAttribute, const size_t cchLine, const til::point coordTarget);
126127
bool _isHoveredHyperlink(const TextAttribute& textAttribute) const noexcept;

0 commit comments

Comments
 (0)
⚡