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