2017-12-05 10:33:59 +00:00
|
|
|
|
;;; org-tempo.el --- Template expansion for Org structures -*- lexical-binding: t; -*-
|
|
|
|
|
|
2023-01-01 10:31:12 +00:00
|
|
|
|
;; Copyright (C) 2017-2023 Free Software Foundation, Inc.
|
2017-12-05 10:33:59 +00:00
|
|
|
|
;;
|
|
|
|
|
;; Author: Rasmus Pank Roulund <emacs at pank dot eu>
|
|
|
|
|
;; Keywords: outlines, hypermedia, calendar, wp
|
2021-09-26 07:44:29 +00:00
|
|
|
|
;; URL: https://orgmode.org
|
2017-12-05 10:33:59 +00:00
|
|
|
|
;;
|
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
;;
|
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
;; GNU General Public License for more details.
|
|
|
|
|
|
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
|
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
|
;;
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
;;
|
|
|
|
|
;; Org Tempo reimplements completions of structure template before
|
|
|
|
|
;; point like `org-try-structure-completion' in Org v9.1 and earlier.
|
|
|
|
|
;; For example, strings like "<e" at the beginning of the line will be
|
|
|
|
|
;; expanded to an example block.
|
|
|
|
|
;;
|
|
|
|
|
;; All blocks defined in `org-structure-template-alist' are added as
|
|
|
|
|
;; Org Tempo shortcuts, in addition to keywords defined in
|
|
|
|
|
;; `org-tempo-keywords-alist'.
|
|
|
|
|
;;
|
|
|
|
|
;; `tempo' can also be used to define more sophisticated keywords
|
|
|
|
|
;; completions. See the section "Additional keywords" below for
|
2017-12-21 11:59:36 +00:00
|
|
|
|
;; examples.
|
2017-12-05 10:33:59 +00:00
|
|
|
|
;;
|
|
|
|
|
;;; Code:
|
|
|
|
|
|
2022-08-04 13:53:05 +00:00
|
|
|
|
(require 'org-macs)
|
|
|
|
|
(org-assert-version)
|
|
|
|
|
|
2017-12-05 10:33:59 +00:00
|
|
|
|
(require 'tempo)
|
|
|
|
|
(require 'cl-lib)
|
2018-03-31 06:51:10 +00:00
|
|
|
|
(require 'org)
|
2017-12-05 10:33:59 +00:00
|
|
|
|
|
2018-02-03 23:24:01 +00:00
|
|
|
|
(defvar org-structure-template-alist)
|
|
|
|
|
|
2017-12-05 10:33:59 +00:00
|
|
|
|
|
|
|
|
|
(defgroup org-tempo nil
|
2018-04-27 22:46:25 +00:00
|
|
|
|
"Template expansion of Org structures."
|
2017-12-05 10:33:59 +00:00
|
|
|
|
:tag "Org structure"
|
|
|
|
|
:group 'org)
|
|
|
|
|
|
|
|
|
|
(defvar org-tempo-tags nil
|
2018-04-27 22:46:25 +00:00
|
|
|
|
"Tempo tags for Org mode.")
|
2017-12-05 10:33:59 +00:00
|
|
|
|
|
|
|
|
|
(defcustom org-tempo-keywords-alist
|
2017-12-21 11:55:35 +00:00
|
|
|
|
'(("L" . "latex")
|
|
|
|
|
("H" . "html")
|
|
|
|
|
("A" . "ascii")
|
|
|
|
|
("i" . "index"))
|
2017-12-05 10:33:59 +00:00
|
|
|
|
"Keyword completion elements.
|
|
|
|
|
|
2018-04-27 22:46:25 +00:00
|
|
|
|
This is an alist of KEY characters and corresponding KEYWORDS,
|
|
|
|
|
just like `org-structure-template-alist'. The tempo snippet
|
|
|
|
|
\"<KEY\" will be expanded using the KEYWORD value. For example
|
2018-06-14 14:39:28 +00:00
|
|
|
|
\"<L\" at the beginning of a line is expanded to \"#+latex:\".
|
2017-12-05 10:33:59 +00:00
|
|
|
|
|
2021-03-12 11:11:17 +00:00
|
|
|
|
Do not use \"I\" as a KEY, as it is reserved for expanding
|
2018-04-27 22:46:25 +00:00
|
|
|
|
\"#+include\"."
|
2017-12-21 11:55:35 +00:00
|
|
|
|
:type '(repeat (cons (string :tag "Key")
|
2017-12-05 10:33:59 +00:00
|
|
|
|
(string :tag "Keyword")))
|
|
|
|
|
:package-version '(Org . "9.2"))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;; Org Tempo functions and setup.
|
|
|
|
|
|
|
|
|
|
(defun org-tempo-setup ()
|
2018-04-27 22:46:25 +00:00
|
|
|
|
"Setup tempo tags and match finder for the current buffer."
|
2017-12-21 11:59:36 +00:00
|
|
|
|
(org-tempo--update-maybe)
|
2017-12-05 10:33:59 +00:00
|
|
|
|
(tempo-use-tag-list 'org-tempo-tags)
|
2017-12-21 11:55:35 +00:00
|
|
|
|
(setq-local tempo-match-finder "^ *\\(<[[:word:]]+\\)\\="))
|
2017-12-05 10:33:59 +00:00
|
|
|
|
|
2017-12-21 11:59:36 +00:00
|
|
|
|
(defun org-tempo--keys ()
|
|
|
|
|
"Return a list of all Org Tempo expansion strings, like \"<s\"."
|
|
|
|
|
(mapcar (lambda (pair) (format "<%s" (car pair)))
|
|
|
|
|
(append org-structure-template-alist
|
|
|
|
|
org-tempo-keywords-alist)))
|
|
|
|
|
|
|
|
|
|
(defun org-tempo--update-maybe ()
|
|
|
|
|
"Check and add new Org Tempo templates if necessary.
|
|
|
|
|
In particular, if new entries were added to
|
|
|
|
|
`org-structure-template-alist' or `org-tempo-keywords-alist', new
|
|
|
|
|
Tempo templates will be added."
|
|
|
|
|
(unless (cl-every (lambda (key) (assoc key org-tempo-tags))
|
|
|
|
|
(org-tempo--keys))
|
|
|
|
|
(org-tempo-add-templates)))
|
|
|
|
|
|
2017-12-05 10:33:59 +00:00
|
|
|
|
(defun org-tempo-add-templates ()
|
|
|
|
|
"Update all Org Tempo templates.
|
|
|
|
|
|
2018-04-27 22:46:25 +00:00
|
|
|
|
Go through `org-structure-template-alist' and
|
|
|
|
|
`org-tempo-keywords-alist' and update tempo templates."
|
Replace all uses of the old `defadvice` with the new `advice-add`
* lisp/org.el (org-run-like-in-org-mode): Strength reduce `eval`
to `cl-progv`.
(org--check-org-structure-template-alist): Strength reduce `eval`
to `symbol-value`.
(org-map-entries, org-eval-in-calendar, org-diary-sexp-entry):
Make sure we use the new lexically scoped dialect.
(org--math-always-on): New function, extracted from advice.
(org-cdlatex-mode): Use it with `advice-add`.
(org-self-insert-command): Simplify `and`+`listp` into `consp`.
(org-submit-bug-report):
Make sure we use the new lexically scoped dialect.
* lisp/org-protocol.el (org-protocol-convert-query-to-plist):
Use `cl-mapcan`.
(org--protocol-detect-protocol-server): New function, extracted
from advice.
(server-visit-files): Use it with `advice-add`.
* lisp/org-mouse.el (org--mouse-dnd-insert-text): New function, extracted
from advice.
(dnd-insert-text): Use it with `advice-add`.
(org--mouse-dnd-open-file): New function, extracted from advice.
(dnd-open-file): Use it with `advice-add`.
(org--mouse-open-at-point): New function, extracted from advice.
(org-mode-hook): Advise `org-open-at-point` with `advice-add`.
* lisp/org-ctags.el (org--ctags-load-tag-list): New function, extracted
from advice.
(visit-tags-table): Use it with `advice-add`.
(org--ctags-set-org-mark-before-finding-tag): New function, extracted
from advice.
(xref-find-definitions): Use it with `advice-add`.
* lisp/org-compat.el (org-bookmark-jump-unhide): Accept (unused) args.
(save-place-find-file-hook): Use `advice-add`.
(org--ecb-show-context): New function, extracted from advice.
(ecb-method-clicked): Use it with `advice-add`.
(org-mark-jump-unhide): Accept (unused) args.
(pop-to-mark-command, exchange-point-and-mark, pop-global-mark):
Use `advice-add`.
Along the way, remove some redundant `:group` args
(redundant because they specify the same group as would be used by
default anyway) and make a few other simplifications.
Also don't bother putting `advice-add` within an eval-after-load
since the advice machinery already takes care of handling it.
2022-04-01 05:50:01 +00:00
|
|
|
|
(mapc #'org--check-org-structure-template-alist '(org-structure-template-alist
|
|
|
|
|
org-tempo-keywords-alist))
|
2017-12-21 11:59:36 +00:00
|
|
|
|
(let ((keys (org-tempo--keys)))
|
2017-12-05 10:33:59 +00:00
|
|
|
|
;; Check for duplicated snippet keys and warn if any are found.
|
|
|
|
|
(when (> (length keys) (length (delete-dups keys)))
|
|
|
|
|
(warn
|
|
|
|
|
"Duplicated keys in `org-structure-template-alist' and `org-tempo-keywords-alist'"))
|
|
|
|
|
;; Remove any keys already defined in case they have been updated.
|
2018-02-04 07:56:15 +00:00
|
|
|
|
(setq org-tempo-tags
|
|
|
|
|
(cl-remove-if (lambda (tag) (member (car tag) keys)) org-tempo-tags))
|
2017-12-05 10:33:59 +00:00
|
|
|
|
(mapc #'org-tempo-add-block org-structure-template-alist)
|
|
|
|
|
(mapc #'org-tempo-add-keyword org-tempo-keywords-alist)))
|
|
|
|
|
|
|
|
|
|
(defun org-tempo-add-block (entry)
|
2023-10-15 08:53:05 +00:00
|
|
|
|
"Add block ENTRY from `org-structure-template-alist'."
|
2017-12-21 11:55:35 +00:00
|
|
|
|
(let* ((key (format "<%s" (car entry)))
|
2017-12-21 11:59:36 +00:00
|
|
|
|
(name (cdr entry))
|
2022-03-20 12:15:21 +00:00
|
|
|
|
(special (member name '("src" "export")))
|
|
|
|
|
(upcase? (string= (car (split-string name))
|
|
|
|
|
(upcase (car (split-string name))))))
|
2017-12-05 10:33:59 +00:00
|
|
|
|
(tempo-define-template (format "org-%s" (replace-regexp-in-string " " "-" name))
|
2022-03-20 12:15:21 +00:00
|
|
|
|
`(,(format "#+%s_%s%s"
|
|
|
|
|
(if upcase? "BEGIN" "begin")
|
|
|
|
|
name
|
|
|
|
|
(if special " " ""))
|
2020-02-03 17:22:55 +00:00
|
|
|
|
,(when special 'p) '> n ,(unless special 'p) n
|
2022-03-20 12:15:21 +00:00
|
|
|
|
,(format "#+%s_%s"
|
|
|
|
|
(if upcase? "END" "end")
|
|
|
|
|
(car (split-string name " ")))
|
2017-12-05 10:33:59 +00:00
|
|
|
|
>)
|
|
|
|
|
key
|
|
|
|
|
(format "Insert a %s block" name)
|
|
|
|
|
'org-tempo-tags)))
|
|
|
|
|
|
|
|
|
|
(defun org-tempo-add-keyword (entry)
|
2023-10-15 08:53:05 +00:00
|
|
|
|
"Add keyword ENTRY from `org-tempo-keywords-alist'."
|
2017-12-21 11:55:35 +00:00
|
|
|
|
(let* ((key (format "<%s" (car entry)))
|
2017-12-05 10:33:59 +00:00
|
|
|
|
(name (cdr entry)))
|
|
|
|
|
(tempo-define-template (format "org-%s" (replace-regexp-in-string " " "-" name))
|
|
|
|
|
`(,(format "#+%s: " name) p '>)
|
|
|
|
|
key
|
|
|
|
|
(format "Insert a %s keyword" name)
|
|
|
|
|
'org-tempo-tags)))
|
|
|
|
|
|
2018-02-11 11:02:47 +00:00
|
|
|
|
(defun org-tempo-complete-tag (&rest _)
|
|
|
|
|
"Look for a tag and expand it silently.
|
|
|
|
|
Unlike to `tempo-complete-tag', do not give a signal if a partial
|
|
|
|
|
completion or no match at all is found. Return nil if expansion
|
|
|
|
|
didn't succeed."
|
2017-12-21 11:59:36 +00:00
|
|
|
|
(org-tempo--update-maybe)
|
2018-02-27 01:02:56 +00:00
|
|
|
|
;; `tempo-complete-tag' returns its SILENT argument when there is no
|
|
|
|
|
;; completion available at all.
|
|
|
|
|
(not (eq 'fail (tempo-complete-tag 'fail))))
|
2018-02-11 11:02:47 +00:00
|
|
|
|
|
2017-12-21 11:59:36 +00:00
|
|
|
|
|
2017-12-05 10:33:59 +00:00
|
|
|
|
;;; Additional keywords
|
|
|
|
|
|
|
|
|
|
(defun org-tempo--include-file ()
|
2018-04-27 22:46:25 +00:00
|
|
|
|
"Add #+include: and a file name."
|
2017-12-10 16:11:24 +00:00
|
|
|
|
(let ((inhibit-quit t))
|
2017-12-05 10:33:59 +00:00
|
|
|
|
(unless (with-local-quit
|
|
|
|
|
(prog1 t
|
|
|
|
|
(insert
|
2017-12-10 16:11:24 +00:00
|
|
|
|
(format "#+include: %S "
|
|
|
|
|
(file-relative-name
|
|
|
|
|
(read-file-name "Include file: "))))))
|
2017-12-05 10:33:59 +00:00
|
|
|
|
(insert "<I")
|
|
|
|
|
(setq quit-flag nil))))
|
|
|
|
|
|
|
|
|
|
(tempo-define-template "org-include"
|
|
|
|
|
'((org-tempo--include-file)
|
|
|
|
|
p >)
|
|
|
|
|
"<I"
|
|
|
|
|
"Include keyword"
|
|
|
|
|
'org-tempo-tags)
|
|
|
|
|
|
|
|
|
|
;;; Setup of Org Tempo
|
|
|
|
|
;;
|
|
|
|
|
;; Org Tempo is set up with each new Org buffer and potentially in the
|
|
|
|
|
;; current Org buffer.
|
|
|
|
|
|
Replace all uses of the old `defadvice` with the new `advice-add`
* lisp/org.el (org-run-like-in-org-mode): Strength reduce `eval`
to `cl-progv`.
(org--check-org-structure-template-alist): Strength reduce `eval`
to `symbol-value`.
(org-map-entries, org-eval-in-calendar, org-diary-sexp-entry):
Make sure we use the new lexically scoped dialect.
(org--math-always-on): New function, extracted from advice.
(org-cdlatex-mode): Use it with `advice-add`.
(org-self-insert-command): Simplify `and`+`listp` into `consp`.
(org-submit-bug-report):
Make sure we use the new lexically scoped dialect.
* lisp/org-protocol.el (org-protocol-convert-query-to-plist):
Use `cl-mapcan`.
(org--protocol-detect-protocol-server): New function, extracted
from advice.
(server-visit-files): Use it with `advice-add`.
* lisp/org-mouse.el (org--mouse-dnd-insert-text): New function, extracted
from advice.
(dnd-insert-text): Use it with `advice-add`.
(org--mouse-dnd-open-file): New function, extracted from advice.
(dnd-open-file): Use it with `advice-add`.
(org--mouse-open-at-point): New function, extracted from advice.
(org-mode-hook): Advise `org-open-at-point` with `advice-add`.
* lisp/org-ctags.el (org--ctags-load-tag-list): New function, extracted
from advice.
(visit-tags-table): Use it with `advice-add`.
(org--ctags-set-org-mark-before-finding-tag): New function, extracted
from advice.
(xref-find-definitions): Use it with `advice-add`.
* lisp/org-compat.el (org-bookmark-jump-unhide): Accept (unused) args.
(save-place-find-file-hook): Use `advice-add`.
(org--ecb-show-context): New function, extracted from advice.
(ecb-method-clicked): Use it with `advice-add`.
(org-mark-jump-unhide): Accept (unused) args.
(pop-to-mark-command, exchange-point-and-mark, pop-global-mark):
Use `advice-add`.
Along the way, remove some redundant `:group` args
(redundant because they specify the same group as would be used by
default anyway) and make a few other simplifications.
Also don't bother putting `advice-add` within an eval-after-load
since the advice machinery already takes care of handling it.
2022-04-01 05:50:01 +00:00
|
|
|
|
(add-hook 'org-mode-hook #'org-tempo-setup)
|
|
|
|
|
(add-hook 'org-tab-before-tab-emulation-hook #'org-tempo-complete-tag)
|
2017-12-10 10:50:38 +00:00
|
|
|
|
|
|
|
|
|
;; Enable Org Tempo in all open Org buffers.
|
2018-02-11 11:06:42 +00:00
|
|
|
|
(dolist (b (org-buffer-list 'files))
|
2017-12-10 16:11:24 +00:00
|
|
|
|
(with-current-buffer b (org-tempo-setup)))
|
2017-12-05 10:33:59 +00:00
|
|
|
|
|
|
|
|
|
(provide 'org-tempo)
|
|
|
|
|
|
|
|
|
|
;;; org-tempo.el ends here
|