]> code.delx.au - gnu-emacs-elpa/blob - ivy.el
ivy.el (ivy-next-history-element): Simplify
[gnu-emacs-elpa] / ivy.el
1 ;;; ivy.el --- Incremental Vertical completYon -*- lexical-binding: t -*-
2
3 ;; Copyright (C) 2015 Free Software Foundation, Inc.
4
5 ;; Author: Oleh Krehel <ohwoeowho@gmail.com>
6 ;; URL: https://github.com/abo-abo/swiper
7 ;; Package-Requires: ((emacs "24.1"))
8 ;; Keywords: matching
9
10 ;; This file is part of GNU Emacs.
11
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)
15 ;; any later version.
16
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.
21
22 ;; For a full copy of the GNU General Public License
23 ;; see <http://www.gnu.org/licenses/>.
24
25 ;;; Commentary:
26 ;;
27 ;; This package provides `ivy-read' as an alternative to
28 ;; `completing-read' and similar functions.
29 ;;
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'.
33 ;;
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\\)".
37
38 ;;; Code:
39 (require 'cl-lib)
40 (require 'ffap)
41
42 ;;* Customization
43 (defgroup ivy nil
44 "Incremental vertical completion."
45 :group 'convenience)
46
47 (defgroup ivy-faces nil
48 "Font-lock faces for `ivy'."
49 :group 'ivy
50 :group 'faces)
51
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.")
58
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.")
65
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.")
72
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.")
79
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.")
86
87 (defface ivy-confirm-face
88 '((t :foreground "ForestGreen" :inherit minibuffer-prompt))
89 "Face used by Ivy for a confirmation prompt.")
90
91 (defface ivy-match-required-face
92 '((t :foreground "red" :inherit minibuffer-prompt))
93 "Face used by Ivy for a match required prompt.")
94
95 (defface ivy-subdir
96 '((t :inherit dired-directory))
97 "Face used by Ivy for highlighting subdirs in the alternatives.")
98
99 (defface ivy-modified-buffer
100 '((t :inherit default))
101 "Face used by Ivy for highlighting modified file visiting buffers.")
102
103 (defface ivy-remote
104 '((t :foreground "#110099"))
105 "Face used by Ivy for highlighting remotes in the alternatives.")
106
107 (defface ivy-virtual
108 '((t :inherit font-lock-builtin-face))
109 "Face used by Ivy for matching virtual buffer names.")
110
111 (setcdr (assoc load-file-name custom-current-group-alist) 'ivy)
112
113 (defcustom ivy-height 10
114 "Number of lines for the minibuffer window."
115 :type 'integer)
116
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."
121 :type '(choice
122 (const :tag "Count disabled" "")
123 (const :tag "Count matches" "%-4d ")
124 (const :tag "Count matches and show current match" "(%d/%d) ")
125 string))
126
127 (defcustom ivy-add-newline-after-prompt nil
128 "When non-nil, add a newline after the `ivy-read' prompt."
129 :type 'boolean)
130
131 (defcustom ivy-wrap nil
132 "When non-nil, wrap around after the first and the last candidate."
133 :type 'boolean)
134
135 (defcustom ivy-display-style (unless (version< emacs-version "24.5") 'fancy)
136 "The style for formatting the minibuffer.
137
138 By default, the matched strings are copied as is.
139
140 The fancy display style highlights matching parts of the regexp,
141 a behavior similar to `swiper'.
142
143 This setting depends on `add-face-text-property' - a C function
144 available as of Emacs 24.5. Fancy style will render poorly in
145 earlier versions of Emacs."
146 :type '(choice
147 (const :tag "Plain" nil)
148 (const :tag "Fancy" fancy)))
149
150 (defcustom ivy-on-del-error-function 'minibuffer-keyboard-quit
151 "The handler for when `ivy-backward-delete-char' throws.
152 Usually a quick exit out of the minibuffer."
153 :type 'function)
154
155 (defcustom ivy-extra-directories '("../" "./")
156 "Add this to the front of the list when completing file names.
157 Only \"./\" and \"../\" apply here. They appear in reverse order."
158 :type '(repeat :tag "Dirs"
159 (choice
160 (const :tag "Parent Directory" "../")
161 (const :tag "Current Directory" "./"))))
162
163 (defcustom ivy-use-virtual-buffers nil
164 "When non-nil, add `recentf-mode' and bookmarks to `ivy-switch-buffer'."
165 :type 'boolean)
166
167 (defvar ivy--actions-list nil
168 "A list of extra actions per command.")
169
170 (defun ivy-set-actions (cmd actions)
171 "Set CMD extra exit points to ACTIONS."
172 (setq ivy--actions-list
173 (plist-put ivy--actions-list cmd actions)))
174
175 (defvar ivy--display-transformers-list nil
176 "A list of str->str transformers per command.")
177
178 (defun ivy-set-display-transformer (cmd transformer)
179 "Set CMD a displayed candidate TRANSFORMER.
180
181 It's a lambda that takes a string one of the candidates in the
182 collection and returns a string for display, the same candidate
183 plus some extra information.
184
185 This lambda is called only on the `ivy-height' candidates that
186 are about to be displayed, not on the whole collection."
187 (setq ivy--display-transformers-list
188 (plist-put ivy--display-transformers-list cmd transformer)))
189
190 (defvar ivy--sources-list nil
191 "A list of extra sources per command.")
192
193 (defun ivy-set-sources (cmd sources)
194 "Attach to CMD a list of extra SOURCES.
195
196 Each static source is a function that takes no argument and
197 returns a list of strings.
198
199 The '(original-source) determines the position of the original
200 dynamic source.
201
202 Extra dynamic sources aren't supported yet.
203
204 Example:
205
206 (defun small-recentf ()
207 (cl-subseq recentf-list 0 20))
208
209 (ivy-set-sources
210 'counsel-locate
211 '((small-recentf)
212 (original-source)))
213 "
214 (setq ivy--sources-list
215 (plist-put ivy--sources-list cmd sources)))
216
217 ;;* Keymap
218 (require 'delsel)
219 (defvar ivy-minibuffer-map
220 (let ((map (make-sparse-keymap)))
221 (define-key map (kbd "C-m") 'ivy-done)
222 (define-key map (kbd "C-M-m") 'ivy-call)
223 (define-key map (kbd "C-j") 'ivy-alt-done)
224 (define-key map (kbd "C-M-j") 'ivy-immediate-done)
225 (define-key map (kbd "TAB") 'ivy-partial-or-done)
226 (define-key map (kbd "C-n") 'ivy-next-line)
227 (define-key map (kbd "C-p") 'ivy-previous-line)
228 (define-key map (kbd "<down>") 'ivy-next-line)
229 (define-key map (kbd "<up>") 'ivy-previous-line)
230 (define-key map (kbd "C-s") 'ivy-next-line-or-history)
231 (define-key map (kbd "C-r") 'ivy-reverse-i-search)
232 (define-key map (kbd "SPC") 'self-insert-command)
233 (define-key map (kbd "DEL") 'ivy-backward-delete-char)
234 (define-key map (kbd "M-DEL") 'ivy-backward-kill-word)
235 (define-key map (kbd "C-d") 'ivy-delete-char)
236 (define-key map (kbd "C-f") 'ivy-forward-char)
237 (define-key map (kbd "M-d") 'ivy-kill-word)
238 (define-key map (kbd "M-<") 'ivy-beginning-of-buffer)
239 (define-key map (kbd "M->") 'ivy-end-of-buffer)
240 (define-key map (kbd "M-n") 'ivy-next-history-element)
241 (define-key map (kbd "M-p") 'ivy-previous-history-element)
242 (define-key map (kbd "C-g") 'minibuffer-keyboard-quit)
243 (define-key map (kbd "C-v") 'ivy-scroll-up-command)
244 (define-key map (kbd "M-v") 'ivy-scroll-down-command)
245 (define-key map (kbd "C-M-n") 'ivy-next-line-and-call)
246 (define-key map (kbd "C-M-p") 'ivy-previous-line-and-call)
247 (define-key map (kbd "M-q") 'ivy-toggle-regexp-quote)
248 (define-key map (kbd "M-j") 'ivy-yank-word)
249 (define-key map (kbd "M-i") 'ivy-insert-current)
250 (define-key map (kbd "C-o") 'hydra-ivy/body)
251 (define-key map (kbd "M-o") 'ivy-dispatching-done)
252 (define-key map (kbd "C-M-o") 'ivy-dispatching-call)
253 (define-key map (kbd "C-k") 'ivy-kill-line)
254 (define-key map (kbd "S-SPC") 'ivy-restrict-to-matches)
255 (define-key map (kbd "M-w") 'ivy-kill-ring-save)
256 (define-key map (kbd "C-'") 'ivy-avy)
257 (define-key map (kbd "C-M-a") 'ivy-read-action)
258 (define-key map (kbd "C-c C-o") 'ivy-occur)
259 (define-key map (kbd "C-c C-a") 'ivy-toggle-ignore)
260 (define-key map (kbd "C-h m") 'ivy-help)
261 map)
262 "Keymap used in the minibuffer.")
263 (autoload 'hydra-ivy/body "ivy-hydra" "" t)
264
265 (defvar ivy-mode-map
266 (let ((map (make-sparse-keymap)))
267 (define-key map [remap switch-to-buffer]
268 'ivy-switch-buffer)
269 (define-key map [remap switch-to-buffer-other-window]
270 'ivy-switch-buffer-other-window)
271 map)
272 "Keymap for `ivy-mode'.")
273
274 ;;* Globals
275 (cl-defstruct ivy-state
276 prompt collection
277 predicate require-match initial-input
278 history preselect keymap update-fn sort
279 ;; The window in which `ivy-read' was called
280 window
281 ;; The buffer in which `ivy-read' was called
282 buffer
283 ;; The value of `ivy-text' to be used by `ivy-occur'
284 text
285 action
286 unwind
287 re-builder
288 matcher
289 ;; When this is non-nil, call it for each input change to get new candidates
290 dynamic-collection
291 ;; A lambda that transforms candidates only for display
292 display-transformer-fn
293 caller)
294
295 (defvar ivy-last (make-ivy-state)
296 "The last parameters passed to `ivy-read'.
297
298 This should eventually become a stack so that you could use
299 `ivy-read' recursively.")
300
301 (defsubst ivy-set-action (action)
302 (setf (ivy-state-action ivy-last) action))
303
304 (defun ivy-thing-at-point ()
305 "Return a string that corresponds to the current thing at point."
306 (or
307 (thing-at-point 'url)
308 (ffap-file-at-point)
309 (let (s)
310 (cond ((stringp (setq s (thing-at-point 'symbol)))
311 (if (string-match "\\`[`']?\\(.*?\\)'?\\'" s)
312 (match-string 1 s)
313 s))
314 ((looking-at "(+\\(\\(?:\\sw\\|\\s_\\)+\\)\\_>")
315 (match-string-no-properties 1))
316 (t
317 "")))))
318
319 (defvar ivy-history nil
320 "History list of candidates entered in the minibuffer.
321
322 Maximum length of the history list is determined by the value
323 of `history-length'.")
324
325 (defvar ivy--directory nil
326 "Current directory when completing file names.")
327
328 (defvar ivy--length 0
329 "Store the amount of viable candidates.")
330
331 (defvar ivy-text ""
332 "Store the user's string as it is typed in.")
333
334 (defvar ivy--current ""
335 "Current candidate.")
336
337 (defvar ivy--index 0
338 "Store the index of the current candidate.")
339
340 (defvar ivy-exit nil
341 "Store 'done if the completion was successfully selected.
342 Otherwise, store nil.")
343
344 (defvar ivy--all-candidates nil
345 "Store the candidates passed to `ivy-read'.")
346
347 (defvar ivy--extra-candidates '((original-source))
348 "Store candidates added by the extra sources.
349
350 This is an internal-use alist. Each key is a function name, or
351 original-source (which represents where the current dynamic
352 candidates should go).
353
354 Each value is an evaluation of the function, in case of static
355 sources. These values will subsequently be filtered on `ivy-text'.
356
357 This variable is set by `ivy-read' and used by `ivy--set-candidates'.")
358
359 (defvar ivy-use-ignore t
360 "Store policy for user-configured candidate filtering.")
361
362 (defvar ivy--default nil
363 "Default initial input.")
364
365 (defvar ivy--prompt nil
366 "Store the format-style prompt.
367 When non-nil, it should contain at least one %d.")
368
369 (defvar ivy--prompt-extra ""
370 "Temporary modifications to the prompt.")
371
372 (defvar ivy--old-re nil
373 "Store the old regexp.")
374
375 (defvar ivy--old-cands nil
376 "Store the candidates matched by `ivy--old-re'.")
377
378 (defvar ivy--regex-function 'ivy--regex
379 "Current function for building a regex.")
380
381 (defvar ivy--subexps 0
382 "Number of groups in the current `ivy--regex'.")
383
384 (defvar ivy--full-length nil
385 "When :dynamic-collection is non-nil, this can be the total amount of candidates.")
386
387 (defvar ivy--old-text ""
388 "Store old `ivy-text' for dynamic completion.")
389
390 (defvar ivy-case-fold-search 'auto
391 "Store the current overriding `case-fold-search'.")
392
393 (defvar Info-current-file)
394
395 (eval-and-compile
396 (unless (fboundp 'defvar-local)
397 (defmacro defvar-local (var val &optional docstring)
398 "Define VAR as a buffer-local variable with default value VAL."
399 (declare (debug defvar) (doc-string 3))
400 (list 'progn (list 'defvar var val docstring)
401 (list 'make-variable-buffer-local (list 'quote var)))))
402 (unless (fboundp 'setq-local)
403 (defmacro setq-local (var val)
404 "Set variable VAR to value VAL in current buffer."
405 (list 'set (list 'make-local-variable (list 'quote var)) val))))
406
407 (defmacro ivy-quit-and-run (&rest body)
408 "Quit the minibuffer and run BODY afterwards."
409 `(progn
410 (put 'quit 'error-message "")
411 (run-at-time nil nil
412 (lambda ()
413 (put 'quit 'error-message "Quit")
414 ,@body))
415 (minibuffer-keyboard-quit)))
416
417 (defun ivy-exit-with-action (action)
418 "Quit the minibuffer and call ACTION afterwards."
419 (ivy-set-action
420 `(lambda (x)
421 (funcall ',action x)
422 (ivy-set-action ',(ivy-state-action ivy-last))))
423 (setq ivy-exit 'done)
424 (exit-minibuffer))
425
426 (defmacro with-ivy-window (&rest body)
427 "Execute BODY in the window from which `ivy-read' was called."
428 (declare (indent 0)
429 (debug t))
430 `(with-selected-window (ivy--get-window ivy-last)
431 ,@body))
432
433 (defun ivy--done (text)
434 "Insert TEXT and exit minibuffer."
435 (if (and ivy--directory
436 (not (eq (ivy-state-history ivy-last) 'grep-files-history)))
437 (insert (setq ivy--current (expand-file-name
438 text ivy--directory)))
439 (insert (setq ivy--current text)))
440 (setq ivy-exit 'done)
441 (exit-minibuffer))
442
443 ;;* Commands
444 (defun ivy-done ()
445 "Exit the minibuffer with the selected candidate."
446 (interactive)
447 (delete-minibuffer-contents)
448 (cond ((> ivy--length 0)
449 (ivy--done ivy--current))
450 ((memq (ivy-state-collection ivy-last)
451 '(read-file-name-internal internal-complete-buffer))
452 (if (or (not (eq confirm-nonexistent-file-or-buffer t))
453 (equal " (confirm)" ivy--prompt-extra))
454 (ivy--done ivy-text)
455 (setq ivy--prompt-extra " (confirm)")
456 (insert ivy-text)
457 (ivy--exhibit)))
458 ((memq (ivy-state-require-match ivy-last)
459 '(nil confirm confirm-after-completion))
460 (ivy--done ivy-text))
461 (t
462 (setq ivy--prompt-extra " (match required)")
463 (insert ivy-text)
464 (ivy--exhibit))))
465
466 (defun ivy-read-action ()
467 "Change the action to one of the available ones.
468
469 Return nil for `minibuffer-keyboard-quit' or wrong key during the
470 selection, non-nil otherwise."
471 (interactive)
472 (let ((actions (ivy-state-action ivy-last)))
473 (if (null (ivy--actionp actions))
474 t
475 (let* ((hint (concat (if (eq this-command 'ivy-read-action)
476 "Select action: "
477 ivy--current)
478 "\n"
479 (mapconcat
480 (lambda (x)
481 (format "%s: %s"
482 (propertize
483 (car x)
484 'face 'font-lock-builtin-face)
485 (nth 2 x)))
486 (cdr actions)
487 "\n")
488 "\n"))
489 (resize-mini-windows 'grow-only)
490 (key (string (read-key hint)))
491 (action-idx (cl-position-if
492 (lambda (x) (equal (car x) key))
493 (cdr actions))))
494 (cond ((string= key "\a")
495 nil)
496 ((null action-idx)
497 (message "%s is not bound" key)
498 nil)
499 (t
500 (message "")
501 (setcar actions (1+ action-idx))
502 (ivy-set-action actions)))))))
503
504 (defun ivy-dispatching-done ()
505 "Select one of the available actions and call `ivy-done'."
506 (interactive)
507 (when (ivy-read-action)
508 (ivy-done)))
509
510 (defun ivy-dispatching-call ()
511 "Select one of the available actions and call `ivy-call'."
512 (interactive)
513 (let ((actions (copy-sequence (ivy-state-action ivy-last))))
514 (unwind-protect
515 (when (ivy-read-action)
516 (ivy-call))
517 (ivy-set-action actions))))
518
519 (defun ivy-build-tramp-name (x)
520 "Reconstruct X into a path.
521 Is is a cons cell, related to `tramp-get-completion-function'."
522 (let ((user (car x))
523 (domain (cadr x)))
524 (if user
525 (concat user "@" domain)
526 domain)))
527
528 (declare-function tramp-get-completion-function "tramp")
529 (declare-function Info-find-node "info")
530
531 (defun ivy-alt-done (&optional arg)
532 "Exit the minibuffer with the selected candidate.
533 When ARG is t, exit with current text, ignoring the candidates."
534 (interactive "P")
535 (cond (arg
536 (ivy-immediate-done))
537 (ivy--directory
538 (ivy--directory-done))
539 ((eq (ivy-state-collection ivy-last) 'Info-read-node-name-1)
540 (if (member ivy--current '("(./)" "(../)"))
541 (ivy-quit-and-run
542 (ivy-read "Go to file: " 'read-file-name-internal
543 :action (lambda (x)
544 (Info-find-node
545 (expand-file-name x ivy--directory)
546 "Top"))))
547 (ivy-done)))
548 (t
549 (ivy-done))))
550
551 (defun ivy--directory-done ()
552 "Handle exit from the minibuffer when completing file names."
553 (let (dir)
554 (cond
555 ((equal ivy-text "/sudo::")
556 (setq dir (concat ivy-text ivy--directory))
557 (ivy--cd dir)
558 (ivy--exhibit))
559 ((and
560 (> ivy--length 0)
561 (not (string= ivy--current "./"))
562 (setq dir (ivy-expand-file-if-directory ivy--current)))
563 (ivy--cd dir)
564 (ivy--exhibit))
565 ((or (and (equal ivy--directory "/")
566 (string-match "\\`[^/]+:.*:.*\\'" ivy-text))
567 (string-match "\\`/[^/]+:.*:.*\\'" ivy-text))
568 (ivy-done))
569 ((or (and (equal ivy--directory "/")
570 (cond ((string-match
571 "\\`\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
572 ivy-text))
573 ((string-match
574 "\\`\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
575 ivy--current)
576 (setq ivy-text ivy--current))))
577 (string-match
578 "\\`/\\([^/]+?\\):\\(?:\\(.*\\)@\\)?\\(.*\\)\\'"
579 ivy-text))
580 (let ((method (match-string 1 ivy-text))
581 (user (match-string 2 ivy-text))
582 (rest (match-string 3 ivy-text))
583 res)
584 (require 'tramp)
585 (dolist (x (tramp-get-completion-function method))
586 (setq res (append res (funcall (car x) (cadr x)))))
587 (setq res (delq nil res))
588 (when user
589 (dolist (x res)
590 (setcar x user)))
591 (setq res (cl-delete-duplicates res :test #'equal))
592 (let* ((old-ivy-last ivy-last)
593 (enable-recursive-minibuffers t)
594 (host (ivy-read "user@host: "
595 (mapcar #'ivy-build-tramp-name res)
596 :initial-input rest)))
597 (setq ivy-last old-ivy-last)
598 (when host
599 (setq ivy--directory "/")
600 (ivy--cd (concat "/" method ":" host ":"))))))
601 (t
602 (ivy-done)))))
603
604 (defun ivy-expand-file-if-directory (file-name)
605 "Expand FILE-NAME as directory.
606 When this directory doesn't exist, return nil."
607 (when (stringp file-name)
608 (let ((full-name
609 ;; Ignore host name must not match method "ssh"
610 (ignore-errors
611 (file-name-as-directory
612 (expand-file-name file-name ivy--directory)))))
613 (when (and full-name (file-directory-p full-name))
614 full-name))))
615
616 (defcustom ivy-tab-space nil
617 "When non-nil, `ivy-partial-or-done' should insert a space."
618 :type 'boolean)
619
620 (defun ivy-partial-or-done ()
621 "Complete the minibuffer text as much as possible.
622 If the text hasn't changed as a result, forward to `ivy-alt-done'."
623 (interactive)
624 (if (and (eq (ivy-state-collection ivy-last) #'read-file-name-internal)
625 (or (and (equal ivy--directory "/")
626 (string-match "\\`[^/]+:.*\\'" ivy-text))
627 (string-match "\\`/" ivy-text)))
628 (let ((default-directory ivy--directory)
629 dir)
630 (minibuffer-complete)
631 (setq ivy-text (ivy--input))
632 (when (setq dir (ivy-expand-file-if-directory ivy-text))
633 (ivy--cd dir)))
634 (or (ivy-partial)
635 (when (or (eq this-command last-command)
636 (eq ivy--length 1))
637 (ivy-alt-done)))))
638
639 (defun ivy-partial ()
640 "Complete the minibuffer text as much as possible."
641 (interactive)
642 (let* ((parts (or (split-string ivy-text " " t) (list "")))
643 (postfix (car (last parts)))
644 (completion-ignore-case t)
645 (startp (string-match "^\\^" postfix))
646 (new (try-completion (if startp
647 (substring postfix 1)
648 postfix)
649 (mapcar (lambda (str)
650 (let ((i (string-match postfix str)))
651 (when i
652 (substring str i))))
653 ivy--old-cands))))
654 (cond ((eq new t) nil)
655 ((string= new ivy-text) nil)
656 (new
657 (delete-region (minibuffer-prompt-end) (point-max))
658 (setcar (last parts)
659 (if startp
660 (concat "^" new)
661 new))
662 (insert (mapconcat #'identity parts " ")
663 (if ivy-tab-space " " ""))
664 t))))
665
666 (defun ivy-immediate-done ()
667 "Exit the minibuffer with the current input."
668 (interactive)
669 (delete-minibuffer-contents)
670 (insert (setq ivy--current
671 (if ivy--directory
672 (expand-file-name ivy-text ivy--directory)
673 ivy-text)))
674 (setq ivy-exit 'done)
675 (exit-minibuffer))
676
677 ;;;###autoload
678 (defun ivy-resume ()
679 "Resume the last completion session."
680 (interactive)
681 (if (null (ivy-state-action ivy-last))
682 (user-error "The last session isn't compatible with `ivy-resume'")
683 (when (eq (ivy-state-caller ivy-last) 'swiper)
684 (switch-to-buffer (ivy-state-buffer ivy-last)))
685 (with-current-buffer (ivy-state-buffer ivy-last)
686 (ivy-read
687 (ivy-state-prompt ivy-last)
688 (ivy-state-collection ivy-last)
689 :predicate (ivy-state-predicate ivy-last)
690 :require-match (ivy-state-require-match ivy-last)
691 :initial-input ivy-text
692 :history (ivy-state-history ivy-last)
693 :preselect (unless (eq (ivy-state-collection ivy-last)
694 'read-file-name-internal)
695 ivy--current)
696 :keymap (ivy-state-keymap ivy-last)
697 :update-fn (ivy-state-update-fn ivy-last)
698 :sort (ivy-state-sort ivy-last)
699 :action (ivy-state-action ivy-last)
700 :unwind (ivy-state-unwind ivy-last)
701 :re-builder (ivy-state-re-builder ivy-last)
702 :matcher (ivy-state-matcher ivy-last)
703 :dynamic-collection (ivy-state-dynamic-collection ivy-last)
704 :caller (ivy-state-caller ivy-last)))))
705
706 (defvar-local ivy-calling nil
707 "When non-nil, call the current action when `ivy--index' changes.")
708
709 (defun ivy-set-index (index)
710 "Set `ivy--index' to INDEX."
711 (setq ivy--index index)
712 (when ivy-calling
713 (ivy--exhibit)
714 (ivy-call)))
715
716 (defun ivy-beginning-of-buffer ()
717 "Select the first completion candidate."
718 (interactive)
719 (ivy-set-index 0))
720
721 (defun ivy-end-of-buffer ()
722 "Select the last completion candidate."
723 (interactive)
724 (ivy-set-index (1- ivy--length)))
725
726 (defun ivy-scroll-up-command ()
727 "Scroll the candidates upward by the minibuffer height."
728 (interactive)
729 (ivy-set-index (min (1- (+ ivy--index ivy-height))
730 (1- ivy--length))))
731
732 (defun ivy-scroll-down-command ()
733 "Scroll the candidates downward by the minibuffer height."
734 (interactive)
735 (ivy-set-index (max (1+ (- ivy--index ivy-height))
736 0)))
737
738 (defun ivy-minibuffer-grow ()
739 "Grow the minibuffer window by 1 line."
740 (interactive)
741 (setq-local max-mini-window-height
742 (cl-incf ivy-height)))
743
744 (defun ivy-minibuffer-shrink ()
745 "Shrink the minibuffer window by 1 line."
746 (interactive)
747 (unless (<= ivy-height 2)
748 (setq-local max-mini-window-height
749 (cl-decf ivy-height))
750 (window-resize (selected-window) -1)))
751
752 (defun ivy-next-line (&optional arg)
753 "Move cursor vertically down ARG candidates."
754 (interactive "p")
755 (setq arg (or arg 1))
756 (let ((index (+ ivy--index arg)))
757 (if (> index (1- ivy--length))
758 (if ivy-wrap
759 (ivy-beginning-of-buffer)
760 (ivy-set-index (1- ivy--length)))
761 (ivy-set-index index))))
762
763 (defun ivy-next-line-or-history (&optional arg)
764 "Move cursor vertically down ARG candidates.
765 If the input is empty, select the previous history element instead."
766 (interactive "p")
767 (if (string= ivy-text "")
768 (ivy-previous-history-element 1)
769 (ivy-next-line arg)))
770
771 (defun ivy-previous-line (&optional arg)
772 "Move cursor vertically up ARG candidates."
773 (interactive "p")
774 (setq arg (or arg 1))
775 (let ((index (- ivy--index arg)))
776 (if (< index 0)
777 (if ivy-wrap
778 (ivy-end-of-buffer)
779 (ivy-set-index 0))
780 (ivy-set-index index))))
781
782 (defun ivy-previous-line-or-history (arg)
783 "Move cursor vertically up ARG candidates.
784 If the input is empty, select the previous history element instead."
785 (interactive "p")
786 (when (string= ivy-text "")
787 (ivy-previous-history-element 1))
788 (ivy-previous-line arg))
789
790 (defun ivy-toggle-calling ()
791 "Flip `ivy-calling'."
792 (interactive)
793 (when (setq ivy-calling (not ivy-calling))
794 (ivy-call)))
795
796 (defun ivy-toggle-ignore ()
797 "Toggle user-configured candidate filtering."
798 (interactive)
799 (setq ivy-use-ignore (null ivy-use-ignore))
800 ;; invalidate cache
801 (setq ivy--old-cands nil))
802
803 (defun ivy--get-action (state)
804 "Get the action function from STATE."
805 (let ((action (ivy-state-action state)))
806 (when action
807 (if (functionp action)
808 action
809 (cadr (nth (car action) action))))))
810
811 (defun ivy--get-window (state)
812 "Get the window from STATE."
813 (if (ivy-state-p state)
814 (let ((window (ivy-state-window state)))
815 (if (window-live-p window)
816 window
817 (if (= (length (window-list)) 1)
818 (selected-window)
819 (next-window))))
820 (selected-window)))
821
822 (defun ivy--actionp (x)
823 "Return non-nil when X is a list of actions."
824 (and x (listp x) (not (eq (car x) 'closure))))
825
826 (defun ivy-next-action ()
827 "When the current action is a list, scroll it forwards."
828 (interactive)
829 (let ((action (ivy-state-action ivy-last)))
830 (when (ivy--actionp action)
831 (unless (>= (car action) (1- (length action)))
832 (cl-incf (car action))))))
833
834 (defun ivy-prev-action ()
835 "When the current action is a list, scroll it backwards."
836 (interactive)
837 (let ((action (ivy-state-action ivy-last)))
838 (when (ivy--actionp action)
839 (unless (<= (car action) 1)
840 (cl-decf (car action))))))
841
842 (defun ivy-action-name ()
843 "Return the name associated with the current action."
844 (let ((action (ivy-state-action ivy-last)))
845 (if (ivy--actionp action)
846 (format "[%d/%d] %s"
847 (car action)
848 (1- (length action))
849 (nth 2 (nth (car action) action)))
850 "[1/1] default")))
851
852 (defvar ivy-inhibit-action nil
853 "When non-nil, `ivy-call' does nothing.
854
855 Example use:
856
857 (let* ((ivy-inhibit-action t)
858 (str (counsel-locate \"lispy.el\")))
859 ;; do whatever with str - the corresponding file will not be opened
860 )")
861
862 (defun ivy-call ()
863 "Call the current action without exiting completion."
864 (interactive)
865 (unless ivy-inhibit-action
866 (let ((action (ivy--get-action ivy-last)))
867 (when action
868 (let* ((collection (ivy-state-collection ivy-last))
869 (x (if (and (consp collection)
870 (consp (car collection)))
871 (cdr (assoc ivy--current collection))
872 (if (equal ivy--current "")
873 ivy-text
874 ivy--current))))
875 (prog1 (funcall action x)
876 (unless (or (eq ivy-exit 'done)
877 (equal (selected-window)
878 (active-minibuffer-window))
879 (null (active-minibuffer-window)))
880 (select-window (active-minibuffer-window)))))))))
881
882 (defun ivy-next-line-and-call (&optional arg)
883 "Move cursor vertically down ARG candidates.
884 Call the permanent action if possible."
885 (interactive "p")
886 (ivy-next-line arg)
887 (ivy--exhibit)
888 (ivy-call))
889
890 (defun ivy-previous-line-and-call (&optional arg)
891 "Move cursor vertically down ARG candidates.
892 Call the permanent action if possible."
893 (interactive "p")
894 (ivy-previous-line arg)
895 (ivy--exhibit)
896 (ivy-call))
897
898 (defun ivy-previous-history-element (arg)
899 "Forward to `previous-history-element' with ARG."
900 (interactive "p")
901 (previous-history-element arg)
902 (ivy--cd-maybe)
903 (move-end-of-line 1)
904 (ivy--maybe-scroll-history))
905
906 (defun ivy-next-history-element (arg)
907 "Forward to `next-history-element' with ARG."
908 (interactive "p")
909 (if (and (= minibuffer-history-position 0)
910 (equal ivy-text ""))
911 (progn
912 (insert ivy--default)
913 (when (and (with-ivy-window (derived-mode-p 'prog-mode))
914 (eq (ivy-state-caller ivy-last) 'swiper)
915 (not (file-exists-p ivy--default))
916 (not (ffap-url-p ivy--default))
917 (not (ivy-state-dynamic-collection ivy-last))
918 (> (point) (minibuffer-prompt-end)))
919 (undo-boundary)
920 (insert "\\_>")
921 (goto-char (minibuffer-prompt-end))
922 (insert "\\_<")
923 (forward-char (+ 2 (length ivy--default)))))
924 (next-history-element arg))
925 (ivy--cd-maybe)
926 (move-end-of-line 1)
927 (ivy--maybe-scroll-history))
928
929 (defvar ivy-ffap-url-functions nil
930 "List of functions that check if the point is on a URL.")
931
932 (defun ivy--cd-maybe ()
933 "Check if the current input points to a different directory.
934 If so, move to that directory, while keeping only the file name."
935 (when ivy--directory
936 (let ((input (ivy--input))
937 url)
938 (if (setq url (or (ffap-url-p input)
939 (with-ivy-window
940 (cl-reduce
941 (lambda (a b)
942 (or a (funcall b)))
943 ivy-ffap-url-functions
944 :initial-value nil))))
945 (ivy-exit-with-action
946 (lambda (_)
947 (funcall ffap-url-fetcher url)))
948 (setq input (expand-file-name input))
949 (let ((file (file-name-nondirectory input))
950 (dir (expand-file-name (file-name-directory input))))
951 (if (string= dir ivy--directory)
952 (progn
953 (delete-minibuffer-contents)
954 (insert file))
955 (ivy--cd dir)
956 (insert file)))))))
957
958 (defun ivy--maybe-scroll-history ()
959 "If the selected history element has an index, scroll there."
960 (let ((idx (ignore-errors
961 (get-text-property
962 (minibuffer-prompt-end)
963 'ivy-index))))
964 (when idx
965 (ivy--exhibit)
966 (setq ivy--index idx))))
967
968 (defun ivy--cd (dir)
969 "When completing file names, move to directory DIR."
970 (if (null ivy--directory)
971 (error "Unexpected")
972 (setq ivy--old-cands nil)
973 (setq ivy--old-re nil)
974 (setq ivy--index 0)
975 (setq ivy--all-candidates
976 (ivy--sorted-files (setq ivy--directory dir)))
977 (setq ivy-text "")
978 (delete-minibuffer-contents)))
979
980 (defun ivy-backward-delete-char ()
981 "Forward to `backward-delete-char'.
982 On error (read-only), call `ivy-on-del-error-function'."
983 (interactive)
984 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
985 (progn
986 (ivy--cd (file-name-directory
987 (directory-file-name
988 (expand-file-name
989 ivy--directory))))
990 (ivy--exhibit))
991 (condition-case nil
992 (backward-delete-char 1)
993 (error
994 (when ivy-on-del-error-function
995 (funcall ivy-on-del-error-function))))))
996
997 (defun ivy-delete-char (arg)
998 "Forward to `delete-char' ARG."
999 (interactive "p")
1000 (unless (= (point) (line-end-position))
1001 (delete-char arg)))
1002
1003 (defun ivy-forward-char (arg)
1004 "Forward to `forward-char' ARG."
1005 (interactive "p")
1006 (unless (= (point) (line-end-position))
1007 (forward-char arg)))
1008
1009 (defun ivy-kill-word (arg)
1010 "Forward to `kill-word' ARG."
1011 (interactive "p")
1012 (unless (= (point) (line-end-position))
1013 (kill-word arg)))
1014
1015 (defun ivy-kill-line ()
1016 "Forward to `kill-line'."
1017 (interactive)
1018 (if (eolp)
1019 (kill-region (minibuffer-prompt-end) (point))
1020 (kill-line)))
1021
1022 (defun ivy-backward-kill-word ()
1023 "Forward to `backward-kill-word'."
1024 (interactive)
1025 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
1026 (progn
1027 (ivy--cd (file-name-directory
1028 (directory-file-name
1029 (expand-file-name
1030 ivy--directory))))
1031 (ivy--exhibit))
1032 (ignore-errors
1033 (let ((pt (point)))
1034 (forward-word -1)
1035 (delete-region (point) pt)))))
1036
1037 (defvar ivy--regexp-quote 'regexp-quote
1038 "Store the regexp quoting state.")
1039
1040 (defun ivy-toggle-regexp-quote ()
1041 "Toggle the regexp quoting."
1042 (interactive)
1043 (setq ivy--old-re nil)
1044 (cl-rotatef ivy--regex-function ivy--regexp-quote))
1045
1046 (defvar avy-all-windows)
1047 (defvar avy-action)
1048 (defvar avy-keys)
1049 (defvar avy-keys-alist)
1050 (defvar avy-style)
1051 (defvar avy-styles-alist)
1052 (declare-function avy--process "ext:avy")
1053 (declare-function avy--style-fn "ext:avy")
1054
1055 (eval-after-load 'avy
1056 '(add-to-list 'avy-styles-alist '(ivy-avy . pre)))
1057
1058 (defun ivy-avy ()
1059 "Jump to one of the current ivy candidates."
1060 (interactive)
1061 (unless (require 'avy nil 'noerror)
1062 (error "Package avy isn't installed"))
1063 (let* ((avy-all-windows nil)
1064 (avy-keys (or (cdr (assq 'ivy-avy avy-keys-alist))
1065 avy-keys))
1066 (avy-style (or (cdr (assq 'ivy-avy
1067 avy-styles-alist))
1068 avy-style))
1069 (candidate
1070 (let ((candidates))
1071 (save-excursion
1072 (save-restriction
1073 (narrow-to-region
1074 (window-start)
1075 (window-end))
1076 (goto-char (point-min))
1077 (forward-line)
1078 (while (< (point) (point-max))
1079 (push
1080 (cons (point)
1081 (selected-window))
1082 candidates)
1083 (forward-line))))
1084 (setq avy-action #'identity)
1085 (avy--process
1086 (nreverse candidates)
1087 (avy--style-fn avy-style)))))
1088 (when (numberp candidate)
1089 (ivy-set-index (- (line-number-at-pos candidate) 2))
1090 (ivy--exhibit)
1091 (ivy-done))))
1092
1093 (defun ivy-sort-file-function-default (x y)
1094 "Compare two files X and Y.
1095 Prioritize directories."
1096 (if (get-text-property 0 'dirp x)
1097 (if (get-text-property 0 'dirp y)
1098 (string< x y)
1099 t)
1100 (if (get-text-property 0 'dirp y)
1101 nil
1102 (string< x y))))
1103
1104 (defcustom ivy-sort-functions-alist
1105 '((read-file-name-internal . ivy-sort-file-function-default)
1106 (internal-complete-buffer . nil)
1107 (counsel-git-grep-function . nil)
1108 (Man-goto-section . nil)
1109 (org-refile . nil)
1110 (t . string-lessp))
1111 "An alist of sorting functions for each collection function.
1112 Interactive functions that call completion fit in here as well.
1113
1114 Nil means no sorting, which is useful to turn off the sorting for
1115 functions that have candidates in the natural buffer order, like
1116 `org-refile' or `Man-goto-section'.
1117
1118 The entry associated with t is used for all fall-through cases.
1119
1120 See also `ivy-sort-max-size'."
1121 :type
1122 '(alist
1123 :key-type (choice
1124 (const :tag "Fall-through" t)
1125 (symbol :tag "Collection"))
1126 :value-type (choice
1127 (const :tag "Plain sort" string-lessp)
1128 (const :tag "File sort" ivy-sort-file-function-default)
1129 (const :tag "No sort" nil)
1130 (function :tag "Custom function")))
1131 :group 'ivy)
1132
1133 (defvar ivy-index-functions-alist
1134 '((swiper . ivy-recompute-index-swiper)
1135 (swiper-multi . ivy-recompute-index-swiper)
1136 (counsel-git-grep . ivy-recompute-index-swiper)
1137 (counsel-grep . ivy-recompute-index-swiper-async)
1138 (t . ivy-recompute-index-zero))
1139 "An alist of index recomputing functions for each collection function.
1140 When the input changes, the appropriate function returns an
1141 integer - the index of the matched candidate that should be
1142 selected.")
1143
1144 (defvar ivy-re-builders-alist
1145 '((t . ivy--regex-plus))
1146 "An alist of regex building functions for each collection function.
1147
1148 Each key is (in order of priority):
1149 1. The actual collection function, e.g. `read-file-name-internal'.
1150 2. The symbol passed by :caller into `ivy-read'.
1151 3. `this-command'.
1152 4. t.
1153
1154 Each value is a function that should take a string and return a
1155 valid regex or a regex sequence (see below).
1156
1157 Possible choices: `ivy--regex', `regexp-quote',
1158 `ivy--regex-plus', `ivy--regex-fuzzy'.
1159
1160 If a function returns a list, it should format like this:
1161 '((\"matching-regexp\" . t) (\"non-matching-regexp\") ...).
1162
1163 The matches will be filtered in a sequence, you can mix the
1164 regexps that should match and that should not match as you
1165 like.")
1166
1167 (defvar ivy-initial-inputs-alist
1168 '((org-refile . "^")
1169 (org-agenda-refile . "^")
1170 (org-capture-refile . "^")
1171 (counsel-M-x . "^")
1172 (counsel-describe-function . "^")
1173 (counsel-describe-variable . "^")
1174 (man . "^")
1175 (woman . "^"))
1176 "Command to initial input table.")
1177
1178 (defcustom ivy-sort-max-size 30000
1179 "Sorting won't be done for collections larger than this."
1180 :type 'integer)
1181
1182 (defun ivy--sorted-files (dir)
1183 "Return the list of files in DIR.
1184 Directories come first."
1185 (let* ((default-directory dir)
1186 (seq (all-completions "" 'read-file-name-internal))
1187 sort-fn)
1188 (if (equal dir "/")
1189 seq
1190 (setq seq (delete "./" (delete "../" seq)))
1191 (when (eq (setq sort-fn (cdr (assoc 'read-file-name-internal
1192 ivy-sort-functions-alist)))
1193 #'ivy-sort-file-function-default)
1194 (setq seq (mapcar (lambda (x)
1195 (propertize x 'dirp (string-match-p "/\\'" x)))
1196 seq)))
1197 (when sort-fn
1198 (setq seq (cl-sort seq sort-fn)))
1199 (dolist (dir ivy-extra-directories)
1200 (push dir seq))
1201 seq)))
1202
1203 (defvar ivy-recursive-restore t
1204 "When non-nil, restore the above state when exiting the minibuffer.
1205 This variable is let-bound to nil by functions that take care of
1206 the restoring themselves.")
1207
1208 ;;** Entry Point
1209 (cl-defun ivy-read (prompt collection
1210 &key
1211 predicate require-match initial-input
1212 history preselect keymap update-fn sort
1213 action unwind re-builder matcher dynamic-collection caller)
1214 "Read a string in the minibuffer, with completion.
1215
1216 PROMPT is a format string, normally ending in a colon and a
1217 space; %d anywhere in the string is replaced by the current
1218 number of matching candidates. For the literal % character,
1219 escape it with %%. See also `ivy-count-format'.
1220
1221 COLLECTION is either a list of strings, a function, an alist, or
1222 a hash table.
1223
1224 If INITIAL-INPUT is not nil, then insert that input in the
1225 minibuffer initially.
1226
1227 KEYMAP is composed with `ivy-minibuffer-map'.
1228
1229 If PRESELECT is not nil, then select the corresponding candidate
1230 out of the ones that match the INITIAL-INPUT.
1231
1232 UPDATE-FN is called each time the current candidate(s) is changed.
1233
1234 When SORT is t, use `ivy-sort-functions-alist' for sorting.
1235
1236 ACTION is a lambda function to call after selecting a result. It
1237 takes a single string argument.
1238
1239 UNWIND is a lambda function to call before exiting.
1240
1241 RE-BUILDER is a lambda function to call to transform text into a
1242 regex pattern.
1243
1244 MATCHER is to override matching.
1245
1246 DYNAMIC-COLLECTION is a boolean to specify if the list of
1247 candidates is updated after each input by calling COLLECTION.
1248
1249 CALLER is a symbol to uniquely identify the caller to `ivy-read'.
1250 It is used, along with COLLECTION, to determine which
1251 customizations apply to the current completion session."
1252 (let ((extra-actions (delete-dups
1253 (append (plist-get ivy--actions-list t)
1254 (plist-get ivy--actions-list this-command)
1255 (plist-get ivy--actions-list caller)))))
1256 (when extra-actions
1257 (setq action
1258 (cond ((functionp action)
1259 `(1
1260 ("o" ,action "default")
1261 ,@extra-actions))
1262 ((null action)
1263 `(1
1264 ("o" identity "default")
1265 ,@extra-actions))
1266 (t
1267 (delete-dups (append action extra-actions)))))))
1268 (let ((extra-sources (plist-get ivy--sources-list caller)))
1269 (if extra-sources
1270 (progn
1271 (setq ivy--extra-candidates nil)
1272 (dolist (source extra-sources)
1273 (cond ((equal source '(original-source))
1274 (setq ivy--extra-candidates
1275 (cons source ivy--extra-candidates)))
1276 ((null (cdr source))
1277 (setq ivy--extra-candidates
1278 (cons
1279 (list (car source) (funcall (car source)))
1280 ivy--extra-candidates))))))
1281 (setq ivy--extra-candidates '((original-source)))))
1282 (let ((recursive-ivy-last (and (active-minibuffer-window) ivy-last))
1283 (transformer-fn
1284 (plist-get ivy--display-transformers-list
1285 (or caller (and (functionp collection)
1286 collection))))
1287 (original-action (and (consp action)
1288 (copy-sequence action))))
1289 (setq ivy-last
1290 (make-ivy-state
1291 :prompt prompt
1292 :collection collection
1293 :predicate predicate
1294 :require-match require-match
1295 :initial-input initial-input
1296 :history history
1297 :preselect preselect
1298 :keymap keymap
1299 :update-fn update-fn
1300 :sort sort
1301 :action action
1302 :window (selected-window)
1303 :buffer (current-buffer)
1304 :unwind unwind
1305 :re-builder re-builder
1306 :matcher matcher
1307 :dynamic-collection dynamic-collection
1308 :display-transformer-fn transformer-fn
1309 :caller caller))
1310 (ivy--reset-state ivy-last)
1311 (prog1
1312 (unwind-protect
1313 (minibuffer-with-setup-hook
1314 #'ivy--minibuffer-setup
1315 (let* ((hist (or history 'ivy-history))
1316 (minibuffer-completion-table collection)
1317 (minibuffer-completion-predicate predicate)
1318 (resize-mini-windows (cond
1319 ((display-graphic-p) nil)
1320 ((null resize-mini-windows) 'grow-only)
1321 (t resize-mini-windows))))
1322 (read-from-minibuffer
1323 prompt
1324 (ivy-state-initial-input ivy-last)
1325 (make-composed-keymap keymap ivy-minibuffer-map)
1326 nil
1327 hist)
1328 (when (eq ivy-exit 'done)
1329 (let ((item (if ivy--directory
1330 ivy--current
1331 ivy-text)))
1332 (unless (equal item "")
1333 (set hist (cons (propertize item 'ivy-index ivy--index)
1334 (delete item
1335 (cdr (symbol-value hist))))))))
1336 ivy--current))
1337 (remove-hook 'post-command-hook #'ivy--exhibit)
1338 (when (setq unwind (ivy-state-unwind ivy-last))
1339 (funcall unwind))
1340 (unless (eq ivy-exit 'done)
1341 (when recursive-ivy-last
1342 (ivy--reset-state (setq ivy-last recursive-ivy-last)))))
1343 (ivy-call)
1344 (when original-action
1345 (setf (ivy-state-action ivy-last) original-action))
1346 (when (and recursive-ivy-last
1347 ivy-recursive-restore)
1348 (ivy--reset-state (setq ivy-last recursive-ivy-last))))))
1349
1350 (defun ivy--reset-state (state)
1351 "Reset the ivy to STATE.
1352 This is useful for recursive `ivy-read'."
1353 (let ((prompt (or (ivy-state-prompt state) ""))
1354 (collection (ivy-state-collection state))
1355 (predicate (ivy-state-predicate state))
1356 (history (ivy-state-history state))
1357 (preselect (ivy-state-preselect state))
1358 (sort (ivy-state-sort state))
1359 (re-builder (ivy-state-re-builder state))
1360 (dynamic-collection (ivy-state-dynamic-collection state))
1361 (initial-input (ivy-state-initial-input state))
1362 (require-match (ivy-state-require-match state))
1363 (caller (ivy-state-caller state)))
1364 (unless initial-input
1365 (setq initial-input (cdr (assoc this-command
1366 ivy-initial-inputs-alist))))
1367 (setq ivy--directory nil)
1368 (setq ivy-case-fold-search 'auto)
1369 (setq ivy--regex-function
1370 (or re-builder
1371 (and (functionp collection)
1372 (cdr (assoc collection ivy-re-builders-alist)))
1373 (and caller
1374 (cdr (assoc caller ivy-re-builders-alist)))
1375 (cdr (assoc this-command ivy-re-builders-alist))
1376 (cdr (assoc t ivy-re-builders-alist))
1377 'ivy--regex))
1378 (setq ivy--subexps 0)
1379 (setq ivy--regexp-quote 'regexp-quote)
1380 (setq ivy--old-text "")
1381 (setq ivy--full-length nil)
1382 (setq ivy-text "")
1383 (setq ivy-calling nil)
1384 (setq ivy-use-ignore t)
1385 (let (coll sort-fn)
1386 (cond ((eq collection 'Info-read-node-name-1)
1387 (if (equal Info-current-file "dir")
1388 (setq coll
1389 (mapcar (lambda (x) (format "(%s)" x))
1390 (cl-delete-duplicates
1391 (all-completions "(" collection predicate)
1392 :test #'equal)))
1393 (setq coll (all-completions "" collection predicate))))
1394 ((eq collection 'read-file-name-internal)
1395 (setq ivy--directory default-directory)
1396 (require 'dired)
1397 (when preselect
1398 (let ((preselect-directory (file-name-directory preselect)))
1399 (unless (or (null preselect-directory)
1400 (string= preselect-directory
1401 default-directory))
1402 (setq ivy--directory preselect-directory))
1403 (setf
1404 (ivy-state-preselect state)
1405 (setq preselect (file-name-nondirectory preselect)))))
1406 (setq coll (ivy--sorted-files ivy--directory))
1407 (when initial-input
1408 (unless (or require-match
1409 (equal initial-input default-directory)
1410 (equal initial-input ""))
1411 (setq coll (cons initial-input coll)))
1412 (unless (and (ivy-state-action ivy-last)
1413 (not (equal (ivy--get-action ivy-last) 'identity)))
1414 (setq initial-input nil))))
1415 ((eq collection 'internal-complete-buffer)
1416 (setq coll (ivy--buffer-list "" ivy-use-virtual-buffers)))
1417 (dynamic-collection
1418 (setq coll (funcall collection ivy-text)))
1419 ((or (functionp collection)
1420 (byte-code-function-p collection)
1421 (vectorp collection)
1422 (and (consp collection) (listp (car collection)))
1423 (hash-table-p collection)
1424 (and (listp collection) (symbolp (car collection))))
1425 (setq coll (all-completions "" collection predicate)))
1426 (t
1427 (setq coll collection)))
1428 (when sort
1429 (if (and (functionp collection)
1430 (setq sort-fn (assoc collection ivy-sort-functions-alist)))
1431 (when (and (setq sort-fn (cdr sort-fn))
1432 (not (eq collection 'read-file-name-internal)))
1433 (setq coll (cl-sort coll sort-fn)))
1434 (unless (eq history 'org-refile-history)
1435 (if (and (setq sort-fn (cdr (assoc t ivy-sort-functions-alist)))
1436 (<= (length coll) ivy-sort-max-size))
1437 (setq coll (cl-sort (copy-sequence coll) sort-fn))))))
1438 (setq coll (ivy--set-candidates coll))
1439 (when preselect
1440 (unless (or (and require-match
1441 (not (eq collection 'internal-complete-buffer)))
1442 dynamic-collection
1443 (let ((re (regexp-quote preselect)))
1444 (cl-find-if (lambda (x) (string-match re x))
1445 coll)))
1446 (setq coll (cons preselect coll))))
1447 (setq ivy--old-re nil)
1448 (setq ivy--old-cands nil)
1449 (when (integerp preselect)
1450 (setq ivy--old-re "")
1451 (setq ivy--index preselect))
1452 (when initial-input
1453 ;; Needed for anchor to work
1454 (setq ivy--old-cands coll)
1455 (setq ivy--old-cands (ivy--filter initial-input coll)))
1456 (setq ivy--all-candidates coll)
1457 (unless (integerp preselect)
1458 (setq ivy--index (or
1459 (and dynamic-collection
1460 ivy--index)
1461 (and preselect
1462 (ivy--preselect-index
1463 preselect
1464 (if initial-input
1465 ivy--old-cands
1466 coll)))
1467 0))))
1468 (setq ivy-exit nil)
1469 (setq ivy--default
1470 (if (region-active-p)
1471 (buffer-substring
1472 (region-beginning)
1473 (region-end))
1474 (ivy-thing-at-point)))
1475 (setq ivy--prompt
1476 (cond ((string-match "%.*d" prompt)
1477 prompt)
1478 ((null ivy-count-format)
1479 (error
1480 "`ivy-count-format' can't be nil. Set it to an empty string instead"))
1481 ((string-match "%d.*%d" ivy-count-format)
1482 (let ((w (length (number-to-string
1483 (length ivy--all-candidates))))
1484 (s (copy-sequence ivy-count-format)))
1485 (string-match "%d" s)
1486 (match-end 0)
1487 (string-match "%d" s (match-end 0))
1488 (setq s (replace-match (format "%%-%dd" w) nil nil s))
1489 (string-match "%d" s)
1490 (concat (replace-match (format "%%%dd" w) nil nil s)
1491 prompt)))
1492 ((string-match "%.*d" ivy-count-format)
1493 (concat ivy-count-format prompt))
1494 (ivy--directory
1495 prompt)
1496 (t
1497 prompt)))
1498 (setf (ivy-state-initial-input ivy-last) initial-input)))
1499
1500 ;;;###autoload
1501 (defun ivy-completing-read (prompt collection
1502 &optional predicate require-match initial-input
1503 history def inherit-input-method)
1504 "Read a string in the minibuffer, with completion.
1505
1506 This interface conforms to `completing-read' and can be used for
1507 `completing-read-function'.
1508
1509 PROMPT is a string that normally ends in a colon and a space.
1510 COLLECTION is either a list of strings, an alist, an obarray, or a hash table.
1511 PREDICATE limits completion to a subset of COLLECTION.
1512 REQUIRE-MATCH is a boolean value. See `completing-read'.
1513 INITIAL-INPUT is a string inserted into the minibuffer initially.
1514 HISTORY is a list of previously selected inputs.
1515 DEF is the default value.
1516 INHERIT-INPUT-METHOD is currently ignored."
1517 (if (memq this-command '(tmm-menubar tmm-shortcut))
1518 (completing-read-default prompt collection
1519 predicate require-match
1520 initial-input history
1521 def inherit-input-method)
1522 ;; See the doc of `completing-read'.
1523 (when (consp history)
1524 (when (numberp (cdr history))
1525 (setq initial-input (nth (1- (cdr history))
1526 (symbol-value (car history)))))
1527 (setq history (car history)))
1528 (ivy-read (replace-regexp-in-string "%" "%%" prompt)
1529 collection
1530 :predicate predicate
1531 :require-match require-match
1532 :initial-input (if (consp initial-input)
1533 (car initial-input)
1534 (if (and (stringp initial-input)
1535 (string-match "\\+" initial-input))
1536 (replace-regexp-in-string
1537 "\\+" "\\\\+" initial-input)
1538 initial-input))
1539 :preselect (if (listp def) (car def) def)
1540 :history history
1541 :keymap nil
1542 :sort
1543 (let ((sort (or (assoc this-command ivy-sort-functions-alist)
1544 (assoc t ivy-sort-functions-alist))))
1545 (if sort
1546 (cdr sort)
1547 t)))))
1548
1549 (defvar ivy-completion-beg nil
1550 "Completion bounds start.")
1551
1552 (defvar ivy-completion-end nil
1553 "Completion bounds end.")
1554
1555 (defun ivy-completion-in-region-action (str)
1556 "Insert STR, erasing the previous one.
1557 The previous string is between `ivy-completion-beg' and `ivy-completion-end'."
1558 (when (stringp str)
1559 (with-ivy-window
1560 (when ivy-completion-beg
1561 (delete-region
1562 ivy-completion-beg
1563 ivy-completion-end))
1564 (setq ivy-completion-beg
1565 (move-marker (make-marker) (point)))
1566 (insert str)
1567 (setq ivy-completion-end
1568 (move-marker (make-marker) (point))))))
1569
1570 (defun ivy-completion-common-length (str)
1571 "Return the length of the first 'completions-common-part face in STR."
1572 (let ((pos 0)
1573 (len (length str)))
1574 (while (and (<= pos len)
1575 (let ((prop (get-text-property pos 'face str)))
1576 (not (eq 'completions-common-part
1577 (if (listp prop) (car prop) prop)))))
1578 (setq pos (1+ pos)))
1579 (if (< pos len)
1580 (or (next-single-property-change pos 'face str) len)
1581 0)))
1582
1583 (defun ivy-completion-in-region (start end collection &optional predicate)
1584 "An Ivy function suitable for `completion-in-region-function'."
1585 (let* ((enable-recursive-minibuffers t)
1586 (str (buffer-substring-no-properties start end))
1587 (completion-ignore-case case-fold-search)
1588 (comps
1589 (completion-all-completions str collection predicate (- end start))))
1590 (if (null comps)
1591 (message "No matches")
1592 (nconc comps nil)
1593 (setq ivy-completion-beg (- end (ivy-completion-common-length (car comps))))
1594 (setq ivy-completion-end end)
1595 (if (null (cdr comps))
1596 (if (string= str (car comps))
1597 (message "Sole match")
1598 (setf (ivy-state-window ivy-last) (selected-window))
1599 (ivy-completion-in-region-action
1600 (substring-no-properties
1601 (car comps))))
1602 (let* ((w (1+ (floor (log (length comps) 10))))
1603 (ivy-count-format (if (string= ivy-count-format "")
1604 ivy-count-format
1605 (format "%%-%dd " w)))
1606 (prompt (format "(%s): " str)))
1607 (and
1608 (ivy-read (if (string= ivy-count-format "")
1609 prompt
1610 (replace-regexp-in-string "%" "%%" prompt))
1611 ;; remove 'completions-first-difference face
1612 (mapcar #'substring-no-properties comps)
1613 :predicate predicate
1614 :action #'ivy-completion-in-region-action
1615 :require-match t)
1616 t))))))
1617
1618 (defcustom ivy-do-completion-in-region t
1619 "When non-nil `ivy-mode' will set `completion-in-region-function'."
1620 :type 'boolean)
1621
1622 ;;;###autoload
1623 (define-minor-mode ivy-mode
1624 "Toggle Ivy mode on or off.
1625 Turn Ivy mode on if ARG is positive, off otherwise.
1626 Turning on Ivy mode sets `completing-read-function' to
1627 `ivy-completing-read'.
1628
1629 Global bindings:
1630 \\{ivy-mode-map}
1631
1632 Minibuffer bindings:
1633 \\{ivy-minibuffer-map}"
1634 :group 'ivy
1635 :global t
1636 :keymap ivy-mode-map
1637 :lighter " ivy"
1638 (if ivy-mode
1639 (progn
1640 (setq completing-read-function 'ivy-completing-read)
1641 (when ivy-do-completion-in-region
1642 (setq completion-in-region-function 'ivy-completion-in-region)))
1643 (setq completing-read-function 'completing-read-default)
1644 (setq completion-in-region-function 'completion--in-region)))
1645
1646 (defun ivy--preselect-index (preselect candidates)
1647 "Return the index of PRESELECT in CANDIDATES."
1648 (cond ((integerp preselect)
1649 preselect)
1650 ((cl-position preselect candidates :test #'equal))
1651 ((stringp preselect)
1652 (let ((re preselect))
1653 (cl-position-if
1654 (lambda (x)
1655 (string-match re x))
1656 candidates)))))
1657
1658 ;;* Implementation
1659 ;;** Regex
1660 (defvar ivy--regex-hash
1661 (make-hash-table :test #'equal)
1662 "Store pre-computed regex.")
1663
1664 (defun ivy--split (str)
1665 "Split STR into a list by single spaces.
1666 The remaining spaces stick to their left.
1667 This allows to \"quote\" N spaces by inputting N+1 spaces."
1668 (let ((len (length str))
1669 start0
1670 (start1 0)
1671 res s
1672 match-len)
1673 (while (and (string-match " +" str start1)
1674 (< start1 len))
1675 (setq match-len (- (match-end 0) (match-beginning 0)))
1676 (if (= match-len 1)
1677 (progn
1678 (when start0
1679 (setq start1 start0)
1680 (setq start0 nil))
1681 (push (substring str start1 (match-beginning 0)) res)
1682 (setq start1 (match-end 0)))
1683 (setq str (replace-match
1684 (make-string (1- match-len) ?\ )
1685 nil nil str))
1686 (setq start0 (or start0 start1))
1687 (setq start1 (1- (match-end 0)))))
1688 (if start0
1689 (push (substring str start0) res)
1690 (setq s (substring str start1))
1691 (unless (= (length s) 0)
1692 (push s res)))
1693 (nreverse res)))
1694
1695 (defun ivy--regex (str &optional greedy)
1696 "Re-build regex pattern from STR in case it has a space.
1697 When GREEDY is non-nil, join words in a greedy way."
1698 (let ((hashed (unless greedy
1699 (gethash str ivy--regex-hash))))
1700 (if hashed
1701 (prog1 (cdr hashed)
1702 (setq ivy--subexps (car hashed)))
1703 (when (string-match "\\([^\\]\\|^\\)\\\\$" str)
1704 (setq str (substring str 0 -1)))
1705 (cdr (puthash str
1706 (let ((subs (ivy--split str)))
1707 (if (= (length subs) 1)
1708 (cons
1709 (setq ivy--subexps 0)
1710 (car subs))
1711 (cons
1712 (setq ivy--subexps (length subs))
1713 (mapconcat
1714 (lambda (x)
1715 (if (string-match "\\`\\\\([^?].*\\\\)\\'" x)
1716 x
1717 (format "\\(%s\\)" x)))
1718 subs
1719 (if greedy
1720 ".*"
1721 ".*?")))))
1722 ivy--regex-hash)))))
1723
1724 (defun ivy--regex-ignore-order--part (str &optional discard)
1725 "Re-build regex from STR by splitting at spaces.
1726 Ignore the order of each group."
1727 (let* ((subs (split-string str " +" t))
1728 (len (length subs)))
1729 (cl-case len
1730 (0
1731 "")
1732 (t
1733 (mapcar (lambda (x) (cons x (not discard)))
1734 subs)))))
1735
1736 (defun ivy--regex-ignore-order (str)
1737 "Re-build regex from STR by splitting at spaces.
1738 Ignore the order of each group. Everything before \"!\" should
1739 match. Everything after \"!\" should not match."
1740 (let ((parts (split-string str "!" t)))
1741 (cl-case (length parts)
1742 (0
1743 "")
1744 (1
1745 (if (string= (substring str 0 1) "!")
1746 (list (cons "" t)
1747 (ivy--regex-ignore-order--part (car parts) t))
1748 (ivy--regex-ignore-order--part (car parts))))
1749 (2
1750 (append
1751 (ivy--regex-ignore-order--part (car parts))
1752 (ivy--regex-ignore-order--part (cadr parts) t)))
1753 (t (error "Unexpected: use only one !")))))
1754
1755 (defun ivy--regex-plus (str)
1756 "Build a regex sequence from STR.
1757 Spaces are wild card characters, everything before \"!\" should
1758 match. Everything after \"!\" should not match."
1759 (let ((parts (split-string str "!" t)))
1760 (cl-case (length parts)
1761 (0
1762 "")
1763 (1
1764 (if (string= (substring str 0 1) "!")
1765 (list (cons "" t)
1766 (list (ivy--regex (car parts))))
1767 (ivy--regex (car parts))))
1768 (2
1769 (cons
1770 (cons (ivy--regex (car parts)) t)
1771 (mapcar #'list (split-string (cadr parts) " " t))))
1772 (t (error "Unexpected: use only one !")))))
1773
1774 (defun ivy--regex-fuzzy (str)
1775 "Build a regex sequence from STR.
1776 Insert .* between each char."
1777 (if (string-match "\\`\\(\\^?\\)\\(.*?\\)\\(\\$?\\)\\'" str)
1778 (prog1
1779 (concat (match-string 1 str)
1780 (mapconcat
1781 (lambda (x)
1782 (format "\\(%c\\)" x))
1783 (string-to-list (match-string 2 str)) ".*")
1784 (match-string 3 str))
1785 (setq ivy--subexps (length (match-string 2 str))))
1786 str))
1787
1788 (defcustom ivy-fixed-height-minibuffer nil
1789 "When non nil, fix the height of the minibuffer during ivy
1790 completion at `ivy-height'. This effectively sets the minimum
1791 height at this level and tries to ensure that it does not change
1792 depending on the number of candidates."
1793 :group 'ivy
1794 :type 'boolean)
1795
1796 ;;** Rest
1797 (defun ivy--minibuffer-setup ()
1798 "Setup ivy completion in the minibuffer."
1799 (set (make-local-variable 'completion-show-inline-help) nil)
1800 (set (make-local-variable 'minibuffer-default-add-function)
1801 (lambda ()
1802 (list ivy--default)))
1803 (when (display-graphic-p)
1804 (setq truncate-lines t))
1805 (setq-local max-mini-window-height ivy-height)
1806 (when ivy-fixed-height-minibuffer
1807 (set-window-text-height (selected-window) ivy-height))
1808 (add-hook 'post-command-hook #'ivy--exhibit nil t)
1809 ;; show completions with empty input
1810 (ivy--exhibit))
1811
1812 (defun ivy--input ()
1813 "Return the current minibuffer input."
1814 ;; assume one-line minibuffer input
1815 (buffer-substring-no-properties
1816 (minibuffer-prompt-end)
1817 (line-end-position)))
1818
1819 (defun ivy--cleanup ()
1820 "Delete the displayed completion candidates."
1821 (save-excursion
1822 (goto-char (minibuffer-prompt-end))
1823 (delete-region (line-end-position) (point-max))))
1824
1825 (defun ivy--insert-prompt ()
1826 "Update the prompt according to `ivy--prompt'."
1827 (when ivy--prompt
1828 (unless (memq this-command '(ivy-done ivy-alt-done ivy-partial-or-done
1829 counsel-find-symbol))
1830 (setq ivy--prompt-extra ""))
1831 (let (head tail)
1832 (if (string-match "\\(.*\\): \\'" ivy--prompt)
1833 (progn
1834 (setq head (match-string 1 ivy--prompt))
1835 (setq tail ": "))
1836 (setq head (substring ivy--prompt 0 -1))
1837 (setq tail " "))
1838 (let ((inhibit-read-only t)
1839 (std-props '(front-sticky t rear-nonsticky t field t read-only t))
1840 (n-str
1841 (concat
1842 (if (and (bound-and-true-p minibuffer-depth-indicate-mode)
1843 (> (minibuffer-depth) 1))
1844 (format "[%d] " (minibuffer-depth))
1845 "")
1846 (concat
1847 (if (string-match "%d.*%d" ivy-count-format)
1848 (format head
1849 (1+ ivy--index)
1850 (or (and (ivy-state-dynamic-collection ivy-last)
1851 ivy--full-length)
1852 ivy--length))
1853 (format head
1854 (or (and (ivy-state-dynamic-collection ivy-last)
1855 ivy--full-length)
1856 ivy--length)))
1857 ivy--prompt-extra
1858 tail)))
1859 (d-str (if ivy--directory
1860 (abbreviate-file-name ivy--directory)
1861 "")))
1862 (save-excursion
1863 (goto-char (point-min))
1864 (delete-region (point-min) (minibuffer-prompt-end))
1865 (if (> (+ (mod (+ (length n-str) (length d-str)) (window-width))
1866 (length ivy-text))
1867 (window-width))
1868 (setq n-str (concat n-str "\n" d-str))
1869 (setq n-str (concat n-str d-str)))
1870 (when ivy-add-newline-after-prompt
1871 (setq n-str (concat n-str "\n")))
1872 (let ((regex (format "\\([^\n]\\{%d\\}\\)[^\n]" (window-width))))
1873 (while (string-match regex n-str)
1874 (setq n-str (replace-match (concat (match-string 1 n-str) "\n") nil t n-str 1))))
1875 (set-text-properties 0 (length n-str)
1876 `(face minibuffer-prompt ,@std-props)
1877 n-str)
1878 (ivy--set-match-props n-str "confirm"
1879 `(face ivy-confirm-face ,@std-props))
1880 (ivy--set-match-props n-str "match required"
1881 `(face ivy-match-required-face ,@std-props))
1882 (insert n-str))
1883 ;; get out of the prompt area
1884 (constrain-to-field nil (point-max))))))
1885
1886 (defun ivy--set-match-props (str match props)
1887 "Set STR text properties that match MATCH to PROPS."
1888 (when (string-match match str)
1889 (set-text-properties
1890 (match-beginning 0)
1891 (match-end 0)
1892 props
1893 str)))
1894
1895 (defvar inhibit-message)
1896
1897 (defun ivy--sort-maybe (collection)
1898 "Sort COLLECTION if needed."
1899 (let ((sort (ivy-state-sort ivy-last))
1900 entry)
1901 (if (null sort)
1902 collection
1903 (let ((sort-fn (cond ((functionp sort)
1904 sort)
1905 ((setq entry (assoc (ivy-state-collection ivy-last)
1906 ivy-sort-functions-alist))
1907 (cdr entry))
1908 (t
1909 (cdr (assoc t ivy-sort-functions-alist))))))
1910 (if (functionp sort-fn)
1911 (cl-sort (copy-sequence collection) sort-fn)
1912 collection)))))
1913
1914 (defun ivy--exhibit ()
1915 "Insert Ivy completions display.
1916 Should be run via minibuffer `post-command-hook'."
1917 (when (memq 'ivy--exhibit post-command-hook)
1918 (let ((inhibit-field-text-motion nil))
1919 (constrain-to-field nil (point-max)))
1920 (setq ivy-text (ivy--input))
1921 (if (ivy-state-dynamic-collection ivy-last)
1922 ;; while-no-input would cause annoying
1923 ;; "Waiting for process to die...done" message interruptions
1924 (let ((inhibit-message t))
1925 (unless (equal ivy--old-text ivy-text)
1926 (while-no-input
1927 (setq ivy--all-candidates
1928 (ivy--sort-maybe
1929 (funcall (ivy-state-collection ivy-last) ivy-text)))
1930 (setq ivy--old-text ivy-text)))
1931 (when ivy--all-candidates
1932 (ivy--insert-minibuffer
1933 (ivy--format ivy--all-candidates))))
1934 (cond (ivy--directory
1935 (if (string-match "/\\'" ivy-text)
1936 (if (member ivy-text ivy--all-candidates)
1937 (ivy--cd (expand-file-name ivy-text ivy--directory))
1938 (when (string-match "//\\'" ivy-text)
1939 (if (and default-directory
1940 (string-match "\\`[[:alpha:]]:/" default-directory))
1941 (ivy--cd (match-string 0 default-directory))
1942 (ivy--cd "/")))
1943 (when (string-match "[[:alpha:]]:/$" ivy-text)
1944 (let ((drive-root (match-string 0 ivy-text)))
1945 (when (file-exists-p drive-root)
1946 (ivy--cd drive-root)))))
1947 (if (string-match "\\`~\\'" ivy-text)
1948 (ivy--cd (expand-file-name "~/")))))
1949 ((eq (ivy-state-collection ivy-last) 'internal-complete-buffer)
1950 (when (or (and (string-match "\\` " ivy-text)
1951 (not (string-match "\\` " ivy--old-text)))
1952 (and (string-match "\\` " ivy--old-text)
1953 (not (string-match "\\` " ivy-text))))
1954 (setq ivy--all-candidates
1955 (if (and (> (length ivy-text) 0)
1956 (eq (aref ivy-text 0)
1957 ?\ ))
1958 (ivy--buffer-list " ")
1959 (ivy--buffer-list "" ivy-use-virtual-buffers)))
1960 (setq ivy--old-re nil))))
1961 (ivy--insert-minibuffer
1962 (with-current-buffer (ivy-state-buffer ivy-last)
1963 (ivy--format
1964 (ivy--filter ivy-text ivy--all-candidates))))
1965 (setq ivy--old-text ivy-text))))
1966
1967 (defun ivy--insert-minibuffer (text)
1968 "Insert TEXT into minibuffer with appropriate cleanup."
1969 (let ((resize-mini-windows nil)
1970 (update-fn (ivy-state-update-fn ivy-last))
1971 deactivate-mark)
1972 (ivy--cleanup)
1973 (when update-fn
1974 (funcall update-fn))
1975 (ivy--insert-prompt)
1976 ;; Do nothing if while-no-input was aborted.
1977 (when (stringp text)
1978 (let ((buffer-undo-list t))
1979 (save-excursion
1980 (forward-line 1)
1981 (insert text))))
1982 (when (display-graphic-p)
1983 (ivy--resize-minibuffer-to-fit))))
1984
1985 (defun ivy--resize-minibuffer-to-fit ()
1986 "Resize the minibuffer window size to fit the text in the minibuffer."
1987 (unless (frame-root-window-p (minibuffer-window))
1988 (with-selected-window (minibuffer-window)
1989 (if (fboundp 'window-text-pixel-size)
1990 (let ((text-height (cdr (window-text-pixel-size)))
1991 (body-height (window-body-height nil t)))
1992 (when (> text-height body-height)
1993 ;; Note: the size increment needs to be at least frame-char-height,
1994 ;; otherwise resizing won't do anything.
1995 (let ((delta (max (- text-height body-height) (frame-char-height))))
1996 (window-resize nil delta nil t t))))
1997 (let ((text-height (count-screen-lines))
1998 (body-height (window-body-height)))
1999 (when (> text-height body-height)
2000 (window-resize nil (- text-height body-height) nil t)))))))
2001
2002 (declare-function colir-blend-face-background "ext:colir")
2003
2004 (defun ivy--add-face (str face)
2005 "Propertize STR with FACE.
2006 `font-lock-append-text-property' is used, since it's better than
2007 `propertize' or `add-face-text-property' in this case."
2008 (require 'colir)
2009 (condition-case nil
2010 (progn
2011 (colir-blend-face-background 0 (length str) face str)
2012 (let ((foreground (face-foreground face)))
2013 (when foreground
2014 (add-face-text-property
2015 0 (length str)
2016 `(:foreground ,foreground)
2017 nil
2018 str))))
2019 (error
2020 (ignore-errors
2021 (font-lock-append-text-property 0 (length str) 'face face str))))
2022 str)
2023
2024 (declare-function flx-make-string-cache "ext:flx")
2025 (declare-function flx-score "ext:flx")
2026
2027 (defvar ivy--flx-cache nil)
2028
2029 (eval-after-load 'flx
2030 '(setq ivy--flx-cache (flx-make-string-cache)))
2031
2032 (defun ivy-toggle-case-fold ()
2033 "Toggle the case folding between nil and auto.
2034 In any completion session, the case folding starts in auto:
2035
2036 - when the input is all lower case, `case-fold-search' is t
2037 - otherwise nil.
2038
2039 You can toggle this to make `case-fold-search' nil regardless of input."
2040 (interactive)
2041 (setq ivy-case-fold-search
2042 (if ivy-case-fold-search
2043 nil
2044 'auto))
2045 ;; reset cache so that the candidate list updates
2046 (setq ivy--old-re nil))
2047
2048 (defun ivy--re-filter (re candidates)
2049 "Return all RE matching CANDIDATES.
2050 RE is a list of cons cells, with a regexp car and a boolean cdr.
2051 When the cdr is t, the car must match.
2052 Otherwise, the car must not match."
2053 (let ((re-list (if (stringp re) (list (cons re t)) re))
2054 (res candidates))
2055 (dolist (re re-list)
2056 (setq res
2057 (ignore-errors
2058 (funcall
2059 (if (cdr re)
2060 #'cl-remove-if-not
2061 #'cl-remove-if)
2062 (let ((re-str (car re)))
2063 (lambda (x) (string-match re-str x)))
2064 res))))
2065 res))
2066
2067 (defun ivy--filter (name candidates)
2068 "Return all items that match NAME in CANDIDATES.
2069 CANDIDATES are assumed to be static."
2070 (let ((re (funcall ivy--regex-function name)))
2071 (if (and (equal re ivy--old-re)
2072 ivy--old-cands)
2073 ;; quick caching for "C-n", "C-p" etc.
2074 ivy--old-cands
2075 (let* ((re-str (if (listp re) (caar re) re))
2076 (matcher (ivy-state-matcher ivy-last))
2077 (case-fold-search
2078 (and ivy-case-fold-search
2079 (string= name (downcase name))))
2080 (cands (cond
2081 (matcher
2082 (funcall matcher re candidates))
2083 ((and ivy--old-re
2084 (stringp re)
2085 (stringp ivy--old-re)
2086 (not (string-match "\\\\" ivy--old-re))
2087 (not (equal ivy--old-re ""))
2088 (memq (cl-search
2089 (if (string-match "\\\\)\\'" ivy--old-re)
2090 (substring ivy--old-re 0 -2)
2091 ivy--old-re)
2092 re)
2093 '(0 2)))
2094 (ignore-errors
2095 (cl-remove-if-not
2096 (lambda (x) (string-match re x))
2097 ivy--old-cands)))
2098 (t
2099 (ivy--re-filter re candidates)))))
2100 (ivy--recompute-index name re-str cands)
2101 (setq ivy--old-re
2102 (if (eq ivy--regex-function 'ivy--regex-ignore-order)
2103 re
2104 (if cands
2105 re-str
2106 "")))
2107 (setq ivy--old-cands (ivy--sort name cands))))))
2108
2109 (defun ivy--set-candidates (x)
2110 "Update `ivy--all-candidates' with X."
2111 (let (res)
2112 (dolist (source ivy--extra-candidates)
2113 (if (equal source '(original-source))
2114 (if (null res)
2115 (setq res x)
2116 (setq res (append x res)))
2117 (setq ivy--old-re nil)
2118 (setq res (append
2119 (ivy--filter ivy-text (cadr source))
2120 res))))
2121 (setq ivy--all-candidates res)))
2122
2123 (defcustom ivy-sort-matches-functions-alist '((t . nil))
2124 "An alist of functions for sorting matching candidates.
2125
2126 Unlike `ivy-sort-functions-alist', which is used to sort the
2127 whole collection only once, this alist of functions are used to
2128 sort only matching candidates after each change in input.
2129
2130 The alist KEY is either a collection function or t to match
2131 previously unmatched collection functions.
2132
2133 The alist VAL is a sorting function with the signature of
2134 `ivy--prefix-sort'."
2135 :type '(alist
2136 :key-type (choice
2137 (const :tag "Fall-through" t)
2138 (symbol :tag "Collection"))
2139 :value-type
2140 (choice
2141 (const :tag "Don't sort" nil)
2142 (const :tag "Put prefix matches ahead" 'ivy--prefix-sort)
2143 (function :tag "Custom sort function"))))
2144
2145 (defun ivy--sort-files-by-date (_name candidates)
2146 "Re-soft CANDIDATES according to file modification date."
2147 (let ((default-directory ivy--directory))
2148 (cl-sort (copy-sequence candidates)
2149 (lambda (f1 f2)
2150 (time-less-p
2151 (nth 5 (file-attributes f2))
2152 (nth 5 (file-attributes f1)))))))
2153
2154 (defun ivy--sort (name candidates)
2155 "Re-sort CANDIDATES by NAME.
2156 All CANDIDATES are assumed to match NAME."
2157 (let ((key (or (ivy-state-caller ivy-last)
2158 (when (functionp (ivy-state-collection ivy-last))
2159 (ivy-state-collection ivy-last))))
2160 fun)
2161 (cond ((and (require 'flx nil 'noerror)
2162 (eq ivy--regex-function 'ivy--regex-fuzzy))
2163 (ivy--flx-sort name candidates))
2164 ((setq fun (cdr (or (assoc key ivy-sort-matches-functions-alist)
2165 (assoc t ivy-sort-matches-functions-alist))))
2166 (funcall fun name candidates))
2167 (t
2168 candidates))))
2169
2170 (defun ivy--prefix-sort (name candidates)
2171 "Re-sort CANDIDATES.
2172 Prefix matches to NAME are put ahead of the list."
2173 (if (or (string-match "^\\^" name) (string= name ""))
2174 candidates
2175 (let ((re-prefix (concat "^" (funcall ivy--regex-function name)))
2176 res-prefix
2177 res-noprefix)
2178 (dolist (s candidates)
2179 (if (string-match re-prefix s)
2180 (push s res-prefix)
2181 (push s res-noprefix)))
2182 (nconc
2183 (nreverse res-prefix)
2184 (nreverse res-noprefix)))))
2185
2186 (defun ivy--recompute-index (name re-str cands)
2187 (let* ((caller (ivy-state-caller ivy-last))
2188 (func (or (and caller (cdr (assoc caller ivy-index-functions-alist)))
2189 (cdr (assoc t ivy-index-functions-alist))
2190 #'ivy-recompute-index-zero)))
2191 (unless (eq this-command 'ivy-resume)
2192 (setq ivy--index
2193 (or
2194 (cl-position (if (and (> (length name) 0)
2195 (eq ?^ (aref name 0)))
2196 (substring name 1)
2197 name) cands
2198 :test #'equal)
2199 (and ivy--directory
2200 (cl-position
2201 (concat re-str "/") cands
2202 :test #'equal))
2203 (and (not (string= name ""))
2204 (not (and (require 'flx nil 'noerror)
2205 (eq ivy--regex-function 'ivy--regex-fuzzy)
2206 (< (length cands) 200)))
2207 ivy--old-cands
2208 (cl-position (nth ivy--index ivy--old-cands)
2209 cands))
2210 (funcall func re-str cands))))
2211 (when (and (or (string= name "")
2212 (string= name "^"))
2213 (not (equal ivy--old-re "")))
2214 (setq ivy--index
2215 (or (ivy--preselect-index
2216 (ivy-state-preselect ivy-last)
2217 cands)
2218 ivy--index)))))
2219
2220 (defun ivy-recompute-index-swiper (_re-str cands)
2221 (let ((tail (nthcdr ivy--index ivy--old-cands))
2222 idx)
2223 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
2224 (progn
2225 (while (and tail (null idx))
2226 ;; Compare with eq to handle equal duplicates in cands
2227 (setq idx (cl-position (pop tail) cands)))
2228 (or
2229 idx
2230 (1- (length cands))))
2231 (if ivy--old-cands
2232 ivy--index
2233 ;; already in ivy-state-buffer
2234 (let ((n (line-number-at-pos))
2235 (res 0)
2236 (i 0))
2237 (dolist (c cands)
2238 (when (eq n (read (get-text-property 0 'display c)))
2239 (setq res i))
2240 (cl-incf i))
2241 res)))))
2242
2243 (defun ivy-recompute-index-swiper-async (_re-str cands)
2244 (if (null ivy--old-cands)
2245 (let ((ln (with-ivy-window
2246 (line-number-at-pos))))
2247 (or (cl-position-if (lambda (x)
2248 (>= (string-to-number x) ln))
2249 cands)
2250 0))
2251 (let ((tail (nthcdr ivy--index ivy--old-cands))
2252 idx)
2253 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
2254 (progn
2255 (while (and tail (null idx))
2256 ;; Compare with `equal', since the collection is re-created
2257 ;; each time with `split-string'
2258 (setq idx (cl-position (pop tail) cands :test #'equal)))
2259 (or idx 0))
2260 ivy--index))))
2261
2262 (defun ivy-recompute-index-zero (_re-str _cands)
2263 0)
2264
2265 (defcustom ivy-minibuffer-faces
2266 '(ivy-minibuffer-match-face-1
2267 ivy-minibuffer-match-face-2
2268 ivy-minibuffer-match-face-3
2269 ivy-minibuffer-match-face-4)
2270 "List of `ivy' faces for minibuffer group matches."
2271 :type '(repeat :tag "Faces"
2272 (choice
2273 (const ivy-minibuffer-match-face-1)
2274 (const ivy-minibuffer-match-face-2)
2275 (const ivy-minibuffer-match-face-3)
2276 (const ivy-minibuffer-match-face-4)
2277 (face :tag "Other face"))))
2278
2279 (defvar ivy-flx-limit 200
2280 "Used to conditionally turn off flx sorting.
2281
2282 When the amount of matching candidates exceeds this limit, then
2283 no sorting is done.")
2284
2285 (defun ivy--flx-sort (name cands)
2286 "Sort according to closeness to string NAME the string list CANDS."
2287 (condition-case nil
2288 (if (and cands
2289 (< (length cands) ivy-flx-limit))
2290 (let* ((flx-name (if (string-match "^\\^" name)
2291 (substring name 1)
2292 name))
2293 (cands-with-score
2294 (delq nil
2295 (mapcar
2296 (lambda (x)
2297 (let ((score (flx-score x flx-name ivy--flx-cache)))
2298 (and score
2299 (cons score x))))
2300 cands))))
2301 (if cands-with-score
2302 (mapcar (lambda (x)
2303 (let ((str (copy-sequence (cdr x)))
2304 (i 0)
2305 (last-j -2))
2306 (dolist (j (cdar x))
2307 (unless (eq j (1+ last-j))
2308 (cl-incf i))
2309 (setq last-j j)
2310 (ivy-add-face-text-property
2311 j (1+ j)
2312 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2313 ivy-minibuffer-faces)
2314 str))
2315 str))
2316 (sort cands-with-score
2317 (lambda (x y)
2318 (> (caar x) (caar y)))))
2319 cands))
2320 cands)
2321 (error
2322 cands)))
2323
2324 (defcustom ivy-format-function 'ivy-format-function-default
2325 "Function to transform the list of candidates into a string.
2326 This string is inserted into the minibuffer."
2327 :type '(choice
2328 (const :tag "Default" ivy-format-function-default)
2329 (const :tag "Arrow prefix" ivy-format-function-arrow)
2330 (const :tag "Full line" ivy-format-function-line)))
2331
2332 (defun ivy--truncate-string (str width)
2333 "Truncate STR to WIDTH."
2334 (if (> (string-width str) width)
2335 (concat (substring str 0 (min (- width 3)
2336 (- (length str) 3))) "...")
2337 str))
2338
2339 (defun ivy--format-function-generic (selected-fn other-fn strs separator)
2340 "Transform CAND-PAIRS into a string for minibuffer.
2341 SELECTED-FN and OTHER-FN each take one string argument.
2342 SEPARATOR is used to join the candidates."
2343 (let ((i -1))
2344 (mapconcat
2345 (lambda (str)
2346 (let ((curr (eq (cl-incf i) ivy--index)))
2347 (if curr
2348 (funcall selected-fn str)
2349 (funcall other-fn str))))
2350 strs
2351 separator)))
2352
2353 (defun ivy-format-function-default (cands)
2354 "Transform CAND-PAIRS into a string for minibuffer."
2355 (ivy--format-function-generic
2356 (lambda (str)
2357 (ivy--add-face str 'ivy-current-match))
2358 #'identity
2359 cands
2360 "\n"))
2361
2362 (defun ivy-format-function-arrow (cands)
2363 "Transform CAND-PAIRS into a string for minibuffer."
2364 (ivy--format-function-generic
2365 (lambda (str)
2366 (concat "> " (ivy--add-face str 'ivy-current-match)))
2367 (lambda (str)
2368 (concat " " str))
2369 cands
2370 "\n"))
2371
2372 (defun ivy-format-function-line (cands)
2373 "Transform CAND-PAIRS into a string for minibuffer."
2374 (ivy--format-function-generic
2375 (lambda (str)
2376 (ivy--add-face (concat str "\n") 'ivy-current-match))
2377 (lambda (str)
2378 (concat str "\n"))
2379 cands
2380 ""))
2381
2382 (defun ivy-add-face-text-property (start end face str)
2383 (if (fboundp 'add-face-text-property)
2384 (add-face-text-property
2385 start end face nil str)
2386 (font-lock-append-text-property
2387 start end 'face face str)))
2388
2389 (defun ivy--format-minibuffer-line (str)
2390 (let ((start 0)
2391 (str (copy-sequence str)))
2392 (cond ((eq ivy--regex-function 'ivy--regex-ignore-order)
2393 (when (consp ivy--old-re)
2394 (let ((i 1))
2395 (dolist (re ivy--old-re)
2396 (when (string-match (car re) str)
2397 (ivy-add-face-text-property
2398 (match-beginning 0) (match-end 0)
2399 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2400 ivy-minibuffer-faces)
2401 str))
2402 (cl-incf i)))))
2403 ((and (eq ivy-display-style 'fancy)
2404 (not (eq ivy--regex-function 'ivy--regex-fuzzy)))
2405 (unless ivy--old-re
2406 (setq ivy--old-re (funcall ivy--regex-function ivy-text)))
2407 (while (and (string-match ivy--old-re str start)
2408 (> (- (match-end 0) (match-beginning 0)) 0))
2409 (setq start (match-end 0))
2410 (let ((i 0))
2411 (while (<= i ivy--subexps)
2412 (let ((face
2413 (cond ((zerop ivy--subexps)
2414 (cadr ivy-minibuffer-faces))
2415 ((zerop i)
2416 (car ivy-minibuffer-faces))
2417 (t
2418 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2419 ivy-minibuffer-faces)))))
2420 (ivy-add-face-text-property
2421 (match-beginning i) (match-end i)
2422 face str))
2423 (cl-incf i))))))
2424 str))
2425
2426 (ivy-set-display-transformer
2427 'counsel-find-file 'ivy-read-file-transformer)
2428 (ivy-set-display-transformer
2429 'read-file-name-internal 'ivy-read-file-transformer)
2430
2431 (defun ivy-read-file-transformer (str)
2432 (if (string-match-p "/\\'" str)
2433 (propertize str 'face 'ivy-subdir)
2434 str))
2435
2436 (defun ivy--format (cands)
2437 "Return a string for CANDS suitable for display in the minibuffer.
2438 CANDS is a list of strings."
2439 (setq ivy--length (length cands))
2440 (when (>= ivy--index ivy--length)
2441 (setq ivy--index (max (1- ivy--length) 0)))
2442 (if (null cands)
2443 (setq ivy--current "")
2444 (let* ((half-height (/ ivy-height 2))
2445 (start (max 0 (- ivy--index half-height)))
2446 (end (min (+ start (1- ivy-height)) ivy--length))
2447 (start (max 0 (min start (- end (1- ivy-height)))))
2448 (cands (cl-subseq cands start end))
2449 (index (- ivy--index start))
2450 transformer-fn)
2451 (setq ivy--current (copy-sequence (nth index cands)))
2452 (when (setq transformer-fn (ivy-state-display-transformer-fn ivy-last))
2453 (with-ivy-window
2454 (setq cands (mapcar transformer-fn cands))))
2455 (let* ((ivy--index index)
2456 (cands (mapcar
2457 #'ivy--format-minibuffer-line
2458 cands))
2459 (res (concat "\n" (funcall ivy-format-function cands))))
2460 (put-text-property 0 (length res) 'read-only nil res)
2461 res))))
2462
2463 (defvar ivy--virtual-buffers nil
2464 "Store the virtual buffers alist.")
2465
2466 (defvar recentf-list)
2467
2468 (defcustom ivy-virtual-abbreviate 'name
2469 "The mode of abbreviation for virtual buffer names."
2470 :type '(choice
2471 (const :tag "Only name" name)
2472 (const :tag "Full path" full)
2473 ;; eventually, uniquify
2474 ))
2475
2476 (defun ivy--virtual-buffers ()
2477 "Adapted from `ido-add-virtual-buffers-to-list'."
2478 (unless recentf-mode
2479 (recentf-mode 1))
2480 (let ((bookmarks (and (boundp 'bookmark-alist)
2481 bookmark-alist))
2482 virtual-buffers name)
2483 (dolist (head (append
2484 recentf-list
2485 (delete " - no file -"
2486 (delq nil (mapcar (lambda (bookmark)
2487 (cdr (assoc 'filename bookmark)))
2488 bookmarks)))))
2489 (setq name
2490 (if (eq ivy-virtual-abbreviate 'name)
2491 (file-name-nondirectory head)
2492 (expand-file-name head)))
2493 (when (equal name "")
2494 (setq name (file-name-nondirectory (directory-file-name head))))
2495 (when (equal name "")
2496 (setq name head))
2497 (and (not (equal name ""))
2498 (null (get-file-buffer head))
2499 (not (assoc name virtual-buffers))
2500 (push (cons name head) virtual-buffers)))
2501 (when virtual-buffers
2502 (dolist (comp virtual-buffers)
2503 (put-text-property 0 (length (car comp))
2504 'face 'ivy-virtual
2505 (car comp)))
2506 (setq ivy--virtual-buffers (nreverse virtual-buffers))
2507 (mapcar #'car ivy--virtual-buffers))))
2508
2509 (defcustom ivy-ignore-buffers '("\\` ")
2510 "List of regexps or functions matching buffer names to ignore."
2511 :type '(repeat (choice regexp function)))
2512
2513 (defun ivy--buffer-list (str &optional virtual)
2514 "Return the buffers that match STR.
2515 When VIRTUAL is non-nil, add virtual buffers."
2516 (delete-dups
2517 (append
2518 (mapcar
2519 (lambda (x)
2520 (if (with-current-buffer x
2521 (file-remote-p
2522 (abbreviate-file-name default-directory)))
2523 (propertize x 'face 'ivy-remote)
2524 x))
2525 (all-completions str 'internal-complete-buffer))
2526 (and virtual
2527 (ivy--virtual-buffers)))))
2528
2529 (defun ivy--switch-buffer-action (buffer)
2530 "Switch to BUFFER.
2531 BUFFER may be a string or nil."
2532 (with-ivy-window
2533 (if (zerop (length buffer))
2534 (switch-to-buffer
2535 ivy-text nil 'force-same-window)
2536 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2537 (if (and virtual
2538 (not (get-buffer buffer)))
2539 (find-file (cdr virtual))
2540 (switch-to-buffer
2541 buffer nil 'force-same-window))))))
2542
2543 (defun ivy--switch-buffer-other-window-action (buffer)
2544 "Switch to BUFFER in other window.
2545 BUFFER may be a string or nil."
2546 (if (zerop (length buffer))
2547 (switch-to-buffer-other-window ivy-text)
2548 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2549 (if (and virtual
2550 (not (get-buffer buffer)))
2551 (find-file-other-window (cdr virtual))
2552 (switch-to-buffer-other-window buffer)))))
2553
2554 (defun ivy--rename-buffer-action (buffer)
2555 "Rename BUFFER."
2556 (let ((new-name (read-string "Rename buffer (to new name): ")))
2557 (with-current-buffer buffer
2558 (rename-buffer new-name))))
2559
2560 (defvar ivy-switch-buffer-map (make-sparse-keymap))
2561
2562 (ivy-set-actions
2563 'ivy-switch-buffer
2564 '(("k"
2565 (lambda (x)
2566 (kill-buffer x)
2567 (ivy--reset-state ivy-last))
2568 "kill")
2569 ("j"
2570 ivy--switch-buffer-other-window-action
2571 "other")
2572 ("r"
2573 ivy--rename-buffer-action
2574 "rename")))
2575
2576 (defun ivy--switch-buffer-matcher (regexp candidates)
2577 "Return REGEXP-matching CANDIDATES.
2578 Skip buffers that match `ivy-ignore-buffers'."
2579 (let ((res (ivy--re-filter regexp candidates)))
2580 (if (or (null ivy-use-ignore)
2581 (null ivy-ignore-buffers))
2582 res
2583 (or (cl-remove-if
2584 (lambda (buf)
2585 (cl-find-if
2586 (lambda (f-or-r)
2587 (if (functionp f-or-r)
2588 (funcall f-or-r buf)
2589 (string-match-p f-or-r buf)))
2590 ivy-ignore-buffers))
2591 res)
2592 res))))
2593
2594 (ivy-set-display-transformer
2595 'ivy-switch-buffer 'ivy-switch-buffer-transformer)
2596 (ivy-set-display-transformer
2597 'internal-complete-buffer 'ivy-switch-buffer-transformer)
2598
2599 (defun ivy-switch-buffer-transformer (str)
2600 (let ((b (get-buffer str)))
2601 (if (and b
2602 (buffer-file-name b)
2603 (buffer-modified-p b))
2604 (propertize str 'face 'ivy-modified-buffer)
2605 str)))
2606
2607 (defun ivy-switch-buffer-occur ()
2608 "Occur function for `ivy-switch-buffer' that uses `ibuffer'."
2609 (let* ((cand-regexp
2610 (concat "\\(" (mapconcat #'regexp-quote ivy--old-cands "\\|") "\\)"))
2611 (new-qualifier `((name . ,cand-regexp))))
2612 (ibuffer nil (buffer-name) new-qualifier)))
2613
2614 ;;;###autoload
2615 (defun ivy-switch-buffer ()
2616 "Switch to another buffer."
2617 (interactive)
2618 (let ((this-command 'ivy-switch-buffer))
2619 (ivy-read "Switch to buffer: " 'internal-complete-buffer
2620 :matcher #'ivy--switch-buffer-matcher
2621 :preselect (buffer-name (other-buffer (current-buffer)))
2622 :action #'ivy--switch-buffer-action
2623 :keymap ivy-switch-buffer-map
2624 :caller 'ivy-switch-buffer)))
2625
2626 ;;;###autoload
2627 (defun ivy-switch-buffer-other-window ()
2628 "Switch to another buffer in another window."
2629 (interactive)
2630 (ivy-read "Switch to buffer in other window: " 'internal-complete-buffer
2631 :preselect (buffer-name (other-buffer (current-buffer)))
2632 :action #'ivy--switch-buffer-other-window-action
2633 :keymap ivy-switch-buffer-map
2634 :caller 'ivy-switch-buffer-other-window))
2635
2636 ;;;###autoload
2637 (defun ivy-recentf ()
2638 "Find a file on `recentf-list'."
2639 (interactive)
2640 (ivy-read "Recentf: " recentf-list
2641 :action
2642 (lambda (f)
2643 (with-ivy-window
2644 (find-file f)))
2645 :caller 'ivy-recentf))
2646
2647 (defun ivy-yank-word ()
2648 "Pull next word from buffer into search string."
2649 (interactive)
2650 (let (amend)
2651 (with-ivy-window
2652 (let ((pt (point))
2653 (le (line-end-position)))
2654 (forward-word 1)
2655 (if (> (point) le)
2656 (goto-char pt)
2657 (setq amend (buffer-substring-no-properties pt (point))))))
2658 (when amend
2659 (insert (replace-regexp-in-string " +" " " amend)))))
2660
2661 (defun ivy-kill-ring-save ()
2662 "Store the current candidates into the kill ring.
2663 If the region is active, forward to `kill-ring-save' instead."
2664 (interactive)
2665 (if (region-active-p)
2666 (call-interactively 'kill-ring-save)
2667 (kill-new
2668 (mapconcat
2669 #'identity
2670 ivy--old-cands
2671 "\n"))))
2672
2673 (defun ivy-insert-current ()
2674 "Make the current candidate into current input.
2675 Don't finish completion."
2676 (interactive)
2677 (delete-minibuffer-contents)
2678 (if (and ivy--directory
2679 (string-match "/$" ivy--current))
2680 (insert (substring ivy--current 0 -1))
2681 (insert ivy--current)))
2682
2683 (defun ivy-toggle-fuzzy ()
2684 "Toggle the re builder between `ivy--regex-fuzzy' and `ivy--regex-plus'."
2685 (interactive)
2686 (setq ivy--old-re nil)
2687 (if (eq ivy--regex-function 'ivy--regex-fuzzy)
2688 (setq ivy--regex-function 'ivy--regex-plus)
2689 (setq ivy--regex-function 'ivy--regex-fuzzy)))
2690
2691 (defun ivy-reverse-i-search ()
2692 "Enter a recursive `ivy-read' session using the current history.
2693 The selected history element will be inserted into the minibuffer."
2694 (interactive)
2695 (let ((enable-recursive-minibuffers t)
2696 (history (symbol-value (ivy-state-history ivy-last)))
2697 (old-last ivy-last)
2698 (ivy-recursive-restore nil))
2699 (ivy-read "Reverse-i-search: "
2700 history
2701 :action (lambda (x)
2702 (ivy--reset-state
2703 (setq ivy-last old-last))
2704 (delete-minibuffer-contents)
2705 (insert (substring-no-properties x))
2706 (ivy--cd-maybe)))))
2707
2708 (defun ivy-restrict-to-matches ()
2709 "Restrict candidates to current matches and erase input."
2710 (interactive)
2711 (delete-minibuffer-contents)
2712 (setq ivy--all-candidates
2713 (ivy--filter ivy-text ivy--all-candidates)))
2714
2715 ;;* Occur
2716 (defvar-local ivy-occur-last nil
2717 "Buffer-local value of `ivy-last'.
2718 Can't re-use `ivy-last' because using e.g. `swiper' in the same
2719 buffer would modify `ivy-last'.")
2720
2721 (defvar ivy-occur-mode-map
2722 (let ((map (make-sparse-keymap)))
2723 (define-key map [mouse-1] 'ivy-occur-click)
2724 (define-key map (kbd "RET") 'ivy-occur-press)
2725 (define-key map (kbd "j") 'ivy-occur-next-line)
2726 (define-key map (kbd "k") 'ivy-occur-previous-line)
2727 (define-key map (kbd "h") 'backward-char)
2728 (define-key map (kbd "l") 'forward-char)
2729 (define-key map (kbd "f") 'ivy-occur-press)
2730 (define-key map (kbd "g") 'ivy-occur-revert-buffer)
2731 (define-key map (kbd "a") 'ivy-occur-read-action)
2732 (define-key map (kbd "o") 'ivy-occur-dispatch)
2733 (define-key map (kbd "c") 'ivy-occur-toggle-calling)
2734 (define-key map (kbd "q") 'quit-window)
2735 map)
2736 "Keymap for Ivy Occur mode.")
2737
2738 (defun ivy-occur-toggle-calling ()
2739 "Toggle `ivy-calling'."
2740 (interactive)
2741 (if (setq ivy-calling (not ivy-calling))
2742 (progn
2743 (setq mode-name "Ivy-Occur [calling]")
2744 (ivy-occur-press))
2745 (setq mode-name "Ivy-Occur"))
2746 (force-mode-line-update))
2747
2748 (defun ivy-occur-next-line (&optional arg)
2749 "Move the cursor down ARG lines.
2750 When `ivy-calling' isn't nil, call `ivy-occur-press'."
2751 (interactive "p")
2752 (forward-line arg)
2753 (when ivy-calling
2754 (ivy-occur-press)))
2755
2756 (defun ivy-occur-previous-line (&optional arg)
2757 "Move the cursor up ARG lines.
2758 When `ivy-calling' isn't nil, call `ivy-occur-press'."
2759 (interactive "p")
2760 (forward-line (- arg))
2761 (when ivy-calling
2762 (ivy-occur-press)))
2763
2764 (define-derived-mode ivy-occur-mode fundamental-mode "Ivy-Occur"
2765 "Major mode for output from \\[ivy-occur].
2766
2767 \\{ivy-occur-mode-map}")
2768
2769 (defvar ivy-occur-grep-mode-map
2770 (let ((map (copy-keymap ivy-occur-mode-map)))
2771 (define-key map (kbd "C-x C-q") 'ivy-wgrep-change-to-wgrep-mode)
2772 map)
2773 "Keymap for Ivy Occur Grep mode.")
2774
2775 (define-derived-mode ivy-occur-grep-mode grep-mode "Ivy-Occur"
2776 "Major mode for output from \\[ivy-occur].
2777
2778 \\{ivy-occur-grep-mode-map}")
2779
2780 (defvar ivy--occurs-list nil
2781 "A list of custom occur generators per command.")
2782
2783 (defun ivy-set-occur (cmd occur)
2784 "Assign CMD a custom OCCUR function."
2785 (setq ivy--occurs-list
2786 (plist-put ivy--occurs-list cmd occur)))
2787
2788 (ivy-set-occur 'ivy-switch-buffer 'ivy-switch-buffer-occur)
2789 (ivy-set-occur 'ivy-switch-buffer-other-window 'ivy-switch-buffer-occur)
2790
2791 (defun ivy--occur-insert-lines (cands)
2792 (dolist (str cands)
2793 (add-text-properties
2794 0 (length str)
2795 `(mouse-face
2796 highlight
2797 help-echo "mouse-1: call ivy-action")
2798 str)
2799 (insert str "\n")))
2800
2801 (defun ivy-occur ()
2802 "Stop completion and put the current matches into a new buffer.
2803
2804 The new buffer remembers current action(s).
2805
2806 While in the *ivy-occur* buffer, selecting a candidate with RET or
2807 a mouse click will call the appropriate action for that candidate.
2808
2809 There is no limit on the number of *ivy-occur* buffers."
2810 (interactive)
2811 (if (not (window-minibuffer-p))
2812 (user-error "No completion session is active")
2813 (let* ((caller (ivy-state-caller ivy-last))
2814 (occur-fn (plist-get ivy--occurs-list caller))
2815 (buffer
2816 (generate-new-buffer
2817 (format "*ivy-occur%s \"%s\"*"
2818 (if caller
2819 (concat " " (prin1-to-string caller))
2820 "")
2821 ivy-text))))
2822 (with-current-buffer buffer
2823 (let ((inhibit-read-only t))
2824 (erase-buffer)
2825 (if occur-fn
2826 (funcall occur-fn)
2827 (ivy-occur-mode)
2828 (insert (format "%d candidates:\n" (length ivy--old-cands)))
2829 (ivy--occur-insert-lines
2830 (mapcar
2831 (lambda (cand) (concat " " cand))
2832 ivy--old-cands))))
2833 (setf (ivy-state-text ivy-last) ivy-text)
2834 (setq ivy-occur-last ivy-last)
2835 (setq-local ivy--directory ivy--directory))
2836 (ivy-exit-with-action
2837 `(lambda (_) (pop-to-buffer ,buffer))))))
2838
2839 (defun ivy-occur-revert-buffer ()
2840 "Refresh the buffer making it up-to date with the collection.
2841
2842 Currently only works for `swiper'. In that specific case, the
2843 *ivy-occur* buffer becomes nearly useless as the orignal buffer
2844 is updated, since the line numbers no longer match.
2845
2846 Calling this function is as if you called `ivy-occur' on the
2847 updated original buffer."
2848 (interactive)
2849 (let ((caller (ivy-state-caller ivy-occur-last))
2850 (ivy-last ivy-occur-last))
2851 (when (eq caller 'swiper)
2852 (let ((buffer (ivy-state-buffer ivy-occur-last)))
2853 (unless (buffer-live-p buffer)
2854 (error "buffer was killed"))
2855 (let ((inhibit-read-only t))
2856 (erase-buffer)
2857 (funcall (plist-get ivy--occurs-list caller) t))))))
2858
2859 (declare-function wgrep-change-to-wgrep-mode "ext:wgrep")
2860
2861 (defun ivy-wgrep-change-to-wgrep-mode ()
2862 "Forward to `wgrep-change-to-wgrep-mode'."
2863 (interactive)
2864 (if (require 'wgrep nil 'noerror)
2865 (wgrep-change-to-wgrep-mode)
2866 (error "Package wgrep isn't installed")))
2867
2868 (defun ivy-occur-read-action ()
2869 "Select one of the available actions as the current one."
2870 (interactive)
2871 (let ((ivy-last ivy-occur-last))
2872 (ivy-read-action)))
2873
2874 (defun ivy-occur-dispatch ()
2875 "Call one of the available actions on the current item."
2876 (interactive)
2877 (let* ((state-action (ivy-state-action ivy-occur-last))
2878 (actions (if (symbolp state-action)
2879 state-action
2880 (copy-sequence state-action))))
2881 (unwind-protect
2882 (progn
2883 (ivy-occur-read-action)
2884 (ivy-occur-press))
2885 (setf (ivy-state-action ivy-occur-last) actions))))
2886
2887 (defun ivy-occur-click (event)
2888 "Execute action for the current candidate.
2889 EVENT gives the mouse position."
2890 (interactive "e")
2891 (let ((window (posn-window (event-end event)))
2892 (pos (posn-point (event-end event))))
2893 (with-current-buffer (window-buffer window)
2894 (goto-char pos)
2895 (ivy-occur-press))))
2896
2897 (declare-function swiper--cleanup "swiper")
2898 (declare-function swiper--add-overlays "swiper")
2899
2900 (defun ivy-occur-press ()
2901 "Execute action for the current candidate."
2902 (interactive)
2903 (when (save-excursion
2904 (beginning-of-line)
2905 (looking-at "\\(?:./\\| \\)\\(.*\\)$"))
2906 (when (memq (ivy-state-caller ivy-occur-last)
2907 '(swiper counsel-git-grep counsel-grep counsel-ag
2908 counsel-describe-function counsel-describe-variable))
2909 (let ((window (ivy-state-window ivy-occur-last)))
2910 (when (or (null (window-live-p window))
2911 (equal window (selected-window)))
2912 (save-selected-window
2913 (setf (ivy-state-window ivy-occur-last)
2914 (display-buffer (ivy-state-buffer ivy-occur-last)
2915 'display-buffer-pop-up-window))))))
2916 (let* ((ivy-last ivy-occur-last)
2917 (ivy-text (ivy-state-text ivy-last))
2918 (str (buffer-substring
2919 (match-beginning 1)
2920 (match-end 1)))
2921 (coll (ivy-state-collection ivy-last))
2922 (action (ivy--get-action ivy-last))
2923 (ivy-exit 'done))
2924 (with-ivy-window
2925 (funcall action
2926 (if (and (consp coll)
2927 (consp (car coll)))
2928 (cdr (assoc str coll))
2929 str))
2930 (if (memq (ivy-state-caller ivy-last)
2931 '(swiper counsel-git-grep))
2932 (with-current-buffer (window-buffer (selected-window))
2933 (swiper--cleanup)
2934 (swiper--add-overlays
2935 (ivy--regex ivy-text)
2936 (line-beginning-position)
2937 (line-end-position)
2938 (selected-window))
2939 (run-at-time 0.5 nil 'swiper--cleanup)))))))
2940
2941 (defvar ivy-help-file (let ((default-directory
2942 (if load-file-name
2943 (file-name-directory load-file-name)
2944 default-directory)))
2945 (if (file-exists-p "ivy-help.org")
2946 (expand-file-name "ivy-help.org")
2947 (if (file-exists-p "doc/ivy-help.org")
2948 (expand-file-name "doc/ivy-help.org"))))
2949 "The file for `ivy-help'.")
2950
2951 (defun ivy-help ()
2952 "Help for `ivy'."
2953 (interactive)
2954 (let ((buf (get-buffer "*Ivy Help*")))
2955 (unless buf
2956 (setq buf (get-buffer-create "*Ivy Help*"))
2957 (with-current-buffer buf
2958 (insert-file-contents ivy-help-file)
2959 (org-mode)
2960 (view-mode)
2961 (goto-char (point-min))))
2962 (if (eq this-command 'ivy-help)
2963 (switch-to-buffer buf)
2964 (with-ivy-window
2965 (pop-to-buffer buf)))
2966 (view-mode)
2967 (goto-char (point-min))))
2968
2969 (provide 'ivy)
2970
2971 ;;; ivy.el ends here