refactor: integration of qt_completion_listbox

Author: JimZhouZZY

src/Edit/Interface/edit_complete.cpp

@@ -1,4 +1,3 @@
-
 /******************************************************************************
  * MODULE     : edit_complete.cpp
  * DESCRIPTION: Tab completion
@@ -16,6 +15,7 @@
 #include "hashset.hpp"
 #include "iterator.hpp"
 #include "merge_sort.hpp"
+#include "message.hpp"
 #include "observers.hpp"
 #include "tree_observer.hpp"
 
@@ -132,6 +132,34 @@ edit_interface_rep::complete_start (string prefix, array<string> compls) {
     completion_prefix= prefix;
     completions      = close_completions (compls);
     completion_pos   = 0;
+    bool visible;
+    SERVER (get_completion_listbox_visible (visible))
+    if (!visible) {
+      // TODO: refactor this part to edit_interface_rep::show_completion_listbox
+      array<string> full_completions;
+      for (int i= 0; i < N (completions); ++i) {
+        string c= completions[i];
+        if (c == completion_prefix) continue; // skip the prefix itself
+        full_completions << (completion_prefix * c);
+      }
+
+      path tp1= tp;
+      for (int i= 0; i < N (prefix); ++i) {
+        tp1= previous_valid (et, tp1);
+      }
+
+      cursor cu= eb->find_check_cursor (tp1);
+      // cout << "Prefix Cursor: " << cu->ox << ", " << cu->oy << LF;
+      SI pos_x=
+          ((cu->ox - get_scroll_x () - 500) * magf + get_canvas_x ()) / 256;
+      SI pos_y= -((cu->oy - 5000 - get_scroll_y ()) * magf) / 256;
+      // TODO: 5000 is a magic number to add space between completion list box
+      // and the text.
+      //       We need to find a better way to get the position
+
+      SERVER (show_completion_listbox (full_completions, pos_x, pos_y));
+    }
+
     insert_tree (completions[0]);
     complete_message ();
     beep ();
@@ -142,9 +170,17 @@ edit_interface_rep::complete_start (string prefix, array<string> compls) {
 bool
 edit_interface_rep::complete_keypress (string key) {
   set_message ("", "");
+  cout << "complete_keypress: " << key << LF;
   if (key == "space") key= " ";
-  if ((key != "tab") && (key != "S-tab")) {
+
+  if (key == "enter" || key == "return") {
+    set_input_normal ();
+    SERVER (set_completion_listbox_visible (false));
+    return true;
+  }
+  if ((key != "tab") && (key != "S-tab") && (key != "up") && (key != "down")) {
     set_input_normal ();
+    SERVER (set_completion_listbox_visible (false));
     return false;
   }
   tree st= subtree (et, path_up (tp));
@@ -161,10 +197,17 @@ edit_interface_rep::complete_keypress (string key) {
     return false;
   }
 
-  if (key == "tab") completion_pos++;
-  else completion_pos--;
+  if (key == "tab" || key == "down") {
+    completion_pos++;
+    SERVER (set_completion_listbox_next (true));
+  }
+  else if (key == "S-tab" || key == "up") {
+    completion_pos--;
+    SERVER (set_completion_listbox_next (false));
+  }
   if (completion_pos < 0) completion_pos= N (completions) - 1;
   if (completion_pos >= N (completions)) completion_pos= 0;
+  SERVER (set_completion_listbox_visible (true))
   string new_s= completions[completion_pos];
   remove (path_up (tp) * (end - N (old_s)), N (old_s));
   insert (path_up (tp) * (end - N (old_s)), new_s);

src/Graphics/Gui/message.hpp

@@ -51,6 +51,9 @@ enum slot_id {
   SLOT_VISIBLE_PART,
   SLOT_SCROLLBARS_VISIBILITY,
   SLOT_SCROLL_POSITION,
+  SLOT_COMPLETION_LISTBOX_SHOW,
+  SLOT_COMPLETION_LISTBOX_VISIBLE,
+  SLOT_COMPLETION_LISTBOX_NEXT,
   SLOT_CANVAS,
   SLOT_SCROLLABLE,
   SLOT_CURSOR,
@@ -502,6 +505,27 @@ set_scroll_position (widget w, SI x, SI y) {
   send<SI, SI> (w, SLOT_SCROLL_POSITION, x, y);
 }
 
+inline void
+show_completion_listbox (widget w, array<string>& completions, SI x, SI y) {
+  send<array<string>, SI, SI> (w, SLOT_COMPLETION_LISTBOX_SHOW, completions, x,
+                               y);
+}
+
+inline void
+get_completion_listbox_visible (widget w, bool& visible) {
+  query<bool> (w, SLOT_COMPLETION_LISTBOX_VISIBLE);
+}
+
+inline void
+set_completion_listbox_visible (widget w, bool visible) {
+  send<bool> (w, SLOT_COMPLETION_LISTBOX_VISIBLE, visible);
+}
+
+inline void
+set_completion_listbox_next (widget w, bool next) {
+  send<bool> (w, SLOT_COMPLETION_LISTBOX_NEXT, next);
+}
+
 inline void
 get_scroll_position (widget w, SI& x, SI& y) {
   // get scroll position in a canvas

src/Graphics/Gui/widget.cpp

@@ -47,6 +47,9 @@ slot_name (const slot s) {
                              "SLOT_VISIBLE_PART",
                              "SLOT_SCROLLBARS_VISIBILITY",
                              "SLOT_SCROLL_POSITION",
+                             "SLOT_COMPLETION_LISTBOX_SHOW",
+                             "SLOT_COMPLETION_LISTBOX_VISIBLE",
+                             "SLOT_COMPLETION_LISTBOX_NEXT",
                              "SLOT_CANVAS",
                              "SLOT_SCROLLABLE",
                              "SLOT_CURSOR",

src/Plugins/Qt/qt_completion_listbox.cpp

@@ -0,0 +1,121 @@
+/******************************************************************************
+ * MODULE     : qt_completion_listbox.cpp
+ * DESCRIPTION: Implementation of Completion ListBox widget for auto-completion
+ * COPYRIGHT  : (C) 2025 JimZhouZZY
+ *******************************************************************************
+ * This software falls under the GNU general public license version 3 or later.
+ * It comes WITHOUT ANY WARRANTY WHATSOEVER. For details, see the file LICENSE
+ * in the root directory or <http://www.gnu.org/licenses/gpl-3.0.html>.
+ ******************************************************************************/
+
+#include "qt_completion_listbox.hpp"
+#include "QTMScrollView.hpp"
+#include "message.hpp"
+#include <QApplication>
+#include <QKeyEvent>
+#include <QScrollBar>
+
+QtCompletionListBox::QtCompletionListBox (QWidget* parent)
+    : QListWidget (parent), eventTarget (nullptr) {
+  setWindowFlags (Qt::FramelessWindowHint |
+                  Qt::WindowStaysOnTopHint); // Qt::Window, Qt::Popup
+  setFocusPolicy (Qt::NoFocus);              // Qt::ClickFocus, Qt::StrongFocus
+  setSelectionMode (QAbstractItemView::SingleSelection);
+  setMouseTracking (true);
+
+  setStyleSheet ("QListWidget::item:selected {"
+                 "  background-color: #3daee9;" // 蓝色背景
+                 "  color: white;"              // 白色文字
+                 "}"
+                 "QListWidget::item:hover {"
+                 "  background-color: #93cee9;" // 浅蓝色悬停
+                 "}"
+                 "QListWidget {"
+                 "  border: 1px solid #bfbfbf;"
+                 "  background-color: white;"
+                 "  alternate-background-color: #f0f0f0;"
+                 "}");
+
+  connect (this, &QListWidget::itemClicked, this,
+           &QtCompletionListBox::onItemClicked);
+}
+
+void
+QtCompletionListBox::showCompletions (array<string>& completions, SI x, SI y) {
+  clear ();
+  for (int i= 0; i < N (completions); ++i) {
+    addItem (QString::fromUtf8 (as_charp (completions[i])));
+  }
+  if (N (completions) > 0) setCurrentRow (0);
+
+  QSize  size (200, qMin (100, 20 + N (completions) * 22));
+  QPoint topLeft (x, y);
+  // qDebug () << "QtCompletionListBox::showCompletions: "
+  //           << "x=" << x << ", y=" << y << ", size=" << size.width () << "x"
+  //           << size.height () << Qt::endl;
+  move (topLeft);
+  resize (size);
+  showComponent ();
+}
+
+void
+QtCompletionListBox::showComponent () {
+  // Ensure the listbox is visible
+  show ();
+  raise ();
+  // activateWindow ();
+  // setFocus (Qt::ActiveWindowFocusReason);
+}
+
+void
+QtCompletionListBox::keyPressEvent (QKeyEvent* event) {
+  return;
+}
+
+void
+QtCompletionListBox::focusOutEvent (QFocusEvent* event) {
+  hide ();
+  QListWidget::focusOutEvent (event);
+}
+
+void
+QtCompletionListBox::onItemClicked (QListWidgetItem* item) {
+  if (item) {
+    emit completionSelected (item->text ());
+    hide ();
+  }
+}
+
+void
+QtCompletionListBox::wheelEvent (QWheelEvent* event) {
+  QListWidget::wheelEvent (event);
+}
+
+void
+QtCompletionListBox::selectNextItem () {
+  int row= currentRow ();
+  if (row < count () - 1) setCurrentRow (row + 1);
+  else setCurrentRow (0);
+}
+
+void
+QtCompletionListBox::selectPreviousItem () {
+  int row= currentRow ();
+  if (0 < row) setCurrentRow (row - 1);
+  else setCurrentRow (count () - 1);
+}
+
+void
+QtCompletionListBox::selectItemIndex (int index) {
+  if (index >= 0 && index < count ()) {
+    setCurrentRow (index);
+  }
+  else {
+    // std::cerr << "Index out of bounds: " << index << std::endl;
+  }
+}
+
+void
+QtCompletionListBox::setEventTarget (QWidget* target) {
+  eventTarget= target;
+}

