Skip to content

Support IBusLookupTable signal for IBus frontend #1420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Support IBusLookupTable signal for IBus frontend #1420

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
85e8972
Support lookup table signal for IBus frontend
chenx-dust Sep 23, 2025
afb3235
Align capability behavior to IBus
chenx-dust Sep 23, 2025
fd7054d
Refactor ibusfrontend candidate list publishing
chenx-dust Sep 24, 2025
34e3366
Fix no candidate case to fit ibus behavior
chenx-dust Sep 24, 2025
849c97b
Better show/hide lookup table logic
chenx-dust Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 121 additions & 3 deletions src/frontend/ibusfrontend/ibusfrontend.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@ using AttachmentsType = FCITX_STRING_TO_DBUS_TYPE("a{sv}");
using IBusText = FCITX_STRING_TO_DBUS_TYPE("(sa{sv}sv)");
using IBusAttrList = FCITX_STRING_TO_DBUS_TYPE("(sa{sv}av)");
using IBusAttribute = FCITX_STRING_TO_DBUS_TYPE("(sa{sv}uuuu)");
using IBusLookupTable = FCITX_STRING_TO_DBUS_TYPE("(sa{sv}uubbiavav)");

IBusAttribute makeIBusAttr(uint32_t type, uint32_t value, uint32_t start,
uint32_t end) {
Expand All @@ -289,6 +290,47 @@ IBusText makeSimpleIBusText(const std::string &str) {
return text;
}

IBusLookupTable makeIBusLookupTable(uint32_t pageSize, uint32_t cursorPos,
bool cursorVisible, bool round,
CandidateLayoutHint layoutHint,
const std::vector<std::string> &candidates,
const std::vector<std::string> &labels) {
IBusLookupTable table;
std::get<0>(table) = "IBusLookupTable";
std::get<2>(table) = pageSize;
std::get<3>(table) = cursorPos;
std::get<4>(table) = cursorVisible;
std::get<5>(table) = round;

enum IBusOrientation {
IBUS_ORIENTATION_HORIZONTAL = 0,
IBUS_ORIENTATION_VERTICAL = 1,
IBUS_ORIENTATION_SYSTEM = 2,
};
switch (layoutHint) {
case CandidateLayoutHint::Horizontal:
std::get<6>(table) = IBUS_ORIENTATION_HORIZONTAL;
break;
case CandidateLayoutHint::NotSet:
std::get<6>(table) = IBUS_ORIENTATION_SYSTEM;
break;
case CandidateLayoutHint::Vertical:
std::get<6>(table) = IBUS_ORIENTATION_VERTICAL;
break;
}

std::vector<dbus::Variant> ibus_candidates(candidates.size());
for (const auto &candidate : candidates) {
std::get<7>(table).emplace_back(
dbus::Variant(makeSimpleIBusText(candidate)));
}
for (const auto &label : labels) {
std::get<8>(table).emplace_back(
dbus::Variant(makeSimpleIBusText(label)));
}
return table;
}

} // namespace

class IBusFrontend : public dbus::ObjectVTable<IBusFrontend> {
Expand Down Expand Up @@ -427,6 +469,68 @@ class IBusInputContext : public InputContext,
static_cast<uint32_t>(code), state);
bus()->flush();
}

