1 ;;; el-search.el --- Expression based incremental search for emacs-lisp-mode -*- lexical-binding: t -*-
3 ;; Copyright (C) 2015 Free Software Foundation, Inc
5 ;; Author: Michael Heerdegen <michael_heerdegen@web.de>
6 ;; Maintainer: Michael Heerdegen <michael_heerdegen@web.de>
7 ;; Created: 29 Jul 2015
9 ;; Compatibility: GNU Emacs 25
11 ;; Package-Requires: ((emacs "25"))
14 ;; This file is not part of GNU Emacs.
16 ;; GNU Emacs is free software: you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation, either version 3 of the License, or
19 ;; (at your option) any later version.
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
36 ;; The main user entry point is `el-search-pattern'. This command
37 ;; prompts for a `pcase' pattern and searches the current buffer for
38 ;; matching expressions by iteratively `read'ing buffer contents. For
39 ;; any match, point is put at the beginning of the expression found
40 ;; (unlike isearch which puts point at the end of matches).
42 ;; Why is it based on `pcase'? Because pattern matching (and the
43 ;; ability to combine destructuring and condition testing) is well
44 ;; suited for this task. In addition, pcase allows to add specialized
45 ;; pattern types and to combine them with other patterns in a natural
46 ;; and transparent way out of the box.
48 ;; It doesn't matter how the code is actually formatted. Comments are
49 ;; ignored, and strings are treated as atomic objects, their contents
50 ;; are not being searched.
53 ;; Example 1: if you enter
57 ;; at the prompt, this will find any occurrence of the number 97 in
58 ;; the code, but not 977 or (+ 90 7) or "My string containing 97".
59 ;; But it will find anything `eq' to 97 after reading, e.g. #x61 or
63 ;; Example 2: If you enter the pattern
67 ;; you search for all defvar forms that don't specify an init value.
69 ;; The following will search for defvar forms with a docstring whose
70 ;; first line is longer than 70 characters:
73 ;; ,(and s (guard (< 70 (length (car (split-string s "\n")))))))
76 ;; When a search pattern is processed, the searched buffer is current
77 ;; with point at the beginning of the currently tested expression.
83 ;; For pattern input, the minibuffer is put into `emacs-lisp-mode'.
85 ;; Any input PATTERN is silently transformed into (and exp PATTERN)
86 ;; so that you can always refer to the whole currently tested
87 ;; expression via the variable `exp'.
92 ;; If you want to search a buffer for symbols that are defined in
93 ;; "cl-lib", you can use this pattern
95 ;; (guard (and (symbolp exp)
96 ;; (when-let ((file (symbol-file exp)))
97 ;; (string-match-p "cl-lib\\.elc?$" file))))
100 ;; ,----------------------------------------------------------------------
101 ;; | Q: "But I hate `pcase'! Can't we just do without?" |
103 ;; | A: Respect that you kept up until here! Just use (guard CODE), where|
104 ;; | CODE is any normal Elisp expression that returns non-nil when and |
105 ;; | only when you have a match. Use the variable `exp' to refer to |
106 ;; | the currently tested expression. Just like in the last example! |
107 ;; `----------------------------------------------------------------------
110 ;; It's cumbersome to write out the same complicated pattern
111 ;; constructs in the minibuffer again and again. You can define your
112 ;; own pcase pattern types for the purpose of el-search with
113 ;; `el-search-defpattern'. It is just like `pcase-defmacro', but the
114 ;; effect is limited to this package. See C-h f `el-search-pattern'
115 ;; for a list of predefined additional pattern forms.
121 ;; You can replace expressions with command `el-search-query-replace'.
122 ;; You are queried for a (pcase) pattern and a replacement expression.
123 ;; For each match of the pattern, the replacement expression is
124 ;; evaluated with the bindings created by the pcase matching in
125 ;; effect, and printed to produce the replacement string.
127 ;; Example: In some buffer you want to swap the two expressions at the
128 ;; places of the first two arguments in all calls of function `foo',
131 ;; (foo 'a (* 2 (+ 3 4)) t)
135 ;; (foo (* 2 (+ 3 4)) 'a t).
139 ;; M-x el-search-query-replace RET
140 ;; `(foo ,a ,b . ,rest) RET
141 ;; `(foo ,b ,a . ,rest) RET
143 ;; Type y to replace a match and go to the next one, r to replace
144 ;; without moving, SPC to go to the next match and ! to replace all
145 ;; remaining matches automatically. q quits. n is like SPC, so that
146 ;; y and n work like in isearch (meaning "yes" and "no") if you are
149 ;; It is possible to replace a match with multiple expressions using
150 ;; "splicing mode". When it is active, the replacement expression
151 ;; must evaluate to a list, and is spliced instead of inserted into
152 ;; the buffer for any replaced match. Use s to toggle splicing mode
153 ;; in a `el-search-query-replace' session.
156 ;; Suggested key bindings
157 ;; ======================
159 ;; (define-key emacs-lisp-mode-map [(control ?S)] #'el-search-pattern)
160 ;; (define-key emacs-lisp-mode-map [(control ?%)] #'el-search-query-replace)
162 ;; (define-key isearch-mode-map [(control ?S)] #'el-search-search-from-isearch)
163 ;; (define-key isearch-mode-map [(control ?%)] #'el-search-replace-from-isearch)
165 ;; The bindings in `isearch-mode-map' let you conveniently switch to
166 ;; elisp searching from isearch.
169 ;; Bugs, Known Limitations
170 ;; =======================
172 ;; - Replacing: in some cases the reader syntax of forms
173 ;; is changing due to reading+printing. "Some" because we can treat
174 ;; that problem in most cases.
176 ;; - Similarly: Comments are normally preserved (where it makes
177 ;; sense). But when replacing like `(foo ,a ,b) -> `(foo ,b ,a)
186 ;; the comment will be lost.
192 ;; Thanks to Stefan Monnier for corrections and advice.
197 ;; - When replacing like (progn A B C) -> A B C, the layout of the
198 ;; whole "group" A B C as a unit is lost. Instead of restoring layout
199 ;; as we do now (via "read mappings"), we could just make a backup of
200 ;; the original expression as a string, and use our search machinery
201 ;; to find occurrences in the replacement recursively.
203 ;; - detect infloops when replacing automatically (e.g. for 1 -> '(1))
205 ;; - implement backward searching
207 ;; - improve docstrings
209 ;; - handle more reader syntaxes, e.g. #n, #n#
211 ;; - Implement sessions; add multi-file support based on iterators. A
212 ;; file list is read in (or the user can specify an iterator as a
213 ;; variable). The state in the current buffer is just (buffer
214 ;; . marker). Or should this be abstracted into an own lib? Could
215 ;; be named "files-session" or so.
227 (require 'elisp-mode)
229 (require 'help-fns) ;el-search--make-docstring
232 ;;;; Configuration stuff
234 (defgroup el-search nil
235 "Expression based search and replace for `emacs-lisp-mode'."
238 (defcustom el-search-this-expression-identifier 'exp
239 "Identifier referring to the current expression in pattern input.
240 When entering a PATTERN in an interactive \"el-search\" command,
241 the pattern actually used will be
243 `(and ,el-search-this-expression-identifier ,pattern)
245 The default value is `exp'."
248 (defface el-search-match '((((background dark)) (:background "#0000A0"))
249 (t (:background "DarkSlateGray3")))
250 "Face for highlighting the current match.")
252 (defface el-search-other-match '((((background dark)) (:background "#202060"))
253 (t (:background "DarkSlateGray1")))
254 "Face for highlighting the other matches.")
256 (defcustom el-search-smart-case-fold-search t
257 "Whether to use smart case folding in pattern matching.
258 When an \"el-search\" pattern involves regexp matching (like for
259 \"string\" or \"source\") and this option is non-nil,
260 case-fold-search will be temporarily bound to t if the according
261 regexp contains any upper case letter, and nil else. This is
262 done independently for every single matching operation.
264 If nil, the value of `case-fold-search' is decisive."
270 (defun el-search--smart-string-match-p (regexp string)
271 "`string-match-p' taking `el-search-smart-case-fold-search' into account."
272 (let ((case-fold-search (if el-search-smart-case-fold-search
273 (not (let ((case-fold-search nil))
274 (string-match-p "[[:upper:]]" regexp)))
276 (string-match-p regexp string)))
278 (defun el-search--print (expr)
279 (let ((print-quoted t)
282 (prin1-to-string expr)))
284 (defvar el-search-read-expression-map
285 (let ((map (make-sparse-keymap)))
286 (set-keymap-parent map read-expression-map)
287 (define-key map [(control ?g)] #'abort-recursive-edit)
288 (define-key map [up] nil)
289 (define-key map [down] nil)
290 (define-key map [(control meta backspace)] #'backward-kill-sexp)
291 (define-key map [(control ?S)] #'exit-minibuffer)
293 "Map for reading input with `el-search-read-expression'.")
295 (defun el-search--setup-minibuffer ()
297 (use-local-map el-search-read-expression-map)
298 (setq font-lock-mode t)
299 (funcall font-lock-function 1)
302 (goto-char (point-max))
303 (when-let ((this-sexp (with-current-buffer (window-buffer (minibuffer-selected-window))
304 (thing-at-point 'sexp))))
305 (let ((more-defaults (list (concat "'" this-sexp))))
306 (setq-local minibuffer-default-add-function
307 (lambda () (if (listp minibuffer-default)
308 (append minibuffer-default more-defaults)
309 (cons minibuffer-default more-defaults)))))))
311 ;; $$$$$FIXME: this should be in Emacs! There is only a helper `read--expression'.
312 (defun el-search-read-expression (prompt &optional initial-contents hist default read)
313 "Read expression for `my-eval-expression'."
314 (minibuffer-with-setup-hook #'el-search--setup-minibuffer
315 (read-from-minibuffer prompt initial-contents el-search-read-expression-map read
316 (or hist 'read-expression-history) default)))
318 (defvar el-search--initial-mb-contents nil)
320 (defun el-search--read-pattern (prompt &optional default read)
321 (let ((input (el-search-read-expression
322 prompt el-search--initial-mb-contents 'el-search-history default read)))
323 (if (or read (not (string= input ""))) input (car el-search-history))))
325 (defun el-search--end-of-sexp ()
326 ;;Point must be at sexp beginning
327 (or (scan-sexps (point) 1) (point-max)))
329 (defun el-search--ensure-sexp-start ()
330 "Move point to the next sexp beginning position.
331 Don't move if already at beginning of a sexp. Point must not be
332 inside a string or comment. `read' the expression at that point
334 (let ((not-done t) res)
336 (let ((stop-here nil)
337 (looking-at-from-back (lambda (regexp n)
340 (looking-at regexp)))))
341 (while (not stop-here)
343 ((eobp) (signal 'end-of-buffer nil))
344 ((looking-at (rx (and (* space) ";"))) (forward-line))
345 ((looking-at (rx (+ (or space "\n")))) (goto-char (match-end 0)))
347 ;; FIXME: can the rest be done more generically?
348 ((and (looking-at (rx (or (syntax symbol) (syntax word))))
349 (not (looking-at "\\_<"))
350 (not (funcall looking-at-from-back ",@" 2)))
352 ((or (and (looking-at "'") (funcall looking-at-from-back "#" 1))
353 (and (looking-at "@") (funcall looking-at-from-back "," 1)))
355 (t (setq stop-here t)))))
358 (setq res (save-excursion (read (current-buffer))))
360 (error (forward-char))))
363 (defvar el-search--pcase-macros '()
364 "List of additional \"el-search\" pcase macros.")
366 (defun el-search--make-docstring ()
367 ;; code mainly from `pcase--make-docstring'
368 (let* ((main (documentation (symbol-function 'el-search-pattern) 'raw))
369 (ud (help-split-fundoc main 'pcase)))
371 (insert (or (cdr ud) main))
373 (pcase-lambda (`(,symbol . ,fun))
374 (when-let ((doc (documentation fun)))
376 (setq doc (help-fns--signature symbol doc fun fun nil))
377 (insert "\n" (or doc "Not documented."))))
378 (reverse el-search--pcase-macros))
379 (let ((combined-doc (buffer-string)))
380 (if ud (help-add-fundoc-usage combined-doc (car ud)) combined-doc)))))
382 (put 'el-search-pattern 'function-documentation '(el-search--make-docstring))
384 (defmacro el-search-defpattern (name args &rest body)
385 "Like `pcase-defmacro', but limited to el-search patterns.
386 The semantics is exactly that of `pcase-defmacro', but the scope
387 of the definitions is limited to \"el-search\"."
388 (declare (indent 2) (debug defun))
389 `(setf (alist-get ',name el-search--pcase-macros)
390 (lambda ,args ,@body)))
392 (defun el-search--macroexpand-1 (pattern)
393 "Expand \"el-search\" PATTERN.
394 This is like `pcase--macroexpand', but expands only patterns
395 defined with `el-search-defpattern' and performs only one
398 Return PATTERN if this pattern type was not defined with
399 `el-search-defpattern'."
400 (if-let ((expander (alist-get (car-safe pattern) el-search--pcase-macros)))
401 (apply expander (cdr pattern))
404 (defmacro el-search--with-additional-pcase-macros (&rest body)
405 `(cl-letf ,(mapcar (pcase-lambda (`(,symbol . ,fun))
406 `((get ',symbol 'pcase-macroexpander) #',fun))
407 el-search--pcase-macros)
410 (defun el-search--matcher (pattern &rest body)
411 (eval ;use `eval' to allow for user defined pattern types at run time
412 (let ((expression (make-symbol "expression")))
413 `(el-search--with-additional-pcase-macros
414 (let ((byte-compile-debug t) ;make undefined pattern types raise an error
415 (warning-suppress-log-types '((bytecomp)))
416 (pcase--dontwarn-upats (cons '_ pcase--dontwarn-upats)))
417 (byte-compile (lambda (,expression)
419 (,pattern ,@(or body (list t)))
422 (defun el-search--match-p (matcher expression)
423 (funcall matcher expression))
425 (defun el-search--wrap-pattern (pattern)
426 `(and ,el-search-this-expression-identifier ,pattern))
428 (defun el-search--skip-expression (expression &optional read)
429 ;; Move forward at least one character. Don't move into a string or
430 ;; comment. Don't move further than the beginning of the next sexp.
431 ;; Try to move as far as possible. Point must be at the beginning
433 ;; If there are positions where `read' would succeed, but that do
434 ;; not represent a valid sexp start, move past them (e.g. when
435 ;; before "#'" move past both characters).
437 ;; EXPRESSION must be the (read) expression at point, but when READ
438 ;; is non-nil, ignore the first argument and read the expression at
440 (when read (setq expression (save-excursion (read (current-buffer)))))
442 ((or (null expression)
443 (equal [] expression)
444 (not (or (listp expression) (vectorp expression))))
445 (goto-char (el-search--end-of-sexp)))
446 ((looking-at (rx (or ",@" "," "#'" "'")))
447 (goto-char (match-end 0)))
450 (defun el-search--search-pattern-1 (matcher &optional noerror)
451 (let ((match-beg nil) (opoint (point)) current-expr)
453 ;; when inside a string or comment, move past it
454 (let ((syntax-here (syntax-ppss)))
455 (when (nth 3 syntax-here) ;inside a string
456 (goto-char (nth 8 syntax-here))
458 (when (nth 4 syntax-here) ;inside a comment
460 (while (and (not (eobp)) (looking-at (rx (and (* space) ";"))))
464 (while (not match-beg)
466 (setq current-expr (el-search--ensure-sexp-start))
469 (throw 'no-match t)))
470 (if (el-search--match-p matcher current-expr)
471 (setq match-beg (point)
473 (el-search--skip-expression current-expr))))
474 (if noerror nil (signal 'end-of-buffer nil)))
477 (defun el-search--search-pattern (pattern &optional noerror)
478 "Search elisp buffer with `pcase' PATTERN.
479 Set point to the beginning of the occurrence found and return
480 point. Optional second argument, if non-nil, means if fail just
481 return nil (no error)."
482 (el-search--search-pattern-1 (el-search--matcher pattern) noerror))
484 (defun el-search--do-subsexps (pos do-fun &optional ret-fun bound)
485 ;; In current buffer, for any expression start between POS and BOUND
486 ;; or (point-max), in order, call two argument function DO-FUN with
487 ;; the current sexp string and the ending position of the current
488 ;; sexp. When done, with RET-FUN given, call it with no args and
489 ;; return the result; else, return nil.
493 (while (< (point) (or bound (point-max)))
494 (let* ((this-sexp-end (save-excursion (thing-at-point--end-of-sexp) (point)))
495 (this-sexp-string (buffer-substring-no-properties (point) this-sexp-end)))
496 (funcall do-fun this-sexp-string this-sexp-end)
497 (el-search--skip-expression (read this-sexp-string))
498 (el-search--ensure-sexp-start)))
500 (when ret-fun (funcall ret-fun))))
502 (defun el-search--create-read-map (&optional pos)
504 (el-search--do-subsexps
506 (lambda (sexp _) (push (cons (read sexp) sexp) mapping))
507 (lambda () (nreverse mapping))
508 (save-excursion (thing-at-point--end-of-sexp) (point)))))
510 (defun el-search--repair-replacement-layout (printed mapping)
513 (el-search--do-subsexps
515 (lambda (sexp sexp-end)
516 (when-let ((old (cdr (assoc (read sexp) mapping))))
517 (delete-region (point) sexp-end)
518 (when (string-match-p "\n" old)
519 (unless (looking-back "^[[:space:]]*" (line-beginning-position))
521 (unless (looking-at "[[:space:]\)]*$")
524 (save-excursion (insert old))))
525 (lambda () (buffer-substring (point-min) (point-max))))))
527 (defun el-search--check-pattern-args (type args predicate &optional message)
528 "Check whether all ARGS fulfill PREDICATE.
529 Raise an error if not. TYPE and optional argument MESSAGE are
530 used to construct the error message."
532 (unless (funcall predicate arg)
533 (error (concat "Pattern `%S': "
534 (or message (format "argument doesn't fulfill %S" predicate))
540 ;;;; Additional pattern type definitions
542 (defun el-search--split (matcher1 matcher2 list)
543 "Helper for the append pattern type.
545 When a splitting of LIST into two lists L1, L2 exist so that Li
546 is matched by MATCHERi, return (L1 L2) for such Li, else return
548 (let ((try-match (lambda (list1 list2)
549 (when (and (el-search--match-p matcher1 list1)
550 (el-search--match-p matcher2 list2))
551 (list list1 list2))))
552 (list1 list) (list2 '()) (match nil))
553 ;; don't use recursion, this could hit `max-lisp-eval-depth'
554 (while (and (not (setq match (funcall try-match list1 list2)))
556 (let ((last-list1 (last list1)))
557 (if-let ((cdr-last-list1 (cdr last-list1)))
558 ;; list1 is a dotted list. Then list2 must be empty.
559 (progn (setcdr last-list1 nil)
560 (setq list2 cdr-last-list1))
561 (setq list1 (butlast list1 1)
562 list2 (cons (car last-list1) list2)))))
565 (el-search-defpattern append (&rest patterns)
566 "Matches any list factorable into lists matched by PATTERNS in order.
568 PATTERNS is a list of patterns P1..Pn. Match any list L for that
569 lists L1..Ln exist that are matched by P1..Pn in order and L is
570 equal to the concatenation of L1..Ln. Ln is allowed to be no
573 When different ways of matching are possible, it is unspecified
578 (append '(1 2 3) x (app car-safe 7))
580 matches the list (1 2 3 4 5 6 7 8 9) and binds `x' to (4 5 6)."
583 (pcase-let ((`(,pattern . ,more-patterns) patterns))
585 ((null more-patterns) pattern)
586 ((null (cdr more-patterns))
588 (app ,(apply-partially #'el-search--split
589 (el-search--matcher pattern)
590 (el-search--matcher (car more-patterns)))
591 (,'\` ((,'\, ,pattern)
592 (,'\, ,(car more-patterns)))))))
593 (t `(append ,pattern (append ,@more-patterns)))))))
595 (el-search-defpattern string (&rest regexps)
596 "Matches any string that is matched by all REGEXPS."
597 (el-search--check-pattern-args 'string regexps #'stringp)
598 (let ((string (make-symbol "string"))
599 (regexp (make-symbol "regexp")))
601 (pred (lambda (,string)
603 (lambda (,regexp) (el-search--smart-string-match-p ,regexp ,string))
606 (el-search-defpattern symbol (&rest regexps)
607 "Matches any symbol whose name is matched by all REGEXPS."
608 (el-search--check-pattern-args 'symbol regexps #'stringp)
610 (app symbol-name (string ,@regexps))))
612 (defun el-search--contains-p (matcher exp)
613 "Return non-nil when tree EXP contains a match for MATCHER.
614 Recurse on all types of sequences. In the positive case the
615 return value is (t elt), where ELT is a matching element found in
617 (if (el-search--match-p matcher exp)
620 (let ((try-match (apply-partially #'el-search--contains-p matcher)))
622 (or (funcall try-match (car exp))
623 (funcall try-match (cdr exp)))
624 (cl-some try-match exp))))))
626 (el-search-defpattern contains (&rest patterns)
627 "Matches trees that contain a match for all PATTERNs.
628 Searches any tree of sequences recursively for matches. Objects
629 of any kind matched by all PATTERNs are also matched.
631 Example: (contains (string \"H\") 17) matches ((\"Hallo\") x (5 [1 17]))"
634 ((null (cdr patterns))
635 (let ((pattern (car patterns)))
636 `(app ,(apply-partially #'el-search--contains-p (el-search--matcher pattern))
637 (,'\` (t (,'\, ,pattern))))))
638 (t `(and ,@(mapcar (lambda (pattern) `(contains ,pattern)) patterns)))))
640 (el-search-defpattern not (pattern)
641 "Matches any object that is not matched by PATTERN."
642 `(app ,(apply-partially #'el-search--match-p (el-search--matcher pattern))
645 (defun el-search--match-symbol-file (regexp symbol)
646 (when-let ((symbol-file (and (symbolp symbol)
647 (symbol-file symbol))))
648 (el-search--smart-string-match-p
649 (if (symbolp regexp) (concat "\\`" (symbol-name regexp) "\\'") regexp)
650 (file-name-sans-extension (file-name-nondirectory symbol-file)))))
652 (el-search-defpattern source (regexp)
653 "Matches any symbol whose `symbol-file' is matched by REGEXP.
655 This pattern matches when the object is a symbol for that
656 `symbol-file' returns a (non-nil) FILE-NAME that fulfills
657 (string-match-p REGEXP (file-name-sans-extension
658 (file-name-nondirectory FILENAME)))
660 REGEXP can also be a symbol, in which case
662 (concat \"^\" (symbol-name regexp) \"$\")
664 is used as regular expression."
665 (el-search--check-pattern-args 'source (list regexp) #'stringp)
666 `(pred (el-search--match-symbol-file ,regexp)))
668 (defun el-search--match-key-sequence (keys expr)
669 (when-let ((expr-keys (pcase expr
670 ((or (pred stringp) (pred vectorp)) expr)
671 (`(kbd ,(and (pred stringp) string)) (ignore-errors (kbd string))))))
673 (mapcar (lambda (keys) (ignore-errors (key-description keys)))
674 (list keys expr-keys)))))
676 (el-search-defpattern keys (key-sequence)
677 "Matches descriptions of the KEY-SEQUENCE.
678 KEY-SEQUENCE is a string or vector representing a key sequence,
679 or an expression of the form (kbd STRING).
681 Match any description of the same key sequence in any of these
688 matches any of these expressions:
694 (when (eq (car-safe key-sequence) 'kbd)
695 (setq key-sequence (kbd (cadr key-sequence))))
696 (el-search--check-pattern-args 'keys (list key-sequence) (lambda (x) (or (stringp x) (vectorp x)))
697 "argument not a string or vector")
698 `(pred (el-search--match-key-sequence ,key-sequence)))
700 (defun el-search--s (expr)
702 ((symbolp expr) `(or (symbol ,(symbol-name expr))
703 (,'\` (,'quote (,'\, (symbol ,(symbol-name expr)))))
704 (,'\` (,'function (,'\, (symbol ,(symbol-name expr)))))))
705 ((stringp expr) `(string ,expr))
708 (el-search-defpattern l (&rest lpats)
709 "Alternative pattern type for matching lists.
710 Match any list with subsequent elements matched by all LPATS in
713 The idea is to be able to search for pieces of code (i.e. lists)
714 with very brief input by using a specialized syntax.
716 An LPAT can take the following forms:
718 SYMBOL Matches any symbol S matched by SYMBOL's name interpreted
719 as a regexp. Matches also 'S and #'S for any such S.
720 STRING Matches any string matched by STRING interpreted as a
722 _ Matches any list element
723 __ Matches any number of list elements (including zero)
724 ^ Matches zero elements, but only at the beginning of a list
725 $ Matches zero elements, but only at the end of a list
726 PAT Anything else is interpreted as a normal pcase pattern, and
727 matches one list element matched by it
729 ^ is only valid as the first, $ as the last of the LPATS.
731 Example: To match defuns that contain \"hl\" in their name and
732 have at least one mandatory, but also optional arguments, you
733 could use this pattern:
735 (l ^ 'defun hl (l _ &optional))"
736 (let ((match-start nil) (match-end nil))
737 (when (eq (car-safe lpats) '^)
739 (cl-callf cdr lpats))
740 (when (eq (car-safe (last lpats)) '$)
742 (cl-callf butlast lpats 1))
743 `(append ,@(if match-start '() '(_))
749 ('_? '(or '() `(,_))) ;FIXME: useful - document? or should we provide a (? PAT)
751 (_ `(,'\` ((,'\, ,(el-search--s elt)))))))
753 ,@(if match-end '() '(_)))))
758 (defvar-local el-search-hl-overlay nil)
760 (defvar-local el-search-hl-other-overlays '())
762 (defvar el-search-keep-hl nil)
764 (defun el-search-hl-sexp (&optional bounds)
765 (let ((bounds (or bounds
766 (list (point) (el-search--end-of-sexp)))))
767 (if (overlayp el-search-hl-overlay)
768 (apply #'move-overlay el-search-hl-overlay bounds)
769 (overlay-put (setq el-search-hl-overlay (apply #'make-overlay bounds))
770 'face 'el-search-match))
771 (overlay-put el-search-hl-overlay 'priority 1002))
772 (add-hook 'post-command-hook #'el-search-hl-post-command-fun t t))
774 (defun el-search--hl-other-matches-1 (pattern from to)
775 (mapc #'delete-overlay el-search-hl-other-overlays)
776 (setq el-search-hl-other-overlays '())
777 (let ((matcher (el-search--matcher pattern))
778 this-match-beg this-match-end
783 (setq this-match-beg (el-search--search-pattern-1 matcher t))
784 (if (not this-match-beg)
786 (goto-char this-match-beg)
787 (setq this-match-end (el-search--end-of-sexp))
788 (let ((ov (make-overlay this-match-beg this-match-end)))
789 (overlay-put ov 'face 'el-search-other-match)
790 (overlay-put ov 'priority 1001)
791 (push ov el-search-hl-other-overlays)
792 (goto-char this-match-end)
793 (when (>= (point) to) (setq done t))))))))
795 (defun el-search-hl-other-matches (pattern)
796 "Highlight all matches visible in the selected window."
797 (el-search--hl-other-matches-1 pattern
799 (goto-char (window-start))
800 (beginning-of-defun-raw)
803 (add-hook 'window-scroll-functions #'el-search--after-scroll t t))
805 (defun el-search--after-scroll (_win start)
806 (el-search--hl-other-matches-1 el-search-current-pattern
809 (beginning-of-defun-raw)
813 (defun el-search-hl-remove ()
814 (when (overlayp el-search-hl-overlay)
815 (delete-overlay el-search-hl-overlay))
816 (remove-hook 'window-scroll-functions #'el-search--after-scroll t)
817 (mapc #'delete-overlay el-search-hl-other-overlays)
818 (setq el-search-hl-other-overlays '()))
820 (defun el-search-hl-post-command-fun ()
821 (unless (or el-search-keep-hl
822 (eq this-command 'el-search-query-replace)
823 (eq this-command 'el-search-pattern))
824 (el-search-hl-remove)
825 (remove-hook 'post-command-hook 'el-search-hl-post-command-fun t)))
830 (defvar el-search-history '()
831 "List of input strings.")
833 (defvar el-search-success nil)
834 (defvar el-search-current-pattern nil)
837 (defun el-search-pattern (pattern)
838 "Start new or resume last elisp search.
840 Search current buffer for expressions that are matched by `pcase'
841 PATTERN. Use `read' to transform buffer contents into
845 Additional `pcase' pattern types to be used with this command can
846 be defined with `el-search-defpattern'.
848 The following additional pattern types are currently defined:"
849 (interactive (list (if (and (eq this-command last-command)
851 el-search-current-pattern
853 (el-search--read-pattern "Find pcase pattern: "
854 (car el-search-history)
856 ;; A very common mistake: input "foo" instead of "'foo"
857 (when (and (symbolp pattern)
858 (not (eq pattern '_))
859 (or (not (boundp pattern))
860 (not (eq (symbol-value pattern) pattern))))
861 (error "Please don't forget the quote when searching for a symbol"))
862 (el-search--wrap-pattern pattern)))))
863 (if (not (called-interactively-p 'any))
864 (el-search--search-pattern pattern)
865 (setq this-command 'el-search-pattern) ;in case we come from isearch
866 (setq el-search-current-pattern pattern)
867 (let ((opoint (point)))
868 (when (and (eq this-command last-command) el-search-success)
869 (el-search--skip-expression nil t))
870 (setq el-search-success nil)
871 (when (condition-case nil
872 (el-search--search-pattern pattern)
873 (end-of-buffer (message "No match")
875 (el-search-hl-remove)
878 (setq el-search-success t)
880 (unless (eq this-command last-command)
881 (el-search-hl-other-matches pattern))))))
883 (defvar el-search-search-and-replace-help-string
885 y Replace this match and move to the next.
886 SPC or n Skip this match and move to the next.
887 r Replace this match but don't move.
888 ! Replace all remaining matches automatically.
889 q Quit. To resume, use e.g. `repeat-complex-command'.
891 s Toggle splicing mode. When splicing mode is
892 on (default off), the replacement expression must
893 evaluate to a list, and the result is spliced into the
894 buffer, instead of just inserted.
896 Hit any key to proceed."
897 "Help string for ? in `el-search-query-replace'.")
899 (defun el-search-search-and-replace-pattern (pattern replacement &optional mapping splice)
900 (let ((replace-all nil) (nbr-replaced 0) (nbr-skipped 0) (done nil)
901 (el-search-keep-hl t) (opoint (point))
902 (get-replacement (el-search--matcher pattern replacement)))
904 (while (and (not done) (el-search--search-pattern pattern t))
905 (setq opoint (point))
908 (unless (eq this-command last-command)
909 (el-search-hl-other-matches pattern)))
910 (let* ((read-mapping (el-search--create-read-map))
911 (region (list (point) (el-search--end-of-sexp)))
912 (substring (apply #'buffer-substring-no-properties region))
913 (expr (read substring))
915 (new-expr (funcall get-replacement expr))
916 (get-replacement-string
917 (lambda () (if (and splice (not (listp new-expr)))
918 (error "Expression to splice in is an atom")
919 (el-search--repair-replacement-layout
921 (mapconcat #'el-search--print new-expr " ")
922 (el-search--print new-expr))
923 (append mapping read-mapping)))))
924 (to-insert (funcall get-replacement-string))
925 (do-replace (lambda ()
927 (apply #'delete-region region)
928 (let ((inhibit-message t)
931 (indent-region opoint (point))
932 (el-search-hl-sexp (list opoint (point)))
934 (cl-incf nbr-replaced)
935 (setq replaced-this t))))
938 (while (not (pcase (if replaced-this
939 (read-char-choice "[SPC ! q] (? for help)"
942 (concat "Replace this occurrence"
943 (if (or (string-match-p "\n" to-insert)
944 (< 40 (length to-insert)))
945 "" (format " with `%s'" to-insert))
947 (if splice "{splice} " "")
948 "[y SPC r ! s q] (? for help)" )
949 '(?y ?n ?r ?\ ?! ?q ?s ??)))
950 (?r (funcall do-replace)
952 (?y (funcall do-replace)
955 (unless replaced-this (cl-incf nbr-skipped))
957 (?! (unless replaced-this
958 (funcall do-replace))
961 (?s (cl-callf not splice)
962 (setq to-insert (funcall get-replacement-string))
966 (?? (ignore (read-char el-search-search-and-replace-help-string))
968 (unless (or done (eobp)) (el-search--skip-expression nil t)))))
969 (el-search-hl-remove)
971 (message "Replaced %d matches%s"
973 (if (zerop nbr-skipped) ""
974 (format " (%d skipped)" nbr-skipped)))))
976 (defun el-search-query-replace-read-args ()
977 (barf-if-buffer-read-only)
978 (let* ((from (el-search--read-pattern "Replace from: "))
979 (to (let ((el-search--initial-mb-contents nil))
980 (el-search--read-pattern "Replace with result of evaluation of: " from))))
981 (list (el-search--wrap-pattern (read from)) (read to)
984 (el-search--create-read-map 1)))))
987 (defun el-search-query-replace (from to &optional mapping)
988 "Replace some occurrences of FROM pattern with evaluated TO."
989 (interactive (el-search-query-replace-read-args))
990 (setq this-command 'el-search-query-replace) ;in case we come from isearch
991 (setq el-search-current-pattern from)
992 (barf-if-buffer-read-only)
993 (el-search-search-and-replace-pattern from to mapping))
995 (defun el-search--take-over-from-isearch (&optional goto-left-end)
996 (let ((other-end (and goto-left-end isearch-other-end))
997 (input isearch-string))
999 (when (and other-end (< other-end (point)))
1000 (goto-char other-end))
1004 (defun el-search-search-from-isearch ()
1005 ;; FIXME: an interesting alternative would be to really integrate it
1006 ;; with Isearch, using `isearch-search-fun-function'.
1007 ;; Alas, this is not trivial if we want to transfer our optimizations.
1009 (let ((el-search--initial-mb-contents (concat "'" (el-search--take-over-from-isearch))))
1010 ;; use `call-interactively' so we get recorded in `extended-command-history'
1011 (call-interactively #'el-search-pattern)))
1014 (defun el-search-replace-from-isearch ()
1016 (let ((el-search--initial-mb-contents (concat "'" (el-search--take-over-from-isearch t))))
1017 (call-interactively #'el-search-query-replace)))
1021 (provide 'el-search)
1022 ;;; el-search.el ends here