emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Thorsten Jolitz <tjolitz@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: Programming with org-element-cache -> short introduction?
Date: Mon, 11 Aug 2014 15:50:42 +0200	[thread overview]
Message-ID: <87fvh3m8y5.fsf@gmail.com> (raw)
In-Reply-To: 87iolzp3nf.fsf@nicolasgoaziou.fr

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

Hello,

> Thorsten Jolitz <tjolitz@gmail.com> writes:
>
>> when programming with Org elements sometimes things seem to work and
>> then something strange happens - what smells like a cache problem. I
>> don't mean a cache bug, but a programmer (me) not taking the cache
>> into account the right way.
>
> It might also be a cache problem. Do not hesitate to report it.

Ok

>> Is there a short introduction somewhere about the 'todos' and 'nogos' in
>> programming with elements wrt to the org-element-cache?
>
> The only "nogo" is to never modify (destructively) a value returned by
> `org-element-at-point' or `org-element-context'. Consider their return
> value as read-only, and possibly invalid as soon as you modify the
> buffer.

This one directly applies to my use-case (wrt `org-element-at-point'). 
Is it ok to do these two things:

 - let-bind a value returned by `org-element-at-point' and modify it (with
   plist-put), and 

   1. then return the interpreted value or

   2. do (delete-region ...) on old element and then insert the
      (interpreted) new one?

 - globally set a value returned by `org-element-at-point', modify it
   (with plist-put) in a function call, but use the variable as a quoted
   (!) function arg and reset the original value with this trick:
   
   #+begin_src emacs-lisp
     (setq X (org-element-at-point))

     (defun foo (element &optional replace-p)
       (let ((elem (eval element)))
         [...destructively modify elem...]
         [...interpret elem ...]
         (when replace-p
           [...delete old-element ...]
           [...insert interpreted elem, goto beg ...]
           (set element (org-element-at-point)))))

     (foo 'X t)
   #+end_src

> These advices don't apply to `org-element-parse-buffer', which doesn't
> use cache (if it did, it should copy cached elements beforehand anyway).

Ok

-- 
cheers,
Thorsten

next prev parent reply	other threads:[~2014-08-11 13:51 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-08-10  0:47 Programming with org-element-cache -> short introduction? Thorsten Jolitz
2014-08-11 13:16 ` Nicolas Goaziou
2014-08-11 13:50   ` Thorsten Jolitz [this message]
2014-08-11 14:22     ` 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=87fvh3m8y5.fsf@gmail.com \
    --to=tjolitz@gmail.com \
    --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

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).