From: "Kévin Le Gouguec" <kevin.legouguec@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: Setting org-todo-keywords through directory-local variables
Date: Wed, 24 Jun 2020 19:54:16 +0200 [thread overview]
Message-ID: <87a70stkmv.fsf@gmail.com> (raw)
In-Reply-To: <87eeraaju7.fsf@gmail.com> (=?utf-8?Q?=22K=C3=A9vin?= Le Gouguec"'s message of "Sat, 23 May 2020 14:58:56 +0200")
[-- Attachment #1: Type: text/plain, Size: 1897 bytes --]
Hello,
I would like to re-submit this idea, now that I am reasonably sure that
my implementation will not impact users who do not use the feature.
(I understand that Org 9.4 is on the way. I am not asking for this
feature to be included right now; I would like to get some feedback
first, then move on to documenting it.)
* Motivation
To recap: AFAIK it is not possible to define both org-todo-keywords and
org-todo-keyword-faces per-directory. The former can be set with
#+SETUPFILE, but the latter simply can't be set locally, unless I'm
mistaken.
I'd like to specify, for all Org files in a directory, which keywords to
use and how they must look. Setting both org-todo-* variables in
.dir-locals.el would be ideal IMO: the definitions for keywords and
their faces would be right next to each other.
This cannot work right now because (1) of a stray call to default-value
(2) Org computes the TODO machinery (regexps and font-lock) when setting
up the major mode, before directory-local variables are in effect.
* Prior art
AUCTeX[1] and markdown-mode[2] both solve this using
hack-local-variables-hook. This seems to be the expected way for modes
to (re)compute things that may be affected by file or directory-local
variables.
[1] http://git.savannah.gnu.org/cgit/auctex.git/tree/font-latex.el?h=release_12_2#n1331
[2] https://github.com/jrblevin/markdown-mode/blob/v2.4/markdown-mode.el#L9403
The idea is to register a function that will check whether the user
overloaded variables we care about; if that's the case, then we
recompute what we need to.
* Patch
The attached patch:
- does not change org-mode's default setup logic,
- adds a function to hack-local-variables-hook that will look for
org-todo-* variables, and recompute org-set-regexps-and-options and
org-set-font-lock-defaults if needed,
- adds :safe predicates for these variables,
- adds unit tests.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Allow-users-to-configure-TODO-keywords-from-dir-loca.patch --]
[-- Type: text/x-patch, Size: 6926 bytes --]
From 148c5fa45e1fb8d58ecc86bb266d0fa33b8994a6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?K=C3=A9vin=20Le=20Gouguec?= <kevin.legouguec@gmail.com>
Date: Wed, 27 May 2020 22:53:56 +0200
Subject: [PATCH] Allow users to configure TODO keywords from dir-locals.el
This uses the same method as AUCTeX and markdown-mode to refresh
fontification based on file-local and directory-local variables:
http://git.savannah.gnu.org/cgit/auctex.git/tree/font-latex.el?h=release_12_2#n1331
https://github.com/jrblevin/markdown-mode/blob/v2.4/markdown-mode.el#L9403
* lisp/org-faces.el (org-todo-keyword-faces): Add safe-local-variable
predicate.
* lisp/org.el (org-todo-keywords): Add safe-local-variable predicate.
(org-set-regexps-and-options): Use buffer-local value of
org-todo-keywords.
(org-mode): Register a function to reset regexps and font-lock once
file-local variables have been applied.
(org--process-local-variables): Recompute regexps and font-lock if the
user set relevant variables.
* testing/examples/dir-locals/.dir-locals.el:
* testing/examples/dir-locals/todo.org: Support files for new tests.
* testing/lisp/test-org.el (test-org/dir-local-todo-keyword-faces):
(test-org/dir-local-todo-cycling): New tests.
---
lisp/org-faces.el | 10 ++++++-
lisp/org.el | 28 +++++++++++++++----
testing/examples/dir-locals/.dir-locals.el | 11 ++++++++
testing/examples/dir-locals/todo.org | 8 ++++++
testing/lisp/test-org.el | 32 ++++++++++++++++++++++
5 files changed, 82 insertions(+), 7 deletions(-)
create mode 100644 testing/examples/dir-locals/.dir-locals.el
create mode 100644 testing/examples/dir-locals/todo.org
diff --git a/lisp/org-faces.el b/lisp/org-faces.el
index d78b606ec..fc834f37d 100644
--- a/lisp/org-faces.el
+++ b/lisp/org-faces.el
@@ -291,7 +291,15 @@ determines if it is a foreground or a background color."
(string :tag "Keyword")
(choice :tag "Face "
(string :tag "Color")
- (sexp :tag "Face")))))
+ (sexp :tag "Face"))))
+ :safe (lambda (x)
+ (cl-every
+ (lambda (pair)
+ (let ((keyword (car pair))
+ (face (cdr pair)))
+ (and (stringp keyword)
+ (or (facep face) (listp face)))))
+ x)))
(defface org-priority '((t :inherit font-lock-keyword-face))
"Face used for priority cookies."
diff --git a/lisp/org.el b/lisp/org.el
index 4d46b4173..c0183dbff 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -1945,7 +1945,13 @@ taken from the (otherwise obsolete) variable `org-todo-interpretation'."
org-todo-interpretation-widgets))
widget))
(repeat
- (string :tag "Keyword"))))))
+ (string :tag "Keyword")))))
+ :safe (lambda (x)
+ (cl-every
+ (lambda (seq)
+ (and (memq (car seq) '(sequence type))
+ (cl-every (lambda (i) (stringp i)) (cdr seq))))
+ x)))
(defvar-local org-todo-keywords-1 nil
"All TODO and DONE keywords active in a buffer.")
@@ -4358,10 +4364,9 @@ related expressions."
(cons 'sequence (split-string value)))
(append (cdr (assoc "TODO" alist))
(cdr (assoc "SEQ_TODO" alist)))))
- (let ((d (default-value 'org-todo-keywords)))
- (if (not (stringp (car d))) d
- ;; XXX: Backward compatibility code.
- (list (cons org-todo-interpretation d)))))))
+ (if (not (stringp (car org-todo-keywords))) org-todo-keywords
+ ;; XXX: Backward compatibility code.
+ (list (cons org-todo-interpretation org-todo-keywords))))))
(dolist (sequence todo-sequences)
(let* ((sequence (or (run-hook-with-args-until-success
'org-todo-setup-filter-hook sequence)
@@ -4908,7 +4913,18 @@ The following commands are available:
;; Try to set `org-hide' face correctly.
(let ((foreground (org-find-invisible-foreground)))
(when foreground
- (set-face-foreground 'org-hide foreground))))
+ (set-face-foreground 'org-hide foreground)))
+
+ (add-hook 'hack-local-variables-hook #'org--process-local-variables nil t))
+
+(defun org--process-local-variables ()
+ "Refresh settings affected by file-local or directory-local variables."
+ (when
+ (let ((local-vars (mapcar #'car file-local-variables-alist)))
+ (or (memq 'org-todo-keywords local-vars)
+ (memq 'org-todo-keyword-faces local-vars)))
+ (org-set-regexps-and-options)
+ (org-set-font-lock-defaults)))
;; Update `customize-package-emacs-version-alist'
(add-to-list 'customize-package-emacs-version-alist
diff --git a/testing/examples/dir-locals/.dir-locals.el b/testing/examples/dir-locals/.dir-locals.el
new file mode 100644
index 000000000..677eaca10
--- /dev/null
+++ b/testing/examples/dir-locals/.dir-locals.el
@@ -0,0 +1,11 @@
+((org-mode
+ . ((org-todo-keywords
+ . ((sequence "TODO" "|" "DONE")
+ (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
+ (sequence "|" "CANCELED")))
+ (org-todo-keyword-faces
+ . (("REPORT" . org-todo)
+ ("BUG" . warning)
+ ("KNOWNCAUSE" . warning)
+ ("FIXED" . org-done)
+ ("CANCELED" . shadow))))))
diff --git a/testing/examples/dir-locals/todo.org b/testing/examples/dir-locals/todo.org
new file mode 100644
index 000000000..cd06b5ebd
--- /dev/null
+++ b/testing/examples/dir-locals/todo.org
@@ -0,0 +1,8 @@
+#+Title: headings with TODO keywords set in .dir-locals.el
+* TODO heading
+* DONE heading
+* REPORT heading
+* BUG heading
+* KNOWNCAUSE heading
+* FIXED heading
+* CANCELED heading
diff --git a/testing/lisp/test-org.el b/testing/lisp/test-org.el
index 375e1a718..2adcb2681 100644
--- a/testing/lisp/test-org.el
+++ b/testing/lisp/test-org.el
@@ -7158,6 +7158,38 @@ CLOCK: [2012-03-29 Thu 10:00]--[2012-03-29 Thu 16:40] => 6:40"
(org-todo "DONE")
(buffer-string))))))
+(ert-deftest test-org/dir-local-todo-keyword-faces ()
+ "Make sure TODO faces honor dir-local variables."
+ (org-test-in-example-file
+ (expand-file-name "dir-locals/todo.org" org-test-example-dir)
+ (font-lock-ensure (point-min) (point-max))
+ (dolist (expected-face '(org-todo
+ org-done
+ org-todo
+ warning
+ warning
+ org-done
+ shadow))
+ (should (equal (get-text-property (+ 2 (point)) 'face)
+ expected-face))
+ (next-line))))
+
+(ert-deftest test-org/dir-local-todo-cycling ()
+ "Make sure TODO cycling honors dir-local variables."
+ (org-test-in-example-file
+ (expand-file-name "dir-locals/todo.org" org-test-example-dir)
+ (dolist (expected-heading '("* DONE heading"
+ "* heading"
+ "* BUG heading"
+ "* KNOWNCAUSE heading"
+ "* FIXED heading"
+ "* heading"
+ "* heading"))
+ (org-todo)
+ (should (string= (buffer-substring (point) (line-end-position))
+ expected-heading))
+ (next-line))
+ (revert-buffer t t)))
\f
;;; Timestamps API
--
2.27.0
[-- Attachment #3: Type: text/plain, Size: 112 bytes --]
Am I on the right track with this patch, or are there problems I haven't
thought of?
Thank you for your time.
next prev parent reply other threads:[~2020-06-24 17:54 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-20 21:12 Setting org-todo-keywords through directory-local variables Kévin Le Gouguec
2020-05-21 23:12 ` Kévin Le Gouguec
2020-05-22 15:11 ` Nicolas Goaziou
2020-05-23 12:58 ` Kévin Le Gouguec
2020-06-24 17:54 ` Kévin Le Gouguec [this message]
2020-09-05 15:39 ` Bastien
2022-10-30 3:10 ` Ihor Radchenko
2022-10-30 14:35 ` Kévin Le Gouguec
2022-10-31 3:00 ` Ihor Radchenko
2020-05-22 8:42 ` 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=87a70stkmv.fsf@gmail.com \
--to=kevin.legouguec@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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).