Merge branch 'maint'
[org-mode.git] / lisp / ob-abc.el
blobfe46a7f5325aec76ef9a3768015931969e13ec6c
1 ;;; ob-abc.el --- Org Babel Functions for ABC -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2013-2016 Free Software Foundation, Inc.
5 ;; Author: William Waites
6 ;; Keywords: literate programming, music
7 ;; Homepage: http://www.tardis.ed.ac.uk/wwaites
8 ;; Version: 0.01
10 ;;; License:
12 ;; This program is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; This program is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;;; This file adds support to Org Babel for music in ABC notation.
30 ;;; It requires that the abcm2ps program is installed.
31 ;;; See http://moinejf.free.fr/
33 (require 'ob)
35 ;; optionally define a file extension for this language
36 (add-to-list 'org-babel-tangle-lang-exts '("abc" . "abc"))
38 ;; optionally declare default header arguments for this language
39 (defvar org-babel-default-header-args:abc
40 '((:results . "file") (:exports . "results"))
41 "Default arguments to use when evaluating an ABC source block.")
43 (defun org-babel-expand-body:abc (body params)
44 "Expand BODY according to PARAMS, return the expanded body."
45 (let ((vars (org-babel--get-vars params)))
46 (mapc
47 (lambda (pair)
48 (let ((name (symbol-name (car pair)))
49 (value (cdr pair)))
50 (setq body
51 (replace-regexp-in-string
52 (concat "\$" (regexp-quote name))
53 (if (stringp value) value (format "%S" value))
54 body))))
55 vars)
56 body))
58 (defun org-babel-execute:abc (body params)
59 "Execute a block of ABC code with org-babel. This function is
60 called by `org-babel-execute-src-block'"
61 (message "executing Abc source code block")
62 (let* ((cmdline (cdr (assoc :cmdline params)))
63 (out-file (let ((file (cdr (assq :file params))))
64 (if file (replace-regexp-in-string "\.pdf$" ".ps" file)
65 (error "abc code block requires :file header argument"))))
66 (in-file (org-babel-temp-file "abc-"))
67 (render (concat "abcm2ps" " " cmdline
68 " -O " (org-babel-process-file-name out-file)
69 " " (org-babel-process-file-name in-file))))
70 (with-temp-file in-file (insert (org-babel-expand-body:abc body params)))
71 (org-babel-eval render "")
72 ;;; handle where abcm2ps changes the file name (to support multiple files
73 (when (or (string= (file-name-extension out-file) "eps")
74 (string= (file-name-extension out-file) "svg"))
75 (rename-file (concat
76 (file-name-sans-extension out-file) "001."
77 (file-name-extension out-file))
78 out-file t))
79 ;;; if we were asked for a pdf...
80 (when (string= (file-name-extension (cdr (assoc :file params))) "pdf")
81 (org-babel-eval (concat "ps2pdf" " " out-file " " (cdr (assoc :file params))) ""))
82 ;;; indicate that the file has been written
83 nil))
85 ;; This function should be used to assign any variables in params in
86 ;; the context of the session environment.
87 (defun org-babel-prep-session:abc (_session _params)
88 "Return an error because abc does not support sessions."
89 (error "ABC does not support sessions"))
91 (provide 'ob-abc)
92 ;;; ob-abc.el ends here