From: daanturo <daanturo@gmail.com>
To: emacs-devel@gnu.org
Subject: A function to take the regexp-matched subsring directly
Date: Sun, 30 Oct 2022 22:17:00 +0700 [thread overview]
Message-ID: <d7cf5a87-b427-fa3f-a3dd-c370689b8204@gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 365 bytes --]
How do you think about such a built-in functionality?
I find myself using them in parsing strings alot, most of the time I
just care about whether a particular matched (sub-)expression or not:
Does it match? Yes? Good, throw me result, else give me null.
The implementation is attached. I name it 'regexp-match' (please
change the name if needed).
--
Daanturo.
[-- Attachment #2: 0001-Define-regexp-match-regexp-match.patch --]
[-- Type: text/x-patch, Size: 4453 bytes --]
From dc788fca8def8c17f901ec5d72ff38d6716dc6ce Mon Sep 17 00:00:00 2001
From: Daanturo <daanturo@gmail.com>
Date: Sun, 30 Oct 2022 21:54:56 +0700
Subject: [PATCH] Define regexp-match, regexp-match*
* lisp/emacs-lisp/subr-x.el: implementation
* doc/lispref/searching.texi: documents
* etc/NEWS: documents
* lisp/emacs-lisp/shortdoc.el: documents
---
doc/lispref/searching.texi | 32 ++++++++++++++++++++++++++++++++
etc/NEWS | 7 +++++++
lisp/emacs-lisp/shortdoc.el | 4 ++++
lisp/emacs-lisp/subr-x.el | 27 +++++++++++++++++++++++++++
4 files changed, 70 insertions(+)
diff --git a/doc/lispref/searching.texi b/doc/lispref/searching.texi
index 743718b560..e4cecd858a 100644
--- a/doc/lispref/searching.texi
+++ b/doc/lispref/searching.texi
@@ -2099,6 +2099,38 @@ This predicate function does what @code{string-match} does, but it
avoids modifying the match data.
@end defun
+@defun regexp-match regexp string &optional n
+This function returns the n-th matched substring for regexp in string.
+N defaults to 0 (the whole match). It does not modify the match data.
+
+@example
+@group
+(regexp-match "quick" "The quick brown fox jumped quickly.")
+ @result{} "quick"
+@end group
+@group
+(regexp-match "quick[[:space:]]+\\([a-z]+\\)" "The quick brown fox jumped quickly." 1)
+ @result{} "brown"
+@end group
+@end example
+
+@end defun
+
+
+@defun regexp-match* regexp string
+This function returns list of matched substrings for regexp
+in string. It does not modify the match data.
+
+@example
+@group
+(regexp-match* "quick[[:space:]]+\\([a-z]+\\)" "The quick brown fox jumped quickly.")
+ @result{} ("quick brown" "brown")
+@end group
+@end example
+
+@end defun
+
+
@defun looking-at regexp &optional inhibit-modify
This function determines whether the text in the current buffer directly
following point matches the regular expression @var{regexp}. ``Directly
diff --git a/etc/NEWS b/etc/NEWS
index a185967483..6faee7251e 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -3198,6 +3198,13 @@ The following generalized variables have been made obsolete:
\f
* Lisp Changes in Emacs 29.1
++++
+** New function 'regexp-match', 'regexp-match*'.
+'regexp-match' can be used to extract the substring that matches a
+wanted subexpression from a string, while 'regexp-match*' returns
+the corresponding substring for each subexpression. Both don't change
+the match data
+
+++
** Interpreted closures are "safe for space".
As was already the case for byte-compiled closures, instead of capturing
diff --git a/lisp/emacs-lisp/shortdoc.el b/lisp/emacs-lisp/shortdoc.el
index dbac03432c..81e6168217 100644
--- a/lisp/emacs-lisp/shortdoc.el
+++ b/lisp/emacs-lisp/shortdoc.el
@@ -781,6 +781,10 @@ A FUNC form can have any number of `:no-eval' (or `:no-value'),
:eg-result 3)
(save-match-data
:no-eval (save-match-data ...))
+ (regexp-match
+ :eval (regexp-match "^\\([fo]+\\)b" "foobar" 1))
+ (regexp-match*
+ :eval (regexp-match* "^\\([fo]+\\)b" "foobar"))
"Replacing Match"
(replace-match
:no-eval (replace-match "new")
diff --git a/lisp/emacs-lisp/subr-x.el b/lisp/emacs-lisp/subr-x.el
index 6e4d88b4df..ba57fe1cb7 100644
--- a/lisp/emacs-lisp/subr-x.el
+++ b/lisp/emacs-lisp/subr-x.el
@@ -347,6 +347,33 @@ This takes into account combining characters and grapheme clusters."
(setq start (1+ start))))
(nreverse result)))
+;;;###autoload
+(defun regexp-match (regexp string &optional n)
+ "Return the N -th matched substring for REGEXP in STRING.
+N defaults to 0 (the whole match).
+
+This function does not change the match data."
+ (declare (pure t) (side-effect-free t))
+ (let ((n (or n 0)))
+ (save-match-data
+ (when (string-match regexp string)
+ (match-string n string)))))
+
+;;;###autoload
+(defun regexp-match* (regexp string)
+ "Return a list of matched substrings for REGEXP in STRING.
+
+This function does not change the match data."
+ (declare (pure t) (side-effect-free t))
+ (save-match-data
+ (when (string-match regexp string)
+ (let ((match-index (1- (/ (length (match-data)) 2)))
+ matches)
+ (while (<= 0 match-index)
+ (push (match-string match-index string) matches)
+ (setq match-index (1- match-index)))
+ matches))))
+
;;;###autoload
(defun add-display-text-property (start end prop value
&optional object)
--
2.38.1
next reply other threads:[~2022-10-30 15:17 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-30 15:17 daanturo [this message]
2022-10-30 15:45 ` A function to take the regexp-matched subsring directly Philip Kaludercic
2022-10-30 16:46 ` daanturo
2022-10-30 17:26 ` Philip Kaludercic
2022-10-30 15:52 ` Stefan Monnier
2022-10-30 17:16 ` daanturo
2022-10-30 22:01 ` Stefan Monnier
2022-10-31 3:47 ` daanturo
2022-10-30 17:29 ` Philip Kaludercic
2022-10-30 22:07 ` Stefan Monnier
2022-10-31 8:56 ` Mattias Engdegård
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=d7cf5a87-b427-fa3f-a3dd-c370689b8204@gmail.com \
--to=daanturo@gmail.com \
--cc=emacs-devel@gnu.org \
/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.