Add caching to org-buffer-property-keys

Add caching to org-buffer-property-keys

[Karl Voit]

Hi!

In short: can we get a cached org-buffer-property-keys please?


My background story:

I love using following function which gives me a neat functionality:
I mark a string, press the keybinding shortcut, and gets asked which
property should be replaced/filled with the marked region text.

Very handy when you've got a new phone number of a contact which
should find its way to the associated property.

(defun my-org-region-to-property (&optional property)
  (interactive)
  ;; if no region is defined, do nothing
  (if (use-region-p)
      ;; if a region string is found, ask for a property and set property to
      ;; the string in the region
      (let ((val (replace-regexp-in-string
                  "\\`[ \t\n]*" ""
                  (replace-regexp-in-string "[ \t\n]*\\'" ""
                                            (substring (buffer-string)
                                                       (- (region-beginning) 1)
                                                       (region-end))))
                 )
            ;; if none was stated by user, read property from user
            (prop (or property
                      (org-read-property-name))))
        ;; set property
        (org-set-property prop val))))

A big drawback is that I have to wait 18 seconds(!) until
org-read-property-name which calls org-buffer-property-keys asks for
the property. This is a real show stopper for this cool function.

Since the properties of a buffer do not change that often, caching
its previous result would make sense to me. This way, I only have to
wait 18 seconds once per file on the first call.

An alternative would be a org-read-property-name which uses only the
properties of the current heading.


Thanks for your support!

-- 
mail|git|SVN|photos|postings|SMS|phonecalls|RSS|CSV|XML to Org-mode:
       > get Memacs from https://github.com/novoid/Memacs <

https://github.com/novoid/extract_pdf_annotations_to_orgmode + more on github

Re: Add caching to org-buffer-property-keys

[Thierry Banel]

Nice function!
Maybe a rewrite of (org-read-property-name) calling
(org-entry-properties) could speed up things.
(org-entry-properties) returns an assoc list of the local header properties.

Le 02/03/2016 12:29, Karl Voit a écrit :
> Hi!
>
> In short: can we get a cached org-buffer-property-keys please?
>
>
> My background story:
>
> I love using following function which gives me a neat functionality:
> I mark a string, press the keybinding shortcut, and gets asked which
> property should be replaced/filled with the marked region text.
>
> Very handy when you've got a new phone number of a contact which
> should find its way to the associated property.
>
> (defun my-org-region-to-property (&optional property)
>   (interactive)
>   ;; if no region is defined, do nothing
>   (if (use-region-p)
>       ;; if a region string is found, ask for a property and set property to
>       ;; the string in the region
>       (let ((val (replace-regexp-in-string
>                   "\\`[ \t\n]*" ""
>                   (replace-regexp-in-string "[ \t\n]*\\'" ""
>                                             (substring (buffer-string)
>                                                        (- (region-beginning) 1)
>                                                        (region-end))))
>                  )
>             ;; if none was stated by user, read property from user
>             (prop (or property
>                       (org-read-property-name))))
>         ;; set property
>         (org-set-property prop val))))
>
> A big drawback is that I have to wait 18 seconds(!) until
> org-read-property-name which calls org-buffer-property-keys asks for
> the property. This is a real show stopper for this cool function.
>
> Since the properties of a buffer do not change that often, caching
> its previous result would make sense to me. This way, I only have to
> wait 18 seconds once per file on the first call.
>
> An alternative would be a org-read-property-name which uses only the
> properties of the current heading.
>
>
> Thanks for your support!
>

Re: Add caching to org-buffer-property-keys

[Nicolas Goaziou]

Hello,

Thierry Banel <tbanelwebmin@free.fr> writes:

> Maybe a rewrite of (org-read-property-name) calling
> (org-entry-properties) could speed up things.
> (org-entry-properties) returns an assoc list of the local header
> properties.

I agree. The OP should use `org-entry-properties' instead of
`org-buffer-property-keys' in his function, so as to get local header
properties.

Regards,

-- 
Nicolas Goaziou

Re: Add caching to org-buffer-property-keys

[Karl Voit]

* Thierry Banel <tbanelwebmin@free.fr> wrote:
> Nice function!
> Maybe a rewrite of (org-read-property-name) calling
> (org-entry-properties) could speed up things.
> (org-entry-properties) returns an assoc list of the local header properties.

OK, great idea.

I tried by myself (Elisp noob) and failed: see code below.

The code evaluates without complaining but when I use the function,
I get asked for a property which gets also correctly written to the
property. However, the completion of the property does not work.

I'm sure, it's only a small error of mine. 

Thanks for your help here!


