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