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--display-transformers-list nil
172 "A list of str->str transformers per command.")
174 (defun ivy-set-display-transformer (cmd transformer)
175 "Set CMD a displayed candidate TRANSFORMER.
177 It's a lambda that takes a string one of the candidates in the
178 collection and returns a string for display, the same candidate
179 plus some extra information.
181 This lambda is called only on the `ivy-height' candidates that
182 are about to be displayed, not on the whole collection."
183 (setq ivy--display-transformers-list
184 (plist-put ivy--display-transformers-list cmd transformer)))
186 (defvar ivy--sources-list nil
187 "A list of extra sources per command.")
189 (defun ivy-set-sources (cmd sources)
190 "Attach to CMD a list of extra SOURCES.
192 Each static source is a function that takes no argument and
193 returns a list of strings.
195 The '(original-source) determines the position of the original
198 Extra dynamic sources aren't supported yet.
202 (defun small-recentf ()
203 (cl-subseq recentf-list 0 20))
210 (setq ivy--sources-list
211 (plist-put ivy--sources-list cmd sources)))
215 (defvar ivy-minibuffer-map
216 (let ((map (make-sparse-keymap)))
217 (define-key map (kbd "C-m") 'ivy-done)
218 (define-key map (kbd "C-M-m") 'ivy-call)
219 (define-key map (kbd "C-j") 'ivy-alt-done)
220 (define-key map (kbd "C-M-j") 'ivy-immediate-done)
221 (define-key map (kbd "TAB") 'ivy-partial-or-done)
222 (define-key map (kbd "C-n") 'ivy-next-line)
223 (define-key map (kbd "C-p") 'ivy-previous-line)
224 (define-key map (kbd "<down>") 'ivy-next-line)
225 (define-key map (kbd "<up>") 'ivy-previous-line)
226 (define-key map (kbd "C-s") 'ivy-next-line-or-history)
227 (define-key map (kbd "C-r") 'ivy-reverse-i-search)
228 (define-key map (kbd "SPC") 'self-insert-command)
229 (define-key map (kbd "DEL") 'ivy-backward-delete-char)
230 (define-key map (kbd "M-DEL") 'ivy-backward-kill-word)
231 (define-key map (kbd "C-d") 'ivy-delete-char)
232 (define-key map (kbd "C-f") 'ivy-forward-char)
233 (define-key map (kbd "M-d") 'ivy-kill-word)
234 (define-key map (kbd "M-<") 'ivy-beginning-of-buffer)
235 (define-key map (kbd "M->") 'ivy-end-of-buffer)
236 (define-key map (kbd "M-n") 'ivy-next-history-element)
237 (define-key map (kbd "M-p") 'ivy-previous-history-element)
238 (define-key map (kbd "C-g") 'minibuffer-keyboard-quit)
239 (define-key map (kbd "C-v") 'ivy-scroll-up-command)
240 (define-key map (kbd "M-v") 'ivy-scroll-down-command)
241 (define-key map (kbd "C-M-n") 'ivy-next-line-and-call)
242 (define-key map (kbd "C-M-p") 'ivy-previous-line-and-call)
243 (define-key map (kbd "M-q") 'ivy-toggle-regexp-quote)
244 (define-key map (kbd "M-j") 'ivy-yank-word)
245 (define-key map (kbd "M-i") 'ivy-insert-current)
246 (define-key map (kbd "C-o") 'hydra-ivy/body)
247 (define-key map (kbd "M-o") 'ivy-dispatching-done)
248 (define-key map (kbd "C-M-o") 'ivy-dispatching-call)
249 (define-key map (kbd "C-k") 'ivy-kill-line)
250 (define-key map (kbd "S-SPC") 'ivy-restrict-to-matches)
251 (define-key map (kbd "M-w") 'ivy-kill-ring-save)
252 (define-key map (kbd "C-'") 'ivy-avy)
253 (define-key map (kbd "C-M-a") 'ivy-read-action)
254 (define-key map (kbd "C-c C-o") 'ivy-occur)
255 (define-key map (kbd "C-c C-a") 'ivy-toggle-ignore)
256 (define-key map (kbd "C-h m") 'ivy-help)
258 "Keymap used in the minibuffer.")
259 (autoload 'hydra-ivy/body "ivy-hydra" "" t)
262 (let ((map (make-sparse-keymap)))
263 (define-key map [remap switch-to-buffer]
265 (define-key map [remap switch-to-buffer-other-window]
266 'ivy-switch-buffer-other-window)
268 "Keymap for `ivy-mode'.")
271 (cl-defstruct ivy-state
273 predicate require-match initial-input
274 history preselect keymap update-fn sort
275 ;; The window in which `ivy-read' was called
277 ;; The buffer in which `ivy-read' was called
279 ;; The value of `ivy-text' to be used by `ivy-occur'
285 ;; When this is non-nil, call it for each input change to get new candidates
287 ;; A lambda that transforms candidates only for display
288 display-transformer-fn
291 (defvar ivy-last (make-ivy-state)
292 "The last parameters passed to `ivy-read'.
294 This should eventually become a stack so that you could use
295 `ivy-read' recursively.")
297 (defsubst ivy-set-action (action)
298 (setf (ivy-state-action ivy-last) action))
300 (defun ivy-thing-at-point ()
301 "Return a string that corresponds to the current thing at point."
303 (thing-at-point 'url)
305 (cond ((stringp (setq s (thing-at-point 'symbol)))
306 (if (string-match "\\`[`']?\\(.*?\\)'?\\'" s)
309 ((looking-at "(+\\(\\(?:\\sw\\|\\s_\\)+\\)\\_>")
310 (match-string-no-properties 1))
314 (defvar ivy-history nil
315 "History list of candidates entered in the minibuffer.
317 Maximum length of the history list is determined by the value
318 of `history-length'.")
320 (defvar ivy--directory nil
321 "Current directory when completing file names.")
323 (defvar ivy--length 0
324 "Store the amount of viable candidates.")
327 "Store the user's string as it is typed in.")
329 (defvar ivy--current ""
330 "Current candidate.")
333 "Store the index of the current candidate.")
336 "Store 'done if the completion was successfully selected.
337 Otherwise, store nil.")
339 (defvar ivy--all-candidates nil
340 "Store the candidates passed to `ivy-read'.")
342 (defvar ivy--extra-candidates '((original-source))
343 "Store candidates added by the extra sources.
345 This is an internal-use alist. Each key is a function name, or
346 original-source (which represents where the current dynamic
347 candidates should go).
349 Each value is an evaluation of the function, in case of static
350 sources. These values will subsequently be filtered on `ivy-text'.
352 This variable is set by `ivy-read' and used by `ivy--set-candidates'.")
354 (defvar ivy-use-ignore t
355 "Store policy for user-configured candidate filtering.")
357 (defvar ivy--default nil
358 "Default initial input.")
360 (defvar ivy--prompt nil
361 "Store the format-style prompt.
362 When non-nil, it should contain at least one %d.")
364 (defvar ivy--prompt-extra ""
365 "Temporary modifications to the prompt.")
367 (defvar ivy--old-re nil
368 "Store the old regexp.")
370 (defvar ivy--old-cands nil
371 "Store the candidates matched by `ivy--old-re'.")
373 (defvar ivy--regex-function 'ivy--regex
374 "Current function for building a regex.")
376 (defvar ivy--subexps 0
377 "Number of groups in the current `ivy--regex'.")
379 (defvar ivy--full-length nil
380 "When :dynamic-collection is non-nil, this can be the total amount of candidates.")
382 (defvar ivy--old-text ""
383 "Store old `ivy-text' for dynamic completion.")
385 (defvar ivy-case-fold-search 'auto
386 "Store the current overriding `case-fold-search'.")
388 (defvar Info-current-file)
390 (defmacro ivy-quit-and-run (&rest body)
391 "Quit the minibuffer and run BODY afterwards."
393 (put 'quit 'error-message "")
396 (put 'quit 'error-message "Quit")
398 (minibuffer-keyboard-quit)))
400 (defun ivy-exit-with-action (action)
401 "Quit the minibuffer and call ACTION afterwards."
405 (ivy-set-action ',(ivy-state-action ivy-last))))
406 (setq ivy-exit 'done)
409 (defmacro with-ivy-window (&rest body)
410 "Execute BODY in the window from which `ivy-read' was called."
413 `(with-selected-window (ivy--get-window ivy-last)
416 (defun ivy--done (text)
417 "Insert TEXT and exit minibuffer."
418 (if (and ivy--directory
419 (not (eq (ivy-state-history ivy-last) 'grep-files-history)))
420 (insert (setq ivy--current (expand-file-name
421 text ivy--directory)))
422 (insert (setq ivy--current text)))
423 (setq ivy-exit 'done)
428 "Exit the minibuffer with the selected candidate."
430 (delete-minibuffer-contents)
431 (cond ((> ivy--length 0)
432 (ivy--done ivy--current))
433 ((memq (ivy-state-collection ivy-last)
434 '(read-file-name-internal internal-complete-buffer))
435 (if (or (not (eq confirm-nonexistent-file-or-buffer t))
436 (equal " (confirm)" ivy--prompt-extra))
438 (setq ivy--prompt-extra " (confirm)")
441 ((memq (ivy-state-require-match ivy-last)
442 '(nil confirm confirm-after-completion))
443 (ivy--done ivy-text))
445 (setq ivy--prompt-extra " (match required)")
449 (defun ivy-read-action ()
450 "Change the action to one of the available ones.
452 Return nil for `minibuffer-keyboard-quit' or wrong key during the
453 selection, non-nil otherwise."
455 (let ((actions (ivy-state-action ivy-last)))
456 (if (null (ivy--actionp actions))
458 (let* ((hint (concat (if (eq this-command 'ivy-read-action)
467 'face 'font-lock-builtin-face)
472 (resize-mini-windows 'grow-only)
473 (key (string (read-key hint)))
474 (action-idx (cl-position-if
475 (lambda (x) (equal (car x) key))
477 (cond ((string= key "
\a")
480 (message "%s is not bound" key)
484 (setcar actions (1+ action-idx))
485 (ivy-set-action actions)))))))
487 (defun ivy-dispatching-done ()
488 "Select one of the available actions and call `ivy-done'."
490 (when (ivy-read-action)
493 (defun ivy-dispatching-call ()
494 "Select one of the available actions and call `ivy-call'."
496 (let ((actions (copy-sequence (ivy-state-action ivy-last))))
498 (when (ivy-read-action)
500 (ivy-set-action actions))))
502 (defun ivy-build-tramp-name (x)
503 "Reconstruct X into a path.
504 Is is a cons cell, related to `tramp-get-completion-function'."
508 (concat user "@" domain)
511 (declare-function tramp-get-completion-function "tramp")
512 (declare-function Info-find-node "info")
514 (defun ivy-alt-done (&optional arg)
515 "Exit the minibuffer with the selected candidate.
516 When ARG is t, exit with current text, ignoring the candidates."
519 (ivy-immediate-done))
521 (ivy--directory-done))
522 ((eq (ivy-state-collection ivy-last) 'Info-read-node-name-1)
523 (if (or (equal ivy--current "(./)")
524 (equal ivy--current "(../)"))
526 (ivy-read "Go to file: " 'read-file-name-internal
529 (expand-file-name x ivy--directory)
535 (defun ivy--directory-done ()
536 "Handle exit from the minibuffer when completing file names."
539 ((equal ivy-text "/sudo::")
540 (setq dir (concat ivy-text ivy--directory))
545 (not (equal ivy-text ""))
549 (file-name-as-directory
551 ivy-text ivy--directory))))))
553 (not (string= ivy--current "./"))
554 (cl-plusp ivy--length)
557 (setq dir (file-name-as-directory
559 ivy--current ivy--directory)))))))
562 ((or (and (equal ivy--directory "/")
563 (string-match "\\`[^/]+:.*:.*\\'" ivy-text))
564 (string-match "\\`/[^/]+:.*:.*\\'" ivy-text))
566 ((or (and (equal ivy--directory "/")
568 "\\`\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
571 "\\`\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
573 (setq ivy-text ivy--current))))
575 "\\`/\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
577 (let ((method (match-string 1 ivy-text))
578 (user (match-string 2 ivy-text))
579 (rest (match-string 3 ivy-text))
582 (dolist (x (tramp-get-completion-function method))
583 (setq res (append res (funcall (car x) (cadr x)))))
584 (setq res (delq nil res))
588 (setq res (cl-delete-duplicates res :test #'equal))
589 (let* ((old-ivy-last ivy-last)
590 (enable-recursive-minibuffers t)
591 (host (ivy-read "user@host: "
592 (mapcar #'ivy-build-tramp-name res)
593 :initial-input rest)))
594 (setq ivy-last old-ivy-last)
596 (setq ivy--directory "/")
597 (ivy--cd (concat "/" method ":" host ":"))))))
601 (defcustom ivy-tab-space nil
602 "When non-nil, `ivy-partial-or-done' should insert a space."
605 (defun ivy-partial-or-done ()
606 "Complete the minibuffer text as much as possible.
607 If the text hasn't changed as a result, forward to `ivy-alt-done'."
609 (if (and (eq (ivy-state-collection ivy-last) #'read-file-name-internal)
610 (or (and (equal ivy--directory "/")
611 (string-match "\\`[^/]+:.*\\'" ivy-text))
612 (string-match "\\`/" ivy-text)))
613 (let ((default-directory ivy--directory))
614 (minibuffer-complete)
615 (setq ivy-text (ivy--input))
616 (when (file-directory-p
617 (expand-file-name ivy-text ivy--directory))
618 (ivy--cd (file-name-as-directory
619 (expand-file-name ivy-text ivy--directory)))))
621 (when (or (eq this-command last-command)
625 (defun ivy-partial ()
626 "Complete the minibuffer text as much as possible."
628 (let* ((parts (or (split-string ivy-text " " t) (list "")))
629 (postfix (car (last parts)))
630 (completion-ignore-case t)
631 (startp (string-match "^\\^" postfix))
632 (new (try-completion (if startp
633 (substring postfix 1)
635 (mapcar (lambda (str)
636 (let ((i (string-match postfix str)))
640 (cond ((eq new t) nil)
641 ((string= new ivy-text) nil)
643 (delete-region (minibuffer-prompt-end) (point-max))
648 (insert (mapconcat #'identity parts " ")
649 (if ivy-tab-space " " ""))
652 (defun ivy-immediate-done ()
653 "Exit the minibuffer with the current input."
655 (delete-minibuffer-contents)
656 (insert (setq ivy--current
658 (expand-file-name ivy-text ivy--directory)
660 (setq ivy-exit 'done)
665 "Resume the last completion session."
667 (when (eq (ivy-state-caller ivy-last) 'swiper)
668 (switch-to-buffer (ivy-state-buffer ivy-last)))
669 (with-current-buffer (ivy-state-buffer ivy-last)
671 (ivy-state-prompt ivy-last)
672 (ivy-state-collection ivy-last)
673 :predicate (ivy-state-predicate ivy-last)
674 :require-match (ivy-state-require-match ivy-last)
675 :initial-input ivy-text
676 :history (ivy-state-history ivy-last)
677 :preselect (unless (eq (ivy-state-collection ivy-last)
678 'read-file-name-internal)
680 :keymap (ivy-state-keymap ivy-last)
681 :update-fn (ivy-state-update-fn ivy-last)
682 :sort (ivy-state-sort ivy-last)
683 :action (ivy-state-action ivy-last)
684 :unwind (ivy-state-unwind ivy-last)
685 :re-builder (ivy-state-re-builder ivy-last)
686 :matcher (ivy-state-matcher ivy-last)
687 :dynamic-collection (ivy-state-dynamic-collection ivy-last)
688 :caller (ivy-state-caller ivy-last))))
690 (defvar ivy-calling nil
691 "When non-nil, call the current action when `ivy--index' changes.")
693 (defun ivy-set-index (index)
694 "Set `ivy--index' to INDEX."
695 (setq ivy--index index)
700 (defun ivy-beginning-of-buffer ()
701 "Select the first completion candidate."
705 (defun ivy-end-of-buffer ()
706 "Select the last completion candidate."
708 (ivy-set-index (1- ivy--length)))
710 (defun ivy-scroll-up-command ()
711 "Scroll the candidates upward by the minibuffer height."
713 (ivy-set-index (min (1- (+ ivy--index ivy-height))
716 (defun ivy-scroll-down-command ()
717 "Scroll the candidates downward by the minibuffer height."
719 (ivy-set-index (max (1+ (- ivy--index ivy-height))
722 (defun ivy-minibuffer-grow ()
723 "Grow the minibuffer window by 1 line."
725 (setq-local max-mini-window-height
726 (cl-incf ivy-height)))
728 (defun ivy-minibuffer-shrink ()
729 "Shrink the minibuffer window by 1 line."
731 (unless (<= ivy-height 2)
732 (setq-local max-mini-window-height
733 (cl-decf ivy-height))
734 (window-resize (selected-window) -1)))
736 (defun ivy-next-line (&optional arg)
737 "Move cursor vertically down ARG candidates."
739 (setq arg (or arg 1))
740 (let ((index (+ ivy--index arg)))
741 (if (> index (1- ivy--length))
743 (ivy-beginning-of-buffer)
744 (ivy-set-index (1- ivy--length)))
745 (ivy-set-index index))))
747 (defun ivy-next-line-or-history (&optional arg)
748 "Move cursor vertically down ARG candidates.
749 If the input is empty, select the previous history element instead."
751 (if (string= ivy-text "")
752 (ivy-previous-history-element 1)
753 (ivy-next-line arg)))
755 (defun ivy-previous-line (&optional arg)
756 "Move cursor vertically up ARG candidates."
758 (setq arg (or arg 1))
759 (let ((index (- ivy--index arg)))
764 (ivy-set-index index))))
766 (defun ivy-previous-line-or-history (arg)
767 "Move cursor vertically up ARG candidates.
768 If the input is empty, select the previous history element instead."
770 (when (string= ivy-text "")
771 (ivy-previous-history-element 1))
772 (ivy-previous-line arg))
774 (defun ivy-toggle-calling ()
775 "Flip `ivy-calling'."
777 (when (setq ivy-calling (not ivy-calling))
780 (defun ivy-toggle-ignore ()
781 "Toggle user-configured candidate filtering."
783 (setq ivy-use-ignore (null ivy-use-ignore))
785 (setq ivy--old-cands nil))
787 (defun ivy--get-action (state)
788 "Get the action function from STATE."
789 (let ((action (ivy-state-action state)))
791 (if (functionp action)
793 (cadr (nth (car action) action))))))
795 (defun ivy--get-window (state)
796 "Get the window from STATE."
797 (if (ivy-state-p state)
798 (let ((window (ivy-state-window state)))
799 (if (window-live-p window)
801 (if (= (length (window-list)) 1)
806 (defun ivy--actionp (x)
807 "Return non-nil when X is a list of actions."
808 (and x (listp x) (not (eq (car x) 'closure))))
810 (defun ivy-next-action ()
811 "When the current action is a list, scroll it forwards."
813 (let ((action (ivy-state-action ivy-last)))
814 (when (ivy--actionp action)
815 (unless (>= (car action) (1- (length action)))
816 (cl-incf (car action))))))
818 (defun ivy-prev-action ()
819 "When the current action is a list, scroll it backwards."
821 (let ((action (ivy-state-action ivy-last)))
822 (when (ivy--actionp action)
823 (unless (<= (car action) 1)
824 (cl-decf (car action))))))
826 (defun ivy-action-name ()
827 "Return the name associated with the current action."
828 (let ((action (ivy-state-action ivy-last)))
829 (if (ivy--actionp action)
833 (nth 2 (nth (car action) action)))
836 (defvar ivy-inhibit-action nil
837 "When non-nil, `ivy-call' does nothing.
841 (let* ((ivy-inhibit-action t)
842 (str (counsel-locate \"lispy.el\")))
843 ;; do whatever with str - the corresponding file will not be opened
847 "Call the current action without exiting completion."
849 (unless ivy-inhibit-action
850 (let ((action (ivy--get-action ivy-last)))
852 (let* ((collection (ivy-state-collection ivy-last))
853 (x (if (and (consp collection)
854 (consp (car collection)))
855 (cdr (assoc ivy--current collection))
856 (if (equal ivy--current "")
859 (prog1 (funcall action x)
860 (unless (or (eq ivy-exit 'done)
861 (equal (selected-window)
862 (active-minibuffer-window))
863 (null (active-minibuffer-window)))
864 (select-window (active-minibuffer-window)))))))))
866 (defun ivy-next-line-and-call (&optional arg)
867 "Move cursor vertically down ARG candidates.
868 Call the permanent action if possible."
874 (defun ivy-previous-line-and-call (&optional arg)
875 "Move cursor vertically down ARG candidates.
876 Call the permanent action if possible."
878 (ivy-previous-line arg)
882 (defun ivy-previous-history-element (arg)
883 "Forward to `previous-history-element' with ARG."
885 (previous-history-element arg)
888 (ivy--maybe-scroll-history))
890 (defun ivy-next-history-element (arg)
891 "Forward to `next-history-element' with ARG."
893 (if (and (= minibuffer-history-position 0)
896 (insert ivy--default)
897 (when (and (with-ivy-window (derived-mode-p 'prog-mode))
898 (not (file-exists-p ivy--default))
899 (> (point) (minibuffer-prompt-end)))
902 (goto-char (minibuffer-prompt-end))
904 (forward-char (+ 2 (length ivy--default)))))
905 (next-history-element arg))
908 (ivy--maybe-scroll-history))
910 (defvar ivy-ffap-url-functions nil
911 "List of functions that check if the point is on a URL.")
913 (defun ivy--cd-maybe ()
914 "Check if the current input points to a different directory.
915 If so, move to that directory, while keeping only the file name."
917 (let ((input (ivy--input))
919 (if (setq url (or (ffap-url-p input)
924 ivy-ffap-url-functions
925 :initial-value nil))))
926 (ivy-exit-with-action
928 (funcall ffap-url-fetcher url)))
929 (setq input (expand-file-name input))
930 (let ((file (file-name-nondirectory input))
931 (dir (expand-file-name (file-name-directory input))))
932 (if (string= dir ivy--directory)
934 (delete-minibuffer-contents)
939 (defun ivy--maybe-scroll-history ()
940 "If the selected history element has an index, scroll there."
941 (let ((idx (ignore-errors
943 (minibuffer-prompt-end)
947 (setq ivy--index idx))))
950 "When completing file names, move to directory DIR."
951 (if (null ivy--directory)
953 (setq ivy--old-cands nil)
954 (setq ivy--old-re nil)
956 (setq ivy--all-candidates
957 (ivy--sorted-files (setq ivy--directory dir)))
959 (delete-minibuffer-contents)))
961 (defun ivy-backward-delete-char ()
962 "Forward to `backward-delete-char'.
963 On error (read-only), call `ivy-on-del-error-function'."
965 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
967 (ivy--cd (file-name-directory
973 (backward-delete-char 1)
975 (when ivy-on-del-error-function
976 (funcall ivy-on-del-error-function))))))
978 (defun ivy-delete-char (arg)
979 "Forward to `delete-char' ARG."
981 (unless (= (point) (line-end-position))
984 (defun ivy-forward-char (arg)
985 "Forward to `forward-char' ARG."
987 (unless (= (point) (line-end-position))
990 (defun ivy-kill-word (arg)
991 "Forward to `kill-word' ARG."
993 (unless (= (point) (line-end-position))
996 (defun ivy-kill-line ()
997 "Forward to `kill-line'."
1000 (kill-region (minibuffer-prompt-end) (point))
1003 (defun ivy-backward-kill-word ()
1004 "Forward to `backward-kill-word'."
1006 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
1008 (ivy--cd (file-name-directory
1009 (directory-file-name
1016 (delete-region (point) pt)))))
1018 (defvar ivy--regexp-quote 'regexp-quote
1019 "Store the regexp quoting state.")
1021 (defun ivy-toggle-regexp-quote ()
1022 "Toggle the regexp quoting."
1024 (setq ivy--old-re nil)
1025 (cl-rotatef ivy--regex-function ivy--regexp-quote))
1027 (defvar avy-all-windows)
1030 (defvar avy-keys-alist)
1032 (defvar avy-styles-alist)
1033 (declare-function avy--process "ext:avy")
1034 (declare-function avy--style-fn "ext:avy")
1036 (eval-after-load 'avy
1037 '(add-to-list 'avy-styles-alist '(ivy-avy . pre)))
1040 "Jump to one of the current ivy candidates."
1042 (unless (require 'avy nil 'noerror)
1043 (error "Package avy isn't installed"))
1044 (let* ((avy-all-windows nil)
1045 (avy-keys (or (cdr (assq 'ivy-avy avy-keys-alist))
1047 (avy-style (or (cdr (assq 'ivy-avy
1057 (goto-char (point-min))
1059 (while (< (point) (point-max))
1065 (setq avy-action #'identity)
1067 (nreverse candidates)
1068 (avy--style-fn avy-style)))))
1069 (ivy-set-index (- (line-number-at-pos candidate) 2))
1073 (defun ivy-sort-file-function-default (x y)
1074 "Compare two files X and Y.
1075 Prioritize directories."
1076 (if (get-text-property 0 'dirp x)
1077 (if (get-text-property 0 'dirp y)
1080 (if (get-text-property 0 'dirp y)
1084 (defcustom ivy-sort-functions-alist
1085 '((read-file-name-internal . ivy-sort-file-function-default)
1086 (internal-complete-buffer . nil)
1087 (counsel-git-grep-function . nil)
1088 (Man-goto-section . nil)
1091 "An alist of sorting functions for each collection function.
1092 Interactive functions that call completion fit in here as well.
1094 Nil means no sorting, which is useful to turn off the sorting for
1095 functions that have candidates in the natural buffer order, like
1096 `org-refile' or `Man-goto-section'.
1098 The entry associated with t is used for all fall-through cases.
1100 See also `ivy-sort-max-size'."
1104 (const :tag "Fall-through" t)
1105 (symbol :tag "Collection"))
1107 (const :tag "Plain sort" string-lessp)
1108 (const :tag "File sort" ivy-sort-file-function-default)
1109 (const :tag "No sort" nil)))
1112 (defvar ivy-index-functions-alist
1113 '((swiper . ivy-recompute-index-swiper)
1114 (swiper-multi . ivy-recompute-index-swiper)
1115 (counsel-git-grep . ivy-recompute-index-swiper)
1116 (counsel-grep . ivy-recompute-index-swiper-async)
1117 (t . ivy-recompute-index-zero))
1118 "An alist of index recomputing functions for each collection function.
1119 When the input changes, the appropriate function returns an
1120 integer - the index of the matched candidate that should be
1123 (defvar ivy-re-builders-alist
1124 '((t . ivy--regex-plus))
1125 "An alist of regex building functions for each collection function.
1127 Each key is (in order of priority):
1128 1. The actual collection function, e.g. `read-file-name-internal'.
1129 2. The symbol passed by :caller into `ivy-read'.
1133 Each value is a function that should take a string and return a
1134 valid regex or a regex sequence (see below).
1136 Possible choices: `ivy--regex', `regexp-quote',
1137 `ivy--regex-plus', `ivy--regex-fuzzy'.
1139 If a function returns a list, it should format like this:
1140 '((\"matching-regexp\" . t) (\"non-matching-regexp\") ...).
1142 The matches will be filtered in a sequence, you can mix the
1143 regexps that should match and that should not match as you
1146 (defvar ivy-initial-inputs-alist
1147 '((org-refile . "^")
1148 (org-agenda-refile . "^")
1149 (org-capture-refile . "^")
1151 (counsel-describe-function . "^")
1152 (counsel-describe-variable . "^")
1155 "Command to initial input table.")
1157 (defcustom ivy-sort-max-size 30000
1158 "Sorting won't be done for collections larger than this."
1161 (defun ivy--sorted-files (dir)
1162 "Return the list of files in DIR.
1163 Directories come first."
1164 (let* ((default-directory dir)
1165 (seq (all-completions "" 'read-file-name-internal))
1169 (setq seq (delete "./" (delete "../" seq)))
1170 (when (eq (setq sort-fn (cdr (assoc 'read-file-name-internal
1171 ivy-sort-functions-alist)))
1172 #'ivy-sort-file-function-default)
1173 (setq seq (mapcar (lambda (x)
1174 (propertize x 'dirp (string-match-p "/\\'" x)))
1177 (setq seq (cl-sort seq sort-fn)))
1178 (dolist (dir ivy-extra-directories)
1182 (defvar ivy-recursive-restore t
1183 "When non-nil, restore the above state when exiting the minibuffer.
1184 This variable is let-bound to nil by functions that take care of
1185 the restoring themselves.")
1188 (cl-defun ivy-read (prompt collection
1190 predicate require-match initial-input
1191 history preselect keymap update-fn sort
1192 action unwind re-builder matcher dynamic-collection caller)
1193 "Read a string in the minibuffer, with completion.
1195 PROMPT is a format string, normally ending in a colon and a
1196 space; %d anywhere in the string is replaced by the current
1197 number of matching candidates. For the literal % character,
1198 escape it with %%. See also `ivy-count-format'.
1200 COLLECTION is either a list of strings, a function, an alist, or
1203 If INITIAL-INPUT is not nil, then insert that input in the
1204 minibuffer initially.
1206 KEYMAP is composed with `ivy-minibuffer-map'.
1208 If PRESELECT is not nil, then select the corresponding candidate
1209 out of the ones that match the INITIAL-INPUT.
1211 UPDATE-FN is called each time the current candidate(s) is changed.
1213 When SORT is t, use `ivy-sort-functions-alist' for sorting.
1215 ACTION is a lambda function to call after selecting a result. It
1216 takes a single string argument.
1218 UNWIND is a lambda function to call before exiting.
1220 RE-BUILDER is a lambda function to call to transform text into a
1223 MATCHER is to override matching.
1225 DYNAMIC-COLLECTION is a boolean to specify if the list of
1226 candidates is updated after each input by calling COLLECTION.
1228 CALLER is a symbol to uniquely identify the caller to `ivy-read'.
1229 It is used, along with COLLECTION, to determine which
1230 customizations apply to the current completion session."
1231 (let ((extra-actions (delete-dups
1232 (append (plist-get ivy--actions-list t)
1233 (plist-get ivy--actions-list this-command)
1234 (plist-get ivy--actions-list caller)))))
1237 (cond ((functionp action)
1239 ("o" ,action "default")
1243 ("o" identity "default")
1246 (delete-dups (append action extra-actions)))))))
1247 (let ((extra-sources (plist-get ivy--sources-list caller)))
1250 (setq ivy--extra-candidates nil)
1251 (dolist (source extra-sources)
1252 (cond ((equal source '(original-source))
1253 (setq ivy--extra-candidates
1254 (cons source ivy--extra-candidates)))
1255 ((null (cdr source))
1256 (setq ivy--extra-candidates
1258 (list (car source) (funcall (car source)))
1259 ivy--extra-candidates))))))
1260 (setq ivy--extra-candidates '((original-source)))))
1261 (let ((recursive-ivy-last (and (active-minibuffer-window) ivy-last))
1262 (transformer-fn (plist-get ivy--display-transformers-list caller)))
1266 :collection collection
1267 :predicate predicate
1268 :require-match require-match
1269 :initial-input initial-input
1271 :preselect preselect
1273 :update-fn update-fn
1276 :window (selected-window)
1277 :buffer (current-buffer)
1279 :re-builder re-builder
1281 :dynamic-collection dynamic-collection
1282 :display-transformer-fn transformer-fn
1284 (ivy--reset-state ivy-last)
1287 (minibuffer-with-setup-hook
1288 #'ivy--minibuffer-setup
1289 (let* ((hist (or history 'ivy-history))
1290 (minibuffer-completion-table collection)
1291 (minibuffer-completion-predicate predicate)
1292 (resize-mini-windows (cond
1293 ((display-graphic-p) nil)
1294 ((null resize-mini-windows) 'grow-only)
1295 (t resize-mini-windows))))
1296 (read-from-minibuffer
1298 (ivy-state-initial-input ivy-last)
1299 (make-composed-keymap keymap ivy-minibuffer-map)
1302 (when (eq ivy-exit 'done)
1303 (let ((item (if ivy--directory
1306 (unless (equal item "")
1307 (set hist (cons (propertize item 'ivy-index ivy--index)
1309 (cdr (symbol-value hist))))))))
1311 (remove-hook 'post-command-hook #'ivy--exhibit)
1312 (when (setq unwind (ivy-state-unwind ivy-last))
1314 (unless (eq ivy-exit 'done)
1315 (when recursive-ivy-last
1316 (ivy--reset-state (setq ivy-last recursive-ivy-last)))))
1318 (when (and recursive-ivy-last
1319 ivy-recursive-restore)
1320 (ivy--reset-state (setq ivy-last recursive-ivy-last))))))
1322 (defun ivy--reset-state (state)
1323 "Reset the ivy to STATE.
1324 This is useful for recursive `ivy-read'."
1325 (let ((prompt (or (ivy-state-prompt state) ""))
1326 (collection (ivy-state-collection state))
1327 (predicate (ivy-state-predicate state))
1328 (history (ivy-state-history state))
1329 (preselect (ivy-state-preselect state))
1330 (sort (ivy-state-sort state))
1331 (re-builder (ivy-state-re-builder state))
1332 (dynamic-collection (ivy-state-dynamic-collection state))
1333 (initial-input (ivy-state-initial-input state))
1334 (require-match (ivy-state-require-match state))
1335 (caller (ivy-state-caller state)))
1336 (unless initial-input
1337 (setq initial-input (cdr (assoc this-command
1338 ivy-initial-inputs-alist))))
1339 (setq ivy--directory nil)
1340 (setq ivy-case-fold-search 'auto)
1341 (setq ivy--regex-function
1343 (and (functionp collection)
1344 (cdr (assoc collection ivy-re-builders-alist)))
1346 (cdr (assoc caller ivy-re-builders-alist)))
1347 (cdr (assoc this-command ivy-re-builders-alist))
1348 (cdr (assoc t ivy-re-builders-alist))
1350 (setq ivy--subexps 0)
1351 (setq ivy--regexp-quote 'regexp-quote)
1352 (setq ivy--old-text "")
1353 (setq ivy--full-length nil)
1355 (setq ivy-calling nil)
1356 (setq ivy-use-ignore t)
1358 (cond ((eq collection 'Info-read-node-name-1)
1359 (if (equal Info-current-file "dir")
1361 (mapcar (lambda (x) (format "(%s)" x))
1362 (cl-delete-duplicates
1363 (all-completions "(" collection predicate)
1365 (setq coll (all-completions "" collection predicate))))
1366 ((eq collection 'read-file-name-internal)
1367 (setq ivy--directory default-directory)
1370 (let ((preselect-directory (file-name-directory preselect)))
1371 (unless (or (null preselect-directory)
1372 (string= preselect-directory
1374 (setq ivy--directory preselect-directory))
1376 (ivy-state-preselect state)
1377 (setq preselect (file-name-nondirectory preselect)))))
1378 (setq coll (ivy--sorted-files ivy--directory))
1380 (unless (or require-match
1381 (equal initial-input default-directory)
1382 (equal initial-input ""))
1383 (setq coll (cons initial-input coll)))
1384 (unless (and (ivy-state-action ivy-last)
1385 (not (equal (ivy--get-action ivy-last) 'identity)))
1386 (setq initial-input nil))))
1387 ((eq collection 'internal-complete-buffer)
1388 (setq coll (ivy--buffer-list "" ivy-use-virtual-buffers)))
1390 (setq coll (funcall collection ivy-text)))
1391 ((or (functionp collection)
1392 (byte-code-function-p collection)
1393 (vectorp collection)
1394 (and (consp collection) (listp (car collection)))
1395 (hash-table-p collection)
1396 (and (listp collection) (symbolp (car collection))))
1397 (setq coll (all-completions "" collection predicate)))
1399 (setq coll collection)))
1401 (if (and (functionp collection)
1402 (setq sort-fn (assoc collection ivy-sort-functions-alist)))
1403 (when (and (setq sort-fn (cdr sort-fn))
1404 (not (eq collection 'read-file-name-internal)))
1405 (setq coll (cl-sort coll sort-fn)))
1406 (unless (eq history 'org-refile-history)
1407 (if (and (setq sort-fn (cdr (assoc t ivy-sort-functions-alist)))
1408 (<= (length coll) ivy-sort-max-size))
1409 (setq coll (cl-sort (copy-sequence coll) sort-fn))))))
1411 (unless (or (and require-match
1412 (not (eq collection 'internal-complete-buffer)))
1414 (let ((re (regexp-quote preselect)))
1415 (cl-find-if (lambda (x) (string-match re x))
1417 (setq coll (cons preselect coll))))
1418 (setq ivy--old-re nil)
1419 (setq ivy--old-cands nil)
1420 (when (integerp preselect)
1421 (setq ivy--old-re "")
1422 (setq ivy--index preselect))
1424 ;; Needed for anchor to work
1425 (setq ivy--old-cands coll)
1426 (setq ivy--old-cands (ivy--filter initial-input coll)))
1427 (setq ivy--all-candidates coll)
1428 (unless (integerp preselect)
1429 (setq ivy--index (or
1430 (and dynamic-collection
1433 (ivy--preselect-index
1441 (if (region-active-p)
1445 (ivy-thing-at-point)))
1447 (cond ((string-match "%.*d" prompt)
1449 ((null ivy-count-format)
1451 "`ivy-count-format' can't be nil. Set it to an empty string instead"))
1452 ((string-match "%d.*%d" ivy-count-format)
1453 (let ((w (length (number-to-string
1454 (length ivy--all-candidates))))
1455 (s (copy-sequence ivy-count-format)))
1456 (string-match "%d" s)
1458 (string-match "%d" s (match-end 0))
1459 (setq s (replace-match (format "%%-%dd" w) nil nil s))
1460 (string-match "%d" s)
1461 (concat (replace-match (format "%%%dd" w) nil nil s)
1463 ((string-match "%.*d" ivy-count-format)
1464 (concat ivy-count-format prompt))
1469 (setf (ivy-state-initial-input ivy-last) initial-input)))
1472 (defun ivy-completing-read (prompt collection
1473 &optional predicate require-match initial-input
1474 history def inherit-input-method)
1475 "Read a string in the minibuffer, with completion.
1477 This interface conforms to `completing-read' and can be used for
1478 `completing-read-function'.
1480 PROMPT is a string that normally ends in a colon and a space.
1481 COLLECTION is either a list of strings, an alist, an obarray, or a hash table.
1482 PREDICATE limits completion to a subset of COLLECTION.
1483 REQUIRE-MATCH is a boolean value. See `completing-read'.
1484 INITIAL-INPUT is a string inserted into the minibuffer initially.
1485 HISTORY is a list of previously selected inputs.
1486 DEF is the default value.
1487 INHERIT-INPUT-METHOD is currently ignored."
1488 (if (memq this-command '(tmm-menubar tmm-shortcut))
1489 (completing-read-default prompt collection
1490 predicate require-match
1491 initial-input history
1492 def inherit-input-method)
1493 ;; See the doc of `completing-read'.
1494 (when (consp history)
1495 (when (numberp (cdr history))
1496 (setq initial-input (nth (1- (cdr history))
1497 (symbol-value (car history)))))
1498 (setq history (car history)))
1499 (ivy-read (replace-regexp-in-string "%" "%%" prompt)
1501 :predicate predicate
1502 :require-match require-match
1503 :initial-input (if (consp initial-input)
1505 (if (and (stringp initial-input)
1506 (string-match "\\+" initial-input))
1507 (replace-regexp-in-string
1508 "\\+" "\\\\+" initial-input)
1510 :preselect (if (listp def) (car def) def)
1514 (let ((sort (assoc this-command ivy-sort-functions-alist)))
1519 (defvar ivy-completion-beg nil
1520 "Completion bounds start.")
1522 (defvar ivy-completion-end nil
1523 "Completion bounds end.")
1525 (defun ivy-completion-in-region-action (str)
1526 "Insert STR, erasing the previous one.
1527 The previous string is between `ivy-completion-beg' and `ivy-completion-end'."
1530 (when ivy-completion-beg
1533 ivy-completion-end))
1534 (setq ivy-completion-beg
1535 (move-marker (make-marker) (point)))
1537 (setq ivy-completion-end
1538 (move-marker (make-marker) (point))))))
1540 (defun ivy-completion-common-length (str)
1541 "Return the length of the first 'completions-common-part face in STR."
1544 (while (and (<= pos len)
1545 (let ((prop (get-text-property pos 'face str)))
1546 (not (eq 'completions-common-part
1547 (if (listp prop) (car prop) prop)))))
1548 (setq pos (1+ pos)))
1550 (or (next-single-property-change pos 'face str) len)
1553 (defun ivy-completion-in-region (start end collection &optional predicate)
1554 "An Ivy function suitable for `completion-in-region-function'."
1555 (let* ((enable-recursive-minibuffers t)
1556 (str (buffer-substring-no-properties start end))
1557 (completion-ignore-case case-fold-search)
1559 (completion-all-completions str collection predicate (- end start))))
1561 (message "No matches")
1563 (setq ivy-completion-beg (- end (ivy-completion-common-length (car comps))))
1564 (setq ivy-completion-end end)
1565 (if (null (cdr comps))
1566 (if (string= str (car comps))
1567 (message "Sole match")
1568 (setf (ivy-state-window ivy-last) (selected-window))
1569 (ivy-completion-in-region-action
1570 (substring-no-properties
1572 (let* ((w (1+ (floor (log (length comps) 10))))
1573 (ivy-count-format (if (string= ivy-count-format "")
1575 (format "%%-%dd " w)))
1576 (prompt (format "(%s): " str)))
1578 (ivy-read (if (string= ivy-count-format "")
1580 (replace-regexp-in-string "%" "%%" prompt))
1581 ;; remove 'completions-first-difference face
1582 (mapcar #'substring-no-properties comps)
1583 :predicate predicate
1584 :action #'ivy-completion-in-region-action
1588 (defcustom ivy-do-completion-in-region t
1589 "When non-nil `ivy-mode' will set `completion-in-region-function'."
1593 (define-minor-mode ivy-mode
1594 "Toggle Ivy mode on or off.
1595 Turn Ivy mode on if ARG is positive, off otherwise.
1596 Turning on Ivy mode sets `completing-read-function' to
1597 `ivy-completing-read'.
1602 Minibuffer bindings:
1603 \\{ivy-minibuffer-map}"
1606 :keymap ivy-mode-map
1610 (setq completing-read-function 'ivy-completing-read)
1611 (when ivy-do-completion-in-region
1612 (setq completion-in-region-function 'ivy-completion-in-region)))
1613 (setq completing-read-function 'completing-read-default)
1614 (setq completion-in-region-function 'completion--in-region)))
1616 (defun ivy--preselect-index (preselect candidates)
1617 "Return the index of PRESELECT in CANDIDATES."
1618 (cond ((integerp preselect)
1620 ((cl-position preselect candidates :test #'equal))
1621 ((stringp preselect)
1622 (let ((re preselect))
1625 (string-match re x))
1630 (defvar ivy--regex-hash
1631 (make-hash-table :test #'equal)
1632 "Store pre-computed regex.")
1634 (defun ivy--split (str)
1635 "Split STR into a list by single spaces.
1636 The remaining spaces stick to their left.
1637 This allows to \"quote\" N spaces by inputting N+1 spaces."
1638 (let ((len (length str))
1643 (while (and (string-match " +" str start1)
1645 (setq match-len (- (match-end 0) (match-beginning 0)))
1649 (setq start1 start0)
1651 (push (substring str start1 (match-beginning 0)) res)
1652 (setq start1 (match-end 0)))
1653 (setq str (replace-match
1654 (make-string (1- match-len) ?\ )
1656 (setq start0 (or start0 start1))
1657 (setq start1 (1- (match-end 0)))))
1659 (push (substring str start0) res)
1660 (setq s (substring str start1))
1661 (unless (= (length s) 0)
1665 (defun ivy--regex (str &optional greedy)
1666 "Re-build regex pattern from STR in case it has a space.
1667 When GREEDY is non-nil, join words in a greedy way."
1668 (let ((hashed (unless greedy
1669 (gethash str ivy--regex-hash))))
1672 (setq ivy--subexps (car hashed)))
1673 (when (string-match "\\([^\\]\\|^\\)\\\\$" str)
1674 (setq str (substring str 0 -1)))
1676 (let ((subs (ivy--split str)))
1677 (if (= (length subs) 1)
1679 (setq ivy--subexps 0)
1682 (setq ivy--subexps (length subs))
1685 (if (string-match "\\`\\\\([^?].*\\\\)\\'" x)
1687 (format "\\(%s\\)" x)))
1692 ivy--regex-hash)))))
1694 (defun ivy--regex-ignore-order--part (str &optional discard)
1695 "Re-build regex from STR by splitting at spaces.
1696 Ignore the order of each group."
1697 (let* ((subs (split-string str " +" t))
1698 (len (length subs)))
1703 (mapcar (lambda (x) (cons x (not discard)))
1706 (defun ivy--regex-ignore-order (str)
1707 "Re-build regex from STR by splitting at spaces.
1708 Ignore the order of each group. Everything before \"!\" should
1709 match. Everything after \"!\" should not match."
1710 (let ((parts (split-string str "!" t)))
1711 (cl-case (length parts)
1715 (if (string= (substring str 0 1) "!")
1717 (ivy--regex-ignore-order--part (car parts) t))
1718 (ivy--regex-ignore-order--part (car parts))))
1721 (ivy--regex-ignore-order--part (car parts))
1722 (ivy--regex-ignore-order--part (cadr parts) t)))
1723 (t (error "Unexpected: use only one !")))))
1725 (defun ivy--regex-plus (str)
1726 "Build a regex sequence from STR.
1727 Spaces are wild card characters, everything before \"!\" should
1728 match. Everything after \"!\" should not match."
1729 (let ((parts (split-string str "!" t)))
1730 (cl-case (length parts)
1734 (if (string= (substring str 0 1) "!")
1736 (list (ivy--regex (car parts))))
1737 (ivy--regex (car parts))))
1740 (cons (ivy--regex (car parts)) t)
1741 (mapcar #'list (split-string (cadr parts) " " t))))
1742 (t (error "Unexpected: use only one !")))))
1744 (defun ivy--regex-fuzzy (str)
1745 "Build a regex sequence from STR.
1746 Insert .* between each char."
1747 (if (string-match "\\`\\(\\^?\\)\\(.*?\\)\\(\\$?\\)\\'" str)
1749 (concat (match-string 1 str)
1752 (format "\\(%c\\)" x))
1753 (string-to-list (match-string 2 str)) ".*")
1754 (match-string 3 str))
1755 (setq ivy--subexps (length (match-string 2 str))))
1758 (defcustom ivy-fixed-height-minibuffer nil
1759 "When non nil, fix the height of the minibuffer during ivy
1760 completion at `ivy-height'. This effectively sets the minimum
1761 height at this level and tries to ensure that it does not change
1762 depending on the number of candidates."
1767 (defun ivy--minibuffer-setup ()
1768 "Setup ivy completion in the minibuffer."
1769 (set (make-local-variable 'completion-show-inline-help) nil)
1770 (set (make-local-variable 'minibuffer-default-add-function)
1772 (list ivy--default)))
1773 (when (display-graphic-p)
1774 (setq truncate-lines t))
1775 (setq-local max-mini-window-height ivy-height)
1776 (when ivy-fixed-height-minibuffer
1777 (set-window-text-height (selected-window) ivy-height))
1778 (add-hook 'post-command-hook #'ivy--exhibit nil t)
1779 ;; show completions with empty input
1782 (defun ivy--input ()
1783 "Return the current minibuffer input."
1784 ;; assume one-line minibuffer input
1785 (buffer-substring-no-properties
1786 (minibuffer-prompt-end)
1787 (line-end-position)))
1789 (defun ivy--cleanup ()
1790 "Delete the displayed completion candidates."
1792 (goto-char (minibuffer-prompt-end))
1793 (delete-region (line-end-position) (point-max))))
1795 (defun ivy--insert-prompt ()
1796 "Update the prompt according to `ivy--prompt'."
1798 (unless (memq this-command '(ivy-done ivy-alt-done ivy-partial-or-done
1799 counsel-find-symbol))
1800 (setq ivy--prompt-extra ""))
1802 (if (string-match "\\(.*\\): \\'" ivy--prompt)
1804 (setq head (match-string 1 ivy--prompt))
1806 (setq head (substring ivy--prompt 0 -1))
1808 (let ((inhibit-read-only t)
1809 (std-props '(front-sticky t rear-nonsticky t field t read-only t))
1812 (if (and (bound-and-true-p minibuffer-depth-indicate-mode)
1813 (> (minibuffer-depth) 1))
1814 (format "[%d] " (minibuffer-depth))
1817 (if (string-match "%d.*%d" ivy-count-format)
1820 (or (and (ivy-state-dynamic-collection ivy-last)
1824 (or (and (ivy-state-dynamic-collection ivy-last)
1829 (d-str (if ivy--directory
1830 (abbreviate-file-name ivy--directory)
1833 (goto-char (point-min))
1834 (delete-region (point-min) (minibuffer-prompt-end))
1835 (if (> (+ (mod (+ (length n-str) (length d-str)) (window-width))
1838 (setq n-str (concat n-str "\n" d-str))
1839 (setq n-str (concat n-str d-str)))
1840 (let ((regex (format "\\([^\n]\\{%d\\}\\)[^\n]" (window-width))))
1841 (while (string-match regex n-str)
1842 (setq n-str (replace-match (concat (match-string 1 n-str) "\n") nil t n-str 1))))
1843 (set-text-properties 0 (length n-str)
1844 `(face minibuffer-prompt ,@std-props)
1846 (ivy--set-match-props n-str "confirm"
1847 `(face ivy-confirm-face ,@std-props))
1848 (ivy--set-match-props n-str "match required"
1849 `(face ivy-match-required-face ,@std-props))
1851 ;; get out of the prompt area
1852 (constrain-to-field nil (point-max))))))
1854 (defun ivy--set-match-props (str match props)
1855 "Set STR text properties that match MATCH to PROPS."
1856 (when (string-match match str)
1857 (set-text-properties
1863 (defvar inhibit-message)
1865 (defun ivy--sort-maybe (collection)
1866 "Sort COLLECTION if needed."
1867 (let ((sort (ivy-state-sort ivy-last))
1871 (let ((sort-fn (cond ((functionp sort)
1873 ((setq entry (assoc (ivy-state-collection ivy-last)
1874 ivy-sort-functions-alist))
1877 (cdr (assoc t ivy-sort-functions-alist))))))
1878 (if (functionp sort-fn)
1879 (cl-sort (copy-sequence collection) sort-fn)
1882 (defun ivy--exhibit ()
1883 "Insert Ivy completions display.
1884 Should be run via minibuffer `post-command-hook'."
1885 (when (memq 'ivy--exhibit post-command-hook)
1886 (let ((inhibit-field-text-motion nil))
1887 (constrain-to-field nil (point-max)))
1888 (setq ivy-text (ivy--input))
1889 (if (ivy-state-dynamic-collection ivy-last)
1890 ;; while-no-input would cause annoying
1891 ;; "Waiting for process to die...done" message interruptions
1892 (let ((inhibit-message t))
1893 (unless (equal ivy--old-text ivy-text)
1895 (setq ivy--all-candidates
1897 (funcall (ivy-state-collection ivy-last) ivy-text)))
1898 (setq ivy--old-text ivy-text)))
1899 (when ivy--all-candidates
1900 (ivy--insert-minibuffer
1901 (ivy--format ivy--all-candidates))))
1902 (cond (ivy--directory
1903 (if (string-match "/\\'" ivy-text)
1904 (if (member ivy-text ivy--all-candidates)
1905 (ivy--cd (expand-file-name ivy-text ivy--directory))
1906 (when (string-match "//\\'" ivy-text)
1907 (if (and default-directory
1908 (string-match "\\`[[:alpha:]]:/" default-directory))
1909 (ivy--cd (match-string 0 default-directory))
1911 (when (string-match "[[:alpha:]]:/$" ivy-text)
1912 (let ((drive-root (match-string 0 ivy-text)))
1913 (when (file-exists-p drive-root)
1914 (ivy--cd drive-root)))))
1915 (if (string-match "\\`~\\'" ivy-text)
1916 (ivy--cd (expand-file-name "~/")))))
1917 ((eq (ivy-state-collection ivy-last) 'internal-complete-buffer)
1918 (when (or (and (string-match "\\` " ivy-text)
1919 (not (string-match "\\` " ivy--old-text)))
1920 (and (string-match "\\` " ivy--old-text)
1921 (not (string-match "\\` " ivy-text))))
1922 (setq ivy--all-candidates
1923 (if (and (> (length ivy-text) 0)
1924 (eq (aref ivy-text 0)
1926 (ivy--buffer-list " ")
1927 (ivy--buffer-list "" ivy-use-virtual-buffers)))
1928 (setq ivy--old-re nil))))
1929 (ivy--insert-minibuffer
1930 (with-current-buffer (ivy-state-buffer ivy-last)
1932 (ivy--filter ivy-text ivy--all-candidates))))
1933 (setq ivy--old-text ivy-text))))
1935 (defun ivy--insert-minibuffer (text)
1936 "Insert TEXT into minibuffer with appropriate cleanup."
1937 (let ((resize-mini-windows nil)
1938 (update-fn (ivy-state-update-fn ivy-last))
1942 (funcall update-fn))
1943 (ivy--insert-prompt)
1944 ;; Do nothing if while-no-input was aborted.
1945 (when (stringp text)
1946 (let ((buffer-undo-list t))
1950 (when (display-graphic-p)
1951 (ivy--resize-minibuffer-to-fit))))
1953 (defun ivy--resize-minibuffer-to-fit ()
1954 "Resize the minibuffer window size to fit the text in the minibuffer."
1955 (unless (frame-root-window-p (minibuffer-window))
1956 (with-selected-window (minibuffer-window)
1957 (if (fboundp 'window-text-pixel-size)
1958 (let ((text-height (cdr (window-text-pixel-size)))
1959 (body-height (window-body-height nil t)))
1960 (when (> text-height body-height)
1961 ;; Note: the size increment needs to be at least frame-char-height,
1962 ;; otherwise resizing won't do anything.
1963 (let ((delta (max (- text-height body-height) (frame-char-height))))
1964 (window-resize nil delta nil t t))))
1965 (let ((text-height (count-screen-lines))
1966 (body-height (window-body-height)))
1967 (when (> text-height body-height)
1968 (window-resize nil (- text-height body-height) nil t)))))))
1970 (declare-function colir-blend-face-background "ext:colir")
1972 (defun ivy--add-face (str face)
1973 "Propertize STR with FACE.
1974 `font-lock-append-text-property' is used, since it's better than
1975 `propertize' or `add-face-text-property' in this case."
1979 (colir-blend-face-background 0 (length str) face str)
1980 (let ((foreground (face-foreground face)))
1982 (add-face-text-property
1984 `(:foreground ,foreground)
1989 (font-lock-append-text-property 0 (length str) 'face face str))))
1992 (declare-function flx-make-string-cache "ext:flx")
1993 (declare-function flx-score "ext:flx")
1995 (defvar ivy--flx-cache nil)
1997 (eval-after-load 'flx
1998 '(setq ivy--flx-cache (flx-make-string-cache)))
2000 (defun ivy-toggle-case-fold ()
2001 "Toggle the case folding between nil and auto.
2002 In any completion session, the case folding starts in auto:
2004 - when the input is all lower case, `case-fold-search' is t
2007 You can toggle this to make `case-fold-search' nil regardless of input."
2009 (setq ivy-case-fold-search
2010 (if ivy-case-fold-search
2013 ;; reset cache so that the candidate list updates
2014 (setq ivy--old-re nil))
2016 (defun ivy--re-filter (re candidates)
2017 "Return all RE matching CANDIDATES.
2018 RE is a list of cons cells, with a regexp car and a boolean cdr.
2019 When the cdr is t, the car must match.
2020 Otherwise, the car must not match."
2021 (let ((re-list (if (stringp re) (list (cons re t)) re))
2023 (dolist (re re-list)
2030 (let ((re-str (car re)))
2031 (lambda (x) (string-match re-str x)))
2035 (defun ivy--filter (name candidates)
2036 "Return all items that match NAME in CANDIDATES.
2037 CANDIDATES are assumed to be static."
2038 (let ((re (funcall ivy--regex-function name)))
2039 (if (and (equal re ivy--old-re)
2041 ;; quick caching for "C-n", "C-p" etc.
2043 (let* ((re-str (if (listp re) (caar re) re))
2044 (matcher (ivy-state-matcher ivy-last))
2046 (and ivy-case-fold-search
2047 (string= name (downcase name))))
2050 (funcall matcher re candidates))
2053 (stringp ivy--old-re)
2054 (not (string-match "\\\\" ivy--old-re))
2055 (not (equal ivy--old-re ""))
2057 (if (string-match "\\\\)\\'" ivy--old-re)
2058 (substring ivy--old-re 0 -2)
2064 (lambda (x) (string-match re x))
2067 (ivy--re-filter re candidates)))))
2068 (ivy--recompute-index name re-str cands)
2070 (if (eq ivy--regex-function 'ivy--regex-ignore-order)
2075 (setq ivy--old-cands (ivy--sort name cands))))))
2077 (defun ivy--set-candidates (x)
2078 "Update `ivy--all-candidates' with X."
2080 (dolist (source ivy--extra-candidates)
2081 (if (equal source '(original-source))
2084 (setq res (append x res)))
2085 (setq ivy--old-re nil)
2087 (ivy--filter ivy-text (cadr source))
2089 (setq ivy--all-candidates res)))
2091 (defcustom ivy-sort-matches-functions-alist '((t . nil))
2092 "An alist of functions for sorting matching candidates.
2094 Unlike `ivy-sort-functions-alist', which is used to sort the
2095 whole collection only once, this alist of functions are used to
2096 sort only matching candidates after each change in input.
2098 The alist KEY is either a collection function or t to match
2099 previously unmatched collection functions.
2101 The alist VAL is a sorting function with the signature of
2102 `ivy--prefix-sort'."
2105 (const :tag "Fall-through" t)
2106 (symbol :tag "Collection"))
2109 (const :tag "Don't sort" nil)
2110 (const :tag "Put prefix matches ahead" 'ivy--prefix-sort)
2111 (function :tag "Custom sort function"))))
2113 (defun ivy--sort-files-by-date (_name candidates)
2114 "Re-soft CANDIDATES according to file modification date."
2115 (let ((default-directory ivy--directory))
2116 (cl-sort (copy-sequence candidates)
2119 (nth 5 (file-attributes f2))
2120 (nth 5 (file-attributes f1)))))))
2122 (defun ivy--sort (name candidates)
2123 "Re-sort CANDIDATES by NAME.
2124 All CANDIDATES are assumed to match NAME."
2125 (let ((key (or (ivy-state-caller ivy-last)
2126 (when (functionp (ivy-state-collection ivy-last))
2127 (ivy-state-collection ivy-last))))
2129 (cond ((and (require 'flx nil 'noerror)
2130 (eq ivy--regex-function 'ivy--regex-fuzzy))
2131 (ivy--flx-sort name candidates))
2132 ((setq fun (cdr (or (assoc key ivy-sort-matches-functions-alist)
2133 (assoc t ivy-sort-matches-functions-alist))))
2134 (funcall fun name candidates))
2138 (defun ivy--prefix-sort (name candidates)
2139 "Re-sort CANDIDATES.
2140 Prefix matches to NAME are put ahead of the list."
2141 (if (or (string-match "^\\^" name) (string= name ""))
2143 (let ((re-prefix (concat "^" (funcall ivy--regex-function name)))
2146 (dolist (s candidates)
2147 (if (string-match re-prefix s)
2149 (push s res-noprefix)))
2151 (nreverse res-prefix)
2152 (nreverse res-noprefix)))))
2154 (defun ivy--recompute-index (name re-str cands)
2155 (let* ((caller (ivy-state-caller ivy-last))
2156 (func (or (and caller (cdr (assoc caller ivy-index-functions-alist)))
2157 (cdr (assoc t ivy-index-functions-alist))
2158 #'ivy-recompute-index-zero)))
2159 (unless (eq this-command 'ivy-resume)
2162 (cl-position (if (and (> (length name) 0)
2163 (eq ?^ (aref name 0)))
2169 (concat re-str "/") cands
2171 (and (not (string= name ""))
2172 (not (and (require 'flx nil 'noerror)
2173 (eq ivy--regex-function 'ivy--regex-fuzzy)
2174 (< (length cands) 200)))
2176 (cl-position (nth ivy--index ivy--old-cands)
2178 (funcall func re-str cands))))
2179 (when (and (or (string= name "")
2181 (not (equal ivy--old-re "")))
2183 (or (ivy--preselect-index
2184 (ivy-state-preselect ivy-last)
2188 (defun ivy-recompute-index-swiper (_re-str cands)
2189 (let ((tail (nthcdr ivy--index ivy--old-cands))
2191 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
2193 (while (and tail (null idx))
2194 ;; Compare with eq to handle equal duplicates in cands
2195 (setq idx (cl-position (pop tail) cands)))
2198 (1- (length cands))))
2201 ;; already in ivy-state-buffer
2202 (let ((n (line-number-at-pos))
2206 (when (eq n (read (get-text-property 0 'display c)))
2211 (defun ivy-recompute-index-swiper-async (_re-str cands)
2212 (let ((tail (nthcdr ivy--index ivy--old-cands))
2214 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
2216 (while (and tail (null idx))
2217 ;; Compare with `equal', since the collection is re-created
2218 ;; each time with `split-string'
2219 (setq idx (cl-position (pop tail) cands :test #'equal)))
2223 (defun ivy-recompute-index-zero (_re-str _cands)
2226 (defcustom ivy-minibuffer-faces
2227 '(ivy-minibuffer-match-face-1
2228 ivy-minibuffer-match-face-2
2229 ivy-minibuffer-match-face-3
2230 ivy-minibuffer-match-face-4)
2231 "List of `ivy' faces for minibuffer group matches."
2232 :type '(repeat :tag "Faces"
2234 (const ivy-minibuffer-match-face-1)
2235 (const ivy-minibuffer-match-face-2)
2236 (const ivy-minibuffer-match-face-3)
2237 (const ivy-minibuffer-match-face-4)
2238 (face :tag "Other face"))))
2240 (defvar ivy-flx-limit 200
2241 "Used to conditionally turn off flx sorting.
2243 When the amount of matching candidates exceeds this limit, then
2244 no sorting is done.")
2246 (defun ivy--flx-sort (name cands)
2247 "Sort according to closeness to string NAME the string list CANDS."
2250 (< (length cands) ivy-flx-limit))
2251 (let* ((flx-name (if (string-match "^\\^" name)
2258 (let ((score (flx-score x flx-name ivy--flx-cache)))
2262 (if cands-with-score
2264 (let ((str (copy-sequence (cdr x)))
2267 (dolist (j (cdar x))
2268 (unless (eq j (1+ last-j))
2271 (ivy-add-face-text-property
2273 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2274 ivy-minibuffer-faces)
2277 (sort cands-with-score
2279 (> (caar x) (caar y)))))
2285 (defcustom ivy-format-function 'ivy-format-function-default
2286 "Function to transform the list of candidates into a string.
2287 This string is inserted into the minibuffer."
2289 (const :tag "Default" ivy-format-function-default)
2290 (const :tag "Arrow prefix" ivy-format-function-arrow)
2291 (const :tag "Full line" ivy-format-function-line)))
2293 (defun ivy--truncate-string (str width)
2294 "Truncate STR to WIDTH."
2295 (if (> (string-width str) width)
2296 (concat (substring str 0 (min (- width 3)
2297 (- (length str) 3))) "...")
2300 (defun ivy--format-function-generic (selected-fn other-fn strs separator)
2301 "Transform CAND-PAIRS into a string for minibuffer.
2302 SELECTED-FN and OTHER-FN each take two string arguments.
2303 SEPARATOR is used to join the candidates."
2307 (let ((curr (eq (cl-incf i) ivy--index)))
2309 (funcall selected-fn str)
2310 (funcall other-fn str))))
2314 (defun ivy-format-function-default (cands)
2315 "Transform CAND-PAIRS into a string for minibuffer."
2316 (ivy--format-function-generic
2318 (ivy--add-face str 'ivy-current-match))
2323 (defun ivy-format-function-arrow (cands)
2324 "Transform CAND-PAIRS into a string for minibuffer."
2325 (ivy--format-function-generic
2327 (concat "> " (ivy--add-face str 'ivy-current-match)))
2333 (defun ivy-format-function-line (cands)
2334 "Transform CAND-PAIRS into a string for minibuffer."
2335 (ivy--format-function-generic
2337 (ivy--add-face (concat str "\n") 'ivy-current-match))
2343 (defun ivy-add-face-text-property (start end face str)
2344 (if (fboundp 'add-face-text-property)
2345 (add-face-text-property
2346 start end face nil str)
2347 (font-lock-append-text-property
2348 start end 'face face str)))
2350 (defun ivy--format-minibuffer-line (str)
2352 (str (copy-sequence str)))
2353 (cond ((eq ivy--regex-function 'ivy--regex-ignore-order)
2354 (when (consp ivy--old-re)
2356 (dolist (re ivy--old-re)
2357 (when (string-match (car re) str)
2358 (ivy-add-face-text-property
2359 (match-beginning 0) (match-end 0)
2360 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2361 ivy-minibuffer-faces)
2364 ((and (eq ivy-display-style 'fancy)
2365 (not (eq ivy--regex-function 'ivy--regex-fuzzy)))
2367 (setq ivy--old-re (funcall ivy--regex-function ivy-text)))
2368 (while (and (string-match ivy--old-re str start)
2369 (> (- (match-end 0) (match-beginning 0)) 0))
2370 (setq start (match-end 0))
2372 (while (<= i ivy--subexps)
2374 (cond ((zerop ivy--subexps)
2375 (cadr ivy-minibuffer-faces))
2377 (car ivy-minibuffer-faces))
2379 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2380 ivy-minibuffer-faces)))))
2381 (ivy-add-face-text-property
2382 (match-beginning i) (match-end i)
2387 (defun ivy--format (cands)
2388 "Return a string for CANDS suitable for display in the minibuffer.
2389 CANDS is a list of strings."
2390 (setq ivy--length (length cands))
2391 (when (>= ivy--index ivy--length)
2392 (setq ivy--index (max (1- ivy--length) 0)))
2394 (setq ivy--current "")
2395 (let* ((half-height (/ ivy-height 2))
2396 (start (max 0 (- ivy--index half-height)))
2397 (end (min (+ start (1- ivy-height)) ivy--length))
2398 (start (max 0 (min start (- end (1- ivy-height)))))
2399 (cands (cl-subseq cands start end))
2400 (index (- ivy--index start))
2402 (cond (ivy--directory
2403 (setq cands (mapcar (lambda (x)
2404 (if (string-match-p "/\\'" x)
2405 (propertize x 'face 'ivy-subdir)
2408 ((eq (ivy-state-collection ivy-last) 'internal-complete-buffer)
2409 (setq cands (mapcar (lambda (x)
2410 (let ((b (get-buffer x)))
2412 (buffer-file-name b)
2413 (buffer-modified-p b))
2414 (propertize x 'face 'ivy-modified-buffer)
2417 (setq ivy--current (copy-sequence (nth index cands)))
2418 (when (setq transformer-fn (ivy-state-display-transformer-fn ivy-last))
2420 (setq cands (mapcar transformer-fn cands))))
2421 (let* ((ivy--index index)
2423 #'ivy--format-minibuffer-line
2425 (res (concat "\n" (funcall ivy-format-function cands))))
2426 (put-text-property 0 (length res) 'read-only nil res)
2429 (defvar ivy--virtual-buffers nil
2430 "Store the virtual buffers alist.")
2432 (defvar recentf-list)
2434 (defcustom ivy-virtual-abbreviate 'name
2435 "The mode of abbreviation for virtual buffer names."
2437 (const :tag "Only name" name)
2438 (const :tag "Full path" full)
2439 ;; eventually, uniquify
2442 (defun ivy--virtual-buffers ()
2443 "Adapted from `ido-add-virtual-buffers-to-list'."
2444 (unless recentf-mode
2446 (let ((bookmarks (and (boundp 'bookmark-alist)
2448 virtual-buffers name)
2449 (dolist (head (append
2451 (delete " - no file -"
2452 (delq nil (mapcar (lambda (bookmark)
2453 (cdr (assoc 'filename bookmark)))
2456 (if (eq ivy-virtual-abbreviate 'name)
2457 (file-name-nondirectory head)
2458 (expand-file-name head)))
2459 (when (equal name "")
2460 (setq name (file-name-nondirectory (directory-file-name head))))
2461 (when (equal name "")
2463 (and (not (equal name ""))
2464 (null (get-file-buffer head))
2465 (not (assoc name virtual-buffers))
2466 (push (cons name head) virtual-buffers)))
2467 (when virtual-buffers
2468 (dolist (comp virtual-buffers)
2469 (put-text-property 0 (length (car comp))
2472 (setq ivy--virtual-buffers (nreverse virtual-buffers))
2473 (mapcar #'car ivy--virtual-buffers))))
2475 (defcustom ivy-ignore-buffers nil
2476 "List of regexps matching buffer names to ignore."
2477 :type '(repeat regexp))
2479 (defun ivy--buffer-list (str &optional virtual)
2480 "Return the buffers that match STR.
2481 When VIRTUAL is non-nil, add virtual buffers."
2486 (if (with-current-buffer x
2488 (abbreviate-file-name default-directory)))
2489 (propertize x 'face 'ivy-remote)
2491 (all-completions str 'internal-complete-buffer))
2493 (ivy--virtual-buffers)))))
2495 (defun ivy--switch-buffer-action (buffer)
2497 BUFFER may be a string or nil."
2499 (if (zerop (length buffer))
2501 ivy-text nil 'force-same-window)
2502 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2504 (not (get-buffer buffer)))
2505 (find-file (cdr virtual))
2507 buffer nil 'force-same-window))))))
2509 (defun ivy--switch-buffer-other-window-action (buffer)
2510 "Switch to BUFFER in other window.
2511 BUFFER may be a string or nil."
2512 (if (zerop (length buffer))
2513 (switch-to-buffer-other-window ivy-text)
2514 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2516 (not (get-buffer buffer)))
2517 (find-file-other-window (cdr virtual))
2518 (switch-to-buffer-other-window buffer)))))
2520 (defun ivy--rename-buffer-action (buffer)
2522 (let ((new-name (read-string "Rename buffer (to new name): ")))
2523 (with-current-buffer buffer
2524 (rename-buffer new-name))))
2526 (defvar ivy-switch-buffer-map (make-sparse-keymap))
2533 (ivy--reset-state ivy-last))
2536 ivy--switch-buffer-other-window-action
2539 ivy--rename-buffer-action
2542 (defun ivy--switch-buffer-matcher (regexp candidates)
2543 "Return REGEXP-matching CANDIDATES.
2544 Skip buffers that match `ivy-ignore-buffers'."
2545 (let ((res (ivy--re-filter regexp candidates)))
2546 (if (or (null ivy-use-ignore)
2547 (null ivy-ignore-buffers))
2553 (string-match regexp buf))
2554 ivy-ignore-buffers))
2559 (defun ivy-switch-buffer ()
2560 "Switch to another buffer."
2563 (call-interactively 'switch-to-buffer)
2564 (let ((this-command 'ivy-switch-buffer))
2565 (ivy-read "Switch to buffer: " 'internal-complete-buffer
2566 :matcher #'ivy--switch-buffer-matcher
2567 :preselect (buffer-name (other-buffer (current-buffer)))
2568 :action #'ivy--switch-buffer-action
2569 :keymap ivy-switch-buffer-map
2570 :caller 'ivy-switch-buffer))))
2573 (defun ivy-switch-buffer-other-window ()
2574 "Switch to another buffer in another window."
2576 (ivy-read "Switch to buffer in other window: " 'internal-complete-buffer
2577 :preselect (buffer-name (other-buffer (current-buffer)))
2578 :action #'ivy--switch-buffer-other-window-action
2579 :keymap ivy-switch-buffer-map
2580 :caller 'ivy-switch-buffer-other-window))
2583 (defun ivy-recentf ()
2584 "Find a file on `recentf-list'."
2586 (ivy-read "Recentf: " recentf-list
2591 :caller 'ivy-recentf))
2593 (defun ivy-yank-word ()
2594 "Pull next word from buffer into search string."
2599 (le (line-end-position)))
2603 (setq amend (buffer-substring-no-properties pt (point))))))
2605 (insert (replace-regexp-in-string " +" " " amend)))))
2607 (defun ivy-kill-ring-save ()
2608 "Store the current candidates into the kill ring.
2609 If the region is active, forward to `kill-ring-save' instead."
2611 (if (region-active-p)
2612 (call-interactively 'kill-ring-save)
2619 (defun ivy-insert-current ()
2620 "Make the current candidate into current input.
2621 Don't finish completion."
2623 (delete-minibuffer-contents)
2624 (if (and ivy--directory
2625 (string-match "/$" ivy--current))
2626 (insert (substring ivy--current 0 -1))
2627 (insert ivy--current)))
2629 (defun ivy-toggle-fuzzy ()
2630 "Toggle the re builder between `ivy--regex-fuzzy' and `ivy--regex-plus'."
2632 (setq ivy--old-re nil)
2633 (if (eq ivy--regex-function 'ivy--regex-fuzzy)
2634 (setq ivy--regex-function 'ivy--regex-plus)
2635 (setq ivy--regex-function 'ivy--regex-fuzzy)))
2637 (defun ivy-reverse-i-search ()
2638 "Enter a recursive `ivy-read' session using the current history.
2639 The selected history element will be inserted into the minibuffer."
2641 (let ((enable-recursive-minibuffers t)
2642 (history (symbol-value (ivy-state-history ivy-last)))
2644 (ivy-recursive-restore nil))
2645 (ivy-read "Reverse-i-search: "
2649 (setq ivy-last old-last))
2650 (delete-minibuffer-contents)
2651 (insert (substring-no-properties x))
2654 (defun ivy-restrict-to-matches ()
2655 "Restrict candidates to current matches and erase input."
2657 (delete-minibuffer-contents)
2658 (setq ivy--all-candidates
2659 (ivy--filter ivy-text ivy--all-candidates)))
2662 (defvar-local ivy-occur-last nil
2663 "Buffer-local value of `ivy-last'.
2664 Can't re-use `ivy-last' because using e.g. `swiper' in the same
2665 buffer would modify `ivy-last'.")
2667 (defvar ivy-occur-mode-map
2668 (let ((map (make-sparse-keymap)))
2669 (define-key map [mouse-1] 'ivy-occur-click)
2670 (define-key map (kbd "RET") 'ivy-occur-press)
2671 (define-key map (kbd "j") 'next-line)
2672 (define-key map (kbd "k") 'previous-line)
2673 (define-key map (kbd "h") 'backward-char)
2674 (define-key map (kbd "l") 'forward-char)
2675 (define-key map (kbd "g") 'ivy-occur-press)
2676 (define-key map (kbd "a") 'ivy-occur-read-action)
2677 (define-key map (kbd "o") 'ivy-occur-dispatch)
2678 (define-key map (kbd "q") 'quit-window)
2680 "Keymap for Ivy Occur mode.")
2682 (define-derived-mode ivy-occur-mode fundamental-mode "Ivy-Occur"
2683 "Major mode for output from \\[ivy-occur].
2685 \\{ivy-occur-mode-map}")
2687 (defvar ivy-occur-grep-mode-map
2688 (let ((map (copy-keymap ivy-occur-mode-map)))
2689 (define-key map (kbd "C-x C-q") 'ivy-wgrep-change-to-wgrep-mode)
2691 "Keymap for Ivy Occur Grep mode.")
2693 (define-derived-mode ivy-occur-grep-mode grep-mode "Ivy-Occur"
2694 "Major mode for output from \\[ivy-occur].
2696 \\{ivy-occur-grep-mode-map}")
2698 (defvar ivy--occurs-list nil
2699 "A list of custom occur generators per command.")
2701 (defun ivy-set-occur (cmd occur)
2702 "Assign CMD a custom OCCUR function."
2703 (setq ivy--occurs-list
2704 (plist-put ivy--occurs-list cmd occur)))
2706 (defun ivy--occur-insert-lines (cands)
2708 (add-text-properties
2712 help-echo "mouse-1: call ivy-action")
2717 "Stop completion and put the current matches into a new buffer.
2719 The new buffer remembers current action(s).
2721 While in the *ivy-occur* buffer, selecting a candidate with RET or
2722 a mouse click will call the appropriate action for that candidate.
2724 There is no limit on the number of *ivy-occur* buffers."
2726 (if (not (window-minibuffer-p))
2727 (user-error "No completion session is active")
2728 (let* ((caller (ivy-state-caller ivy-last))
2729 (occur-fn (plist-get ivy--occurs-list caller))
2731 (generate-new-buffer
2732 (format "*ivy-occur%s \"%s\"*"
2734 (concat " " (prin1-to-string caller))
2737 (with-current-buffer buffer
2738 (let ((inhibit-read-only t))
2743 (insert (format "%d candidates:\n" (length ivy--old-cands)))
2744 (ivy--occur-insert-lines
2746 (lambda (cand) (concat " " cand))
2748 (setf (ivy-state-text ivy-last) ivy-text)
2749 (setq ivy-occur-last ivy-last)
2750 (setq-local ivy--directory ivy--directory))
2751 (ivy-exit-with-action
2752 `(lambda (_) (pop-to-buffer ,buffer))))))
2754 (declare-function wgrep-change-to-wgrep-mode "ext:wgrep")
2756 (defun ivy-wgrep-change-to-wgrep-mode ()
2757 "Forward to `wgrep-change-to-wgrep-mode'."
2759 (if (require 'wgrep nil 'noerror)
2760 (wgrep-change-to-wgrep-mode)
2761 (error "Package wgrep isn't installed")))
2763 (defun ivy-occur-read-action ()
2764 "Select one of the available actions as the current one."
2766 (let ((ivy-last ivy-occur-last))
2769 (defun ivy-occur-dispatch ()
2770 "Call one of the available actions on the current item."
2772 (let* ((state-action (ivy-state-action ivy-occur-last))
2773 (actions (if (symbolp state-action)
2775 (copy-sequence state-action))))
2778 (ivy-occur-read-action)
2780 (setf (ivy-state-action ivy-occur-last) actions))))
2782 (defun ivy-occur-click (event)
2783 "Execute action for the current candidate.
2784 EVENT gives the mouse position."
2786 (let ((window (posn-window (event-end event)))
2787 (pos (posn-point (event-end event))))
2788 (with-current-buffer (window-buffer window)
2790 (ivy-occur-press))))
2792 (declare-function swiper--cleanup "swiper")
2793 (declare-function swiper--add-overlays "swiper")
2795 (defun ivy-occur-press ()
2796 "Execute action for the current candidate."
2799 (when (save-excursion
2801 (looking-at "\\(?:./\\| \\)\\(.*\\)$"))
2802 (let* ((ivy-last ivy-occur-last)
2803 (ivy-text (ivy-state-text ivy-last))
2804 (str (buffer-substring
2807 (coll (ivy-state-collection ivy-last))
2808 (action (ivy--get-action ivy-last))
2812 (if (and (consp coll)
2814 (cdr (assoc str coll))
2816 (if (memq (ivy-state-caller ivy-last)
2817 '(swiper counsel-git-grep))
2818 (with-current-buffer (window-buffer (selected-window))
2820 (swiper--add-overlays
2821 (ivy--regex ivy-text)
2822 (line-beginning-position)
2825 (run-at-time 0.5 nil 'swiper--cleanup))
2826 (pulse-momentary-highlight-one-line (point)))))))
2828 (defvar ivy-help-file (let ((default-directory
2830 (file-name-directory load-file-name)
2831 default-directory)))
2832 (if (file-exists-p "ivy-help.org")
2833 (expand-file-name "ivy-help.org")
2834 (if (file-exists-p "doc/ivy-help.org")
2835 (expand-file-name "doc/ivy-help.org"))))
2836 "The file for `ivy-help'.")
2841 (let ((buf (get-buffer "*Ivy Help*")))
2843 (setq buf (get-buffer-create "*Ivy Help*"))
2844 (with-current-buffer buf
2845 (insert-file-contents ivy-help-file)
2848 (goto-char (point-min))))
2849 (if (eq this-command 'ivy-help)
2850 (switch-to-buffer buf)
2852 (pop-to-buffer buf)))
2854 (goto-char (point-min))))
2858 ;;; ivy.el ends here