mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-11-30 08:08:26 +00:00
449 lines
18 KiB
EmacsLisp
449 lines
18 KiB
EmacsLisp
;;; org-macro.el --- Macro Replacement Code for Org -*- lexical-binding: t; -*-
|
||
|
||
;; Copyright (C) 2013-2024 Free Software Foundation, Inc.
|
||
|
||
;; Author: Nicolas Goaziou <n.goaziou@gmail.com>
|
||
;; Keywords: outlines, hypermedia, calendar, wp
|
||
|
||
;; 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:
|
||
|
||
;; Macros are expanded with `org-macro-replace-all', which relies
|
||
;; internally on `org-macro-expand'.
|
||
|
||
;; Default templates for expansion are stored in the buffer-local
|
||
;; variable `org-macro-templates'. This variable is updated by
|
||
;; `org-macro-initialize-templates', which recursively calls
|
||
;; `org-macro--collect-macros' in order to read setup files.
|
||
|
||
;; Argument in macros are separated with commas. Proper escaping rules
|
||
;; are implemented in `org-macro-escape-arguments' and arguments can
|
||
;; be extracted from a string with `org-macro-extract-arguments'.
|
||
|
||
;; Along with macros defined through #+MACRO: keyword, default
|
||
;; templates include the following hard-coded macros:
|
||
;; {{{time(format-string)}}},
|
||
;; {{{property(node-property)}}},
|
||
;; {{{input-file}}},
|
||
;; {{{modification-time(format-string)}}},
|
||
;; {{{n(counter,action}}}.
|
||
|
||
;; Upon exporting, "ox.el" will also provide {{{author}}}, {{{date}}},
|
||
;; {{{email}}} and {{{title}}} macros.
|
||
|
||
;;; Code:
|
||
|
||
(require 'org-macs)
|
||
(org-assert-version)
|
||
|
||
(require 'cl-lib)
|
||
(require 'org-macs)
|
||
(require 'org-compat)
|
||
|
||
(declare-function org-collect-keywords "org" (keywords &optional unique directory))
|
||
(declare-function org-element-at-point "org-element" (&optional pom cached-only))
|
||
(declare-function org-element-context "org-element" (&optional element))
|
||
(declare-function org-element-copy "org-element-ast" (datum))
|
||
(declare-function org-element-macro-parser "org-element" ())
|
||
(declare-function org-element-keyword-parser "org-element" (limit affiliated))
|
||
(declare-function org-element-put-property "org-element-ast" (node property value))
|
||
(declare-function org-element-parse-secondary-string "org-element" (string restriction &optional parent))
|
||
(declare-function org-element-property "org-element-ast" (property node))
|
||
(declare-function org-element-begin "org-element" (node))
|
||
(declare-function org-element-end "org-element" (node))
|
||
(declare-function org-element-restriction "org-element" (element))
|
||
(declare-function org-element-type "org-element-ast" (node &optional anonymous))
|
||
(declare-function org-element-type-p "org-element-ast" (node types))
|
||
(declare-function org-entry-get "org" (pom property &optional inherit literal-nil))
|
||
(declare-function org-file-contents "org" (file &optional noerror nocache))
|
||
(declare-function org-in-commented-heading-p "org" (&optional no-inheritance element))
|
||
(declare-function org-link-search "ol" (s &optional avoid-pos stealth))
|
||
(declare-function org-mode "org" ())
|
||
(declare-function vc-backend "vc-hooks" (f))
|
||
(declare-function vc-call "vc-hooks" (fun file &rest args) t)
|
||
(declare-function vc-exec-after "vc-dispatcher" (code &optional success))
|
||
|
||
(defvar org-link-search-must-match-exact-headline)
|
||
|
||
;;; Variables
|
||
|
||
(defvar-local org-macro-templates nil
|
||
"Alist containing all macro templates in current buffer.
|
||
Associations are in the shape of (NAME . TEMPLATE) where NAME
|
||
stands for macro's name and template for its replacement value,
|
||
both as strings. This is an internal variable. Do not set it
|
||
directly, use instead:
|
||
|
||
#+MACRO: name template")
|
||
|
||
;;; Functions
|
||
|
||
(defun org-macro--makeargs (template)
|
||
"Compute the formal arglist to use for TEMPLATE."
|
||
(let ((max 0) (i 0))
|
||
(while (string-match "\\$\\([0-9]+\\)" template i)
|
||
(setq i (match-end 0))
|
||
(setq max (max max (string-to-number (match-string 1 template)))))
|
||
(let ((args '(&rest _)))
|
||
(if (< max 1) args ;Avoid `&optional &rest', refused by Emacs-26!
|
||
(while (> max 0)
|
||
(push (intern (format "$%d" max)) args)
|
||
(setq max (1- max)))
|
||
(cons '&optional args)))))
|
||
|
||
(defun org-macro--set-templates (templates)
|
||
"Set template for the macro NAME.
|
||
VALUE is the template of the macro. The new value override the
|
||
previous one, unless VALUE is nil. Return the updated list."
|
||
(let ((new-templates nil))
|
||
(pcase-dolist (`(,name . ,value) templates)
|
||
(let ((old-definition (assoc name new-templates)))
|
||
;; This code can be evaluated unconditionally, as a part of
|
||
;; loading Org mode. We *must not* evaluate any code present
|
||
;; inside the Org buffer while loading. Org buffers may come
|
||
;; from various sources, like received email messages from
|
||
;; potentially malicious senders. Org mode might be used to
|
||
;; preview such messages and no code evaluation from inside the
|
||
;; received Org text should ever happen without user consent.
|
||
(when (and (stringp value) (string-match-p "\\`(eval\\>" value))
|
||
;; Pre-process the evaluation form for faster macro expansion.
|
||
(let* ((args (org-macro--makeargs value))
|
||
(body
|
||
(condition-case nil
|
||
;; `value' is of the form "(eval ...)" but we
|
||
;; don't want this to mean to pass the result to
|
||
;; `eval' (which would cause double evaluation),
|
||
;; so we strip the `eval' away with `cadr'.
|
||
(cadr (read value))
|
||
(error
|
||
(user-error "Invalid definition for macro %S" name)))))
|
||
(setq value `(lambda ,args ,body))))
|
||
(cond ((and value old-definition) (setcdr old-definition value))
|
||
(old-definition)
|
||
(t (push (cons name (or value "")) new-templates)))))
|
||
new-templates))
|
||
|
||
(defun org-macro--collect-macros ()
|
||
"Collect macro definitions in current buffer and setup files.
|
||
Return an alist containing all macro templates found."
|
||
(let ((templates
|
||
`(("author" . ,(org-macro--find-keyword-value "AUTHOR" t))
|
||
("email" . ,(org-macro--find-keyword-value "EMAIL"))
|
||
("title" . ,(org-macro--find-keyword-value "TITLE" t))
|
||
("date" . ,(org-macro--find-date)))))
|
||
(pcase (org-collect-keywords '("MACRO"))
|
||
(`(("MACRO" . ,values))
|
||
(dolist (value values)
|
||
(when (string-match "^\\(\\S-+\\)[ \t]*" value)
|
||
(let ((name (match-string 1 value))
|
||
(definition (substring value (match-end 0))))
|
||
(push (cons name definition) templates))))))
|
||
templates))
|
||
|
||
(defun org-macro-initialize-templates (&optional default)
|
||
"Collect macro templates defined in current buffer.
|
||
|
||
DEFAULT is a list of globally available templates.
|
||
|
||
Templates are stored in buffer-local variable `org-macro-templates'.
|
||
|
||
In addition to buffer-defined macros, the function installs the
|
||
following ones: \"n\", \"author\", \"email\", \"keyword\",
|
||
\"time\", \"property\", and, if the buffer is associated to
|
||
a file, \"input-file\" and \"modification-time\"."
|
||
(require 'org-element)
|
||
(org-macro--counter-initialize) ;for "n" macro
|
||
(setq org-macro-templates
|
||
(nconc
|
||
;; Install user-defined macros. Local macros have higher
|
||
;; precedence than global ones.
|
||
(org-macro--set-templates (append default (org-macro--collect-macros)))
|
||
;; Install file-specific macros.
|
||
(let ((visited-file (buffer-file-name (buffer-base-buffer))))
|
||
(and visited-file
|
||
(file-exists-p visited-file)
|
||
(list
|
||
`("input-file" . ,(file-name-nondirectory visited-file))
|
||
`("modification-time" .
|
||
,(let ((modtime (file-attribute-modification-time
|
||
(file-attributes visited-file))))
|
||
(lambda (arg1 &optional arg2 &rest _)
|
||
(format-time-string
|
||
arg1
|
||
(or (and (org-string-nw-p arg2)
|
||
(org-macro--vc-modified-time visited-file))
|
||
modtime))))))))
|
||
;; Install generic macros.
|
||
'(("keyword" . (lambda (arg1 &rest _)
|
||
(org-macro--find-keyword-value arg1 t)))
|
||
("n" . (lambda (&optional arg1 arg2 &rest _)
|
||
(org-macro--counter-increment arg1 arg2)))
|
||
("property" . (lambda (arg1 &optional arg2 &rest _)
|
||
(org-macro--get-property arg1 arg2)))
|
||
("time" . (lambda (arg1 &rest _)
|
||
(format-time-string arg1)))))))
|
||
|
||
(defun org-macro-expand (macro templates)
|
||
"Return expanded MACRO, as a string.
|
||
MACRO is an object, obtained, for example, with
|
||
`org-element-context'. TEMPLATES is an alist of templates used
|
||
for expansion. See `org-macro-templates' for a buffer-local
|
||
default value. Return nil if no template was found."
|
||
(let ((template
|
||
;; Macro names are case-insensitive.
|
||
(cdr (assoc-string (org-element-property :key macro) templates t))))
|
||
(when template
|
||
(let* ((value
|
||
(if (functionp template)
|
||
(apply template (org-element-property :args macro))
|
||
(replace-regexp-in-string
|
||
"\\$[0-9]+"
|
||
(lambda (m)
|
||
(or (nth (1- (string-to-number (substring m 1)))
|
||
(org-element-property :args macro))
|
||
;; No argument: remove place-holder.
|
||
""))
|
||
template nil 'literal))))
|
||
;; Force return value to be a string.
|
||
(format "%s" (or value ""))))))
|
||
|
||
(defun org-macro-replace-all (templates &optional keywords)
|
||
"Replace all macros in current buffer by their expansion.
|
||
|
||
TEMPLATES is an alist of templates used for expansion. See
|
||
`org-macro-templates' for a buffer-local default value.
|
||
|
||
Optional argument KEYWORDS, when non-nil is a list of keywords,
|
||
as strings, where macro expansion is allowed.
|
||
|
||
Return an error if a macro in the buffer cannot be associated to
|
||
a definition in TEMPLATES."
|
||
(org-with-wide-buffer
|
||
(goto-char (point-min))
|
||
(let ((properties-regexp (format "\\`EXPORT_%s\\+?\\'"
|
||
(regexp-opt keywords)))
|
||
record)
|
||
(while (re-search-forward "{{{[-A-Za-z0-9_]" nil t)
|
||
(unless (save-match-data (org-in-commented-heading-p))
|
||
(let* ((datum (save-match-data (org-element-context)))
|
||
(type (org-element-type datum))
|
||
(macro
|
||
(cond
|
||
((eq type 'macro) datum)
|
||
;; In parsed keywords and associated node
|
||
;; properties, force macro recognition.
|
||
((or (and (eq type 'keyword)
|
||
(member (org-element-property :key datum) keywords))
|
||
(and (eq type 'node-property)
|
||
(string-match-p properties-regexp
|
||
(org-element-property :key datum))))
|
||
(save-excursion
|
||
(goto-char (match-beginning 0))
|
||
(org-element-macro-parser))))))
|
||
(when macro
|
||
;; `:parent' property might change as we modify buffer.
|
||
;; We do not care about it when checking for circular
|
||
;; dependencies. So, setting `:parent' to nil making sure
|
||
;; that actual macro element (if org-element-cache is
|
||
;; active) is unchanged.
|
||
(setq macro (cl-copy-list macro))
|
||
(org-element-put-property macro :parent nil)
|
||
(let* ((key (org-element-property :key macro))
|
||
(value (org-macro-expand macro templates))
|
||
(begin (org-element-begin macro))
|
||
(signature (list begin
|
||
macro
|
||
(org-element-property :args macro))))
|
||
;; Avoid circular dependencies by checking if the same
|
||
;; macro with the same arguments is expanded at the
|
||
;; same position twice.
|
||
(cond ((member signature record)
|
||
(error "Circular macro expansion: %s" key))
|
||
(value
|
||
(push signature record)
|
||
(delete-region
|
||
begin
|
||
;; Preserve white spaces after the macro.
|
||
(progn (goto-char (org-element-end macro))
|
||
(skip-chars-backward " \t")
|
||
(point)))
|
||
;; Leave point before replacement in case of
|
||
;; recursive expansions.
|
||
(save-excursion (insert value)))
|
||
;; Special "results" macro: if it is not defined,
|
||
;; simply leave it as-is. It will be expanded in
|
||
;; a second phase.
|
||
((equal key "results"))
|
||
(t
|
||
(error "Undefined Org macro: %s; aborting"
|
||
(org-element-property :key macro))))))))))))
|
||
|
||
(defun org-macro-escape-arguments (&rest args)
|
||
"Build macro's arguments string from ARGS.
|
||
ARGS are strings. Return value is a string with arguments
|
||
properly escaped and separated with commas. This is the opposite
|
||
of `org-macro-extract-arguments'."
|
||
(let ((s ""))
|
||
(dolist (arg (reverse args) (substring s 1))
|
||
(setq s
|
||
(concat
|
||
","
|
||
(replace-regexp-in-string
|
||
"\\(\\\\*\\),"
|
||
(lambda (m)
|
||
(concat (make-string (1+ (* 2 (length (match-string 1 m)))) ?\\)
|
||
","))
|
||
;; If a non-terminal argument ends on backslashes, make
|
||
;; sure to also escape them as they will be followed by
|
||
;; a comma.
|
||
(concat arg (and (not (equal s ""))
|
||
(string-match "\\\\+\\'" arg)
|
||
(match-string 0 arg)))
|
||
nil t)
|
||
s)))))
|
||
|
||
(defun org-macro-extract-arguments (s)
|
||
"Extract macro arguments from string S.
|
||
S is a string containing comma separated values properly escaped.
|
||
Return a list of arguments, as strings. This is the opposite of
|
||
`org-macro-escape-arguments'."
|
||
;; Do not use `org-split-string' since empty strings are
|
||
;; meaningful here.
|
||
(split-string
|
||
(replace-regexp-in-string
|
||
"\\(\\\\*\\),"
|
||
(lambda (str)
|
||
(let ((len (length (match-string 1 str))))
|
||
(concat (make-string (/ len 2) ?\\)
|
||
(if (zerop (mod len 2)) "\000" ","))))
|
||
s nil t)
|
||
"\000"))
|
||
|
||
|
||
;;; Helper functions and variables for internal macros
|
||
|
||
(defun org-macro--get-property (property location)
|
||
"Find PROPERTY's value at LOCATION.
|
||
PROPERTY is a string. LOCATION is a search string, as expected
|
||
by `org-link-search', or the empty string."
|
||
(org-with-wide-buffer
|
||
(when (org-string-nw-p location)
|
||
(condition-case _
|
||
(let ((org-link-search-must-match-exact-headline t))
|
||
(org-link-search location nil t))
|
||
(error
|
||
(error "Macro property failed: cannot find location %s" location))))
|
||
(org-entry-get nil property 'selective)))
|
||
|
||
(defun org-macro--find-keyword-value (name &optional collect)
|
||
"Find value for keyword NAME in current buffer.
|
||
Return value associated to the keywords named after NAME, as
|
||
a string, or nil. When optional argument COLLECT is non-nil,
|
||
concatenate values, separated with a space, from various keywords
|
||
in the buffer."
|
||
(org-with-point-at 1
|
||
(let ((regexp (format "^[ \t]*#\\+%s:" (regexp-quote name)))
|
||
(case-fold-search t)
|
||
(result nil))
|
||
(catch :exit
|
||
(while (re-search-forward regexp nil t)
|
||
(let ((element (org-with-point-at (match-beginning 0) (org-element-keyword-parser (line-end-position) (list (match-beginning 0))))))
|
||
(when (org-element-type-p element 'keyword)
|
||
(let ((value (org-element-property :value element)))
|
||
(if (not collect) (throw :exit value)
|
||
(setq result (concat result " " value)))))))
|
||
(and result (org-trim result))))))
|
||
|
||
(defun org-macro--find-date ()
|
||
"Find value for DATE in current buffer.
|
||
Return value as a string."
|
||
(let* ((value (org-macro--find-keyword-value "DATE"))
|
||
(date (org-element-parse-secondary-string
|
||
value (org-element-restriction 'keyword))))
|
||
(if (and (consp date)
|
||
(not (cdr date))
|
||
(org-element-type-p (car date) 'timestamp))
|
||
(format "(eval (if (org-string-nw-p $1) %s %S))"
|
||
(format "(org-format-timestamp '%S $1)"
|
||
(org-element-put-property
|
||
(org-element-copy (car date))
|
||
;; Remove non-printable.
|
||
:buffer nil))
|
||
value)
|
||
value)))
|
||
|
||
(defun org-macro--vc-modified-time (file)
|
||
(require 'vc) ; Not everything we need is autoloaded.
|
||
(save-window-excursion
|
||
(when (vc-backend file)
|
||
(let ((buf (get-buffer-create " *org-vc*"))
|
||
(case-fold-search t)
|
||
date)
|
||
(unwind-protect
|
||
(progn
|
||
(vc-call print-log (list file) buf nil nil 1)
|
||
(with-current-buffer buf
|
||
(vc-exec-after
|
||
(lambda ()
|
||
(goto-char (point-min))
|
||
(when (re-search-forward "Date:?[ \t]*" nil t)
|
||
(let ((time (parse-time-string
|
||
(buffer-substring
|
||
(point) (line-end-position)))))
|
||
(when (cl-some #'identity time)
|
||
(setq date (org-encode-time time))))))))
|
||
(let ((proc (get-buffer-process buf)))
|
||
(while (and proc (accept-process-output proc .5 nil t)))))
|
||
(kill-buffer buf))
|
||
date))))
|
||
|
||
(defvar org-macro--counter-table nil
|
||
"Hash table containing counter value per name.")
|
||
|
||
(defun org-macro--counter-initialize ()
|
||
"Initialize `org-macro--counter-table'."
|
||
(setq org-macro--counter-table (make-hash-table :test #'equal)))
|
||
|
||
(defun org-macro--counter-increment (name &optional action)
|
||
"Increment counter NAME.
|
||
NAME is a string identifying the counter.
|
||
|
||
When non-nil, optional argument ACTION is a string.
|
||
|
||
If the string is \"-\", keep the NAME counter at its current
|
||
value, i.e. do not increment.
|
||
|
||
If the string represents an integer, set the counter to this number.
|
||
|
||
Any other non-empty string resets the counter to 1."
|
||
(let ((name-trimmed (if (stringp name) (org-trim name) ""))
|
||
(action-trimmed (when (org-string-nw-p action)
|
||
(org-trim action))))
|
||
(puthash name-trimmed
|
||
(cond ((not (org-string-nw-p action-trimmed))
|
||
(1+ (gethash name-trimmed org-macro--counter-table 0)))
|
||
((string= "-" action-trimmed)
|
||
(gethash name-trimmed org-macro--counter-table 1))
|
||
((string-match-p "\\`[0-9]+\\'" action-trimmed)
|
||
(string-to-number action-trimmed))
|
||
(t 1))
|
||
org-macro--counter-table)))
|
||
|
||
(provide 'org-macro)
|
||
|
||
;;; org-macro.el ends here
|