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