Bug: Changed behaviour of org-at-timestamp-p after recent change

Bug: Changed behaviour of org-at-timestamp-p after recent change

[Anders Johansson]

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

Hi,
I noticed that this commit:
b1a570b3b  org-agenda: Fix regression when diary sexp timestamps are ignored

made a call like (org-at-timestamp-p 'agenda) match against the regexp
`org-element--timestamp-regexp`. However, this regexp doesn’t have the
match groups setup as the others (`org-ts-regexp3` and `org-ts-regexp2`) so
the last part of the docstring for org-at-timestamp-p doesn’t hold anymore
(that the timestamp parts should now be put in match groups).

I was using this in some code of mine, but I also realize that this doesn’t
feel all that clean anyway. I am not sure if this is used elsewhere in org
though.

Best,
Anders

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

Re: Bug: Changed behaviour of org-at-timestamp-p after recent change

[Ihor Radchenko]

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


Anders Johansson <mejlaandersj@gmail.com> writes:
> Hi,
> I noticed that this commit:
> b1a570b3b  org-agenda: Fix regression when diary sexp timestamps are ignored
>
> made a call like (org-at-timestamp-p 'agenda) match against the regexp
> `org-element--timestamp-regexp`. However, this regexp doesn’t have the
> match groups setup as the others (`org-ts-regexp3` and `org-ts-regexp2`) so
> the last part of the docstring for org-at-timestamp-p doesn’t hold anymore
> (that the timestamp parts should now be put in match groups).

Confirmed.
Can you try the attached patch?

Also, unless I miss something, docstring was not fully obeyed even in
the past. Consider the following timestamp:

 <2022-04-15 Fri 11:40>

I ran the following code with point at the timestamp:
(progn (org-at-timestamp-p ) (mapcar #'substring-no-properties (list (match-string 0) (match-string 1) (match-string 2) (match-string 3) (match-string 4) (match-string 5) (match-string 6) (match-string 7))))

The output is:
("<2022-04-15 Fri 11:40>" "2022-04-15 Fri 11:40" "2022" "04" "15" "Fri" " 11:40" "11" "40")

There are two extra groups (group 1 and group 6), presumably due to
earlier changes in org-ts-regexp1.

> I was using this in some code of mine, but I also realize that this doesn’t
> feel all that clean anyway. I am not sure if this is used elsewhere in org
> though.

I am currently working on an alternative concept of analyzing arbitrary
org element components. Instead of named groups, I plan to provide named
match groups:

(progn (org-element-match 'timestamp) (org-element-match-data))

((:minute-start 314 316)
 (:hour-start 311 313)
 (:day-start 304 306)
 (:month-start 301 303)
 (:year-start 296 300)
 (:date-start 296 316)
 (:timestamp-start 295 317)
 (:end-marker 316 317)
 (:begin-marker 295 296)
 (:full 295 317)
 (:full-no-blank 295 317)
 (:full-no-affiliated 295 317))

The current WIP implementation is in
https://github.com/yantar92/org/blob/feature/org-font-lock-element/lisp/org-element-match.el

The match groups set by org-at-timestamp-p are currently being used by
the following functions: org-mouse-delete-timestamp,
org-follow-timestamp-link, org-time-stamp, org-toggle-timestamp-type

However, all but one of them are only using group 0 and
org-follow-timestamp-link is using group 1 as currently set by
org-at-timestamp-p against the docstring.

Best,
Ihor


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-at-timestamp-p-Fix-invalid-regexp-groups-for-age.patch --]
[-- Type: text/x-patch, Size: 2080 bytes --]

From d9a5cb8b7d7b12aca389331f4817130420d2d744 Mon Sep 17 00:00:00 2001
Message-Id: <d9a5cb8b7d7b12aca389331f4817130420d2d744.1650012068.git.yantar92@gmail.com>
From: Ihor Radchenko <yantar92@gmail.com>
Date: Fri, 15 Apr 2022 15:05:39 +0800
Subject: [PATCH] org-at-timestamp-p: Fix invalid regexp groups for 'agenda
 scope

* lisp/org.el (org-at-timestamp-p): Make sure that match groups follow
the docstring in `agenda' scope.  Update docstring explaining return
values for sexp timestamps.

Reported in https://orgmode.org/list/CAKJdtO8bqdbW5N6pRFNQRATjm2daEBDCpJj0njwcd4fmhSJSKQ@mail.gmail.com
---
 lisp/org.el | 24 ++++++++++++++----------
 1 file changed, 14 insertions(+), 10 deletions(-)

diff --git a/lisp/org.el b/lisp/org.el
index 3cc8a5036..b736a3824 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -15248,20 +15248,24 @@ (defun org-at-timestamp-p (&optional extended)
 When at a timestamp, return the position of the point as a symbol
 among `bracket', `after', `year', `month', `hour', `minute',
 `day' or a number of character from the last know part of the
-time stamp.
+time stamp.  If diary sexp timestamps, any point inside the timestamp
+is considered `day' (i.e. only `bracket', `day', and `after' return
+values are possible).
 
 When matching, the match groups are the following:
-  group 1: year
-  group 2: month
-  group 3: day number
-  group 4: day name
+  group 1: year, if any
+  group 2: month, if any
+  group 3: day number, if any
+  group 4: day name, if any
   group 5: hours, if any
   group 6: minutes, if any"
-  (let* ((regexp (if extended
-                     (if (eq extended 'agenda)
-                         org-element--timestamp-regexp
-		       org-ts-regexp3)
-                   org-ts-regexp2))
+  (let* ((regexp
+          (if extended
+              (if (eq extended 'agenda)
+                  (rx (or (regexp org-ts-regexp3)
+                          (regexp org-element--timestamp-regexp)))
+		org-ts-regexp3)
+            org-ts-regexp2))
 	 (pos (point))
 	 (match?
 	  (let ((boundaries (org-in-regexp regexp)))
-- 
2.35.1