emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
blob 666954e1b20a940d8022a035dfa3ff1ee4a755fd 4417 bytes (raw)
name: lisp/org-tempo.el 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
;;; org-tempo.el --- template expansion for org structures -*- lexical-binding: t; -*-

;; Copyright (C) 2017 Free Software Foundation, Inc.
;;
;; Author: Rasmus Pank Roulund <emacs at pank dot eu>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
;;
;; 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
;; additional details.
;;
;;; Code:

(require 'tempo)
(require 'cl-lib)

(defvar org-tempo-tags nil
  "Tempo tags for org-mode")

(defcustom org-tempo-keywords-alist
  '((?L . "latex")
    (?H . "html")
    (?A . "ascii")
    (?i . "index"))
  "Keyword templates like `org-structure-template-alist'."
  :group 'org-tempo
  :type '(repeat
	  (cons (character :tag "Key")
		(string :tag "Template")))
  :package-version '(Org . "9.2"))

(defun org-tempo-setup ()
  (org-tempo-add-templates)
  (tempo-use-tag-list 'org-tempo-tags)
  (setq-local tempo-match-finder "^ *\\(<[[:word:]]\\)\\="))

(defun org-tempo-add-templates ()
  "Update all org-tempo templates.

Goes through `org-structure-template-alist' and
`org-tempo-keywords-alist'."
  (let ((keys (mapcar (apply-partially 'format "<%c")
		      (mapcar 'car (append org-structure-template-alist
					   org-tempo-keywords-alist)))))
    (if (> (length keys)
           (length (delete-dups keys)))
	(user-error
	 "Duplicated keys in `org-structure-template-alist' and `org-tempo-keywords-alist'"))
    (mapcar (lambda (key)
	      (if (assoc-string key org-tempo-tags)
		  (setq org-tempo-tags
			(delete (assoc-string key org-tempo-tags)
				org-tempo-tags))))
	    keys)
    (mapcar 'org-tempo-add-block org-structure-template-alist)
    (mapcar 'org-tempo-add-keyword org-tempo-keywords-alist)))

(defun org-tempo-add-block (entry)
  "Add block entry from `org-structure-template-alist'."
  (let* ((key (format "<%c" (car entry)))
	 (name (cdr entry)))
    (tempo-define-template (format "org-%s" (replace-regexp-in-string " " "-" name))
			   `(,(format "#+begin_%s " name) p '> n n
			     ,(format "#+end_%s" (car (org-split-string name " ")))
			     >)
			   key
			   (format "Insert a %s block" name)
			   'org-tempo-tags)))

(defun org-tempo-add-keyword (entry)
  "Add keyword entry from `org-tempo-keywords-alist'."
  (let* ((key (format "<%c" (car entry)))
	 (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)))

;;; Additional keywords

(tempo-define-template "org-include"
		       '("#+include: "
			 (ignore-errors
			   (format "\"%s\" " (file-relative-name (read-file-name "Include file: "))))
			 p >)
		       "<I"
		       "Include keyword"
		       'org-tempo-tags)

(add-hook 'org-mode-hook 'org-tempo-setup)

(with-eval-after-load 'org
  (org-tempo-add-templates)
  (add-hook 'org-tab-before-tab-emulation-hook
	    (lambda (&optional silent)
	      ;; Simple test if `org-tempo-setup' has been run.
	      ;; May not be the case if `org-tempo' was loaded
	      ;; after Org.
	      (unless (cl-member "<I" tempo-collection :key 'car :test 'equal)
		(org-tempo-setup))
	      (tempo-complete-tag silent))))

(provide 'org-tempo)

;;; org-tempo.el ends here

debug log:

solving 666954e1b ...
found 666954e1b in https://list.orgmode.org/orgmode/87mv2ya2ep.fsf@pank.eu/ ||
	https://list.orgmode.org/orgmode/87wp22a2i5.fsf@gmx.us/

applying [1/1] https://list.orgmode.org/orgmode/87mv2ya2ep.fsf@pank.eu/
diff --git a/lisp/org-tempo.el b/lisp/org-tempo.el
new file mode 100644
index 000000000..666954e1b

Checking patch lisp/org-tempo.el...
Applied patch lisp/org-tempo.el cleanly.

skipping https://list.orgmode.org/orgmode/87wp22a2i5.fsf@gmx.us/ for 666954e1b
index at:
100644 666954e1b20a940d8022a035dfa3ff1ee4a755fd	lisp/org-tempo.el

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

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).