void updateClientSideUIImpl() override {
auto *instance = im_->instance();
auto candidateList = inputPanel().candidateList();

std::vector<std::string> candidates, labels;
int cursorIndex = 0;
int pageSize = 0;
CandidateLayoutHint layoutHint;
if (!candidateList) {
if (showingLookupTable_) {
hideLookupTableTo(name_);
showingLookupTable_ = false;
}
return;
}

pageSize = candidateList->size();
cursorIndex = candidateList->cursorIndex();
layoutHint = candidateList->layoutHint();

auto processCandidate = [&](const CandidateWord& candidate, bool appendLabel, Text fallbackLabel) {
if (candidate.isPlaceHolder()) {
return;
}
Text candidateText =
instance->outputFilter(this, candidate.textWithComment());
candidates.emplace_back(candidateText.toString());
if (appendLabel) {
Text labelText = candidate.hasCustomLabel()
? candidate.customLabel()
: fallbackLabel;
labelText = instance->outputFilter(this, labelText);
labels.emplace_back(labelText.toString());
}
};

// All previous candidates should be sent to ibus.
auto cursorList = candidateList->toBulkCursor();
auto bulkList = candidateList->toBulk();
auto pageList = candidateList->toPageable();
if (cursorList && bulkList && pageList) {
cursorIndex = cursorList->globalCursorIndex();
int firstCandidateGlobalIndex =
cursorIndex - candidateList->cursorIndex();
for (int i = 0; i < firstCandidateGlobalIndex; i++) {
processCandidate(bulkList->candidateFromAll(i), false, Text());
}
}
for (int i = 0, e = candidateList->size(); i < e; i++) {
processCandidate(candidateList->candidate(i), true,
candidateList->label(i));
}

IBusLookupTable table = makeIBusLookupTable(
pageSize, cursorIndex, true, false, layoutHint, candidates, labels);
if (!showingLookupTable_) {
showLookupTableTo(name_);
showingLookupTable_ = true;
}
updateLookupTableTo(name_, table, true);
}
#define CHECK_SENDER_OR_RETURN \
if (currentMessage()->sender() != name_) \
return
Expand Down Expand Up @@ -473,8 +577,17 @@ class IBusInputContext : public InputContext,
IBUS_CAP_SURROUNDING_TEXT = 1 << 5
};
auto flags = capabilityFlags()
.unset(CapabilityFlag::Preedit)
.unset(CapabilityFlag::FormattedPreedit)
.unset(CapabilityFlag::SurroundingText);
.unset(CapabilityFlag::SurroundingText)
.unset(CapabilityFlag::ClientSideInputPanel);
// No IBUS_CAP_FOCUS means to handle all and always focus in
if ((cap & IBUS_CAP_FOCUS) == 0) {
cap |= (IBUS_CAP_PREEDIT_TEXT | IBUS_CAP_AUXILIARY_TEXT |
IBUS_CAP_LOOKUP_TABLE | IBUS_CAP_PROPERTY);
this->focusIn();
this->setFocusGroup(nullptr);
}
if (cap & IBUS_CAP_PREEDIT_TEXT) {
flags |= CapabilityFlag::Preedit;
flags |= CapabilityFlag::FormattedPreedit;
Expand All @@ -485,6 +598,9 @@ class IBusInputContext : public InputContext,
requireSurroundingTextTo(name_);
}
}
if (cap & IBUS_CAP_LOOKUP_TABLE) {
flags |= CapabilityFlag::ClientSideInputPanel;
}

setCapabilityFlags(flags);
}
Expand Down Expand Up @@ -560,6 +676,8 @@ class IBusInputContext : public InputContext,
"DeleteSurroundingText", "iu");
FCITX_OBJECT_VTABLE_SIGNAL(requireSurroundingText, "RequireSurroundingText",
"");
FCITX_OBJECT_VTABLE_SIGNAL(updateLookupTable, "UpdateLookupTable", "vb");
FCITX_OBJECT_VTABLE_SIGNAL(hideLookupTable, "HideLookupTable", "");

// We don't use following
FCITX_OBJECT_VTABLE_SIGNAL(showPreeditText, "ShowPreeditText", "");
Expand All @@ -568,9 +686,7 @@ class IBusInputContext : public InputContext,
"vb");
FCITX_OBJECT_VTABLE_SIGNAL(showAuxiliaryText, "ShowAuxiliaryText", "");
FCITX_OBJECT_VTABLE_SIGNAL(hideAuxiliaryText, "hideAuxiliaryText", "");
FCITX_OBJECT_VTABLE_SIGNAL(updateLookupTable, "UpdateLookupTable", "vb");
FCITX_OBJECT_VTABLE_SIGNAL(showLookupTable, "ShowLookupTable", "");
FCITX_OBJECT_VTABLE_SIGNAL(hideLookupTable, "HideLookupTable", "");
FCITX_OBJECT_VTABLE_SIGNAL(pageUpLookupTable, "PageUpLookupTable", "");
FCITX_OBJECT_VTABLE_SIGNAL(pageDownLookupTable, "PageDownLookupTable", "");
FCITX_OBJECT_VTABLE_SIGNAL(cursorUpLookupTable, "CursorUpLookupTable", "");
Expand Down Expand Up @@ -712,6 +828,7 @@ class IBusInputContext : public InputContext,
std::string name_;
bool clientCommitPreedit_ = false;
bool effectivePostProcessKeyEvent_ = false;
bool showingLookupTable_ = false;

IBusService service_{this};
};
Expand All @@ -737,6 +854,7 @@ IBusFrontendModule::IBusFrontendModule(Instance *instance)
dbus::VariantTypeRegistry::defaultRegistry().registerType<IBusText>();
dbus::VariantTypeRegistry::defaultRegistry().registerType<IBusAttribute>();
dbus::VariantTypeRegistry::defaultRegistry().registerType<IBusAttrList>();
dbus::VariantTypeRegistry::defaultRegistry().registerType<IBusLookupTable>();

// Do the resource initialization first.
inputMethod1_ = std::make_unique<IBusFrontend>(
Expand Down