From: Alan Schmitt <alan.schmitt@polytechnique.org>
To: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: doc patch: move footnote in external links
Date: Sat, 07 Feb 2015 12:23:55 +0100 [thread overview]
Message-ID: <m21tm2q81g.fsf@charm-ecran.irisa.fr> (raw)
In-Reply-To: <87h9vrt8e9.fsf@nicolasgoaziou.fr> (Nicolas Goaziou's message of "Fri, 16 Jan 2015 09:57:05 +0100")
[-- Attachment #1.1: Type: text/plain, Size: 186 bytes --]
Hello,
Here is a new version of the patch, with some tests and a mention in
ORG-NEWS. I did not know if I should mention the ORG-NEWS change in the
Changelog (I did not).
Best,
Alan
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-Function-org-link-search-does-exact-headline-search.patch --]
[-- Type: text/x-patch, Size: 8560 bytes --]
From ea6fb4d8134b1708ae195a342b41de268453b470 Mon Sep 17 00:00:00 2001
From: Alan Schmitt <alan.schmitt@polytechnique.org>
Date: Fri, 12 Dec 2014 08:26:05 +0100
Subject: [PATCH] Function `org-link-search' does exact headline search
* lisp/org.el (org-link-search): Change headline search such that it
always does an exact search, ignoring spaces.
* testing/lisp/test-org.el (test-org/fuzzy-links): Test exact headline
match with spaces and cookies.
* doc/org.texi (External links): Cleanup footnote about the
`org-link-search-must-match-exact-headline' option for text searches
and add a footnote about the effect of the same option for heading
searches.
---
doc/org.texi | 12 +++++++----
etc/ORG-NEWS | 5 +++++
lisp/org.el | 54 +++++++++++++++++++++++++++---------------------
testing/lisp/test-org.el | 25 ++++++++++++++++++++++
4 files changed, 69 insertions(+), 27 deletions(-)
diff --git a/doc/org.texi b/doc/org.texi
index 14eaf1a..3c967be 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -3561,10 +3561,14 @@ file:projects.org::some words @r{text search in Org file}@footnote{
The actual behavior of the search will depend on the value of
the option @code{org-link-search-must-match-exact-headline}. If its value
is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
-exact headline will be matched. If the value is @code{'query-to-create},
-then an exact headline will be searched; if it is not found, then the user
-will be queried to create it.}
-file:projects.org::*task title @r{heading search in Org file}
+exact headline will be matched, ignoring spaces and cookies. If the value is
+@code{query-to-create}, then an exact headline will be searched; if it is not
+found, then the user will be queried to create it.}
+file:projects.org::*task title @r{heading search in Org
+file}@footnote{ Headline searches always match the exact headline, ignoring
+spaces and cookies. If the headline is not found and the value of the option
+@code{org-link-search-must-match-exact-headline} is @code{query-to-create},
+then the user will be queried to create it.}
file+sys:/path/to/file @r{open via OS, like double-click}
file+emacs:/path/to/file @r{force opening by Emacs}
docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 2f8d2ab..cce762e 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -218,6 +218,11 @@ The build system has been enhanced to allow test selection with a
regular expression by defining =BTEST_RE= during the test invocation.
This is especially useful during bisection to find just when a
particular test failure was introduced.
+*** Exact heading search for external links ignore spaces and cookies
+Exact heading search for links now ignore spaces and cookies. This is
+the case for links of the form ~file:projects.org::*task title~, as
+well as links of the form ~file:projects.org::some words~
+when ~org-link-search-must-match-exact-headline~ is not nil.
* Version 8.2
** Incompatible changes
diff --git a/lisp/org.el b/lisp/org.el
index a095f8d..271fe1f 100755
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -11007,8 +11007,7 @@ visibility around point, thus ignoring
org-emphasis-alist)
"\\|") "\\)"))
(pos (point))
- (pre nil) (post nil)
- words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
+ words re0 re2 re4_ re4 re5 re2a re2a_ reall)
(cond
;; First check if there are any special search functions
((run-hook-with-args-until-success 'org-execute-file-search-functions s))
@@ -11062,14 +11061,36 @@ visibility around point, thus ignoring
((derived-mode-p 'org-mode)
(org-occur (match-string 1 s)))
(t (org-do-occur (match-string 1 s)))))
- ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
- (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
+ ((and (derived-mode-p 'org-mode)
+ (or (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
+ org-link-search-must-match-exact-headline))
+ ;; Headline search
(goto-char (point-min))
(cond
((let (case-fold-search)
- (re-search-forward (format org-complex-heading-regexp-format
- (regexp-quote s))
- nil t))
+ (re-search-forward
+ (let* ((wspace "[ \t]")
+ (wspaceopt (concat wspace "*"))
+ (cookie (concat "\\(?:"
+ wspaceopt
+ "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]"
+ wspaceopt
+ "\\)"))
+ (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)")))
+ (concat
+ "^\\(\\*+\\)"
+ "\\(?: +" org-todo-regexp "\\)?"
+ "\\(?: +\\(\\[#.\\]\\)\\)?"
+ sep "*" (mapconcat #'identity
+ (org-split-string
+ (regexp-quote s))
+ (concat sep "+"))
+ sep "*"
+ (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
+ "[ \t]*$"))
+ ;; (format org-complex-heading-regexp-format
+ ;; (regexp-quote s))
+ nil t))
;; OK, found a match
(setq type 'dedicated)
(goto-char (match-beginning 0)))
@@ -11085,11 +11106,6 @@ visibility around point, thus ignoring
(error "No match"))))
(t
;; A normal search string
- (when (equal (string-to-char s) ?*)
- ;; Anchor on headlines, post may include tags.
- (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
- post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
- s (substring s 1)))
(remove-text-properties
0 (length s)
'(face nil mouse-face nil keymap nil fontified nil) s)
@@ -11106,15 +11122,9 @@ visibility around point, thus ignoring
"[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
re4 (concat "[^a-zA-Z_]" re4_)
- re1 (concat pre re2 post)
- re3 (concat pre (if pre re4_ re4) post)
- re5 (concat pre ".*" re4)
- re2 (concat pre re2)
- re2a (concat pre (if pre re2a_ re2a))
- re4 (concat pre (if pre re4_ re4))
- reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
- "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
- re5 "\\)"))
+ re5 (concat ".*" re4)
+ reall (concat "\\(" re0 "\\)\\|\\(" re2 "\\)\\|\\(" re4
+ "\\)\\|\\(" re5 "\\)"))
(cond
((eq type 'org-occur) (org-occur reall))
((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
@@ -11122,10 +11132,8 @@ visibility around point, thus ignoring
(setq type 'fuzzy)
(if (or (and (org-search-not-self 1 re0 nil t)
(setq type 'dedicated))
- (org-search-not-self 1 re1 nil t)
(org-search-not-self 1 re2 nil t)
(org-search-not-self 1 re2a nil t)
- (org-search-not-self 1 re3 nil t)
(org-search-not-self 1 re4 nil t)
(org-search-not-self 1 re5 nil t))
(goto-char (match-beginning 1))
diff --git a/testing/lisp/test-org.el b/testing/lisp/test-org.el
index 6faabdd..cd1df08 100644
--- a/testing/lisp/test-org.el
+++ b/testing/lisp/test-org.el
@@ -1331,6 +1331,31 @@
(goto-line 3)
(org-open-at-point)
(looking-at "\\* Test")))
+ ;; With a leading star in link, enforce exact heading match, even
+ ;; with `org-link-search-must-match-exact-headline' set to nil.
+ (should-error
+ (org-test-with-temp-text "* Test 1\nFoo Bar\n[[*Test]]"
+ (goto-line 3)
+ (let ((org-link-search-must-match-exact-headline nil))
+ (org-open-at-point))))
+ ;; Heading match should not care about spaces, cookies, todo
+ ;; keywords, priorities, and tags.
+ (should
+ (let ((first-line "** TODO [#A] [/] Test [1/2] [33%] 1 \t 2 [%] :work:urgent: "))
+ (org-test-with-temp-text (concat first-line "\nFoo Bar\n[[*Test 1 2]]")
+ (goto-line 3)
+ (let ((org-link-search-must-match-exact-headline nil)
+ (org-todo-regexp "TODO"))
+ (org-open-at-point))
+ (looking-at (regexp-quote first-line)))))
+ ;; Heading match should still be exact
+ (should-error
+ (let ((first-line "** TODO [#A] [/] Test [1/2] [33%] 1 \t 2 [%] :work:urgent: "))
+ (org-test-with-temp-text (concat first-line "\nFoo Bar\n[[*Test 1]]")
+ (goto-line 3)
+ (let ((org-link-search-must-match-exact-headline nil)
+ (org-todo-regexp "TODO"))
+ (org-open-at-point)))))
;; Correctly un-hexify fuzzy links.
(should
(org-test-with-temp-text "* With space\n[[*With%20space][With space]]"
--
2.2.2
[-- Attachment #1.3: Type: text/plain, Size: 44 bytes --]
--
OpenPGP Key ID : 040D0A3B4ED2E5C7
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 494 bytes --]
next prev parent reply other threads:[~2015-02-07 11:24 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-12-12 7:31 doc patch: move footnote in external links Alan Schmitt
2014-12-12 17:29 ` Nicolas Goaziou
2014-12-13 9:43 ` Alan Schmitt
2014-12-13 14:17 ` Nicolas Goaziou
2014-12-16 17:20 ` Alan Schmitt
2014-12-16 21:54 ` Nicolas Goaziou
2014-12-17 16:33 ` Alan Schmitt
2014-12-20 22:15 ` Nicolas Goaziou
2015-01-10 12:45 ` Alan Schmitt
2015-01-11 22:00 ` Nicolas Goaziou
2015-01-12 7:40 ` Alan Schmitt
2015-01-12 8:43 ` Nicolas Goaziou
2015-01-12 11:12 ` Alan Schmitt
2015-01-12 22:56 ` Nicolas Goaziou
2015-01-14 13:19 ` Alan Schmitt
2015-01-16 8:57 ` Nicolas Goaziou
2015-02-07 11:23 ` Alan Schmitt [this message]
2015-02-07 21:44 ` Nicolas Goaziou
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
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=m21tm2q81g.fsf@charm-ecran.irisa.fr \
--to=alan.schmitt@polytechnique.org \
--cc=emacs-orgmode@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 public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).