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 (defgroup ivy-faces nil
48 "Font-lock faces for `ivy'."
52 (defface ivy-current-match
53 '((((class color) (background light))
54 :background "#1a4b77" :foreground "white")
55 (((class color) (background dark))
56 :background "#65a7e2" :foreground "black"))
57 "Face used by Ivy for highlighting the current match.")
59 (defface ivy-minibuffer-match-face-1
60 '((((class color) (background light))
61 :background "#d3d3d3")
62 (((class color) (background dark))
63 :background "#555555"))
64 "The background face for `ivy' minibuffer matches.")
66 (defface ivy-minibuffer-match-face-2
67 '((((class color) (background light))
68 :background "#e99ce8" :weight bold)
69 (((class color) (background dark))
70 :background "#777777" :weight bold))
71 "Face for `ivy' minibuffer matches numbered 1 modulo 3.")
73 (defface ivy-minibuffer-match-face-3
74 '((((class color) (background light))
75 :background "#bbbbff" :weight bold)
76 (((class color) (background dark))
77 :background "#7777ff" :weight bold))
78 "Face for `ivy' minibuffer matches numbered 2 modulo 3.")
80 (defface ivy-minibuffer-match-face-4
81 '((((class color) (background light))
82 :background "#ffbbff" :weight bold)
83 (((class color) (background dark))
84 :background "#8a498a" :weight bold))
85 "Face for `ivy' minibuffer matches numbered 3 modulo 3.")
87 (defface ivy-confirm-face
88 '((t :foreground "ForestGreen" :inherit minibuffer-prompt))
89 "Face used by Ivy for a confirmation prompt.")
91 (defface ivy-match-required-face
92 '((t :foreground "red" :inherit minibuffer-prompt))
93 "Face used by Ivy for a match required prompt.")
96 '((t (:inherit 'dired-directory)))
97 "Face used by Ivy for highlighting subdirs in the alternatives.")
99 (defface ivy-modified-buffer
100 '((t :inherit 'default))
101 "Face used by Ivy for highlighting modified file visiting buffers.")
104 '((t (:foreground "#110099")))
105 "Face used by Ivy for highlighting remotes in the alternatives.")
108 '((t :inherit font-lock-builtin-face))
109 "Face used by Ivy for matching virtual buffer names.")
111 (setcdr (assoc load-file-name custom-current-group-alist) 'ivy)
113 (defcustom ivy-height 10
114 "Number of lines for the minibuffer window."
117 (defcustom ivy-count-format "%-4d "
118 "The style to use for displaying the current candidate count for `ivy-read'.
119 Set this to \"\" to suppress the count visibility.
120 Set this to \"(%d/%d) \" to display both the index and the count."
122 (const :tag "Count disabled" "")
123 (const :tag "Count matches" "%-4d ")
124 (const :tag "Count matches and show current match" "(%d/%d) ")
127 (defcustom ivy-wrap nil
128 "When non-nil, wrap around after the first and the last candidate."
131 (defcustom ivy-display-style (unless (version< emacs-version "24.5") 'fancy)
132 "The style for formatting the minibuffer.
134 By default, the matched strings are copied as is.
136 The fancy display style highlights matching parts of the regexp,
137 a behavior similar to `swiper'.
139 This setting depends on `add-face-text-property' - a C function
140 available as of Emacs 24.5. Fancy style will render poorly in
141 earlier versions of Emacs."
143 (const :tag "Plain" nil)
144 (const :tag "Fancy" fancy)))
146 (defcustom ivy-on-del-error-function 'minibuffer-keyboard-quit
147 "The handler for when `ivy-backward-delete-char' throws.
148 Usually a quick exit out of the minibuffer."
151 (defcustom ivy-extra-directories '("../" "./")
152 "Add this to the front of the list when completing file names.
153 Only \"./\" and \"../\" apply here. They appear in reverse order."
154 :type '(repeat :tag "Dirs"
156 (const :tag "Parent Directory" "../")
157 (const :tag "Current Directory" "./"))))
159 (defcustom ivy-use-virtual-buffers nil
160 "When non-nil, add `recentf-mode' and bookmarks to `ivy-switch-buffer'."
163 (defvar ivy--actions-list nil
164 "A list of extra actions per command.")
166 (defun ivy-set-actions (cmd actions)
167 "Set CMD extra exit points to ACTIONS."
168 (setq ivy--actions-list
169 (plist-put ivy--actions-list cmd actions)))
171 (defvar ivy--sources-list nil
172 "A list of extra sources per command.")
174 (defun ivy-set-sources (cmd sources)
175 "Attach to CMD a list of extra SOURCES.
177 Each static source is a function that takes no argument and
178 returns a list of strings.
180 The '(original-source) determines the position of the original
183 Extra dynamic sources aren't supported yet.
187 (defun small-recentf ()
188 (cl-subseq recentf-list 0 20))
195 (setq ivy--sources-list
196 (plist-put ivy--sources-list cmd sources)))
200 (defvar ivy-minibuffer-map
201 (let ((map (make-sparse-keymap)))
202 (define-key map (kbd "C-m") 'ivy-done)
203 (define-key map (kbd "C-M-m") 'ivy-call)
204 (define-key map (kbd "C-j") 'ivy-alt-done)
205 (define-key map (kbd "C-M-j") 'ivy-immediate-done)
206 (define-key map (kbd "TAB") 'ivy-partial-or-done)
207 (define-key map (kbd "C-n") 'ivy-next-line)
208 (define-key map (kbd "C-p") 'ivy-previous-line)
209 (define-key map (kbd "<down>") 'ivy-next-line)
210 (define-key map (kbd "<up>") 'ivy-previous-line)
211 (define-key map (kbd "C-s") 'ivy-next-line-or-history)
212 (define-key map (kbd "C-r") 'ivy-reverse-i-search)
213 (define-key map (kbd "SPC") 'self-insert-command)
214 (define-key map (kbd "DEL") 'ivy-backward-delete-char)
215 (define-key map (kbd "M-DEL") 'ivy-backward-kill-word)
216 (define-key map (kbd "C-d") 'ivy-delete-char)
217 (define-key map (kbd "C-f") 'ivy-forward-char)
218 (define-key map (kbd "M-d") 'ivy-kill-word)
219 (define-key map (kbd "M-<") 'ivy-beginning-of-buffer)
220 (define-key map (kbd "M->") 'ivy-end-of-buffer)
221 (define-key map (kbd "M-n") 'ivy-next-history-element)
222 (define-key map (kbd "M-p") 'ivy-previous-history-element)
223 (define-key map (kbd "C-g") 'minibuffer-keyboard-quit)
224 (define-key map (kbd "C-v") 'ivy-scroll-up-command)
225 (define-key map (kbd "M-v") 'ivy-scroll-down-command)
226 (define-key map (kbd "C-M-n") 'ivy-next-line-and-call)
227 (define-key map (kbd "C-M-p") 'ivy-previous-line-and-call)
228 (define-key map (kbd "M-q") 'ivy-toggle-regexp-quote)
229 (define-key map (kbd "M-j") 'ivy-yank-word)
230 (define-key map (kbd "M-i") 'ivy-insert-current)
231 (define-key map (kbd "C-o") 'hydra-ivy/body)
232 (define-key map (kbd "M-o") 'ivy-dispatching-done)
233 (define-key map (kbd "C-M-o") 'ivy-dispatching-call)
234 (define-key map (kbd "C-k") 'ivy-kill-line)
235 (define-key map (kbd "S-SPC") 'ivy-restrict-to-matches)
236 (define-key map (kbd "M-w") 'ivy-kill-ring-save)
237 (define-key map (kbd "C-'") 'ivy-avy)
238 (define-key map (kbd "C-M-a") 'ivy-read-action)
239 (define-key map (kbd "C-c C-o") 'ivy-occur)
240 (define-key map (kbd "C-c C-a") 'ivy-toggle-ignore)
241 (define-key map (kbd "C-h m") 'ivy-help)
243 "Keymap used in the minibuffer.")
244 (autoload 'hydra-ivy/body "ivy-hydra" "" t)
247 (let ((map (make-sparse-keymap)))
248 (define-key map [remap switch-to-buffer]
250 (define-key map [remap switch-to-buffer-other-window]
251 'ivy-switch-buffer-other-window)
253 "Keymap for `ivy-mode'.")
256 (cl-defstruct ivy-state
258 predicate require-match initial-input
259 history preselect keymap update-fn sort
260 ;; The window in which `ivy-read' was called
262 ;; The buffer in which `ivy-read' was called
264 ;; The value of `ivy-text' to be used by `ivy-occur'
270 ;; When this is non-nil, call it for each input change to get new candidates
274 (defvar ivy-last (make-ivy-state)
275 "The last parameters passed to `ivy-read'.
277 This should eventually become a stack so that you could use
278 `ivy-read' recursively.")
280 (defsubst ivy-set-action (action)
281 (setf (ivy-state-action ivy-last) action))
283 (defvar ivy-history nil
284 "History list of candidates entered in the minibuffer.
286 Maximum length of the history list is determined by the value
287 of `history-length'.")
289 (defvar ivy--directory nil
290 "Current directory when completing file names.")
292 (defvar ivy--length 0
293 "Store the amount of viable candidates.")
296 "Store the user's string as it is typed in.")
298 (defvar ivy--current ""
299 "Current candidate.")
302 "Store the index of the current candidate.")
305 "Store 'done if the completion was successfully selected.
306 Otherwise, store nil.")
308 (defvar ivy--all-candidates nil
309 "Store the candidates passed to `ivy-read'.")
311 (defvar ivy--extra-candidates '((original-source))
312 "Store candidates added by the extra sources.
314 This is an internal-use alist. Each key is a function name, or
315 original-source (which represents where the current dynamic
316 candidates should go).
318 Each value is an evaluation of the function, in case of static
319 sources. These values will subsequently be filtered on `ivy-text'.
321 This variable is set by `ivy-read' and used by `ivy--set-candidates'.")
323 (defvar ivy-use-ignore t
324 "Store policy for user-configured candidate filtering.")
326 (defvar ivy--default nil
327 "Default initial input.")
329 (defvar ivy--prompt nil
330 "Store the format-style prompt.
331 When non-nil, it should contain at least one %d.")
333 (defvar ivy--prompt-extra ""
334 "Temporary modifications to the prompt.")
336 (defvar ivy--old-re nil
337 "Store the old regexp.")
339 (defvar ivy--old-cands nil
340 "Store the candidates matched by `ivy--old-re'.")
342 (defvar ivy--regex-function 'ivy--regex
343 "Current function for building a regex.")
345 (defvar ivy--subexps 0
346 "Number of groups in the current `ivy--regex'.")
348 (defvar ivy--full-length nil
349 "When :dynamic-collection is non-nil, this can be the total amount of candidates.")
351 (defvar ivy--old-text ""
352 "Store old `ivy-text' for dynamic completion.")
354 (defvar ivy-case-fold-search 'auto
355 "Store the current overriding `case-fold-search'.")
357 (defvar Info-current-file)
359 (defmacro ivy-quit-and-run (&rest body)
360 "Quit the minibuffer and run BODY afterwards."
362 (put 'quit 'error-message "")
365 (put 'quit 'error-message "Quit")
367 (minibuffer-keyboard-quit)))
369 (defun ivy-exit-with-action (action)
370 "Quit the minibuffer and call ACTION afterwards."
374 (ivy-set-action ',(ivy-state-action ivy-last))))
375 (setq ivy-exit 'done)
378 (defmacro with-ivy-window (&rest body)
379 "Execute BODY in the window from which `ivy-read' was called."
382 `(with-selected-window (ivy--get-window ivy-last)
385 (defun ivy--done (text)
386 "Insert TEXT and exit minibuffer."
387 (if (and ivy--directory
388 (not (eq (ivy-state-history ivy-last) 'grep-files-history)))
389 (insert (setq ivy--current (expand-file-name
390 text ivy--directory)))
391 (insert (setq ivy--current text)))
392 (setq ivy-exit 'done)
397 "Exit the minibuffer with the selected candidate."
399 (delete-minibuffer-contents)
400 (cond ((> ivy--length 0)
401 (ivy--done ivy--current))
402 ((memq (ivy-state-collection ivy-last)
403 '(read-file-name-internal internal-complete-buffer))
404 (if (or (not (eq confirm-nonexistent-file-or-buffer t))
405 (equal " (confirm)" ivy--prompt-extra))
407 (setq ivy--prompt-extra " (confirm)")
410 ((memq (ivy-state-require-match ivy-last)
411 '(nil confirm confirm-after-completion))
412 (ivy--done ivy-text))
414 (setq ivy--prompt-extra " (match required)")
418 (defun ivy-read-action ()
419 "Change the action to one of the available ones."
421 (let ((actions (ivy-state-action ivy-last)))
422 (unless (null (ivy--actionp actions))
423 (let* ((hint (concat (if (eq this-command 'ivy-read-action)
432 'face 'font-lock-builtin-face)
437 (key (string (read-key hint)))
438 (action-idx (cl-position-if
439 (lambda (x) (equal (car x) key))
441 (cond ((string= key "
\a"))
443 (error "%s is not bound" key))
446 (setcar actions (1+ action-idx))
447 (ivy-set-action actions)))))))
449 (defun ivy-dispatching-done ()
450 "Select one of the available actions and call `ivy-done'."
455 (defun ivy-dispatching-call ()
456 "Select one of the available actions and call `ivy-call'."
458 (let ((actions (copy-sequence (ivy-state-action ivy-last))))
460 (when (ivy-read-action)
462 (ivy-set-action actions))))
464 (defun ivy-build-tramp-name (x)
465 "Reconstruct X into a path.
466 Is is a cons cell, related to `tramp-get-completion-function'."
470 (concat user "@" domain)
473 (declare-function tramp-get-completion-function "tramp")
474 (declare-function Info-find-node "info")
476 (defun ivy-alt-done (&optional arg)
477 "Exit the minibuffer with the selected candidate.
478 When ARG is t, exit with current text, ignoring the candidates."
481 (ivy-immediate-done))
483 (ivy--directory-done))
484 ((eq (ivy-state-collection ivy-last) 'Info-read-node-name-1)
485 (if (or (equal ivy--current "(./)")
486 (equal ivy--current "(../)"))
488 (ivy-read "Go to file: " 'read-file-name-internal
491 (expand-file-name x ivy--directory)
497 (defun ivy--directory-done ()
498 "Handle exit from the minibuffer when completing file names."
501 ((equal ivy-text "/sudo::")
502 (setq dir (concat ivy-text ivy--directory))
507 (not (equal ivy-text ""))
511 (file-name-as-directory
513 ivy-text ivy--directory))))))
515 (not (string= ivy--current "./"))
516 (cl-plusp ivy--length)
519 (setq dir (file-name-as-directory
521 ivy--current ivy--directory)))))))
524 ((or (and (equal ivy--directory "/")
525 (string-match "\\`[^/]+:.*:.*\\'" ivy-text))
526 (string-match "\\`/[^/]+:.*:.*\\'" ivy-text))
528 ((or (and (equal ivy--directory "/")
530 "\\`\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
533 "\\`\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
535 (setq ivy-text ivy--current))))
537 "\\`/\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
539 (let ((method (match-string 1 ivy-text))
540 (user (match-string 2 ivy-text))
541 (rest (match-string 3 ivy-text))
544 (dolist (x (tramp-get-completion-function method))
545 (setq res (append res (funcall (car x) (cadr x)))))
546 (setq res (delq nil res))
550 (setq res (cl-delete-duplicates res :test #'equal))
551 (let* ((old-ivy-last ivy-last)
552 (enable-recursive-minibuffers t)
553 (host (ivy-read "user@host: "
554 (mapcar #'ivy-build-tramp-name res)
555 :initial-input rest)))
556 (setq ivy-last old-ivy-last)
558 (setq ivy--directory "/")
559 (ivy--cd (concat "/" method ":" host ":"))))))
563 (defcustom ivy-tab-space nil
564 "When non-nil, `ivy-partial-or-done' should insert a space."
567 (defun ivy-partial-or-done ()
568 "Complete the minibuffer text as much as possible.
569 If the text hasn't changed as a result, forward to `ivy-alt-done'."
571 (if (and (eq (ivy-state-collection ivy-last) #'read-file-name-internal)
572 (or (and (equal ivy--directory "/")
573 (string-match "\\`[^/]+:.*\\'" ivy-text))
574 (string-match "\\`/" ivy-text)))
575 (let ((default-directory ivy--directory))
576 (minibuffer-complete)
577 (setq ivy-text (ivy--input))
578 (when (file-directory-p
579 (expand-file-name ivy-text ivy--directory))
580 (ivy--cd (file-name-as-directory
581 (expand-file-name ivy-text ivy--directory)))))
583 (when (or (eq this-command last-command)
587 (defun ivy-partial ()
588 "Complete the minibuffer text as much as possible."
590 (let* ((parts (or (split-string ivy-text " " t) (list "")))
591 (postfix (car (last parts)))
592 (completion-ignore-case t)
593 (startp (string-match "^\\^" postfix))
594 (new (try-completion (if startp
595 (substring postfix 1)
597 (mapcar (lambda (str)
598 (let ((i (string-match postfix str)))
602 (cond ((eq new t) nil)
603 ((string= new ivy-text) nil)
605 (delete-region (minibuffer-prompt-end) (point-max))
610 (insert (mapconcat #'identity parts " ")
611 (if ivy-tab-space " " ""))
614 (defun ivy-immediate-done ()
615 "Exit the minibuffer with the current input."
617 (delete-minibuffer-contents)
618 (insert (setq ivy--current
620 (expand-file-name ivy-text ivy--directory)
622 (setq ivy-exit 'done)
627 "Resume the last completion session."
629 (when (eq (ivy-state-caller ivy-last) 'swiper)
630 (switch-to-buffer (ivy-state-buffer ivy-last)))
631 (with-current-buffer (ivy-state-buffer ivy-last)
633 (ivy-state-prompt ivy-last)
634 (ivy-state-collection ivy-last)
635 :predicate (ivy-state-predicate ivy-last)
636 :require-match (ivy-state-require-match ivy-last)
637 :initial-input ivy-text
638 :history (ivy-state-history ivy-last)
639 :preselect (unless (eq (ivy-state-collection ivy-last)
640 'read-file-name-internal)
642 :keymap (ivy-state-keymap ivy-last)
643 :update-fn (ivy-state-update-fn ivy-last)
644 :sort (ivy-state-sort ivy-last)
645 :action (ivy-state-action ivy-last)
646 :unwind (ivy-state-unwind ivy-last)
647 :re-builder (ivy-state-re-builder ivy-last)
648 :matcher (ivy-state-matcher ivy-last)
649 :dynamic-collection (ivy-state-dynamic-collection ivy-last)
650 :caller (ivy-state-caller ivy-last))))
652 (defvar ivy-calling nil
653 "When non-nil, call the current action when `ivy--index' changes.")
655 (defun ivy-set-index (index)
656 "Set `ivy--index' to INDEX."
657 (setq ivy--index index)
662 (defun ivy-beginning-of-buffer ()
663 "Select the first completion candidate."
667 (defun ivy-end-of-buffer ()
668 "Select the last completion candidate."
670 (ivy-set-index (1- ivy--length)))
672 (defun ivy-scroll-up-command ()
673 "Scroll the candidates upward by the minibuffer height."
675 (ivy-set-index (min (1- (+ ivy--index ivy-height))
678 (defun ivy-scroll-down-command ()
679 "Scroll the candidates downward by the minibuffer height."
681 (ivy-set-index (max (1+ (- ivy--index ivy-height))
684 (defun ivy-minibuffer-grow ()
685 "Grow the minibuffer window by 1 line."
687 (setq-local max-mini-window-height
688 (cl-incf ivy-height)))
690 (defun ivy-minibuffer-shrink ()
691 "Shrink the minibuffer window by 1 line."
693 (unless (<= ivy-height 2)
694 (setq-local max-mini-window-height
695 (cl-decf ivy-height))
696 (window-resize (selected-window) -1)))
698 (defun ivy-next-line (&optional arg)
699 "Move cursor vertically down ARG candidates."
701 (setq arg (or arg 1))
702 (let ((index (+ ivy--index arg)))
703 (if (> index (1- ivy--length))
705 (ivy-beginning-of-buffer)
706 (ivy-set-index (1- ivy--length)))
707 (ivy-set-index index))))
709 (defun ivy-next-line-or-history (&optional arg)
710 "Move cursor vertically down ARG candidates.
711 If the input is empty, select the previous history element instead."
713 (if (string= ivy-text "")
714 (ivy-previous-history-element 1)
715 (ivy-next-line arg)))
717 (defun ivy-previous-line (&optional arg)
718 "Move cursor vertically up ARG candidates."
720 (setq arg (or arg 1))
721 (let ((index (- ivy--index arg)))
726 (ivy-set-index index))))
728 (defun ivy-previous-line-or-history (arg)
729 "Move cursor vertically up ARG candidates.
730 If the input is empty, select the previous history element instead."
732 (when (string= ivy-text "")
733 (ivy-previous-history-element 1))
734 (ivy-previous-line arg))
736 (defun ivy-toggle-calling ()
737 "Flip `ivy-calling'."
739 (when (setq ivy-calling (not ivy-calling))
742 (defun ivy-toggle-ignore ()
743 "Toggle user-configured candidate filtering."
745 (setq ivy-use-ignore (null ivy-use-ignore))
747 (setq ivy--old-cands nil))
749 (defun ivy--get-action (state)
750 "Get the action function from STATE."
751 (let ((action (ivy-state-action state)))
753 (if (functionp action)
755 (cadr (nth (car action) action))))))
757 (defun ivy--get-window (state)
758 "Get the window from STATE."
759 (if (ivy-state-p state)
760 (let ((window (ivy-state-window state)))
761 (if (window-live-p window)
763 (if (= (length (window-list)) 1)
768 (defun ivy--actionp (x)
769 "Return non-nil when X is a list of actions."
770 (and x (listp x) (not (eq (car x) 'closure))))
772 (defun ivy-next-action ()
773 "When the current action is a list, scroll it forwards."
775 (let ((action (ivy-state-action ivy-last)))
776 (when (ivy--actionp action)
777 (unless (>= (car action) (1- (length action)))
778 (cl-incf (car action))))))
780 (defun ivy-prev-action ()
781 "When the current action is a list, scroll it backwards."
783 (let ((action (ivy-state-action ivy-last)))
784 (when (ivy--actionp action)
785 (unless (<= (car action) 1)
786 (cl-decf (car action))))))
788 (defun ivy-action-name ()
789 "Return the name associated with the current action."
790 (let ((action (ivy-state-action ivy-last)))
791 (if (ivy--actionp action)
795 (nth 2 (nth (car action) action)))
798 (defvar ivy-inhibit-action nil
799 "When non-nil, `ivy-call' does nothing.
803 (let* ((ivy-inhibit-action t)
804 (str (counsel-locate \"lispy.el\")))
805 ;; do whatever with str - the corresponding file will not be opened
809 "Call the current action without exiting completion."
811 (unless ivy-inhibit-action
812 (let ((action (ivy--get-action ivy-last)))
814 (let* ((collection (ivy-state-collection ivy-last))
815 (x (if (and (consp collection)
816 (consp (car collection)))
817 (cdr (assoc ivy--current collection))
818 (if (equal ivy--current "")
821 (prog1 (funcall action x)
822 (unless (or (eq ivy-exit 'done)
823 (equal (selected-window)
824 (active-minibuffer-window))
825 (null (active-minibuffer-window)))
826 (select-window (active-minibuffer-window)))))))))
828 (defun ivy-next-line-and-call (&optional arg)
829 "Move cursor vertically down ARG candidates.
830 Call the permanent action if possible."
836 (defun ivy-previous-line-and-call (&optional arg)
837 "Move cursor vertically down ARG candidates.
838 Call the permanent action if possible."
840 (ivy-previous-line arg)
844 (defun ivy-previous-history-element (arg)
845 "Forward to `previous-history-element' with ARG."
847 (previous-history-element arg)
850 (ivy--maybe-scroll-history))
852 (defun ivy-next-history-element (arg)
853 "Forward to `next-history-element' with ARG."
855 (if (and (= minibuffer-history-position 0)
858 (insert ivy--default)
859 (when (and (with-ivy-window (derived-mode-p 'prog-mode))
860 (> (point) (minibuffer-prompt-end)))
863 (goto-char (minibuffer-prompt-end))
865 (forward-char (+ 2 (length ivy--default)))))
866 (next-history-element arg))
869 (ivy--maybe-scroll-history))
871 (defvar ivy-ffap-url-functions nil
872 "List of functions that check if the point is on a URL.")
874 (defun ivy--cd-maybe ()
875 "Check if the current input points to a different directory.
876 If so, move to that directory, while keeping only the file name."
878 (let ((input (ivy--input))
880 (if (setq url (or (ffap-url-p input)
885 ivy-ffap-url-functions
886 :initial-value nil))))
887 (ivy-exit-with-action
889 (funcall ffap-url-fetcher url)))
890 (setq input (expand-file-name input))
891 (let ((file (file-name-nondirectory input))
892 (dir (expand-file-name (file-name-directory input))))
893 (if (string= dir ivy--directory)
895 (delete-minibuffer-contents)
900 (defun ivy--maybe-scroll-history ()
901 "If the selected history element has an index, scroll there."
902 (let ((idx (ignore-errors
904 (minibuffer-prompt-end)
908 (setq ivy--index idx))))
911 "When completing file names, move to directory DIR."
912 (if (null ivy--directory)
914 (setq ivy--old-cands nil)
915 (setq ivy--old-re nil)
917 (setq ivy--all-candidates
918 (ivy--sorted-files (setq ivy--directory dir)))
920 (delete-minibuffer-contents)))
922 (defun ivy-backward-delete-char ()
923 "Forward to `backward-delete-char'.
924 On error (read-only), call `ivy-on-del-error-function'."
926 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
928 (ivy--cd (file-name-directory
934 (backward-delete-char 1)
936 (when ivy-on-del-error-function
937 (funcall ivy-on-del-error-function))))))
939 (defun ivy-delete-char (arg)
940 "Forward to `delete-char' ARG."
942 (unless (= (point) (line-end-position))
945 (defun ivy-forward-char (arg)
946 "Forward to `forward-char' ARG."
948 (unless (= (point) (line-end-position))
951 (defun ivy-kill-word (arg)
952 "Forward to `kill-word' ARG."
954 (unless (= (point) (line-end-position))
957 (defun ivy-kill-line ()
958 "Forward to `kill-line'."
961 (kill-region (minibuffer-prompt-end) (point))
964 (defun ivy-backward-kill-word ()
965 "Forward to `backward-kill-word'."
967 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
969 (ivy--cd (file-name-directory
977 (delete-region (point) pt)))))
979 (defvar ivy--regexp-quote 'regexp-quote
980 "Store the regexp quoting state.")
982 (defun ivy-toggle-regexp-quote ()
983 "Toggle the regexp quoting."
985 (setq ivy--old-re nil)
986 (cl-rotatef ivy--regex-function ivy--regexp-quote))
988 (defvar avy-all-windows)
991 (defvar avy-keys-alist)
993 (defvar avy-styles-alist)
994 (declare-function avy--process "ext:avy")
995 (declare-function avy--style-fn "ext:avy")
997 (eval-after-load 'avy
998 '(add-to-list 'avy-styles-alist '(ivy-avy . pre)))
1001 "Jump to one of the current ivy candidates."
1003 (unless (require 'avy nil 'noerror)
1004 (error "Package avy isn't installed"))
1005 (let* ((avy-all-windows nil)
1006 (avy-keys (or (cdr (assq 'ivy-avy avy-keys-alist))
1008 (avy-style (or (cdr (assq 'ivy-avy
1018 (goto-char (point-min))
1020 (while (< (point) (point-max))
1026 (setq avy-action #'identity)
1028 (nreverse candidates)
1029 (avy--style-fn avy-style)))))
1030 (ivy-set-index (- (line-number-at-pos candidate) 2))
1034 (defun ivy-sort-file-function-default (x y)
1035 "Compare two files X and Y.
1036 Prioritize directories."
1037 (if (get-text-property 0 'dirp x)
1038 (if (get-text-property 0 'dirp y)
1041 (if (get-text-property 0 'dirp y)
1045 (defcustom ivy-sort-functions-alist
1046 '((read-file-name-internal . ivy-sort-file-function-default)
1047 (internal-complete-buffer . nil)
1048 (counsel-git-grep-function . nil)
1049 (Man-goto-section . nil)
1052 "An alist of sorting functions for each collection function.
1053 Interactive functions that call completion fit in here as well.
1055 Nil means no sorting, which is useful to turn off the sorting for
1056 functions that have candidates in the natural buffer order, like
1057 `org-refile' or `Man-goto-section'.
1059 The entry associated with t is used for all fall-through cases.
1061 See also `ivy-sort-max-size'."
1065 (const :tag "All other functions" t)
1066 (symbol :tag "Function"))
1068 (const :tag "plain sort" string-lessp)
1069 (const :tag "file sort" ivy-sort-file-function-default)
1070 (const :tag "no sort" nil)))
1073 (defvar ivy-index-functions-alist
1074 '((swiper . ivy-recompute-index-swiper)
1075 (swiper-multi . ivy-recompute-index-swiper)
1076 (counsel-git-grep . ivy-recompute-index-swiper)
1077 (counsel-grep . ivy-recompute-index-swiper-async)
1078 (t . ivy-recompute-index-zero))
1079 "An alist of index recomputing functions for each collection function.
1080 When the input changes, the appropriate function returns an
1081 integer - the index of the matched candidate that should be
1084 (defvar ivy-re-builders-alist
1085 '((t . ivy--regex-plus))
1086 "An alist of regex building functions for each collection function.
1088 Each key is (in order of priority):
1089 1. The actual collection function, e.g. `read-file-name-internal'.
1090 2. The symbol passed by :caller into `ivy-read'.
1094 Each value is a function that should take a string and return a
1095 valid regex or a regex sequence (see below).
1097 Possible choices: `ivy--regex', `regexp-quote',
1098 `ivy--regex-plus', `ivy--regex-fuzzy'.
1100 If a function returns a list, it should format like this:
1101 '((\"matching-regexp\" . t) (\"non-matching-regexp\") ...).
1103 The matches will be filtered in a sequence, you can mix the
1104 regexps that should match and that should not match as you
1107 (defvar ivy-initial-inputs-alist
1108 '((org-refile . "^")
1109 (org-agenda-refile . "^")
1110 (org-capture-refile . "^")
1112 (counsel-describe-function . "^")
1113 (counsel-describe-variable . "^")
1116 "Command to initial input table.")
1118 (defcustom ivy-sort-max-size 30000
1119 "Sorting won't be done for collections larger than this."
1122 (defun ivy--sorted-files (dir)
1123 "Return the list of files in DIR.
1124 Directories come first."
1125 (let* ((default-directory dir)
1126 (seq (all-completions "" 'read-file-name-internal))
1130 (setq seq (delete "./" (delete "../" seq)))
1131 (when (eq (setq sort-fn (cdr (assoc 'read-file-name-internal
1132 ivy-sort-functions-alist)))
1133 #'ivy-sort-file-function-default)
1134 (setq seq (mapcar (lambda (x)
1135 (propertize x 'dirp (string-match-p "/\\'" x)))
1138 (setq seq (cl-sort seq sort-fn)))
1139 (dolist (dir ivy-extra-directories)
1143 (defvar ivy-recursive-restore t
1144 "When non-nil, restore the above state when exiting the minibuffer.
1145 This variable is let-bound to nil by functions that take care of
1146 the restoring themselves.")
1149 (cl-defun ivy-read (prompt collection
1151 predicate require-match initial-input
1152 history preselect keymap update-fn sort
1153 action unwind re-builder matcher dynamic-collection caller)
1154 "Read a string in the minibuffer, with completion.
1156 PROMPT is a format string, normally ending in a colon and a
1157 space; %d anywhere in the string is replaced by the current
1158 number of matching candidates. For the literal % character,
1159 escape it with %%. See also `ivy-count-format'.
1161 COLLECTION is either a list of strings, a function, an alist, or
1164 If INITIAL-INPUT is not nil, then insert that input in the
1165 minibuffer initially.
1167 KEYMAP is composed with `ivy-minibuffer-map'.
1169 If PRESELECT is not nil, then select the corresponding candidate
1170 out of the ones that match the INITIAL-INPUT.
1172 UPDATE-FN is called each time the current candidate(s) is changed.
1174 When SORT is t, use `ivy-sort-functions-alist' for sorting.
1176 ACTION is a lambda function to call after selecting a result. It
1177 takes a single string argument.
1179 UNWIND is a lambda function to call before exiting.
1181 RE-BUILDER is a lambda function to call to transform text into a
1184 MATCHER is to override matching.
1186 DYNAMIC-COLLECTION is a boolean to specify if the list of
1187 candidates is updated after each input by calling COLLECTION.
1189 CALLER is a symbol to uniquely identify the caller to `ivy-read'.
1190 It is used, along with COLLECTION, to determine which
1191 customizations apply to the current completion session."
1192 (let ((extra-actions (delete-dups
1193 (append (plist-get ivy--actions-list t)
1194 (plist-get ivy--actions-list this-command)
1195 (plist-get ivy--actions-list caller)))))
1198 (cond ((functionp action)
1200 ("o" ,action "default")
1204 ("o" identity "default")
1207 (delete-dups (append action extra-actions)))))))
1208 (let ((extra-sources (plist-get ivy--sources-list caller)))
1211 (setq ivy--extra-candidates nil)
1212 (dolist (source extra-sources)
1213 (cond ((equal source '(original-source))
1214 (setq ivy--extra-candidates
1215 (cons source ivy--extra-candidates)))
1216 ((null (cdr source))
1217 (setq ivy--extra-candidates
1219 (list (car source) (funcall (car source)))
1220 ivy--extra-candidates))))))
1221 (setq ivy--extra-candidates '((original-source)))))
1222 (let ((recursive-ivy-last (and (active-minibuffer-window) ivy-last)))
1226 :collection collection
1227 :predicate predicate
1228 :require-match require-match
1229 :initial-input initial-input
1231 :preselect preselect
1233 :update-fn update-fn
1236 :window (selected-window)
1237 :buffer (current-buffer)
1239 :re-builder re-builder
1241 :dynamic-collection dynamic-collection
1243 (ivy--reset-state ivy-last)
1246 (minibuffer-with-setup-hook
1247 #'ivy--minibuffer-setup
1248 (let* ((hist (or history 'ivy-history))
1249 (minibuffer-completion-table collection)
1250 (minibuffer-completion-predicate predicate)
1251 (resize-mini-windows (cond
1252 ((display-graphic-p) nil)
1253 ((null resize-mini-windows) 'grow-only)
1254 (t resize-mini-windows))))
1255 (read-from-minibuffer
1257 (ivy-state-initial-input ivy-last)
1258 (make-composed-keymap keymap ivy-minibuffer-map)
1261 (when (eq ivy-exit 'done)
1262 (let ((item (if ivy--directory
1265 (unless (equal item "")
1266 (set hist (cons (propertize item 'ivy-index ivy--index)
1268 (cdr (symbol-value hist))))))))
1270 (remove-hook 'post-command-hook #'ivy--exhibit)
1271 (when (setq unwind (ivy-state-unwind ivy-last))
1273 (unless (eq ivy-exit 'done)
1274 (when recursive-ivy-last
1275 (ivy--reset-state (setq ivy-last recursive-ivy-last)))))
1277 (when (and recursive-ivy-last
1278 ivy-recursive-restore)
1279 (ivy--reset-state (setq ivy-last recursive-ivy-last))))))
1281 (defun ivy--reset-state (state)
1282 "Reset the ivy to STATE.
1283 This is useful for recursive `ivy-read'."
1284 (let ((prompt (or (ivy-state-prompt state) ""))
1285 (collection (ivy-state-collection state))
1286 (predicate (ivy-state-predicate state))
1287 (history (ivy-state-history state))
1288 (preselect (ivy-state-preselect state))
1289 (sort (ivy-state-sort state))
1290 (re-builder (ivy-state-re-builder state))
1291 (dynamic-collection (ivy-state-dynamic-collection state))
1292 (initial-input (ivy-state-initial-input state))
1293 (require-match (ivy-state-require-match state))
1294 (caller (ivy-state-caller state)))
1295 (unless initial-input
1296 (setq initial-input (cdr (assoc this-command
1297 ivy-initial-inputs-alist))))
1298 (setq ivy--directory nil)
1299 (setq ivy-case-fold-search 'auto)
1300 (setq ivy--regex-function
1302 (and (functionp collection)
1303 (cdr (assoc collection ivy-re-builders-alist)))
1305 (cdr (assoc caller ivy-re-builders-alist)))
1306 (cdr (assoc this-command ivy-re-builders-alist))
1307 (cdr (assoc t ivy-re-builders-alist))
1309 (setq ivy--subexps 0)
1310 (setq ivy--regexp-quote 'regexp-quote)
1311 (setq ivy--old-text "")
1312 (setq ivy--full-length nil)
1314 (setq ivy-calling nil)
1315 (setq ivy-use-ignore t)
1317 (cond ((eq collection 'Info-read-node-name-1)
1318 (if (equal Info-current-file "dir")
1320 (mapcar (lambda (x) (format "(%s)" x))
1321 (cl-delete-duplicates
1322 (all-completions "(" collection predicate)
1324 (setq coll (all-completions "" collection predicate))))
1325 ((eq collection 'read-file-name-internal)
1326 (setq ivy--directory default-directory)
1329 (let ((preselect-directory (file-name-directory preselect)))
1330 (unless (or (null preselect-directory)
1331 (string= preselect-directory
1333 (setq ivy--directory preselect-directory))
1335 (ivy-state-preselect state)
1336 (setq preselect (file-name-nondirectory preselect)))))
1337 (setq coll (ivy--sorted-files ivy--directory))
1339 (unless (or require-match
1340 (equal initial-input default-directory)
1341 (equal initial-input ""))
1342 (setq coll (cons initial-input coll)))
1343 (unless (and (ivy-state-action ivy-last)
1344 (not (equal (ivy--get-action ivy-last) 'identity)))
1345 (setq initial-input nil))))
1346 ((eq collection 'internal-complete-buffer)
1347 (setq coll (ivy--buffer-list "" ivy-use-virtual-buffers)))
1349 (setq coll (funcall collection ivy-text)))
1350 ((or (functionp collection)
1351 (byte-code-function-p collection)
1352 (vectorp collection)
1353 (and (consp collection) (listp (car collection)))
1354 (hash-table-p collection)
1355 (and (listp collection) (symbolp (car collection))))
1356 (setq coll (all-completions "" collection predicate)))
1358 (setq coll collection)))
1360 (if (and (functionp collection)
1361 (setq sort-fn (assoc collection ivy-sort-functions-alist)))
1362 (when (and (setq sort-fn (cdr sort-fn))
1363 (not (eq collection 'read-file-name-internal)))
1364 (setq coll (cl-sort coll sort-fn)))
1365 (unless (eq history 'org-refile-history)
1366 (if (and (setq sort-fn (cdr (assoc t ivy-sort-functions-alist)))
1367 (<= (length coll) ivy-sort-max-size))
1368 (setq coll (cl-sort (copy-sequence coll) sort-fn))))))
1370 (unless (or (and require-match
1371 (not (eq collection 'internal-complete-buffer)))
1373 (let ((re (regexp-quote preselect)))
1374 (cl-find-if (lambda (x) (string-match re x))
1376 (setq coll (cons preselect coll))))
1377 (setq ivy--old-re nil)
1378 (setq ivy--old-cands nil)
1379 (when (integerp preselect)
1380 (setq ivy--old-re "")
1381 (setq ivy--index preselect))
1383 ;; Needed for anchor to work
1384 (setq ivy--old-cands coll)
1385 (setq ivy--old-cands (ivy--filter initial-input coll)))
1386 (setq ivy--all-candidates coll)
1387 (unless (integerp preselect)
1388 (setq ivy--index (or
1389 (and dynamic-collection
1392 (ivy--preselect-index
1400 (if (region-active-p)
1405 (thing-at-point 'url)
1406 (thing-at-point 'symbol)
1409 (cond ((string-match "%.*d" prompt)
1411 ((null ivy-count-format)
1413 "`ivy-count-format' can't be nil. Set it to an empty string instead"))
1414 ((string-match "%d.*%d" ivy-count-format)
1415 (let ((w (length (number-to-string
1416 (length ivy--all-candidates))))
1417 (s (copy-sequence ivy-count-format)))
1418 (string-match "%d" s)
1420 (string-match "%d" s (match-end 0))
1421 (setq s (replace-match (format "%%-%dd" w) nil nil s))
1422 (string-match "%d" s)
1423 (concat (replace-match (format "%%%dd" w) nil nil s)
1425 ((string-match "%.*d" ivy-count-format)
1426 (concat ivy-count-format prompt))
1431 (setf (ivy-state-initial-input ivy-last) initial-input)))
1434 (defun ivy-completing-read (prompt collection
1435 &optional predicate require-match initial-input
1436 history def inherit-input-method)
1437 "Read a string in the minibuffer, with completion.
1439 This interface conforms to `completing-read' and can be used for
1440 `completing-read-function'.
1442 PROMPT is a string that normally ends in a colon and a space.
1443 COLLECTION is either a list of strings, an alist, an obarray, or a hash table.
1444 PREDICATE limits completion to a subset of COLLECTION.
1445 REQUIRE-MATCH is a boolean value. See `completing-read'.
1446 INITIAL-INPUT is a string inserted into the minibuffer initially.
1447 HISTORY is a list of previously selected inputs.
1448 DEF is the default value.
1449 INHERIT-INPUT-METHOD is currently ignored."
1450 (if (memq this-command '(tmm-menubar tmm-shortcut))
1451 (completing-read-default prompt collection
1452 predicate require-match
1453 initial-input history
1454 def inherit-input-method)
1455 ;; See the doc of `completing-read'.
1456 (when (consp history)
1457 (when (numberp (cdr history))
1458 (setq initial-input (nth (1- (cdr history))
1459 (symbol-value (car history)))))
1460 (setq history (car history)))
1461 (ivy-read (replace-regexp-in-string "%" "%%" prompt)
1463 :predicate predicate
1464 :require-match require-match
1465 :initial-input (if (consp initial-input)
1467 (if (and (stringp initial-input)
1468 (string-match "\\+" initial-input))
1469 (replace-regexp-in-string
1470 "\\+" "\\\\+" initial-input)
1472 :preselect (if (listp def) (car def) def)
1476 (let ((sort (assoc this-command ivy-sort-functions-alist)))
1481 (defvar ivy-completion-beg nil
1482 "Completion bounds start.")
1484 (defvar ivy-completion-end nil
1485 "Completion bounds end.")
1487 (defun ivy-completion-in-region-action (str)
1488 "Insert STR, erasing the previous one.
1489 The previous string is between `ivy-completion-beg' and `ivy-completion-end'."
1492 (when ivy-completion-beg
1495 ivy-completion-end))
1496 (setq ivy-completion-beg
1497 (move-marker (make-marker) (point)))
1499 (setq ivy-completion-end
1500 (move-marker (make-marker) (point))))))
1502 (defun ivy-completion-common-length (str)
1503 "Return the length of the first 'completions-common-part face in STR."
1506 (while (and (<= pos len)
1507 (let ((prop (get-text-property pos 'face str)))
1508 (not (eq 'completions-common-part
1509 (if (listp prop) (car prop) prop)))))
1510 (setq pos (1+ pos)))
1512 (or (next-single-property-change pos 'face str) len)
1515 (defun ivy-completion-in-region (start end collection &optional predicate)
1516 "An Ivy function suitable for `completion-in-region-function'."
1517 (let* ((enable-recursive-minibuffers t)
1518 (str (buffer-substring-no-properties start end))
1519 (completion-ignore-case case-fold-search)
1521 (completion-all-completions str collection predicate (- end start))))
1523 (message "No matches")
1525 (setq ivy-completion-beg (- end (ivy-completion-common-length (car comps))))
1526 (setq ivy-completion-end end)
1527 (if (null (cdr comps))
1528 (if (string= str (car comps))
1529 (message "Sole match")
1530 (setf (ivy-state-window ivy-last) (selected-window))
1531 (ivy-completion-in-region-action
1532 (substring-no-properties
1534 (let* ((w (1+ (floor (log (length comps) 10))))
1535 (ivy-count-format (if (string= ivy-count-format "")
1537 (format "%%-%dd " w)))
1538 (prompt (format "(%s): " str)))
1540 (ivy-read (if (string= ivy-count-format "")
1542 (replace-regexp-in-string "%" "%%" prompt))
1543 ;; remove 'completions-first-difference face
1544 (mapcar #'substring-no-properties comps)
1545 :predicate predicate
1546 :action #'ivy-completion-in-region-action
1550 (defcustom ivy-do-completion-in-region t
1551 "When non-nil `ivy-mode' will set `completion-in-region-function'."
1555 (define-minor-mode ivy-mode
1556 "Toggle Ivy mode on or off.
1557 Turn Ivy mode on if ARG is positive, off otherwise.
1558 Turning on Ivy mode sets `completing-read-function' to
1559 `ivy-completing-read'.
1564 Minibuffer bindings:
1565 \\{ivy-minibuffer-map}"
1568 :keymap ivy-mode-map
1572 (setq completing-read-function 'ivy-completing-read)
1573 (when ivy-do-completion-in-region
1574 (setq completion-in-region-function 'ivy-completion-in-region)))
1575 (setq completing-read-function 'completing-read-default)
1576 (setq completion-in-region-function 'completion--in-region)))
1578 (defun ivy--preselect-index (preselect candidates)
1579 "Return the index of PRESELECT in CANDIDATES."
1580 (cond ((integerp preselect)
1582 ((cl-position preselect candidates :test #'equal))
1583 ((stringp preselect)
1584 (let ((re (regexp-quote preselect)))
1587 (string-match re x))
1592 (defvar ivy--regex-hash
1593 (make-hash-table :test #'equal)
1594 "Store pre-computed regex.")
1596 (defun ivy--split (str)
1597 "Split STR into a list by single spaces.
1598 The remaining spaces stick to their left.
1599 This allows to \"quote\" N spaces by inputting N+1 spaces."
1600 (let ((len (length str))
1605 (while (and (string-match " +" str start1)
1607 (setq match-len (- (match-end 0) (match-beginning 0)))
1611 (setq start1 start0)
1613 (push (substring str start1 (match-beginning 0)) res)
1614 (setq start1 (match-end 0)))
1615 (setq str (replace-match
1616 (make-string (1- match-len) ?\ )
1618 (setq start0 (or start0 start1))
1619 (setq start1 (1- (match-end 0)))))
1621 (push (substring str start0) res)
1622 (setq s (substring str start1))
1623 (unless (= (length s) 0)
1627 (defun ivy--regex (str &optional greedy)
1628 "Re-build regex pattern from STR in case it has a space.
1629 When GREEDY is non-nil, join words in a greedy way."
1630 (let ((hashed (unless greedy
1631 (gethash str ivy--regex-hash))))
1634 (setq ivy--subexps (car hashed)))
1635 (when (string-match "\\([^\\]\\|^\\)\\\\$" str)
1636 (setq str (substring str 0 -1)))
1638 (let ((subs (ivy--split str)))
1639 (if (= (length subs) 1)
1641 (setq ivy--subexps 0)
1644 (setq ivy--subexps (length subs))
1647 (if (string-match "\\`\\\\(.*\\\\)\\'" x)
1649 (format "\\(%s\\)" x)))
1654 ivy--regex-hash)))))
1656 (defun ivy--regex-ignore-order--part (str &optional discard)
1657 "Re-build regex from STR by splitting at spaces.
1658 Ignore the order of each group."
1659 (let* ((subs (split-string str " +" t))
1660 (len (length subs)))
1665 (mapcar (lambda (x) (cons x (not discard)))
1668 (defun ivy--regex-ignore-order (str)
1669 "Re-build regex from STR by splitting at spaces.
1670 Ignore the order of each group. Everything before \"!\" should
1671 match. Everything after \"!\" should not match."
1672 (let ((parts (split-string str "!" t)))
1673 (cl-case (length parts)
1677 (if (string= (substring str 0 1) "!")
1679 (ivy--regex-ignore-order--part (car parts) t))
1680 (ivy--regex-ignore-order--part (car parts))))
1683 (ivy--regex-ignore-order--part (car parts))
1684 (ivy--regex-ignore-order--part (cadr parts) t)))
1685 (t (error "Unexpected: use only one !")))))
1687 (defun ivy--regex-plus (str)
1688 "Build a regex sequence from STR.
1689 Spaces are wild card characters, everything before \"!\" should
1690 match. Everything after \"!\" should not match."
1691 (let ((parts (split-string str "!" t)))
1692 (cl-case (length parts)
1696 (if (string= (substring str 0 1) "!")
1698 (list (ivy--regex (car parts))))
1699 (ivy--regex (car parts))))
1702 (cons (ivy--regex (car parts)) t)
1703 (mapcar #'list (split-string (cadr parts) " " t))))
1704 (t (error "Unexpected: use only one !")))))
1706 (defun ivy--regex-fuzzy (str)
1707 "Build a regex sequence from STR.
1708 Insert .* between each char."
1709 (if (string-match "\\`\\(\\^?\\)\\(.*?\\)\\(\\$?\\)\\'" str)
1711 (concat (match-string 1 str)
1714 (format "\\(%c\\)" x))
1715 (string-to-list (match-string 2 str)) ".*")
1716 (match-string 3 str))
1717 (setq ivy--subexps (length (match-string 2 str))))
1721 (defun ivy--minibuffer-setup ()
1722 "Setup ivy completion in the minibuffer."
1723 (set (make-local-variable 'completion-show-inline-help) nil)
1724 (set (make-local-variable 'minibuffer-default-add-function)
1726 (list ivy--default)))
1727 (when (display-graphic-p)
1728 (setq truncate-lines t))
1729 (setq-local max-mini-window-height ivy-height)
1730 (add-hook 'post-command-hook #'ivy--exhibit nil t)
1731 ;; show completions with empty input
1734 (defun ivy--input ()
1735 "Return the current minibuffer input."
1736 ;; assume one-line minibuffer input
1737 (buffer-substring-no-properties
1738 (minibuffer-prompt-end)
1739 (line-end-position)))
1741 (defun ivy--cleanup ()
1742 "Delete the displayed completion candidates."
1744 (goto-char (minibuffer-prompt-end))
1745 (delete-region (line-end-position) (point-max))))
1747 (defun ivy--insert-prompt ()
1748 "Update the prompt according to `ivy--prompt'."
1750 (unless (memq this-command '(ivy-done ivy-alt-done ivy-partial-or-done
1751 counsel-find-symbol))
1752 (setq ivy--prompt-extra ""))
1754 (if (string-match "\\(.*\\): \\'" ivy--prompt)
1756 (setq head (match-string 1 ivy--prompt))
1758 (setq head (substring ivy--prompt 0 -1))
1760 (let ((inhibit-read-only t)
1761 (std-props '(front-sticky t rear-nonsticky t field t read-only t))
1764 (if (and (bound-and-true-p minibuffer-depth-indicate-mode)
1765 (> (minibuffer-depth) 1))
1766 (format "[%d] " (minibuffer-depth))
1769 (if (string-match "%d.*%d" ivy-count-format)
1772 (or (and (ivy-state-dynamic-collection ivy-last)
1776 (or (and (ivy-state-dynamic-collection ivy-last)
1781 (d-str (if ivy--directory
1782 (abbreviate-file-name ivy--directory)
1785 (goto-char (point-min))
1786 (delete-region (point-min) (minibuffer-prompt-end))
1787 (if (> (+ (mod (+ (length n-str) (length d-str)) (window-width))
1790 (setq n-str (concat n-str "\n" d-str))
1791 (setq n-str (concat n-str d-str)))
1792 (let ((regex (format "\\([^\n]\\{%d\\}\\)[^\n]" (window-width))))
1793 (while (string-match regex n-str)
1794 (setq n-str (replace-match (concat (match-string 1 n-str) "\n") nil t n-str 1))))
1795 (set-text-properties 0 (length n-str)
1796 `(face minibuffer-prompt ,@std-props)
1798 (ivy--set-match-props n-str "confirm"
1799 `(face ivy-confirm-face ,@std-props))
1800 (ivy--set-match-props n-str "match required"
1801 `(face ivy-match-required-face ,@std-props))
1803 ;; get out of the prompt area
1804 (constrain-to-field nil (point-max))))))
1806 (defun ivy--set-match-props (str match props)
1807 "Set STR text properties that match MATCH to PROPS."
1808 (when (string-match match str)
1809 (set-text-properties
1815 (defvar inhibit-message)
1817 (defun ivy--sort-maybe (collection)
1818 "Sort COLLECTION if needed."
1819 (let ((sort (ivy-state-sort ivy-last))
1823 (let ((sort-fn (cond ((functionp sort)
1825 ((setq entry (assoc (ivy-state-collection ivy-last)
1826 ivy-sort-functions-alist))
1829 (cdr (assoc t ivy-sort-functions-alist))))))
1830 (if (functionp sort-fn)
1831 (cl-sort (copy-sequence collection) sort-fn)
1834 (defun ivy--exhibit ()
1835 "Insert Ivy completions display.
1836 Should be run via minibuffer `post-command-hook'."
1837 (when (memq 'ivy--exhibit post-command-hook)
1838 (let ((inhibit-field-text-motion nil))
1839 (constrain-to-field nil (point-max)))
1840 (setq ivy-text (ivy--input))
1841 (if (ivy-state-dynamic-collection ivy-last)
1842 ;; while-no-input would cause annoying
1843 ;; "Waiting for process to die...done" message interruptions
1844 (let ((inhibit-message t))
1845 (unless (equal ivy--old-text ivy-text)
1847 (setq ivy--all-candidates
1849 (funcall (ivy-state-collection ivy-last) ivy-text)))
1850 (setq ivy--old-text ivy-text)))
1851 (when ivy--all-candidates
1852 (ivy--insert-minibuffer
1853 (ivy--format ivy--all-candidates))))
1854 (cond (ivy--directory
1855 (if (string-match "/\\'" ivy-text)
1856 (if (member ivy-text ivy--all-candidates)
1857 (ivy--cd (expand-file-name ivy-text ivy--directory))
1858 (when (string-match "//\\'" ivy-text)
1859 (if (and default-directory
1860 (string-match "\\`[[:alpha:]]:/" default-directory))
1861 (ivy--cd (match-string 0 default-directory))
1863 (when (string-match "[[:alpha:]]:/$" ivy-text)
1864 (let ((drive-root (match-string 0 ivy-text)))
1865 (when (file-exists-p drive-root)
1866 (ivy--cd drive-root)))))
1867 (if (string-match "\\`~\\'" ivy-text)
1868 (ivy--cd (expand-file-name "~/")))))
1869 ((eq (ivy-state-collection ivy-last) 'internal-complete-buffer)
1870 (when (or (and (string-match "\\` " ivy-text)
1871 (not (string-match "\\` " ivy--old-text)))
1872 (and (string-match "\\` " ivy--old-text)
1873 (not (string-match "\\` " ivy-text))))
1874 (setq ivy--all-candidates
1875 (if (and (> (length ivy-text) 0)
1876 (eq (aref ivy-text 0)
1878 (ivy--buffer-list " ")
1879 (ivy--buffer-list "" ivy-use-virtual-buffers)))
1880 (setq ivy--old-re nil))))
1881 (ivy--insert-minibuffer
1882 (with-current-buffer (ivy-state-buffer ivy-last)
1884 (ivy--filter ivy-text ivy--all-candidates))))
1885 (setq ivy--old-text ivy-text))))
1887 (defun ivy--insert-minibuffer (text)
1888 "Insert TEXT into minibuffer with appropriate cleanup."
1889 (let ((resize-mini-windows nil)
1890 (update-fn (ivy-state-update-fn ivy-last))
1894 (funcall update-fn))
1895 (ivy--insert-prompt)
1896 ;; Do nothing if while-no-input was aborted.
1897 (when (stringp text)
1898 (let ((buffer-undo-list t))
1902 (when (display-graphic-p)
1903 (ivy--resize-minibuffer-to-fit))))
1905 (defun ivy--resize-minibuffer-to-fit ()
1906 "Resize the minibuffer window size to fit the text in the minibuffer."
1907 (unless (frame-root-window-p (minibuffer-window))
1908 (with-selected-window (minibuffer-window)
1909 (if (fboundp 'window-text-pixel-size)
1910 (let ((text-height (cdr (window-text-pixel-size)))
1911 (body-height (window-body-height nil t)))
1912 (when (> text-height body-height)
1913 ;; Note: the size increment needs to be at least frame-char-height,
1914 ;; otherwise resizing won't do anything.
1915 (let ((delta (max (- text-height body-height) (frame-char-height))))
1916 (window-resize nil delta nil t t))))
1917 (let ((text-height (count-screen-lines))
1918 (body-height (window-body-height)))
1919 (when (> text-height body-height)
1920 (window-resize nil (- text-height body-height) nil t)))))))
1922 (declare-function colir-blend-face-background "ext:colir")
1924 (defun ivy--add-face (str face)
1925 "Propertize STR with FACE.
1926 `font-lock-append-text-property' is used, since it's better than
1927 `propertize' or `add-face-text-property' in this case."
1931 (colir-blend-face-background 0 (length str) face str)
1932 (let ((foreground (face-foreground face)))
1934 (add-face-text-property
1936 `(:foreground ,foreground)
1941 (font-lock-append-text-property 0 (length str) 'face face str))))
1944 (declare-function flx-make-string-cache "ext:flx")
1945 (declare-function flx-score "ext:flx")
1947 (defvar ivy--flx-cache nil)
1949 (eval-after-load 'flx
1950 '(setq ivy--flx-cache (flx-make-string-cache)))
1952 (defun ivy-toggle-case-fold ()
1953 "Toggle the case folding between nil and auto.
1954 In any completion session, the case folding starts in auto:
1956 - when the input is all lower case, `case-fold-search' is t
1959 You can toggle this to make `case-fold-search' nil regardless of input."
1961 (setq ivy-case-fold-search
1962 (if ivy-case-fold-search
1965 ;; reset cache so that the candidate list updates
1966 (setq ivy--old-re nil))
1968 (defun ivy--re-filter (re candidates)
1969 "Return all RE matching CANDIDATES.
1970 RE is a list of cons cells, with a regexp car and a boolean cdr.
1971 When the cdr is t, the car must match.
1972 Otherwise, the car must not match."
1973 (let ((re-list (if (stringp re) (list (cons re t)) re))
1975 (dolist (re re-list)
1982 (let ((re-str (car re)))
1983 (lambda (x) (string-match re-str x)))
1987 (defun ivy--filter (name candidates)
1988 "Return all items that match NAME in CANDIDATES.
1989 CANDIDATES are assumed to be static."
1990 (let ((re (funcall ivy--regex-function name)))
1991 (if (and (equal re ivy--old-re)
1993 ;; quick caching for "C-n", "C-p" etc.
1995 (let* ((re-str (if (listp re) (caar re) re))
1996 (matcher (ivy-state-matcher ivy-last))
1998 (and ivy-case-fold-search
1999 (string= name (downcase name))))
2002 (funcall matcher re candidates))
2005 (stringp ivy--old-re)
2006 (not (string-match "\\\\" ivy--old-re))
2007 (not (equal ivy--old-re ""))
2009 (if (string-match "\\\\)\\'" ivy--old-re)
2010 (substring ivy--old-re 0 -2)
2016 (lambda (x) (string-match re x))
2019 (ivy--re-filter re candidates)))))
2020 (ivy--recompute-index name re-str cands)
2022 (if (eq ivy--regex-function 'ivy--regex-ignore-order)
2027 (setq ivy--old-cands (ivy--sort name cands))))))
2029 (defun ivy--set-candidates (x)
2030 "Update `ivy--all-candidates' with X."
2032 (dolist (source ivy--extra-candidates)
2033 (if (equal source '(original-source))
2036 (setq res (append x res)))
2037 (setq ivy--old-re nil)
2039 (ivy--filter ivy-text (cadr source))
2041 (setq ivy--all-candidates res)))
2043 (defcustom ivy-sort-matches-functions-alist '((t . nil))
2044 "An alist of functions for sorting matching candidates.
2046 Unlike `ivy-sort-functions-alist', which is used to sort the
2047 whole collection only once, this alist of functions are used to
2048 sort only matching candidates after each change in input.
2050 The alist KEY is either a collection function or t to match
2051 previously unmatched collection functions.
2053 The alist VAL is a sorting function with the signature of
2054 `ivy--prefix-sort'.")
2056 (defun ivy--sort-files-by-date (_name candidates)
2057 "Re-soft CANDIDATES according to file modification date."
2058 (let ((default-directory ivy--directory))
2059 (cl-sort (copy-sequence candidates)
2062 (nth 5 (file-attributes f2))
2063 (nth 5 (file-attributes f1)))))))
2065 (defun ivy--sort (name candidates)
2066 "Re-sort CANDIDATES by NAME.
2067 All CANDIDATES are assumed to match NAME."
2068 (let ((key (or (ivy-state-caller ivy-last)
2069 (when (functionp (ivy-state-collection ivy-last))
2070 (ivy-state-collection ivy-last))))
2072 (cond ((and (require 'flx nil 'noerror)
2073 (eq ivy--regex-function 'ivy--regex-fuzzy))
2074 (ivy--flx-sort name candidates))
2075 ((setq fun (cdr (or (assoc key ivy-sort-matches-functions-alist)
2076 (assoc t ivy-sort-matches-functions-alist))))
2077 (funcall fun name candidates))
2081 (defun ivy--prefix-sort (name candidates)
2082 "Re-sort CANDIDATES.
2083 Prefix matches to NAME are put ahead of the list."
2084 (if (or (string-match "^\\^" name) (string= name ""))
2086 (let ((re-prefix (concat "^" (funcall ivy--regex-function name)))
2089 (dolist (s candidates)
2090 (if (string-match re-prefix s)
2092 (push s res-noprefix)))
2094 (nreverse res-prefix)
2095 (nreverse res-noprefix)))))
2097 (defun ivy--recompute-index (name re-str cands)
2098 (let* ((caller (ivy-state-caller ivy-last))
2099 (func (or (and caller (cdr (assoc caller ivy-index-functions-alist)))
2100 (cdr (assoc t ivy-index-functions-alist))
2101 #'ivy-recompute-index-zero)))
2102 (unless (eq this-command 'ivy-resume)
2105 (cl-position (if (and (> (length name) 0)
2106 (eq ?^ (aref name 0)))
2112 (concat re-str "/") cands
2114 (and (not (string= name ""))
2115 (not (and (require 'flx nil 'noerror)
2116 (eq ivy--regex-function 'ivy--regex-fuzzy)
2117 (< (length cands) 200)))
2119 (cl-position (nth ivy--index ivy--old-cands)
2121 (funcall func re-str cands))))
2122 (when (and (or (string= name "")
2124 (not (equal ivy--old-re "")))
2126 (or (ivy--preselect-index
2127 (ivy-state-preselect ivy-last)
2131 (defun ivy-recompute-index-swiper (_re-str cands)
2132 (let ((tail (nthcdr ivy--index ivy--old-cands))
2134 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
2136 (while (and tail (null idx))
2137 ;; Compare with eq to handle equal duplicates in cands
2138 (setq idx (cl-position (pop tail) cands)))
2141 (1- (length cands))))
2144 ;; already in ivy-state-buffer
2145 (let ((n (line-number-at-pos))
2149 (when (eq n (read (get-text-property 0 'display c)))
2154 (defun ivy-recompute-index-swiper-async (_re-str cands)
2155 (let ((tail (nthcdr ivy--index ivy--old-cands))
2157 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
2159 (while (and tail (null idx))
2160 ;; Compare with `equal', since the collection is re-created
2161 ;; each time with `split-string'
2162 (setq idx (cl-position (pop tail) cands :test #'equal)))
2166 (defun ivy-recompute-index-zero (_re-str _cands)
2169 (defcustom ivy-minibuffer-faces
2170 '(ivy-minibuffer-match-face-1
2171 ivy-minibuffer-match-face-2
2172 ivy-minibuffer-match-face-3
2173 ivy-minibuffer-match-face-4)
2174 "List of `ivy' faces for minibuffer group matches.")
2176 (defvar ivy-flx-limit 200
2177 "Used to conditionally turn off flx sorting.
2179 When the amount of matching candidates exceeds this limit, then
2180 no sorting is done.")
2182 (defun ivy--flx-sort (name cands)
2183 "Sort according to closeness to string NAME the string list CANDS."
2186 (< (length cands) ivy-flx-limit))
2187 (let* ((flx-name (if (string-match "^\\^" name)
2194 (let ((score (flx-score x flx-name ivy--flx-cache)))
2198 (if cands-with-score
2200 (let ((str (copy-sequence (cdr x)))
2203 (dolist (j (cdar x))
2204 (unless (eq j (1+ last-j))
2207 (ivy-add-face-text-property
2209 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2210 ivy-minibuffer-faces)
2213 (sort cands-with-score
2215 (> (caar x) (caar y)))))
2221 (defcustom ivy-format-function 'ivy-format-function-default
2222 "Function to transform the list of candidates into a string.
2223 This string is inserted into the minibuffer."
2225 (const :tag "Default" ivy-format-function-default)
2226 (const :tag "Arrow prefix" ivy-format-function-arrow)
2227 (const :tag "Full line" ivy-format-function-line)))
2229 (defun ivy--truncate-string (str width)
2230 "Truncate STR to WIDTH."
2231 (if (> (string-width str) width)
2232 (concat (substring str 0 (min (- width 3)
2233 (- (length str) 3))) "...")
2236 (defun ivy--format-function-generic (selected-fn other-fn cand-pairs separator)
2237 "Transform CAND-PAIRS into a string for minibuffer.
2238 SELECTED-FN and OTHER-FN each take two string arguments.
2239 SEPARATOR is used to join the candidates."
2243 (let ((str (car pair))
2245 (curr (eq (cl-incf i) ivy--index)))
2247 (funcall selected-fn str extra)
2248 (funcall other-fn str extra))))
2252 (defun ivy-format-function-default (cand-pairs)
2253 "Transform CAND-PAIRS into a string for minibuffer."
2254 (ivy--format-function-generic
2256 (concat (ivy--add-face str 'ivy-current-match) extra))
2261 (defun ivy-format-function-arrow (cand-pairs)
2262 "Transform CAND-PAIRS into a string for minibuffer."
2263 (ivy--format-function-generic
2265 (concat "> " (ivy--add-face str 'ivy-current-match) extra))
2267 (concat " " str extra))
2271 (defun ivy-format-function-line (cand-pairs)
2272 "Transform CAND-PAIRS into a string for minibuffer."
2273 (ivy--format-function-generic
2275 (ivy--add-face (concat str extra "\n") 'ivy-current-match))
2277 (concat str extra "\n"))
2281 (defun ivy-add-face-text-property (start end face str)
2282 (if (fboundp 'add-face-text-property)
2283 (add-face-text-property
2284 start end face nil str)
2285 (font-lock-append-text-property
2286 start end 'face face str)))
2288 (defun ivy--format-minibuffer-line (str)
2290 (str (copy-sequence str)))
2291 (cond ((eq ivy--regex-function 'ivy--regex-ignore-order)
2292 (when (consp ivy--old-re)
2294 (dolist (re ivy--old-re)
2295 (when (string-match (car re) str)
2296 (ivy-add-face-text-property
2297 (match-beginning 0) (match-end 0)
2298 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2299 ivy-minibuffer-faces)
2302 ((and (eq ivy-display-style 'fancy)
2303 (not (eq ivy--regex-function 'ivy--regex-fuzzy)))
2305 (setq ivy--old-re (funcall ivy--regex-function ivy-text)))
2306 (while (and (string-match ivy--old-re str start)
2307 (> (- (match-end 0) (match-beginning 0)) 0))
2308 (setq start (match-end 0))
2310 (while (<= i ivy--subexps)
2312 (cond ((zerop ivy--subexps)
2313 (cadr ivy-minibuffer-faces))
2315 (car ivy-minibuffer-faces))
2317 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2318 ivy-minibuffer-faces)))))
2319 (ivy-add-face-text-property
2320 (match-beginning i) (match-end i)
2325 (defun ivy--format (cands)
2326 "Return a string for CANDS suitable for display in the minibuffer.
2327 CANDS is a list of strings."
2328 (setq ivy--length (length cands))
2329 (when (>= ivy--index ivy--length)
2330 (setq ivy--index (max (1- ivy--length) 0)))
2332 (setq ivy--current "")
2333 (let* ((half-height (/ ivy-height 2))
2334 (start (max 0 (- ivy--index half-height)))
2335 (end (min (+ start (1- ivy-height)) ivy--length))
2336 (start (max 0 (min start (- end (1- ivy-height)))))
2337 (cands (cl-subseq cands start end))
2338 (index (- ivy--index start)))
2339 (cond (ivy--directory
2340 (setq cands (mapcar (lambda (x)
2341 (if (string-match-p "/\\'" x)
2342 (propertize x 'face 'ivy-subdir)
2345 ((eq (ivy-state-collection ivy-last) 'internal-complete-buffer)
2346 (setq cands (mapcar (lambda (x)
2347 (let ((b (get-buffer x)))
2349 (buffer-file-name b)
2350 (buffer-modified-p b))
2351 (propertize x 'face 'ivy-modified-buffer)
2354 (setq ivy--current (copy-sequence (nth index cands)))
2355 (let* ((ivy--index index)
2358 (cons (ivy--format-minibuffer-line cand) nil)) cands))
2359 (res (concat "\n" (funcall ivy-format-function cand-pairs))))
2360 (put-text-property 0 (length res) 'read-only nil res)
2363 (defvar ivy--virtual-buffers nil
2364 "Store the virtual buffers alist.")
2366 (defvar recentf-list)
2368 (defcustom ivy-virtual-abbreviate 'name
2369 "The mode of abbreviation for virtual buffer names."
2371 (const :tag "Only name" name)
2372 (const :tag "Full path" full)
2373 ;; eventually, uniquify
2376 (defun ivy--virtual-buffers ()
2377 "Adapted from `ido-add-virtual-buffers-to-list'."
2378 (unless recentf-mode
2380 (let ((bookmarks (and (boundp 'bookmark-alist)
2382 virtual-buffers name)
2383 (dolist (head (append
2385 (delete " - no file -"
2386 (delq nil (mapcar (lambda (bookmark)
2387 (cdr (assoc 'filename bookmark)))
2390 (if (eq ivy-virtual-abbreviate 'name)
2391 (file-name-nondirectory head)
2392 (expand-file-name head)))
2393 (when (equal name "")
2394 (setq name (file-name-nondirectory (directory-file-name head))))
2395 (when (equal name "")
2397 (and (not (equal name ""))
2398 (null (get-file-buffer head))
2399 (not (assoc name virtual-buffers))
2400 (push (cons name head) virtual-buffers)))
2401 (when virtual-buffers
2402 (dolist (comp virtual-buffers)
2403 (put-text-property 0 (length (car comp))
2406 (setq ivy--virtual-buffers (nreverse virtual-buffers))
2407 (mapcar #'car ivy--virtual-buffers))))
2409 (defcustom ivy-ignore-buffers nil
2410 "List of regexps matching buffer names to ignore."
2411 :type '(repeat regexp))
2413 (defun ivy--buffer-list (str &optional virtual)
2414 "Return the buffers that match STR.
2415 When VIRTUAL is non-nil, add virtual buffers."
2420 (if (with-current-buffer x
2422 (abbreviate-file-name default-directory)))
2423 (propertize x 'face 'ivy-remote)
2425 (all-completions str 'internal-complete-buffer))
2427 (ivy--virtual-buffers)))))
2429 (defun ivy--switch-buffer-action (buffer)
2431 BUFFER may be a string or nil."
2433 (if (zerop (length buffer))
2435 ivy-text nil 'force-same-window)
2436 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2438 (not (get-buffer buffer)))
2439 (find-file (cdr virtual))
2441 buffer nil 'force-same-window))))))
2443 (defun ivy--switch-buffer-other-window-action (buffer)
2444 "Switch to BUFFER in other window.
2445 BUFFER may be a string or nil."
2446 (if (zerop (length buffer))
2447 (switch-to-buffer-other-window ivy-text)
2448 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2450 (not (get-buffer buffer)))
2451 (find-file-other-window (cdr virtual))
2452 (switch-to-buffer-other-window buffer)))))
2454 (defun ivy--rename-buffer-action (buffer)
2456 (let ((new-name (read-string "Rename buffer (to new name): ")))
2457 (with-current-buffer buffer
2458 (rename-buffer new-name))))
2460 (defvar ivy-switch-buffer-map (make-sparse-keymap))
2467 (ivy--reset-state ivy-last))
2470 ivy--switch-buffer-other-window-action
2473 ivy--rename-buffer-action
2476 (defun ivy--switch-buffer-matcher (regexp candidates)
2477 "Return REGEXP-matching CANDIDATES.
2478 Skip buffers that match `ivy-ignore-buffers'."
2479 (let ((res (ivy--re-filter regexp candidates)))
2480 (if (or (null ivy-use-ignore)
2481 (null ivy-ignore-buffers))
2487 (string-match regexp buf))
2488 ivy-ignore-buffers))
2493 (defun ivy-switch-buffer ()
2494 "Switch to another buffer."
2497 (call-interactively 'switch-to-buffer)
2498 (let ((this-command 'ivy-switch-buffer))
2499 (ivy-read "Switch to buffer: " 'internal-complete-buffer
2500 :matcher #'ivy--switch-buffer-matcher
2501 :preselect (buffer-name (other-buffer (current-buffer)))
2502 :action #'ivy--switch-buffer-action
2503 :keymap ivy-switch-buffer-map
2504 :caller 'ivy-switch-buffer))))
2507 (defun ivy-switch-buffer-other-window ()
2508 "Switch to another buffer in another window."
2510 (ivy-read "Switch to buffer in other window: " 'internal-complete-buffer
2511 :preselect (buffer-name (other-buffer (current-buffer)))
2512 :action #'ivy--switch-buffer-other-window-action
2513 :keymap ivy-switch-buffer-map
2514 :caller 'ivy-switch-buffer-other-window))
2517 (defun ivy-recentf ()
2518 "Find a file on `recentf-list'."
2520 (ivy-read "Recentf: " recentf-list
2525 :caller 'ivy-recentf))
2527 (defun ivy-yank-word ()
2528 "Pull next word from buffer into search string."
2533 (le (line-end-position)))
2537 (setq amend (buffer-substring-no-properties pt (point))))))
2539 (insert (replace-regexp-in-string " +" " " amend)))))
2541 (defun ivy-kill-ring-save ()
2542 "Store the current candidates into the kill ring.
2543 If the region is active, forward to `kill-ring-save' instead."
2545 (if (region-active-p)
2546 (call-interactively 'kill-ring-save)
2553 (defun ivy-insert-current ()
2554 "Make the current candidate into current input.
2555 Don't finish completion."
2557 (delete-minibuffer-contents)
2558 (if (and ivy--directory
2559 (string-match "/$" ivy--current))
2560 (insert (substring ivy--current 0 -1))
2561 (insert ivy--current)))
2563 (defun ivy-toggle-fuzzy ()
2564 "Toggle the re builder between `ivy--regex-fuzzy' and `ivy--regex-plus'."
2566 (setq ivy--old-re nil)
2567 (if (eq ivy--regex-function 'ivy--regex-fuzzy)
2568 (setq ivy--regex-function 'ivy--regex-plus)
2569 (setq ivy--regex-function 'ivy--regex-fuzzy)))
2571 (defun ivy-reverse-i-search ()
2572 "Enter a recursive `ivy-read' session using the current history.
2573 The selected history element will be inserted into the minibuffer."
2575 (let ((enable-recursive-minibuffers t)
2576 (history (symbol-value (ivy-state-history ivy-last)))
2578 (ivy-recursive-restore nil))
2579 (ivy-read "Reverse-i-search: "
2583 (setq ivy-last old-last))
2584 (delete-minibuffer-contents)
2585 (insert (substring-no-properties x))
2588 (defun ivy-restrict-to-matches ()
2589 "Restrict candidates to current matches and erase input."
2591 (delete-minibuffer-contents)
2592 (setq ivy--all-candidates
2593 (ivy--filter ivy-text ivy--all-candidates)))
2596 (defvar-local ivy-occur-last nil
2597 "Buffer-local value of `ivy-last'.
2598 Can't re-use `ivy-last' because using e.g. `swiper' in the same
2599 buffer would modify `ivy-last'.")
2601 (defvar ivy-occur-mode-map
2602 (let ((map (make-sparse-keymap)))
2603 (define-key map [mouse-1] 'ivy-occur-click)
2604 (define-key map (kbd "RET") 'ivy-occur-press)
2605 (define-key map (kbd "j") 'next-line)
2606 (define-key map (kbd "k") 'previous-line)
2607 (define-key map (kbd "h") 'backward-char)
2608 (define-key map (kbd "l") 'forward-char)
2609 (define-key map (kbd "g") 'ivy-occur-press)
2610 (define-key map (kbd "a") 'ivy-occur-read-action)
2611 (define-key map (kbd "o") 'ivy-occur-dispatch)
2612 (define-key map (kbd "q") 'quit-window)
2614 "Keymap for Ivy Occur mode.")
2616 (define-derived-mode ivy-occur-mode fundamental-mode "Ivy-Occur"
2617 "Major mode for output from \\[ivy-occur].
2619 \\{ivy-occur-mode-map}")
2621 (defvar ivy-occur-grep-mode-map
2622 (let ((map (copy-keymap ivy-occur-mode-map)))
2623 (define-key map (kbd "C-x C-q") 'ivy-wgrep-change-to-wgrep-mode)
2625 "Keymap for Ivy Occur Grep mode.")
2627 (define-derived-mode ivy-occur-grep-mode grep-mode "Ivy-Occur"
2628 "Major mode for output from \\[ivy-occur].
2630 \\{ivy-occur-grep-mode-map}")
2632 (defvar ivy--occurs-list nil
2633 "A list of custom occur generators per command.")
2635 (defun ivy-set-occur (cmd occur)
2636 "Assign CMD a custom OCCUR function."
2637 (setq ivy--occurs-list
2638 (plist-put ivy--occurs-list cmd occur)))
2640 (defun ivy--occur-insert-lines (cands)
2642 (add-text-properties
2646 help-echo "mouse-1: call ivy-action")
2651 "Stop completion and put the current matches into a new buffer.
2653 The new buffer remembers current action(s).
2655 While in the *ivy-occur* buffer, selecting a candidate with RET or
2656 a mouse click will call the appropriate action for that candidate.
2658 There is no limit on the number of *ivy-occur* buffers."
2660 (if (not (window-minibuffer-p))
2661 (user-error "No completion session is active")
2662 (let* ((caller (ivy-state-caller ivy-last))
2663 (occur-fn (plist-get ivy--occurs-list caller))
2665 (generate-new-buffer
2666 (format "*ivy-occur%s \"%s\"*"
2668 (concat " " (prin1-to-string caller))
2671 (with-current-buffer buffer
2672 (let ((inhibit-read-only t))
2677 (insert (format "%d candidates:\n" (length ivy--old-cands)))
2678 (ivy--occur-insert-lines
2680 (lambda (cand) (concat " " cand))
2682 (setf (ivy-state-text ivy-last) ivy-text)
2683 (setq ivy-occur-last ivy-last)
2684 (setq-local ivy--directory ivy--directory))
2685 (ivy-exit-with-action
2686 `(lambda (_) (pop-to-buffer ,buffer))))))
2688 (declare-function wgrep-change-to-wgrep-mode "ext:wgrep")
2690 (defun ivy-wgrep-change-to-wgrep-mode ()
2691 "Forward to `wgrep-change-to-wgrep-mode'."
2693 (if (require 'wgrep nil 'noerror)
2694 (wgrep-change-to-wgrep-mode)
2695 (error "Package wgrep isn't installed")))
2697 (defun ivy-occur-read-action ()
2698 "Select one of the available actions as the current one."
2700 (let ((ivy-last ivy-occur-last))
2703 (defun ivy-occur-dispatch ()
2704 "Call one of the available actions on the current item."
2706 (let* ((state-action (ivy-state-action ivy-occur-last))
2707 (actions (if (symbolp state-action)
2709 (copy-sequence state-action))))
2712 (ivy-occur-read-action)
2714 (setf (ivy-state-action ivy-occur-last) actions))))
2716 (defun ivy-occur-click (event)
2717 "Execute action for the current candidate.
2718 EVENT gives the mouse position."
2720 (let ((window (posn-window (event-end event)))
2721 (pos (posn-point (event-end event))))
2722 (with-current-buffer (window-buffer window)
2724 (ivy-occur-press))))
2726 (declare-function swiper--cleanup "swiper")
2727 (declare-function swiper--add-overlays "swiper")
2729 (defun ivy-occur-press ()
2730 "Execute action for the current candidate."
2733 (when (save-excursion
2735 (looking-at "\\(?:./\\| \\)\\(.*\\)$"))
2736 (let* ((ivy-last ivy-occur-last)
2737 (ivy-text (ivy-state-text ivy-last))
2738 (str (buffer-substring
2741 (coll (ivy-state-collection ivy-last))
2742 (action (ivy--get-action ivy-last))
2746 (if (and (consp coll)
2748 (cdr (assoc str coll))
2750 (if (memq (ivy-state-caller ivy-last)
2751 '(swiper counsel-git-grep))
2752 (with-current-buffer (window-buffer (selected-window))
2754 (swiper--add-overlays
2755 (ivy--regex ivy-text)
2756 (line-beginning-position)
2759 (run-at-time 0.5 nil 'swiper--cleanup))
2760 (pulse-momentary-highlight-one-line (point)))))))
2762 (defvar ivy-help-file (let ((default-directory
2764 (file-name-directory load-file-name)
2765 default-directory)))
2766 (if (file-exists-p "ivy-help.org")
2767 (expand-file-name "ivy-help.org")
2768 (if (file-exists-p "doc/ivy-help.org")
2769 (expand-file-name "doc/ivy-help.org"))))
2770 "The file for `ivy-help'.")
2775 (let ((buf (get-buffer "*Ivy Help*")))
2777 (setq buf (get-buffer-create "*Ivy Help*"))
2778 (with-current-buffer buf
2779 (insert-file-contents ivy-help-file)
2782 (goto-char (point-min))))
2783 (if (eq this-command 'ivy-help)
2784 (switch-to-buffer buf)
2786 (pop-to-buffer buf)))
2788 (goto-char (point-min))))
2792 ;;; ivy.el ends here