From mboxrd@z Thu Jan 1 00:00:00 1970 From: Eric Abrahamsen Subject: Re: [RFC] Change property drawer syntax Date: Wed, 15 Oct 2014 00:18:02 +0800 Message-ID: <87vbnmtykl.fsf@ericabrahamsen.net> References: <87oatek909.fsf@nicolasgoaziou.fr> Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:45608) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xe4j9-00050W-Az for emacs-orgmode@gnu.org; Tue, 14 Oct 2014 12:13:41 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Xe4j3-0006Ij-8j for emacs-orgmode@gnu.org; Tue, 14 Oct 2014 12:13:35 -0400 Received: from plane.gmane.org ([80.91.229.3]:52194) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xe4j3-0006Ib-2W for emacs-orgmode@gnu.org; Tue, 14 Oct 2014 12:13:29 -0400 Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1Xe4iz-0004cG-PZ for emacs-orgmode@gnu.org; Tue, 14 Oct 2014 18:13:25 +0200 Received: from 114.248.10.109 ([114.248.10.109]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Tue, 14 Oct 2014 18:13:25 +0200 Received: from eric by 114.248.10.109 with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Tue, 14 Oct 2014 18:13:25 +0200 List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: emacs-orgmode@gnu.org Nicolas Goaziou writes: > Hello, > > As discussed previously, I would like to modify property drawers syntax. > The change is simple: they must be located right after a headline and > its planning line, if any. Therefore the following cases are valid > > * Headline > :PROPERTIES: > :KEY: value > :END: > > * Headline > SCHEDULED: <2014-10-14 mar.> > :PROPERTIES: > :KEY: value > :END: > > but, in the following case, the scheduled keyword will not be recognized > > * Headline > :PROPERTIES: > :KEY: value > :END: > SCHEDULED: <2014-10-14 mar.> > > When not empty, they also have to contain only node properties. > Moreover, node properties' keys can only contain non-whitespace > characters and cannot end with a plus sign (which is used for > accumulation). Value can contain anything but a newline character. > > Thus, the following property drawer is invalid > > * Headline > :PROPERTIES: > :KEY: value > Some text. > :END: > > Any invalid property drawer becomes de facto a regular drawer, with > "PROPERTIES" as its name. > > Besides defining exactly the syntax of property drawers, it should also > make the property API faster in some cases. Indeed, there's no need to > search through entire (possibly huge) sections in order to find > properties attached to a headline. > > However, it will break some Org documents. In particular, TODO-states > changes are usually logged before any drawer, including properties > drawers. The following function repairs them. > > (defun org-repair-property-drawers () > "Fix properties drawers in current buffer. > Ignore non Org buffers." > (when (eq major-mode 'org-mode) > (org-with-wide-buffer > (goto-char (point-min)) > (let ((case-fold-search t) > (inline-re (and (featurep 'org-inlinetask) > (concat (org-inlinetask-outline-regexp) > "END[ \t]*$")))) > (org-map-entries > (lambda () > (unless (and inline-re (org-looking-at-p inline-re)) > (save-excursion > (let ((end (save-excursion (outline-next-heading) (point)))) > (forward-line) > (when (org-looking-at-p org-planning-line-re) (forward-line)) > (when (and (< (point) end) > (not (org-looking-at-p org-property-drawer-re)) > (save-excursion > (re-search-forward org-property-drawer-re end t))) > (insert (delete-and-extract-region > (match-beginning 0) > (min (1+ (match-end 0)) end))) > (unless (bolp) (insert "\n")))))))))))) > > Internally, changes are somewhat invasive, as they include a rewrite of > almost all the property API. They also alter clocking, tags, todo > keywords, logging, initialization, hopefully in an invisible manner. > > I pushed a new branch, "top-properties" in the repository for code > review and testing. It includes unit tests, documentation and an > ORG-NEWS entry. Sounds like fun! Here's maybe a bug. In this test case: * Here's something ** Second level :PROPERTIES: :ID: 06b778b5-72a5-45b5-aea6-2d0fef0fd24b :END: Calling org-entry-put on the first heading will actually place the property on its child. Reason being that, when org-entry-put calls org-get-property-block, and that calls org-insert-property-drawer, point has already been advanced to the beginning of the "** Second level" line. org-insert-property-drawer examines the child instead of the parent, thinks it doesn't have to insert anything, and returns nil. Code later in org-get-property-block locates the ":END:" belonging to the child, assumes that's the end of the parent's block, and sticks the new property there. (I found this because org-id-get-create placed new ID values in the child's property drawer.) That was a mouthful, but I'm not going to venture a patch at this point! Eric