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.")
112 '((t :inherit font-lock-builtin-face))
113 "Face used by Ivy for displaying keys in `ivy-read-action'.")
115 (setcdr (assoc load-file-name custom-current-group-alist) 'ivy)
117 (defcustom ivy-height 10
118 "Number of lines for the minibuffer window."
121 (defcustom ivy-count-format "%-4d "
122 "The style to use for displaying the current candidate count for `ivy-read'.
123 Set this to \"\" to suppress the count visibility.
124 Set this to \"(%d/%d) \" to display both the index and the count."
126 (const :tag "Count disabled" "")
127 (const :tag "Count matches" "%-4d ")
128 (const :tag "Count matches and show current match" "(%d/%d) ")
131 (defcustom ivy-add-newline-after-prompt nil
132 "When non-nil, add a newline after the `ivy-read' prompt."
135 (defcustom ivy-wrap nil
136 "When non-nil, wrap around after the first and the last candidate."
139 (defcustom ivy-display-style (unless (version< emacs-version "24.5") 'fancy)
140 "The style for formatting the minibuffer.
142 By default, the matched strings are copied as is.
144 The fancy display style highlights matching parts of the regexp,
145 a behavior similar to `swiper'.
147 This setting depends on `add-face-text-property' - a C function
148 available as of Emacs 24.5. Fancy style will render poorly in
149 earlier versions of Emacs."
151 (const :tag "Plain" nil)
152 (const :tag "Fancy" fancy)))
154 (defcustom ivy-on-del-error-function 'minibuffer-keyboard-quit
155 "The handler for when `ivy-backward-delete-char' throws.
156 Usually a quick exit out of the minibuffer."
159 (defcustom ivy-extra-directories '("../" "./")
160 "Add this to the front of the list when completing file names.
161 Only \"./\" and \"../\" apply here. They appear in reverse order."
162 :type '(repeat :tag "Dirs"
164 (const :tag "Parent Directory" "../")
165 (const :tag "Current Directory" "./"))))
167 (defcustom ivy-use-virtual-buffers nil
168 "When non-nil, add `recentf-mode' and bookmarks to `ivy-switch-buffer'."
171 (defvar ivy--actions-list nil
172 "A list of extra actions per command.")
174 (defun ivy-set-actions (cmd actions)
175 "Set CMD extra exit points to ACTIONS."
176 (setq ivy--actions-list
177 (plist-put ivy--actions-list cmd actions)))
179 (defvar ivy--display-transformers-list nil
180 "A list of str->str transformers per command.")
182 (defun ivy-set-display-transformer (cmd transformer)
183 "Set CMD a displayed candidate TRANSFORMER.
185 It's a lambda that takes a string one of the candidates in the
186 collection and returns a string for display, the same candidate
187 plus some extra information.
189 This lambda is called only on the `ivy-height' candidates that
190 are about to be displayed, not on the whole collection."
191 (setq ivy--display-transformers-list
192 (plist-put ivy--display-transformers-list cmd transformer)))
194 (defvar ivy--sources-list nil
195 "A list of extra sources per command.")
197 (defun ivy-set-sources (cmd sources)
198 "Attach to CMD a list of extra SOURCES.
200 Each static source is a function that takes no argument and
201 returns a list of strings.
203 The '(original-source) determines the position of the original
206 Extra dynamic sources aren't supported yet.
210 (defun small-recentf ()
211 (cl-subseq recentf-list 0 20))
218 (setq ivy--sources-list
219 (plist-put ivy--sources-list cmd sources)))
223 (defvar ivy-minibuffer-map
224 (let ((map (make-sparse-keymap)))
225 (define-key map (kbd "C-m") 'ivy-done)
226 (define-key map (kbd "C-M-m") 'ivy-call)
227 (define-key map (kbd "C-j") 'ivy-alt-done)
228 (define-key map (kbd "C-M-j") 'ivy-immediate-done)
229 (define-key map (kbd "TAB") 'ivy-partial-or-done)
230 (define-key map [remap next-line] 'ivy-next-line)
231 (define-key map [remap previous-line] 'ivy-previous-line)
232 (define-key map (kbd "C-s") 'ivy-next-line-or-history)
233 (define-key map (kbd "C-r") 'ivy-reverse-i-search)
234 (define-key map (kbd "SPC") 'self-insert-command)
235 (define-key map [remap delete-backward-char] 'ivy-backward-delete-char)
236 (define-key map [remap backward-kill-word] 'ivy-backward-kill-word)
237 (define-key map [remap delete-char] 'ivy-delete-char)
238 (define-key map [remap forward-char] 'ivy-forward-char)
239 (define-key map [remap kill-word] 'ivy-kill-word)
240 (define-key map [remap beginning-of-buffer] 'ivy-beginning-of-buffer)
241 (define-key map [remap end-of-buffer] 'ivy-end-of-buffer)
242 (define-key map (kbd "M-n") 'ivy-next-history-element)
243 (define-key map (kbd "M-p") 'ivy-previous-history-element)
244 (define-key map (kbd "C-g") 'minibuffer-keyboard-quit)
245 (define-key map [remap scroll-up-command] 'ivy-scroll-up-command)
246 (define-key map [remap scroll-down-command] 'ivy-scroll-down-command)
247 (define-key map (kbd "C-M-n") 'ivy-next-line-and-call)
248 (define-key map (kbd "C-M-p") 'ivy-previous-line-and-call)
249 (define-key map (kbd "M-q") 'ivy-toggle-regexp-quote)
250 (define-key map (kbd "M-j") 'ivy-yank-word)
251 (define-key map (kbd "M-i") 'ivy-insert-current)
252 (define-key map (kbd "C-o") 'hydra-ivy/body)
253 (define-key map (kbd "M-o") 'ivy-dispatching-done)
254 (define-key map (kbd "C-M-o") 'ivy-dispatching-call)
255 (define-key map [remap kill-line] 'ivy-kill-line)
256 (define-key map (kbd "S-SPC") 'ivy-restrict-to-matches)
257 (define-key map [remap kill-ring-save] 'ivy-kill-ring-save)
258 (define-key map (kbd "C-'") 'ivy-avy)
259 (define-key map (kbd "C-M-a") 'ivy-read-action)
260 (define-key map (kbd "C-c C-o") 'ivy-occur)
261 (define-key map (kbd "C-c C-a") 'ivy-toggle-ignore)
262 (define-key map [remap describe-mode] 'ivy-help)
264 "Keymap used in the minibuffer.")
265 (autoload 'hydra-ivy/body "ivy-hydra" "" t)
268 (let ((map (make-sparse-keymap)))
269 (define-key map [remap switch-to-buffer]
271 (define-key map [remap switch-to-buffer-other-window]
272 'ivy-switch-buffer-other-window)
274 "Keymap for `ivy-mode'.")
277 (cl-defstruct ivy-state
279 predicate require-match initial-input
280 history preselect keymap update-fn sort
281 ;; The window in which `ivy-read' was called
283 ;; The buffer in which `ivy-read' was called
285 ;; The value of `ivy-text' to be used by `ivy-occur'
291 ;; When this is non-nil, call it for each input change to get new candidates
293 ;; A lambda that transforms candidates only for display
294 display-transformer-fn
297 (defvar ivy-last (make-ivy-state)
298 "The last parameters passed to `ivy-read'.
300 This should eventually become a stack so that you could use
301 `ivy-read' recursively.")
303 (defsubst ivy-set-action (action)
304 (setf (ivy-state-action ivy-last) action))
306 (defun ivy-thing-at-point ()
307 "Return a string that corresponds to the current thing at point."
309 (thing-at-point 'url)
310 (and (eq (ivy-state-collection ivy-last) 'read-file-name-internal)
311 (ffap-file-at-point))
313 (cond ((stringp (setq s (thing-at-point 'symbol)))
314 (if (string-match "\\`[`']?\\(.*?\\)'?\\'" s)
317 ((looking-at "(+\\(\\(?:\\sw\\|\\s_\\)+\\)\\_>")
318 (match-string-no-properties 1))
322 (defvar ivy-history nil
323 "History list of candidates entered in the minibuffer.
325 Maximum length of the history list is determined by the value
326 of `history-length'.")
328 (defvar ivy--directory nil
329 "Current directory when completing file names.")
331 (defvar ivy--length 0
332 "Store the amount of viable candidates.")
335 "Store the user's string as it is typed in.")
337 (defvar ivy--current ""
338 "Current candidate.")
341 "Store the index of the current candidate.")
344 "Store 'done if the completion was successfully selected.
345 Otherwise, store nil.")
347 (defvar ivy--all-candidates nil
348 "Store the candidates passed to `ivy-read'.")
350 (defvar ivy--extra-candidates '((original-source))
351 "Store candidates added by the extra sources.
353 This is an internal-use alist. Each key is a function name, or
354 original-source (which represents where the current dynamic
355 candidates should go).
357 Each value is an evaluation of the function, in case of static
358 sources. These values will subsequently be filtered on `ivy-text'.
360 This variable is set by `ivy-read' and used by `ivy--set-candidates'.")
362 (defcustom ivy-use-ignore-default t
363 "The default policy for user-configured candidate filtering."
365 (const :tag "Ignore ignored always" always)
366 (const :tag "Ignore ignored when others exist" t)
367 (const :tag "Don't ignore" nil)))
369 (defvar ivy-use-ignore t
370 "Store policy for user-configured candidate filtering.
371 This may be changed dynamically by `ivy-toggle-ignore'.
372 Use `ivy-use-ignore-default' for a permanent configuration.")
374 (defvar ivy--default nil
375 "Default initial input.")
377 (defvar ivy--prompt nil
378 "Store the format-style prompt.
379 When non-nil, it should contain at least one %d.")
381 (defvar ivy--prompt-extra ""
382 "Temporary modifications to the prompt.")
384 (defvar ivy--old-re nil
385 "Store the old regexp.")
387 (defvar ivy--old-cands nil
388 "Store the candidates matched by `ivy--old-re'.")
390 (defvar ivy--regex-function 'ivy--regex
391 "Current function for building a regex.")
393 (defvar ivy--subexps 0
394 "Number of groups in the current `ivy--regex'.")
396 (defvar ivy--full-length nil
397 "When :dynamic-collection is non-nil, this can be the total amount of candidates.")
399 (defvar ivy--old-text ""
400 "Store old `ivy-text' for dynamic completion.")
402 (defvar ivy-case-fold-search 'auto
403 "Store the current overriding `case-fold-search'.")
405 (defvar Info-current-file)
408 (unless (fboundp 'defvar-local)
409 (defmacro defvar-local (var val &optional docstring)
410 "Define VAR as a buffer-local variable with default value VAL."
411 (declare (debug defvar) (doc-string 3))
412 (list 'progn (list 'defvar var val docstring)
413 (list 'make-variable-buffer-local (list 'quote var)))))
414 (unless (fboundp 'setq-local)
415 (defmacro setq-local (var val)
416 "Set variable VAR to value VAL in current buffer."
417 (list 'set (list 'make-local-variable (list 'quote var)) val))))
419 (defmacro ivy-quit-and-run (&rest body)
420 "Quit the minibuffer and run BODY afterwards."
422 (put 'quit 'error-message "")
425 (put 'quit 'error-message "Quit")
427 (minibuffer-keyboard-quit)))
429 (defun ivy-exit-with-action (action)
430 "Quit the minibuffer and call ACTION afterwards."
434 (ivy-set-action ',(ivy-state-action ivy-last))))
435 (setq ivy-exit 'done)
438 (defmacro with-ivy-window (&rest body)
439 "Execute BODY in the window from which `ivy-read' was called."
442 `(with-selected-window (ivy--get-window ivy-last)
445 (defun ivy--done (text)
446 "Insert TEXT and exit minibuffer."
447 (if (and ivy--directory
448 (not (eq (ivy-state-history ivy-last) 'grep-files-history)))
449 (insert (setq ivy--current (expand-file-name
450 text ivy--directory)))
451 (insert (setq ivy--current text)))
452 (setq ivy-exit 'done)
457 "Exit the minibuffer with the selected candidate."
459 (delete-minibuffer-contents)
460 (cond ((or (> ivy--length 0)
461 ;; the action from `ivy-dispatching-done' may not need a
463 (eq this-command 'ivy-dispatching-done))
464 (ivy--done ivy--current))
465 ((memq (ivy-state-collection ivy-last)
466 '(read-file-name-internal internal-complete-buffer))
467 (if (or (not (eq confirm-nonexistent-file-or-buffer t))
468 (equal " (confirm)" ivy--prompt-extra))
470 (setq ivy--prompt-extra " (confirm)")
473 ((memq (ivy-state-require-match ivy-last)
474 '(nil confirm confirm-after-completion))
475 (ivy--done ivy-text))
477 (setq ivy--prompt-extra " (match required)")
481 (defvar ivy-read-action-format-function 'ivy-read-action-format-default
482 "Function used to transform the actions list into a docstring.")
484 (defun ivy-read-action-format-default (actions)
485 "Create a docstring from ACTIONS.
487 ACTIONS is a list. Each list item is a list of 3 items:
488 key (a string), cmd and doc (a string)."
490 (if (eq this-command 'ivy-read-action)
503 (defun ivy-read-action ()
504 "Change the action to one of the available ones.
506 Return nil for `minibuffer-keyboard-quit' or wrong key during the
507 selection, non-nil otherwise."
509 (let ((actions (ivy-state-action ivy-last)))
510 (if (null (ivy--actionp actions))
512 (let* ((hint (funcall ivy-read-action-format-function (cdr actions)))
513 (resize-mini-windows 'grow-only)
514 (key (string (read-key hint)))
515 (action-idx (cl-position-if
516 (lambda (x) (equal (car x) key))
518 (cond ((string= key "
\a")
521 (message "%s is not bound" key)
525 (setcar actions (1+ action-idx))
526 (ivy-set-action actions)))))))
528 (defun ivy-dispatching-done ()
529 "Select one of the available actions and call `ivy-done'."
531 (when (ivy-read-action)
534 (defun ivy-dispatching-call ()
535 "Select one of the available actions and call `ivy-call'."
537 (let ((actions (copy-sequence (ivy-state-action ivy-last))))
539 (when (ivy-read-action)
541 (ivy-set-action actions))))
543 (defun ivy-build-tramp-name (x)
544 "Reconstruct X into a path.
545 Is is a cons cell, related to `tramp-get-completion-function'."
549 (concat user "@" domain)
552 (declare-function tramp-get-completion-function "tramp")
553 (declare-function Info-find-node "info")
555 (defun ivy-alt-done (&optional arg)
556 "Exit the minibuffer with the selected candidate.
557 When ARG is t, exit with current text, ignoring the candidates."
560 (ivy-immediate-done))
562 (ivy--directory-done))
563 ((eq (ivy-state-collection ivy-last) 'Info-read-node-name-1)
564 (if (member ivy--current '("(./)" "(../)"))
566 (ivy-read "Go to file: " 'read-file-name-internal
569 (expand-file-name x ivy--directory)
575 (defun ivy--directory-done ()
576 "Handle exit from the minibuffer when completing file names."
579 ((equal ivy-text "/sudo::")
580 (setq dir (concat ivy-text ivy--directory))
585 (not (string= ivy--current "./"))
586 (setq dir (ivy-expand-file-if-directory ivy--current)))
589 ((or (and (equal ivy--directory "/")
590 (string-match "\\`[^/]+:.*:.*\\'" ivy-text))
591 (string-match "\\`/[^/]+:.*:.*\\'" ivy-text))
593 ((or (and (equal ivy--directory "/")
595 "\\`\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
598 "\\`\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
600 (setq ivy-text ivy--current))))
602 "\\`/\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
604 (let ((method (match-string 1 ivy-text))
605 (user (match-string 2 ivy-text))
606 (rest (match-string 3 ivy-text))
609 (dolist (x (tramp-get-completion-function method))
610 (setq res (append res (funcall (car x) (cadr x)))))
611 (setq res (delq nil res))
615 (setq res (cl-delete-duplicates res :test #'equal))
616 (let* ((old-ivy-last ivy-last)
617 (enable-recursive-minibuffers t)
618 (host (ivy-read "user@host: "
619 (mapcar #'ivy-build-tramp-name res)
620 :initial-input rest)))
621 (setq ivy-last old-ivy-last)
623 (setq ivy--directory "/")
624 (ivy--cd (concat "/" method ":" host ":"))))))
628 (defun ivy-expand-file-if-directory (file-name)
629 "Expand FILE-NAME as directory.
630 When this directory doesn't exist, return nil."
631 (when (stringp file-name)
633 ;; Ignore host name must not match method "ssh"
635 (file-name-as-directory
636 (expand-file-name file-name ivy--directory)))))
637 (when (and full-name (file-directory-p full-name))
640 (defcustom ivy-tab-space nil
641 "When non-nil, `ivy-partial-or-done' should insert a space."
644 (defun ivy-partial-or-done ()
645 "Complete the minibuffer text as much as possible.
646 If the text hasn't changed as a result, forward to `ivy-alt-done'."
648 (if (and (eq (ivy-state-collection ivy-last) #'read-file-name-internal)
649 (or (and (equal ivy--directory "/")
650 (string-match "\\`[^/]+:.*\\'" ivy-text))
651 (string-match "\\`/" ivy-text)))
652 (let ((default-directory ivy--directory)
654 (minibuffer-complete)
655 (setq ivy-text (ivy--input))
656 (when (setq dir (ivy-expand-file-if-directory ivy-text))
659 (when (or (eq this-command last-command)
663 (defun ivy-partial ()
664 "Complete the minibuffer text as much as possible."
666 (let* ((parts (or (split-string ivy-text " " t) (list "")))
667 (postfix (car (last parts)))
668 (completion-ignore-case t)
669 (startp (string-match "^\\^" postfix))
670 (new (try-completion (if startp
671 (substring postfix 1)
673 (mapcar (lambda (str)
674 (let ((i (string-match postfix str)))
678 (cond ((eq new t) nil)
679 ((string= new ivy-text) nil)
681 (delete-region (minibuffer-prompt-end) (point-max))
686 (insert (mapconcat #'identity parts " ")
687 (if ivy-tab-space " " ""))
690 (defun ivy-immediate-done ()
691 "Exit the minibuffer with the current input."
693 (delete-minibuffer-contents)
694 (insert (setq ivy--current
696 (expand-file-name ivy-text ivy--directory)
698 (setq ivy-exit 'done)
703 "Resume the last completion session."
705 (if (null (ivy-state-action ivy-last))
706 (user-error "The last session isn't compatible with `ivy-resume'")
707 (when (eq (ivy-state-caller ivy-last) 'swiper)
708 (switch-to-buffer (ivy-state-buffer ivy-last)))
709 (with-current-buffer (ivy-state-buffer ivy-last)
711 (ivy-state-prompt ivy-last)
712 (ivy-state-collection ivy-last)
713 :predicate (ivy-state-predicate ivy-last)
714 :require-match (ivy-state-require-match ivy-last)
715 :initial-input ivy-text
716 :history (ivy-state-history ivy-last)
717 :preselect (unless (eq (ivy-state-collection ivy-last)
718 'read-file-name-internal)
720 :keymap (ivy-state-keymap ivy-last)
721 :update-fn (ivy-state-update-fn ivy-last)
722 :sort (ivy-state-sort ivy-last)
723 :action (ivy-state-action ivy-last)
724 :unwind (ivy-state-unwind ivy-last)
725 :re-builder (ivy-state-re-builder ivy-last)
726 :matcher (ivy-state-matcher ivy-last)
727 :dynamic-collection (ivy-state-dynamic-collection ivy-last)
728 :caller (ivy-state-caller ivy-last)))))
730 (defvar-local ivy-calling nil
731 "When non-nil, call the current action when `ivy--index' changes.")
733 (defun ivy-set-index (index)
734 "Set `ivy--index' to INDEX."
735 (setq ivy--index index)
740 (defun ivy-beginning-of-buffer ()
741 "Select the first completion candidate."
745 (defun ivy-end-of-buffer ()
746 "Select the last completion candidate."
748 (ivy-set-index (1- ivy--length)))
750 (defun ivy-scroll-up-command ()
751 "Scroll the candidates upward by the minibuffer height."
753 (ivy-set-index (min (1- (+ ivy--index ivy-height))
756 (defun ivy-scroll-down-command ()
757 "Scroll the candidates downward by the minibuffer height."
759 (ivy-set-index (max (1+ (- ivy--index ivy-height))
762 (defun ivy-minibuffer-grow ()
763 "Grow the minibuffer window by 1 line."
765 (setq-local max-mini-window-height
766 (cl-incf ivy-height)))
768 (defun ivy-minibuffer-shrink ()
769 "Shrink the minibuffer window by 1 line."
771 (unless (<= ivy-height 2)
772 (setq-local max-mini-window-height
773 (cl-decf ivy-height))
774 (window-resize (selected-window) -1)))
776 (defun ivy-next-line (&optional arg)
777 "Move cursor vertically down ARG candidates."
779 (setq arg (or arg 1))
780 (let ((index (+ ivy--index arg)))
781 (if (> index (1- ivy--length))
783 (ivy-beginning-of-buffer)
784 (ivy-set-index (1- ivy--length)))
785 (ivy-set-index index))))
787 (defun ivy-next-line-or-history (&optional arg)
788 "Move cursor vertically down ARG candidates.
789 If the input is empty, select the previous history element instead."
791 (if (string= ivy-text "")
792 (ivy-previous-history-element 1)
793 (ivy-next-line arg)))
795 (defun ivy-previous-line (&optional arg)
796 "Move cursor vertically up ARG candidates."
798 (setq arg (or arg 1))
799 (let ((index (- ivy--index arg)))
804 (ivy-set-index index))))
806 (defun ivy-previous-line-or-history (arg)
807 "Move cursor vertically up ARG candidates.
808 If the input is empty, select the previous history element instead."
810 (when (string= ivy-text "")
811 (ivy-previous-history-element 1))
812 (ivy-previous-line arg))
814 (defun ivy-toggle-calling ()
815 "Flip `ivy-calling'."
817 (when (setq ivy-calling (not ivy-calling))
820 (defun ivy-toggle-ignore ()
821 "Toggle user-configured candidate filtering."
826 (or ivy-use-ignore-default t)))
828 (setq ivy--old-cands nil))
830 (defun ivy--get-action (state)
831 "Get the action function from STATE."
832 (let ((action (ivy-state-action state)))
834 (if (functionp action)
836 (cadr (nth (car action) action))))))
838 (defun ivy--get-window (state)
839 "Get the window from STATE."
840 (if (ivy-state-p state)
841 (let ((window (ivy-state-window state)))
842 (if (window-live-p window)
844 (if (= (length (window-list)) 1)
849 (defun ivy--actionp (x)
850 "Return non-nil when X is a list of actions."
851 (and x (listp x) (not (eq (car x) 'closure))))
853 (defun ivy-next-action ()
854 "When the current action is a list, scroll it forwards."
856 (let ((action (ivy-state-action ivy-last)))
857 (when (ivy--actionp action)
858 (unless (>= (car action) (1- (length action)))
859 (cl-incf (car action))))))
861 (defun ivy-prev-action ()
862 "When the current action is a list, scroll it backwards."
864 (let ((action (ivy-state-action ivy-last)))
865 (when (ivy--actionp action)
866 (unless (<= (car action) 1)
867 (cl-decf (car action))))))
869 (defun ivy-action-name ()
870 "Return the name associated with the current action."
871 (let ((action (ivy-state-action ivy-last)))
872 (if (ivy--actionp action)
876 (nth 2 (nth (car action) action)))
879 (defvar ivy-inhibit-action nil
880 "When non-nil, `ivy-call' does nothing.
884 (let* ((ivy-inhibit-action t)
885 (str (counsel-locate \"lispy.el\")))
886 ;; do whatever with str - the corresponding file will not be opened
890 "Call the current action without exiting completion."
892 (unless ivy-inhibit-action
893 (let ((action (ivy--get-action ivy-last)))
895 (let* ((collection (ivy-state-collection ivy-last))
896 (x (if (and (consp collection)
897 (consp (car collection)))
898 (cdr (assoc ivy--current collection))
899 (if (equal ivy--current "")
902 (prog1 (funcall action x)
903 (unless (or (eq ivy-exit 'done)
904 (equal (selected-window)
905 (active-minibuffer-window))
906 (null (active-minibuffer-window)))
907 (select-window (active-minibuffer-window)))))))))
909 (defun ivy-next-line-and-call (&optional arg)
910 "Move cursor vertically down ARG candidates.
911 Call the permanent action if possible."
917 (defun ivy-previous-line-and-call (&optional arg)
918 "Move cursor vertically down ARG candidates.
919 Call the permanent action if possible."
921 (ivy-previous-line arg)
925 (defun ivy-previous-history-element (arg)
926 "Forward to `previous-history-element' with ARG."
928 (previous-history-element arg)
931 (ivy--maybe-scroll-history))
933 (defun ivy-next-history-element (arg)
934 "Forward to `next-history-element' with ARG."
936 (if (and (= minibuffer-history-position 0)
939 (insert ivy--default)
940 (when (and (with-ivy-window (derived-mode-p 'prog-mode))
941 (eq (ivy-state-caller ivy-last) 'swiper)
942 (not (file-exists-p ivy--default))
943 (not (ffap-url-p ivy--default))
944 (not (ivy-state-dynamic-collection ivy-last))
945 (> (point) (minibuffer-prompt-end)))
948 (goto-char (minibuffer-prompt-end))
950 (forward-char (+ 2 (length ivy--default)))))
951 (next-history-element arg))
954 (ivy--maybe-scroll-history))
956 (defvar ivy-ffap-url-functions nil
957 "List of functions that check if the point is on a URL.")
959 (defun ivy--cd-maybe ()
960 "Check if the current input points to a different directory.
961 If so, move to that directory, while keeping only the file name."
963 (let ((input (ivy--input))
965 (if (setq url (or (ffap-url-p input)
970 ivy-ffap-url-functions
971 :initial-value nil))))
972 (ivy-exit-with-action
974 (funcall ffap-url-fetcher url)))
975 (setq input (expand-file-name input))
976 (let ((file (file-name-nondirectory input))
977 (dir (expand-file-name (file-name-directory input))))
978 (if (string= dir ivy--directory)
980 (delete-minibuffer-contents)
985 (defun ivy--maybe-scroll-history ()
986 "If the selected history element has an index, scroll there."
987 (let ((idx (ignore-errors
989 (minibuffer-prompt-end)
993 (setq ivy--index idx))))
996 "When completing file names, move to directory DIR."
997 (if (null ivy--directory)
999 (setq ivy--old-cands nil)
1000 (setq ivy--old-re nil)
1002 (setq ivy--all-candidates
1003 (ivy--sorted-files (setq ivy--directory dir)))
1005 (delete-minibuffer-contents)))
1007 (defun ivy-backward-delete-char ()
1008 "Forward to `backward-delete-char'.
1009 On error (read-only), call `ivy-on-del-error-function'."
1011 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
1013 (ivy--cd (file-name-directory
1014 (directory-file-name
1019 (backward-delete-char 1)
1021 (when ivy-on-del-error-function
1022 (funcall ivy-on-del-error-function))))))
1024 (defun ivy-delete-char (arg)
1025 "Forward to `delete-char' ARG."
1027 (unless (= (point) (line-end-position))
1030 (defun ivy-forward-char (arg)
1031 "Forward to `forward-char' ARG."
1033 (unless (= (point) (line-end-position))
1034 (forward-char arg)))
1036 (defun ivy-kill-word (arg)
1037 "Forward to `kill-word' ARG."
1039 (unless (= (point) (line-end-position))
1042 (defun ivy-kill-line ()
1043 "Forward to `kill-line'."
1046 (kill-region (minibuffer-prompt-end) (point))
1049 (defun ivy-backward-kill-word ()
1050 "Forward to `backward-kill-word'."
1052 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
1054 (ivy--cd (file-name-directory
1055 (directory-file-name
1062 (delete-region (point) pt)))))
1064 (defvar ivy--regexp-quote 'regexp-quote
1065 "Store the regexp quoting state.")
1067 (defun ivy-toggle-regexp-quote ()
1068 "Toggle the regexp quoting."
1070 (setq ivy--old-re nil)
1071 (cl-rotatef ivy--regex-function ivy--regexp-quote))
1073 (defvar avy-all-windows)
1076 (defvar avy-keys-alist)
1078 (defvar avy-styles-alist)
1079 (declare-function avy--process "ext:avy")
1080 (declare-function avy--style-fn "ext:avy")
1082 (eval-after-load 'avy
1083 '(add-to-list 'avy-styles-alist '(ivy-avy . pre)))
1086 "Jump to one of the current ivy candidates."
1088 (unless (require 'avy nil 'noerror)
1089 (error "Package avy isn't installed"))
1090 (let* ((avy-all-windows nil)
1091 (avy-keys (or (cdr (assq 'ivy-avy avy-keys-alist))
1093 (avy-style (or (cdr (assq 'ivy-avy
1103 (goto-char (point-min))
1105 (while (< (point) (point-max))
1111 (setq avy-action #'identity)
1113 (nreverse candidates)
1114 (avy--style-fn avy-style)))))
1115 (when (numberp candidate)
1116 (ivy-set-index (- (line-number-at-pos candidate) 2))
1120 (defun ivy-sort-file-function-default (x y)
1121 "Compare two files X and Y.
1122 Prioritize directories."
1123 (if (get-text-property 0 'dirp x)
1124 (if (get-text-property 0 'dirp y)
1127 (if (get-text-property 0 'dirp y)
1131 (defcustom ivy-sort-functions-alist
1132 '((read-file-name-internal . ivy-sort-file-function-default)
1133 (internal-complete-buffer . nil)
1134 (counsel-git-grep-function . nil)
1135 (Man-goto-section . nil)
1138 "An alist of sorting functions for each collection function.
1139 Interactive functions that call completion fit in here as well.
1141 Nil means no sorting, which is useful to turn off the sorting for
1142 functions that have candidates in the natural buffer order, like
1143 `org-refile' or `Man-goto-section'.
1145 The entry associated with t is used for all fall-through cases.
1147 See also `ivy-sort-max-size'."
1151 (const :tag "Fall-through" t)
1152 (symbol :tag "Collection"))
1154 (const :tag "Plain sort" string-lessp)
1155 (const :tag "File sort" ivy-sort-file-function-default)
1156 (const :tag "No sort" nil)
1157 (function :tag "Custom function")))
1160 (defvar ivy-index-functions-alist
1161 '((swiper . ivy-recompute-index-swiper)
1162 (swiper-multi . ivy-recompute-index-swiper)
1163 (counsel-git-grep . ivy-recompute-index-swiper)
1164 (counsel-grep . ivy-recompute-index-swiper-async)
1165 (t . ivy-recompute-index-zero))
1166 "An alist of index recomputing functions for each collection function.
1167 When the input changes, the appropriate function returns an
1168 integer - the index of the matched candidate that should be
1171 (defvar ivy-re-builders-alist
1172 '((t . ivy--regex-plus))
1173 "An alist of regex building functions for each collection function.
1175 Each key is (in order of priority):
1176 1. The actual collection function, e.g. `read-file-name-internal'.
1177 2. The symbol passed by :caller into `ivy-read'.
1181 Each value is a function that should take a string and return a
1182 valid regex or a regex sequence (see below).
1184 Possible choices: `ivy--regex', `regexp-quote',
1185 `ivy--regex-plus', `ivy--regex-fuzzy'.
1187 If a function returns a list, it should format like this:
1188 '((\"matching-regexp\" . t) (\"non-matching-regexp\") ...).
1190 The matches will be filtered in a sequence, you can mix the
1191 regexps that should match and that should not match as you
1194 (defvar ivy-initial-inputs-alist
1195 '((org-refile . "^")
1196 (org-agenda-refile . "^")
1197 (org-capture-refile . "^")
1199 (counsel-describe-function . "^")
1200 (counsel-describe-variable . "^")
1203 "Command to initial input table.")
1205 (defcustom ivy-sort-max-size 30000
1206 "Sorting won't be done for collections larger than this."
1209 (defun ivy--sorted-files (dir)
1210 "Return the list of files in DIR.
1211 Directories come first."
1212 (let* ((default-directory dir)
1213 (seq (all-completions "" 'read-file-name-internal))
1217 (setq seq (delete "./" (delete "../" seq)))
1218 (when (eq (setq sort-fn (cdr (assoc 'read-file-name-internal
1219 ivy-sort-functions-alist)))
1220 #'ivy-sort-file-function-default)
1221 (setq seq (mapcar (lambda (x)
1222 (propertize x 'dirp (string-match-p "/\\'" x)))
1225 (setq seq (cl-sort seq sort-fn)))
1226 (dolist (dir ivy-extra-directories)
1230 (defvar ivy-recursive-restore t
1231 "When non-nil, restore the above state when exiting the minibuffer.
1232 This variable is let-bound to nil by functions that take care of
1233 the restoring themselves.")
1236 (cl-defun ivy-read (prompt collection
1238 predicate require-match initial-input
1239 history preselect keymap update-fn sort
1240 action unwind re-builder matcher dynamic-collection caller)
1241 "Read a string in the minibuffer, with completion.
1243 PROMPT is a format string, normally ending in a colon and a
1244 space; %d anywhere in the string is replaced by the current
1245 number of matching candidates. For the literal % character,
1246 escape it with %%. See also `ivy-count-format'.
1248 COLLECTION is either a list of strings, a function, an alist, or
1251 If INITIAL-INPUT is not nil, then insert that input in the
1252 minibuffer initially.
1254 KEYMAP is composed with `ivy-minibuffer-map'.
1256 If PRESELECT is not nil, then select the corresponding candidate
1257 out of the ones that match the INITIAL-INPUT.
1259 UPDATE-FN is called each time the current candidate(s) is changed.
1261 When SORT is t, use `ivy-sort-functions-alist' for sorting.
1263 ACTION is a lambda function to call after selecting a result. It
1264 takes a single string argument.
1266 UNWIND is a lambda function to call before exiting.
1268 RE-BUILDER is a lambda function to call to transform text into a
1271 MATCHER is to override matching.
1273 DYNAMIC-COLLECTION is a boolean to specify if the list of
1274 candidates is updated after each input by calling COLLECTION.
1276 CALLER is a symbol to uniquely identify the caller to `ivy-read'.
1277 It is used, along with COLLECTION, to determine which
1278 customizations apply to the current completion session."
1279 (let ((extra-actions (delete-dups
1280 (append (plist-get ivy--actions-list t)
1281 (plist-get ivy--actions-list this-command)
1282 (plist-get ivy--actions-list caller)))))
1285 (cond ((functionp action)
1287 ("o" ,action "default")
1291 ("o" identity "default")
1294 (delete-dups (append action extra-actions)))))))
1295 (let ((extra-sources (plist-get ivy--sources-list caller)))
1298 (setq ivy--extra-candidates nil)
1299 (dolist (source extra-sources)
1300 (cond ((equal source '(original-source))
1301 (setq ivy--extra-candidates
1302 (cons source ivy--extra-candidates)))
1303 ((null (cdr source))
1304 (setq ivy--extra-candidates
1306 (list (car source) (funcall (car source)))
1307 ivy--extra-candidates))))))
1308 (setq ivy--extra-candidates '((original-source)))))
1309 (let ((recursive-ivy-last (and (active-minibuffer-window) ivy-last))
1311 (plist-get ivy--display-transformers-list
1312 (or caller (and (functionp collection)
1317 :collection collection
1318 :predicate predicate
1319 :require-match require-match
1320 :initial-input initial-input
1322 :preselect preselect
1324 :update-fn update-fn
1327 :window (selected-window)
1328 :buffer (current-buffer)
1330 :re-builder re-builder
1332 :dynamic-collection dynamic-collection
1333 :display-transformer-fn transformer-fn
1335 (ivy--reset-state ivy-last)
1338 (minibuffer-with-setup-hook
1339 #'ivy--minibuffer-setup
1340 (let* ((hist (or history 'ivy-history))
1341 (minibuffer-completion-table collection)
1342 (minibuffer-completion-predicate predicate)
1343 (resize-mini-windows (cond
1344 ((display-graphic-p) nil)
1345 ((null resize-mini-windows) 'grow-only)
1346 (t resize-mini-windows))))
1347 (read-from-minibuffer
1349 (ivy-state-initial-input ivy-last)
1350 (make-composed-keymap keymap ivy-minibuffer-map)
1353 (when (eq ivy-exit 'done)
1354 (let ((item (if ivy--directory
1357 (unless (equal item "")
1358 (set hist (cons (propertize item 'ivy-index ivy--index)
1360 (cdr (symbol-value hist))))))))
1362 (remove-hook 'post-command-hook #'ivy--exhibit)
1363 (when (setq unwind (ivy-state-unwind ivy-last))
1365 (unless (eq ivy-exit 'done)
1366 (when recursive-ivy-last
1367 (ivy--reset-state (setq ivy-last recursive-ivy-last)))))
1369 (when (and recursive-ivy-last
1370 ivy-recursive-restore)
1371 (ivy--reset-state (setq ivy-last recursive-ivy-last))))))
1373 (defun ivy--reset-state (state)
1374 "Reset the ivy to STATE.
1375 This is useful for recursive `ivy-read'."
1376 (let ((prompt (or (ivy-state-prompt state) ""))
1377 (collection (ivy-state-collection state))
1378 (predicate (ivy-state-predicate state))
1379 (history (ivy-state-history state))
1380 (preselect (ivy-state-preselect state))
1381 (sort (ivy-state-sort state))
1382 (re-builder (ivy-state-re-builder state))
1383 (dynamic-collection (ivy-state-dynamic-collection state))
1384 (initial-input (ivy-state-initial-input state))
1385 (require-match (ivy-state-require-match state))
1386 (caller (ivy-state-caller state)))
1387 (unless initial-input
1388 (setq initial-input (cdr (assoc this-command
1389 ivy-initial-inputs-alist))))
1390 (setq ivy--directory nil)
1391 (setq ivy-case-fold-search 'auto)
1392 (setq ivy--regex-function
1394 (and (functionp collection)
1395 (cdr (assoc collection ivy-re-builders-alist)))
1397 (cdr (assoc caller ivy-re-builders-alist)))
1398 (cdr (assoc this-command ivy-re-builders-alist))
1399 (cdr (assoc t ivy-re-builders-alist))
1401 (setq ivy--subexps 0)
1402 (setq ivy--regexp-quote 'regexp-quote)
1403 (setq ivy--old-text "")
1404 (setq ivy--full-length nil)
1406 (setq ivy-calling nil)
1407 (setq ivy-use-ignore ivy-use-ignore-default)
1409 (cond ((eq collection 'Info-read-node-name-1)
1410 (if (equal Info-current-file "dir")
1412 (mapcar (lambda (x) (format "(%s)" x))
1413 (cl-delete-duplicates
1414 (all-completions "(" collection predicate)
1416 (setq coll (all-completions "" collection predicate))))
1417 ((eq collection 'read-file-name-internal)
1418 (if (and initial-input (file-directory-p initial-input))
1420 (setq ivy--directory initial-input)
1421 (setq initial-input nil))
1422 (setq ivy--directory default-directory))
1425 (let ((preselect-directory (file-name-directory preselect)))
1426 (unless (or (null preselect-directory)
1427 (string= preselect-directory
1429 (setq ivy--directory preselect-directory))
1431 (ivy-state-preselect state)
1432 (setq preselect (file-name-nondirectory preselect)))))
1433 (setq coll (ivy--sorted-files ivy--directory))
1435 (unless (or require-match
1436 (equal initial-input default-directory)
1437 (equal initial-input ""))
1438 (setq coll (cons initial-input coll)))
1439 (unless (and (ivy-state-action ivy-last)
1440 (not (equal (ivy--get-action ivy-last) 'identity)))
1441 (setq initial-input nil))))
1442 ((eq collection 'internal-complete-buffer)
1443 (setq coll (ivy--buffer-list "" ivy-use-virtual-buffers predicate)))
1445 (setq coll (funcall collection ivy-text)))
1446 ((or (functionp collection)
1447 (byte-code-function-p collection)
1448 (vectorp collection)
1449 (and (consp collection) (listp (car collection)))
1450 (hash-table-p collection)
1451 (and (listp collection) (symbolp (car collection))))
1452 (setq coll (all-completions "" collection predicate)))
1454 (setq coll collection)))
1456 (if (and (functionp collection)
1457 (setq sort-fn (assoc collection ivy-sort-functions-alist)))
1458 (when (and (setq sort-fn (cdr sort-fn))
1459 (not (eq collection 'read-file-name-internal)))
1460 (setq coll (cl-sort coll sort-fn)))
1461 (unless (eq history 'org-refile-history)
1462 (if (and (setq sort-fn (cdr (assoc t ivy-sort-functions-alist)))
1463 (<= (length coll) ivy-sort-max-size))
1464 (setq coll (cl-sort (copy-sequence coll) sort-fn))))))
1465 (setq coll (ivy--set-candidates coll))
1467 (unless (or (and require-match
1468 (not (eq collection 'internal-complete-buffer)))
1470 (let ((re (regexp-quote preselect)))
1471 (cl-find-if (lambda (x) (string-match re x))
1473 (setq coll (cons preselect coll))))
1474 (setq ivy--old-re nil)
1475 (setq ivy--old-cands nil)
1476 (when (integerp preselect)
1477 (setq ivy--old-re "")
1478 (setq ivy--index preselect))
1480 ;; Needed for anchor to work
1481 (setq ivy--old-cands coll)
1482 (setq ivy--old-cands (ivy--filter initial-input coll)))
1483 (setq ivy--all-candidates coll)
1484 (unless (integerp preselect)
1485 (setq ivy--index (or
1486 (and dynamic-collection
1489 (ivy--preselect-index
1497 (if (region-active-p)
1501 (ivy-thing-at-point)))
1503 (cond ((string-match "%.*d" prompt)
1505 ((null ivy-count-format)
1507 "`ivy-count-format' can't be nil. Set it to an empty string instead"))
1508 ((string-match "%d.*%d" ivy-count-format)
1509 (let ((w (length (number-to-string
1510 (length ivy--all-candidates))))
1511 (s (copy-sequence ivy-count-format)))
1512 (string-match "%d" s)
1514 (string-match "%d" s (match-end 0))
1515 (setq s (replace-match (format "%%-%dd" w) nil nil s))
1516 (string-match "%d" s)
1517 (concat (replace-match (format "%%%dd" w) nil nil s)
1519 ((string-match "%.*d" ivy-count-format)
1520 (concat ivy-count-format prompt))
1525 (setf (ivy-state-initial-input ivy-last) initial-input)))
1528 (defun ivy-completing-read (prompt collection
1529 &optional predicate require-match initial-input
1530 history def inherit-input-method)
1531 "Read a string in the minibuffer, with completion.
1533 This interface conforms to `completing-read' and can be used for
1534 `completing-read-function'.
1536 PROMPT is a string that normally ends in a colon and a space.
1537 COLLECTION is either a list of strings, an alist, an obarray, or a hash table.
1538 PREDICATE limits completion to a subset of COLLECTION.
1539 REQUIRE-MATCH is a boolean value. See `completing-read'.
1540 INITIAL-INPUT is a string inserted into the minibuffer initially.
1541 HISTORY is a list of previously selected inputs.
1542 DEF is the default value.
1543 INHERIT-INPUT-METHOD is currently ignored."
1544 (if (memq this-command '(tmm-menubar tmm-shortcut))
1545 (completing-read-default prompt collection
1546 predicate require-match
1547 initial-input history
1548 def inherit-input-method)
1549 ;; See the doc of `completing-read'.
1550 (when (consp history)
1551 (when (numberp (cdr history))
1552 (setq initial-input (nth (1- (cdr history))
1553 (symbol-value (car history)))))
1554 (setq history (car history)))
1555 (ivy-read (replace-regexp-in-string "%" "%%" prompt)
1557 :predicate predicate
1558 :require-match require-match
1559 :initial-input (if (consp initial-input)
1561 (if (and (stringp initial-input)
1562 (string-match "\\+" initial-input))
1563 (replace-regexp-in-string
1564 "\\+" "\\\\+" initial-input)
1566 :preselect (if (listp def) (car def) def)
1570 (let ((sort (or (assoc this-command ivy-sort-functions-alist)
1571 (assoc t ivy-sort-functions-alist))))
1576 (defvar ivy-completion-beg nil
1577 "Completion bounds start.")
1579 (defvar ivy-completion-end nil
1580 "Completion bounds end.")
1582 (defun ivy-completion-in-region-action (str)
1583 "Insert STR, erasing the previous one.
1584 The previous string is between `ivy-completion-beg' and `ivy-completion-end'."
1587 (when ivy-completion-beg
1590 ivy-completion-end))
1591 (setq ivy-completion-beg
1592 (move-marker (make-marker) (point)))
1594 (setq ivy-completion-end
1595 (move-marker (make-marker) (point))))))
1597 (defun ivy-completion-common-length (str)
1598 "Return the length of the first 'completions-common-part face in STR."
1601 (while (and (<= pos len)
1602 (let ((prop (get-text-property pos 'face str)))
1603 (not (eq 'completions-common-part
1604 (if (listp prop) (car prop) prop)))))
1605 (setq pos (1+ pos)))
1607 (or (next-single-property-change pos 'face str) len)
1610 (defun ivy-completion-in-region (start end collection &optional predicate)
1611 "An Ivy function suitable for `completion-in-region-function'."
1612 (let* ((enable-recursive-minibuffers t)
1613 (str (buffer-substring-no-properties start end))
1614 (completion-ignore-case case-fold-search)
1616 (completion-all-completions str collection predicate (- end start))))
1618 (message "No matches")
1620 (setq ivy-completion-beg (- end (ivy-completion-common-length (car comps))))
1621 (setq ivy-completion-end end)
1622 (if (null (cdr comps))
1623 (if (string= str (car comps))
1624 (message "Sole match")
1625 (setf (ivy-state-window ivy-last) (selected-window))
1626 (ivy-completion-in-region-action
1627 (substring-no-properties
1629 (let* ((w (1+ (floor (log (length comps) 10))))
1630 (ivy-count-format (if (string= ivy-count-format "")
1632 (format "%%-%dd " w)))
1633 (prompt (format "(%s): " str)))
1635 (ivy-read (if (string= ivy-count-format "")
1637 (replace-regexp-in-string "%" "%%" prompt))
1638 ;; remove 'completions-first-difference face
1639 (mapcar #'substring-no-properties comps)
1640 :predicate predicate
1641 :action #'ivy-completion-in-region-action
1645 (defcustom ivy-do-completion-in-region t
1646 "When non-nil `ivy-mode' will set `completion-in-region-function'."
1650 (define-minor-mode ivy-mode
1651 "Toggle Ivy mode on or off.
1652 Turn Ivy mode on if ARG is positive, off otherwise.
1653 Turning on Ivy mode sets `completing-read-function' to
1654 `ivy-completing-read'.
1659 Minibuffer bindings:
1660 \\{ivy-minibuffer-map}"
1663 :keymap ivy-mode-map
1667 (setq completing-read-function 'ivy-completing-read)
1668 (when ivy-do-completion-in-region
1669 (setq completion-in-region-function 'ivy-completion-in-region)))
1670 (setq completing-read-function 'completing-read-default)
1671 (setq completion-in-region-function 'completion--in-region)))
1673 (defun ivy--preselect-index (preselect candidates)
1674 "Return the index of PRESELECT in CANDIDATES."
1675 (cond ((integerp preselect)
1677 ((cl-position preselect candidates :test #'equal))
1678 ((stringp preselect)
1679 (let ((re preselect))
1682 (string-match re x))
1687 (defvar ivy--regex-hash
1688 (make-hash-table :test #'equal)
1689 "Store pre-computed regex.")
1691 (defun ivy--split (str)
1692 "Split STR into a list by single spaces.
1693 The remaining spaces stick to their left.
1694 This allows to \"quote\" N spaces by inputting N+1 spaces."
1695 (let ((len (length str))
1700 (while (and (string-match " +" str start1)
1702 (if (and (> (match-beginning 0) 2)
1703 (string= "[^" (substring
1705 (- (match-beginning 0) 2)
1706 (match-beginning 0))))
1708 (setq start1 (match-end 0))
1710 (setq match-len (- (match-end 0) (match-beginning 0)))
1714 (setq start1 start0)
1716 (push (substring str start1 (match-beginning 0)) res)
1717 (setq start1 (match-end 0)))
1718 (setq str (replace-match
1719 (make-string (1- match-len) ?\ )
1721 (setq start0 (or start0 start1))
1722 (setq start1 (1- (match-end 0))))))
1724 (push (substring str start0) res)
1725 (setq s (substring str start1))
1726 (unless (= (length s) 0)
1730 (defun ivy--regex (str &optional greedy)
1731 "Re-build regex pattern from STR in case it has a space.
1732 When GREEDY is non-nil, join words in a greedy way."
1733 (let ((hashed (unless greedy
1734 (gethash str ivy--regex-hash))))
1737 (setq ivy--subexps (car hashed)))
1738 (when (string-match "\\([^\\]\\|^\\)\\\\$" str)
1739 (setq str (substring str 0 -1)))
1741 (let ((subs (ivy--split str)))
1742 (if (= (length subs) 1)
1744 (setq ivy--subexps 0)
1747 (setq ivy--subexps (length subs))
1750 (if (string-match "\\`\\\\([^?].*\\\\)\\'" x)
1752 (format "\\(%s\\)" x)))
1757 ivy--regex-hash)))))
1759 (defun ivy--regex-ignore-order--part (str &optional discard)
1760 "Re-build regex from STR by splitting at spaces.
1761 Ignore the order of each group."
1762 (let* ((subs (split-string str " +" t))
1763 (len (length subs)))
1768 (mapcar (lambda (x) (cons x (not discard)))
1771 (defun ivy--regex-ignore-order (str)
1772 "Re-build regex from STR by splitting at spaces.
1773 Ignore the order of each group. Everything before \"!\" should
1774 match. Everything after \"!\" should not match."
1775 (let ((parts (split-string str "!" t)))
1776 (cl-case (length parts)
1780 (if (string= (substring str 0 1) "!")
1782 (ivy--regex-ignore-order--part (car parts) t))
1783 (ivy--regex-ignore-order--part (car parts))))
1786 (ivy--regex-ignore-order--part (car parts))
1787 (ivy--regex-ignore-order--part (cadr parts) t)))
1788 (t (error "Unexpected: use only one !")))))
1790 (defun ivy--regex-plus (str)
1791 "Build a regex sequence from STR.
1792 Spaces are wild card characters, everything before \"!\" should
1793 match. Everything after \"!\" should not match."
1794 (let ((parts (split-string str "!" t)))
1795 (cl-case (length parts)
1799 (if (string= (substring str 0 1) "!")
1801 (list (ivy--regex (car parts))))
1802 (ivy--regex (car parts))))
1805 (cons (ivy--regex (car parts)) t)
1806 (mapcar #'list (split-string (cadr parts) " " t))))
1807 (t (error "Unexpected: use only one !")))))
1809 (defun ivy--regex-fuzzy (str)
1810 "Build a regex sequence from STR.
1811 Insert .* between each char."
1812 (if (string-match "\\`\\(\\^?\\)\\(.*?\\)\\(\\$?\\)\\'" str)
1814 (concat (match-string 1 str)
1817 (format "\\(%c\\)" x))
1818 (string-to-list (match-string 2 str)) ".*")
1819 (match-string 3 str))
1820 (setq ivy--subexps (length (match-string 2 str))))
1823 (defcustom ivy-fixed-height-minibuffer nil
1824 "When non nil, fix the height of the minibuffer during ivy
1825 completion at `ivy-height'. This effectively sets the minimum
1826 height at this level and tries to ensure that it does not change
1827 depending on the number of candidates."
1832 (defun ivy--minibuffer-setup ()
1833 "Setup ivy completion in the minibuffer."
1834 (set (make-local-variable 'completion-show-inline-help) nil)
1835 (set (make-local-variable 'minibuffer-default-add-function)
1837 (list ivy--default)))
1838 (set (make-local-variable 'inhibit-field-text-motion) nil)
1839 (when (display-graphic-p)
1840 (setq truncate-lines t))
1841 (setq-local max-mini-window-height ivy-height)
1842 (when ivy-fixed-height-minibuffer
1843 (set-window-text-height (selected-window) ivy-height))
1844 (add-hook 'post-command-hook #'ivy--exhibit nil t)
1845 ;; show completions with empty input
1848 (defun ivy--input ()
1849 "Return the current minibuffer input."
1850 ;; assume one-line minibuffer input
1851 (buffer-substring-no-properties
1852 (minibuffer-prompt-end)
1853 (line-end-position)))
1855 (defun ivy--cleanup ()
1856 "Delete the displayed completion candidates."
1858 (goto-char (minibuffer-prompt-end))
1859 (delete-region (line-end-position) (point-max))))
1861 (defun ivy--insert-prompt ()
1862 "Update the prompt according to `ivy--prompt'."
1864 (unless (memq this-command '(ivy-done ivy-alt-done ivy-partial-or-done
1865 counsel-find-symbol))
1866 (setq ivy--prompt-extra ""))
1868 (if (string-match "\\(.*\\): \\'" ivy--prompt)
1870 (setq head (match-string 1 ivy--prompt))
1872 (setq head (substring ivy--prompt 0 -1))
1874 (let ((inhibit-read-only t)
1875 (std-props '(front-sticky t rear-nonsticky t field t read-only t))
1878 (if (and (bound-and-true-p minibuffer-depth-indicate-mode)
1879 (> (minibuffer-depth) 1))
1880 (format "[%d] " (minibuffer-depth))
1883 (if (string-match "%d.*%d" ivy-count-format)
1886 (or (and (ivy-state-dynamic-collection ivy-last)
1890 (or (and (ivy-state-dynamic-collection ivy-last)
1895 (d-str (if ivy--directory
1896 (abbreviate-file-name ivy--directory)
1899 (goto-char (point-min))
1900 (delete-region (point-min) (minibuffer-prompt-end))
1901 (if (> (+ (mod (+ (length n-str) (length d-str)) (window-width))
1904 (setq n-str (concat n-str "\n" d-str))
1905 (setq n-str (concat n-str d-str)))
1906 (when ivy-add-newline-after-prompt
1907 (setq n-str (concat n-str "\n")))
1908 (let ((regex (format "\\([^\n]\\{%d\\}\\)[^\n]" (window-width))))
1909 (while (string-match regex n-str)
1910 (setq n-str (replace-match (concat (match-string 1 n-str) "\n") nil t n-str 1))))
1911 (set-text-properties 0 (length n-str)
1912 `(face minibuffer-prompt ,@std-props)
1914 (ivy--set-match-props n-str "confirm"
1915 `(face ivy-confirm-face ,@std-props))
1916 (ivy--set-match-props n-str "match required"
1917 `(face ivy-match-required-face ,@std-props))
1919 ;; get out of the prompt area
1920 (constrain-to-field nil (point-max))))))
1922 (defun ivy--set-match-props (str match props)
1923 "Set STR text properties that match MATCH to PROPS."
1924 (when (string-match match str)
1925 (set-text-properties
1931 (defvar inhibit-message)
1933 (defun ivy--sort-maybe (collection)
1934 "Sort COLLECTION if needed."
1935 (let ((sort (ivy-state-sort ivy-last))
1939 (let ((sort-fn (cond ((functionp sort)
1941 ((setq entry (assoc (ivy-state-collection ivy-last)
1942 ivy-sort-functions-alist))
1945 (cdr (assoc t ivy-sort-functions-alist))))))
1946 (if (functionp sort-fn)
1947 (cl-sort (copy-sequence collection) sort-fn)
1950 (defun ivy--magic-file-slash ()
1951 (cond ((member ivy-text ivy--all-candidates)
1952 (ivy--cd (expand-file-name ivy-text ivy--directory)))
1953 ((string-match "//\\'" ivy-text)
1954 (if (and default-directory
1955 (string-match "\\`[[:alpha:]]:/" default-directory))
1956 (ivy--cd (match-string 0 default-directory))
1958 ((string-match "[[:alpha:]]:/\\'" ivy-text)
1959 (let ((drive-root (match-string 0 ivy-text)))
1960 (when (file-exists-p drive-root)
1961 (ivy--cd drive-root))))
1962 ((and (or (> ivy--index 0)
1964 (not (string= ivy-text "/")))
1965 (let ((default-directory ivy--directory))
1966 (file-directory-p ivy--current)))
1967 (ivy--cd (expand-file-name ivy--current ivy--directory)))))
1969 (defun ivy--exhibit ()
1970 "Insert Ivy completions display.
1971 Should be run via minibuffer `post-command-hook'."
1972 (when (memq 'ivy--exhibit post-command-hook)
1973 (let ((inhibit-field-text-motion nil))
1974 (constrain-to-field nil (point-max)))
1975 (setq ivy-text (ivy--input))
1976 (if (ivy-state-dynamic-collection ivy-last)
1977 ;; while-no-input would cause annoying
1978 ;; "Waiting for process to die...done" message interruptions
1979 (let ((inhibit-message t))
1980 (unless (equal ivy--old-text ivy-text)
1982 (setq ivy--all-candidates
1984 (funcall (ivy-state-collection ivy-last) ivy-text)))
1985 (setq ivy--old-text ivy-text)))
1986 (when ivy--all-candidates
1987 (ivy--insert-minibuffer
1988 (ivy--format ivy--all-candidates))))
1989 (cond (ivy--directory
1990 (if (string-match "/\\'" ivy-text)
1991 (ivy--magic-file-slash)
1992 (if (string-match "\\`~\\'" ivy-text)
1993 (ivy--cd (expand-file-name "~/")))))
1994 ((eq (ivy-state-collection ivy-last) 'internal-complete-buffer)
1995 (when (or (and (string-match "\\` " ivy-text)
1996 (not (string-match "\\` " ivy--old-text)))
1997 (and (string-match "\\` " ivy--old-text)
1998 (not (string-match "\\` " ivy-text))))
1999 (setq ivy--all-candidates
2000 (if (and (> (length ivy-text) 0)
2001 (eq (aref ivy-text 0)
2003 (ivy--buffer-list " ")
2004 (ivy--buffer-list "" ivy-use-virtual-buffers)))
2005 (setq ivy--old-re nil))))
2006 (ivy--insert-minibuffer
2007 (with-current-buffer (ivy-state-buffer ivy-last)
2009 (ivy--filter ivy-text ivy--all-candidates))))
2010 (setq ivy--old-text ivy-text))))
2012 (defun ivy--insert-minibuffer (text)
2013 "Insert TEXT into minibuffer with appropriate cleanup."
2014 (let ((resize-mini-windows nil)
2015 (update-fn (ivy-state-update-fn ivy-last))
2019 (funcall update-fn))
2020 (ivy--insert-prompt)
2021 ;; Do nothing if while-no-input was aborted.
2022 (when (stringp text)
2023 (let ((buffer-undo-list t))
2027 (when (display-graphic-p)
2028 (ivy--resize-minibuffer-to-fit))))
2030 (defun ivy--resize-minibuffer-to-fit ()
2031 "Resize the minibuffer window size to fit the text in the minibuffer."
2032 (unless (frame-root-window-p (minibuffer-window))
2033 (with-selected-window (minibuffer-window)
2034 (if (fboundp 'window-text-pixel-size)
2035 (let ((text-height (cdr (window-text-pixel-size)))
2036 (body-height (window-body-height nil t)))
2037 (when (> text-height body-height)
2038 ;; Note: the size increment needs to be at least frame-char-height,
2039 ;; otherwise resizing won't do anything.
2040 (let ((delta (max (- text-height body-height) (frame-char-height))))
2041 (window-resize nil delta nil t t))))
2042 (let ((text-height (count-screen-lines))
2043 (body-height (window-body-height)))
2044 (when (> text-height body-height)
2045 (window-resize nil (- text-height body-height) nil t)))))))
2047 (declare-function colir-blend-face-background "ext:colir")
2049 (defun ivy--add-face (str face)
2050 "Propertize STR with FACE.
2051 `font-lock-append-text-property' is used, since it's better than
2052 `propertize' or `add-face-text-property' in this case."
2056 (colir-blend-face-background 0 (length str) face str)
2057 (let ((foreground (face-foreground face)))
2059 (add-face-text-property
2061 `(:foreground ,foreground)
2066 (font-lock-append-text-property 0 (length str) 'face face str))))
2069 (declare-function flx-make-string-cache "ext:flx")
2070 (declare-function flx-score "ext:flx")
2072 (defvar ivy--flx-cache nil)
2074 (eval-after-load 'flx
2075 '(setq ivy--flx-cache (flx-make-string-cache)))
2077 (defun ivy-toggle-case-fold ()
2078 "Toggle the case folding between nil and auto.
2079 In any completion session, the case folding starts in auto:
2081 - when the input is all lower case, `case-fold-search' is t
2084 You can toggle this to make `case-fold-search' nil regardless of input."
2086 (setq ivy-case-fold-search
2087 (if ivy-case-fold-search
2090 ;; reset cache so that the candidate list updates
2091 (setq ivy--old-re nil))
2093 (defun ivy--re-filter (re candidates)
2094 "Return all RE matching CANDIDATES.
2095 RE is a list of cons cells, with a regexp car and a boolean cdr.
2096 When the cdr is t, the car must match.
2097 Otherwise, the car must not match."
2098 (let ((re-list (if (stringp re) (list (cons re t)) re))
2100 (dolist (re re-list)
2107 (let ((re-str (car re)))
2108 (lambda (x) (string-match re-str x)))
2112 (defun ivy--filter (name candidates)
2113 "Return all items that match NAME in CANDIDATES.
2114 CANDIDATES are assumed to be static."
2115 (let ((re (funcall ivy--regex-function name)))
2116 (if (and (equal re ivy--old-re)
2118 ;; quick caching for "C-n", "C-p" etc.
2120 (let* ((re-str (if (listp re) (caar re) re))
2121 (matcher (ivy-state-matcher ivy-last))
2123 (and ivy-case-fold-search
2124 (string= name (downcase name))))
2127 (funcall matcher re candidates))
2130 (stringp ivy--old-re)
2131 (not (string-match "\\\\" ivy--old-re))
2132 (not (equal ivy--old-re ""))
2134 (if (string-match "\\\\)\\'" ivy--old-re)
2135 (substring ivy--old-re 0 -2)
2141 (lambda (x) (string-match re x))
2144 (ivy--re-filter re candidates)))))
2145 (ivy--recompute-index name re-str cands)
2147 (if (eq ivy--regex-function 'ivy--regex-ignore-order)
2152 (setq ivy--old-cands (ivy--sort name cands))))))
2154 (defun ivy--set-candidates (x)
2155 "Update `ivy--all-candidates' with X."
2157 (dolist (source ivy--extra-candidates)
2158 (if (equal source '(original-source))
2161 (setq res (append x res)))
2162 (setq ivy--old-re nil)
2164 (ivy--filter ivy-text (cadr source))
2166 (setq ivy--all-candidates res)))
2168 (defcustom ivy-sort-matches-functions-alist '((t . nil))
2169 "An alist of functions for sorting matching candidates.
2171 Unlike `ivy-sort-functions-alist', which is used to sort the
2172 whole collection only once, this alist of functions are used to
2173 sort only matching candidates after each change in input.
2175 The alist KEY is either a collection function or t to match
2176 previously unmatched collection functions.
2178 The alist VAL is a sorting function with the signature of
2179 `ivy--prefix-sort'."
2182 (const :tag "Fall-through" t)
2183 (symbol :tag "Collection"))
2186 (const :tag "Don't sort" nil)
2187 (const :tag "Put prefix matches ahead" 'ivy--prefix-sort)
2188 (function :tag "Custom sort function"))))
2190 (defun ivy--sort-files-by-date (_name candidates)
2191 "Re-soft CANDIDATES according to file modification date."
2192 (let ((default-directory ivy--directory))
2193 (cl-sort (copy-sequence candidates)
2196 (nth 5 (file-attributes f2))
2197 (nth 5 (file-attributes f1)))))))
2199 (defun ivy--sort (name candidates)
2200 "Re-sort CANDIDATES by NAME.
2201 All CANDIDATES are assumed to match NAME."
2202 (let ((key (or (ivy-state-caller ivy-last)
2203 (when (functionp (ivy-state-collection ivy-last))
2204 (ivy-state-collection ivy-last))))
2206 (cond ((and (require 'flx nil 'noerror)
2207 (eq ivy--regex-function 'ivy--regex-fuzzy))
2208 (ivy--flx-sort name candidates))
2209 ((setq fun (cdr (or (assoc key ivy-sort-matches-functions-alist)
2210 (assoc t ivy-sort-matches-functions-alist))))
2211 (funcall fun name candidates))
2215 (defun ivy--prefix-sort (name candidates)
2216 "Re-sort CANDIDATES.
2217 Prefix matches to NAME are put ahead of the list."
2218 (if (or (string-match "^\\^" name) (string= name ""))
2220 (let ((re-prefix (concat "^" (funcall ivy--regex-function name)))
2223 (dolist (s candidates)
2224 (if (string-match re-prefix s)
2226 (push s res-noprefix)))
2228 (nreverse res-prefix)
2229 (nreverse res-noprefix)))))
2231 (defun ivy--recompute-index (name re-str cands)
2232 (let* ((caller (ivy-state-caller ivy-last))
2233 (func (or (and caller (cdr (assoc caller ivy-index-functions-alist)))
2234 (cdr (assoc t ivy-index-functions-alist))
2235 #'ivy-recompute-index-zero)))
2236 (unless (eq this-command 'ivy-resume)
2239 (cl-position (if (and (> (length name) 0)
2240 (eq ?^ (aref name 0)))
2246 (concat re-str "/") cands
2248 (and (not (string= name ""))
2249 (not (and (require 'flx nil 'noerror)
2250 (eq ivy--regex-function 'ivy--regex-fuzzy)
2251 (< (length cands) 200)))
2253 (cl-position (nth ivy--index ivy--old-cands)
2255 (funcall func re-str cands))))
2256 (when (and (or (string= name "")
2258 (not (equal ivy--old-re "")))
2260 (or (ivy--preselect-index
2261 (ivy-state-preselect ivy-last)
2265 (defun ivy-recompute-index-swiper (_re-str cands)
2266 (let ((tail (nthcdr ivy--index ivy--old-cands))
2268 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
2270 (while (and tail (null idx))
2271 ;; Compare with eq to handle equal duplicates in cands
2272 (setq idx (cl-position (pop tail) cands)))
2275 (1- (length cands))))
2278 ;; already in ivy-state-buffer
2279 (let ((n (line-number-at-pos))
2283 (when (eq n (read (get-text-property 0 'display c)))
2288 (defun ivy-recompute-index-swiper-async (_re-str cands)
2289 (if (null ivy--old-cands)
2290 (let ((ln (with-ivy-window
2291 (line-number-at-pos))))
2293 ;; closest to current line going forwards
2294 (cl-position-if (lambda (x)
2295 (>= (string-to-number x) ln))
2297 ;; closest to current line going backwards
2298 (1- (length cands))))
2299 (let ((tail (nthcdr ivy--index ivy--old-cands))
2301 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
2303 (while (and tail (null idx))
2304 ;; Compare with `equal', since the collection is re-created
2305 ;; each time with `split-string'
2306 (setq idx (cl-position (pop tail) cands :test #'equal)))
2310 (defun ivy-recompute-index-zero (_re-str _cands)
2313 (defcustom ivy-minibuffer-faces
2314 '(ivy-minibuffer-match-face-1
2315 ivy-minibuffer-match-face-2
2316 ivy-minibuffer-match-face-3
2317 ivy-minibuffer-match-face-4)
2318 "List of `ivy' faces for minibuffer group matches."
2319 :type '(repeat :tag "Faces"
2321 (const ivy-minibuffer-match-face-1)
2322 (const ivy-minibuffer-match-face-2)
2323 (const ivy-minibuffer-match-face-3)
2324 (const ivy-minibuffer-match-face-4)
2325 (face :tag "Other face"))))
2327 (defvar ivy-flx-limit 200
2328 "Used to conditionally turn off flx sorting.
2330 When the amount of matching candidates exceeds this limit, then
2331 no sorting is done.")
2333 (defun ivy--flx-sort (name cands)
2334 "Sort according to closeness to string NAME the string list CANDS."
2337 (< (length cands) ivy-flx-limit))
2338 (let* ((flx-name (if (string-match "^\\^" name)
2345 (let ((score (flx-score x flx-name ivy--flx-cache)))
2349 (if cands-with-score
2351 (let ((str (copy-sequence (cdr x)))
2354 (dolist (j (cdar x))
2355 (unless (eq j (1+ last-j))
2358 (ivy-add-face-text-property
2360 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2361 ivy-minibuffer-faces)
2364 (sort cands-with-score
2366 (> (caar x) (caar y)))))
2372 (defcustom ivy-format-function 'ivy-format-function-default
2373 "Function to transform the list of candidates into a string.
2374 This string is inserted into the minibuffer."
2376 (const :tag "Default" ivy-format-function-default)
2377 (const :tag "Arrow prefix" ivy-format-function-arrow)
2378 (const :tag "Full line" ivy-format-function-line)))
2380 (defun ivy--truncate-string (str width)
2381 "Truncate STR to WIDTH."
2382 (if (> (string-width str) width)
2383 (concat (substring str 0 (min (- width 3)
2384 (- (length str) 3))) "...")
2387 (defun ivy--format-function-generic (selected-fn other-fn strs separator)
2388 "Transform CAND-PAIRS into a string for minibuffer.
2389 SELECTED-FN and OTHER-FN each take one string argument.
2390 SEPARATOR is used to join the candidates."
2394 (let ((curr (eq (cl-incf i) ivy--index)))
2396 (funcall selected-fn str)
2397 (funcall other-fn str))))
2401 (defun ivy-format-function-default (cands)
2402 "Transform CAND-PAIRS into a string for minibuffer."
2403 (ivy--format-function-generic
2405 (ivy--add-face str 'ivy-current-match))
2410 (defun ivy-format-function-arrow (cands)
2411 "Transform CAND-PAIRS into a string for minibuffer."
2412 (ivy--format-function-generic
2414 (concat "> " (ivy--add-face str 'ivy-current-match)))
2420 (defun ivy-format-function-line (cands)
2421 "Transform CAND-PAIRS into a string for minibuffer."
2422 (ivy--format-function-generic
2424 (ivy--add-face (concat str "\n") 'ivy-current-match))
2430 (defun ivy-add-face-text-property (start end face str)
2431 (if (fboundp 'add-face-text-property)
2432 (add-face-text-property
2433 start end face nil str)
2434 (font-lock-append-text-property
2435 start end 'face face str)))
2437 (defun ivy--format-minibuffer-line (str)
2439 (str (copy-sequence str)))
2440 (cond ((eq ivy--regex-function 'ivy--regex-ignore-order)
2441 (when (consp ivy--old-re)
2443 (dolist (re ivy--old-re)
2444 (when (string-match (car re) str)
2445 (ivy-add-face-text-property
2446 (match-beginning 0) (match-end 0)
2447 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2448 ivy-minibuffer-faces)
2451 ((and (eq ivy-display-style 'fancy)
2452 (not (eq ivy--regex-function 'ivy--regex-fuzzy)))
2454 (setq ivy--old-re (funcall ivy--regex-function ivy-text)))
2456 (while (and (string-match ivy--old-re str start)
2457 (> (- (match-end 0) (match-beginning 0)) 0))
2458 (setq start (match-end 0))
2460 (while (<= i ivy--subexps)
2462 (cond ((zerop ivy--subexps)
2463 (cadr ivy-minibuffer-faces))
2465 (car ivy-minibuffer-faces))
2467 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2468 ivy-minibuffer-faces)))))
2469 (ivy-add-face-text-property
2470 (match-beginning i) (match-end i)
2475 (ivy-set-display-transformer
2476 'counsel-find-file 'ivy-read-file-transformer)
2477 (ivy-set-display-transformer
2478 'read-file-name-internal 'ivy-read-file-transformer)
2480 (defun ivy-read-file-transformer (str)
2481 (if (string-match-p "/\\'" str)
2482 (propertize str 'face 'ivy-subdir)
2485 (defun ivy--format (cands)
2486 "Return a string for CANDS suitable for display in the minibuffer.
2487 CANDS is a list of strings."
2488 (setq ivy--length (length cands))
2489 (when (>= ivy--index ivy--length)
2490 (setq ivy--index (max (1- ivy--length) 0)))
2492 (setq ivy--current "")
2493 (let* ((half-height (/ ivy-height 2))
2494 (start (max 0 (- ivy--index half-height)))
2495 (end (min (+ start (1- ivy-height)) ivy--length))
2496 (start (max 0 (min start (- end (1- ivy-height)))))
2497 (cands (cl-subseq cands start end))
2498 (index (- ivy--index start))
2500 (setq ivy--current (copy-sequence (nth index cands)))
2501 (when (setq transformer-fn (ivy-state-display-transformer-fn ivy-last))
2503 (setq cands (mapcar transformer-fn cands))))
2504 (let* ((ivy--index index)
2506 #'ivy--format-minibuffer-line
2508 (res (concat "\n" (funcall ivy-format-function cands))))
2509 (put-text-property 0 (length res) 'read-only nil res)
2512 (defvar ivy--virtual-buffers nil
2513 "Store the virtual buffers alist.")
2515 (defvar recentf-list)
2517 (defcustom ivy-virtual-abbreviate 'name
2518 "The mode of abbreviation for virtual buffer names."
2520 (const :tag "Only name" name)
2521 (const :tag "Full path" full)
2522 ;; eventually, uniquify
2525 (defun ivy--virtual-buffers ()
2526 "Adapted from `ido-add-virtual-buffers-to-list'."
2527 (unless recentf-mode
2529 (let ((bookmarks (and (boundp 'bookmark-alist)
2531 virtual-buffers name)
2532 (dolist (head (append
2534 (delete " - no file -"
2535 (delq nil (mapcar (lambda (bookmark)
2536 (cdr (assoc 'filename bookmark)))
2539 (if (eq ivy-virtual-abbreviate 'name)
2540 (file-name-nondirectory head)
2541 (expand-file-name head)))
2542 (when (equal name "")
2543 (setq name (file-name-nondirectory (directory-file-name head))))
2544 (when (equal name "")
2546 (and (not (equal name ""))
2547 (null (get-file-buffer head))
2548 (not (assoc name virtual-buffers))
2549 (push (cons name head) virtual-buffers)))
2550 (when virtual-buffers
2551 (dolist (comp virtual-buffers)
2552 (put-text-property 0 (length (car comp))
2555 (setq ivy--virtual-buffers (nreverse virtual-buffers))
2556 (mapcar #'car ivy--virtual-buffers))))
2558 (defcustom ivy-ignore-buffers '("\\` ")
2559 "List of regexps or functions matching buffer names to ignore."
2560 :type '(repeat (choice regexp function)))
2562 (defun ivy--buffer-list (str &optional virtual predicate)
2563 "Return the buffers that match STR.
2564 When VIRTUAL is non-nil, add virtual buffers."
2569 (if (with-current-buffer x
2571 (abbreviate-file-name default-directory)))
2572 (propertize x 'face 'ivy-remote)
2574 (all-completions str 'internal-complete-buffer predicate))
2576 (ivy--virtual-buffers)))))
2578 (defvar ivy-views (and nil
2579 `(("ivy + *scratch* {}"
2581 (file ,(expand-file-name "ivy.el"))
2582 (buffer "*scratch*")))
2583 ("swiper + *scratch* {}"
2585 (file ,(expand-file-name "swiper.el"))
2586 (buffer "*scratch*")))))
2587 "Store window configurations selectable by `ivy-switch-buffer'.
2589 The default value is given as an example.
2591 Each element is a list of (NAME TREE). NAME is a string, it's
2592 recommended to end it with a distinctive snippet e.g. \"{}\" so
2593 that it's easy to distinguish the window configurations.
2595 TREE is a nested list with the following valid cars:
2596 - vert: split the window vertically
2597 - horz: split the window horizontally
2598 - file: open the specified file
2599 - buffer: open the specified buffer
2601 TREE can be nested multiple times to have mulitple window splits.")
2603 (defun ivy-source-views ()
2604 (mapcar #'car ivy-views))
2609 (ivy-source-views)))
2611 (defun ivy-set-view-recur (view)
2612 (cond ((eq (car view) 'vert)
2613 (let ((wnd1 (selected-window))
2614 (wnd2 (split-window-vertically)))
2615 (with-selected-window wnd1
2616 (ivy-set-view-recur (nth 1 view)))
2617 (with-selected-window wnd2
2618 (ivy-set-view-recur (nth 2 view)))))
2619 ((eq (car view) 'horz)
2620 (let ((wnd1 (selected-window))
2621 (wnd2 (split-window-horizontally)))
2622 (with-selected-window wnd1
2623 (ivy-set-view-recur (nth 1 view)))
2624 (with-selected-window wnd2
2625 (ivy-set-view-recur (nth 2 view)))))
2626 ((eq (car view) 'file)
2627 (let* ((name (cadr view))
2628 (virtual (assoc name ivy--virtual-buffers))
2630 (cond ((setq buffer (get-buffer name))
2631 (switch-to-buffer buffer nil 'force-same-window))
2633 (find-file (cdr virtual)))
2634 ((file-exists-p name)
2635 (find-file name)))))
2636 ((eq (car view) 'buffer)
2637 (switch-to-buffer (cadr view)))
2638 ((eq (car view) 'sexp)
2639 (eval (cadr view)))))
2641 (defun ivy--switch-buffer-action (buffer)
2643 BUFFER may be a string or nil."
2645 (if (zerop (length buffer))
2647 ivy-text nil 'force-same-window)
2648 (let ((virtual (assoc buffer ivy--virtual-buffers))
2649 (view (assoc buffer ivy-views)))
2651 (not (get-buffer buffer)))
2652 (find-file (cdr virtual)))
2654 (delete-other-windows)
2655 (ivy-set-view-recur (cadr view)))
2658 buffer nil 'force-same-window)))))))
2660 (defun ivy--switch-buffer-other-window-action (buffer)
2661 "Switch to BUFFER in other window.
2662 BUFFER may be a string or nil."
2663 (if (zerop (length buffer))
2664 (switch-to-buffer-other-window ivy-text)
2665 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2667 (not (get-buffer buffer)))
2668 (find-file-other-window (cdr virtual))
2669 (switch-to-buffer-other-window buffer)))))
2671 (defun ivy--rename-buffer-action (buffer)
2673 (let ((new-name (read-string "Rename buffer (to new name): ")))
2674 (with-current-buffer buffer
2675 (rename-buffer new-name))))
2677 (defvar ivy-switch-buffer-map (make-sparse-keymap))
2684 (ivy--reset-state ivy-last))
2687 ivy--switch-buffer-other-window-action
2690 ivy--rename-buffer-action
2693 (defun ivy--switch-buffer-matcher (regexp candidates)
2694 "Return REGEXP-matching CANDIDATES.
2695 Skip buffers that match `ivy-ignore-buffers'."
2696 (let ((res (ivy--re-filter regexp candidates)))
2697 (if (or (null ivy-use-ignore)
2698 (null ivy-ignore-buffers))
2704 (if (functionp f-or-r)
2705 (funcall f-or-r buf)
2706 (string-match-p f-or-r buf)))
2707 ivy-ignore-buffers))
2709 (and (eq ivy-use-ignore t)
2712 (ivy-set-display-transformer
2713 'ivy-switch-buffer 'ivy-switch-buffer-transformer)
2714 (ivy-set-display-transformer
2715 'internal-complete-buffer 'ivy-switch-buffer-transformer)
2717 (defun ivy-switch-buffer-transformer (str)
2718 (let ((b (get-buffer str)))
2720 (buffer-file-name b)
2721 (buffer-modified-p b))
2722 (propertize str 'face 'ivy-modified-buffer)
2725 (defun ivy-switch-buffer-occur ()
2726 "Occur function for `ivy-switch-buffer' that uses `ibuffer'."
2728 (concat "\\(" (mapconcat #'regexp-quote ivy--old-cands "\\|") "\\)"))
2729 (new-qualifier `((name . ,cand-regexp))))
2730 (ibuffer nil (buffer-name) new-qualifier)))
2733 (defun ivy-switch-buffer ()
2734 "Switch to another buffer."
2736 (let ((this-command 'ivy-switch-buffer))
2737 (ivy-read "Switch to buffer: " 'internal-complete-buffer
2738 :matcher #'ivy--switch-buffer-matcher
2739 :preselect (buffer-name (other-buffer (current-buffer)))
2740 :action #'ivy--switch-buffer-action
2741 :keymap ivy-switch-buffer-map
2742 :caller 'ivy-switch-buffer)))
2745 (defun ivy-switch-buffer-other-window ()
2746 "Switch to another buffer in another window."
2748 (ivy-read "Switch to buffer in other window: " 'internal-complete-buffer
2749 :preselect (buffer-name (other-buffer (current-buffer)))
2750 :action #'ivy--switch-buffer-other-window-action
2751 :keymap ivy-switch-buffer-map
2752 :caller 'ivy-switch-buffer-other-window))
2755 (defun ivy-recentf ()
2756 "Find a file on `recentf-list'."
2758 (ivy-read "Recentf: " recentf-list
2763 :caller 'ivy-recentf))
2765 (defun ivy-yank-word ()
2766 "Pull next word from buffer into search string."
2771 (le (line-end-position)))
2775 (setq amend (buffer-substring-no-properties pt (point))))))
2777 (insert (replace-regexp-in-string " +" " " amend)))))
2779 (defun ivy-kill-ring-save ()
2780 "Store the current candidates into the kill ring.
2781 If the region is active, forward to `kill-ring-save' instead."
2783 (if (region-active-p)
2784 (call-interactively 'kill-ring-save)
2791 (defun ivy-insert-current ()
2792 "Make the current candidate into current input.
2793 Don't finish completion."
2795 (delete-minibuffer-contents)
2796 (if (and ivy--directory
2797 (string-match "/$" ivy--current))
2798 (insert (substring ivy--current 0 -1))
2799 (insert ivy--current)))
2801 (defun ivy-toggle-fuzzy ()
2802 "Toggle the re builder between `ivy--regex-fuzzy' and `ivy--regex-plus'."
2804 (setq ivy--old-re nil)
2805 (if (eq ivy--regex-function 'ivy--regex-fuzzy)
2806 (setq ivy--regex-function 'ivy--regex-plus)
2807 (setq ivy--regex-function 'ivy--regex-fuzzy)))
2809 (defun ivy-reverse-i-search ()
2810 "Enter a recursive `ivy-read' session using the current history.
2811 The selected history element will be inserted into the minibuffer."
2813 (let ((enable-recursive-minibuffers t)
2814 (history (symbol-value (ivy-state-history ivy-last)))
2816 (ivy-recursive-restore nil))
2817 (ivy-read "Reverse-i-search: "
2821 (setq ivy-last old-last))
2822 (delete-minibuffer-contents)
2823 (insert (substring-no-properties x))
2826 (defun ivy-restrict-to-matches ()
2827 "Restrict candidates to current matches and erase input."
2829 (delete-minibuffer-contents)
2830 (setq ivy--all-candidates
2831 (ivy--filter ivy-text ivy--all-candidates)))
2834 (defvar-local ivy-occur-last nil
2835 "Buffer-local value of `ivy-last'.
2836 Can't re-use `ivy-last' because using e.g. `swiper' in the same
2837 buffer would modify `ivy-last'.")
2839 (defvar ivy-occur-mode-map
2840 (let ((map (make-sparse-keymap)))
2841 (define-key map [mouse-1] 'ivy-occur-click)
2842 (define-key map (kbd "RET") 'ivy-occur-press)
2843 (define-key map (kbd "j") 'ivy-occur-next-line)
2844 (define-key map (kbd "k") 'ivy-occur-previous-line)
2845 (define-key map (kbd "h") 'backward-char)
2846 (define-key map (kbd "l") 'forward-char)
2847 (define-key map (kbd "f") 'ivy-occur-press)
2848 (define-key map (kbd "g") 'ivy-occur-revert-buffer)
2849 (define-key map (kbd "a") 'ivy-occur-read-action)
2850 (define-key map (kbd "o") 'ivy-occur-dispatch)
2851 (define-key map (kbd "c") 'ivy-occur-toggle-calling)
2852 (define-key map (kbd "q") 'quit-window)
2854 "Keymap for Ivy Occur mode.")
2856 (defun ivy-occur-toggle-calling ()
2857 "Toggle `ivy-calling'."
2859 (if (setq ivy-calling (not ivy-calling))
2861 (setq mode-name "Ivy-Occur [calling]")
2863 (setq mode-name "Ivy-Occur"))
2864 (force-mode-line-update))
2866 (defun ivy-occur-next-line (&optional arg)
2867 "Move the cursor down ARG lines.
2868 When `ivy-calling' isn't nil, call `ivy-occur-press'."
2874 (defun ivy-occur-previous-line (&optional arg)
2875 "Move the cursor up ARG lines.
2876 When `ivy-calling' isn't nil, call `ivy-occur-press'."
2878 (forward-line (- arg))
2882 (define-derived-mode ivy-occur-mode fundamental-mode "Ivy-Occur"
2883 "Major mode for output from \\[ivy-occur].
2885 \\{ivy-occur-mode-map}")
2887 (defvar ivy-occur-grep-mode-map
2888 (let ((map (copy-keymap ivy-occur-mode-map)))
2889 (define-key map (kbd "C-x C-q") 'ivy-wgrep-change-to-wgrep-mode)
2891 "Keymap for Ivy Occur Grep mode.")
2893 (define-derived-mode ivy-occur-grep-mode grep-mode "Ivy-Occur"
2894 "Major mode for output from \\[ivy-occur].
2896 \\{ivy-occur-grep-mode-map}")
2898 (defvar ivy--occurs-list nil
2899 "A list of custom occur generators per command.")
2901 (defun ivy-set-occur (cmd occur)
2902 "Assign CMD a custom OCCUR function."
2903 (setq ivy--occurs-list
2904 (plist-put ivy--occurs-list cmd occur)))
2906 (ivy-set-occur 'ivy-switch-buffer 'ivy-switch-buffer-occur)
2907 (ivy-set-occur 'ivy-switch-buffer-other-window 'ivy-switch-buffer-occur)
2909 (defun ivy--occur-insert-lines (cands)
2911 (add-text-properties
2915 help-echo "mouse-1: call ivy-action")
2920 "Stop completion and put the current matches into a new buffer.
2922 The new buffer remembers current action(s).
2924 While in the *ivy-occur* buffer, selecting a candidate with RET or
2925 a mouse click will call the appropriate action for that candidate.
2927 There is no limit on the number of *ivy-occur* buffers."
2929 (if (not (window-minibuffer-p))
2930 (user-error "No completion session is active")
2931 (let* ((caller (ivy-state-caller ivy-last))
2932 (occur-fn (plist-get ivy--occurs-list caller))
2934 (generate-new-buffer
2935 (format "*ivy-occur%s \"%s\"*"
2937 (concat " " (prin1-to-string caller))
2940 (with-current-buffer buffer
2941 (let ((inhibit-read-only t))
2946 (insert (format "%d candidates:\n" (length ivy--old-cands)))
2947 (ivy--occur-insert-lines
2949 (lambda (cand) (concat " " cand))
2951 (setf (ivy-state-text ivy-last) ivy-text)
2952 (setq ivy-occur-last ivy-last)
2953 (setq-local ivy--directory ivy--directory))
2954 (ivy-exit-with-action
2955 `(lambda (_) (pop-to-buffer ,buffer))))))
2957 (defun ivy-occur-revert-buffer ()
2958 "Refresh the buffer making it up-to date with the collection.
2960 Currently only works for `swiper'. In that specific case, the
2961 *ivy-occur* buffer becomes nearly useless as the orignal buffer
2962 is updated, since the line numbers no longer match.
2964 Calling this function is as if you called `ivy-occur' on the
2965 updated original buffer."
2967 (let ((caller (ivy-state-caller ivy-occur-last))
2968 (ivy-last ivy-occur-last))
2969 (cond ((eq caller 'swiper)
2970 (let ((buffer (ivy-state-buffer ivy-occur-last)))
2971 (unless (buffer-live-p buffer)
2972 (error "buffer was killed"))
2973 (let ((inhibit-read-only t))
2975 (funcall (plist-get ivy--occurs-list caller) t))))
2976 ((memq caller '(counsel-git-grep counsel-grep counsel-ag))
2977 (let ((inhibit-read-only t))
2979 (funcall (plist-get ivy--occurs-list caller)))))))
2981 (declare-function wgrep-change-to-wgrep-mode "ext:wgrep")
2983 (defun ivy-wgrep-change-to-wgrep-mode ()
2984 "Forward to `wgrep-change-to-wgrep-mode'."
2986 (if (require 'wgrep nil 'noerror)
2987 (wgrep-change-to-wgrep-mode)
2988 (error "Package wgrep isn't installed")))
2990 (defun ivy-occur-read-action ()
2991 "Select one of the available actions as the current one."
2993 (let ((ivy-last ivy-occur-last))
2996 (defun ivy-occur-dispatch ()
2997 "Call one of the available actions on the current item."
2999 (let* ((state-action (ivy-state-action ivy-occur-last))
3000 (actions (if (symbolp state-action)
3002 (copy-sequence state-action))))
3005 (ivy-occur-read-action)
3007 (setf (ivy-state-action ivy-occur-last) actions))))
3009 (defun ivy-occur-click (event)
3010 "Execute action for the current candidate.
3011 EVENT gives the mouse position."
3013 (let ((window (posn-window (event-end event)))
3014 (pos (posn-point (event-end event))))
3015 (with-current-buffer (window-buffer window)
3017 (ivy-occur-press))))
3019 (declare-function swiper--cleanup "swiper")
3020 (declare-function swiper--add-overlays "swiper")
3021 (defvar ivy-occur-timer nil)
3022 (defvar counsel-grep-last-line)
3024 (defun ivy-occur-press ()
3025 "Execute action for the current candidate."
3027 (when (save-excursion
3029 (looking-at "\\(?:./\\| \\)\\(.*\\)$"))
3030 (when (memq (ivy-state-caller ivy-occur-last)
3031 '(swiper counsel-git-grep counsel-grep counsel-ag
3032 counsel-describe-function counsel-describe-variable))
3033 (let ((window (ivy-state-window ivy-occur-last)))
3034 (when (or (null (window-live-p window))
3035 (equal window (selected-window)))
3036 (save-selected-window
3037 (setf (ivy-state-window ivy-occur-last)
3038 (display-buffer (ivy-state-buffer ivy-occur-last)
3039 'display-buffer-pop-up-window))))))
3040 (let* ((ivy-last ivy-occur-last)
3041 (ivy-text (ivy-state-text ivy-last))
3042 (str (buffer-substring
3045 (coll (ivy-state-collection ivy-last))
3046 (action (ivy--get-action ivy-last))
3049 (setq counsel-grep-last-line nil)
3051 (if (and (consp coll)
3053 (cdr (assoc str coll))
3055 (if (memq (ivy-state-caller ivy-last)
3056 '(swiper counsel-git-grep counsel-grep))
3057 (with-current-buffer (window-buffer (selected-window))
3059 (swiper--add-overlays
3060 (ivy--regex ivy-text)
3061 (line-beginning-position)
3064 (when (timerp ivy-occur-timer)
3065 (cancel-timer ivy-occur-timer))
3066 (setq ivy-occur-timer (run-at-time 1.0 nil 'swiper--cleanup))))))))
3068 (defvar ivy-help-file (let ((default-directory
3070 (file-name-directory load-file-name)
3071 default-directory)))
3072 (if (file-exists-p "ivy-help.org")
3073 (expand-file-name "ivy-help.org")
3074 (if (file-exists-p "doc/ivy-help.org")
3075 (expand-file-name "doc/ivy-help.org"))))
3076 "The file for `ivy-help'.")
3081 (let ((buf (get-buffer "*Ivy Help*")))
3083 (setq buf (get-buffer-create "*Ivy Help*"))
3084 (with-current-buffer buf
3085 (insert-file-contents ivy-help-file)
3088 (goto-char (point-min))))
3089 (if (eq this-command 'ivy-help)
3090 (switch-to-buffer buf)
3092 (pop-to-buffer buf)))
3094 (goto-char (point-min))))
3098 ;;; ivy.el ends here