Package: emacs;
Reported by: Michal Nazarewicz <mina86 <at> mina86.com>
Date: Thu, 5 Jun 2014 11:25:01 UTC
Severity: minor
Fixed in version 25.1
Done: Michal Nazarewicz <mina86 <at> mina86.com>
Bug is archived. No further changes may be made.
View this message in rfc822 format
From: Michal Nazarewicz <mina86 <at> mina86.com> To: 17699 <at> debbugs.gnu.org Subject: bug#17699: [PATCH 2/7] tildify.el: Fix matched group indexes in end-regex building Date: Thu, 5 Jun 2014 13:27:31 +0200
* lisp/textmodes/tildifi.el (tildify-find-env): When looking for
a start of an ignore-environment, the regex is built by
concatenating regexes of all the environments configured in
`tildify-ignored-environments-alist'. So for example, the following
list could be used to match TeX's \verb and \verb* commands:
(("\\\\verb\\(.\\)" . (1))
("\\\\verb\\*\\(.\\)" . (1)))
This would result in the following regex being used to find the start
of any of the variants of the \verb command:
\\\\verb\\(.\\)\\|\\\\verb\\*\\(.\\)
But now, if “\\\\verb\\*\\(.\\)” matches, the first capture group
won't match anything, and thus (match-string 1) will be nil, which
will cause building of the end-matching regex to fail.
Fix this by using capture groups from the time when the opening
regexes are matched individually.
* tests/automated/tildify-tests.el (tildify-test-find-env-group-index-bug):
New test validating fix to the above bug.
---
lisp/ChangeLog | 23 +++++++++++++++++++++++
lisp/textmodes/tildify.el | 30 +++++++++++++++---------------
test/ChangeLog | 4 ++++
test/automated/tildify-tests.el | 12 ++++++++++++
4 files changed, 54 insertions(+), 15 deletions(-)
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index dc3c42a..523b2a9 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,28 @@
2014-06-05 Michal Nazarewicz <mina86 <at> mina86.com>
+ * textmodes/tildify.el (tildify-find-env): Fix matched group
+ indexes in end-regex building
+
+ When looking for a start of an ignore-environment, the regex is built
+ by concatenating regexes of all the environments configured in
+ `tildify-ignored-environments-alist'. So for example, the following
+ list could be used to match TeX's \verb and \verb* commands:
+
+ (("\\\\verb\\(.\\)" . (1))
+ ("\\\\verb\\*\\(.\\)" . (1)))
+
+ This would result in the following regex being used to find the start
+ of any of the variants of the \verb command:
+
+ \\\\verb\\(.\\)\\|\\\\verb\\*\\(.\\)
+
+ But now, if “\\\\verb\\*\\(.\\)” matches, the first capture group
+ won't match anything, and thus (match-string 1) will be nil, which
+ will cause building of the end-matching regex to fail.
+
+ Fix this by using capture groups from the time when the opening
+ regexes are matched individually.
+
* textmodes/tildify.el (tildify-find-env): Fix end-regex building
in `tildify-find-env'
diff --git a/lisp/textmodes/tildify.el b/lisp/textmodes/tildify.el
index 7e4b39b..7aa338e 100644
--- a/lisp/textmodes/tildify.el
+++ b/lisp/textmodes/tildify.el
@@ -271,22 +271,22 @@ Return regexp for the end of the environment or nil if no environment was
found."
;; Find environment
(when (re-search-forward regexp nil t)
- ;; Build end-env regexp
- (let ((match (match-string 0))
- (alist (tildify-mode-alist tildify-ignored-environments-alist)))
- (save-match-data
+ (save-match-data
+ ;; Build end-env regexp
+ (let ((match (match-string 0))
+ (alist (tildify-mode-alist tildify-ignored-environments-alist)))
(while (not (eq (string-match (caar alist) match) 0))
- (setq alist (cdr alist))))
- (let ((expression (cdar alist)))
- (if (stringp expression)
- expression
- (mapconcat
- (lambda (expr)
- (if (stringp expr)
- expr
- (regexp-quote (match-string expr))))
- expression
- ""))))))
+ (setq alist (cdr alist)))
+ (let ((expression (cdar alist)))
+ (if (stringp expression)
+ expression
+ (mapconcat
+ (lambda (expr)
+ (if (stringp expr)
+ expr
+ (regexp-quote (match-string expr match))))
+ expression
+ "")))))))
(defun tildify-tildify (beg end ask)
"Add tilde characters in the region between BEG and END.
diff --git a/test/ChangeLog b/test/ChangeLog
index db32aae..93ef098 100644
--- a/test/ChangeLog
+++ b/test/ChangeLog
@@ -1,5 +1,9 @@
2014-06-05 Michal Nazarewicz <mina86 <at> mina86.com>
+ * automated/tildify-tests.el (tildify-test-find-env-group-index-bug):
+ New test checking end-regex building when multiple environment pairs
+ use integers to refer to capture groups.
+
* automated/tildify-tests.el (tildify-test-find-env-end-re-bug): New
test checking end-regex building in `tildify-find-env' function when
integers (denoting capture groups) and strings are mixed together.
diff --git a/test/automated/tildify-tests.el b/test/automated/tildify-tests.el
index 25e9f22..6fee28b 100644
--- a/test/automated/tildify-tests.el
+++ b/test/automated/tildify-tests.el
@@ -112,6 +112,18 @@ latter is missing, SENTENCE will be used in all placeholder positions."
(should (string-equal "end-foo" (tildify-find-env "foo\\|bar"))))))
+(ert-deftest tildify-test-find-env-group-index-bug ()
+ "Tests generation of match-string indexes"
+ (with-temp-buffer
+ (let ((tildify-ignored-environments-alist
+ `((,major-mode ("start-\\(foo\\|bar\\)" . ("end-" 1))
+ ("open-\\(foo\\|bar\\)" . ("close-" 1)))))
+ (beg-re "start-\\(foo\\|bar\\)\\|open-\\(foo\\|bar\\)"))
+ (insert "open-foo whatever close-foo")
+ (goto-char (point-min))
+ (should (string-equal "close-foo" (tildify-find-env beg-re))))))
+
+
(provide 'tildify-tests)
;;; tildify-tests.el ends here
--
2.0.0.526.g5318336
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.