lisp/replace.el

   1 ;;; replace.el --- replace commands for Emacs
   2
   3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1996, 1997, 2000, 2001, 2002,
   4 ;;   2003, 2004  Free Software Foundation, Inc.
   5
   6 ;; Maintainer: FSF
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;; This package supplies the string and regular-expression replace functions
  28 ;; documented in the Emacs user's manual.
  29
  30 ;;; Code:
  31
  32 (defcustom case-replace t
  33   "*Non-nil means `query-replace' should preserve case in replacements."
  34   :type 'boolean
  35   :group 'matching)
  36
  37 (defvar query-replace-history nil)
  38
  39 (defvar query-replace-interactive nil
  40   "Non-nil means `query-replace' uses the last search string.
  41 That becomes the \"string to replace\".")
  42
  43 (defcustom query-replace-from-history-variable 'query-replace-history
  44   "History list to use for the FROM argument of `query-replace' commands.
  45 The value of this variable should be a symbol; that symbol
  46 is used as a variable to hold a history list for the strings
  47 or patterns to be replaced."
  48   :group 'matching
  49   :type 'symbol
  50   :version "20.3")
  51
  52 (defcustom query-replace-to-history-variable 'query-replace-history
  53   "History list to use for the TO argument of `query-replace' commands.
  54 The value of this variable should be a symbol; that symbol
  55 is used as a variable to hold a history list for replacement
  56 strings or patterns."
  57   :group 'matching
  58   :type 'symbol
  59   :version "20.3")
  60
  61 (defcustom query-replace-skip-read-only nil
  62   "*Non-nil means `query-replace' and friends ignore read-only matches."
  63   :type 'boolean
  64   :group 'matching
  65   :version "21.4")
  66
  67 (defun query-replace-descr (string)
  68   (mapconcat 'isearch-text-char-description string ""))
  69
  70 (defun query-replace-read-from (string regexp-flag)
  71   "Query and return the `from' argument of a query-replace operation.
  72 The return value can also be a pair (FROM . TO) indicating that the user
  73 wants to replace FROM with TO."
  74   (if query-replace-interactive
  75       (car (if regexp-flag regexp-search-ring search-ring))
  76     (let* ((lastfrom (car (symbol-value query-replace-from-history-variable)))
  77            (lastto (car (symbol-value query-replace-to-history-variable)))
  78            (from
  79             ;; The save-excursion here is in case the user marks and copies
  80             ;; a region in order to specify the minibuffer input.
  81             ;; That should not clobber the region for the query-replace itself.
  82             (save-excursion
  83               (when (equal lastfrom lastto)
  84                 ;; Typically, this is because the two histlists are shared.
  85                 (setq lastfrom (cadr (symbol-value
  86                                       query-replace-from-history-variable))))
  87               (read-from-minibuffer
  88                (if (and lastto lastfrom)
  89                    (format "%s (default %s -> %s): " string
  90                            (query-replace-descr lastfrom)
  91                            (query-replace-descr lastto))
  92                  (format "%s: " string))
  93                nil nil nil
  94                query-replace-from-history-variable
  95                nil t t))))
  96       (if (and (zerop (length from)) lastto lastfrom)
  97           (cons lastfrom
  98                 (query-replace-compile-replacement lastto regexp-flag))
  99         ;; Warn if user types \n or \t, but don't reject the input.
 100         (and regexp-flag
 101              (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\[nt]\\)" from)
 102              (let ((match (match-string 3 from)))
 103                (cond
 104                 ((string= match "\\n")
 105                  (message "Note: `\\n' here doesn't match a newline; to do that, type C-q C-j instead"))
 106                 ((string= match "\\t")
 107                  (message "Note: `\\t' here doesn't match a tab; to do that, just type TAB")))
 108                (sit-for 2)))
 109         from))))
 110
 111 (defun query-replace-compile-replacement (to regexp-flag)
 112   "Maybe convert a regexp replacement TO to Lisp.
 113 Returns a list suitable for `perform-replace' if necessary,
 114 the original string if not."
 115   (if (and regexp-flag
 116            (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to))
 117       (let (pos list char)
 118         (while
 119             (progn
 120               (setq pos (match-end 0))
 121               (push (substring to 0 (- pos 2)) list)
 122               (setq char (aref to (1- pos))
 123                     to (substring to pos))
 124               (cond ((eq char ?\#)
 125                      (push '(number-to-string replace-count) list))
 126                     ((eq char ?\,)
 127                      (setq pos (read-from-string to))
 128                      (push `(replace-quote ,(car pos)) list)
 129                      (let ((end
 130                             ;; Swallow a space after a symbol
 131                             ;; if there is a space.
 132                             (if (and (or (symbolp (car pos))
 133                                          ;; Swallow a space after 'foo
 134                                          ;; but not after (quote foo).
 135                                          (and (eq (car-safe (car pos)) 'quote)
 136                                               (not (= ?\( (aref to 0)))))
 137                                      (eq (string-match " " to (cdr pos))
 138                                          (cdr pos)))
 139                                 (1+ (cdr pos))
 140                               (cdr pos))))
 141                        (setq to (substring to end)))))
 142               (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)))
 143         (setq to (nreverse (delete "" (cons to list))))
 144         (replace-match-string-symbols to)
 145         (cons 'replace-eval-replacement
 146               (if (cdr to)
 147                   (cons 'concat to)
 148                 (car to))))
 149     to))
 150
 151
 152 (defun query-replace-read-to (from string regexp-flag)
 153   "Query and return the `to' argument of a query-replace operation."
 154   (query-replace-compile-replacement
 155    (save-excursion
 156      (read-from-minibuffer
 157       (format "%s %s with: " string (query-replace-descr from))
 158       nil nil nil
 159       query-replace-to-history-variable from t t))
 160    regexp-flag))
 161
 162 (defun query-replace-read-args (string regexp-flag &optional noerror)
 163   (unless noerror
 164     (barf-if-buffer-read-only))
 165   (let* ((from (query-replace-read-from string regexp-flag))
 166          (to (if (consp from) (prog1 (cdr from) (setq from (car from)))
 167                (query-replace-read-to from string regexp-flag))))
 168     (list from to current-prefix-arg)))
 169
 170 (defun query-replace (from-string to-string &optional delimited start end)
 171   "Replace some occurrences of FROM-STRING with TO-STRING.
 172 As each match is found, the user must type a character saying
 173 what to do with it.  For directions, type \\[help-command] at that time.
 174
 175 In Transient Mark mode, if the mark is active, operate on the contents
 176 of the region.  Otherwise, operate from point to the end of the buffer.
 177
 178 If `query-replace-interactive' is non-nil, the last incremental search
 179 string is used as FROM-STRING--you don't have to specify it with the
 180 minibuffer.
 181
 182 Matching is independent of case if `case-fold-search' is non-nil and
 183 FROM-STRING has no uppercase letters.  Replacement transfers the case
 184 pattern of the old text to the new text, if `case-replace' and
 185 `case-fold-search' are non-nil and FROM-STRING has no uppercase
 186 letters.  \(Transferring the case pattern means that if the old text
 187 matched is all caps, or capitalized, then its replacement is upcased
 188 or capitalized.)
 189
 190 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
 191 only matches surrounded by word boundaries.
 192 Fourth and fifth arg START and END specify the region to operate on.
 193
 194 To customize possible responses, change the \"bindings\" in `query-replace-map'."
 195   (interactive (let ((common
 196                       (query-replace-read-args "Query replace" nil)))
 197                  (list (nth 0 common) (nth 1 common) (nth 2 common)
 198                        ;; These are done separately here
 199                        ;; so that command-history will record these expressions
 200                        ;; rather than the values they had this time.
 201                        (if (and transient-mark-mode mark-active)
 202                            (region-beginning))
 203                        (if (and transient-mark-mode mark-active)
 204                            (region-end)))))
 205   (perform-replace from-string to-string t nil delimited nil nil start end))
 206
 207 (define-key esc-map "%" 'query-replace)
 208
 209 (defun query-replace-regexp (regexp to-string &optional delimited start end)
 210   "Replace some things after point matching REGEXP with TO-STRING.
 211 As each match is found, the user must type a character saying
 212 what to do with it.  For directions, type \\[help-command] at that time.
 213
 214 In Transient Mark mode, if the mark is active, operate on the contents
 215 of the region.  Otherwise, operate from point to the end of the buffer.
 216
 217 If `query-replace-interactive' is non-nil, the last incremental search
 218 regexp is used as REGEXP--you don't have to specify it with the
 219 minibuffer.
 220
 221 Matching is independent of case if `case-fold-search' is non-nil and
 222 REGEXP has no uppercase letters.  Replacement transfers the case
 223 pattern of the old text to the new text, if `case-replace' and
 224 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
 225 \(Transferring the case pattern means that if the old text matched is
 226 all caps, or capitalized, then its replacement is upcased or
 227 capitalized.)
 228
 229 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
 230 only matches surrounded by word boundaries.
 231 Fourth and fifth arg START and END specify the region to operate on.
 232
 233 In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
 234 and `\\=\\N' (where N is a digit) stands for
 235 whatever what matched the Nth `\\(...\\)' in REGEXP.
 236 `\\?' lets you edit the replacement text in the minibuffer
 237 at the given position for each replacement.
 238
 239 In interactive calls, the replacement text can contain `\\,'
 240 followed by a Lisp expression.  Each
 241 replacement evaluates that expression to compute the replacement
 242 string.  Inside of that expression, `\\&' is a string denoting the
 243 whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
 244 for the whole or a partial match converted to a number with
 245 `string-to-number', and `\\#' itself for the number of replacements
 246 done so far (starting with zero).
 247
 248 If the replacement expression is a symbol, write a space after it
 249 to terminate it.  One space there, if any, will be discarded.
 250
 251 When using those Lisp features interactively in the replacement
 252 text, TO-STRING is actually made a list instead of a string.
 253 Use \\[repeat-complex-command] after this command for details."
 254   (interactive
 255    (let ((common
 256           (query-replace-read-args "Query replace regexp" t)))
 257      (list (nth 0 common) (nth 1 common) (nth 2 common)
 258            ;; These are done separately here
 259            ;; so that command-history will record these expressions
 260            ;; rather than the values they had this time.
 261            (if (and transient-mark-mode mark-active)
 262                (region-beginning))
 263            (if (and transient-mark-mode mark-active)
 264                (region-end)))))
 265   (perform-replace regexp to-string t t delimited nil nil start end))
 266
 267 (define-key esc-map [?\C-%] 'query-replace-regexp)
 268
 269 (defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
 270   "Replace some things after point matching REGEXP with the result of TO-EXPR.
 271 As each match is found, the user must type a character saying
 272 what to do with it.  For directions, type \\[help-command] at that time.
 273
 274 TO-EXPR is a Lisp expression evaluated to compute each replacement.  It may
 275 reference `replace-count' to get the number of replacements already made.
 276 If the result of TO-EXPR is not a string, it is converted to one using
 277 `prin1-to-string' with the NOESCAPE argument (which see).
 278
 279 For convenience, when entering TO-EXPR interactively, you can use `\\&' or
 280 `\\0' to stand for whatever matched the whole of REGEXP, and `\\N' (where
 281 N is a digit) to stand for whatever matched the Nth `\\(...\\)' in REGEXP.
 282 Use `\\#&' or `\\#N' if you want a number instead of a string.
 283 In interactive use, `\\#' in itself stands for `replace-count'.
 284
 285 In Transient Mark mode, if the mark is active, operate on the contents
 286 of the region.  Otherwise, operate from point to the end of the buffer.
 287
 288 If `query-replace-interactive' is non-nil, the last incremental search
 289 regexp is used as REGEXP--you don't have to specify it with the
 290 minibuffer.
 291
 292 Preserves case in each replacement if `case-replace' and `case-fold-search'
 293 are non-nil and REGEXP has no uppercase letters.
 294
 295 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
 296 only matches that are surrounded by word boundaries.
 297 Fourth and fifth arg START and END specify the region to operate on."
 298   (interactive
 299    (progn
 300    (barf-if-buffer-read-only)
 301    (let* ((from
 302            ;; Let-bind the history var to disable the "foo -> bar" default.
 303            ;; Maybe we shouldn't disable this default, but for now I'll
 304            ;; leave it off.  --Stef
 305            (let ((query-replace-to-history-variable nil))
 306              (query-replace-read-from "Query replace regexp" t)))
 307           (to (list (read-from-minibuffer
 308                      (format "Query replace regexp %s with eval: "
 309                              (query-replace-descr from))
 310                      nil nil t query-replace-to-history-variable from t))))
 311      ;; We make TO a list because replace-match-string-symbols requires one,
 312      ;; and the user might enter a single token.
 313      (replace-match-string-symbols to)
 314      (list from (car to) current-prefix-arg
 315            (if (and transient-mark-mode mark-active)
 316                (region-beginning))
 317            (if (and transient-mark-mode mark-active)
 318                (region-end))))))
 319   (perform-replace regexp (cons 'replace-eval-replacement to-expr)
 320                    t 'literal delimited nil nil start end))
 321
 322 (defun map-query-replace-regexp (regexp to-strings &optional n start end)
 323   "Replace some matches for REGEXP with various strings, in rotation.
 324 The second argument TO-STRINGS contains the replacement strings,
 325 separated by spaces.  Third arg DELIMITED (prefix arg if interactive),
 326 if non-nil, means replace only matches surrounded by word boundaries.
 327 This command works like `query-replace-regexp' except that each
 328 successive replacement uses the next successive replacement string,
 329 wrapping around from the last such string to the first.
 330
 331 In Transient Mark mode, if the mark is active, operate on the contents
 332 of the region.  Otherwise, operate from point to the end of the buffer.
 333
 334 Non-interactively, TO-STRINGS may be a list of replacement strings.
 335
 336 If `query-replace-interactive' is non-nil, the last incremental search
 337 regexp is used as REGEXP--you don't have to specify it with the minibuffer.
 338
 339 A prefix argument N says to use each replacement string N times
 340 before rotating to the next.
 341 Fourth and fifth arg START and END specify the region to operate on."
 342   (interactive
 343    (let* ((from (if query-replace-interactive
 344                     (car regexp-search-ring)
 345                   (read-from-minibuffer "Map query replace (regexp): "
 346                                         nil nil nil
 347                                         'query-replace-history nil t)))
 348           (to (read-from-minibuffer
 349                (format "Query replace %s with (space-separated strings): "
 350                        (query-replace-descr from))
 351                nil nil nil
 352                'query-replace-history from t)))
 353      (list from to
 354            (and current-prefix-arg
 355                 (prefix-numeric-value current-prefix-arg))
 356            (if (and transient-mark-mode mark-active)
 357                (region-beginning))
 358            (if (and transient-mark-mode mark-active)
 359                (region-end)))))
 360   (let (replacements)
 361     (if (listp to-strings)
 362         (setq replacements to-strings)
 363       (while (/= (length to-strings) 0)
 364         (if (string-match " " to-strings)
 365             (setq replacements
 366                   (append replacements
 367                           (list (substring to-strings 0
 368                                            (string-match " " to-strings))))
 369                   to-strings (substring to-strings
 370                                        (1+ (string-match " " to-strings))))
 371           (setq replacements (append replacements (list to-strings))
 372                 to-strings ""))))
 373     (perform-replace regexp replacements t t nil n nil start end)))
 374
 375 (defun replace-string (from-string to-string &optional delimited start end)
 376   "Replace occurrences of FROM-STRING with TO-STRING.
 377 Preserve case in each match if `case-replace' and `case-fold-search'
 378 are non-nil and FROM-STRING has no uppercase letters.
 379 \(Preserving case means that if the string matched is all caps, or capitalized,
 380 then its replacement is upcased or capitalized.)
 381
 382 In Transient Mark mode, if the mark is active, operate on the contents
 383 of the region.  Otherwise, operate from point to the end of the buffer.
 384
 385 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
 386 only matches surrounded by word boundaries.
 387 Fourth and fifth arg START and END specify the region to operate on.
 388
 389 If `query-replace-interactive' is non-nil, the last incremental search
 390 string is used as FROM-STRING--you don't have to specify it with the
 391 minibuffer.
 392
 393 This function is usually the wrong thing to use in a Lisp program.
 394 What you probably want is a loop like this:
 395   (while (search-forward FROM-STRING nil t)
 396     (replace-match TO-STRING nil t))
 397 which will run faster and will not set the mark or print anything.
 398 \(You may need a more complex loop if FROM-STRING can match the null string
 399 and TO-STRING is also null.)"
 400   (interactive
 401    (let ((common
 402           (query-replace-read-args "Replace string" nil)))
 403      (list (nth 0 common) (nth 1 common) (nth 2 common)
 404            (if (and transient-mark-mode mark-active)
 405                (region-beginning))
 406            (if (and transient-mark-mode mark-active)
 407                (region-end)))))
 408   (perform-replace from-string to-string nil nil delimited nil nil start end))
 409
 410 (defun replace-regexp (regexp to-string &optional delimited start end)
 411   "Replace things after point matching REGEXP with TO-STRING.
 412 Preserve case in each match if `case-replace' and `case-fold-search'
 413 are non-nil and REGEXP has no uppercase letters.
 414
 415 In Transient Mark mode, if the mark is active, operate on the contents
 416 of the region.  Otherwise, operate from point to the end of the buffer.
 417
 418 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
 419 only matches surrounded by word boundaries.
 420 Fourth and fifth arg START and END specify the region to operate on.
 421
 422 In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
 423 and `\\=\\N' (where N is a digit) stands for
 424 whatever what matched the Nth `\\(...\\)' in REGEXP.
 425 `\\?' lets you edit the replacement text in the minibuffer
 426 at the given position for each replacement.
 427
 428 In interactive calls, the replacement text may contain `\\,'
 429 followed by a Lisp expression used as part of the replacement
 430 text.  Inside of that expression, `\\&' is a string denoting the
 431 whole match, `\\N' a partial matches, `\\#&' and `\\#N' the
 432 respective numeric values from `string-to-number', and `\\#'
 433 itself for `replace-count', the number of replacements occured so
 434 far.
 435
 436 If your Lisp expression is an identifier and the next letter in
 437 the replacement string would be interpreted as part of it, you
 438 can wrap it with an expression like `\\,(or \\#)'.  Incidentally,
 439 for this particular case you may also enter `\\#' in the
 440 replacement text directly.
 441
 442 When using those Lisp features interactively in the replacement
 443 text, TO-STRING is actually made a list instead of a string.
 444 Use \\[repeat-complex-command] after this command for details.
 445
 446 If `query-replace-interactive' is non-nil, the last incremental search
 447 regexp is used as REGEXP--you don't have to specify it with the minibuffer.
 448
 449 This function is usually the wrong thing to use in a Lisp program.
 450 What you probably want is a loop like this:
 451   (while (re-search-forward REGEXP nil t)
 452     (replace-match TO-STRING nil nil))
 453 which will run faster and will not set the mark or print anything."
 454   (interactive
 455    (let ((common
 456           (query-replace-read-args "Replace regexp" t)))
 457      (list (nth 0 common) (nth 1 common) (nth 2 common)
 458            (if (and transient-mark-mode mark-active)
 459                (region-beginning))
 460            (if (and transient-mark-mode mark-active)
 461                (region-end)))))
 462   (perform-replace regexp to-string nil t delimited nil nil start end))
 463
 464 \f
 465 (defvar regexp-history nil
 466   "History list for some commands that read regular expressions.")
 467
 468
 469 (defalias 'delete-non-matching-lines 'keep-lines)
 470 (defalias 'delete-matching-lines 'flush-lines)
 471 (defalias 'count-matches 'how-many)
 472
 473
 474 (defun keep-lines-read-args (prompt)
 475   "Read arguments for `keep-lines' and friends.
 476 Prompt for a regexp with PROMPT.
 477 Value is a list, (REGEXP)."
 478   (list (read-from-minibuffer prompt nil nil nil
 479                               'regexp-history nil t)))
 480
 481 (defun keep-lines (regexp &optional rstart rend)
 482   "Delete all lines except those containing matches for REGEXP.
 483 A match split across lines preserves all the lines it lies in.
 484 Applies to all lines after point.
 485
 486 If REGEXP contains upper case characters (excluding those preceded by `\\'),
 487 the matching is case-sensitive.
 488
 489 Second and third arg RSTART and REND specify the region to operate on.
 490
 491 Interactively, in Transient Mark mode when the mark is active, operate
 492 on the contents of the region.  Otherwise, operate from point to the
 493 end of the buffer."
 494
 495   (interactive
 496    (progn
 497      (barf-if-buffer-read-only)
 498      (keep-lines-read-args "Keep lines (containing match for regexp): ")))
 499   (if rstart
 500       (progn
 501         (goto-char (min rstart rend))
 502         (setq rend (copy-marker (max rstart rend))))
 503     (if (and transient-mark-mode mark-active)
 504         (setq rstart (region-beginning)
 505               rend (copy-marker (region-end)))
 506       (setq rstart (point)
 507             rend (point-max-marker)))
 508     (goto-char rstart))
 509   (save-excursion
 510     (or (bolp) (forward-line 1))
 511     (let ((start (point))
 512           (case-fold-search  (and case-fold-search
 513                                   (isearch-no-upper-case-p regexp t))))
 514       (while (< (point) rend)
 515         ;; Start is first char not preserved by previous match.
 516         (if (not (re-search-forward regexp rend 'move))
 517             (delete-region start rend)
 518           (let ((end (save-excursion (goto-char (match-beginning 0))
 519                                      (beginning-of-line)
 520                                      (point))))
 521             ;; Now end is first char preserved by the new match.
 522             (if (< start end)
 523                 (delete-region start end))))
 524
 525         (setq start (save-excursion (forward-line 1) (point)))
 526         ;; If the match was empty, avoid matching again at same place.
 527         (and (< (point) rend)
 528              (= (match-beginning 0) (match-end 0))
 529              (forward-char 1))))))
 530
 531
 532 (defun flush-lines (regexp &optional rstart rend)
 533   "Delete lines containing matches for REGEXP.
 534 If a match is split across lines, all the lines it lies in are deleted.
 535 Applies to lines after point.
 536
 537 If REGEXP contains upper case characters (excluding those preceded by `\\'),
 538 the matching is case-sensitive.
 539
 540 Second and third arg RSTART and REND specify the region to operate on.
 541
 542 Interactively, in Transient Mark mode when the mark is active, operate
 543 on the contents of the region.  Otherwise, operate from point to the
 544 end of the buffer."
 545
 546   (interactive
 547    (progn
 548      (barf-if-buffer-read-only)
 549      (keep-lines-read-args "Flush lines (containing match for regexp): ")))
 550   (if rstart
 551       (progn
 552         (goto-char (min rstart rend))
 553         (setq rend (copy-marker (max rstart rend))))
 554     (if (and transient-mark-mode mark-active)
 555         (setq rstart (region-beginning)
 556               rend (copy-marker (region-end)))
 557       (setq rstart (point)
 558             rend (point-max-marker)))
 559     (goto-char rstart))
 560   (let ((case-fold-search (and case-fold-search
 561                                (isearch-no-upper-case-p regexp t))))
 562     (save-excursion
 563       (while (and (< (point) rend)
 564                   (re-search-forward regexp rend t))
 565         (delete-region (save-excursion (goto-char (match-beginning 0))
 566                                        (beginning-of-line)
 567                                        (point))
 568                        (progn (forward-line 1) (point)))))))
 569
 570
 571 (defun how-many (regexp &optional rstart rend)
 572   "Print number of matches for REGEXP following point.
 573
 574 If REGEXP contains upper case characters (excluding those preceded by `\\'),
 575 the matching is case-sensitive.
 576
 577 Second and third arg RSTART and REND specify the region to operate on.
 578
 579 Interactively, in Transient Mark mode when the mark is active, operate
 580 on the contents of the region.  Otherwise, operate from point to the
 581 end of the buffer."
 582
 583   (interactive
 584    (keep-lines-read-args "How many matches for (regexp): "))
 585   (save-excursion
 586     (if rstart
 587         (goto-char (min rstart rend))
 588       (if (and transient-mark-mode mark-active)
 589           (setq rstart (region-beginning)
 590                 rend (copy-marker (region-end)))
 591         (setq rstart (point)
 592               rend (point-max-marker)))
 593       (goto-char rstart))
 594     (let ((count 0)
 595           opoint
 596           (case-fold-search (and case-fold-search
 597                                  (isearch-no-upper-case-p regexp t))))
 598       (while (and (< (point) rend)
 599                   (progn (setq opoint (point))
 600                          (re-search-forward regexp rend t)))
 601         (if (= opoint (point))
 602             (forward-char 1)
 603           (setq count (1+ count))))
 604       (message "%d occurrences" count))))
 605
 606 \f
 607 (defvar occur-mode-map
 608   (let ((map (make-sparse-keymap)))
 609     (define-key map [mouse-2] 'occur-mode-mouse-goto)
 610     (define-key map "\C-c\C-c" 'occur-mode-goto-occurrence)
 611     (define-key map "\C-m" 'occur-mode-goto-occurrence)
 612     (define-key map "o" 'occur-mode-goto-occurrence-other-window)
 613     (define-key map "\C-o" 'occur-mode-display-occurrence)
 614     (define-key map "\M-n" 'occur-next)
 615     (define-key map "\M-p" 'occur-prev)
 616     (define-key map "r" 'occur-rename-buffer)
 617     (define-key map "c" 'clone-buffer)
 618     (define-key map "g" 'revert-buffer)
 619     (define-key map "q" 'quit-window)
 620     (define-key map "z" 'kill-this-buffer)
 621     (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
 622     map)
 623   "Keymap for `occur-mode'.")
 624
 625 (defvar occur-revert-arguments nil
 626   "Arguments to pass to `occur-1' to revert an Occur mode buffer.
 627 See `occur-revert-function'.")
 628
 629 (defcustom occur-mode-hook '(turn-on-font-lock)
 630   "Hook run when entering Occur mode."
 631   :type 'hook
 632   :group 'matching)
 633
 634 (defcustom occur-hook nil
 635   "Hook run when `occur' is called."
 636   :type 'hook
 637   :group 'matching)
 638
 639 (put 'occur-mode 'mode-class 'special)
 640 (defun occur-mode ()
 641   "Major mode for output from \\[occur].
 642 \\<occur-mode-map>Move point to one of the items in this buffer, then use
 643 \\[occur-mode-goto-occurrence] to go to the occurrence that the item refers to.
 644 Alternatively, click \\[occur-mode-mouse-goto] on an item to go to it.
 645
 646 \\{occur-mode-map}"
 647   (interactive)
 648   (kill-all-local-variables)
 649   (use-local-map occur-mode-map)
 650   (setq major-mode 'occur-mode)
 651   (setq mode-name "Occur")
 652   (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
 653   (make-local-variable 'occur-revert-arguments)
 654   (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
 655   (setq next-error-function 'occur-next-error)
 656   (run-hooks 'occur-mode-hook))
 657
 658 (defun occur-revert-function (ignore1 ignore2)
 659   "Handle `revert-buffer' for Occur mode buffers."
 660   (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
 661
 662 (defun occur-mode-mouse-goto (event)
 663   "In Occur mode, go to the occurrence whose line you click on."
 664   (interactive "e")
 665   (let (pos)
 666     (save-excursion
 667       (set-buffer (window-buffer (posn-window (event-end event))))
 668       (save-excursion
 669         (goto-char (posn-point (event-end event)))
 670         (setq pos (occur-mode-find-occurrence))))
 671     (pop-to-buffer (marker-buffer pos))
 672     (goto-char pos)))
 673
 674 (defun occur-mode-find-occurrence ()
 675   (let ((pos (get-text-property (point) 'occur-target)))
 676     (unless pos
 677       (error "No occurrence on this line"))
 678     (unless (buffer-live-p (marker-buffer pos))
 679       (error "Buffer for this occurrence was killed"))
 680     pos))
 681
 682 (defun occur-mode-goto-occurrence ()
 683   "Go to the occurrence the current line describes."
 684   (interactive)
 685   (let ((pos (occur-mode-find-occurrence)))
 686     (pop-to-buffer (marker-buffer pos))
 687     (goto-char pos)))
 688
 689 (defun occur-mode-goto-occurrence-other-window ()
 690   "Go to the occurrence the current line describes, in another window."
 691   (interactive)
 692   (let ((pos (occur-mode-find-occurrence)))
 693     (switch-to-buffer-other-window (marker-buffer pos))
 694     (goto-char pos)))
 695
 696 (defun occur-mode-display-occurrence ()
 697   "Display in another window the occurrence the current line describes."
 698   (interactive)
 699   (let ((pos (occur-mode-find-occurrence))
 700         window
 701         ;; Bind these to ensure `display-buffer' puts it in another window.
 702         same-window-buffer-names
 703         same-window-regexps)
 704     (setq window (display-buffer (marker-buffer pos)))
 705     ;; This is the way to set point in the proper window.
 706     (save-selected-window
 707       (select-window window)
 708       (goto-char pos))))
 709
 710 (defun occur-find-match (n search message)
 711   (if (not n) (setq n 1))
 712   (let ((r))
 713     (while (> n 0)
 714       (setq r (funcall search (point) 'occur-match))
 715       (and r
 716            (get-text-property r 'occur-match)
 717            (setq r (funcall search r 'occur-match)))
 718       (if r
 719           (goto-char r)
 720         (error message))
 721       (setq n (1- n)))))
 722
 723 (defun occur-next (&optional n)
 724   "Move to the Nth (default 1) next match in an Occur mode buffer."
 725   (interactive "p")
 726   (occur-find-match n #'next-single-property-change "No more matches"))
 727
 728 (defun occur-prev (&optional n)
 729   "Move to the Nth (default 1) previous match in an Occur mode buffer."
 730   (interactive "p")
 731   (occur-find-match n #'previous-single-property-change "No earlier matches"))
 732
 733 (defun occur-next-error (&optional argp reset)
 734   "Move to the Nth (default 1) next match in an Occur mode buffer.
 735 Compatibility function for \\[next-error] invocations."
 736   (interactive "p")
 737   ;; we need to run occur-find-match from within the Occur buffer
 738   (with-current-buffer
 739       ;; Choose the buffer and make it current.
 740       (if (next-error-buffer-p (current-buffer))
 741           (current-buffer)
 742         (next-error-find-buffer nil nil
 743                                 (lambda ()
 744                                   (eq major-mode 'occur-mode))))
 745
 746     (goto-char (cond (reset (point-min))
 747                      ((< argp 0) (line-beginning-position))
 748                      ((line-end-position))))
 749     (occur-find-match
 750      (abs argp)
 751      (if (> 0 argp)
 752          #'previous-single-property-change
 753        #'next-single-property-change)
 754      "No more matches")
 755     ;; In case the *Occur* buffer is visible in a nonselected window.
 756     (set-window-point (get-buffer-window (current-buffer)) (point))
 757     (occur-mode-goto-occurrence)))
 758 \f
 759 (defface match
 760   '((((class color) (min-colors 88) (background light))
 761      :background "Tan")
 762     (((class color) (min-colors 88) (background dark))
 763      :background "RoyalBlue4")
 764     (((class color) (min-colors 8))
 765      :background "blue" :foreground "white")
 766     (((type tty) (class mono))
 767      :inverse-video t)
 768     (t :background "gray"))
 769   "Face used to highlight matches permanently."
 770   :group 'matching
 771   :version "21.4")
 772
 773 (defcustom list-matching-lines-default-context-lines 0
 774   "*Default number of context lines included around `list-matching-lines' matches.
 775 A negative number means to include that many lines before the match.
 776 A positive number means to include that many lines both before and after."
 777   :type 'integer
 778   :group 'matching)
 779
 780 (defalias 'list-matching-lines 'occur)
 781
 782 (defcustom list-matching-lines-face 'match
 783   "*Face used by \\[list-matching-lines] to show the text that matches.
 784 If the value is nil, don't highlight the matching portions specially."
 785   :type 'face
 786   :group 'matching)
 787
 788 (defcustom list-matching-lines-buffer-name-face 'underline
 789   "*Face used by \\[list-matching-lines] to show the names of buffers.
 790 If the value is nil, don't highlight the buffer names specially."
 791   :type 'face
 792   :group 'matching)
 793
 794 (defun occur-accumulate-lines (count &optional keep-props)
 795   (save-excursion
 796     (let ((forwardp (> count 0))
 797           result beg end)
 798       (while (not (or (zerop count)
 799                       (if forwardp
 800                           (eobp)
 801                         (bobp))))
 802         (setq count (+ count (if forwardp -1 1)))
 803         (setq beg (line-beginning-position)
 804               end (line-end-position))
 805         (if (and keep-props (boundp 'jit-lock-mode) jit-lock-mode
 806                  (text-property-not-all beg end 'fontified t))
 807             (jit-lock-fontify-now beg end))
 808         (push
 809          (funcall (if keep-props
 810                       #'buffer-substring
 811                     #'buffer-substring-no-properties)
 812                   beg end)
 813          result)
 814         (forward-line (if forwardp 1 -1)))
 815       (nreverse result))))
 816
 817 (defun occur-read-primary-args ()
 818   (list (let* ((default (car regexp-history))
 819                (input
 820                 (read-from-minibuffer
 821                  (if default
 822                      (format "List lines matching regexp (default `%s'): "
 823                              (query-replace-descr default))
 824                    "List lines matching regexp: ")
 825                  nil
 826                  nil
 827                  nil
 828                  'regexp-history
 829                  default)))
 830           (if (equal input "")
 831               default
 832             input))
 833         (when current-prefix-arg
 834           (prefix-numeric-value current-prefix-arg))))
 835
 836 (defun occur-rename-buffer (&optional unique-p)
 837   "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
 838 Here `original-buffer-name' is the buffer name were occur was originally run.
 839 When given the prefix argument, the renaming will not clobber the existing
 840 buffer(s) of that name, but use `generate-new-buffer-name' instead.
 841 You can add this to `occur-hook' if you always want a separate *Occur*
 842 buffer for each buffer where you invoke `occur'."
 843   (interactive "P")
 844   (with-current-buffer
 845       (if (eq major-mode 'occur-mode) (current-buffer) (get-buffer "*Occur*"))
 846     (rename-buffer (concat "*Occur: "
 847                            (mapconcat #'buffer-name
 848                                       (car (cddr occur-revert-arguments)) "/")
 849                            "*")
 850                    unique-p)))
 851
 852 (defun occur (regexp &optional nlines)
 853   "Show all lines in the current buffer containing a match for REGEXP.
 854
 855 If a match spreads across multiple lines, all those lines are shown.
 856
 857 Each line is displayed with NLINES lines before and after, or -NLINES
 858 before if NLINES is negative.
 859 NLINES defaults to `list-matching-lines-default-context-lines'.
 860 Interactively it is the prefix arg.
 861
 862 The lines are shown in a buffer named `*Occur*'.
 863 It serves as a menu to find any of the occurrences in this buffer.
 864 \\<occur-mode-map>\\[describe-mode] in that buffer will explain how.
 865
 866 If REGEXP contains upper case characters (excluding those preceded by `\\'),
 867 the matching is case-sensitive."
 868   (interactive (occur-read-primary-args))
 869   (occur-1 regexp nlines (list (current-buffer))))
 870
 871 (defun multi-occur (bufs regexp &optional nlines)
 872   "Show all lines in buffers BUFS containing a match for REGEXP.
 873 This function acts on multiple buffers; otherwise, it is exactly like
 874 `occur'."
 875   (interactive
 876    (cons
 877     (let* ((bufs (list (read-buffer "First buffer to search: "
 878                                     (current-buffer) t)))
 879            (buf nil)
 880            (ido-ignore-item-temp-list bufs))
 881       (while (not (string-equal
 882                    (setq buf (read-buffer
 883                               (if (eq read-buffer-function 'ido-read-buffer)
 884                                   "Next buffer to search (C-j to end): "
 885                                 "Next buffer to search (RET to end): ")
 886                               nil t))
 887                    ""))
 888         (add-to-list 'bufs buf)
 889         (setq ido-ignore-item-temp-list bufs))
 890       (nreverse (mapcar #'get-buffer bufs)))
 891     (occur-read-primary-args)))
 892   (occur-1 regexp nlines bufs))
 893
 894 (defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines)
 895   "Show all lines matching REGEXP in buffers named by BUFREGEXP.
 896 See also `multi-occur'."
 897   (interactive
 898    (cons
 899     (let* ((default (car regexp-history))
 900            (input
 901             (read-from-minibuffer
 902              "List lines in buffers whose filename matches regexp: "
 903              nil
 904              nil
 905              nil
 906              'regexp-history)))
 907       (if (equal input "")
 908           default
 909         input))
 910     (occur-read-primary-args)))
 911   (when bufregexp
 912     (occur-1 regexp nlines
 913              (delq nil
 914                    (mapcar (lambda (buf)
 915                              (when (and (buffer-file-name buf)
 916                                         (string-match bufregexp
 917                                                       (buffer-file-name buf)))
 918                                buf))
 919                            (buffer-list))))))
 920
 921 (defun occur-1 (regexp nlines bufs &optional buf-name)
 922   (unless buf-name
 923     (setq buf-name "*Occur*"))
 924   (let (occur-buf
 925         (active-bufs (delq nil (mapcar #'(lambda (buf)
 926                                            (when (buffer-live-p buf) buf))
 927                                        bufs))))
 928     ;; Handle the case where one of the buffers we're searching is the
 929     ;; output buffer.  Just rename it.
 930     (when (member buf-name (mapcar 'buffer-name active-bufs))
 931       (with-current-buffer (get-buffer buf-name)
 932         (rename-uniquely)))
 933
 934     ;; Now find or create the output buffer.
 935     ;; If we just renamed that buffer, we will make a new one here.
 936     (setq occur-buf (get-buffer-create buf-name))
 937
 938     (with-current-buffer occur-buf
 939       (setq buffer-read-only nil)
 940       (occur-mode)
 941       (erase-buffer)
 942       (let ((count (occur-engine
 943                     regexp active-bufs occur-buf
 944                     (or nlines list-matching-lines-default-context-lines)
 945                     (and case-fold-search
 946                          (isearch-no-upper-case-p regexp t))
 947                     list-matching-lines-buffer-name-face
 948                     nil list-matching-lines-face t)))
 949         (let* ((bufcount (length active-bufs))
 950                (diff (- (length bufs) bufcount)))
 951           (message "Searched %d buffer%s%s; %s match%s for `%s'"
 952                    bufcount (if (= bufcount 1) "" "s")
 953                    (if (zerop diff) "" (format " (%d killed)" diff))
 954                    (if (zerop count) "no" (format "%d" count))
 955                    (if (= count 1) "" "es")
 956                    regexp))
 957         (setq occur-revert-arguments (list regexp nlines bufs)
 958               buffer-read-only t)
 959         (if (> count 0)
 960             (progn
 961               (display-buffer occur-buf)
 962               (setq next-error-last-buffer occur-buf))
 963           (kill-buffer occur-buf)))
 964       (run-hooks 'occur-hook))))
 965
 966 (defun occur-engine-add-prefix (lines)
 967   (mapcar
 968    #'(lambda (line)
 969        (concat "       :" line "\n"))
 970    lines))
 971
 972 (defun occur-engine (regexp buffers out-buf nlines case-fold-search
 973                             title-face prefix-face match-face keep-props)
 974   (with-current-buffer out-buf
 975     (setq buffer-read-only nil)
 976     (let ((globalcount 0)
 977           (coding nil))
 978       ;; Map over all the buffers
 979       (dolist (buf buffers)
 980         (when (buffer-live-p buf)
 981           (let ((matches 0)     ;; count of matched lines
 982                 (lines 1)       ;; line count
 983                 (matchbeg 0)
 984                 (origpt nil)
 985                 (begpt nil)
 986                 (endpt nil)
 987                 (marker nil)
 988                 (curstring "")
 989                 (headerpt (with-current-buffer out-buf (point))))
 990             (save-excursion
 991               (set-buffer buf)
 992               (or coding
 993                   ;; Set CODING only if the current buffer locally
 994                   ;; binds buffer-file-coding-system.
 995                   (not (local-variable-p 'buffer-file-coding-system))
 996                   (setq coding buffer-file-coding-system))
 997               (save-excursion
 998                 (goto-char (point-min)) ;; begin searching in the buffer
 999                 (while (not (eobp))
1000                   (setq origpt (point))
1001                   (when (setq endpt (re-search-forward regexp nil t))
1002                     (setq matches (1+ matches)) ;; increment match count
1003                     (setq matchbeg (match-beginning 0))
1004                     (setq lines (+ lines (1- (count-lines origpt endpt))))
1005                     (save-excursion
1006                       (goto-char matchbeg)
1007                       (setq begpt (line-beginning-position)
1008                             endpt (line-end-position)))
1009                     (setq marker (make-marker))
1010                     (set-marker marker matchbeg)
1011                     (if (and keep-props (boundp 'jit-lock-mode) jit-lock-mode
1012                              (text-property-not-all begpt endpt 'fontified t))
1013                         (jit-lock-fontify-now begpt endpt))
1014                     (setq curstring (buffer-substring begpt endpt))
1015                     ;; Depropertize the string, and maybe
1016                     ;; highlight the matches
1017                     (let ((len (length curstring))
1018                           (start 0))
1019                       (unless keep-props
1020                         (set-text-properties 0 len nil curstring))
1021                       (while (and (< start len)
1022                                   (string-match regexp curstring start))
1023                         (add-text-properties
1024                          (match-beginning 0) (match-end 0)
1025                          (append
1026                           `(occur-match t)
1027                           (when match-face
1028                             ;; Use `face' rather than `font-lock-face' here
1029                             ;; so as to override faces copied from the buffer.
1030                             `(face ,match-face)))
1031                          curstring)
1032                         (setq start (match-end 0))))
1033                     ;; Generate the string to insert for this match
1034                     (let* ((out-line
1035                             (concat
1036                              ;; Using 7 digits aligns tabs properly.
1037                              (apply #'propertize (format "%7d:" lines)
1038                                     (append
1039                                      (when prefix-face
1040                                        `(font-lock-face prefix-face))
1041                                      '(occur-prefix t)))
1042                              ;; We don't put `mouse-face' on the newline,
1043                              ;; because that loses.  And don't put it
1044                              ;; on context lines to reduce flicker.
1045                              (propertize curstring 'mouse-face 'highlight)
1046                              "\n"))
1047                            (data
1048                             (if (= nlines 0)
1049                                 ;; The simple display style
1050                                 out-line
1051                               ;; The complex multi-line display
1052                               ;; style.  Generate a list of lines,
1053                               ;; concatenate them all together.
1054                               (apply #'concat
1055                                      (nconc
1056                                       (occur-engine-add-prefix (nreverse (cdr (occur-accumulate-lines (- (1+ (abs nlines))) keep-props))))
1057                                       (list out-line)
1058                                       (if (> nlines 0)
1059                                           (occur-engine-add-prefix
1060                                            (cdr (occur-accumulate-lines (1+ nlines) keep-props)))))))))
1061                       ;; Actually insert the match display data
1062                       (with-current-buffer out-buf
1063                         (let ((beg (point))
1064                               (end (progn (insert data) (point))))
1065                           (unless (= nlines 0)
1066                             (insert "-------\n"))
1067                           (add-text-properties
1068                            beg end
1069                            `(occur-target ,marker help-echo "mouse-2: go to this occurrence")))))
1070                     (goto-char endpt))
1071                   (if endpt
1072                       (progn
1073                         (setq lines (1+ lines))
1074                         ;; On to the next match...
1075                         (forward-line 1))
1076                     (goto-char (point-max))))))
1077             (when (not (zerop matches)) ;; is the count zero?
1078               (setq globalcount (+ globalcount matches))
1079               (with-current-buffer out-buf
1080                 (goto-char headerpt)
1081                 (let ((beg (point))
1082                       end)
1083                   (insert (format "%d match%s for \"%s\" in buffer: %s\n"
1084                                   matches (if (= matches 1) "" "es")
1085                                   regexp (buffer-name buf)))
1086                   (setq end (point))
1087                   (add-text-properties beg end
1088                                        (append
1089                                         (when title-face
1090                                           `(font-lock-face ,title-face))
1091                                         `(occur-title ,buf))))
1092                 (goto-char (point-min)))))))
1093       (if coding
1094           ;; CODING is buffer-file-coding-system of the first buffer
1095           ;; that locally binds it.  Let's use it also for the output
1096           ;; buffer.
1097           (set-buffer-file-coding-system coding))
1098       ;; Return the number of matches
1099       globalcount)))
1100
1101 \f
1102 ;; It would be nice to use \\[...], but there is no reasonable way
1103 ;; to make that display both SPC and Y.
1104 (defconst query-replace-help
1105   "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1106 RET or `q' to exit, Period to replace one match and exit,
1107 Comma to replace but not move point immediately,
1108 C-r to enter recursive edit (\\[exit-recursive-edit] to get out again),
1109 C-w to delete match and recursive edit,
1110 C-l to clear the screen, redisplay, and offer same replacement again,
1111 ! to replace all remaining matches with no more questions,
1112 ^ to move point back to previous match,
1113 E to edit the replacement string"
1114   "Help message while in `query-replace'.")
1115
1116 (defvar query-replace-map (make-sparse-keymap)
1117   "Keymap that defines the responses to questions in `query-replace'.
1118 The \"bindings\" in this map are not commands; they are answers.
1119 The valid answers include `act', `skip', `act-and-show',
1120 `exit', `act-and-exit', `edit', `delete-and-edit', `recenter',
1121 `automatic', `backup', `exit-prefix', and `help'.")
1122
1123 (define-key query-replace-map " " 'act)
1124 (define-key query-replace-map "\d" 'skip)
1125 (define-key query-replace-map [delete] 'skip)
1126 (define-key query-replace-map [backspace] 'skip)
1127 (define-key query-replace-map "y" 'act)
1128 (define-key query-replace-map "n" 'skip)
1129 (define-key query-replace-map "Y" 'act)
1130 (define-key query-replace-map "N" 'skip)
1131 (define-key query-replace-map "e" 'edit-replacement)
1132 (define-key query-replace-map "E" 'edit-replacement)
1133 (define-key query-replace-map "," 'act-and-show)
1134 (define-key query-replace-map "q" 'exit)
1135 (define-key query-replace-map "\r" 'exit)
1136 (define-key query-replace-map [return] 'exit)
1137 (define-key query-replace-map "." 'act-and-exit)
1138 (define-key query-replace-map "\C-r" 'edit)
1139 (define-key query-replace-map "\C-w" 'delete-and-edit)
1140 (define-key query-replace-map "\C-l" 'recenter)
1141 (define-key query-replace-map "!" 'automatic)
1142 (define-key query-replace-map "^" 'backup)
1143 (define-key query-replace-map "\C-h" 'help)
1144 (define-key query-replace-map [f1] 'help)
1145 (define-key query-replace-map [help] 'help)
1146 (define-key query-replace-map "?" 'help)
1147 (define-key query-replace-map "\C-g" 'quit)
1148 (define-key query-replace-map "\C-]" 'quit)
1149 (define-key query-replace-map "\e" 'exit-prefix)
1150 (define-key query-replace-map [escape] 'exit-prefix)
1151
1152 (defun replace-match-string-symbols (n)
1153   "Process a list (and any sub-lists), expanding certain symbols.
1154 Symbol  Expands To
1155 N     (match-string N)           (where N is a string of digits)
1156 #N    (string-to-number (match-string N))
1157 &     (match-string 0)
1158 #&    (string-to-number (match-string 0))
1159 #     replace-count
1160
1161 Note that these symbols must be preceeded by a backslash in order to
1162 type them."
1163   (while n
1164     (cond
1165      ((consp (car n))
1166       (replace-match-string-symbols (car n))) ;Process sub-list
1167      ((symbolp (car n))
1168       (let ((name (symbol-name (car n))))
1169         (cond
1170          ((string-match "^[0-9]+$" name)
1171           (setcar n (list 'match-string (string-to-number name))))
1172          ((string-match "^#[0-9]+$" name)
1173           (setcar n (list 'string-to-number
1174                           (list 'match-string
1175                                 (string-to-number (substring name 1))))))
1176          ((string= "&" name)
1177           (setcar n '(match-string 0)))
1178          ((string= "#&" name)
1179           (setcar n '(string-to-number (match-string 0))))
1180          ((string= "#" name)
1181           (setcar n 'replace-count))))))
1182     (setq n (cdr n))))
1183
1184 (defun replace-eval-replacement (expression replace-count)
1185   (let ((replacement (eval expression)))
1186     (if (stringp replacement)
1187         replacement
1188       (prin1-to-string replacement t))))
1189
1190 (defun replace-quote (replacement)
1191   "Quote a replacement string.
1192 This just doubles all backslashes in REPLACEMENT and
1193 returns the resulting string.  If REPLACEMENT is not
1194 a string, it is first passed through `prin1-to-string'
1195 with the `noescape' argument set.
1196
1197 `match-data' is preserved across the call."
1198   (save-match-data
1199     (replace-regexp-in-string "\\\\" "\\\\"
1200                               (if (stringp replacement)
1201                                   replacement
1202                                 (prin1-to-string replacement t))
1203                               t t)))
1204
1205 (defun replace-loop-through-replacements (data replace-count)
1206   ;; DATA is a vector contaning the following values:
1207   ;;   0 next-rotate-count
1208   ;;   1 repeat-count
1209   ;;   2 next-replacement
1210   ;;   3 replacements
1211   (if (= (aref data 0) replace-count)
1212       (progn
1213         (aset data 0 (+ replace-count (aref data 1)))
1214         (let ((next (cdr (aref data 2))))
1215           (aset data 2 (if (consp next) next (aref data 3))))))
1216   (car (aref data 2)))
1217
1218 (defun replace-match-data (integers reuse &optional new)
1219   "Like `match-data', but markers in REUSE get invalidated.
1220 If NEW is non-NIL, it is set and returned instead of fresh data,
1221 but coerced to the correct value of INTEGERS."
1222   (or (and new
1223            (progn
1224              (set-match-data new)
1225              (and (eq new reuse)
1226                   (eq (null integers) (markerp (car reuse)))
1227                   new)))
1228       (match-data integers
1229                   (prog1 reuse
1230                     (while reuse
1231                       (if (markerp (car reuse))
1232                           (set-marker (car reuse) nil))
1233                       (setq reuse (cdr reuse)))))))
1234
1235 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data)
1236   "Make a replacement with `replace-match', editing `\\?'.
1237 NEWTEXT, FIXEDCASE, LITERAL are just passed on.  If NOEDIT is true, no
1238 check for `\\?' is made to save time.  MATCH-DATA is used for the
1239 replacement.  In case editing is done, it is changed to use markers.
1240
1241 The return value is non-NIL if there has been no `\\?' or NOEDIT was
1242 passed in.  If LITERAL is set, no checking is done, anyway."
1243   (unless (or literal noedit)
1244     (setq noedit t)
1245     (while (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\?\\)"
1246                          newtext)
1247       (setq newtext
1248             (read-input "Edit replacement string: "
1249                         (prog1
1250                             (cons
1251                              (replace-match "" t t newtext 3)
1252                              (1+ (match-beginning 3)))
1253                           (setq match-data
1254                                 (replace-match-data
1255                                  nil match-data match-data))))
1256             noedit nil)))
1257   (set-match-data match-data)
1258   (replace-match newtext fixedcase literal)
1259   noedit)
1260
1261 (defcustom query-replace-highlight t
1262   "*Non-nil means to highlight matches during query replacement."
1263   :type 'boolean
1264   :group 'matching)
1265
1266 (defcustom query-replace-lazy-highlight t
1267   "*Controls the lazy-highlighting during query replacements.
1268 When non-nil, all text in the buffer matching the current match
1269 is highlighted lazily using isearch lazy highlighting (see
1270 `isearch-lazy-highlight-initial-delay' and
1271 `isearch-lazy-highlight-interval')."
1272   :type 'boolean
1273   :group 'matching
1274   :version "21.4")
1275
1276 (defface query-replace
1277   '((t (:inherit isearch)))
1278   "Face for highlighting query replacement matches."
1279   :group 'matching
1280   :version "21.4")
1281
1282 (defun perform-replace (from-string replacements
1283                         query-flag regexp-flag delimited-flag
1284                         &optional repeat-count map start end)
1285   "Subroutine of `query-replace'.  Its complexity handles interactive queries.
1286 Don't use this in your own program unless you want to query and set the mark
1287 just as `query-replace' does.  Instead, write a simple loop like this:
1288
1289   (while (re-search-forward \"foo[ \\t]+bar\" nil t)
1290     (replace-match \"foobar\" nil nil))
1291
1292 which will run faster and probably do exactly what you want.  Please
1293 see the documentation of `replace-match' to find out how to simulate
1294 `case-replace'.
1295
1296 This function returns nil if and only if there were no matches to
1297 make, or the user didn't cancel the call."
1298   (or map (setq map query-replace-map))
1299   (and query-flag minibuffer-auto-raise
1300        (raise-frame (window-frame (minibuffer-window))))
1301   (let ((nocasify (not (and case-fold-search case-replace
1302                             (string-equal from-string
1303                                           (downcase from-string)))))
1304         (case-fold-search (and case-fold-search
1305                                (string-equal from-string
1306                                              (downcase from-string))))
1307         (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
1308         (search-function (if regexp-flag 're-search-forward 'search-forward))
1309         (search-string from-string)
1310         (real-match-data nil)           ; the match data for the current match
1311         (next-replacement nil)
1312         (noedit nil)
1313         (keep-going t)
1314         (stack nil)
1315         (replace-count 0)
1316         (nonempty-match nil)
1317
1318         ;; If non-nil, it is marker saying where in the buffer to stop.
1319         (limit nil)
1320
1321         ;; Data for the next match.  If a cons, it has the same format as
1322         ;; (match-data); otherwise it is t if a match is possible at point.
1323         (match-again t)
1324
1325         (isearch-string isearch-string)
1326         (isearch-regexp isearch-regexp)
1327         (isearch-case-fold-search isearch-case-fold-search)
1328         (message
1329          (if query-flag
1330              (substitute-command-keys
1331               "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) "))))
1332
1333     ;; If region is active, in Transient Mark mode, operate on region.
1334     (when start
1335       (setq limit (copy-marker (max start end)))
1336       (goto-char (min start end))
1337       (deactivate-mark))
1338
1339     ;; REPLACEMENTS is either a string, a list of strings, or a cons cell
1340     ;; containing a function and its first argument.  The function is
1341     ;; called to generate each replacement like this:
1342     ;;   (funcall (car replacements) (cdr replacements) replace-count)
1343     ;; It must return a string.
1344     (cond
1345      ((stringp replacements)
1346       (setq next-replacement replacements
1347             replacements     nil))
1348      ((stringp (car replacements)) ; If it isn't a string, it must be a cons
1349       (or repeat-count (setq repeat-count 1))
1350       (setq replacements (cons 'replace-loop-through-replacements
1351                                (vector repeat-count repeat-count
1352                                        replacements replacements)))))
1353
1354     (if delimited-flag
1355         (setq search-function 're-search-forward
1356               search-string (concat "\\b"
1357                                     (if regexp-flag from-string
1358                                       (regexp-quote from-string))
1359                                     "\\b")))
1360     (when query-replace-lazy-highlight
1361       (setq isearch-string search-string
1362             isearch-regexp (or delimited-flag regexp-flag)
1363             isearch-case-fold-search case-fold-search
1364             isearch-lazy-highlight-last-string nil))
1365
1366     (push-mark)
1367     (undo-boundary)
1368     (unwind-protect
1369         ;; Loop finding occurrences that perhaps should be replaced.
1370         (while (and keep-going
1371                     (not (or (eobp) (and limit (>= (point) limit))))
1372                     ;; Use the next match if it is already known;
1373                     ;; otherwise, search for a match after moving forward
1374                     ;; one char if progress is required.
1375                     (setq real-match-data
1376                           (if (consp match-again)
1377                               (progn (goto-char (nth 1 match-again))
1378                                      (replace-match-data t
1379                                       real-match-data
1380                                       match-again))
1381                             (and (or match-again
1382                                      ;; MATCH-AGAIN non-nil means we
1383                                      ;; accept an adjacent match.  If
1384                                      ;; we don't, move one char to the
1385                                      ;; right.  This takes us a
1386                                      ;; character too far at the end,
1387                                      ;; but this is undone after the
1388                                      ;; while-loop.
1389                                      (progn
1390                                        (forward-char 1)
1391                                        (not (or (eobp)
1392                                                 (and limit (>= (point) limit))))))
1393                                  (funcall search-function search-string limit t)
1394                                  ;; For speed, use only integers and
1395                                  ;; reuse the list used last time.
1396                                  (replace-match-data t real-match-data)))))
1397           ;; Optionally ignore matches that have a read-only property.
1398           (unless (and query-replace-skip-read-only
1399                        (text-property-not-all
1400                         (match-beginning 0) (match-end 0)
1401                         'read-only nil))
1402
1403             ;; Record whether the match is nonempty, to avoid an infinite loop
1404             ;; repeatedly matching the same empty string.
1405             (setq nonempty-match
1406                   (/= (nth 0 real-match-data) (nth 1 real-match-data)))
1407
1408             ;; If the match is empty, record that the next one can't be
1409             ;; adjacent.
1410
1411             ;; Otherwise, if matching a regular expression, do the next
1412             ;; match now, since the replacement for this match may
1413             ;; affect whether the next match is adjacent to this one.
1414             ;; If that match is empty, don't use it.
1415             (setq match-again
1416                   (and nonempty-match
1417                        (or (not regexp-flag)
1418                            (and (looking-at search-string)
1419                                 (let ((match (match-data)))
1420                                   (and (/= (nth 0 match) (nth 1 match))
1421                                        match))))))
1422
1423             ;; Calculate the replacement string, if necessary.
1424             (when replacements
1425               (set-match-data real-match-data)
1426               (setq next-replacement
1427                     (funcall (car replacements) (cdr replacements)
1428                              replace-count)
1429                     noedit nil))
1430             (if (not query-flag)
1431                 (let ((inhibit-read-only
1432                        query-replace-skip-read-only))
1433                   (unless (or literal noedit)
1434                     (replace-highlight (nth 0 real-match-data)
1435                                        (nth 1 real-match-data)))
1436                   (setq noedit
1437                         (replace-match-maybe-edit
1438                          next-replacement nocasify literal
1439                          noedit real-match-data)
1440                         replace-count (1+ replace-count)))
1441               (undo-boundary)
1442               (let (done replaced key def)
1443                 ;; Loop reading commands until one of them sets done,
1444                 ;; which means it has finished handling this
1445                 ;; occurrence.  Any command that sets `done' should
1446                 ;; leave behind proper match data for the stack.
1447                 ;; Commands not setting `done' need to adjust
1448                 ;; `real-match-data'.
1449                 (while (not done)
1450                   (set-match-data real-match-data)
1451                   (replace-highlight (match-beginning 0) (match-end 0))
1452                   ;; Bind message-log-max so we don't fill up the message log
1453                   ;; with a bunch of identical messages.
1454                   (let ((message-log-max nil))
1455                     (message message
1456                              (query-replace-descr from-string)
1457                              (query-replace-descr next-replacement)))
1458                   (setq key (read-event))
1459                   ;; Necessary in case something happens during read-event
1460                   ;; that clobbers the match data.
1461                   (set-match-data real-match-data)
1462                   (setq key (vector key))
1463                   (setq def (lookup-key map key))
1464                   ;; Restore the match data while we process the command.
1465                   (cond ((eq def 'help)
1466                          (with-output-to-temp-buffer "*Help*"
1467                            (princ
1468                             (concat "Query replacing "
1469                                     (if regexp-flag "regexp " "")
1470                                     from-string " with "
1471                                     next-replacement ".\n\n"
1472                                     (substitute-command-keys
1473                                      query-replace-help)))
1474                            (with-current-buffer standard-output
1475                              (help-mode))))
1476                         ((eq def 'exit)
1477                          (setq keep-going nil)
1478                          (setq done t))
1479                         ((eq def 'backup)
1480                          (if stack
1481                              (let ((elt (pop stack)))
1482                                (goto-char (nth 0 elt))
1483                                (setq replaced (nth 1 elt)
1484                                      real-match-data
1485                                      (replace-match-data
1486                                       t real-match-data
1487                                       (nth 2 elt))))
1488                            (message "No previous match")
1489                            (ding 'no-terminate)
1490                            (sit-for 1)))
1491                         ((eq def 'act)
1492                          (or replaced
1493                              (setq noedit
1494                                    (replace-match-maybe-edit
1495                                     next-replacement nocasify literal
1496                                     noedit real-match-data)
1497                                    replace-count (1+ replace-count)))
1498                          (setq done t replaced t))
1499                         ((eq def 'act-and-exit)
1500                          (or replaced
1501                              (setq noedit
1502                                    (replace-match-maybe-edit
1503                                     next-replacement nocasify literal
1504                                     noedit real-match-data)
1505                                    replace-count (1+ replace-count)))
1506                          (setq keep-going nil)
1507                          (setq done t replaced t))
1508                         ((eq def 'act-and-show)
1509                          (if (not replaced)
1510                              (setq noedit
1511                                    (replace-match-maybe-edit
1512                                     next-replacement nocasify literal
1513                                     noedit real-match-data)
1514                                    replace-count (1+ replace-count)
1515                                    real-match-data (replace-match-data
1516                                                     t real-match-data)
1517                                    replaced t)))
1518                         ((eq def 'automatic)
1519                          (or replaced
1520                              (setq noedit
1521                                    (replace-match-maybe-edit
1522                                     next-replacement nocasify literal
1523                                     noedit real-match-data)
1524                                    replace-count (1+ replace-count)))
1525                          (setq done t query-flag nil replaced t))
1526                         ((eq def 'skip)
1527                          (setq done t))
1528                         ((eq def 'recenter)
1529                          (recenter nil))
1530                         ((eq def 'edit)
1531                          (let ((opos (point-marker)))
1532                            (setq real-match-data (replace-match-data
1533                                                   nil real-match-data
1534                                                   real-match-data))
1535                            (goto-char (match-beginning 0))
1536                            (save-excursion
1537                              (save-window-excursion
1538                                (recursive-edit)))
1539                            (goto-char opos)
1540                            (set-marker opos nil))
1541                          ;; Before we make the replacement,
1542                          ;; decide whether the search string
1543                          ;; can match again just after this match.
1544                          (if (and regexp-flag nonempty-match)
1545                              (setq match-again (and (looking-at search-string)
1546                                                     (match-data)))))
1547                         ;; Edit replacement.
1548                         ((eq def 'edit-replacement)
1549                          (setq real-match-data (replace-match-data
1550                                                 nil real-match-data
1551                                                 real-match-data)
1552                                next-replacement
1553                                (read-input "Edit replacement string: "
1554                                            next-replacement)
1555                                noedit nil)
1556                          (if replaced
1557                              (set-match-data real-match-data)
1558                            (setq noedit
1559                                  (replace-match-maybe-edit
1560                                   next-replacement nocasify literal noedit
1561                                   real-match-data)
1562                                  replaced t))
1563                          (setq done t))
1564
1565                         ((eq def 'delete-and-edit)
1566                          (replace-match "" t t)
1567                          (setq real-match-data (replace-match-data
1568                                                 nil real-match-data))
1569                          (replace-dehighlight)
1570                          (save-excursion (recursive-edit))
1571                          (setq replaced t))
1572                         ;; Note: we do not need to treat `exit-prefix'
1573                         ;; specially here, since we reread
1574                         ;; any unrecognized character.
1575                         (t
1576                          (setq this-command 'mode-exited)
1577                          (setq keep-going nil)
1578                          (setq unread-command-events
1579                                (append (listify-key-sequence key)
1580                                        unread-command-events))
1581                          (setq done t)))
1582                   (when query-replace-lazy-highlight
1583                     ;; Restore isearch data for lazy highlighting
1584                     ;; in case of isearching during recursive edit
1585                     (setq isearch-string search-string
1586                           isearch-regexp (or delimited-flag regexp-flag)
1587                           isearch-case-fold-search case-fold-search)
1588                     ;; Force lazy rehighlighting only after replacements
1589                     (if (not (memq def '(skip backup)))
1590                         (setq isearch-lazy-highlight-last-string nil))))
1591                 ;; Record previous position for ^ when we move on.
1592                 ;; Change markers to numbers in the match data
1593                 ;; since lots of markers slow down editing.
1594                 (push (list (point) replaced
1595 ;;; If the replacement has already happened, all we need is the
1596 ;;; current match start and end.  We could get this with a trivial
1597 ;;; match like
1598 ;;; (save-excursion (goto-char (match-beginning 0))
1599 ;;;                 (search-forward (match-string 0))
1600 ;;;                 (match-data t))
1601 ;;; if we really wanted to avoid manually constructing match data.
1602 ;;; Adding current-buffer is necessary so that match-data calls can
1603 ;;; return markers which are appropriate for editing.
1604                             (if replaced
1605                                 (list
1606                                  (match-beginning 0)
1607                                  (match-end 0)
1608                                  (current-buffer))
1609                               (match-data t)))
1610                       stack)))))
1611
1612       ;; The code preventing adjacent regexp matches in the condition
1613       ;; of the while-loop above will haven taken us one character
1614       ;; beyond the last replacement.  Undo that.
1615       (when (and regexp-flag (not match-again) (> replace-count 0))
1616         (backward-char 1))
1617
1618       (replace-dehighlight))
1619     (or unread-command-events
1620         (message "Replaced %d occurrence%s"
1621                  replace-count
1622                  (if (= replace-count 1) "" "s")))
1623     (and keep-going stack)))
1624
1625 (defvar replace-overlay nil)
1626
1627 (defun replace-highlight (beg end)
1628   (if query-replace-highlight
1629       (if replace-overlay
1630           (move-overlay replace-overlay beg end (current-buffer))
1631         (setq replace-overlay (make-overlay beg end))
1632         (overlay-put replace-overlay 'priority 1) ;higher than lazy overlays
1633         (overlay-put replace-overlay 'face 'query-replace)))
1634   (if query-replace-lazy-highlight
1635       (isearch-lazy-highlight-new-loop)))
1636
1637 (defun replace-dehighlight ()
1638   (when replace-overlay
1639     (delete-overlay replace-overlay))
1640   (when query-replace-lazy-highlight
1641     (isearch-lazy-highlight-cleanup lazy-highlight-cleanup)
1642     (setq isearch-lazy-highlight-last-string nil)))
1643
1644 ;; arch-tag: 16b4cd61-fd40-497b-b86f-b667c4cf88e4
1645 ;;; replace.el ends here