src/Plugins/Qt/qt_completion_listbox.hpp

@@ -0,0 +1,49 @@
+/******************************************************************************
+ * MODULE     : qt_completion_listbox.hpp
+ * DESCRIPTION: Completion ListBox widget for auto-completion
+ * COPYRIGHT  : (C) 2025 JimZhouZZY
+ *******************************************************************************
+ * This software falls under the GNU general public license version 3 or later.
+ * It comes WITHOUT ANY WARRANTY WHATSOEVER. For details, see the file LICENSE
+ * in the root directory or <http://www.gnu.org/licenses/gpl-3.0.html>.
+ ******************************************************************************/
+
+#ifndef QT_COMPLETION_LISTBOX_HPP
+#define QT_COMPLETION_LISTBOX_HPP
+
+#include "QTMScrollView.hpp"
+#include "array.hpp"
+#include <QListWidget>
+#include <QPoint>
+#include <QStringList>
+
+class QtCompletionListBox : public QListWidget {
+  Q_OBJECT
+public:
+  void setAnchorUpdater (QTMScrollView*           scrollarea,
+                         std::function<QPoint ()> anchorToScreenFunc);
+  explicit QtCompletionListBox (QWidget* parent= nullptr);
+
+  void showCompletions (array<string>& completions, SI x, SI y);
+  void selectNextItem ();
+  void selectPreviousItem ();
+  void selectItemIndex (int index);
+  void setEventTarget (QWidget* target);
+  void showComponent ();
+
+signals:
+  void completionSelected (const QString& text);
+
+protected:
+  void keyPressEvent (QKeyEvent* event) override;
+  void focusOutEvent (QFocusEvent* event) override;
+  void wheelEvent (QWheelEvent* event) override;
+
+private:
+  QWidget* eventTarget;
+
+private slots:
+  void onItemClicked (QListWidgetItem* item);
+};
+
+#endif // QT_COMPLETION_LISTBOX_HPP