emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Eric Abrahamsen <eric@ericabrahamsen.net>
To: emacs-orgmode@gnu.org
Subject: Re: How to find the headline matching a string
Date: Sun, 01 Jun 2014 12:05:03 +0800	[thread overview]
Message-ID: <874n05e0ls.fsf@ericabrahamsen.net> (raw)
In-Reply-To: 87ha45r9hi.fsf@gmail.com

Thorsten Jolitz <tjolitz@gmail.com> writes:

> Chris Poole <lists@chrispoole.com> writes:
>
>> Eric Abrahamsen:
>>> the `org-map-entries' function can be given a scope of 'agenda
>>
>> That worked perfectly, thanks. Here's what I ended up with:
>>
>> (org-map-entries (lambda ()
>> (when (equal title (org-get-heading t t))
>> (org-entry-put (point) "TODO" "DONE")))
>> tag 'agenda)
>
> As much as I like the powerful `org-map-entries', I wonder if it will
> coexist with `org-element-map' in the future, since it does not use the
> new parser. 
>
> Whats the recommendation here? Should one rather use 
>
> ,-----------------------------------------------------------
> | (org-element-map (org-element-parse-buffer) 'headline (lambda () ...))
> `-----------------------------------------------------------
>
> nowadays, or do both functions serve different purposes, or is it just a
> matter of taste?

Interesting! I wasn't even aware of org-element-map, thanks for that.
Obviously I don't know the answer to your question, but they do seem to
do very similar things. On the other hand, `org-element-map' won't do
multiple files, and if you want to restrict to certain elements you have
to do the matching logic yourself (as opposed to `org-map-entries's
agenda-style search string).

I'd be curious, too, to hear if `org-map-entries' is going to get EOL'd
at some point. I suppose it's safe so long as `org-scan-tags' remains
the heart of the agenda process.

Here's my stab at two roughly equivalent functions, one using
org-element, the other older function. Just for the hell of it I tried
using "benchmark" to profile them, but have no idea if the results mean
much of anything. Most importantly, I don't really know if
`org-element-parse-buffer' ends up using the cache or not -- I assume
not.

(defun my-find-title-element-map (title)
  (interactive "sTitle: ")
  (let ((files (org-agenda-files))
	found)
    (dolist (f files)
      (with-current-buffer (org-get-agenda-file-buffer f)
	(org-element-map (org-element-parse-buffer 'headline)
	    'headline
	  (lambda (hl)
	    (when (string= title (org-element-property :title hl))
	      (push (move-marker (make-marker)
				 (org-element-property :begin hl))
		    found))))))
    found))


(defun my-find-title-entries-map (title)
  (interactive "sTitle: ")
  (let (found)
    (org-map-entries
     (lambda ()
       (when (string= title (org-get-heading t t))
	 (push (move-marker (make-marker)
			    (line-beginning-position))
	       found)))
     nil 'agenda)
    found))

(benchmark-run 100 (my-find-title-element-map "Unique Heading Text"))
=> (164.576821235 142 23.892782392000186)

(benchmark-run 100 (my-find-title-entries-map "Unique Heading Text"))
=> (58.111630133 36 6.047778745000016)

This isn't quite an idle inquiry: part of Gnorb does exactly this
(scanning all agenda files for headings with a certain property value).
While using `org-map-entries' in an interactive function is currently
good enough, I'd eventually like to have it happen more often, and
quickly, in non-interactive functions. I was considering making my own
mini-cache, but if `org-element-map' can do it, and do it quickly
(presumably using the cache), I'd much prefer using that.

Thanks,
Eric

  reply	other threads:[~2014-06-01  4:01 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-05-31 15:07 How to find the headline matching a string Chris Poole
2014-05-31 15:27 ` Eric Abrahamsen
2014-05-31 16:51   ` Chris Poole
2014-05-31 17:00     ` Igor Sosa Mayor
2014-05-31 17:31       ` Chris Poole
2014-05-31 17:53         ` Igor Sosa Mayor
2014-05-31 20:14     ` Thorsten Jolitz
2014-06-01  4:05       ` Eric Abrahamsen [this message]
2014-06-03  9:05         ` Thorsten Jolitz
2014-06-03  9:51           ` Eric Abrahamsen
2014-06-03 20:21             ` Nicolas Goaziou
2014-06-04  1:36               ` Eric Abrahamsen
2014-06-04 11:27                 ` Thorsten Jolitz

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=874n05e0ls.fsf@ericabrahamsen.net \
    --to=eric@ericabrahamsen.net \
    --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).