1 ;;; swiper.el --- Isearch with an overview. Oh, man! -*- lexical-binding: t -*-
3 ;; Copyright (C) 2015 Free Software Foundation, Inc.
5 ;; Author: Oleh Krehel <ohwoeowho@gmail.com>
6 ;; URL: https://github.com/abo-abo/swiper
8 ;; Package-Requires: ((emacs "24.1"))
11 ;; This file is part of GNU Emacs.
13 ;; This file is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
18 ;; This program is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; For a full copy of the GNU General Public License
24 ;; see <http://www.gnu.org/licenses/>.
28 ;; This package gives an overview of the current regex search
29 ;; candidates. The search regex can be split into groups with a
30 ;; space. Each group is highlighted with a different face.
32 ;; The overview back end is `ivy'.
34 ;; It can double as a quick `regex-builder', although only single
35 ;; lines will be matched.
41 "`isearch' with an overview."
45 (defface swiper-match-face-1
46 '((t (:inherit isearch-lazy-highlight-face)))
47 "Face for `swiper' matches.")
49 (defface swiper-match-face-2
50 '((t (:inherit isearch)))
51 "Face for `swiper' matches.")
53 (defface swiper-match-face-3
54 '((t (:inherit match)))
55 "Face for `swiper' matches.")
57 (defface swiper-match-face-4
58 '((t (:inherit isearch)))
59 "Face for `swiper' matches.")
61 (defface swiper-line-face
62 '((t (:inherit highlight)))
63 "Face for current `swiper' line.")
65 (defcustom swiper-faces '(swiper-match-face-1
69 "List of `swiper' faces for group matches.")
71 (defcustom swiper-min-highlight 2
72 "Only highlight matches for regexps at least this long."
76 (let ((map (make-sparse-keymap)))
77 (define-key map (kbd "M-q") 'swiper-query-replace)
78 (define-key map (kbd "C-l") 'swiper-recenter-top-bottom)
82 (defun swiper-query-replace ()
83 "Start `query-replace' with string to replace from last search string."
85 (if (null (window-minibuffer-p))
86 (user-error "Should only be called in the minibuffer through `swiper-map'")
87 (let* ((enable-recursive-minibuffers t)
88 (from (ivy--regex ivy-text))
89 (to (query-replace-read-to from "Query replace" t)))
90 (delete-minibuffer-contents)
93 (with-selected-window swiper--window
94 (perform-replace from to
99 (defvar swiper--window nil
100 "Store the current window.")
102 (defun swiper-recenter-top-bottom (&optional arg)
103 "Call (`recenter-top-bottom' ARG) in `swiper--window'."
105 (with-selected-window swiper--window
106 (recenter-top-bottom arg)))
108 (defun swiper-font-lock-ensure ()
109 "Ensure the entired buffer is highlighted."
110 (unless (or (derived-mode-p 'magit-mode)
111 (memq major-mode '(package-menu-mode
115 emms-playlist-mode erc-mode
119 (unless (> (buffer-size) 100000)
120 (if (fboundp 'font-lock-ensure)
122 (with-no-warnings (font-lock-fontify-buffer))))))
124 (defvar swiper--format-spec ""
125 "Store the current candidates format spec.")
127 (defun swiper--candidates ()
128 "Return a list of this buffer lines."
129 (let ((n-lines (count-lines (point-min) (point-max))))
130 (unless (zerop n-lines)
131 (setq swiper--format-spec
132 (format "%%-%dd %%s" (1+ (floor (log n-lines 10)))))
133 (let ((line-number 0)
136 (goto-char (point-min))
137 (swiper-font-lock-ensure)
138 (while (< (point) (point-max))
139 (push (format swiper--format-spec
140 (cl-incf line-number)
142 (line-beginning-position)
143 (line-end-position)))
146 (nreverse candidates))))))
148 (defvar swiper--opoint 1
149 "The point when `swiper' starts.")
152 (defun swiper (&optional initial-input)
153 "`isearch' with an overview.
154 When non-nil, INITIAL-INPUT is the initial search pattern."
156 (swiper--ivy initial-input))
158 (defvar swiper--anchor nil
159 "A line number to which the search should be anchored.")
161 (defvar swiper--len 0
162 "The last length of input for which an anchoring was made.")
164 (defun swiper--init ()
165 "Perform initialization common to both completion methods."
167 (setq swiper--opoint (point))
169 (setq swiper--anchor (line-number-at-pos))
170 (setq swiper--window (selected-window)))
172 (defun swiper--ivy (&optional initial-input)
173 "`isearch' with an overview using `ivy'.
174 When non-nil, INITIAL-INPUT is the initial search pattern."
176 (unless (eq (length (help-function-arglist 'ivy-read)) 4)
177 (warn "You seem to be using the outdated stand-alone \"ivy\" package.
178 Please remove it and update the \"swiper\" package."))
180 (let ((candidates (swiper--candidates))
185 (buffer-substring-no-properties
186 (line-beginning-position)
187 (line-end-position)))))
191 (replace-regexp-in-string
192 "%s" "pattern: " swiper--format-spec)
194 :initial-input initial-input
198 :update-fn #'swiper--update-input-ivy))
201 (goto-char swiper--opoint)
202 (swiper--action res ivy-text)))))
204 (defun swiper--ensure-visible ()
205 "Remove overlays hiding point."
206 (let ((overlays (overlays-at (point)))
208 (while (setq ov (pop overlays))
209 (if (and (invisible-p (overlay-get ov 'invisible))
210 (setq expose (overlay-get ov 'isearch-open-invisible)))
211 (funcall expose ov)))))
213 (defvar swiper--overlays nil
216 (defun swiper--cleanup ()
217 "Clean up the overlays."
218 (while swiper--overlays
219 (delete-overlay (pop swiper--overlays)))
221 (goto-char (point-min))
222 (isearch-clean-overlays)))
224 (defun swiper--update-input-ivy ()
225 "Called when `ivy' input is updated."
227 (let* ((re (ivy--regex ivy-text))
229 (num (if (string-match "^[0-9]+" str)
230 (string-to-number (match-string 0 str))
232 (with-selected-window swiper--window
233 (goto-char (point-min))
235 (goto-char (point-min))
236 (forward-line (1- num))
237 (isearch-range-invisible (line-beginning-position)
239 (unless (and (>= (point) (window-start))
240 (<= (point) (window-end swiper--window t)))
242 (swiper--add-overlays re))))
244 (defun swiper--add-overlays (re &optional beg end)
245 "Add overlays for RE regexp in visible part of the current buffer.
246 BEG and END, when specified, are the point bounds."
247 (let ((ov (make-overlay
248 (line-beginning-position)
249 (1+ (line-end-position)))))
250 (overlay-put ov 'face 'swiper-line-face)
251 (overlay-put ov 'window swiper--window)
252 (push ov swiper--overlays))
253 (let* ((wh (window-height))
254 (beg (or beg (save-excursion
255 (forward-line (- wh))
257 (end (or end (save-excursion
260 (when (>= (length re) swiper-min-highlight)
263 ;; RE can become an invalid regexp
264 (while (and (ignore-errors (re-search-forward re end t))
265 (> (- (match-end 0) (match-beginning 0)) 0))
267 (while (<= i ivy--subexps)
268 (when (match-beginning i)
269 (let ((overlay (make-overlay (match-beginning i)
272 (cond ((zerop ivy--subexps)
273 (cl-caddr swiper-faces))
277 (nth (1+ (mod (1- i) (1- (length swiper-faces))))
279 (push overlay swiper--overlays)
280 (overlay-put overlay 'face face)
281 (overlay-put overlay 'window swiper--window)
282 (overlay-put overlay 'priority i)))
285 (defun swiper--action (x input)
286 "Goto line X and search for INPUT."
288 (user-error "No candidates")
289 (goto-char (point-min))
290 (forward-line (1- (read x)))
292 (ivy--regex input) (line-end-position) t)
293 (swiper--ensure-visible)
294 (when (/= (point) swiper--opoint)
295 (unless (and transient-mark-mode mark-active)
296 (push-mark swiper--opoint t)
297 (message "Mark saved where search started")))))
301 ;;; swiper.el ends here