From: Eshel Yaron <me@eshelyaron.com>
Date: Tue, 27 Jun 2023 18:36:45 +0000 (+0300)
Subject: Add grouping and affixation functions for module completion
X-Git-Tag: V9.1.10-sweep-0.21.0~1
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=89daa53a16c3aa2d2d779834c7193709f885d51c;p=sweep.git

Add grouping and affixation functions for module completion

This adds a 'group-function' and an 'affixation-function' to
'sweeprolog-module-completion-table', for Emacs 28+

The affixation API allows us to compute the appropriate padding to
insert before annotations in a cleaner way.  Modules are group
according to their classes.

* sweep.pl (sweep_module_class/2): New predicate.

* sweeprolog.el (sweeprolog-module-minibuffer-annotation-1):
Extract helper function from...
(sweeprolog-module-minibuffer-annotation): ...here. Adapt.
(sweeprolog-module-minibuffer-affixation)
(sweeprolog-module-minibuffer-group): New functions.
(sweeprolog-module-completion-table): Use them.
---

diff --git a/sweep.pl b/sweep.pl
index 72465d7..2ecebe0 100644
--- a/sweep.pl
+++ b/sweep.pl
@@ -89,7 +89,8 @@
             sweep_breakpoint_file/2,
             sweep_expand_macro/2,
             sweep_module_annotation/2,
-            sweep_is_module/2
+            sweep_is_module/2,
+            sweep_module_class/2
           ]).
 
 :- use_module(library(pldoc)).
@@ -259,6 +260,10 @@ sweep_documentation_modes([mode(Mode0, Args)|_], OneLiner, Docs) :-
 sweep_documentation_modes([_|T], OneLiner, Docs) :-
     sweep_documentation_modes(T, OneLiner, Docs).
 
+sweep_module_class(M0, C) :-
+    atom_string(M, M0),
+    module_property(M, class(C0)),
+    atom_string(C0, C).
 
 sweep_module_path(ModuleName, Path) :-
     atom_string(Module, ModuleName),
diff --git a/sweeprolog.el b/sweeprolog.el
index fd13c27..0b65ee3 100644
--- a/sweeprolog.el
+++ b/sweeprolog.el
@@ -1184,21 +1184,54 @@ the prefix argument."
 FILE is the file name of MODULE and DESC is its description, or nil."
   (sweeprolog--query-once "sweep" "sweep_module_annotation" module))
 
-(defun sweeprolog-module-minibuffer-annotation (module)
-  "Annotation function for module completion candidates.
-
-Return a string used to annotate MODULE."
+(defun sweeprolog-module-minibuffer-annotation-1 (module pad)
+  "Return a string used to annotate MODULE while padding to PAD."
   (let* ((width (string-width module))
          (file-desc (sweeprolog-module-annotation module))
          (file (car file-desc))
          (desc (cdr file-desc)))
-    (concat
-     (make-string
-      (+ (max (- (or sweeprolog--module-max-width width) width) 0) 2)
-      ?\s)
-     (when file (concat file (when desc (concat ": "))))
-     (replace-regexp-in-string (rx "library(" (+ graph) "): ") ""
-                               (or desc "")))))
+    (propertize
+     (concat
+      (make-string
+       (+ (- sweeprolog--module-max-width width) 2)
+       ?\s)
+      (when file (concat file
+                         (when desc (concat ": "))))
+      (replace-regexp-in-string (rx "library(" (+ graph) "): ") ""
+                                (or desc "")))
+     'face 'sweeprolog-structured-comment)))
+
+(defun sweeprolog-module-minibuffer-annotation (module)
+  "Annotation function for module completion candidates.
+
+Return a string used to annotate MODULE."
+  (sweeprolog-module-minibuffer-annotation-1 module
+                                             (or sweeprolog--module-max-width
+                                                 (string-width module))))
+
+(defun sweeprolog-module-minibuffer-affixation (completions)
+  "Affixation function for module completion candidates.
+
+Map COMPLETIONS to a list of elements (CAND PRE SUF), where CAND
+is a candidate string, PRE is a prefix string to display before
+the candidate and SUF is its suffix to display after it."
+  (when completions
+    (let ((module-max-width (seq-max (mapcar #'string-width
+                                             completions))))
+      (mapcar (lambda (cand)
+                (list cand ""
+                      (sweeprolog-module-minibuffer-annotation-1
+                       cand module-max-width)))
+              completions))))
+
+(defun sweeprolog-module-minibuffer-group (completion transform)
+  "Grouping function for module completion candidates.
+
+See (info \"(elisp)Programmed Completion\") for the meaning of
+COMPLETION and TRANSFORM."
+  (if transform
+      completion
+    (sweeprolog--query-once "sweep" "sweep_module_class" completion)))
 
 (defun sweeprolog-module-p (mod)
   "Return non-nil if MOD is a known Prolog module."
@@ -1218,7 +1251,9 @@ STRING, PREDICATE and ACTION."
     '(metadata
       .
       ((category            . sweeprolog-module)
-       (annotation-function . sweeprolog-module-minibuffer-annotation))))
+       (annotation-function . sweeprolog-module-minibuffer-annotation)
+       (affixation-function . sweeprolog-module-minibuffer-affixation)
+       (group-function      . sweeprolog-module-minibuffer-group))))
    (t (complete-with-action action
                             (sweeprolog-modules-collection string)
                             string