code.delx.au - gnu-emacs-elpa/blob - swiper.el

   1 ;;; swiper.el --- Isearch with an overview. Oh, man! -*- 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 ;; Version: 0.5.1
   8 ;; Package-Requires: ((emacs "24.1"))
   9 ;; Keywords: matching
  10
  11 ;; This file is part of GNU Emacs.
  12
  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)
  16 ;; any later version.
  17
  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.
  22
  23 ;; For a full copy of the GNU General Public License
  24 ;; see <http://www.gnu.org/licenses/>.
  25
  26 ;;; Commentary:
  27 ;;
  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.
  31 ;;
  32 ;; It can double as a quick `regex-builder', although only single
  33 ;; lines will be matched.
  34 ;;
  35 ;; It also provides `ivy-mode': a global minor mode that uses the
  36 ;; matching back end of `swiper' for all matching on your system,
  37 ;; including file matching. You can use it in place of `ido-mode'
  38 ;; (can't have both on at once).
  39
  40 ;;; Code:
  41 (require 'ivy)
  42
  43 (defgroup swiper nil
  44   "`isearch' with an overview."
  45   :group 'matching
  46   :prefix "swiper-")
  47
  48 (defface swiper-match-face-1
  49   '((t (:inherit isearch-lazy-highlight-face)))
  50   "The background face for `swiper' matches.")
  51
  52 (defface swiper-match-face-2
  53   '((t (:inherit isearch)))
  54   "Face for `swiper' matches modulo 1.")
  55
  56 (defface swiper-match-face-3
  57   '((t (:inherit match)))
  58   "Face for `swiper' matches modulo 2.")
  59
  60 (defface swiper-match-face-4
  61   '((t (:inherit isearch-fail)))
  62   "Face for `swiper' matches modulo 3.")
  63
  64 (defface swiper-minibuffer-match-face-1
  65   '((((class color) (background light))
  66      :background "#d3d3d3")
  67     (((class color) (background dark))
  68      :background "#555555"))
  69   "The background face for `swiper' minibuffer matches."
  70   :group 'function-args-faces)
  71
  72 (defface swiper-minibuffer-match-face-2
  73   '((((class color) (background light))
  74      :background "#e99ce8" :weight bold)
  75     (((class color) (background dark))
  76      :background "#777777" :weight bold))
  77   "Face for `swiper' minibuffer matches modulo 1.")
  78
  79 (defface swiper-minibuffer-match-face-3
  80   '((((class color) (background light))
  81      :background "#bbbbff" :weight bold)
  82     (((class color) (background dark))
  83      :background "#7777ff" :weight bold))
  84   "Face for `swiper' minibuffer matches modulo 2.")
  85
  86 (defface swiper-minibuffer-match-face-4
  87   '((((class color) (background light))
  88      :background "#ffbbff" :weight bold)
  89     (((class color) (background dark))
  90      :background "#8a498a" :weight bold))
  91   "Face for `swiper' minibuffer matches modulo 3.")
  92
  93 (defface swiper-line-face
  94   '((t (:inherit highlight)))
  95   "Face for current `swiper' line.")
  96
  97 (defcustom swiper-faces '(swiper-match-face-1
  98                           swiper-match-face-2
  99                           swiper-match-face-3
 100                           swiper-match-face-4)
 101   "List of `swiper' faces for group matches.")
 102
 103 (defcustom swiper-min-highlight 2
 104   "Only highlight matches for regexps at least this long."
 105   :type 'integer)
 106
 107 (defvar swiper-map
 108   (let ((map (make-sparse-keymap)))
 109     (define-key map (kbd "M-q") 'swiper-query-replace)
 110     (define-key map (kbd "C-l") 'swiper-recenter-top-bottom)
 111     (define-key map (kbd "C-'") 'swiper-avy)
 112     map)
 113   "Keymap for swiper.")
 114
 115 (defun swiper-query-replace ()
 116   "Start `query-replace' with string to replace from last search string."
 117   (interactive)
 118   (if (null (window-minibuffer-p))
 119       (user-error "Should only be called in the minibuffer through `swiper-map'")
 120     (let* ((enable-recursive-minibuffers t)
 121            (from (ivy--regex ivy-text))
 122            (to (query-replace-read-to from "Query replace" t)))
 123       (delete-minibuffer-contents)
 124       (ivy-set-action (lambda (_)
 125                         (with-ivy-window
 126                           (move-beginning-of-line 1)
 127                           (perform-replace from to
 128                                            t t nil))))
 129       (swiper--cleanup)
 130       (exit-minibuffer))))
 131
 132 (defvar avy-background)
 133 (defvar avy-all-windows)
 134 (declare-function avy--regex-candidates "ext:avy")
 135 (declare-function avy--process "ext:avy")
 136 (declare-function avy--overlay-post "ext:avy")
 137 (declare-function avy-action-goto "ext:avy")
 138
 139 ;;;###autoload
 140 (defun swiper-avy ()
 141   "Jump to one of the current swiper candidates."
 142   (interactive)
 143   (unless (string= ivy-text "")
 144     (with-ivy-window
 145       (let* ((avy-all-windows nil)
 146              (candidates
 147               (avy--regex-candidates
 148                (ivy--regex ivy-text)))
 149              (avy-background nil)
 150              (candidate
 151               (avy--process candidates #'avy--overlay-post)))
 152         (ivy-quit-and-run
 153          (avy-action-goto candidate))))))
 154
 155 (defun swiper-recenter-top-bottom (&optional arg)
 156   "Call (`recenter-top-bottom' ARG)."
 157   (interactive "P")
 158   (with-ivy-window
 159     (recenter-top-bottom arg)))
 160
 161 (defun swiper-font-lock-ensure ()
 162   "Ensure the entired buffer is highlighted."
 163   (unless (or (derived-mode-p 'magit-mode)
 164               (bound-and-true-p magit-blame-mode)
 165               (memq major-mode '(package-menu-mode
 166                                  gnus-summary-mode
 167                                  gnus-article-mode
 168                                  gnus-group-mode
 169                                  emms-playlist-mode erc-mode
 170                                  org-agenda-mode
 171                                  dired-mode
 172                                  jabber-chat-mode
 173                                  elfeed-search-mode
 174                                  fundamental-mode
 175                                  Man-mode
 176                                  woman-mode)))
 177     (unless (> (buffer-size) 100000)
 178       (if (fboundp 'font-lock-ensure)
 179           (font-lock-ensure)
 180         (with-no-warnings (font-lock-fontify-buffer))))))
 181
 182 (defvar swiper--format-spec ""
 183   "Store the current candidates format spec.")
 184
 185 (defvar swiper--width nil
 186   "Store the amount of digits needed for the longest line nubmer.")
 187
 188 (defun swiper--candidates ()
 189   "Return a list of this buffer lines."
 190   (let ((n-lines (count-lines (point-min) (point-max))))
 191     (unless (zerop n-lines)
 192       (setq swiper--width (1+ (floor (log n-lines 10))))
 193       (setq swiper--format-spec
 194             (format "%%-%dd " swiper--width))
 195       (let ((line-number 0)
 196             candidates)
 197         (save-excursion
 198           (goto-char (point-min))
 199           (swiper-font-lock-ensure)
 200           (while (< (point) (point-max))
 201             (let ((str (concat " " (buffer-substring
 202                                     (line-beginning-position)
 203                                     (line-end-position)))))
 204               (put-text-property 0 1 'display
 205                                  (format swiper--format-spec
 206                                          (cl-incf line-number))
 207                                  str)
 208               (push str candidates))
 209             (forward-line 1))
 210           (nreverse candidates))))))
 211
 212 (defvar swiper--opoint 1
 213   "The point when `swiper' starts.")
 214
 215 ;;;###autoload
 216 (defun swiper (&optional initial-input)
 217   "`isearch' with an overview.
 218 When non-nil, INITIAL-INPUT is the initial search pattern."
 219   (interactive)
 220   (swiper--ivy initial-input))
 221
 222 (defvar swiper--anchor nil
 223   "A line number to which the search should be anchored.")
 224
 225 (defvar swiper--len 0
 226   "The last length of input for which an anchoring was made.")
 227
 228 (defun swiper--init ()
 229   "Perform initialization common to both completion methods."
 230   (setq swiper--opoint (point))
 231   (setq swiper--len 0)
 232   (setq swiper--anchor (line-number-at-pos)))
 233
 234 (defun swiper--re-builder (str)
 235   "Transform STR into a swiper regex.
 236 This is the regex used in the minibuffer, since the candidates
 237 there have line numbers. In the buffer, `ivy--regex' should be used."
 238   (cond
 239     ((equal str "")
 240      "")
 241     ((equal str "^")
 242      ".")
 243     ((string-match "^\\^" str)
 244      (setq ivy--old-re "")
 245      (let ((re (ivy--regex-plus (substring str 1))))
 246        (format "^[0-9][0-9 ]\\{%d\\}%s"
 247                swiper--width
 248                (if (zerop ivy--subexps)
 249                    (prog1 (format "\\(%s\\)" re)
 250                      (setq ivy--subexps 1))
 251                  re))))
 252     (t
 253      (ivy--regex-plus str))))
 254
 255 (defvar swiper-history nil
 256   "History for `swiper'.")
 257
 258 (defun swiper--ivy (&optional initial-input)
 259   "`isearch' with an overview using `ivy'.
 260 When non-nil, INITIAL-INPUT is the initial search pattern."
 261   (interactive)
 262   (unless (eq (length (help-function-arglist 'ivy-read)) 4)
 263     (warn "You seem to be using the outdated stand-alone \"ivy\" package.
 264 Please remove it and update the \"swiper\" package."))
 265   (swiper--init)
 266   (let ((candidates (swiper--candidates))
 267         (preselect (buffer-substring-no-properties
 268                     (line-beginning-position)
 269                     (line-end-position))))
 270     (unwind-protect
 271          (ivy-read
 272           "Swiper: "
 273           candidates
 274           :initial-input initial-input
 275           :keymap swiper-map
 276           :preselect preselect
 277           :require-match t
 278           :update-fn #'swiper--update-input-ivy
 279           :unwind #'swiper--cleanup
 280           :re-builder #'swiper--re-builder
 281           :history 'swiper-history)
 282       (if (null ivy-exit)
 283           (goto-char swiper--opoint)
 284         (swiper--action ivy--current ivy-text)))))
 285
 286 (defun swiper--ensure-visible ()
 287   "Remove overlays hiding point."
 288   (let ((overlays (overlays-at (point)))
 289         ov expose)
 290     (while (setq ov (pop overlays))
 291       (if (and (invisible-p (overlay-get ov 'invisible))
 292                (setq expose (overlay-get ov 'isearch-open-invisible)))
 293           (funcall expose ov)))))
 294
 295 (defvar swiper--overlays nil
 296   "Store overlays.")
 297
 298 (defun swiper--cleanup ()
 299   "Clean up the overlays."
 300   (while swiper--overlays
 301     (delete-overlay (pop swiper--overlays)))
 302   (save-excursion
 303     (goto-char (point-min))
 304     (isearch-clean-overlays)))
 305
 306 (defun swiper--update-input-ivy ()
 307   "Called when `ivy' input is updated."
 308   (with-ivy-window
 309     (swiper--cleanup)
 310     (when (> (length ivy--current) 0)
 311       (let* ((re (funcall ivy--regex-function ivy-text))
 312              (re (if (stringp re) re (caar re)))
 313              (str (get-text-property 0 'display ivy--current))
 314              (num (if (string-match "^[0-9]+" str)
 315                       (string-to-number (match-string 0 str))
 316                     0)))
 317         (goto-char (point-min))
 318         (when (cl-plusp num)
 319           (goto-char (point-min))
 320           (forward-line (1- num))
 321           (if (and (equal ivy-text "")
 322                    (>= swiper--opoint (line-beginning-position))
 323                    (<= swiper--opoint (line-end-position)))
 324               (goto-char swiper--opoint)
 325             (re-search-forward re (line-end-position) t))
 326           (isearch-range-invisible (line-beginning-position)
 327                                    (line-end-position))
 328           (unless (and (>= (point) (window-start))
 329                        (<= (point) (window-end (ivy-state-window ivy-last) t)))
 330             (recenter)))
 331         (swiper--add-overlays re)))))
 332
 333 (defun swiper--add-overlays (re &optional beg end)
 334   "Add overlays for RE regexp in visible part of the current buffer.
 335 BEG and END, when specified, are the point bounds."
 336   (let ((ov (make-overlay
 337              (line-beginning-position)
 338              (1+ (line-end-position)))))
 339     (overlay-put ov 'face 'swiper-line-face)
 340     (overlay-put ov 'window (ivy-state-window ivy-last))
 341     (push ov swiper--overlays)
 342     (let* ((wh (window-height))
 343            (beg (or beg (save-excursion
 344                           (forward-line (- wh))
 345                           (point))))
 346            (end (or end (save-excursion
 347                           (forward-line wh)
 348                           (point)))))
 349       (when (>= (length re) swiper-min-highlight)
 350         (save-excursion
 351           (goto-char beg)
 352           ;; RE can become an invalid regexp
 353           (while (and (ignore-errors (re-search-forward re end t))
 354                       (> (- (match-end 0) (match-beginning 0)) 0))
 355             (let ((i 0))
 356               (while (<= i ivy--subexps)
 357                 (when (match-beginning i)
 358                   (let ((overlay (make-overlay (match-beginning i)
 359                                                (match-end i)))
 360                         (face
 361                          (cond ((zerop ivy--subexps)
 362                                 (cadr swiper-faces))
 363                                ((zerop i)
 364                                 (car swiper-faces))
 365                                (t
 366                                 (nth (1+ (mod (+ i 2) (1- (length swiper-faces))))
 367                                      swiper-faces)))))
 368                     (push overlay swiper--overlays)
 369                     (overlay-put overlay 'face face)
 370                     (overlay-put overlay 'window (ivy-state-window ivy-last))
 371                     (overlay-put overlay 'priority i)))
 372                 (cl-incf i)))))))))
 373
 374 (defun swiper--action (x input)
 375   "Goto line X and search for INPUT."
 376   (if (null x)
 377       (user-error "No candidates")
 378     (goto-char (point-min))
 379     (forward-line (1- (read (get-text-property 0 'display x))))
 380     (re-search-forward
 381      (ivy--regex input) (line-end-position) t)
 382     (swiper--ensure-visible)
 383     (when (/= (point) swiper--opoint)
 384       (unless (and transient-mark-mode mark-active)
 385         (push-mark swiper--opoint t)
 386         (message "Mark saved where search started")))))
 387
 388 ;; (define-key isearch-mode-map (kbd "C-o") 'swiper-from-isearch)
 389 (defun swiper-from-isearch ()
 390   "Invoke `swiper' from isearch."
 391   (interactive)
 392   (let ((query (if isearch-regexp
 393                    isearch-string
 394                  (regexp-quote isearch-string))))
 395     (isearch-exit)
 396     (swiper query)))
 397
 398 (defvar swiper-multi-buffers nil
 399   "Store the current list of buffers.")
 400
 401 (defvar swiper-multi-candidates nil
 402   "Store the list of candidates for `swiper-multi'.")
 403
 404 (defun swiper-multi-prompt ()
 405   (format "Buffers (%s): "
 406           (mapconcat #'identity swiper-multi-buffers ", ")))
 407
 408 (defun swiper-multi ()
 409   "Select one or more buffers.
 410 Run `swiper' for those buffers."
 411   (interactive)
 412   (setq swiper-multi-buffers nil)
 413   (setq swiper-multi-candidates nil)
 414   (ivy-read (swiper-multi-prompt)
 415             'internal-complete-buffer
 416             :action 'swiper-multi-action-1)
 417   (ivy-read "Swiper: " swiper-multi-candidates
 418             :action 'swiper-multi-action-2
 419             :unwind #'swiper--cleanup))
 420
 421 (defun swiper-multi-action-1 (x)
 422   (if (member x swiper-multi-buffers)
 423       (progn
 424         (setq swiper-multi-buffers (delete x swiper-multi-buffers)))
 425     (unless (equal x "")
 426       (setq swiper-multi-buffers (append swiper-multi-buffers (list x)))))
 427   (let ((prompt (swiper-multi-prompt)))
 428     (setf (ivy-state-prompt ivy-last) prompt)
 429     (setq ivy--prompt (concat "%-4d " prompt)))
 430   (cond ((memq this-command '(ivy-done
 431                               ivy-alt-done
 432                               ivy-immediate-done))
 433          (let ((ww (window-width)))
 434            (dolist (buf swiper-multi-buffers)
 435              (with-current-buffer buf
 436                (setq swiper-multi-candidates
 437                      (append
 438                       (mapcar
 439                        (lambda (s)
 440                          (setq s (concat s " "))
 441                          (let ((len (length s)))
 442                            (put-text-property
 443                             (1- len) len 'display
 444                             (concat
 445                              (make-string
 446                               (max
 447                                (- ww
 448                                   (string-width s)
 449                                   (length (buffer-name))
 450                                   1)
 451                                0)
 452                               ?\ )
 453                              (buffer-name))
 454                             s)
 455                            s))
 456                        (swiper--candidates))
 457                       swiper-multi-candidates))))))
 458         ((eq this-command 'ivy-call)
 459          (delete-minibuffer-contents))))
 460
 461 (defun swiper-multi-action-2 (x)
 462   (let ((buf-space (get-text-property (1- (length x)) 'display x)))
 463     (with-ivy-window
 464       (when (string-match "\\` *\\([^ ]+\\)\\'" buf-space)
 465         (switch-to-buffer (match-string 1 buf-space))
 466         (goto-char (point-min))
 467         (forward-line (1- (read x)))
 468         (re-search-forward
 469          (ivy--regex ivy-text)
 470          (line-end-position) t)
 471         (unless (eq ivy-exit 'done)
 472           (swiper--cleanup)
 473           (swiper--add-overlays (ivy--regex ivy-text)))))))
 474
 475 (provide 'swiper)
 476
 477 ;;; swiper.el ends here