1 ;;; org-tempo.el --- Template expansion for Org structures -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2017-2018 Free Software Foundation, Inc.
5 ;; Author: Rasmus Pank Roulund <emacs at pank dot eu>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
26 ;; Org Tempo reimplements completions of structure template before
27 ;; point like `org-try-structure-completion' in Org v9.1 and earlier.
28 ;; For example, strings like "<e" at the beginning of the line will be
29 ;; expanded to an example block.
31 ;; All blocks defined in `org-structure-template-alist' are added as
32 ;; Org Tempo shortcuts, in addition to keywords defined in
33 ;; `org-tempo-keywords-alist'.
35 ;; `tempo' can also be used to define more sophisticated keywords
36 ;; completions. See the section "Additional keywords" below for
37 ;; additional details.
43 (declare-function org-buffer-list
"org" (&optional predicate exclude-tmp
))
45 (defvar org-structure-template-alist
)
48 (defgroup org-tempo nil
49 "Options for template expansion of Org structures"
53 (defvar org-tempo-tags nil
54 "Tempo tags for Org mode")
56 (defcustom org-tempo-keywords-alist
61 "Keyword completion elements.
63 Like `org-structure-template-alist' this alist of KEY characters
64 and KEYWORD. The tempo snippet \"<KEY\" is expand to the KEYWORD
67 For example \"<l\" at the beginning of a line is expanded to
70 :type
'(repeat (cons (character :tag
"Key")
71 (string :tag
"Keyword")))
72 :package-version
'(Org .
"9.2"))
76 ;;; Org Tempo functions and setup.
78 (defun org-tempo-setup ()
79 (org-tempo-add-templates)
80 (tempo-use-tag-list 'org-tempo-tags
)
81 (setq-local tempo-match-finder
"^ *\\(<[[:word:]]\\)\\="))
83 (defun org-tempo-add-templates ()
84 "Update all Org Tempo templates.
86 Goes through `org-structure-template-alist' and
87 `org-tempo-keywords-alist'."
88 (let ((keys (mapcar (lambda (pair) (format "<%c" (car pair
)))
89 (append org-structure-template-alist
90 org-tempo-keywords-alist
))))
91 ;; Check for duplicated snippet keys and warn if any are found.
92 (when (> (length keys
) (length (delete-dups keys
)))
94 "Duplicated keys in `org-structure-template-alist' and `org-tempo-keywords-alist'"))
96 ;; Remove any keys already defined in case they have been updated.
98 (if (assoc-string key org-tempo-tags
)
100 (delete (assoc-string key org-tempo-tags
)
103 (mapc #'org-tempo-add-block org-structure-template-alist
)
104 (mapc #'org-tempo-add-keyword org-tempo-keywords-alist
)))
106 (defun org-tempo-add-block (entry)
107 "Add block entry from `org-structure-template-alist'."
108 (let* ((key (format "<%c" (car entry
)))
110 (tempo-define-template (format "org-%s" (replace-regexp-in-string " " "-" name
))
111 `(,(format "#+begin_%s " name
) p
'> n n
112 ,(format "#+end_%s" (car (split-string name
" ")))
115 (format "Insert a %s block" name
)
118 (defun org-tempo-add-keyword (entry)
119 "Add keyword entry from `org-tempo-keywords-alist'."
120 (let* ((key (format "<%c" (car entry
)))
122 (tempo-define-template (format "org-%s" (replace-regexp-in-string " " "-" name
))
123 `(,(format "#+%s: " name
) p
'>)
125 (format "Insert a %s keyword" name
)
128 ;;; Additional keywords
130 (defun org-tempo--include-file ()
131 "Ask for file name and take care of quit"
132 (let ((inhibit-quit t
))
133 (unless (with-local-quit
136 (format "#+include: %S "
138 (read-file-name "Include file: "))))))
140 (setq quit-flag nil
))))
142 (tempo-define-template "org-include"
143 '((org-tempo--include-file)
150 ;;; Setup of Org Tempo
152 ;; Org Tempo is set up with each new Org buffer and potentially in the
153 ;; current Org buffer.
155 ;; Tempo templates can only be added after Org is loaded as
156 ;; `org-structure-template-alist' must be loaded.
158 (add-hook 'org-mode-hook
'org-tempo-setup
)
159 (add-hook 'org-tab-before-tab-emulation-hook
162 ;; Enable Org Tempo in all open Org buffers.
163 (dolist (b (org-buffer-list))
164 (with-current-buffer b
(org-tempo-setup)))
166 (eval-after-load 'org
167 '(org-tempo-add-templates))
171 ;;; org-tempo.el ends here