1 ;;; ivy.el --- Incremental Vertical completYon -*- lexical-binding: t -*-
3 ;; Copyright (C) 2015 Free Software Foundation, Inc.
5 ;; Author: Oleh Krehel <ohwoeowho@gmail.com>
6 ;; URL: https://github.com/abo-abo/swiper
7 ;; Package-Requires: ((emacs "24.1"))
10 ;; This file is part of GNU Emacs.
12 ;; This file is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
17 ;; This program is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; For a full copy of the GNU General Public License
23 ;; see <http://www.gnu.org/licenses/>.
27 ;; This package provides `ivy-read' as an alternative to
28 ;; `completing-read' and similar functions.
30 ;; There's no intricate code to determine the best candidate.
31 ;; Instead, the user can navigate to it with `ivy-next-line' and
32 ;; `ivy-previous-line'.
34 ;; The matching is done by splitting the input text by spaces and
35 ;; re-building it into a regex.
36 ;; So "for example" is transformed into "\\(for\\).*\\(example\\)".
44 "Incremental vertical completion."
47 (defface ivy-current-match
48 '((((class color) (background light))
49 :background "#1a4b77" :foreground "white")
50 (((class color) (background dark))
51 :background "#65a7e2" :foreground "black"))
52 "Face used by Ivy for highlighting first match.")
54 (defface ivy-confirm-face
55 '((t :foreground "ForestGreen" :inherit minibuffer-prompt))
56 "Face used by Ivy to issue a confirmation prompt.")
58 (defface ivy-match-required-face
59 '((t :foreground "red" :inherit minibuffer-prompt))
60 "Face used by Ivy to issue a match required prompt.")
63 '((t (:inherit 'dired-directory)))
64 "Face used by Ivy for highlighting subdirs in the alternatives.")
66 (defface ivy-modified-buffer
67 '((t :inherit 'default))
68 "Face used by Ivy for highlighting modified file visiting buffers.")
71 '((t (:foreground "#110099")))
72 "Face used by Ivy for highlighting remotes in the alternatives.")
74 (defcustom ivy-height 10
75 "Number of lines for the minibuffer window."
78 (defcustom ivy-count-format "%-4d "
79 "The style of showing the current candidate count for `ivy-read'.
80 Set this to \"\" if you don't want the count. You can also set
81 it to e.g. \"(%d/%d) \" if you want to see both the candidate
82 index and the candidate count."
84 (const :tag "Count disabled" "")
85 (const :tag "Count matches" "%-4d ")
86 (const :tag "Count matches and show current match" "(%d/%d) ")
89 (defcustom ivy-wrap nil
90 "Whether to wrap around after the first and last candidate."
93 (defcustom ivy-display-style (unless (version< emacs-version "24.5") 'fancy)
94 "The style for formatting the minibuffer.
96 By default, the matched strings will be copied as they are.
98 With the fancy method, the matching parts of the regexp will be
99 additionally highlighted, just like `swiper' does it.
101 This setting depends on `add-face-text-property' - a C function
102 available as of 24.5. It will behave poorly in earlier Emacs
105 (const :tag "Plain" nil)
106 (const :tag "Fancy" fancy)))
108 (defcustom ivy-on-del-error-function 'minibuffer-keyboard-quit
109 "The handler for when `ivy-backward-delete-char' throws.
110 This is usually meant as a quick exit out of the minibuffer."
113 (defcustom ivy-extra-directories '("../" "./")
114 "Add this to the front of the list when completing file names.
115 Only \"./\" and \"../\" apply here. They appear in reverse order."
116 :type '(repeat :tag "Dirs"
118 (const :tag "Parent Directory" "../")
119 (const :tag "Current Directory" "./"))))
121 (defcustom ivy-use-virtual-buffers nil
122 "When non-nil, add `recentf-mode' and bookmarks to `ivy-switch-buffer'."
125 (defvar ivy--actions-list nil
126 "A list of extra actions per command.")
128 (defun ivy-set-actions (cmd actions)
129 "Set CMD extra exit points to ACTIONS."
130 (setq ivy--actions-list
131 (plist-put ivy--actions-list cmd actions)))
135 (defvar ivy-minibuffer-map
136 (let ((map (make-sparse-keymap)))
137 (define-key map (kbd "C-m") 'ivy-done)
138 (define-key map (kbd "C-M-m") 'ivy-call)
139 (define-key map (kbd "C-j") 'ivy-alt-done)
140 (define-key map (kbd "C-M-j") 'ivy-immediate-done)
141 (define-key map (kbd "TAB") 'ivy-partial-or-done)
142 (define-key map (kbd "C-n") 'ivy-next-line)
143 (define-key map (kbd "C-p") 'ivy-previous-line)
144 (define-key map (kbd "<down>") 'ivy-next-line)
145 (define-key map (kbd "<up>") 'ivy-previous-line)
146 (define-key map (kbd "C-s") 'ivy-next-line-or-history)
147 (define-key map (kbd "C-r") 'ivy-reverse-i-search)
148 (define-key map (kbd "SPC") 'self-insert-command)
149 (define-key map (kbd "DEL") 'ivy-backward-delete-char)
150 (define-key map (kbd "M-DEL") 'ivy-backward-kill-word)
151 (define-key map (kbd "C-d") 'ivy-delete-char)
152 (define-key map (kbd "C-f") 'ivy-forward-char)
153 (define-key map (kbd "M-d") 'ivy-kill-word)
154 (define-key map (kbd "M-<") 'ivy-beginning-of-buffer)
155 (define-key map (kbd "M->") 'ivy-end-of-buffer)
156 (define-key map (kbd "M-n") 'ivy-next-history-element)
157 (define-key map (kbd "M-p") 'ivy-previous-history-element)
158 (define-key map (kbd "C-g") 'minibuffer-keyboard-quit)
159 (define-key map (kbd "C-v") 'ivy-scroll-up-command)
160 (define-key map (kbd "M-v") 'ivy-scroll-down-command)
161 (define-key map (kbd "C-M-n") 'ivy-next-line-and-call)
162 (define-key map (kbd "C-M-p") 'ivy-previous-line-and-call)
163 (define-key map (kbd "M-q") 'ivy-toggle-regexp-quote)
164 (define-key map (kbd "M-j") 'ivy-yank-word)
165 (define-key map (kbd "M-i") 'ivy-insert-current)
166 (define-key map (kbd "C-o") 'hydra-ivy/body)
167 (define-key map (kbd "M-o") 'ivy-dispatching-done)
168 (define-key map (kbd "C-M-o") 'ivy-dispatching-call)
169 (define-key map (kbd "C-k") 'ivy-kill-line)
170 (define-key map (kbd "S-SPC") 'ivy-restrict-to-matches)
171 (define-key map (kbd "M-w") 'ivy-kill-ring-save)
172 (define-key map (kbd "C-'") 'ivy-avy)
173 (define-key map (kbd "C-M-a") 'ivy-read-action)
174 (define-key map (kbd "C-c C-o") 'ivy-occur)
176 "Keymap used in the minibuffer.")
177 (autoload 'hydra-ivy/body "ivy-hydra" "" t)
180 (let ((map (make-sparse-keymap)))
181 (define-key map [remap switch-to-buffer] 'ivy-switch-buffer)
183 "Keymap for `ivy-mode'.")
186 (cl-defstruct ivy-state
188 predicate require-match initial-input
189 history preselect keymap update-fn sort
190 ;; The window in which `ivy-read' was called
192 ;; The buffer in which `ivy-read' was called
194 ;; The value of `ivy-text' to be used by `ivy-occur'
200 ;; When this is non-nil, call it for each input change to get new candidates
205 "The last parameters passed to `ivy-read'.
207 This should eventually become a stack so that you could use
208 `ivy-read' recursively.")
210 (defsubst ivy-set-action (action)
211 (setf (ivy-state-action ivy-last) action))
213 (defvar ivy-history nil
214 "History list of candidates entered in the minibuffer.
216 Maximum length of the history list is determined by the value
217 of `history-length', which see.")
219 (defvar ivy--directory nil
220 "Current directory when completing file names.")
222 (defvar ivy--length 0
223 "Store the amount of viable candidates.")
226 "Store the user's string as it is typed in.")
228 (defvar ivy--current ""
229 "Current candidate.")
232 "Store the index of the current candidate.")
235 "Store 'done if the completion was successfully selected.
236 Otherwise, store nil.")
238 (defvar ivy--all-candidates nil
239 "Store the candidates passed to `ivy-read'.")
241 (defvar ivy--default nil
242 "Default initial input.")
244 (defvar ivy--prompt nil
245 "Store the format-style prompt.
246 When non-nil, it should contain one %d.")
248 (defvar ivy--prompt-extra ""
249 "Temporary modifications to the prompt.")
251 (defvar ivy--old-re nil
252 "Store the old regexp.")
254 (defvar ivy--old-cands nil
255 "Store the candidates matched by `ivy--old-re'.")
257 (defvar ivy--regex-function 'ivy--regex
258 "Current function for building a regex.")
260 (defvar ivy--subexps 0
261 "Number of groups in the current `ivy--regex'.")
263 (defvar ivy--full-length nil
264 "When :dynamic-collection is non-nil, this can be the total amount of candidates.")
266 (defvar ivy--old-text ""
267 "Store old `ivy-text' for dynamic completion.")
269 (defvar ivy-case-fold-search 'auto
270 "Store the current overriding `case-fold-search'.")
272 (defvar Info-current-file)
274 (defmacro ivy-quit-and-run (&rest body)
275 "Quit the minibuffer and run BODY afterwards."
277 (put 'quit 'error-message "")
280 (put 'quit 'error-message "Quit")
282 (minibuffer-keyboard-quit)))
284 (defun ivy-exit-with-action (action)
285 "Quit the minibuffer and call ACTION afterwards."
289 (ivy-set-action ',(ivy-state-action ivy-last))))
290 (setq ivy-exit 'done)
293 (defmacro with-ivy-window (&rest body)
294 "Execute BODY in the window from which `ivy-read' was called."
297 `(with-selected-window (ivy--get-window ivy-last)
300 (defun ivy--done (text)
301 "Insert TEXT and exit minibuffer."
302 (if (and ivy--directory
303 (not (eq (ivy-state-history ivy-last) 'grep-files-history)))
304 (insert (setq ivy--current (expand-file-name
305 text ivy--directory)))
306 (insert (setq ivy--current text)))
307 (setq ivy-exit 'done)
312 "Exit the minibuffer with the selected candidate."
314 (delete-minibuffer-contents)
315 (cond ((> ivy--length 0)
316 (ivy--done ivy--current))
317 ((memq (ivy-state-collection ivy-last)
318 '(read-file-name-internal internal-complete-buffer))
319 (if (or (not (eq confirm-nonexistent-file-or-buffer t))
320 (equal " (confirm)" ivy--prompt-extra))
322 (setq ivy--prompt-extra " (confirm)")
325 ((memq (ivy-state-require-match ivy-last)
326 '(nil confirm confirm-after-completion))
327 (ivy--done ivy-text))
329 (setq ivy--prompt-extra " (match required)")
333 (defun ivy-read-action ()
334 "Change the action to one of the available ones."
336 (let ((actions (ivy-state-action ivy-last)))
337 (unless (null (ivy--actionp actions))
338 (let* ((hint (concat ivy--current
345 'face 'font-lock-builtin-face)
350 (key (string (read-key hint)))
351 (action-idx (cl-position-if
352 (lambda (x) (equal (car x) key))
354 (cond ((string= key "
\a"))
356 (error "%s is not bound" key))
359 (setcar actions (1+ action-idx))
360 (ivy-set-action actions)))))))
362 (defun ivy-dispatching-done ()
363 "Select one of the available actions and call `ivy-done'."
368 (defun ivy-dispatching-call ()
369 "Select one of the available actions and call `ivy-call'."
371 (let ((actions (copy-sequence (ivy-state-action ivy-last))))
373 (when (ivy-read-action)
375 (ivy-set-action actions))))
377 (defun ivy-build-tramp-name (x)
378 "Reconstruct X into a path.
379 Is is a cons cell, related to `tramp-get-completion-function'."
383 (concat user "@" domain)
386 (declare-function tramp-get-completion-function "tramp")
387 (declare-function Info-find-node "info")
389 (defun ivy-alt-done (&optional arg)
390 "Exit the minibuffer with the selected candidate.
391 When ARG is t, exit with current text, ignoring the candidates."
394 (ivy-immediate-done))
396 (ivy--directory-done))
397 ((eq (ivy-state-collection ivy-last) 'Info-read-node-name-1)
398 (if (or (equal ivy--current "(./)")
399 (equal ivy--current "(../)"))
401 (ivy-read "Go to file: " 'read-file-name-internal
404 (expand-file-name x ivy--directory)
410 (defun ivy--directory-done ()
411 "Handle exit from the minibuffer when completing file names."
414 ((equal ivy-text "/sudo::")
415 (setq dir (concat ivy-text ivy--directory))
420 (not (equal ivy-text ""))
424 (file-name-as-directory
426 ivy-text ivy--directory))))))
428 (not (string= ivy--current "./"))
429 (cl-plusp ivy--length)
432 (setq dir (file-name-as-directory
434 ivy--current ivy--directory)))))))
437 ((or (and (equal ivy--directory "/")
438 (string-match "\\`[^/]+:.*:.*\\'" ivy-text))
439 (string-match "\\`/[^/]+:.*:.*\\'" ivy-text))
441 ((or (and (equal ivy--directory "/")
443 "\\`\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
446 "\\`\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
448 (setq ivy-text ivy--current))))
450 "\\`/\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
452 (let ((method (match-string 1 ivy-text))
453 (user (match-string 2 ivy-text))
454 (rest (match-string 3 ivy-text))
457 (dolist (x (tramp-get-completion-function method))
458 (setq res (append res (funcall (car x) (cadr x)))))
459 (setq res (delq nil res))
463 (setq res (cl-delete-duplicates res :test #'equal))
464 (let* ((old-ivy-last ivy-last)
465 (enable-recursive-minibuffers t)
466 (host (ivy-read "Find File: "
467 (mapcar #'ivy-build-tramp-name res)
468 :initial-input rest)))
469 (setq ivy-last old-ivy-last)
471 (setq ivy--directory "/")
472 (ivy--cd (concat "/" method ":" host ":"))))))
476 (defcustom ivy-tab-space nil
477 "When non-nil, `ivy-partial-or-done' should insert a space."
480 (defun ivy-partial-or-done ()
481 "Complete the minibuffer text as much as possible.
482 If the text hasn't changed as a result, forward to `ivy-alt-done'."
484 (if (and (eq (ivy-state-collection ivy-last) #'read-file-name-internal)
485 (or (and (equal ivy--directory "/")
486 (string-match "\\`[^/]+:.*\\'" ivy-text))
487 (string-match "\\`/" ivy-text)))
488 (let ((default-directory ivy--directory))
489 (minibuffer-complete)
490 (setq ivy-text (ivy--input))
491 (when (file-directory-p
492 (expand-file-name ivy-text ivy--directory))
493 (ivy--cd (file-name-as-directory
494 (expand-file-name ivy-text ivy--directory)))))
496 (when (or (eq this-command last-command)
500 (defun ivy-partial ()
501 "Complete the minibuffer text as much as possible."
503 (let* ((parts (or (split-string ivy-text " " t) (list "")))
504 (postfix (car (last parts)))
505 (completion-ignore-case t)
506 (startp (string-match "^\\^" postfix))
507 (new (try-completion (if startp
508 (substring postfix 1)
510 (mapcar (lambda (str)
511 (let ((i (string-match postfix str)))
515 (cond ((eq new t) nil)
516 ((string= new ivy-text) nil)
518 (delete-region (minibuffer-prompt-end) (point-max))
523 (insert (mapconcat #'identity parts " ")
524 (if ivy-tab-space " " ""))
527 (defun ivy-immediate-done ()
528 "Exit the minibuffer with the current input."
530 (delete-minibuffer-contents)
531 (insert (setq ivy--current
533 (expand-file-name ivy-text ivy--directory)
535 (setq ivy-exit 'done)
540 "Resume the last completion session."
542 (when (eq (ivy-state-caller ivy-last) 'swiper)
543 (switch-to-buffer (ivy-state-buffer ivy-last)))
544 (with-current-buffer (ivy-state-buffer ivy-last)
546 (ivy-state-prompt ivy-last)
547 (ivy-state-collection ivy-last)
548 :predicate (ivy-state-predicate ivy-last)
549 :require-match (ivy-state-require-match ivy-last)
550 :initial-input ivy-text
551 :history (ivy-state-history ivy-last)
552 :preselect (unless (eq (ivy-state-collection ivy-last)
553 'read-file-name-internal)
555 :keymap (ivy-state-keymap ivy-last)
556 :update-fn (ivy-state-update-fn ivy-last)
557 :sort (ivy-state-sort ivy-last)
558 :action (ivy-state-action ivy-last)
559 :unwind (ivy-state-unwind ivy-last)
560 :re-builder (ivy-state-re-builder ivy-last)
561 :matcher (ivy-state-matcher ivy-last)
562 :dynamic-collection (ivy-state-dynamic-collection ivy-last)
563 :caller (ivy-state-caller ivy-last))))
565 (defvar ivy-calling nil
566 "When non-nil, call the current action when `ivy--index' changes.")
568 (defun ivy-set-index (index)
569 "Set `ivy--index' to INDEX."
570 (setq ivy--index index)
575 (defun ivy-beginning-of-buffer ()
576 "Select the first completion candidate."
580 (defun ivy-end-of-buffer ()
581 "Select the last completion candidate."
583 (ivy-set-index (1- ivy--length)))
585 (defun ivy-scroll-up-command ()
586 "Scroll the candidates upward by the minibuffer height."
588 (ivy-set-index (min (1- (+ ivy--index ivy-height))
591 (defun ivy-scroll-down-command ()
592 "Scroll the candidates downward by the minibuffer height."
594 (ivy-set-index (max (1+ (- ivy--index ivy-height))
597 (defun ivy-minibuffer-grow ()
598 "Grow the minibuffer window by 1 line."
600 (setq-local max-mini-window-height
601 (cl-incf ivy-height)))
603 (defun ivy-minibuffer-shrink ()
604 "Shrink the minibuffer window by 1 line."
606 (unless (<= ivy-height 2)
607 (setq-local max-mini-window-height
608 (cl-decf ivy-height))
609 (window-resize (selected-window) -1)))
611 (defun ivy-next-line (&optional arg)
612 "Move cursor vertically down ARG candidates."
614 (setq arg (or arg 1))
615 (let ((index (+ ivy--index arg)))
616 (if (> index (1- ivy--length))
618 (ivy-beginning-of-buffer)
619 (ivy-set-index (1- ivy--length)))
620 (ivy-set-index index))))
622 (defun ivy-next-line-or-history (&optional arg)
623 "Move cursor vertically down ARG candidates.
624 If the input is empty, select the previous history element instead."
626 (when (string= ivy-text "")
627 (ivy-previous-history-element 1))
630 (defun ivy-previous-line (&optional arg)
631 "Move cursor vertically up ARG candidates."
633 (setq arg (or arg 1))
634 (let ((index (- ivy--index arg)))
639 (ivy-set-index index))))
641 (defun ivy-previous-line-or-history (arg)
642 "Move cursor vertically up ARG candidates.
643 If the input is empty, select the previous history element instead."
645 (when (string= ivy-text "")
646 (ivy-previous-history-element 1))
647 (ivy-previous-line arg))
649 (defun ivy-toggle-calling ()
650 "Flip `ivy-calling'."
652 (when (setq ivy-calling (not ivy-calling))
655 (defun ivy--get-action (state)
656 "Get the action function from STATE."
657 (let ((action (ivy-state-action state)))
659 (if (functionp action)
661 (cadr (nth (car action) action))))))
663 (defun ivy--get-window (state)
664 "Get the window from STATE."
665 (let ((window (ivy-state-window state)))
666 (if (window-live-p window)
668 (if (= (length (window-list)) 1)
672 (defun ivy--actionp (x)
673 "Return non-nil when X is a list of actions."
674 (and x (listp x) (not (eq (car x) 'closure))))
676 (defun ivy-next-action ()
677 "When the current action is a list, scroll it forwards."
679 (let ((action (ivy-state-action ivy-last)))
680 (when (ivy--actionp action)
681 (unless (>= (car action) (1- (length action)))
682 (cl-incf (car action))))))
684 (defun ivy-prev-action ()
685 "When the current action is a list, scroll it backwards."
687 (let ((action (ivy-state-action ivy-last)))
688 (when (ivy--actionp action)
689 (unless (<= (car action) 1)
690 (cl-decf (car action))))))
692 (defun ivy-action-name ()
693 "Return the name associated with the current action."
694 (let ((action (ivy-state-action ivy-last)))
695 (if (ivy--actionp action)
699 (nth 2 (nth (car action) action)))
703 "Call the current action without exiting completion."
705 (let ((action (ivy--get-action ivy-last)))
707 (let* ((collection (ivy-state-collection ivy-last))
708 (x (if (and (consp collection)
709 (consp (car collection)))
710 (cdr (assoc ivy--current collection))
711 (if (equal ivy--current "")
714 (prog1 (funcall action x)
715 (unless (or (eq ivy-exit 'done)
716 (equal (selected-window)
717 (active-minibuffer-window))
718 (null (active-minibuffer-window)))
719 (select-window (active-minibuffer-window))))))))
721 (defun ivy-next-line-and-call (&optional arg)
722 "Move cursor vertically down ARG candidates.
723 Call the permanent action if possible."
729 (defun ivy-previous-line-and-call (&optional arg)
730 "Move cursor vertically down ARG candidates.
731 Call the permanent action if possible."
733 (ivy-previous-line arg)
737 (defun ivy-previous-history-element (arg)
738 "Forward to `previous-history-element' with ARG."
740 (previous-history-element arg)
743 (ivy--maybe-scroll-history))
745 (defun ivy-next-history-element (arg)
746 "Forward to `next-history-element' with ARG."
748 (next-history-element arg)
751 (ivy--maybe-scroll-history))
753 (defun ivy--cd-maybe ()
754 "Check if the current input points to a different directory.
755 If so, move to that directory, while keeping only the file name."
757 (let ((input (ivy--input))
759 (if (setq url (ffap-url-p input))
760 (ivy-exit-with-action
762 (funcall ffap-url-fetcher url)))
763 (setq input (expand-file-name input))
764 (let ((file (file-name-nondirectory input))
765 (dir (expand-file-name (file-name-directory input))))
766 (if (string= dir ivy--directory)
768 (delete-minibuffer-contents)
773 (defun ivy--maybe-scroll-history ()
774 "If the selected history element has an index, scroll there."
775 (let ((idx (ignore-errors
777 (minibuffer-prompt-end)
781 (setq ivy--index idx))))
784 "When completing file names, move to directory DIR."
785 (if (null ivy--directory)
787 (setq ivy--old-cands nil)
788 (setq ivy--old-re nil)
790 (setq ivy--all-candidates
791 (ivy--sorted-files (setq ivy--directory dir)))
793 (delete-minibuffer-contents)))
795 (defun ivy-backward-delete-char ()
796 "Forward to `backward-delete-char'.
797 On error (read-only), call `ivy-on-del-error-function'."
799 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
801 (ivy--cd (file-name-directory
807 (backward-delete-char 1)
809 (when ivy-on-del-error-function
810 (funcall ivy-on-del-error-function))))))
812 (defun ivy-delete-char (arg)
813 "Forward to `delete-char' ARG."
815 (unless (= (point) (line-end-position))
818 (defun ivy-forward-char (arg)
819 "Forward to `forward-char' ARG."
821 (unless (= (point) (line-end-position))
824 (defun ivy-kill-word (arg)
825 "Forward to `kill-word' ARG."
827 (unless (= (point) (line-end-position))
830 (defun ivy-kill-line ()
831 "Forward to `kill-line'."
834 (kill-region (minibuffer-prompt-end) (point))
837 (defun ivy-backward-kill-word ()
838 "Forward to `backward-kill-word'."
840 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
842 (ivy--cd (file-name-directory
850 (delete-region (point) pt)))))
852 (defvar ivy--regexp-quote 'regexp-quote
853 "Store the regexp quoting state.")
855 (defun ivy-toggle-regexp-quote ()
856 "Toggle the regexp quoting."
858 (setq ivy--old-re nil)
859 (cl-rotatef ivy--regex-function ivy--regexp-quote))
861 (defvar avy-all-windows)
864 (defvar avy-keys-alist)
866 (defvar avy-styles-alist)
867 (declare-function avy--process "ext:avy")
868 (declare-function avy--style-fn "ext:avy")
870 (eval-after-load 'avy
871 '(add-to-list 'avy-styles-alist '(ivy-avy . pre)))
874 "Jump to one of the current ivy candidates."
876 (unless (require 'avy nil 'noerror)
877 (error "Package avy isn't installed"))
878 (let* ((avy-all-windows nil)
879 (avy-keys (or (cdr (assq 'ivy-avy avy-keys-alist))
881 (avy-style (or (cdr (assq 'ivy-avy
891 (goto-char (point-min))
893 (while (< (point) (point-max))
899 (setq avy-action #'identity)
901 (nreverse candidates)
902 (avy--style-fn avy-style)))))
903 (ivy-set-index (- (line-number-at-pos candidate) 2))
907 (defun ivy-sort-file-function-default (x y)
908 "Compare two files X and Y.
909 Prioritize directories."
910 (if (get-text-property 0 'dirp x)
911 (if (get-text-property 0 'dirp y)
914 (if (get-text-property 0 'dirp y)
918 (defcustom ivy-sort-functions-alist
919 '((read-file-name-internal . ivy-sort-file-function-default)
920 (internal-complete-buffer . nil)
921 (counsel-git-grep-function . nil)
922 (Man-goto-section . nil)
925 "An alist of sorting functions for each collection function.
926 Interactive functions that call completion fit in here as well.
928 For each entry, nil means no sorting. It's very useful to turn
929 off the sorting for functions that have candidates in the natural
930 buffer order, like `org-refile' or `Man-goto-section'.
932 The entry associated to t is used for all fall-through cases.
934 See also `ivy-sort-max-size'."
938 (const :tag "All other functions" t)
939 (symbol :tag "Function"))
941 (const :tag "plain sort" string-lessp)
942 (const :tag "file sort" ivy-sort-file-function-default)
943 (const :tag "no sort" nil)))
946 (defvar ivy-index-functions-alist
947 '((swiper . ivy-recompute-index-swiper)
948 (swiper-multi . ivy-recompute-index-swiper)
949 (counsel-git-grep . ivy-recompute-index-swiper)
950 (counsel-grep . ivy-recompute-index-swiper-async)
951 (t . ivy-recompute-index-zero))
952 "An alist of index recomputing functions for each collection function.
953 When the input changes, calling the appropriate function will
954 return an integer - the index of the matched candidate that
955 should be selected.")
957 (defvar ivy-re-builders-alist
958 '((t . ivy--regex-plus))
959 "An alist of regex building functions for each collection function.
960 Each function should take a string and return a valid regex or a
961 regex sequence (see below).
963 The entry associated to t is used for all fall-through cases.
964 Possible choices: `ivy--regex', `regexp-quote', `ivy--regex-plus'.
966 In case a function returns a list, it should look like this:
967 '((\"matching-regexp\" . t) (\"non-matching-regexp\") ...).
969 The matches will be filtered in a sequence, you can mix the
970 regexps that should match and that should not match as you
973 (defvar ivy-initial-inputs-alist
975 (org-agenda-refile . "^")
976 (org-capture-refile . "^")
978 (counsel-describe-function . "^")
979 (counsel-describe-variable . "^")
982 "Command to initial input table.")
984 (defcustom ivy-sort-max-size 30000
985 "Sorting won't be done for collections larger than this."
988 (defun ivy--sorted-files (dir)
989 "Return the list of files in DIR.
990 Directories come first."
991 (let* ((default-directory dir)
992 (seq (all-completions "" 'read-file-name-internal))
996 (setq seq (delete "./" (delete "../" seq)))
997 (when (eq (setq sort-fn (cdr (assoc 'read-file-name-internal
998 ivy-sort-functions-alist)))
999 #'ivy-sort-file-function-default)
1000 (setq seq (mapcar (lambda (x)
1001 (propertize x 'dirp (string-match-p "/\\'" x)))
1004 (setq seq (cl-sort seq sort-fn)))
1005 (dolist (dir ivy-extra-directories)
1010 (cl-defun ivy-read (prompt collection
1011 &key predicate require-match initial-input
1012 history preselect keymap update-fn sort
1013 action unwind re-builder matcher dynamic-collection caller)
1014 "Read a string in the minibuffer, with completion.
1016 PROMPT is a string to prompt with; normally it ends in a colon
1017 and a space. When PROMPT contains %d, it will be updated with
1018 the current number of matching candidates. If % appears elsewhere
1019 in the PROMPT it should be quoted as %%.
1020 See also `ivy-count-format'.
1022 COLLECTION is a list of strings, or a function, or an alist, or a
1025 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.
1027 KEYMAP is composed together with `ivy-minibuffer-map'.
1029 If PRESELECT is non-nil select the corresponding candidate out of
1030 the ones that match INITIAL-INPUT.
1032 UPDATE-FN is called each time the current candidate(s) is changed.
1034 When SORT is t, refer to `ivy-sort-functions-alist' for sorting.
1036 ACTION is a lambda to call after a result was selected. It should
1037 take a single argument, usually a string.
1039 UNWIND is a lambda to call before exiting.
1041 RE-BUILDER is a lambda that transforms text into a regex.
1043 MATCHER can completely override matching.
1045 DYNAMIC-COLLECTION is a boolean that determines whether to update
1046 the list of candidates with each input by calling COLLECTION for
1049 CALLER is a symbol to uniquely identify the caller to `ivy-read'.
1050 It's used in conjunction with COLLECTION to indentify which
1051 customizations should apply to the current completion session."
1052 (let ((extra-actions (plist-get ivy--actions-list this-command)))
1055 (if (functionp action)
1057 ("o" ,action "default")
1059 (delete-dups (append action extra-actions))))))
1060 (let ((recursive-ivy-last (and (window-minibuffer-p) ivy-last)))
1064 :collection collection
1065 :predicate predicate
1066 :require-match require-match
1067 :initial-input initial-input
1069 :preselect preselect
1071 :update-fn update-fn
1074 :window (selected-window)
1075 :buffer (current-buffer)
1077 :re-builder re-builder
1079 :dynamic-collection dynamic-collection
1081 (ivy--reset-state ivy-last)
1084 (minibuffer-with-setup-hook
1085 #'ivy--minibuffer-setup
1086 (let* ((hist (or history 'ivy-history))
1087 (minibuffer-completion-table collection)
1088 (minibuffer-completion-predicate predicate)
1089 (resize-mini-windows (cond
1090 ((display-graphic-p) nil)
1091 ((null resize-mini-windows) 'grow-only)
1092 (t resize-mini-windows)))
1093 (res (read-from-minibuffer
1095 (ivy-state-initial-input ivy-last)
1096 (make-composed-keymap keymap ivy-minibuffer-map)
1099 (when (eq ivy-exit 'done)
1100 (let ((item (if ivy--directory
1103 (unless (equal item "")
1104 (set hist (cons (propertize item 'ivy-index ivy--index)
1106 (cdr (symbol-value hist)))))))
1108 (remove-hook 'post-command-hook #'ivy--exhibit)
1109 (when (setq unwind (ivy-state-unwind ivy-last))
1112 (when recursive-ivy-last
1113 (ivy--reset-state (setq ivy-last recursive-ivy-last))))))
1115 (defun ivy--reset-state (state)
1116 "Reset the ivy to STATE.
1117 This is useful for recursive `ivy-read'."
1118 (let ((prompt (ivy-state-prompt state))
1119 (collection (ivy-state-collection state))
1120 (predicate (ivy-state-predicate state))
1121 (history (ivy-state-history state))
1122 (preselect (ivy-state-preselect state))
1123 (sort (ivy-state-sort state))
1124 (re-builder (ivy-state-re-builder state))
1125 (dynamic-collection (ivy-state-dynamic-collection state))
1126 (initial-input (ivy-state-initial-input state))
1127 (require-match (ivy-state-require-match state)))
1128 (unless initial-input
1129 (setq initial-input (cdr (assoc this-command
1130 ivy-initial-inputs-alist))))
1131 (setq ivy--directory nil)
1132 (setq ivy-case-fold-search 'auto)
1133 (setq ivy--regex-function
1135 (and (functionp collection)
1136 (cdr (assoc collection ivy-re-builders-alist)))
1137 (cdr (assoc t ivy-re-builders-alist))
1139 (setq ivy--subexps 0)
1140 (setq ivy--regexp-quote 'regexp-quote)
1141 (setq ivy--old-text "")
1142 (setq ivy--full-length nil)
1144 (setq ivy-calling nil)
1146 (cond ((eq collection 'Info-read-node-name-1)
1147 (if (equal Info-current-file "dir")
1149 (mapcar (lambda (x) (format "(%s)" x))
1150 (cl-delete-duplicates
1151 (all-completions "(" collection predicate)
1153 (setq coll (all-completions "" collection predicate))))
1154 ((eq collection 'read-file-name-internal)
1155 (setq ivy--directory default-directory)
1158 (let ((preselect-directory (file-name-directory preselect)))
1159 (unless (or (null preselect-directory)
1160 (string= preselect-directory
1162 (setq ivy--directory preselect-directory))
1164 (ivy-state-preselect state)
1165 (setq preselect (file-name-nondirectory preselect)))))
1166 (setq coll (ivy--sorted-files ivy--directory))
1168 (unless (or require-match
1169 (equal initial-input default-directory)
1170 (equal initial-input ""))
1171 (setq coll (cons initial-input coll)))
1172 (setq initial-input nil)))
1173 ((eq collection 'internal-complete-buffer)
1174 (setq coll (ivy--buffer-list "" ivy-use-virtual-buffers)))
1175 ((or (functionp collection)
1176 (byte-code-function-p collection)
1177 (vectorp collection)
1178 (and (consp collection) (listp (car collection)))
1179 (hash-table-p collection))
1180 (setq coll (all-completions "" collection predicate)))
1182 (setq coll collection)))
1184 (if (and (functionp collection)
1185 (setq sort-fn (assoc collection ivy-sort-functions-alist)))
1186 (when (and (setq sort-fn (cdr sort-fn))
1187 (not (eq collection 'read-file-name-internal)))
1188 (setq coll (cl-sort coll sort-fn)))
1189 (unless (eq history 'org-refile-history)
1190 (if (and (setq sort-fn (cdr (assoc t ivy-sort-functions-alist)))
1191 (<= (length coll) ivy-sort-max-size))
1192 (setq coll (cl-sort (copy-sequence coll) sort-fn))))))
1194 (unless (or (and require-match
1195 (not (eq collection 'internal-complete-buffer)))
1197 (let ((re (regexp-quote preselect)))
1198 (cl-find-if (lambda (x) (string-match re x))
1200 (setq coll (cons preselect coll))))
1201 (setq ivy--old-re nil)
1202 (setq ivy--old-cands nil)
1204 ;; Needed for anchor to work
1205 (setq ivy--old-cands coll)
1206 (setq ivy--old-cands (ivy--filter initial-input coll)))
1207 (setq ivy--all-candidates coll)
1208 (setq ivy--index (or
1209 (and dynamic-collection
1212 (ivy--preselect-index
1219 (setq ivy--default (or
1220 (thing-at-point 'url)
1221 (thing-at-point 'symbol)
1224 (cond ((string-match "%.*d" prompt)
1226 ((null ivy-count-format)
1228 "`ivy-count-format' can't be nil. Set it to an empty string instead"))
1229 ((string-match "%d.*%d" ivy-count-format)
1230 (let ((w (length (number-to-string
1231 (length ivy--all-candidates))))
1232 (s (copy-sequence ivy-count-format)))
1233 (string-match "%d" s)
1235 (string-match "%d" s (match-end 0))
1236 (setq s (replace-match (format "%%-%dd" w) nil nil s))
1237 (string-match "%d" s)
1238 (concat (replace-match (format "%%%dd" w) nil nil s)
1240 ((string-match "%.*d" ivy-count-format)
1241 (concat ivy-count-format prompt))
1246 (setf (ivy-state-initial-input ivy-last) initial-input)))
1249 (defun ivy-completing-read (prompt collection
1250 &optional predicate require-match initial-input
1251 history def _inherit-input-method)
1252 "Read a string in the minibuffer, with completion.
1254 This is an interface that conforms to `completing-read', so that
1255 it can be used for `completing-read-function'.
1257 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1258 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1259 PREDICATE limits completion to a subset of COLLECTION.
1260 REQUIRE-MATCH is considered boolean. See `completing-read'.
1261 INITIAL-INPUT is a string that can be inserted into the minibuffer initially.
1262 _HISTORY is ignored for now.
1263 DEF is the default value.
1264 _INHERIT-INPUT-METHOD is ignored for now.
1266 The history, defaults and input-method arguments are ignored for now."
1267 ;; See the doc of `completing-read'.
1268 (when (consp history)
1269 (when (numberp (cdr history))
1270 (setq initial-input (nth (1- (cdr history))
1271 (symbol-value (car history)))))
1272 (setq history (car history)))
1273 (ivy-read (replace-regexp-in-string "%" "%%" prompt)
1275 :predicate predicate
1276 :require-match require-match
1277 :initial-input (if (consp initial-input)
1279 (if (and (stringp initial-input)
1280 (string-match "\\+" initial-input))
1281 (replace-regexp-in-string
1282 "\\+" "\\\\+" initial-input)
1284 :preselect (if (listp def) (car def) def)
1288 (let ((sort (assoc this-command ivy-sort-functions-alist)))
1294 (define-minor-mode ivy-mode
1295 "Toggle Ivy mode on or off.
1296 With ARG, turn Ivy mode on if arg is positive, off otherwise.
1297 Turning on Ivy mode will set `completing-read-function' to
1298 `ivy-completing-read'.
1303 Minibuffer bindings:
1304 \\{ivy-minibuffer-map}"
1307 :keymap ivy-mode-map
1310 (setq completing-read-function 'ivy-completing-read)
1311 (setq completing-read-function 'completing-read-default)))
1313 (defun ivy--preselect-index (preselect candidates)
1314 "Return the index of PRESELECT in CANDIDATES."
1315 (cond ((integerp preselect)
1317 ((cl-position preselect candidates :test #'equal))
1318 ((stringp preselect)
1319 (let ((re (regexp-quote preselect)))
1322 (string-match re x))
1327 (defvar ivy--regex-hash
1328 (make-hash-table :test #'equal)
1329 "Store pre-computed regex.")
1331 (defun ivy--split (str)
1332 "Split STR into a list by single spaces.
1333 The remaining spaces stick to their left.
1334 This allows to \"quote\" N spaces by inputting N+1 spaces."
1335 (let ((len (length str))
1340 (while (and (string-match " +" str start1)
1342 (setq match-len (- (match-end 0) (match-beginning 0)))
1346 (setq start1 start0)
1348 (push (substring str start1 (match-beginning 0)) res)
1349 (setq start1 (match-end 0)))
1350 (setq str (replace-match
1351 (make-string (1- match-len) ?\ )
1353 (setq start0 (or start0 start1))
1354 (setq start1 (1- (match-end 0)))))
1356 (push (substring str start0) res)
1357 (setq s (substring str start1))
1358 (unless (= (length s) 0)
1362 (defun ivy--regex (str &optional greedy)
1363 "Re-build regex from STR in case it has a space.
1364 When GREEDY is non-nil, join words in a greedy way."
1365 (let ((hashed (unless greedy
1366 (gethash str ivy--regex-hash))))
1369 (setq ivy--subexps (car hashed)))
1370 (when (string-match "\\([^\\]\\|^\\)\\\\$" str)
1371 (setq str (substring str 0 -1)))
1373 (let ((subs (ivy--split str)))
1374 (if (= (length subs) 1)
1376 (setq ivy--subexps 0)
1379 (setq ivy--subexps (length subs))
1382 (if (string-match "\\`\\\\(.*\\\\)\\'" x)
1384 (format "\\(%s\\)" x)))
1389 ivy--regex-hash)))))
1391 (defun ivy--regex-ignore-order (str)
1392 "Re-build regex from STR by splitting it on spaces.
1393 Ignore the order of each group.
1395 ATTENTION: This is a proof of concept and may not work as you
1396 expect. It will match as many groups as there are in the STR, but
1397 won't make sure that the matches are distinct. For instance, if
1398 you type 'foo bar', anything that contains 'foo' and 'bar', 'bar'
1399 and 'foo' will be matched, but also anything that contains 'foo'
1400 twice or 'bar' twice. If you want to find all candidates containing 'foo' and
1401 'bar' in any order, consider using `ivy-restrict-to-matches' instead.
1403 (let* ((subs (split-string str " +" t))
1404 (len (length subs)))
1407 (setq ivy--subexps 0)
1410 (setq ivy--subexps len)
1411 (let ((all (mapconcat #'identity subs "\\|")))
1414 (if (string-match "\\`\\\\(.*\\\\)\\'" x)
1416 (format "\\(%s\\)" x)))
1420 (defun ivy--regex-plus (str)
1421 "Build a regex sequence from STR.
1422 Spaces are wild, everything before \"!\" should match.
1423 Everything after \"!\" should not match."
1424 (let ((parts (split-string str "!" t)))
1425 (cl-case (length parts)
1429 (ivy--regex (car parts)))
1433 (split-string (cadr parts) " " t))))
1434 (cons (cons (ivy--regex (car parts)) t)
1436 (t (error "Unexpected: use only one !")))))
1438 (defun ivy--regex-fuzzy (str)
1439 "Build a regex sequence from STR.
1440 Insert .* between each char."
1441 (if (string-match "\\`\\(\\^?\\)\\(.*?\\)\\(\\$?\\)\\'" str)
1443 (concat (match-string 1 str)
1446 (format "\\(%c\\)" x))
1447 (string-to-list (match-string 2 str)) ".*")
1448 (match-string 3 str))
1449 (setq ivy--subexps (length (match-string 2 str))))
1453 (defun ivy--minibuffer-setup ()
1454 "Setup ivy completion in the minibuffer."
1455 (set (make-local-variable 'completion-show-inline-help) nil)
1456 (set (make-local-variable 'minibuffer-default-add-function)
1458 (list ivy--default)))
1459 (when (display-graphic-p)
1460 (setq truncate-lines t))
1461 (setq-local max-mini-window-height ivy-height)
1462 (add-hook 'post-command-hook #'ivy--exhibit nil t)
1463 ;; show completions with empty input
1466 (defun ivy--input ()
1467 "Return the current minibuffer input."
1468 ;; assume one-line minibuffer input
1469 (buffer-substring-no-properties
1470 (minibuffer-prompt-end)
1471 (line-end-position)))
1473 (defun ivy--cleanup ()
1474 "Delete the displayed completion candidates."
1476 (goto-char (minibuffer-prompt-end))
1477 (delete-region (line-end-position) (point-max))))
1479 (defun ivy--insert-prompt ()
1480 "Update the prompt according to `ivy--prompt'."
1482 (unless (memq this-command '(ivy-done ivy-alt-done ivy-partial-or-done
1483 counsel-find-symbol))
1484 (setq ivy--prompt-extra ""))
1486 (if (string-match "\\(.*\\): \\'" ivy--prompt)
1488 (setq head (match-string 1 ivy--prompt))
1490 (setq head (substring ivy--prompt 0 -1))
1492 (let ((inhibit-read-only t)
1493 (std-props '(front-sticky t rear-nonsticky t field t read-only t))
1496 (if (and (bound-and-true-p minibuffer-depth-indicate-mode)
1497 (> (minibuffer-depth) 1))
1498 (format "[%d] " (minibuffer-depth))
1501 (if (string-match "%d.*%d" ivy-count-format)
1504 (or (and (ivy-state-dynamic-collection ivy-last)
1508 (or (and (ivy-state-dynamic-collection ivy-last)
1513 (d-str (if ivy--directory
1514 (abbreviate-file-name ivy--directory)
1517 (goto-char (point-min))
1518 (delete-region (point-min) (minibuffer-prompt-end))
1519 (if (> (+ (mod (+ (length n-str) (length d-str)) (window-width))
1522 (setq n-str (concat n-str "\n" d-str))
1523 (setq n-str (concat n-str d-str)))
1524 (let ((regex (format "\\([^\n]\\{%d\\}\\)[^\n]" (window-width))))
1525 (while (string-match regex n-str)
1526 (setq n-str (replace-match (concat (match-string 1 n-str) "\n") nil t n-str 1))))
1527 (set-text-properties 0 (length n-str)
1528 `(face minibuffer-prompt ,@std-props)
1530 (ivy--set-match-props n-str "confirm"
1531 `(face ivy-confirm-face ,@std-props))
1532 (ivy--set-match-props n-str "match required"
1533 `(face ivy-match-required-face ,@std-props))
1535 ;; get out of the prompt area
1536 (constrain-to-field nil (point-max))))))
1538 (defun ivy--set-match-props (str match props)
1539 "Set STR text proprties that match MATCH to PROPS."
1540 (when (string-match match str)
1541 (set-text-properties
1547 (defvar inhibit-message)
1549 (defun ivy--sort-maybe (collection)
1550 "Sort COLLECTION if needed."
1551 (let ((sort (ivy-state-sort ivy-last))
1555 (let ((sort-fn (cond ((functionp sort)
1557 ((setq entry (assoc (ivy-state-collection ivy-last)
1558 ivy-sort-functions-alist))
1561 (cdr (assoc t ivy-sort-functions-alist))))))
1562 (if (functionp sort-fn)
1563 (cl-sort (copy-sequence collection) sort-fn)
1566 (defun ivy--exhibit ()
1567 "Insert Ivy completions display.
1568 Should be run via minibuffer `post-command-hook'."
1569 (when (memq 'ivy--exhibit post-command-hook)
1570 (let ((inhibit-field-text-motion nil))
1571 (constrain-to-field nil (point-max)))
1572 (setq ivy-text (ivy--input))
1573 (if (ivy-state-dynamic-collection ivy-last)
1574 ;; while-no-input would cause annoying
1575 ;; "Waiting for process to die...done" message interruptions
1576 (let ((inhibit-message t))
1577 (unless (equal ivy--old-text ivy-text)
1579 (setq ivy--all-candidates
1581 (funcall (ivy-state-collection ivy-last) ivy-text)))
1582 (setq ivy--old-text ivy-text)))
1583 (when ivy--all-candidates
1584 (ivy--insert-minibuffer
1585 (ivy--format ivy--all-candidates))))
1586 (cond (ivy--directory
1587 (if (string-match "/\\'" ivy-text)
1588 (if (member ivy-text ivy--all-candidates)
1589 (ivy--cd (expand-file-name ivy-text ivy--directory))
1590 (when (string-match "//\\'" ivy-text)
1591 (if (and default-directory
1592 (string-match "\\`[[:alpha:]]:/" default-directory))
1593 (ivy--cd (match-string 0 default-directory))
1595 (when (string-match "[[:alpha:]]:/$" ivy-text)
1596 (let ((drive-root (match-string 0 ivy-text)))
1597 (when (file-exists-p drive-root)
1598 (ivy--cd drive-root)))))
1599 (if (string-match "\\`~\\'" ivy-text)
1600 (ivy--cd (expand-file-name "~/")))))
1601 ((eq (ivy-state-collection ivy-last) 'internal-complete-buffer)
1602 (when (or (and (string-match "\\` " ivy-text)
1603 (not (string-match "\\` " ivy--old-text)))
1604 (and (string-match "\\` " ivy--old-text)
1605 (not (string-match "\\` " ivy-text))))
1606 (setq ivy--all-candidates
1607 (if (and (> (length ivy-text) 0)
1608 (eq (aref ivy-text 0)
1610 (ivy--buffer-list " ")
1611 (ivy--buffer-list "" ivy-use-virtual-buffers)))
1612 (setq ivy--old-re nil))))
1613 (ivy--insert-minibuffer
1614 (with-current-buffer (ivy-state-buffer ivy-last)
1616 (ivy--filter ivy-text ivy--all-candidates))))
1617 (setq ivy--old-text ivy-text))))
1619 (defun ivy--insert-minibuffer (text)
1620 "Insert TEXT into minibuffer with appropriate cleanup."
1621 (let ((resize-mini-windows nil)
1622 (update-fn (ivy-state-update-fn ivy-last))
1626 (funcall update-fn))
1627 (ivy--insert-prompt)
1628 ;; Do nothing if while-no-input was aborted.
1629 (when (stringp text)
1630 (let ((buffer-undo-list t))
1634 (when (display-graphic-p)
1635 (ivy--resize-minibuffer-to-fit))))
1637 (defun ivy--resize-minibuffer-to-fit ()
1638 "Resize the minibuffer window so it has enough space to display
1639 all of the text contained in the minibuffer."
1640 (with-selected-window (minibuffer-window)
1641 (if (fboundp 'window-text-pixel-size)
1642 (let ((text-height (cdr (window-text-pixel-size)))
1643 (body-height (window-body-height nil t)))
1644 (when (> text-height body-height)
1645 (window-resize nil (- text-height body-height) nil t t)))
1646 (let ((text-height (count-screen-lines))
1647 (body-height (window-body-height)))
1648 (when (> text-height body-height)
1649 (window-resize nil (- text-height body-height) nil t))))))
1651 (declare-function colir-blend-face-background "ext:colir")
1653 (defun ivy--add-face (str face)
1654 "Propertize STR with FACE.
1655 `font-lock-append-text-property' is used, since it's better than
1656 `propertize' or `add-face-text-property' in this case."
1660 (colir-blend-face-background 0 (length str) face str)
1661 (let ((foreground (face-foreground face)))
1663 (add-face-text-property
1665 `(:foreground ,foreground)
1670 (font-lock-append-text-property 0 (length str) 'face face str))))
1673 (declare-function flx-make-string-cache "ext:flx")
1674 (declare-function flx-score "ext:flx")
1676 (defvar ivy--flx-cache nil)
1678 (eval-after-load 'flx
1679 '(setq ivy--flx-cache (flx-make-string-cache)))
1681 (defun ivy-toggle-case-fold ()
1682 "Toggle the case folding between nil and auto.
1683 In any completion session, the case folding starts in auto:
1685 - when the input is all lower case, `case-fold-search' is t
1686 - otherwise it's nil.
1688 You can toggle this to make `case-fold-search' nil regardless of input."
1690 (setq ivy-case-fold-search
1691 (if ivy-case-fold-search
1694 ;; reset cache so that the candidate list updates
1695 (setq ivy--old-re nil))
1697 (defun ivy--filter (name candidates)
1698 "Return all items that match NAME in CANDIDATES.
1699 CANDIDATES are assumed to be static."
1700 (let ((re (funcall ivy--regex-function name)))
1701 (if (and (equal re ivy--old-re)
1703 ;; quick caching for "C-n", "C-p" etc.
1705 (let* ((re-str (if (listp re) (caar re) re))
1706 (matcher (ivy-state-matcher ivy-last))
1708 (and ivy-case-fold-search
1709 (string= name (downcase name))))
1712 (funcall matcher re candidates))
1715 (stringp ivy--old-re)
1716 (not (string-match "\\\\" ivy--old-re))
1717 (not (equal ivy--old-re ""))
1719 (if (string-match "\\\\)\\'" ivy--old-re)
1720 (substring ivy--old-re 0 -2)
1726 (lambda (x) (string-match re x))
1729 (let ((re-list (if (stringp re) (list (cons re t)) re))
1731 (dolist (re re-list)
1738 (let ((re-str (car re)))
1739 (lambda (x) (string-match re-str x)))
1742 (ivy--recompute-index name re-str cands)
1743 (setq ivy--old-re (if cands re-str ""))
1744 (setq ivy--old-cands (ivy--sort name cands))))))
1746 (defcustom ivy-sort-matches-functions-alist '((t . nil))
1747 "An alist of functions used to sort the matching candidates.
1749 This is different from `ivy-sort-functions-alist', which is used
1750 to sort the whole collection only once. The functions taken from
1751 here are instead used on each input change, but they are used
1752 only on already matching candidates, not on all of them.
1754 The alist KEY is a collection function or t to match previously
1755 not matched collection functions.
1757 The alist VAL is a sorting function with the signature of
1758 `ivy--prefix-sort'.")
1760 (defun ivy--sort-files-by-date (_name candidates)
1761 "Re-soft CANDIDATES according to file modification date."
1762 (let ((default-directory ivy--directory))
1763 (cl-sort (copy-sequence candidates)
1766 (nth 5 (file-attributes f2))
1767 (nth 5 (file-attributes f1)))))))
1769 (defun ivy--sort (name candidates)
1770 "Re-sort CANDIDATES according to NAME.
1771 All CANDIDATES are assumed to match NAME."
1772 (let ((key (or (ivy-state-caller ivy-last)
1773 (when (functionp (ivy-state-collection ivy-last))
1774 (ivy-state-collection ivy-last))))
1776 (cond ((and (require 'flx nil 'noerror)
1777 (eq ivy--regex-function 'ivy--regex-fuzzy))
1778 (ivy--flx-sort name candidates))
1779 ((setq fun (cdr (or (assoc key ivy-sort-matches-functions-alist)
1780 (assoc t ivy-sort-matches-functions-alist))))
1781 (funcall fun name candidates))
1785 (defun ivy--prefix-sort (name candidates)
1786 "Re-sort CANDIDATES.
1787 Prefix matches to NAME are put ahead of the list."
1788 (if (or (string-match "^\\^" name) (string= name ""))
1790 (let ((re-prefix (concat "^" (funcall ivy--regex-function name)))
1793 (dolist (s candidates)
1794 (if (string-match re-prefix s)
1796 (push s res-noprefix)))
1798 (nreverse res-prefix)
1799 (nreverse res-noprefix)))))
1801 (defun ivy--recompute-index (name re-str cands)
1802 (let* ((caller (ivy-state-caller ivy-last))
1803 (func (or (and caller (cdr (assoc caller ivy-index-functions-alist)))
1804 (cdr (assoc t ivy-index-functions-alist))
1805 #'ivy-recompute-index-zero)))
1806 (unless (eq this-command 'ivy-resume)
1809 (cl-position (if (and (> (length re-str) 0)
1810 (eq ?^ (aref re-str 0)))
1811 (substring re-str 1)
1816 (concat re-str "/") cands
1818 (and (not (string= name ""))
1819 (not (and (require 'flx nil 'noerror)
1820 (eq ivy--regex-function 'ivy--regex-fuzzy)
1821 (< (length cands) 200)))
1823 (cl-position (nth ivy--index ivy--old-cands)
1825 (funcall func re-str cands))))
1826 (when (and (or (string= name "")
1828 (not (equal ivy--old-re "")))
1830 (or (ivy--preselect-index
1831 (ivy-state-preselect ivy-last)
1835 (defun ivy-recompute-index-swiper (_re-str cands)
1836 (let ((tail (nthcdr ivy--index ivy--old-cands))
1838 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
1840 (while (and tail (null idx))
1841 ;; Compare with eq to handle equal duplicates in cands
1842 (setq idx (cl-position (pop tail) cands)))
1846 ;; already in ivy-state-buffer
1847 (let ((n (line-number-at-pos))
1851 (when (eq n (read (get-text-property 0 'display c)))
1856 (defun ivy-recompute-index-swiper-async (_re-str cands)
1857 (let ((tail (nthcdr ivy--index ivy--old-cands))
1859 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
1861 (while (and tail (null idx))
1862 ;; Compare with `equal', since the collection is re-created
1863 ;; each time with `split-string'
1864 (setq idx (cl-position (pop tail) cands :test #'equal)))
1868 (defun ivy-recompute-index-zero (_re-str _cands)
1871 (defun ivy--flx-sort (name cands)
1872 "Sort according to closeness to string NAME the string list CANDS."
1875 (< (length cands) 200))
1876 (let* ((flx-name (if (string-match "^\\^" name)
1883 (let ((score (car (flx-score x flx-name ivy--flx-cache))))
1887 (if cands-with-score
1889 (sort cands-with-score
1891 (> (car x) (car y)))))
1897 (defcustom ivy-format-function 'ivy-format-function-default
1898 "Function to transform the list of candidate pairs into a string.
1899 This string will be inserted into the minibuffer."
1901 (const :tag "Default" ivy-format-function-default)
1902 (const :tag "Arrow prefix" ivy-format-function-arrow)
1903 (const :tag "Full line" ivy-format-function-line)))
1905 (defun ivy--truncate-string (str width)
1906 "Truncate STR to WIDTH."
1907 (if (> (string-width str) width)
1908 (concat (substring str 0 (min (- width 3)
1909 (- (length str) 3))) "...")
1912 (defun ivy--format-function-generic (selected-fn other-fn cand-pairs separator)
1913 "Transform CAND-PAIRS into a string for minibuffer.
1914 SELECTED-FN and OTHER-FN each take two string arguments.
1915 SEPARATOR is used to join the candidates."
1919 (let ((str (car pair))
1921 (curr (eq (cl-incf i) ivy--index)))
1923 (funcall selected-fn str extra)
1924 (funcall other-fn str extra))))
1928 (defun ivy-format-function-default (cand-pairs)
1929 "Transform CAND-PAIRS into a string for minibuffer."
1930 (ivy--format-function-generic
1932 (concat (ivy--add-face str 'ivy-current-match) extra))
1937 (defun ivy-format-function-arrow (cand-pairs)
1938 "Transform CAND-PAIRS into a string for minibuffer."
1939 (ivy--format-function-generic
1941 (concat "> " (ivy--add-face str 'ivy-current-match) extra))
1943 (concat " " str extra))
1947 (defun ivy-format-function-line (cand-pairs)
1948 "Transform CAND-PAIRS into a string for minibuffer."
1949 (ivy--format-function-generic
1951 (ivy--add-face (concat str extra "\n") 'ivy-current-match))
1953 (concat str extra "\n"))
1957 (defface ivy-minibuffer-match-face-1
1958 '((((class color) (background light))
1959 :background "#d3d3d3")
1960 (((class color) (background dark))
1961 :background "#555555"))
1962 "The background face for `ivy' minibuffer matches.")
1964 (defface ivy-minibuffer-match-face-2
1965 '((((class color) (background light))
1966 :background "#e99ce8" :weight bold)
1967 (((class color) (background dark))
1968 :background "#777777" :weight bold))
1969 "Face for `ivy' minibuffer matches modulo 1.")
1971 (defface ivy-minibuffer-match-face-3
1972 '((((class color) (background light))
1973 :background "#bbbbff" :weight bold)
1974 (((class color) (background dark))
1975 :background "#7777ff" :weight bold))
1976 "Face for `ivy' minibuffer matches modulo 2.")
1978 (defface ivy-minibuffer-match-face-4
1979 '((((class color) (background light))
1980 :background "#ffbbff" :weight bold)
1981 (((class color) (background dark))
1982 :background "#8a498a" :weight bold))
1983 "Face for `ivy' minibuffer matches modulo 3.")
1985 (defcustom ivy-minibuffer-faces
1986 '(ivy-minibuffer-match-face-1
1987 ivy-minibuffer-match-face-2
1988 ivy-minibuffer-match-face-3
1989 ivy-minibuffer-match-face-4)
1990 "List of `ivy' faces for minibuffer group matches.")
1992 (defun ivy--format-minibuffer-line (str)
1994 (str (copy-sequence str)))
1995 (when (eq ivy-display-style 'fancy)
1997 (setq ivy--old-re (funcall ivy--regex-function ivy-text)))
1998 (while (and (string-match ivy--old-re str start)
1999 (> (- (match-end 0) (match-beginning 0)) 0))
2000 (setq start (match-end 0))
2002 (while (<= i ivy--subexps)
2004 (cond ((zerop ivy--subexps)
2005 (cadr ivy-minibuffer-faces))
2007 (car ivy-minibuffer-faces))
2009 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2010 ivy-minibuffer-faces)))))
2011 (if (fboundp 'add-face-text-property)
2012 (add-face-text-property
2018 (font-lock-append-text-property
2027 (defun ivy--format (cands)
2028 "Return a string for CANDS suitable for display in the minibuffer.
2029 CANDS is a list of strings."
2030 (setq ivy--length (length cands))
2031 (when (>= ivy--index ivy--length)
2032 (setq ivy--index (max (1- ivy--length) 0)))
2034 (setq ivy--current "")
2035 (let* ((half-height (/ ivy-height 2))
2036 (start (max 0 (- ivy--index half-height)))
2037 (end (min (+ start (1- ivy-height)) ivy--length))
2038 (start (max 0 (min start (- end (1- ivy-height)))))
2039 (cands (cl-subseq cands start end))
2040 (index (- ivy--index start)))
2041 (cond (ivy--directory
2042 (setq cands (mapcar (lambda (x)
2043 (if (string-match-p "/\\'" x)
2044 (propertize x 'face 'ivy-subdir)
2047 ((eq (ivy-state-collection ivy-last) 'internal-complete-buffer)
2048 (setq cands (mapcar (lambda (x)
2049 (let ((b (get-buffer x)))
2051 (buffer-file-name b)
2052 (buffer-modified-p b))
2053 (propertize x 'face 'ivy-modified-buffer)
2056 (setq ivy--current (copy-sequence (nth index cands)))
2057 (let* ((ivy--index index)
2060 (cons (ivy--format-minibuffer-line cand) nil)) cands))
2061 (res (concat "\n" (funcall ivy-format-function cand-pairs))))
2062 (put-text-property 0 (length res) 'read-only nil res)
2065 (defvar ivy--virtual-buffers nil
2066 "Store the virtual buffers alist.")
2068 (defvar recentf-list)
2070 (defface ivy-virtual '((t :inherit font-lock-builtin-face))
2071 "Face used by Ivy for matching virtual buffer names.")
2073 (defcustom ivy-virtual-abbreviate 'name
2074 "The mode of abbreviation for virtual buffer names."
2076 (const :tag "Only name" name)
2077 (const :tag "Full path" full)
2078 ;; eventually, uniquify
2081 (defun ivy--virtual-buffers ()
2082 "Adapted from `ido-add-virtual-buffers-to-list'."
2083 (unless recentf-mode
2085 (let ((bookmarks (and (boundp 'bookmark-alist)
2087 virtual-buffers name)
2088 (dolist (head (append
2090 (delete " - no file -"
2091 (delq nil (mapcar (lambda (bookmark)
2092 (cdr (assoc 'filename bookmark)))
2095 (if (eq ivy-virtual-abbreviate 'name)
2096 (file-name-nondirectory head)
2097 (expand-file-name head)))
2098 (when (equal name "")
2099 (setq name (file-name-nondirectory (directory-file-name head))))
2100 (when (equal name "")
2102 (and (not (equal name ""))
2103 (null (get-file-buffer head))
2104 (not (assoc name virtual-buffers))
2105 (push (cons name head) virtual-buffers)))
2106 (when virtual-buffers
2107 (dolist (comp virtual-buffers)
2108 (put-text-property 0 (length (car comp))
2111 (setq ivy--virtual-buffers (nreverse virtual-buffers))
2112 (mapcar #'car ivy--virtual-buffers))))
2114 (defun ivy--buffer-list (str &optional virtual)
2115 "Return the buffers that match STR.
2116 When VIRTUAL is non-nil, add virtual buffers."
2121 (if (with-current-buffer x
2123 (abbreviate-file-name default-directory)))
2124 (propertize x 'face 'ivy-remote)
2126 (all-completions str 'internal-complete-buffer))
2128 (ivy--virtual-buffers)))))
2130 (defun ivy--switch-buffer-action (buffer)
2132 BUFFER may be a string or nil."
2134 (if (zerop (length buffer))
2136 ivy-text nil 'force-same-window)
2137 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2139 (not (get-buffer buffer)))
2140 (find-file (cdr virtual))
2142 buffer nil 'force-same-window))))))
2144 (defun ivy--switch-buffer-other-window-action (buffer)
2145 "Switch to BUFFER in other window.
2146 BUFFER may be a string or nil."
2147 (if (zerop (length buffer))
2148 (switch-to-buffer-other-window ivy-text)
2149 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2151 (not (get-buffer buffer)))
2152 (find-file-other-window (cdr virtual))
2153 (switch-to-buffer-other-window buffer)))))
2155 (defun ivy--rename-buffer-action (buffer)
2157 (let ((new-name (read-string "Rename buffer (to new name): ")))
2158 (with-current-buffer buffer
2159 (rename-buffer new-name))))
2161 (defvar ivy-switch-buffer-map (make-sparse-keymap))
2168 (ivy--reset-state ivy-last))
2171 ivy--switch-buffer-other-window-action
2174 ivy--rename-buffer-action
2178 (defun ivy-switch-buffer ()
2179 "Switch to another buffer."
2182 (call-interactively 'switch-to-buffer)
2183 (let ((this-command 'ivy-switch-buffer))
2184 (ivy-read "Switch to buffer: " 'internal-complete-buffer
2185 :preselect (buffer-name (other-buffer (current-buffer)))
2186 :action #'ivy--switch-buffer-action
2187 :keymap ivy-switch-buffer-map))))
2190 (defun ivy-recentf ()
2191 "Find a file on `recentf-list'."
2193 (ivy-read "Recentf: " recentf-list
2199 (defun ivy-yank-word ()
2200 "Pull next word from buffer into search string."
2205 (le (line-end-position)))
2209 (setq amend (buffer-substring-no-properties pt (point))))))
2211 (insert (replace-regexp-in-string " +" " " amend)))))
2213 (defun ivy-kill-ring-save ()
2214 "Store the current candidates into the kill ring.
2215 If the region is active, forward to `kill-ring-save' instead."
2217 (if (region-active-p)
2218 (call-interactively 'kill-ring-save)
2225 (defun ivy-insert-current ()
2226 "Make the current candidate into current input.
2227 Don't finish completion."
2229 (delete-minibuffer-contents)
2230 (if (and ivy--directory
2231 (string-match "/$" ivy--current))
2232 (insert (substring ivy--current 0 -1))
2233 (insert ivy--current)))
2235 (defun ivy-toggle-fuzzy ()
2236 "Toggle the re builder between `ivy--regex-fuzzy' and `ivy--regex-plus'."
2238 (setq ivy--old-re nil)
2239 (if (eq ivy--regex-function 'ivy--regex-fuzzy)
2240 (setq ivy--regex-function 'ivy--regex-plus)
2241 (setq ivy--regex-function 'ivy--regex-fuzzy)))
2243 (defun ivy-reverse-i-search ()
2244 "Enter a recursive `ivy-read' session using the current history.
2245 The selected history element will be inserted into the minibufer."
2247 (let ((enable-recursive-minibuffers t)
2248 (history (symbol-value (ivy-state-history ivy-last)))
2249 (old-last ivy-last))
2250 (ivy-read "Reverse-i-search: "
2254 (setq ivy-last old-last))
2255 (delete-minibuffer-contents)
2256 (insert (substring-no-properties x))
2259 (defun ivy-restrict-to-matches ()
2260 "Restrict candidates to current matches and erase input."
2262 (delete-minibuffer-contents)
2263 (setq ivy--all-candidates
2264 (ivy--filter ivy-text ivy--all-candidates)))
2267 (defvar-local ivy-occur-last nil
2268 "Buffer-local value of `ivy-last'.
2269 Can't re-use `ivy-last' because using e.g. `swiper' in the same
2270 buffer would modify `ivy-last'.")
2272 (defvar ivy-occur-mode-map
2273 (let ((map (make-sparse-keymap)))
2274 (define-key map [mouse-1] 'ivy-occur-click)
2275 (define-key map (kbd "RET") 'ivy-occur-press)
2276 (define-key map (kbd "j") 'next-line)
2277 (define-key map (kbd "k") 'previous-line)
2278 (define-key map (kbd "h") 'backward-char)
2279 (define-key map (kbd "l") 'forward-char)
2280 (define-key map (kbd "g") 'ivy-occur-press)
2281 (define-key map (kbd "a") 'ivy-occur-read-action)
2282 (define-key map (kbd "o") 'ivy-occur-dispatch)
2283 (define-key map (kbd "q") 'quit-window)
2285 "Keymap for Ivy Occur mode.")
2287 (define-derived-mode ivy-occur-mode fundamental-mode "Ivy-Occur"
2288 "Major mode for output from \\[ivy-occur].
2290 \\{ivy-occur-mode-map}")
2292 (defvar ivy-occur-grep-mode-map
2293 (let ((map (copy-keymap ivy-occur-mode-map)))
2294 (define-key map (kbd "C-x C-q") 'ivy-wgrep-change-to-wgrep-mode)
2296 "Keymap for Ivy Occur Grep mode.")
2298 (define-derived-mode ivy-occur-grep-mode grep-mode "Ivy-Occur"
2299 "Major mode for output from \\[ivy-occur].
2301 \\{ivy-occur-grep-mode-map}")
2303 (defvar counsel-git-grep-cmd)
2306 "Stop completion and put the current matches into a new buffer.
2308 The new buffer will also remember the current action(s).
2310 While in the *ivy-occur* buffer, selecting a cadidate with RET or
2311 a mouse click will call the appropriate action for that candidate.
2313 It's possible to have an unlimited amount of *ivy-occur* buffers."
2316 (generate-new-buffer
2317 (format "*ivy-occur%s \"%s\"*"
2319 (if (setq caller (ivy-state-caller ivy-last))
2320 (concat " " (prin1-to-string caller))
2323 (do-grep (eq (ivy-state-caller ivy-last) 'counsel-git-grep)))
2324 (with-current-buffer buffer
2327 (setq ivy--old-cands
2329 (shell-command-to-string
2330 (format counsel-git-grep-cmd ivy--old-re))
2333 (ivy-occur-grep-mode))
2335 (setf (ivy-state-text ivy-last) ivy-text)
2336 (setq ivy-occur-last ivy-last)
2337 (setq-local ivy--directory ivy--directory)
2338 (let ((inhibit-read-only t))
2341 ;; Need precise number of header lines for `wgrep' to work.
2342 (insert (format "-*- mode:grep; default-directory: %S -*-\n\n\n"
2343 default-directory)))
2344 (insert (format "%d candidates:\n" (length ivy--old-cands)))
2345 (dolist (cand ivy--old-cands)
2346 (let ((str (if do-grep
2348 (concat " " cand))))
2349 (add-text-properties
2353 help-echo "mouse-1: call ivy-action")
2355 (insert str "\n")))))
2356 (ivy-exit-with-action
2357 `(lambda (_) (pop-to-buffer ,buffer)))))
2359 (declare-function wgrep-change-to-wgrep-mode "ext:wgrep")
2361 (defun ivy-wgrep-change-to-wgrep-mode ()
2362 "Forward to `wgrep-change-to-wgrep-mode'."
2364 (if (require 'wgrep nil 'noerror)
2365 (wgrep-change-to-wgrep-mode)
2366 (error "Package wgrep isn't installed")))
2368 (defun ivy-occur-read-action ()
2369 "Select one of the available actions as the current one."
2371 (let ((ivy-last ivy-occur-last))
2374 (defun ivy-occur-dispatch ()
2375 "Call one of the available actions on the current item."
2377 (let* ((state-action (ivy-state-action ivy-occur-last))
2378 (actions (if (symbolp state-action)
2380 (copy-sequence state-action))))
2383 (ivy-occur-read-action)
2385 (setf (ivy-state-action ivy-occur-last) actions))))
2387 (defun ivy-occur-click (event)
2388 "Execute action for the current candidate.
2389 EVENT gives the mouse position."
2391 (let ((window (posn-window (event-end event)))
2392 (pos (posn-point (event-end event))))
2393 (with-current-buffer (window-buffer window)
2395 (ivy-occur-press))))
2397 (defun ivy-occur-press ()
2398 "Execute action for the current candidate."
2401 (when (save-excursion
2403 (looking-at "\\(?:./\\| \\)\\(.*\\)$"))
2404 (let* ((ivy-last ivy-occur-last)
2405 (ivy-text (ivy-state-text ivy-last))
2406 (str (buffer-substring
2409 (coll (ivy-state-collection ivy-last))
2410 (action (ivy--get-action ivy-last))
2414 (if (and (consp coll)
2416 (cdr (assoc str coll))
2418 (if (memq (ivy-state-caller ivy-last)
2419 '(swiper counsel-git-grep))
2420 (with-current-buffer (window-buffer (selected-window))
2422 (swiper--add-overlays
2423 (ivy--regex ivy-text)
2424 (line-beginning-position)
2427 (run-at-time 0.5 nil 'swiper--cleanup))
2428 (pulse-momentary-highlight-one-line (point)))))))
2432 ;;; ivy.el ends here