common-part: rename to `match' and document

[gnu-emacs-elpa] / company-capf.el

diff --git a/company-capf.el b/company-capf.el
index 018c6b775f51b13c006b261e4851f1ccb32b6ac2..17be772126736ab282b2524fd509c8cc190a9c7f 100644 (file)
--- a/company-capf.el
+++ b/company-capf.el
@@ -27,6 +27,14 @@
 
 (eval-when-compile (require 'cl))
 
+(defvar company--capf-data nil)
+(make-variable-buffer-local 'company--capf-data)
+
+(defun company--capf-clear-data (&optional _ignore)
+  (setq company--capf-data nil)
+  (remove-hook 'company-completion-cancelled-hook 'company--capf-clear-data t)
+  (remove-hook 'company-completion-finished-hook 'company--capf-clear-data t))
+
 (defun company--capf-data ()
   ;; Ignore tags-completion-at-point-function because it subverts company-etags
   ;; in the default value of company-backends, where the latter comes later.
@@ -34,7 +42,7 @@
           (data (run-hook-wrapped 'completion-at-point-functions
                                   ;; Ignore misbehaving functions.
                                   #'completion--capf-wrapper 'optimist)))
-    (when (consp data) data)))
+    (when (and (consp (cdr data)) (numberp (nth 1 data))) data)))
 
 (defun company-capf (command &optional arg &rest _args)
   "`company-mode' back-end using `completion-at-point-functions'.
@@ -47,9 +55,12 @@ Requires Emacs 24.1 or newer."
        (when res
          (if (> (nth 2 res) (point))
              'stop
+           (setq company--capf-data res)
+           (add-hook 'company-completion-cancelled-hook 'company--capf-clear-data nil t)
+           (add-hook 'company-completion-finished-hook 'company--capf-clear-data nil t)
            (buffer-substring-no-properties (nth 1 res) (point))))))
     (`candidates
-     (let ((res (company--capf-data)))
+     (let ((res company--capf-data))
        (when res
          (let* ((table (nth 3 res))
                 (pred (plist-get (nthcdr 4 res) :predicate))
@@ -71,41 +82,51 @@ Requires Emacs 24.1 or newer."
                          candidates))
              candidates)))))
     (`sorted
-     (let ((res (company--capf-data)))
+     (let ((res company--capf-data))
        (when res
          (let ((meta (completion-metadata
                       (buffer-substring (nth 1 res) (nth 2 res))
                       (nth 3 res) (plist-get (nthcdr 4 res) :predicate))))
            (cdr (assq 'display-sort-function meta))))))
-    (`common-part
+    (`match
      ;; Can't just use 0 when base-size (see above) is non-zero.
-     (let ((start (if (get-text-property 0 'face arg)
+     (let ((start (if (get-text-property 0 'font-lock-face arg)
                       0
-                    (next-single-property-change 0 'face arg))))
+                    (next-single-property-change 0 'font-lock-face arg))))
        (when start
          ;; completions-common-part comes first, but we can't just look for this
          ;; value because it can be in a list.
          (or
-          (let ((value (get-text-property start 'face arg)))
+          (let ((value (get-text-property start 'font-lock-face arg)))
             (text-property-not-all start (length arg)
-                                   'face value arg))
+                                   'font-lock-face value arg))
           (length arg)))))
-    (`duplicates nil) ;Don't bother.
-    (`no-cache t)     ;FIXME: Improve!
+    (`duplicates t)
+    (`no-cache t)   ;Not much can be done here, as long as we handle
+                    ;non-prefix matches.
     (`meta
-     (let ((f (plist-get (nthcdr 4 (company--capf-data)) :company-docsig)))
+     (let ((f (plist-get (nthcdr 4 company--capf-data) :company-docsig)))
        (when f (funcall f arg))))
     (`doc-buffer
-     (let ((f (plist-get (nthcdr 4 (company--capf-data)) :company-doc-buffer)))
+     (let ((f (plist-get (nthcdr 4 company--capf-data) :company-doc-buffer)))
        (when f (funcall f arg))))
     (`location
-     (let ((f (plist-get (nthcdr 4 (company--capf-data)) :company-location)))
+     (let ((f (plist-get (nthcdr 4 company--capf-data) :company-location)))
        (when f (funcall f arg))))
+    (`annotation
+     (save-excursion
+       ;; FIXME: `company-begin' sets `company-point' after calling
+       ;; `company--begin-new'.  We shouldn't rely on `company-point' here,
+       ;; better to cache the capf-data value instead.
+       (when company-point
+         (goto-char company-point))
+       (let ((f (plist-get (nthcdr 4 company--capf-data) :annotation-function)))
+         (when f (funcall f arg)))))
     (`require-match
-     (plist-get (nthcdr 4 (company--capf-data)) :company-require-match))
+     (plist-get (nthcdr 4 company--capf-data) :company-require-match))
     (`init nil)      ;Don't bother: plenty of other ways to initialize the code.
     (`post-completion
-     (let* ((res (company--capf-data))
+     (let* ((res company--capf-data)
             (exit-function (plist-get (nthcdr 4 res) :exit-function)))
        (if exit-function
            (funcall exit-function arg 'finished))))