From: Tino Calancha <tino.calancha@gmail.com>
To: Juri Linkov <juri@linkov.net>
Cc: Emacs developers <emacs-devel@gnu.org>,
Tino Calancha <tino.calancha@gmail.com>
Subject: Re: [patch] Run occur command restricted to a region
Date: Sun, 22 Jan 2017 19:32:35 +0900 [thread overview]
Message-ID: <87fukb2xmk.fsf@gmail.com> (raw)
In-Reply-To: <8760l9wcci.fsf@mail.linkov.net> (Juri Linkov's message of "Sat, 21 Jan 2017 01:17:17 +0200")
Juri Linkov <juri@linkov.net> writes:
>> OK. Updated the patch.
>> *) First patch allow `occur' handle the region with the new convention,
>> i.e., region argument instead of BEG, END.
>
> Thanks. As a prerequisite I'm going to install this patch:
> +(defun region-bounds ()
> + "Return the boundaries of the region as a list of (START . END) positions."
> + (funcall region-extract-function 'bounds))
> +
> (defvar region-insert-function
> (lambda (lines)
> (let ((first t))
Thank you.
>> **) The second patch add your suggestion on showing highlighted the
>> current line. When there are matches after the current line, the
>> point in *Occur* is set right after such line.
>>
>> I am fine with just adding *). In case we also want **),
>> an option to enable/disable that behaviour might be desirable.
>
> Keeping traditional behaviour means not jumping to the middle of the
> *Occur* output by default. Then maybe we could use the same option
> to highlight the current line and to jump to it? Like the existing
> ‘list-matching-lines-buffer-name-face’, adding a nil/face choice for
> ‘list-matching-lines-current-line-face’, so when it's nil then don't
> highlight/jump?
OK, why not?
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
From c9a6891187de8c4df6294777ea745810d405b07a Mon Sep 17 00:00:00 2001
From: Tino Calancha <tino.calancha@gmail.com>
Date: Sun, 22 Jan 2017 19:12:35 +0900
Subject: [PATCH 1/2] Allow occur command to operate on the region
See discussion in:
https://lists.gnu.org/archive/html/emacs-devel/2016-12/msg01084.html
* lisp/replace.el (occur--region-start, occur--region-end)
(occur--matches-threshold): New variables.
(occur-engine): Use them.
(occur): Idem.
Add optional arg REGION; if non-nil occur applies in that region.
* doc/lispintro/emacs-lisp-intro.texi (Keybindings): Update manual
* doc/emacs/search.texi (Other Repeating Search: Idem.
; etc/NEWS: Add entry to announce the change.
---
doc/emacs/search.texi | 3 +++
doc/lispintro/emacs-lisp-intro.texi | 8 ++++---
etc/NEWS | 2 ++
lisp/replace.el | 46 +++++++++++++++++++++++++++++++------
4 files changed, 49 insertions(+), 10 deletions(-)
diff --git a/doc/emacs/search.texi b/doc/emacs/search.texi
index b728258973..28e25bec43 100644
--- a/doc/emacs/search.texi
+++ b/doc/emacs/search.texi
@@ -1672,6 +1672,9 @@ Other Repeating Search
no upper-case letters and @code{case-fold-search} is non-@code{nil}.
Aside from @code{occur} and its variants, all operate on the text from
point to the end of the buffer, or on the region if it is active.
+The command @code{occur} will operate on the region if
+it is active as well; when the region is not active, @code{occur}
+operates in the whole buffer.
@findex list-matching-lines
@findex occur
diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi
index 830c072cf5..36d767737d 100644
--- a/doc/lispintro/emacs-lisp-intro.texi
+++ b/doc/lispintro/emacs-lisp-intro.texi
@@ -17151,9 +17151,11 @@ Keybindings
@findex occur
The @code{occur} command shows all the lines in the current buffer
-that contain a match for a regular expression. Matching lines are
-shown in a buffer called @file{*Occur*}. That buffer serves as a menu
-to jump to occurrences.
+that contain a match for a regular expression. When the region is
+active, @code{occur} restricts matches to such region. Otherwise it
+uses the entire buffer.
+Matching lines are shown in a buffer called @file{*Occur*}.
+That buffer serves as a menu to jump to occurrences.
@findex global-unset-key
@cindex Unbinding key
diff --git a/etc/NEWS b/etc/NEWS
index ca66df6261..9eb5d82099 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -310,6 +310,8 @@ substituted by a home directory by writing it as "/foo:/:/~/file".
\f
* Editing Changes in Emacs 26.1
+
+** The 'occur' command can now operate on the region.
+++
** New bindings for 'query-replace-map'.
'undo', undo the last replacement; bound to 'u'.
diff --git a/lisp/replace.el b/lisp/replace.el
index ff91734445..00e73157ff 100644
--- a/lisp/replace.el
+++ b/lisp/replace.el
@@ -1360,7 +1360,12 @@ occur-rename-buffer
"*")
(or unique-p (not interactive-p)))))
-(defun occur (regexp &optional nlines)
+;; Region limits when `occur' applies on a region.
+(defvar occur--region-start nil)
+(defvar occur--region-end nil)
+(defvar occur--matches-threshold nil)
+
+(defun occur (regexp &optional nlines region)
"Show all lines in the current buffer containing a match for REGEXP.
If a match spreads across multiple lines, all those lines are shown.
@@ -1369,6 +1374,10 @@ occur
NLINES defaults to `list-matching-lines-default-context-lines'.
Interactively it is the prefix arg.
+Optional arg REGION, if non-nil, mean restrict search to the
+specified region. Otherwise search the entire buffer.
+When REGION is non-nil, it must be a cons (START . END).
+
The lines are shown in a buffer named `*Occur*'.
It serves as a menu to find any of the occurrences in this buffer.
\\<occur-mode-map>\\[describe-mode] in that buffer will explain how.
@@ -1386,8 +1395,24 @@ occur
program. When there is no parenthesized subexpressions in REGEXP
the entire match is collected. In any case the searched buffer
is not modified."
- (interactive (occur-read-primary-args))
- (occur-1 regexp nlines (list (current-buffer))))
+ (interactive
+ (nconc (occur-read-primary-args)
+ (and (use-region-p) (region-bounds))))
+ (let* ((start (car region))
+ (end (cdr region))
+ (in-region-p (or start end)))
+ (when in-region-p
+ (or start (setq start (point-min)))
+ (or end (setq end (point-max))))
+ (let ((occur--region-start start)
+ (occur--region-end end)
+ (occur--matches-threshold
+ (and in-region-p
+ (line-number-at-pos (min start end)))))
+ (save-excursion ; If no matches `occur-1' doesn't restore the point.
+ (and in-region-p (narrow-to-region start end))
+ (occur-1 regexp nlines (list (current-buffer)))
+ (and in-region-p (widen))))))
(defvar ido-ignore-item-temp-list)
@@ -1545,13 +1570,15 @@ occur-engine
(let ((global-lines 0) ;; total count of matching lines
(global-matches 0) ;; total count of matches
(coding nil)
- (case-fold-search case-fold))
+ (case-fold-search case-fold)
+ (in-region-p (and occur--region-start occur--region-end)))
;; Map over all the buffers
(dolist (buf buffers)
(when (buffer-live-p buf)
(let ((lines 0) ;; count of matching lines
(matches 0) ;; count of matches
- (curr-line 1) ;; line count
+ (curr-line ;; line count
+ (or occur--matches-threshold 1))
(prev-line nil) ;; line number of prev match endpt
(prev-after-lines nil) ;; context lines of prev match
(matchbeg 0)
@@ -1684,7 +1711,7 @@ occur-engine
(let ((beg (point))
end)
(insert (propertize
- (format "%d match%s%s%s in buffer: %s\n"
+ (format "%d match%s%s%s in buffer: %s%s\n"
matches (if (= matches 1) "" "es")
;; Don't display the same number of lines
;; and matches in case of 1 match per line.
@@ -1694,7 +1721,12 @@ occur-engine
;; Don't display regexp for multi-buffer.
(if (> (length buffers) 1)
"" (occur-regexp-descr regexp))
- (buffer-name buf))
+ (buffer-name buf)
+ (if in-region-p
+ (format " within region: %d-%d"
+ occur--region-start
+ occur--region-end)
+ ""))
'read-only t))
(setq end (point))
(add-text-properties beg end `(occur-title ,buf))
--
2.11.0
From 31b578636731c0a67dc64aad8d880d82d7c8804d Mon Sep 17 00:00:00 2001
From: Tino Calancha <tino.calancha@gmail.com>
Date: Sun, 22 Jan 2017 19:25:34 +0900
Subject: [PATCH 2/2] Show current line highlighted in *Occur* buffer
* lisp/replace.el (occur-current-line-face): New face.
(list-matching-lines-current-line-face): New user option.
(occur--orig-line, occur--orig-line-str): New variables.
(occur, occur-engine): Use them.
(occur--final-pos): New variable.
(occur-1): Use it.
(occur-engine): Idem.
Show the current line with 'occur-current-line-face'.
Set point on the first matching line after the current one.
* etc/NEWS: Add entry for the new option.
---
etc/NEWS | 3 +++
lisp/replace.el | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++----
2 files changed, 70 insertions(+), 5 deletions(-)
diff --git a/etc/NEWS b/etc/NEWS
index 9eb5d82099..ff8246506d 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -311,6 +311,9 @@ substituted by a home directory by writing it as "/foo:/:/~/file".
* Editing Changes in Emacs 26.1
+** A new user option 'list-matching-lines-current-line-face'
+to show highlighted the current line in the *Occur* buffer.
+
** The 'occur' command can now operate on the region.
+++
** New bindings for 'query-replace-map'.
diff --git a/lisp/replace.el b/lisp/replace.el
index 00e73157ff..3de09b48cc 100644
--- a/lisp/replace.el
+++ b/lisp/replace.el
@@ -1081,6 +1081,12 @@ occur-mode-find-occurrence-hook
:type 'hook
:group 'matching)
+(defface occur-current-line-face
+ '((t (:inherit lazy-highlight)))
+ "Face for highlighting the current line in *Occur* buffer."
+ :group 'matching
+ :version "26.1")
+
(put 'occur-mode 'mode-class 'special)
(define-derived-mode occur-mode special-mode "Occur"
"Major mode for output from \\[occur].
@@ -1304,6 +1310,13 @@ list-matching-lines-buffer-name-face
:type 'face
:group 'matching)
+(defcustom list-matching-lines-current-line-face nil
+ "If non-nil, \\[list-matching-lines] shows the current line highlighted.
+Set the point right after such line when there are matches after it."
+ :type '(choice (const :tag "Unset" nil)
+ (const :tag "highlight current line" occur-current-line-face))
+ :group 'matching)
+
(defcustom list-matching-lines-prefix-face 'shadow
"Face used by \\[list-matching-lines] to show the prefix column.
If the face doesn't differ from the default face,
@@ -1364,6 +1377,9 @@ occur-rename-buffer
(defvar occur--region-start nil)
(defvar occur--region-end nil)
(defvar occur--matches-threshold nil)
+(defvar occur--orig-line nil)
+(defvar occur--orig-line-str nil)
+(defvar occur--final-pos nil)
(defun occur (regexp &optional nlines region)
"Show all lines in the current buffer containing a match for REGEXP.
@@ -1381,6 +1397,9 @@ occur
The lines are shown in a buffer named `*Occur*'.
It serves as a menu to find any of the occurrences in this buffer.
\\<occur-mode-map>\\[describe-mode] in that buffer will explain how.
+If `list-matching-lines-current-line-face' is non-nil, then show highlighted
+the current line; if there are matches after it, then set the
+point right after such line.
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
@@ -1408,7 +1427,13 @@ occur
(occur--region-end end)
(occur--matches-threshold
(and in-region-p
- (line-number-at-pos (min start end)))))
+ (line-number-at-pos (min start end))))
+ (occur--orig-line
+ (line-number-at-pos (point)))
+ (occur--orig-line-str
+ (buffer-substring-no-properties
+ (line-beginning-position)
+ (line-end-position))))
(save-excursion ; If no matches `occur-1' doesn't restore the point.
(and in-region-p (narrow-to-region start end))
(occur-1 regexp nlines (list (current-buffer)))
@@ -1507,7 +1532,8 @@ occur-1
(occur-mode))
(let ((inhibit-read-only t)
;; Don't generate undo entries for creation of the initial contents.
- (buffer-undo-list t))
+ (buffer-undo-list t)
+ (occur--final-pos nil))
(erase-buffer)
(let ((count
(if (stringp nlines)
@@ -1559,6 +1585,10 @@ occur-1
(if (= count 0)
(kill-buffer occur-buf)
(display-buffer occur-buf)
+ (when occur--final-pos
+ (set-window-point
+ (get-buffer-window occur-buf 'all-frames)
+ occur--final-pos))
(setq next-error-last-buffer occur-buf)
(setq buffer-read-only t)
(set-buffer-modified-p nil)
@@ -1571,7 +1601,8 @@ occur-engine
(global-matches 0) ;; total count of matches
(coding nil)
(case-fold-search case-fold)
- (in-region-p (and occur--region-start occur--region-end)))
+ (in-region-p (and occur--region-start occur--region-end))
+ (multi-occur-p (cdr buffers)))
;; Map over all the buffers
(dolist (buf buffers)
(when (buffer-live-p buf)
@@ -1579,12 +1610,16 @@ occur-engine
(matches 0) ;; count of matches
(curr-line ;; line count
(or occur--matches-threshold 1))
+ (orig-line occur--orig-line)
+ (orig-line-str occur--orig-line-str)
+ (orig-line-shown-p)
(prev-line nil) ;; line number of prev match endpt
(prev-after-lines nil) ;; context lines of prev match
(matchbeg 0)
(origpt nil)
(begpt nil)
(endpt nil)
+ (finalpt nil)
(marker nil)
(curstring "")
(ret nil)
@@ -1685,6 +1720,18 @@ occur-engine
(nth 0 ret))))
;; Actually insert the match display data
(with-current-buffer out-buf
+ (when (and list-matching-lines-current-line-face
+ (not multi-occur-p)
+ (not orig-line-shown-p)
+ (>= curr-line orig-line))
+ (insert
+ (concat
+ (propertize
+ (format "%7d:%s" orig-line orig-line-str)
+ 'face 'occur-current-line-face
+ 'mouse-face 'mode-line-highlight
+ 'help-echo "Current line") "\n"))
+ (setq orig-line-shown-p t finalpt (point)))
(insert data)))
(goto-char endpt))
(if endpt
@@ -1698,6 +1745,18 @@ occur-engine
(forward-line 1))
(goto-char (point-max)))
(setq prev-line (1- curr-line)))
+ ;; Insert original line if haven't done yet.
+ (when (and list-matching-lines-current-line-face
+ (not multi-occur-p)
+ (not orig-line-shown-p))
+ (with-current-buffer out-buf
+ (insert
+ (concat
+ (propertize
+ (format "%7d:%s" orig-line orig-line-str)
+ 'face 'occur-current-line-face
+ 'mouse-face 'mode-line-highlight
+ 'help-echo "Current line") "\n"))))
;; Flush remaining context after-lines.
(when prev-after-lines
(with-current-buffer out-buf
@@ -1731,8 +1790,11 @@ occur-engine
(setq end (point))
(add-text-properties beg end `(occur-title ,buf))
(when title-face
- (add-face-text-property beg end title-face)))
- (goto-char (point-min)))))))
+ (add-face-text-property beg end title-face))
+ (goto-char (if finalpt
+ (setq occur--final-pos
+ (cl-incf finalpt (- end beg)))
+ (point-min)))))))))
;; Display total match count and regexp for multi-buffer.
(when (and (not (zerop global-lines)) (> (length buffers) 1))
(goto-char (point-min))
--
2.11.0
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
In GNU Emacs 26.0.50.1 (x86_64-pc-linux-gnu, GTK+ Version 3.22.6)
of 2017-01-22
Repository revision: 0a49f158f1598fb92989f3cbdc238a7e5f1bd8a3
next prev parent reply other threads:[~2017-01-22 10:32 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-29 6:36 [patch] Run occur command restricted to a region Tino Calancha
2016-12-29 16:10 ` Eli Zaretskii
2016-12-29 16:54 ` Tino Calancha
2016-12-29 18:16 ` Drew Adams
2016-12-29 18:50 ` Kaushal Modi
2016-12-29 20:52 ` Drew Adams
2016-12-30 2:57 ` Tino Calancha
2017-01-03 17:37 ` Region argument (was: [patch] Run occur command restricted to a region) Stefan Monnier
2017-01-03 18:34 ` Eli Zaretskii
2017-01-03 18:59 ` Region argument Stefan Monnier
2017-01-03 19:19 ` Eli Zaretskii
2017-01-04 0:57 ` Juri Linkov
2016-12-29 23:31 ` [patch] Run occur command restricted to a region Juri Linkov
2016-12-30 2:47 ` Tino Calancha
2016-12-30 23:20 ` Juri Linkov
2016-12-30 7:53 ` Eli Zaretskii
2016-12-30 23:16 ` Juri Linkov
2016-12-31 8:37 ` Eli Zaretskii
[not found] ` <87r34ozq20.fsf@gmail.com>
[not found] ` <87inq0xhiw.fsf@mail.linkov.net>
[not found] ` <alpine.DEB.2.20.1701011834290.1852@calancha-pc>
[not found] ` <87d1g55h8d.fsf@mail.linkov.net>
2017-01-03 10:19 ` Tino Calancha
2017-01-18 11:04 ` Tino Calancha
2017-01-19 23:51 ` Juri Linkov
2017-01-20 13:48 ` Tino Calancha
2017-01-20 16:46 ` Davis Herring
2017-01-20 23:17 ` Juri Linkov
2017-01-22 10:32 ` Tino Calancha [this message]
2017-01-22 23:50 ` Juri Linkov
2017-01-23 7:32 ` Tino Calancha
[not found] ` <87lgtu4w5c.fsf@mail.linkov.net>
2017-01-29 6:00 ` Tino Calancha
2017-01-30 0:09 ` Juri Linkov
2017-01-30 4:27 ` Tino Calancha
2017-01-30 4:48 ` Tino Calancha
2017-01-30 15:35 ` Eli Zaretskii
2017-02-02 10:22 ` Tino Calancha
2017-02-02 21:08 ` Eli Zaretskii
2017-02-03 3:11 ` Tino Calancha
2017-02-03 8:02 ` Eli Zaretskii
2017-02-03 10:04 ` CONTRIBUTE: Mention indexing new vars/commands in manual [was: Run occur command restricted to a region] Tino Calancha
2017-02-03 10:37 ` Eli Zaretskii
2017-02-03 11:02 ` Tino Calancha
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87fukb2xmk.fsf@gmail.com \
--to=tino.calancha@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=juri@linkov.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.