2015-10-26 00:56:00 +00:00
|
|
|
;;; ob-ditaa.el --- Babel Functions for ditaa -*- lexical-binding: t; -*-
|
2009-07-17 00:12:11 +00:00
|
|
|
|
2021-01-01 19:55:31 +00:00
|
|
|
;; Copyright (C) 2009-2021 Free Software Foundation, Inc.
|
2009-07-17 00:12:11 +00:00
|
|
|
|
|
|
|
;; Author: Eric Schulte
|
|
|
|
;; Keywords: literate programming, reproducible research
|
2018-01-16 16:22:00 +00:00
|
|
|
;; Homepage: https://orgmode.org
|
2009-07-17 00:12:11 +00:00
|
|
|
|
2010-06-25 16:32:35 +00:00
|
|
|
;; This file is part of GNU Emacs.
|
2009-07-17 00:12:11 +00:00
|
|
|
|
2010-06-25 16:32:35 +00:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2009-07-17 00:12:11 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2010-06-25 16:32:35 +00:00
|
|
|
;; 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,
|
2009-07-17 00:12:11 +00:00
|
|
|
;; 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.
|
2010-06-25 16:32:35 +00:00
|
|
|
|
2009-07-17 00:12:11 +00:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2017-09-13 22:52:52 +00:00
|
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
2009-07-17 00:12:11 +00:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Org-Babel support for evaluating ditaa source code.
|
|
|
|
;;
|
|
|
|
;; This differs from most standard languages in that
|
|
|
|
;;
|
|
|
|
;; 1) there is no such thing as a "session" in ditaa
|
|
|
|
;;
|
|
|
|
;; 2) we are generally only going to return results of type "file"
|
|
|
|
;;
|
|
|
|
;; 3) we are adding the "file" and "cmdline" header arguments
|
|
|
|
;;
|
|
|
|
;; 4) there are no variables (at least for now)
|
|
|
|
|
|
|
|
;;; Code:
|
2010-06-11 23:02:42 +00:00
|
|
|
(require 'ob)
|
2012-10-26 06:18:07 +00:00
|
|
|
(require 'org-compat)
|
2012-02-29 20:23:29 +00:00
|
|
|
|
2009-09-01 21:30:39 +00:00
|
|
|
(defvar org-babel-default-header-args:ditaa
|
2012-03-19 20:38:12 +00:00
|
|
|
'((:results . "file")
|
|
|
|
(:exports . "results")
|
|
|
|
(:java . "-Dfile.encoding=UTF-8"))
|
2010-07-13 23:04:47 +00:00
|
|
|
"Default arguments for evaluating a ditaa source block.")
|
2009-07-17 00:52:31 +00:00
|
|
|
|
2012-08-19 20:19:59 +00:00
|
|
|
(defcustom org-ditaa-jar-path (expand-file-name
|
|
|
|
"ditaa.jar"
|
|
|
|
(file-name-as-directory
|
|
|
|
(expand-file-name
|
|
|
|
"scripts"
|
|
|
|
(file-name-as-directory
|
|
|
|
(expand-file-name
|
|
|
|
"../contrib"
|
|
|
|
(file-name-directory (org-find-library-dir "org")))))))
|
|
|
|
"Path to the ditaa jar executable."
|
|
|
|
:group 'org-babel
|
|
|
|
:type 'string)
|
|
|
|
|
2013-07-17 14:20:37 +00:00
|
|
|
(defcustom org-babel-ditaa-java-cmd "java"
|
|
|
|
"Java executable to use when evaluating ditaa blocks."
|
|
|
|
:group 'org-babel
|
|
|
|
:type 'string)
|
|
|
|
|
2012-09-13 14:58:31 +00:00
|
|
|
(defcustom org-ditaa-eps-jar-path
|
|
|
|
(expand-file-name "DitaaEps.jar" (file-name-directory org-ditaa-jar-path))
|
|
|
|
"Path to the DitaaEps.jar executable."
|
|
|
|
:group 'org-babel
|
Add :version and :package-version
* ox.el (org-export-snippet-translation-alist)
(org-export-coding-system, org-export-in-background)
(org-export-async-init-file, org-export-invisible-backends)
(org-export-dispatch-use-expert-ui):
* ox-texinfo.el (org-texinfo-filename, org-texinfo-classes)
(org-texinfo-format-headline-function)
(org-texinfo-node-description-column)
(org-texinfo-active-timestamp-format)
(org-texinfo-link-with-unknown-path-format)
(org-texinfo-tables-verbatim)
(org-texinfo-table-scientific-notation)
(org-texinfo-text-markup-alist)
(org-texinfo-format-drawer-function)
(org-texinfo-format-inlinetask-function)
(org-texinfo-info-process):
* ox-man.el (org-man-tables-centered)
(org-man-table-scientific-notation)
(org-man-source-highlight, org-man-source-highlight-langs)
(org-man-pdf-process, org-man-logfiles-extensions):
* ox-html.el (org-html-allow-name-attribute-in-anchors)
(org-html-coding-system, org-html-divs):
* ox-ascii.el (org-ascii-text-width)
(org-ascii-headline-spacing, org-ascii-indented-line-width)
(org-ascii-paragraph-spacing, org-ascii-charset)
(org-ascii-underline, org-ascii-bullets)
(org-ascii-links-to-notes)
(org-ascii-table-keep-all-vertical-lines)
(org-ascii-table-widen-columns)
(org-ascii-table-use-ascii-art)
(org-ascii-format-drawer-function)
(org-ascii-format-inlinetask-function):
* org.el (org-modules, org-export-backends)
(org-highlight-latex-and-related, orgstruct-setup-hook):
* org-attach.el (org-attach-git-annex-cutoff):
* org-archive.el (org-archive-file-header-format):
* org-agenda.el (org-agenda-todo-ignore-time-comparison-use-seconds):
* ob-python.el (org-babel-python-hline-to)
(org-babel-python-None-to):
* ob-ditaa.el (org-ditaa-eps-jar-path):
* ob-core.el (org-babel-results-keyword): Add :version and
:package-version.
* ox-ascii.el: Use utf-8-emacs as the file coding system.
2013-03-05 15:34:16 +00:00
|
|
|
:version "24.4"
|
|
|
|
:package-version '(Org . "8.0")
|
2012-09-13 14:58:31 +00:00
|
|
|
:type 'string)
|
|
|
|
|
2012-03-19 20:38:12 +00:00
|
|
|
(defcustom org-ditaa-jar-option "-jar"
|
|
|
|
"Option for the ditaa jar file.
|
|
|
|
Do not leave leading or trailing spaces in this string."
|
|
|
|
:group 'org-babel
|
|
|
|
:version "24.1"
|
|
|
|
:type 'string)
|
|
|
|
|
2009-07-17 00:12:11 +00:00
|
|
|
(defun org-babel-execute:ditaa (body params)
|
2010-07-13 23:04:47 +00:00
|
|
|
"Execute a block of Ditaa code with org-babel.
|
|
|
|
This function is called by `org-babel-execute-src-block'."
|
2016-09-22 17:45:15 +00:00
|
|
|
(let* ((out-file (or (cdr (assq :file params))
|
2015-10-26 00:56:00 +00:00
|
|
|
(error
|
|
|
|
"ditaa code block requires :file header argument")))
|
2016-09-22 17:45:15 +00:00
|
|
|
(cmdline (cdr (assq :cmdline params)))
|
|
|
|
(java (cdr (assq :java params)))
|
2010-09-02 00:08:26 +00:00
|
|
|
(in-file (org-babel-temp-file "ditaa-"))
|
2016-09-22 17:45:15 +00:00
|
|
|
(eps (cdr (assq :eps params)))
|
2014-06-06 16:21:56 +00:00
|
|
|
(eps-file (when eps
|
|
|
|
(org-babel-process-file-name (concat in-file ".eps"))))
|
2014-06-06 16:19:45 +00:00
|
|
|
(pdf-cmd (when (and (or (string= (file-name-extension out-file) "pdf")
|
2016-09-22 17:45:15 +00:00
|
|
|
(cdr (assq :pdf params))))
|
2014-06-06 16:19:45 +00:00
|
|
|
(concat
|
|
|
|
"epstopdf"
|
2014-06-06 16:21:56 +00:00
|
|
|
" " eps-file
|
2014-06-06 16:19:45 +00:00
|
|
|
" -o=" (org-babel-process-file-name out-file))))
|
2013-07-17 14:20:37 +00:00
|
|
|
(cmd (concat org-babel-ditaa-java-cmd
|
|
|
|
" " java " " org-ditaa-jar-option " "
|
2010-09-02 00:08:26 +00:00
|
|
|
(shell-quote-argument
|
2012-09-13 14:58:31 +00:00
|
|
|
(expand-file-name
|
|
|
|
(if eps org-ditaa-eps-jar-path org-ditaa-jar-path)))
|
2010-09-22 20:40:14 +00:00
|
|
|
" " cmdline
|
|
|
|
" " (org-babel-process-file-name in-file)
|
2014-06-06 16:19:45 +00:00
|
|
|
" " (if pdf-cmd
|
2014-06-06 16:21:56 +00:00
|
|
|
eps-file
|
2014-06-06 16:19:45 +00:00
|
|
|
(org-babel-process-file-name out-file)))))
|
2009-07-17 00:12:11 +00:00
|
|
|
(unless (file-exists-p org-ditaa-jar-path)
|
2010-07-06 17:30:58 +00:00
|
|
|
(error "Could not find ditaa.jar at %s" org-ditaa-jar-path))
|
2009-07-17 00:12:11 +00:00
|
|
|
(with-temp-file in-file (insert body))
|
2010-09-02 00:08:26 +00:00
|
|
|
(message cmd) (shell-command cmd)
|
2012-09-13 14:58:31 +00:00
|
|
|
(when pdf-cmd (message pdf-cmd) (shell-command pdf-cmd))
|
2010-12-21 10:21:28 +00:00
|
|
|
nil)) ;; signal that output has already been written to file
|
2009-07-17 00:12:11 +00:00
|
|
|
|
2015-10-26 00:56:00 +00:00
|
|
|
(defun org-babel-prep-session:ditaa (_session _params)
|
2010-07-13 23:04:47 +00:00
|
|
|
"Return an error because ditaa does not support sessions."
|
2009-07-17 00:12:11 +00:00
|
|
|
(error "Ditaa does not support sessions"))
|
|
|
|
|
2010-06-11 23:02:42 +00:00
|
|
|
(provide 'ob-ditaa)
|
2010-06-25 16:32:35 +00:00
|
|
|
|
2010-06-11 23:02:42 +00:00
|
|
|
;;; ob-ditaa.el ends here
|