emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Sebastian Miele <sebastian.miele@gmail.com>
To: David Masterson <dsmasterson92630@outlook.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Empty headline titles unsupported: Bug?
Date: Tue, 25 May 2021 12:43:09 +0200	[thread overview]
Message-ID: <87o8czksaq.fsf@gmail.com> (raw)
In-Reply-To: <SJ0PR03MB54559BAED6B3BFF3EC36A84E9B269@SJ0PR03MB5455.namprd03.prod.outlook.com>

Hi David and all,

David Masterson <dsmasterson92630@outlook.com> writes:
> Sebastian Miele <sebastian.miele@gmail.com> writes:
>> Currently org-syntax.org says that "TITLE can be made of any
>> character but a new line.  Though, it will match after every other
>> part have been matched."  This does not reflect the currently
>> effective behavior that "* :t:" is a headline with title ":t:" and no
>> tags.
>
> Can you describe what should happen in a parser grammar (ie. BNF)?  If
> not, I would tend toward rethinking the structure of the Org file so
> that it can be described in a grammar.  Having a good grammar for Org
> files will promote it's acceptance beyond Emacs.

I do not know whether it can be expressed in a context-free grammar,
although it may very well be possible.  However, the way I understand
the above quote from org-syntax.org (which is, I think, in the end
preferable) is concisely expressible in a regular expression language
that can distinguish between greedy and non-greedy matching of
subexpressions, including Emacs Lisp's regular expressions:

#+BEGIN_SRC elisp
(rx line-start
    (maximal-match STARS SPACE)
    (maximal-match (optional KEYWORD SPACE))
    (maximal-match (optional PRIORITY SPACE))
    (maximal-match (optional COMMENT SPACE))
    (minimal-match (optional TITLE SPACE))
    (maximal-match (optional TAGS))
    (maximal-match (optional SPACE))
    line-end)
#+END_SRC

SPACE is (1+ (any " \t")).  TITLE is (1+ not-newline).  In the
following, I concentrate on differences from org-syntax.org.

The above expression contains COMMENT (matching "COMMENT") not as part
of the title but as separate entity.  Although this is contrary to
org-syntax.org, it is how it is implemented now, e.g., in
org-element-headline-parser.

TAGS currently effectively is (seq ":" (1+ TAG ":")).  In particular,
that means a TAGS specification in a headline must define at least one
tag.

I suggest to change that into (seq ":" (0+ TAG ":")), i.e., to also
allow TAGS specifications of zero tags (just ":").  This would enable to
clearly disambuate the following ambiguity between TITLEs and TAGS:

#+BEGIN_SRC org
,* :t:
,* :t: :
#+END_SRC

The former headline would have empty TITLE and TAGS ":t:".  The latter
headline would have TITLE ":t:" and TAGS ":".

The following toy can be used to test some cases.  It is not complete,
but contains the essential.

#+BEGIN_SRC elisp
(defun f (x)
  (let ((r (rx line-start
               (maximal-match (group (1+ "*")) (1+ (any " \t")))
               (maximal-match (group (optional "TODO" (1+ (any " \t")))))
               (minimal-match (optional (group (1+ not-newline)) (1+ (any " \t"))))
               (maximal-match (group (optional (seq ":" (0+ (any "a-z") ":")))))
               (maximal-match (optional (1+ (any " \t"))))
               line-end)))
    (when (let (case-fold-search) (string-match r x))
      (list :stars (match-string 1 x)
            :todo  (match-string 2 x)
            :title (let ((title (match-string 3 x))) (if title title ""))
            :tags  (match-string 4 x)))))

(f "*** :t:  :  ") ;(:stars "***" :todo "" :title ":t:" :tags ":")
(f "***    :t:  ") ;(:stars "***" :todo "" :title ""    :tags ":t:")
#+END_SRC

Best wishes
Sebastian


  reply	other threads:[~2021-05-25 10:43 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-22 11:15 Sebastian Miele
2021-05-22 12:21 ` Nicolas Goaziou
2021-05-23  4:45   ` Ihor Radchenko
2021-05-23 14:06     ` Nicolas Goaziou
2021-05-23 14:33       ` Ihor Radchenko
2021-05-23 14:55         ` Nicolas Goaziou
2021-05-23 15:22           ` Ihor Radchenko
2021-05-24 11:01             ` Sebastian Miele
2021-05-24 10:37       ` Sebastian Miele
2021-09-26  9:04     ` Bastien
2021-09-26 23:47       ` Tom Gillespie
2021-09-27 19:59       ` Nicolas Goaziou
2021-09-29 11:26     ` Bastien
2021-05-24 10:46 ` Sebastian Miele
2021-05-24 22:17   ` David Masterson
2021-05-25 10:43     ` Sebastian Miele [this message]
2021-05-25 11:43       ` Sebastian Miele
2021-05-25 16:10         ` Nicolas Goaziou
2021-05-25 21:04           ` David Masterson
2021-05-25 23:06             ` Tim Cross
2021-05-26 23:37               ` David Masterson
2021-05-26 14:07           ` Ihor Radchenko
2021-05-26 23:42             ` David Masterson
2021-05-27  3:29               ` Ihor Radchenko
2021-05-27 22:35                 ` David Masterson
2021-05-28  5:36                   ` Tom Gillespie
2021-05-29  6:21                     ` David Masterson
2021-05-29  6:54                       ` Tom Gillespie
2021-05-29  8:04                         ` Ihor Radchenko
2021-05-29 19:33                           ` Tom Gillespie
2021-05-30  4:06                             ` Ihor Radchenko
2021-05-29 14:09                   ` Ihor Radchenko
2021-05-30  2:19                     ` David Masterson

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=87o8czksaq.fsf@gmail.com \
    --to=sebastian.miele@gmail.com \
    --cc=dsmasterson92630@outlook.com \
    --cc=emacs-orgmode@gnu.org \
    --subject='Re: Empty headline titles unsupported: Bug?' \
    /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 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).