]> code.delx.au - gnu-emacs-elpa/blob - ivy.el
Add the '!' behavior into `ivy--regex-ignore-order'
[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 "user@host: "
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 (if (ivy-state-p state)
703 (let ((window (ivy-state-window state)))
704 (if (window-live-p window)
705 window
706 (if (= (length (window-list)) 1)
707 (selected-window)
708 (next-window))))
709 (selected-window)))
710
711 (defun ivy--actionp (x)
712 "Return non-nil when X is a list of actions."
713 (and x (listp x) (not (eq (car x) 'closure))))
714
715 (defun ivy-next-action ()
716 "When the current action is a list, scroll it forwards."
717 (interactive)
718 (let ((action (ivy-state-action ivy-last)))
719 (when (ivy--actionp action)
720 (unless (>= (car action) (1- (length action)))
721 (cl-incf (car action))))))
722
723 (defun ivy-prev-action ()
724 "When the current action is a list, scroll it backwards."
725 (interactive)
726 (let ((action (ivy-state-action ivy-last)))
727 (when (ivy--actionp action)
728 (unless (<= (car action) 1)
729 (cl-decf (car action))))))
730
731 (defun ivy-action-name ()
732 "Return the name associated with the current action."
733 (let ((action (ivy-state-action ivy-last)))
734 (if (ivy--actionp action)
735 (format "[%d/%d] %s"
736 (car action)
737 (1- (length action))
738 (nth 2 (nth (car action) action)))
739 "[1/1] default")))
740
741 (defun ivy-call ()
742 "Call the current action without exiting completion."
743 (interactive)
744 (let ((action (ivy--get-action ivy-last)))
745 (when action
746 (let* ((collection (ivy-state-collection ivy-last))
747 (x (if (and (consp collection)
748 (consp (car collection)))
749 (cdr (assoc ivy--current collection))
750 (if (equal ivy--current "")
751 ivy-text
752 ivy--current))))
753 (prog1 (funcall action x)
754 (unless (or (eq ivy-exit 'done)
755 (equal (selected-window)
756 (active-minibuffer-window))
757 (null (active-minibuffer-window)))
758 (select-window (active-minibuffer-window))))))))
759
760 (defun ivy-next-line-and-call (&optional arg)
761 "Move cursor vertically down ARG candidates.
762 Call the permanent action if possible."
763 (interactive "p")
764 (ivy-next-line arg)
765 (ivy--exhibit)
766 (ivy-call))
767
768 (defun ivy-previous-line-and-call (&optional arg)
769 "Move cursor vertically down ARG candidates.
770 Call the permanent action if possible."
771 (interactive "p")
772 (ivy-previous-line arg)
773 (ivy--exhibit)
774 (ivy-call))
775
776 (defun ivy-previous-history-element (arg)
777 "Forward to `previous-history-element' with ARG."
778 (interactive "p")
779 (previous-history-element arg)
780 (ivy--cd-maybe)
781 (move-end-of-line 1)
782 (ivy--maybe-scroll-history))
783
784 (defun ivy-next-history-element (arg)
785 "Forward to `next-history-element' with ARG."
786 (interactive "p")
787 (next-history-element arg)
788 (ivy--cd-maybe)
789 (move-end-of-line 1)
790 (ivy--maybe-scroll-history))
791
792 (defun ivy--cd-maybe ()
793 "Check if the current input points to a different directory.
794 If so, move to that directory, while keeping only the file name."
795 (when ivy--directory
796 (let ((input (ivy--input))
797 url)
798 (if (setq url (ffap-url-p input))
799 (ivy-exit-with-action
800 (lambda (_)
801 (funcall ffap-url-fetcher url)))
802 (setq input (expand-file-name input))
803 (let ((file (file-name-nondirectory input))
804 (dir (expand-file-name (file-name-directory input))))
805 (if (string= dir ivy--directory)
806 (progn
807 (delete-minibuffer-contents)
808 (insert file))
809 (ivy--cd dir)
810 (insert file)))))))
811
812 (defun ivy--maybe-scroll-history ()
813 "If the selected history element has an index, scroll there."
814 (let ((idx (ignore-errors
815 (get-text-property
816 (minibuffer-prompt-end)
817 'ivy-index))))
818 (when idx
819 (ivy--exhibit)
820 (setq ivy--index idx))))
821
822 (defun ivy--cd (dir)
823 "When completing file names, move to directory DIR."
824 (if (null ivy--directory)
825 (error "Unexpected")
826 (setq ivy--old-cands nil)
827 (setq ivy--old-re nil)
828 (setq ivy--index 0)
829 (setq ivy--all-candidates
830 (ivy--sorted-files (setq ivy--directory dir)))
831 (setq ivy-text "")
832 (delete-minibuffer-contents)))
833
834 (defun ivy-backward-delete-char ()
835 "Forward to `backward-delete-char'.
836 On error (read-only), call `ivy-on-del-error-function'."
837 (interactive)
838 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
839 (progn
840 (ivy--cd (file-name-directory
841 (directory-file-name
842 (expand-file-name
843 ivy--directory))))
844 (ivy--exhibit))
845 (condition-case nil
846 (backward-delete-char 1)
847 (error
848 (when ivy-on-del-error-function
849 (funcall ivy-on-del-error-function))))))
850
851 (defun ivy-delete-char (arg)
852 "Forward to `delete-char' ARG."
853 (interactive "p")
854 (unless (= (point) (line-end-position))
855 (delete-char arg)))
856
857 (defun ivy-forward-char (arg)
858 "Forward to `forward-char' ARG."
859 (interactive "p")
860 (unless (= (point) (line-end-position))
861 (forward-char arg)))
862
863 (defun ivy-kill-word (arg)
864 "Forward to `kill-word' ARG."
865 (interactive "p")
866 (unless (= (point) (line-end-position))
867 (kill-word arg)))
868
869 (defun ivy-kill-line ()
870 "Forward to `kill-line'."
871 (interactive)
872 (if (eolp)
873 (kill-region (minibuffer-prompt-end) (point))
874 (kill-line)))
875
876 (defun ivy-backward-kill-word ()
877 "Forward to `backward-kill-word'."
878 (interactive)
879 (if (and ivy--directory (= (minibuffer-prompt-end) (point)))
880 (progn
881 (ivy--cd (file-name-directory
882 (directory-file-name
883 (expand-file-name
884 ivy--directory))))
885 (ivy--exhibit))
886 (ignore-errors
887 (let ((pt (point)))
888 (forward-word -1)
889 (delete-region (point) pt)))))
890
891 (defvar ivy--regexp-quote 'regexp-quote
892 "Store the regexp quoting state.")
893
894 (defun ivy-toggle-regexp-quote ()
895 "Toggle the regexp quoting."
896 (interactive)
897 (setq ivy--old-re nil)
898 (cl-rotatef ivy--regex-function ivy--regexp-quote))
899
900 (defvar avy-all-windows)
901 (defvar avy-action)
902 (defvar avy-keys)
903 (defvar avy-keys-alist)
904 (defvar avy-style)
905 (defvar avy-styles-alist)
906 (declare-function avy--process "ext:avy")
907 (declare-function avy--style-fn "ext:avy")
908
909 (eval-after-load 'avy
910 '(add-to-list 'avy-styles-alist '(ivy-avy . pre)))
911
912 (defun ivy-avy ()
913 "Jump to one of the current ivy candidates."
914 (interactive)
915 (unless (require 'avy nil 'noerror)
916 (error "Package avy isn't installed"))
917 (let* ((avy-all-windows nil)
918 (avy-keys (or (cdr (assq 'ivy-avy avy-keys-alist))
919 avy-keys))
920 (avy-style (or (cdr (assq 'ivy-avy
921 avy-styles-alist))
922 avy-style))
923 (candidate
924 (let ((candidates))
925 (save-excursion
926 (save-restriction
927 (narrow-to-region
928 (window-start)
929 (window-end))
930 (goto-char (point-min))
931 (forward-line)
932 (while (< (point) (point-max))
933 (push
934 (cons (point)
935 (selected-window))
936 candidates)
937 (forward-line))))
938 (setq avy-action #'identity)
939 (avy--process
940 (nreverse candidates)
941 (avy--style-fn avy-style)))))
942 (ivy-set-index (- (line-number-at-pos candidate) 2))
943 (ivy--exhibit)
944 (ivy-done)))
945
946 (defun ivy-sort-file-function-default (x y)
947 "Compare two files X and Y.
948 Prioritize directories."
949 (if (get-text-property 0 'dirp x)
950 (if (get-text-property 0 'dirp y)
951 (string< x y)
952 t)
953 (if (get-text-property 0 'dirp y)
954 nil
955 (string< x y))))
956
957 (defcustom ivy-sort-functions-alist
958 '((read-file-name-internal . ivy-sort-file-function-default)
959 (internal-complete-buffer . nil)
960 (counsel-git-grep-function . nil)
961 (Man-goto-section . nil)
962 (org-refile . nil)
963 (t . string-lessp))
964 "An alist of sorting functions for each collection function.
965 Interactive functions that call completion fit in here as well.
966
967 Nil means no sorting, which is useful to turn off the sorting for
968 functions that have candidates in the natural buffer order, like
969 `org-refile' or `Man-goto-section'.
970
971 The entry associated with t is used for all fall-through cases.
972
973 See also `ivy-sort-max-size'."
974 :type
975 '(alist
976 :key-type (choice
977 (const :tag "All other functions" t)
978 (symbol :tag "Function"))
979 :value-type (choice
980 (const :tag "plain sort" string-lessp)
981 (const :tag "file sort" ivy-sort-file-function-default)
982 (const :tag "no sort" nil)))
983 :group 'ivy)
984
985 (defvar ivy-index-functions-alist
986 '((swiper . ivy-recompute-index-swiper)
987 (swiper-multi . ivy-recompute-index-swiper)
988 (counsel-git-grep . ivy-recompute-index-swiper)
989 (counsel-grep . ivy-recompute-index-swiper-async)
990 (t . ivy-recompute-index-zero))
991 "An alist of index recomputing functions for each collection function.
992 When the input changes, the appropriate function returns an
993 integer - the index of the matched candidate that should be
994 selected.")
995
996 (defvar ivy-re-builders-alist
997 '((t . ivy--regex-plus))
998 "An alist of regex building functions for each collection function.
999
1000 Each key is (in order of priority):
1001 1. The actual collection function, e.g. `read-file-name-internal'.
1002 2. The symbol passed by :caller into `ivy-read'.
1003 3. `this-command'.
1004 4. t.
1005
1006 Each value is a function that should take a string and return a
1007 valid regex or a regex sequence (see below).
1008
1009 Possible choices: `ivy--regex', `regexp-quote',
1010 `ivy--regex-plus', `ivy--regex-fuzzy'.
1011
1012 If a function returns a list, it should format like this:
1013 '((\"matching-regexp\" . t) (\"non-matching-regexp\") ...).
1014
1015 The matches will be filtered in a sequence, you can mix the
1016 regexps that should match and that should not match as you
1017 like.")
1018
1019 (defvar ivy-initial-inputs-alist
1020 '((org-refile . "^")
1021 (org-agenda-refile . "^")
1022 (org-capture-refile . "^")
1023 (counsel-M-x . "^")
1024 (counsel-describe-function . "^")
1025 (counsel-describe-variable . "^")
1026 (man . "^")
1027 (woman . "^"))
1028 "Command to initial input table.")
1029
1030 (defcustom ivy-sort-max-size 30000
1031 "Sorting won't be done for collections larger than this."
1032 :type 'integer)
1033
1034 (defun ivy--sorted-files (dir)
1035 "Return the list of files in DIR.
1036 Directories come first."
1037 (let* ((default-directory dir)
1038 (seq (all-completions "" 'read-file-name-internal))
1039 sort-fn)
1040 (if (equal dir "/")
1041 seq
1042 (setq seq (delete "./" (delete "../" seq)))
1043 (when (eq (setq sort-fn (cdr (assoc 'read-file-name-internal
1044 ivy-sort-functions-alist)))
1045 #'ivy-sort-file-function-default)
1046 (setq seq (mapcar (lambda (x)
1047 (propertize x 'dirp (string-match-p "/\\'" x)))
1048 seq)))
1049 (when sort-fn
1050 (setq seq (cl-sort seq sort-fn)))
1051 (dolist (dir ivy-extra-directories)
1052 (push dir seq))
1053 seq)))
1054
1055 (defvar ivy-recursive-restore t
1056 "When non-nil, restore the above state when exiting the minibuffer.
1057 This variable is let-bound to nil by functions that take care of
1058 the restoring themselves.")
1059
1060 ;;** Entry Point
1061 (cl-defun ivy-read (prompt collection
1062 &key predicate require-match initial-input
1063 history preselect keymap update-fn sort
1064 action unwind re-builder matcher dynamic-collection caller)
1065 "Read a string in the minibuffer, with completion.
1066
1067 PROMPT is a format string, normally ending in a colon and a
1068 space; %d anywhere in the string is replaced by the current
1069 number of matching candidates. For the literal % character,
1070 escape it with %%. See also `ivy-count-format'.
1071
1072 COLLECTION is either a list of strings, a function, an alist, or
1073 a hash table.
1074
1075 If INITIAL-INPUT is not nil, then insert that input in the
1076 minibuffer initially.
1077
1078 KEYMAP is composed with `ivy-minibuffer-map'.
1079
1080 If PRESELECT is not nil, then select the corresponding candidate
1081 out of the ones that match the INITIAL-INPUT.
1082
1083 UPDATE-FN is called each time the current candidate(s) is changed.
1084
1085 When SORT is t, use `ivy-sort-functions-alist' for sorting.
1086
1087 ACTION is a lambda function to call after selecting a result. It
1088 takes a single string argument.
1089
1090 UNWIND is a lambda function to call before exiting.
1091
1092 RE-BUILDER is a lambda function to call to transform text into a
1093 regex pattern.
1094
1095 MATCHER is to override matching.
1096
1097 DYNAMIC-COLLECTION is a boolean to specify if the list of
1098 candidates is updated after each input by calling COLLECTION.
1099
1100 CALLER is a symbol to uniquely identify the caller to `ivy-read'.
1101 It is used, along with COLLECTION, to determine which
1102 customizations apply to the current completion session."
1103 (let ((extra-actions (append (plist-get ivy--actions-list t)
1104 (plist-get ivy--actions-list this-command))))
1105 (when extra-actions
1106 (setq action
1107 (if (functionp action)
1108 `(1
1109 ("o" ,action "default")
1110 ,@extra-actions)
1111 (delete-dups (append action extra-actions))))))
1112 (let ((recursive-ivy-last (and (active-minibuffer-window) ivy-last)))
1113 (setq ivy-last
1114 (make-ivy-state
1115 :prompt prompt
1116 :collection collection
1117 :predicate predicate
1118 :require-match require-match
1119 :initial-input initial-input
1120 :history history
1121 :preselect preselect
1122 :keymap keymap
1123 :update-fn update-fn
1124 :sort sort
1125 :action action
1126 :window (selected-window)
1127 :buffer (current-buffer)
1128 :unwind unwind
1129 :re-builder re-builder
1130 :matcher matcher
1131 :dynamic-collection dynamic-collection
1132 :caller caller))
1133 (ivy--reset-state ivy-last)
1134 (prog1
1135 (unwind-protect
1136 (minibuffer-with-setup-hook
1137 #'ivy--minibuffer-setup
1138 (let* ((hist (or history 'ivy-history))
1139 (minibuffer-completion-table collection)
1140 (minibuffer-completion-predicate predicate)
1141 (resize-mini-windows (cond
1142 ((display-graphic-p) nil)
1143 ((null resize-mini-windows) 'grow-only)
1144 (t resize-mini-windows))))
1145 (read-from-minibuffer
1146 prompt
1147 (ivy-state-initial-input ivy-last)
1148 (make-composed-keymap keymap ivy-minibuffer-map)
1149 nil
1150 hist)
1151 (when (eq ivy-exit 'done)
1152 (let ((item (if ivy--directory
1153 ivy--current
1154 ivy-text)))
1155 (unless (equal item "")
1156 (set hist (cons (propertize item 'ivy-index ivy--index)
1157 (delete item
1158 (cdr (symbol-value hist))))))))
1159 ivy--current))
1160 (remove-hook 'post-command-hook #'ivy--exhibit)
1161 (when (setq unwind (ivy-state-unwind ivy-last))
1162 (funcall unwind))
1163 (unless (eq ivy-exit 'done)
1164 (when recursive-ivy-last
1165 (ivy--reset-state (setq ivy-last recursive-ivy-last)))))
1166 (ivy-call)
1167 (when (and recursive-ivy-last
1168 ivy-recursive-restore)
1169 (ivy--reset-state (setq ivy-last recursive-ivy-last))))))
1170
1171 (defun ivy--reset-state (state)
1172 "Reset the ivy to STATE.
1173 This is useful for recursive `ivy-read'."
1174 (let ((prompt (or (ivy-state-prompt state) ""))
1175 (collection (ivy-state-collection state))
1176 (predicate (ivy-state-predicate state))
1177 (history (ivy-state-history state))
1178 (preselect (ivy-state-preselect state))
1179 (sort (ivy-state-sort state))
1180 (re-builder (ivy-state-re-builder state))
1181 (dynamic-collection (ivy-state-dynamic-collection state))
1182 (initial-input (ivy-state-initial-input state))
1183 (require-match (ivy-state-require-match state))
1184 (caller (ivy-state-caller state)))
1185 (unless initial-input
1186 (setq initial-input (cdr (assoc this-command
1187 ivy-initial-inputs-alist))))
1188 (setq ivy--directory nil)
1189 (setq ivy-case-fold-search 'auto)
1190 (setq ivy--regex-function
1191 (or re-builder
1192 (and (functionp collection)
1193 (cdr (assoc collection ivy-re-builders-alist)))
1194 (and caller
1195 (cdr (assoc caller ivy-re-builders-alist)))
1196 (cdr (assoc this-command ivy-re-builders-alist))
1197 (cdr (assoc t ivy-re-builders-alist))
1198 'ivy--regex))
1199 (setq ivy--subexps 0)
1200 (setq ivy--regexp-quote 'regexp-quote)
1201 (setq ivy--old-text "")
1202 (setq ivy--full-length nil)
1203 (setq ivy-text "")
1204 (setq ivy-calling nil)
1205 (let (coll sort-fn)
1206 (cond ((eq collection 'Info-read-node-name-1)
1207 (if (equal Info-current-file "dir")
1208 (setq coll
1209 (mapcar (lambda (x) (format "(%s)" x))
1210 (cl-delete-duplicates
1211 (all-completions "(" collection predicate)
1212 :test #'equal)))
1213 (setq coll (all-completions "" collection predicate))))
1214 ((eq collection 'read-file-name-internal)
1215 (setq ivy--directory default-directory)
1216 (require 'dired)
1217 (when preselect
1218 (let ((preselect-directory (file-name-directory preselect)))
1219 (unless (or (null preselect-directory)
1220 (string= preselect-directory
1221 default-directory))
1222 (setq ivy--directory preselect-directory))
1223 (setf
1224 (ivy-state-preselect state)
1225 (setq preselect (file-name-nondirectory preselect)))))
1226 (setq coll (ivy--sorted-files ivy--directory))
1227 (when initial-input
1228 (unless (or require-match
1229 (equal initial-input default-directory)
1230 (equal initial-input ""))
1231 (setq coll (cons initial-input coll)))
1232 (unless (ivy-state-action ivy-last)
1233 (setq initial-input nil))))
1234 ((eq collection 'internal-complete-buffer)
1235 (setq coll (ivy--buffer-list "" ivy-use-virtual-buffers)))
1236 ((or (functionp collection)
1237 (byte-code-function-p collection)
1238 (vectorp collection)
1239 (and (consp collection) (listp (car collection)))
1240 (hash-table-p collection))
1241 (setq coll (all-completions "" collection predicate)))
1242 (t
1243 (setq coll collection)))
1244 (when sort
1245 (if (and (functionp collection)
1246 (setq sort-fn (assoc collection ivy-sort-functions-alist)))
1247 (when (and (setq sort-fn (cdr sort-fn))
1248 (not (eq collection 'read-file-name-internal)))
1249 (setq coll (cl-sort coll sort-fn)))
1250 (unless (eq history 'org-refile-history)
1251 (if (and (setq sort-fn (cdr (assoc t ivy-sort-functions-alist)))
1252 (<= (length coll) ivy-sort-max-size))
1253 (setq coll (cl-sort (copy-sequence coll) sort-fn))))))
1254 (when preselect
1255 (unless (or (and require-match
1256 (not (eq collection 'internal-complete-buffer)))
1257 dynamic-collection
1258 (let ((re (regexp-quote preselect)))
1259 (cl-find-if (lambda (x) (string-match re x))
1260 coll)))
1261 (setq coll (cons preselect coll))))
1262 (setq ivy--old-re nil)
1263 (setq ivy--old-cands nil)
1264 (when (integerp preselect)
1265 (setq ivy--old-re "")
1266 (setq ivy--index preselect))
1267 (when initial-input
1268 ;; Needed for anchor to work
1269 (setq ivy--old-cands coll)
1270 (setq ivy--old-cands (ivy--filter initial-input coll)))
1271 (setq ivy--all-candidates coll)
1272 (unless (integerp preselect)
1273 (setq ivy--index (or
1274 (and dynamic-collection
1275 ivy--index)
1276 (and preselect
1277 (ivy--preselect-index
1278 preselect
1279 (if initial-input
1280 ivy--old-cands
1281 coll)))
1282 0))))
1283 (setq ivy-exit nil)
1284 (setq ivy--default (or
1285 (thing-at-point 'url)
1286 (thing-at-point 'symbol)
1287 ""))
1288 (setq ivy--prompt
1289 (cond ((string-match "%.*d" prompt)
1290 prompt)
1291 ((null ivy-count-format)
1292 (error
1293 "`ivy-count-format' can't be nil. Set it to an empty string instead"))
1294 ((string-match "%d.*%d" ivy-count-format)
1295 (let ((w (length (number-to-string
1296 (length ivy--all-candidates))))
1297 (s (copy-sequence ivy-count-format)))
1298 (string-match "%d" s)
1299 (match-end 0)
1300 (string-match "%d" s (match-end 0))
1301 (setq s (replace-match (format "%%-%dd" w) nil nil s))
1302 (string-match "%d" s)
1303 (concat (replace-match (format "%%%dd" w) nil nil s)
1304 prompt)))
1305 ((string-match "%.*d" ivy-count-format)
1306 (concat ivy-count-format prompt))
1307 (ivy--directory
1308 prompt)
1309 (t
1310 nil)))
1311 (setf (ivy-state-initial-input ivy-last) initial-input)))
1312
1313 ;;;###autoload
1314 (defun ivy-completing-read (prompt collection
1315 &optional predicate require-match initial-input
1316 history def inherit-input-method)
1317 "Read a string in the minibuffer, with completion.
1318
1319 This interface conforms to `completing-read' and can be used for
1320 `completing-read-function'.
1321
1322 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1323 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1324 PREDICATE limits completion to a subset of COLLECTION.
1325 REQUIRE-MATCH is specified with a boolean value. See `completing-read'.
1326 INITIAL-INPUT is a string that can be inserted into the minibuffer initially.
1327 HISTORY is a list of previously selected inputs.
1328 DEF is the default value.
1329 INHERIT-INPUT-METHOD is currently ignored."
1330 (if (memq this-command '(tmm-menubar tmm-shortcut))
1331 (completing-read-default prompt collection
1332 predicate require-match
1333 initial-input history
1334 def inherit-input-method)
1335 ;; See the doc of `completing-read'.
1336 (when (consp history)
1337 (when (numberp (cdr history))
1338 (setq initial-input (nth (1- (cdr history))
1339 (symbol-value (car history)))))
1340 (setq history (car history)))
1341 (ivy-read (replace-regexp-in-string "%" "%%" prompt)
1342 collection
1343 :predicate predicate
1344 :require-match require-match
1345 :initial-input (if (consp initial-input)
1346 (car initial-input)
1347 (if (and (stringp initial-input)
1348 (string-match "\\+" initial-input))
1349 (replace-regexp-in-string
1350 "\\+" "\\\\+" initial-input)
1351 initial-input))
1352 :preselect (if (listp def) (car def) def)
1353 :history history
1354 :keymap nil
1355 :sort
1356 (let ((sort (assoc this-command ivy-sort-functions-alist)))
1357 (if sort
1358 (cdr sort)
1359 t)))))
1360
1361 (defvar ivy-completion-beg nil
1362 "Completion bounds start.")
1363
1364 (defvar ivy-completion-end nil
1365 "Completion bounds end.")
1366
1367 (defun ivy-completion-in-region-action (str)
1368 "Insert STR, erasing the previous one.
1369 The previous string is between `ivy-completion-beg' and `ivy-completion-end'."
1370 (when (stringp str)
1371 (with-ivy-window
1372 (when ivy-completion-beg
1373 (delete-region
1374 ivy-completion-beg
1375 ivy-completion-end))
1376 (setq ivy-completion-beg
1377 (move-marker (make-marker) (point)))
1378 (insert str)
1379 (setq ivy-completion-end
1380 (move-marker (make-marker) (point))))))
1381
1382 (defun ivy-completion-common-length (str)
1383 "Return the length of the first 'completions-common-part face in STR."
1384 (let ((pos 0)
1385 (len (length str)))
1386 (while (and (<= pos len)
1387 (let ((prop (get-text-property pos 'face str)))
1388 (not (eq 'completions-common-part
1389 (if (listp prop) (car prop) prop)))))
1390 (setq pos (1+ pos)))
1391 (if (< pos len)
1392 (or (next-single-property-change pos 'face str) len)
1393 0)))
1394
1395 (defun ivy-completion-in-region (start end collection &optional predicate)
1396 "An Ivy function suitable for `completion-in-region-function'."
1397 (let* ((enable-recursive-minibuffers t)
1398 (str (buffer-substring-no-properties start end))
1399 (comps
1400 (completion-all-completions str collection predicate (- end start))))
1401 (if (null comps)
1402 (message "No matches")
1403 (nconc comps nil)
1404 (setq ivy-completion-beg (- end (ivy-completion-common-length (car comps))))
1405 (setq ivy-completion-end end)
1406 (if (null (cdr comps))
1407 (progn
1408 (setf (ivy-state-window ivy-last) (selected-window))
1409 (ivy-completion-in-region-action
1410 (substring-no-properties
1411 (car comps))))
1412 (let* ((w (1+ (floor (log (length comps) 10))))
1413 (ivy-count-format (and ivy-count-format
1414 (format "%%-%dd " w))))
1415 (and
1416 (ivy-read (format "(%s): " str)
1417 ;; remove 'completions-first-difference face
1418 (mapcar #'substring-no-properties comps)
1419 :predicate predicate
1420 :action #'ivy-completion-in-region-action
1421 :require-match t)
1422 t))))))
1423
1424 ;;;###autoload
1425 (define-minor-mode ivy-mode
1426 "Toggle Ivy mode on or off.
1427 Turn Ivy mode on if ARG is positive, off otherwise.
1428 Turning on Ivy mode sets `completing-read-function' to
1429 `ivy-completing-read'.
1430
1431 Global bindings:
1432 \\{ivy-mode-map}
1433
1434 Minibuffer bindings:
1435 \\{ivy-minibuffer-map}"
1436 :group 'ivy
1437 :global t
1438 :keymap ivy-mode-map
1439 :lighter " ivy"
1440 (if ivy-mode
1441 (progn
1442 (setq completing-read-function 'ivy-completing-read)
1443 (setq completion-in-region-function 'ivy-completion-in-region))
1444 (setq completing-read-function 'completing-read-default)
1445 (setq completion-in-region-function 'completion--in-region)))
1446
1447 (defun ivy--preselect-index (preselect candidates)
1448 "Return the index of PRESELECT in CANDIDATES."
1449 (cond ((integerp preselect)
1450 preselect)
1451 ((cl-position preselect candidates :test #'equal))
1452 ((stringp preselect)
1453 (let ((re (regexp-quote preselect)))
1454 (cl-position-if
1455 (lambda (x)
1456 (string-match re x))
1457 candidates)))))
1458
1459 ;;* Implementation
1460 ;;** Regex
1461 (defvar ivy--regex-hash
1462 (make-hash-table :test #'equal)
1463 "Store pre-computed regex.")
1464
1465 (defun ivy--split (str)
1466 "Split STR into a list by single spaces.
1467 The remaining spaces stick to their left.
1468 This allows to \"quote\" N spaces by inputting N+1 spaces."
1469 (let ((len (length str))
1470 start0
1471 (start1 0)
1472 res s
1473 match-len)
1474 (while (and (string-match " +" str start1)
1475 (< start1 len))
1476 (setq match-len (- (match-end 0) (match-beginning 0)))
1477 (if (= match-len 1)
1478 (progn
1479 (when start0
1480 (setq start1 start0)
1481 (setq start0 nil))
1482 (push (substring str start1 (match-beginning 0)) res)
1483 (setq start1 (match-end 0)))
1484 (setq str (replace-match
1485 (make-string (1- match-len) ?\ )
1486 nil nil str))
1487 (setq start0 (or start0 start1))
1488 (setq start1 (1- (match-end 0)))))
1489 (if start0
1490 (push (substring str start0) res)
1491 (setq s (substring str start1))
1492 (unless (= (length s) 0)
1493 (push s res)))
1494 (nreverse res)))
1495
1496 (defun ivy--regex (str &optional greedy)
1497 "Re-build regex pattern from STR in case it has a space.
1498 When GREEDY is non-nil, join words in a greedy way."
1499 (let ((hashed (unless greedy
1500 (gethash str ivy--regex-hash))))
1501 (if hashed
1502 (prog1 (cdr hashed)
1503 (setq ivy--subexps (car hashed)))
1504 (when (string-match "\\([^\\]\\|^\\)\\\\$" str)
1505 (setq str (substring str 0 -1)))
1506 (cdr (puthash str
1507 (let ((subs (ivy--split str)))
1508 (if (= (length subs) 1)
1509 (cons
1510 (setq ivy--subexps 0)
1511 (car subs))
1512 (cons
1513 (setq ivy--subexps (length subs))
1514 (mapconcat
1515 (lambda (x)
1516 (if (string-match "\\`\\\\(.*\\\\)\\'" x)
1517 x
1518 (format "\\(%s\\)" x)))
1519 subs
1520 (if greedy
1521 ".*"
1522 ".*?")))))
1523 ivy--regex-hash)))))
1524
1525 (defun ivy--regex-ignore-order--part (str &optional discard)
1526 "Re-build regex from STR by splitting at spaces.
1527 Ignore the order of each group."
1528 (let* ((subs (split-string str " +" t))
1529 (len (length subs)))
1530 (cl-case len
1531 (0
1532 "")
1533 (t
1534 (mapcar (lambda (x) (cons x (not discard)))
1535 subs)))))
1536
1537 (defun ivy--regex-ignore-order (str)
1538 "Re-build regex from STR by splitting at spaces.
1539 Ignore the order of each group. Everything before \"!\" should
1540 match. Everything after \"!\" should not match."
1541 (let ((parts (split-string str "!" t)))
1542 (cl-case (length parts)
1543 (0
1544 "")
1545 (1
1546 (if (string= (substring str 0 1) "!")
1547 (list (cons "" t)
1548 (ivy--regex-ignore-order--part (car parts) t))
1549 (ivy--regex-ignore-order--part (car parts))))
1550 (2
1551 (append
1552 (ivy--regex-ignore-order--part (car parts))
1553 (ivy--regex-ignore-order--part (cadr parts) t)))
1554 (t (error "Unexpected: use only one !")))))
1555
1556 (defun ivy--regex-plus (str)
1557 "Build a regex sequence from STR.
1558 Spaces are wild card characters, everything before \"!\" should
1559 match. Everything after \"!\" should not match."
1560 (let ((parts (split-string str "!" t)))
1561 (cl-case (length parts)
1562 (0
1563 "")
1564 (1
1565 (if (string= (substring str 0 1) "!")
1566 (list (cons "" t)
1567 (list (ivy--regex (car parts))))
1568 (ivy--regex (car parts))))
1569 (2
1570 (cons
1571 (cons (ivy--regex (car parts)) t)
1572 (mapcar #'list (split-string (cadr parts) " " t))))
1573 (t (error "Unexpected: use only one !")))))
1574
1575 (defun ivy--regex-fuzzy (str)
1576 "Build a regex sequence from STR.
1577 Insert .* between each char."
1578 (if (string-match "\\`\\(\\^?\\)\\(.*?\\)\\(\\$?\\)\\'" str)
1579 (prog1
1580 (concat (match-string 1 str)
1581 (mapconcat
1582 (lambda (x)
1583 (format "\\(%c\\)" x))
1584 (string-to-list (match-string 2 str)) ".*")
1585 (match-string 3 str))
1586 (setq ivy--subexps (length (match-string 2 str))))
1587 str))
1588
1589 ;;** Rest
1590 (defun ivy--minibuffer-setup ()
1591 "Setup ivy completion in the minibuffer."
1592 (set (make-local-variable 'completion-show-inline-help) nil)
1593 (set (make-local-variable 'minibuffer-default-add-function)
1594 (lambda ()
1595 (list ivy--default)))
1596 (when (display-graphic-p)
1597 (setq truncate-lines t))
1598 (setq-local max-mini-window-height ivy-height)
1599 (add-hook 'post-command-hook #'ivy--exhibit nil t)
1600 ;; show completions with empty input
1601 (ivy--exhibit))
1602
1603 (defun ivy--input ()
1604 "Return the current minibuffer input."
1605 ;; assume one-line minibuffer input
1606 (buffer-substring-no-properties
1607 (minibuffer-prompt-end)
1608 (line-end-position)))
1609
1610 (defun ivy--cleanup ()
1611 "Delete the displayed completion candidates."
1612 (save-excursion
1613 (goto-char (minibuffer-prompt-end))
1614 (delete-region (line-end-position) (point-max))))
1615
1616 (defun ivy--insert-prompt ()
1617 "Update the prompt according to `ivy--prompt'."
1618 (when ivy--prompt
1619 (unless (memq this-command '(ivy-done ivy-alt-done ivy-partial-or-done
1620 counsel-find-symbol))
1621 (setq ivy--prompt-extra ""))
1622 (let (head tail)
1623 (if (string-match "\\(.*\\): \\'" ivy--prompt)
1624 (progn
1625 (setq head (match-string 1 ivy--prompt))
1626 (setq tail ": "))
1627 (setq head (substring ivy--prompt 0 -1))
1628 (setq tail " "))
1629 (let ((inhibit-read-only t)
1630 (std-props '(front-sticky t rear-nonsticky t field t read-only t))
1631 (n-str
1632 (concat
1633 (if (and (bound-and-true-p minibuffer-depth-indicate-mode)
1634 (> (minibuffer-depth) 1))
1635 (format "[%d] " (minibuffer-depth))
1636 "")
1637 (concat
1638 (if (string-match "%d.*%d" ivy-count-format)
1639 (format head
1640 (1+ ivy--index)
1641 (or (and (ivy-state-dynamic-collection ivy-last)
1642 ivy--full-length)
1643 ivy--length))
1644 (format head
1645 (or (and (ivy-state-dynamic-collection ivy-last)
1646 ivy--full-length)
1647 ivy--length)))
1648 ivy--prompt-extra
1649 tail)))
1650 (d-str (if ivy--directory
1651 (abbreviate-file-name ivy--directory)
1652 "")))
1653 (save-excursion
1654 (goto-char (point-min))
1655 (delete-region (point-min) (minibuffer-prompt-end))
1656 (if (> (+ (mod (+ (length n-str) (length d-str)) (window-width))
1657 (length ivy-text))
1658 (window-width))
1659 (setq n-str (concat n-str "\n" d-str))
1660 (setq n-str (concat n-str d-str)))
1661 (let ((regex (format "\\([^\n]\\{%d\\}\\)[^\n]" (window-width))))
1662 (while (string-match regex n-str)
1663 (setq n-str (replace-match (concat (match-string 1 n-str) "\n") nil t n-str 1))))
1664 (set-text-properties 0 (length n-str)
1665 `(face minibuffer-prompt ,@std-props)
1666 n-str)
1667 (ivy--set-match-props n-str "confirm"
1668 `(face ivy-confirm-face ,@std-props))
1669 (ivy--set-match-props n-str "match required"
1670 `(face ivy-match-required-face ,@std-props))
1671 (insert n-str))
1672 ;; get out of the prompt area
1673 (constrain-to-field nil (point-max))))))
1674
1675 (defun ivy--set-match-props (str match props)
1676 "Set STR text properties that match MATCH to PROPS."
1677 (when (string-match match str)
1678 (set-text-properties
1679 (match-beginning 0)
1680 (match-end 0)
1681 props
1682 str)))
1683
1684 (defvar inhibit-message)
1685
1686 (defun ivy--sort-maybe (collection)
1687 "Sort COLLECTION if needed."
1688 (let ((sort (ivy-state-sort ivy-last))
1689 entry)
1690 (if (null sort)
1691 collection
1692 (let ((sort-fn (cond ((functionp sort)
1693 sort)
1694 ((setq entry (assoc (ivy-state-collection ivy-last)
1695 ivy-sort-functions-alist))
1696 (cdr entry))
1697 (t
1698 (cdr (assoc t ivy-sort-functions-alist))))))
1699 (if (functionp sort-fn)
1700 (cl-sort (copy-sequence collection) sort-fn)
1701 collection)))))
1702
1703 (defun ivy--exhibit ()
1704 "Insert Ivy completions display.
1705 Should be run via minibuffer `post-command-hook'."
1706 (when (memq 'ivy--exhibit post-command-hook)
1707 (let ((inhibit-field-text-motion nil))
1708 (constrain-to-field nil (point-max)))
1709 (setq ivy-text (ivy--input))
1710 (if (ivy-state-dynamic-collection ivy-last)
1711 ;; while-no-input would cause annoying
1712 ;; "Waiting for process to die...done" message interruptions
1713 (let ((inhibit-message t))
1714 (unless (equal ivy--old-text ivy-text)
1715 (while-no-input
1716 (setq ivy--all-candidates
1717 (ivy--sort-maybe
1718 (funcall (ivy-state-collection ivy-last) ivy-text)))
1719 (setq ivy--old-text ivy-text)))
1720 (when ivy--all-candidates
1721 (ivy--insert-minibuffer
1722 (ivy--format ivy--all-candidates))))
1723 (cond (ivy--directory
1724 (if (string-match "/\\'" ivy-text)
1725 (if (member ivy-text ivy--all-candidates)
1726 (ivy--cd (expand-file-name ivy-text ivy--directory))
1727 (when (string-match "//\\'" ivy-text)
1728 (if (and default-directory
1729 (string-match "\\`[[:alpha:]]:/" default-directory))
1730 (ivy--cd (match-string 0 default-directory))
1731 (ivy--cd "/")))
1732 (when (string-match "[[:alpha:]]:/$" ivy-text)
1733 (let ((drive-root (match-string 0 ivy-text)))
1734 (when (file-exists-p drive-root)
1735 (ivy--cd drive-root)))))
1736 (if (string-match "\\`~\\'" ivy-text)
1737 (ivy--cd (expand-file-name "~/")))))
1738 ((eq (ivy-state-collection ivy-last) 'internal-complete-buffer)
1739 (when (or (and (string-match "\\` " ivy-text)
1740 (not (string-match "\\` " ivy--old-text)))
1741 (and (string-match "\\` " ivy--old-text)
1742 (not (string-match "\\` " ivy-text))))
1743 (setq ivy--all-candidates
1744 (if (and (> (length ivy-text) 0)
1745 (eq (aref ivy-text 0)
1746 ?\ ))
1747 (ivy--buffer-list " ")
1748 (ivy--buffer-list "" ivy-use-virtual-buffers)))
1749 (setq ivy--old-re nil))))
1750 (ivy--insert-minibuffer
1751 (with-current-buffer (ivy-state-buffer ivy-last)
1752 (ivy--format
1753 (ivy--filter ivy-text ivy--all-candidates))))
1754 (setq ivy--old-text ivy-text))))
1755
1756 (defun ivy--insert-minibuffer (text)
1757 "Insert TEXT into minibuffer with appropriate cleanup."
1758 (let ((resize-mini-windows nil)
1759 (update-fn (ivy-state-update-fn ivy-last))
1760 deactivate-mark)
1761 (ivy--cleanup)
1762 (when update-fn
1763 (funcall update-fn))
1764 (ivy--insert-prompt)
1765 ;; Do nothing if while-no-input was aborted.
1766 (when (stringp text)
1767 (let ((buffer-undo-list t))
1768 (save-excursion
1769 (forward-line 1)
1770 (insert text))))
1771 (when (display-graphic-p)
1772 (ivy--resize-minibuffer-to-fit))))
1773
1774 (defun ivy--resize-minibuffer-to-fit ()
1775 "Resize the minibuffer window size to fit the text in the minibuffer."
1776 (with-selected-window (minibuffer-window)
1777 (if (fboundp 'window-text-pixel-size)
1778 (let ((text-height (cdr (window-text-pixel-size)))
1779 (body-height (window-body-height nil t)))
1780 (when (> text-height body-height)
1781 ;; Note: the size increment needs to be at least frame-char-height,
1782 ;; otherwise resizing won't do anything.
1783 (let ((delta (max (- text-height body-height) (frame-char-height))))
1784 (window-resize nil delta nil t t))))
1785 (let ((text-height (count-screen-lines))
1786 (body-height (window-body-height)))
1787 (when (> text-height body-height)
1788 (window-resize nil (- text-height body-height) nil t))))))
1789
1790 (declare-function colir-blend-face-background "ext:colir")
1791
1792 (defun ivy--add-face (str face)
1793 "Propertize STR with FACE.
1794 `font-lock-append-text-property' is used, since it's better than
1795 `propertize' or `add-face-text-property' in this case."
1796 (require 'colir)
1797 (condition-case nil
1798 (progn
1799 (colir-blend-face-background 0 (length str) face str)
1800 (let ((foreground (face-foreground face)))
1801 (when foreground
1802 (add-face-text-property
1803 0 (length str)
1804 `(:foreground ,foreground)
1805 nil
1806 str))))
1807 (error
1808 (ignore-errors
1809 (font-lock-append-text-property 0 (length str) 'face face str))))
1810 str)
1811
1812 (declare-function flx-make-string-cache "ext:flx")
1813 (declare-function flx-score "ext:flx")
1814
1815 (defvar ivy--flx-cache nil)
1816
1817 (eval-after-load 'flx
1818 '(setq ivy--flx-cache (flx-make-string-cache)))
1819
1820 (defun ivy-toggle-case-fold ()
1821 "Toggle the case folding between nil and auto.
1822 In any completion session, the case folding starts in auto:
1823
1824 - when the input is all lower case, `case-fold-search' is t
1825 - otherwise nil.
1826
1827 You can toggle this to make `case-fold-search' nil regardless of input."
1828 (interactive)
1829 (setq ivy-case-fold-search
1830 (if ivy-case-fold-search
1831 nil
1832 'auto))
1833 ;; reset cache so that the candidate list updates
1834 (setq ivy--old-re nil))
1835
1836 (defun ivy--re-filter (re candidates)
1837 "Return all RE matching CANDIDATES.
1838 RE is a list of cons cells, with a regexp car and a boolean cdr.
1839 When the cdr is t, the car must match.
1840 Otherwise, the car must not match."
1841 (let ((re-list (if (stringp re) (list (cons re t)) re))
1842 (res candidates))
1843 (dolist (re re-list)
1844 (setq res
1845 (ignore-errors
1846 (funcall
1847 (if (cdr re)
1848 #'cl-remove-if-not
1849 #'cl-remove-if)
1850 (let ((re-str (car re)))
1851 (lambda (x) (string-match re-str x)))
1852 res))))
1853 res))
1854
1855 (defun ivy--filter (name candidates)
1856 "Return all items that match NAME in CANDIDATES.
1857 CANDIDATES are assumed to be static."
1858 (let ((re (funcall ivy--regex-function name)))
1859 (if (and (equal re ivy--old-re)
1860 ivy--old-cands)
1861 ;; quick caching for "C-n", "C-p" etc.
1862 ivy--old-cands
1863 (let* ((re-str (if (listp re) (caar re) re))
1864 (matcher (ivy-state-matcher ivy-last))
1865 (case-fold-search
1866 (and ivy-case-fold-search
1867 (string= name (downcase name))))
1868 (cands (cond
1869 (matcher
1870 (funcall matcher re candidates))
1871 ((and ivy--old-re
1872 (stringp re)
1873 (stringp ivy--old-re)
1874 (not (string-match "\\\\" ivy--old-re))
1875 (not (equal ivy--old-re ""))
1876 (memq (cl-search
1877 (if (string-match "\\\\)\\'" ivy--old-re)
1878 (substring ivy--old-re 0 -2)
1879 ivy--old-re)
1880 re)
1881 '(0 2)))
1882 (ignore-errors
1883 (cl-remove-if-not
1884 (lambda (x) (string-match re x))
1885 ivy--old-cands)))
1886 (t
1887 (ivy--re-filter re candidates)))))
1888 (ivy--recompute-index name re-str cands)
1889 (setq ivy--old-re
1890 (if (eq ivy--regex-function 'ivy--regex-ignore-order)
1891 re
1892 (if cands
1893 re-str
1894 "")))
1895 (setq ivy--old-cands (ivy--sort name cands))))))
1896
1897 (defcustom ivy-sort-matches-functions-alist '((t . nil))
1898 "An alist of functions used to sort the matching candidates.
1899
1900 This is different from `ivy-sort-functions-alist', which is used
1901 to sort the whole collection only once. The functions taken from
1902 here are instead used on each input change, but they are used
1903 only on already matching candidates, not on all of them.
1904
1905 The alist KEY is a collection function or t to match previously
1906 not matched collection functions.
1907
1908 The alist VAL is a sorting function with the signature of
1909 `ivy--prefix-sort'.")
1910
1911 (defun ivy--sort-files-by-date (_name candidates)
1912 "Re-soft CANDIDATES according to file modification date."
1913 (let ((default-directory ivy--directory))
1914 (cl-sort (copy-sequence candidates)
1915 (lambda (f1 f2)
1916 (time-less-p
1917 (nth 5 (file-attributes f2))
1918 (nth 5 (file-attributes f1)))))))
1919
1920 (defun ivy--sort (name candidates)
1921 "Re-sort CANDIDATES by NAME.
1922 All CANDIDATES are assumed to match NAME."
1923 (let ((key (or (ivy-state-caller ivy-last)
1924 (when (functionp (ivy-state-collection ivy-last))
1925 (ivy-state-collection ivy-last))))
1926 fun)
1927 (cond ((and (require 'flx nil 'noerror)
1928 (eq ivy--regex-function 'ivy--regex-fuzzy))
1929 (ivy--flx-sort name candidates))
1930 ((setq fun (cdr (or (assoc key ivy-sort-matches-functions-alist)
1931 (assoc t ivy-sort-matches-functions-alist))))
1932 (funcall fun name candidates))
1933 (t
1934 candidates))))
1935
1936 (defun ivy--prefix-sort (name candidates)
1937 "Re-sort CANDIDATES.
1938 Prefix matches to NAME are put ahead of the list."
1939 (if (or (string-match "^\\^" name) (string= name ""))
1940 candidates
1941 (let ((re-prefix (concat "^" (funcall ivy--regex-function name)))
1942 res-prefix
1943 res-noprefix)
1944 (dolist (s candidates)
1945 (if (string-match re-prefix s)
1946 (push s res-prefix)
1947 (push s res-noprefix)))
1948 (nconc
1949 (nreverse res-prefix)
1950 (nreverse res-noprefix)))))
1951
1952 (defun ivy--recompute-index (name re-str cands)
1953 (let* ((caller (ivy-state-caller ivy-last))
1954 (func (or (and caller (cdr (assoc caller ivy-index-functions-alist)))
1955 (cdr (assoc t ivy-index-functions-alist))
1956 #'ivy-recompute-index-zero)))
1957 (unless (eq this-command 'ivy-resume)
1958 (setq ivy--index
1959 (or
1960 (cl-position (if (and (> (length re-str) 0)
1961 (eq ?^ (aref re-str 0)))
1962 (substring re-str 1)
1963 re-str) cands
1964 :test #'equal)
1965 (and ivy--directory
1966 (cl-position
1967 (concat re-str "/") cands
1968 :test #'equal))
1969 (and (not (string= name ""))
1970 (not (and (require 'flx nil 'noerror)
1971 (eq ivy--regex-function 'ivy--regex-fuzzy)
1972 (< (length cands) 200)))
1973
1974 (cl-position (nth ivy--index ivy--old-cands)
1975 cands))
1976 (funcall func re-str cands))))
1977 (when (and (or (string= name "")
1978 (string= name "^"))
1979 (not (equal ivy--old-re "")))
1980 (setq ivy--index
1981 (or (ivy--preselect-index
1982 (ivy-state-preselect ivy-last)
1983 cands)
1984 ivy--index)))))
1985
1986 (defun ivy-recompute-index-swiper (_re-str cands)
1987 (let ((tail (nthcdr ivy--index ivy--old-cands))
1988 idx)
1989 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
1990 (progn
1991 (while (and tail (null idx))
1992 ;; Compare with eq to handle equal duplicates in cands
1993 (setq idx (cl-position (pop tail) cands)))
1994 (or idx 0))
1995 (if ivy--old-cands
1996 ivy--index
1997 ;; already in ivy-state-buffer
1998 (let ((n (line-number-at-pos))
1999 (res 0)
2000 (i 0))
2001 (dolist (c cands)
2002 (when (eq n (read (get-text-property 0 'display c)))
2003 (setq res i))
2004 (cl-incf i))
2005 res)))))
2006
2007 (defun ivy-recompute-index-swiper-async (_re-str cands)
2008 (let ((tail (nthcdr ivy--index ivy--old-cands))
2009 idx)
2010 (if (and tail ivy--old-cands (not (equal "^" ivy--old-re)))
2011 (progn
2012 (while (and tail (null idx))
2013 ;; Compare with `equal', since the collection is re-created
2014 ;; each time with `split-string'
2015 (setq idx (cl-position (pop tail) cands :test #'equal)))
2016 (or idx 0))
2017 ivy--index)))
2018
2019 (defun ivy-recompute-index-zero (_re-str _cands)
2020 0)
2021
2022 (defcustom ivy-minibuffer-faces
2023 '(ivy-minibuffer-match-face-1
2024 ivy-minibuffer-match-face-2
2025 ivy-minibuffer-match-face-3
2026 ivy-minibuffer-match-face-4)
2027 "List of `ivy' faces for minibuffer group matches.")
2028
2029 (defun ivy--flx-sort (name cands)
2030 "Sort according to closeness to string NAME the string list CANDS."
2031 (condition-case nil
2032 (if (and cands
2033 (< (length cands) 200))
2034 (let* ((flx-name (if (string-match "^\\^" name)
2035 (substring name 1)
2036 name))
2037 (cands-with-score
2038 (delq nil
2039 (mapcar
2040 (lambda (x)
2041 (let ((score (flx-score x flx-name ivy--flx-cache)))
2042 (and score
2043 (cons score x))))
2044 cands))))
2045 (if cands-with-score
2046 (mapcar (lambda (x)
2047 (let ((str (copy-sequence (cdr x)))
2048 (i 0)
2049 (last-j -2))
2050 (dolist (j (cdar x))
2051 (unless (eq j (1+ last-j))
2052 (cl-incf i))
2053 (setq last-j j)
2054 (ivy-add-face-text-property
2055 j (1+ j)
2056 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2057 ivy-minibuffer-faces)
2058 str))
2059 str))
2060 (sort cands-with-score
2061 (lambda (x y)
2062 (> (caar x) (caar y)))))
2063 cands))
2064 cands)
2065 (error
2066 cands)))
2067
2068 (defcustom ivy-format-function 'ivy-format-function-default
2069 "Function to transform the list of candidates into a string.
2070 This string is inserted into the minibuffer."
2071 :type '(choice
2072 (const :tag "Default" ivy-format-function-default)
2073 (const :tag "Arrow prefix" ivy-format-function-arrow)
2074 (const :tag "Full line" ivy-format-function-line)))
2075
2076 (defun ivy--truncate-string (str width)
2077 "Truncate STR to WIDTH."
2078 (if (> (string-width str) width)
2079 (concat (substring str 0 (min (- width 3)
2080 (- (length str) 3))) "...")
2081 str))
2082
2083 (defun ivy--format-function-generic (selected-fn other-fn cand-pairs separator)
2084 "Transform CAND-PAIRS into a string for minibuffer.
2085 SELECTED-FN and OTHER-FN each take two string arguments.
2086 SEPARATOR is used to join the candidates."
2087 (let ((i -1))
2088 (mapconcat
2089 (lambda (pair)
2090 (let ((str (car pair))
2091 (extra (cdr pair))
2092 (curr (eq (cl-incf i) ivy--index)))
2093 (if curr
2094 (funcall selected-fn str extra)
2095 (funcall other-fn str extra))))
2096 cand-pairs
2097 separator)))
2098
2099 (defun ivy-format-function-default (cand-pairs)
2100 "Transform CAND-PAIRS into a string for minibuffer."
2101 (ivy--format-function-generic
2102 (lambda (str extra)
2103 (concat (ivy--add-face str 'ivy-current-match) extra))
2104 #'concat
2105 cand-pairs
2106 "\n"))
2107
2108 (defun ivy-format-function-arrow (cand-pairs)
2109 "Transform CAND-PAIRS into a string for minibuffer."
2110 (ivy--format-function-generic
2111 (lambda (str extra)
2112 (concat "> " (ivy--add-face str 'ivy-current-match) extra))
2113 (lambda (str extra)
2114 (concat " " str extra))
2115 cand-pairs
2116 "\n"))
2117
2118 (defun ivy-format-function-line (cand-pairs)
2119 "Transform CAND-PAIRS into a string for minibuffer."
2120 (ivy--format-function-generic
2121 (lambda (str extra)
2122 (ivy--add-face (concat str extra "\n") 'ivy-current-match))
2123 (lambda (str extra)
2124 (concat str extra "\n"))
2125 cand-pairs
2126 ""))
2127
2128 (defun ivy-add-face-text-property (start end face str)
2129 (if (fboundp 'add-face-text-property)
2130 (add-face-text-property
2131 start end face nil str)
2132 (font-lock-append-text-property
2133 start end 'face face str)))
2134
2135 (defun ivy--format-minibuffer-line (str)
2136 (let ((start 0)
2137 (str (copy-sequence str)))
2138 (cond ((eq ivy--regex-function 'ivy--regex-ignore-order)
2139 (when (consp ivy--old-re)
2140 (let ((i 1))
2141 (dolist (re ivy--old-re)
2142 (when (string-match (car re) str)
2143 (ivy-add-face-text-property
2144 (match-beginning 0) (match-end 0)
2145 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2146 ivy-minibuffer-faces)
2147 str))
2148 (cl-incf i)))))
2149 ((and (eq ivy-display-style 'fancy)
2150 (not (eq ivy--regex-function 'ivy--regex-fuzzy)))
2151 (unless ivy--old-re
2152 (setq ivy--old-re (funcall ivy--regex-function ivy-text)))
2153 (while (and (string-match ivy--old-re str start)
2154 (> (- (match-end 0) (match-beginning 0)) 0))
2155 (setq start (match-end 0))
2156 (let ((i 0))
2157 (while (<= i ivy--subexps)
2158 (let ((face
2159 (cond ((zerop ivy--subexps)
2160 (cadr ivy-minibuffer-faces))
2161 ((zerop i)
2162 (car ivy-minibuffer-faces))
2163 (t
2164 (nth (1+ (mod (+ i 2) (1- (length ivy-minibuffer-faces))))
2165 ivy-minibuffer-faces)))))
2166 (ivy-add-face-text-property
2167 (match-beginning i) (match-end i)
2168 face str))
2169 (cl-incf i))))))
2170 str))
2171
2172 (defun ivy--format (cands)
2173 "Return a string for CANDS suitable for display in the minibuffer.
2174 CANDS is a list of strings."
2175 (setq ivy--length (length cands))
2176 (when (>= ivy--index ivy--length)
2177 (setq ivy--index (max (1- ivy--length) 0)))
2178 (if (null cands)
2179 (setq ivy--current "")
2180 (let* ((half-height (/ ivy-height 2))
2181 (start (max 0 (- ivy--index half-height)))
2182 (end (min (+ start (1- ivy-height)) ivy--length))
2183 (start (max 0 (min start (- end (1- ivy-height)))))
2184 (cands (cl-subseq cands start end))
2185 (index (- ivy--index start)))
2186 (cond (ivy--directory
2187 (setq cands (mapcar (lambda (x)
2188 (if (string-match-p "/\\'" x)
2189 (propertize x 'face 'ivy-subdir)
2190 x))
2191 cands)))
2192 ((eq (ivy-state-collection ivy-last) 'internal-complete-buffer)
2193 (setq cands (mapcar (lambda (x)
2194 (let ((b (get-buffer x)))
2195 (if (and b
2196 (buffer-file-name b)
2197 (buffer-modified-p b))
2198 (propertize x 'face 'ivy-modified-buffer)
2199 x)))
2200 cands))))
2201 (setq ivy--current (copy-sequence (nth index cands)))
2202 (let* ((ivy--index index)
2203 (cand-pairs (mapcar
2204 (lambda (cand)
2205 (cons (ivy--format-minibuffer-line cand) nil)) cands))
2206 (res (concat "\n" (funcall ivy-format-function cand-pairs))))
2207 (put-text-property 0 (length res) 'read-only nil res)
2208 res))))
2209
2210 (defvar ivy--virtual-buffers nil
2211 "Store the virtual buffers alist.")
2212
2213 (defvar recentf-list)
2214
2215 (defcustom ivy-virtual-abbreviate 'name
2216 "The mode of abbreviation for virtual buffer names."
2217 :type '(choice
2218 (const :tag "Only name" name)
2219 (const :tag "Full path" full)
2220 ;; eventually, uniquify
2221 ))
2222
2223 (defun ivy--virtual-buffers ()
2224 "Adapted from `ido-add-virtual-buffers-to-list'."
2225 (unless recentf-mode
2226 (recentf-mode 1))
2227 (let ((bookmarks (and (boundp 'bookmark-alist)
2228 bookmark-alist))
2229 virtual-buffers name)
2230 (dolist (head (append
2231 recentf-list
2232 (delete " - no file -"
2233 (delq nil (mapcar (lambda (bookmark)
2234 (cdr (assoc 'filename bookmark)))
2235 bookmarks)))))
2236 (setq name
2237 (if (eq ivy-virtual-abbreviate 'name)
2238 (file-name-nondirectory head)
2239 (expand-file-name head)))
2240 (when (equal name "")
2241 (setq name (file-name-nondirectory (directory-file-name head))))
2242 (when (equal name "")
2243 (setq name head))
2244 (and (not (equal name ""))
2245 (null (get-file-buffer head))
2246 (not (assoc name virtual-buffers))
2247 (push (cons name head) virtual-buffers)))
2248 (when virtual-buffers
2249 (dolist (comp virtual-buffers)
2250 (put-text-property 0 (length (car comp))
2251 'face 'ivy-virtual
2252 (car comp)))
2253 (setq ivy--virtual-buffers (nreverse virtual-buffers))
2254 (mapcar #'car ivy--virtual-buffers))))
2255
2256 (defun ivy--buffer-list (str &optional virtual)
2257 "Return the buffers that match STR.
2258 When VIRTUAL is non-nil, add virtual buffers."
2259 (delete-dups
2260 (append
2261 (mapcar
2262 (lambda (x)
2263 (if (with-current-buffer x
2264 (file-remote-p
2265 (abbreviate-file-name default-directory)))
2266 (propertize x 'face 'ivy-remote)
2267 x))
2268 (all-completions str 'internal-complete-buffer))
2269 (and virtual
2270 (ivy--virtual-buffers)))))
2271
2272 (defun ivy--switch-buffer-action (buffer)
2273 "Switch to BUFFER.
2274 BUFFER may be a string or nil."
2275 (with-ivy-window
2276 (if (zerop (length buffer))
2277 (switch-to-buffer
2278 ivy-text nil 'force-same-window)
2279 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2280 (if (and virtual
2281 (not (get-buffer buffer)))
2282 (find-file (cdr virtual))
2283 (switch-to-buffer
2284 buffer nil 'force-same-window))))))
2285
2286 (defun ivy--switch-buffer-other-window-action (buffer)
2287 "Switch to BUFFER in other window.
2288 BUFFER may be a string or nil."
2289 (if (zerop (length buffer))
2290 (switch-to-buffer-other-window ivy-text)
2291 (let ((virtual (assoc buffer ivy--virtual-buffers)))
2292 (if (and virtual
2293 (not (get-buffer buffer)))
2294 (find-file-other-window (cdr virtual))
2295 (switch-to-buffer-other-window buffer)))))
2296
2297 (defun ivy--rename-buffer-action (buffer)
2298 "Rename BUFFER."
2299 (let ((new-name (read-string "Rename buffer (to new name): ")))
2300 (with-current-buffer buffer
2301 (rename-buffer new-name))))
2302
2303 (defvar ivy-switch-buffer-map (make-sparse-keymap))
2304
2305 (ivy-set-actions
2306 'ivy-switch-buffer
2307 '(("k"
2308 (lambda (x)
2309 (kill-buffer x)
2310 (ivy--reset-state ivy-last))
2311 "kill")
2312 ("j"
2313 ivy--switch-buffer-other-window-action
2314 "other")
2315 ("r"
2316 ivy--rename-buffer-action
2317 "rename")))
2318
2319 ;;;###autoload
2320 (defun ivy-switch-buffer ()
2321 "Switch to another buffer."
2322 (interactive)
2323 (if (not ivy-mode)
2324 (call-interactively 'switch-to-buffer)
2325 (let ((this-command 'ivy-switch-buffer))
2326 (ivy-read "Switch to buffer: " 'internal-complete-buffer
2327 :preselect (buffer-name (other-buffer (current-buffer)))
2328 :action #'ivy--switch-buffer-action
2329 :keymap ivy-switch-buffer-map))))
2330
2331 ;;;###autoload
2332 (defun ivy-recentf ()
2333 "Find a file on `recentf-list'."
2334 (interactive)
2335 (ivy-read "Recentf: " recentf-list
2336 :action
2337 (lambda (f)
2338 (with-ivy-window
2339 (find-file f)))))
2340
2341 (defun ivy-yank-word ()
2342 "Pull next word from buffer into search string."
2343 (interactive)
2344 (let (amend)
2345 (with-ivy-window
2346 (let ((pt (point))
2347 (le (line-end-position)))
2348 (forward-word 1)
2349 (if (> (point) le)
2350 (goto-char pt)
2351 (setq amend (buffer-substring-no-properties pt (point))))))
2352 (when amend
2353 (insert (replace-regexp-in-string " +" " " amend)))))
2354
2355 (defun ivy-kill-ring-save ()
2356 "Store the current candidates into the kill ring.
2357 If the region is active, forward to `kill-ring-save' instead."
2358 (interactive)
2359 (if (region-active-p)
2360 (call-interactively 'kill-ring-save)
2361 (kill-new
2362 (mapconcat
2363 #'identity
2364 ivy--old-cands
2365 "\n"))))
2366
2367 (defun ivy-insert-current ()
2368 "Make the current candidate into current input.
2369 Don't finish completion."
2370 (interactive)
2371 (delete-minibuffer-contents)
2372 (if (and ivy--directory
2373 (string-match "/$" ivy--current))
2374 (insert (substring ivy--current 0 -1))
2375 (insert ivy--current)))
2376
2377 (defun ivy-toggle-fuzzy ()
2378 "Toggle the re builder between `ivy--regex-fuzzy' and `ivy--regex-plus'."
2379 (interactive)
2380 (setq ivy--old-re nil)
2381 (if (eq ivy--regex-function 'ivy--regex-fuzzy)
2382 (setq ivy--regex-function 'ivy--regex-plus)
2383 (setq ivy--regex-function 'ivy--regex-fuzzy)))
2384
2385 (defun ivy-reverse-i-search ()
2386 "Enter a recursive `ivy-read' session using the current history.
2387 The selected history element will be inserted into the minibuffer."
2388 (interactive)
2389 (let ((enable-recursive-minibuffers t)
2390 (history (symbol-value (ivy-state-history ivy-last)))
2391 (old-last ivy-last)
2392 (ivy-recursive-restore nil))
2393 (ivy-read "Reverse-i-search: "
2394 history
2395 :action (lambda (x)
2396 (ivy--reset-state
2397 (setq ivy-last old-last))
2398 (delete-minibuffer-contents)
2399 (insert (substring-no-properties x))
2400 (ivy--cd-maybe)))))
2401
2402 (defun ivy-restrict-to-matches ()
2403 "Restrict candidates to current matches and erase input."
2404 (interactive)
2405 (delete-minibuffer-contents)
2406 (setq ivy--all-candidates
2407 (ivy--filter ivy-text ivy--all-candidates)))
2408
2409 ;;* Occur
2410 (defvar-local ivy-occur-last nil
2411 "Buffer-local value of `ivy-last'.
2412 Can't re-use `ivy-last' because using e.g. `swiper' in the same
2413 buffer would modify `ivy-last'.")
2414
2415 (defvar ivy-occur-mode-map
2416 (let ((map (make-sparse-keymap)))
2417 (define-key map [mouse-1] 'ivy-occur-click)
2418 (define-key map (kbd "RET") 'ivy-occur-press)
2419 (define-key map (kbd "j") 'next-line)
2420 (define-key map (kbd "k") 'previous-line)
2421 (define-key map (kbd "h") 'backward-char)
2422 (define-key map (kbd "l") 'forward-char)
2423 (define-key map (kbd "g") 'ivy-occur-press)
2424 (define-key map (kbd "a") 'ivy-occur-read-action)
2425 (define-key map (kbd "o") 'ivy-occur-dispatch)
2426 (define-key map (kbd "q") 'quit-window)
2427 map)
2428 "Keymap for Ivy Occur mode.")
2429
2430 (define-derived-mode ivy-occur-mode fundamental-mode "Ivy-Occur"
2431 "Major mode for output from \\[ivy-occur].
2432
2433 \\{ivy-occur-mode-map}")
2434
2435 (defvar ivy-occur-grep-mode-map
2436 (let ((map (copy-keymap ivy-occur-mode-map)))
2437 (define-key map (kbd "C-x C-q") 'ivy-wgrep-change-to-wgrep-mode)
2438 map)
2439 "Keymap for Ivy Occur Grep mode.")
2440
2441 (define-derived-mode ivy-occur-grep-mode grep-mode "Ivy-Occur"
2442 "Major mode for output from \\[ivy-occur].
2443
2444 \\{ivy-occur-grep-mode-map}")
2445
2446 (defvar counsel-git-grep-cmd)
2447
2448 (defun ivy-occur ()
2449 "Stop completion and put the current matches into a new buffer.
2450
2451 The new buffer remembers current action(s).
2452
2453 While in the *ivy-occur* buffer, selecting a candidate with RET or
2454 a mouse click will call the appropriate action for that candidate.
2455
2456 There is no limit on the number of *ivy-occur* buffers."
2457 (interactive)
2458 (let ((buffer
2459 (generate-new-buffer
2460 (format "*ivy-occur%s \"%s\"*"
2461 (let (caller)
2462 (if (setq caller (ivy-state-caller ivy-last))
2463 (concat " " (prin1-to-string caller))
2464 ""))
2465 ivy-text)))
2466 (do-grep (eq (ivy-state-caller ivy-last) 'counsel-git-grep)))
2467 (with-current-buffer buffer
2468 (if do-grep
2469 (progn
2470 (setq ivy--old-cands
2471 (split-string
2472 (shell-command-to-string
2473 (format counsel-git-grep-cmd
2474 (if (stringp ivy--old-re)
2475 ivy--old-re
2476 (caar ivy--old-re))))
2477 "\n"
2478 t))
2479 (ivy-occur-grep-mode))
2480 (ivy-occur-mode))
2481 (setf (ivy-state-text ivy-last) ivy-text)
2482 (setq ivy-occur-last ivy-last)
2483 (setq-local ivy--directory ivy--directory)
2484 (let ((inhibit-read-only t))
2485 (erase-buffer)
2486 (when do-grep
2487 ;; Need precise number of header lines for `wgrep' to work.
2488 (insert (format "-*- mode:grep; default-directory: %S -*-\n\n\n"
2489 default-directory)))
2490 (insert (format "%d candidates:\n" (length ivy--old-cands)))
2491 (dolist (cand ivy--old-cands)
2492 (let ((str (if do-grep
2493 (concat "./" cand)
2494 (concat " " cand))))
2495 (add-text-properties
2496 0 (length str)
2497 `(mouse-face
2498 highlight
2499 help-echo "mouse-1: call ivy-action")
2500 str)
2501 (insert str "\n")))))
2502 (ivy-exit-with-action
2503 `(lambda (_) (pop-to-buffer ,buffer)))))
2504
2505 (declare-function wgrep-change-to-wgrep-mode "ext:wgrep")
2506
2507 (defun ivy-wgrep-change-to-wgrep-mode ()
2508 "Forward to `wgrep-change-to-wgrep-mode'."
2509 (interactive)
2510 (if (require 'wgrep nil 'noerror)
2511 (wgrep-change-to-wgrep-mode)
2512 (error "Package wgrep isn't installed")))
2513
2514 (defun ivy-occur-read-action ()
2515 "Select one of the available actions as the current one."
2516 (interactive)
2517 (let ((ivy-last ivy-occur-last))
2518 (ivy-read-action)))
2519
2520 (defun ivy-occur-dispatch ()
2521 "Call one of the available actions on the current item."
2522 (interactive)
2523 (let* ((state-action (ivy-state-action ivy-occur-last))
2524 (actions (if (symbolp state-action)
2525 state-action
2526 (copy-sequence state-action))))
2527 (unwind-protect
2528 (progn
2529 (ivy-occur-read-action)
2530 (ivy-occur-press))
2531 (setf (ivy-state-action ivy-occur-last) actions))))
2532
2533 (defun ivy-occur-click (event)
2534 "Execute action for the current candidate.
2535 EVENT gives the mouse position."
2536 (interactive "e")
2537 (let ((window (posn-window (event-end event)))
2538 (pos (posn-point (event-end event))))
2539 (with-current-buffer (window-buffer window)
2540 (goto-char pos)
2541 (ivy-occur-press))))
2542
2543 (declare-function swiper--cleanup "swiper")
2544 (declare-function swiper--add-overlays "swiper")
2545
2546 (defun ivy-occur-press ()
2547 "Execute action for the current candidate."
2548 (interactive)
2549 (require 'pulse)
2550 (when (save-excursion
2551 (beginning-of-line)
2552 (looking-at "\\(?:./\\| \\)\\(.*\\)$"))
2553 (let* ((ivy-last ivy-occur-last)
2554 (ivy-text (ivy-state-text ivy-last))
2555 (str (buffer-substring
2556 (match-beginning 1)
2557 (match-end 1)))
2558 (coll (ivy-state-collection ivy-last))
2559 (action (ivy--get-action ivy-last))
2560 (ivy-exit 'done))
2561 (with-ivy-window
2562 (funcall action
2563 (if (and (consp coll)
2564 (consp (car coll)))
2565 (cdr (assoc str coll))
2566 str))
2567 (if (memq (ivy-state-caller ivy-last)
2568 '(swiper counsel-git-grep))
2569 (with-current-buffer (window-buffer (selected-window))
2570 (swiper--cleanup)
2571 (swiper--add-overlays
2572 (ivy--regex ivy-text)
2573 (line-beginning-position)
2574 (line-end-position)
2575 (selected-window))
2576 (run-at-time 0.5 nil 'swiper--cleanup))
2577 (pulse-momentary-highlight-one-line (point)))))))
2578
2579 (provide 'ivy)
2580
2581 ;;; ivy.el ends here