;; version that tries to read only properties of current entry:
(defun org-read-entry-property-name ()
  "Read a property name from the current entry (basically a rewrite of 
   org-read-property-name which uses org-entry-properties instead to speed up)"
  (let ((completion-ignore-case t)
    (default-prop (or (and (org-at-property-p)
                   (org-match-string-no-properties 2))
              org-last-set-property)))
    (org-completing-read
     (concat "Property"
         (if default-prop (concat " [" default-prop "]") "")
         ": ")
     ;; ORIGINAL LINE: (mapcar #'list (org-buffer-property-keys nil t t))
     (mapcar #'list (org-entry-properties nil nil))
     nil nil nil nil default-prop)))

(defun my-org-region-to-property (&optional property)
  (interactive)
  ;; if no region is defined, do nothing
  (if (use-region-p)
      ;; if a region string is found, ask for a property and set property to
      ;; the string in the region
      (let ((val (replace-regexp-in-string
                  "\\`[ \t\n]*" ""
                  (replace-regexp-in-string "[ \t\n]*\\'" ""
                                            (substring (buffer-string)
                                                       (- (region-beginning) 1)
                                                       (region-end))))
                 )
            ;; if none was stated by user, read property from user
            (prop (or property
                      (org-read-entry-property-name))))
        ;; set property
        (org-set-property prop val))))


-- 
mail|git|SVN|photos|postings|SMS|phonecalls|RSS|CSV|XML to Org-mode:
       > get Memacs from https://github.com/novoid/Memacs <

https://github.com/novoid/extract_pdf_annotations_to_orgmode + more on github

Re: Add caching to org-buffer-property-keys

[eniotna]

[-- Attachment #1: Type: text/plain, Size: 3404 bytes --]

Hello,

> I'm sure, it's only a small error of mine.

Replace `(mapcar #'list (org-entry-properties nil nil))` by
`(org-entry-properties nil nil)` in your `org-read-entry-property-name`
definition:

```
(defun org-read-entry-property-name ()
  "Read a property name from the current entry (basically a rewrite of
   org-read-property-name which uses org-entry-properties instead to speed
up)"
  (let ((completion-ignore-case t)
        (default-prop (or (and (org-at-property-p)
                               (org-match-string-no-properties 2))
                          org-last-set-property)))
    (org-completing-read
     (concat "Property"
             (if default-prop (concat " [" default-prop "]") "")
             ": ")
     (org-entry-properties nil nil)
     nil nil nil nil default-prop)))
```

Regards,

tony / @ardumont

On Tue, Apr 12, 2016 at 3:55 PM, Karl Voit <devnull@karl-voit.at> wrote:

> * Thierry Banel <tbanelwebmin@free.fr> wrote:
> > Nice function!
> > Maybe a rewrite of (org-read-property-name) calling
> > (org-entry-properties) could speed up things.
> > (org-entry-properties) returns an assoc list of the local header
> properties.
>
> OK, great idea.
>
> I tried by myself (Elisp noob) and failed: see code below.
>
> The code evaluates without complaining but when I use the function,
> I get asked for a property which gets also correctly written to the
> property. However, the completion of the property does not work.
>
> I'm sure, it's only a small error of mine.
>
> Thanks for your help here!
>
>
> ;; version that tries to read only properties of current entry:
> (defun org-read-entry-property-name ()
>   "Read a property name from the current entry (basically a rewrite of
>    org-read-property-name which uses org-entry-properties instead to speed
> up)"
>   (let ((completion-ignore-case t)
>     (default-prop (or (and (org-at-property-p)
>                    (org-match-string-no-properties 2))
>               org-last-set-property)))
>     (org-completing-read
>      (concat "Property"
>          (if default-prop (concat " [" default-prop "]") "")
>          ": ")
>      ;; ORIGINAL LINE: (mapcar #'list (org-buffer-property-keys nil t t))
>      (mapcar #'list (org-entry-properties nil nil))
>      nil nil nil nil default-prop)))
>
> (defun my-org-region-to-property (&optional property)
>   (interactive)
>   ;; if no region is defined, do nothing
>   (if (use-region-p)
>       ;; if a region string is found, ask for a property and set property
> to
>       ;; the string in the region
>       (let ((val (replace-regexp-in-string
>                   "\\`[ \t\n]*" ""
>                   (replace-regexp-in-string "[ \t\n]*\\'" ""
>                                             (substring (buffer-string)
>                                                        (-
> (region-beginning) 1)
>                                                        (region-end))))
>                  )
>             ;; if none was stated by user, read property from user
>             (prop (or property
>                       (org-read-entry-property-name))))
>         ;; set property
>         (org-set-property prop val))))
>
>
> --
> mail|git|SVN|photos|postings|SMS|phonecalls|RSS|CSV|XML to Org-mode:
>        > get Memacs from https://github.com/novoid/Memacs <
>
> https://github.com/novoid/extract_pdf_annotations_to_orgmode + more on
> github
>
>
>

[-- Attachment #2: Type: text/html, Size: 4947 bytes --]

Re: Add caching to org-buffer-property-keys

[Antoine R. Dumont]

[-- Attachment #1: Type: text/plain, Size: 4287 bytes --]

eniotna <eniotna.t@gmail.com> writes:

> Hello,
>
>> I'm sure, it's only a small error of mine.
>
> Replace `(mapcar #'list (org-entry-properties nil nil))` by
> `(org-entry-properties nil nil)` in your `org-read-entry-property-name`
> definition:
>
> ```
> (defun org-read-entry-property-name ()
>   "Read a property name from the current entry (basically a rewrite of
>    org-read-property-name which uses org-entry-properties instead to speed
> up)"
>   (let ((completion-ignore-case t)
>         (default-prop (or (and (org-at-property-p)
>                                (org-match-string-no-properties 2))
>                           org-last-set-property)))
>     (org-completing-read
>      (concat "Property"
>              (if default-prop (concat " [" default-prop "]") "")
>              ": ")
>      (org-entry-properties nil nil)
>      nil nil nil nil default-prop)))
> ```

Also, for information you could use format function.
It clarifies the prompt computation ^^:

```
(defun org-read-entry-property-name ()
  "Read a property name from the current entry."
  (let ((completion-ignore-case t)
        (default-prop (or (and (org-at-property-p)
                               (org-match-string-no-properties 2))
                          org-last-set-property)))
    (org-completing-read
     (format "Property [%s]: " (if default-prop default-prop ""))
     (org-entry-properties nil nil)
     nil nil nil nil default-prop)))
```

>
> Regards,
>
> tony / @ardumont
>
> On Tue, Apr 12, 2016 at 3:55 PM, Karl Voit <devnull@karl-voit.at> wrote:
>
>> * Thierry Banel <tbanelwebmin@free.fr> wrote:
>> > Nice function!
>> > Maybe a rewrite of (org-read-property-name) calling
>> > (org-entry-properties) could speed up things.
>> > (org-entry-properties) returns an assoc list of the local header
>> properties.
>>
>> OK, great idea.
>>
>> I tried by myself (Elisp noob) and failed: see code below.
>>
>> The code evaluates without complaining but when I use the function,
>> I get asked for a property which gets also correctly written to the
>> property. However, the completion of the property does not work.
>>
>> I'm sure, it's only a small error of mine.
>>
>> Thanks for your help here!
>>
>>
>> ;; version that tries to read only properties of current entry:
>> (defun org-read-entry-property-name ()
>>   "Read a property name from the current entry (basically a rewrite of
>>    org-read-property-name which uses org-entry-properties instead to speed
>> up)"
>>   (let ((completion-ignore-case t)
>>     (default-prop (or (and (org-at-property-p)
>>                    (org-match-string-no-properties 2))
>>               org-last-set-property)))
>>     (org-completing-read
>>      (concat "Property"
>>          (if default-prop (concat " [" default-prop "]") "")
>>          ": ")
>>      ;; ORIGINAL LINE: (mapcar #'list (org-buffer-property-keys nil t t))
>>      (mapcar #'list (org-entry-properties nil nil))
>>      nil nil nil nil default-prop)))
>>
>> (defun my-org-region-to-property (&optional property)
>>   (interactive)
>>   ;; if no region is defined, do nothing
>>   (if (use-region-p)
>>       ;; if a region string is found, ask for a property and set property
>> to
>>       ;; the string in the region
>>       (let ((val (replace-regexp-in-string
>>                   "\\`[ \t\n]*" ""
>>                   (replace-regexp-in-string "[ \t\n]*\\'" ""
>>                                             (substring (buffer-string)
>>                                                        (-
>> (region-beginning) 1)
>>                                                        (region-end))))
>>                  )
>>             ;; if none was stated by user, read property from user
>>             (prop (or property
>>                       (org-read-entry-property-name))))
>>         ;; set property
>>         (org-set-property prop val))))
>>
>>
>> --
>> mail|git|SVN|photos|postings|SMS|phonecalls|RSS|CSV|XML to Org-mode:
>>        > get Memacs from https://github.com/novoid/Memacs <
>>
>> https://github.com/novoid/extract_pdf_annotations_to_orgmode + more on
>> github
>>
>>
>>

Cheers,
--
tony / @ardumont

-----------------------------------------------------------------
gpg fingerprint BF00 203D 741A C9D5 46A8 BE07 52E2 E984 0D10 C3B8

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 818 bytes --]

Re: Add caching to org-buffer-property-keys

[Karl Voit]

* Antoine R. Dumont <antoine.romain.dumont@gmail.com> wrote:
>
> Also, for information you could use format function.
> It clarifies the prompt computation ^^:
>
> ```
> (defun org-read-entry-property-name ()
>   "Read a property name from the current entry."
>   (let ((completion-ignore-case t)
>         (default-prop (or (and (org-at-property-p)
>                                (org-match-string-no-properties 2))
>                           org-last-set-property)))
>     (org-completing-read
>      (format "Property [%s]: " (if default-prop default-prop ""))
>      (org-entry-properties nil nil)
>      nil nil nil nil default-prop)))
> ```

Thank you very much!

Nice code, eases my life.

-- 
mail|git|SVN|photos|postings|SMS|phonecalls|RSS|CSV|XML to Org-mode:
       > get Memacs from https://github.com/novoid/Memacs <

https://github.com/novoid/extract_pdf_annotations_to_orgmode + more on github