;;; ob-lilypond.el --- Babel Functions for Lilypond -*- lexical-binding: t; -*-
|
|
;; Copyright (C) 2010-2018 Free Software Foundation, Inc.
|
|
;; Author: Martyn Jago
|
;; Keywords: babel language, literate programming
|
;; Homepage: https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-lilypond.html
|
|
;; 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:
|
|
;; Installation, ob-lilypond documentation, and examples are available at
|
;; https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-lilypond.html
|
;;
|
;; Lilypond documentation can be found at
|
;; http://lilypond.org/manuals.html
|
;;
|
;; This depends on epstopdf --- See http://www.ctan.org/pkg/epstopdf.
|
|
;;; Code:
|
(require 'ob)
|
(require 'outline)
|
(defalias 'lilypond-mode 'LilyPond-mode)
|
|
(add-to-list 'org-babel-tangle-lang-exts '("LilyPond" . "ly"))
|
|
(defvar org-babel-default-header-args:lilypond '()
|
"Default header arguments for lilypond code blocks.
|
NOTE: The arguments are determined at lilypond compile time.
|
See (org-babel-lilypond-set-header-args)")
|
|
(defvar org-babel-lilypond-compile-post-tangle t
|
"Following the org-babel-tangle (C-c C-v t) command,
|
org-babel-lilypond-compile-post-tangle determines whether ob-lilypond should
|
automatically attempt to compile the resultant tangled file.
|
If the value is nil, no automated compilation takes place.
|
Default value is t")
|
|
(defvar org-babel-lilypond-display-pdf-post-tangle t
|
"Following a successful LilyPond compilation
|
org-babel-lilypond-display-pdf-post-tangle determines whether to automate the
|
drawing / redrawing of the resultant pdf. If the value is nil,
|
the pdf is not automatically redrawn. Default value is t")
|
|
(defvar org-babel-lilypond-play-midi-post-tangle t
|
"Following a successful LilyPond compilation
|
org-babel-lilypond-play-midi-post-tangle determines whether to automate the
|
playing of the resultant midi file. If the value is nil,
|
the midi file is not automatically played. Default value is t")
|
|
(defvar org-babel-lilypond-ly-command ""
|
"Command to execute lilypond on your system.
|
Do not set it directly. Customize `org-babel-lilypond-commands' instead.")
|
(defvar org-babel-lilypond-pdf-command ""
|
"Command to show a PDF file on your system.
|
Do not set it directly. Customize `org-babel-lilypond-commands' instead.")
|
(defvar org-babel-lilypond-midi-command ""
|
"Command to play a MIDI file on your system.
|
Do not set it directly. Customize `org-babel-lilypond-commands' instead.")
|
(defcustom org-babel-lilypond-commands
|
(cond
|
((eq system-type 'darwin)
|
'("/Applications/lilypond.app/Contents/Resources/bin/lilypond" "open" "open"))
|
((eq system-type 'windows-nt)
|
'("lilypond" "" ""))
|
(t
|
'("lilypond" "xdg-open" "xdg-open")))
|
"Commands to run lilypond and view or play the results.
|
These should be executables that take a filename as an argument.
|
On some system it is possible to specify the filename directly
|
and the viewer or player will be determined from the file type;
|
you can leave the string empty on this case."
|
:group 'org-babel
|
:type '(list
|
(string :tag "Lilypond ")
|
(string :tag "PDF Viewer ")
|
(string :tag "MIDI Player"))
|
:version "24.4"
|
:package-version '(Org . "8.2.7")
|
:set
|
(lambda (_symbol value)
|
(setq
|
org-babel-lilypond-ly-command (nth 0 value)
|
org-babel-lilypond-pdf-command (nth 1 value)
|
org-babel-lilypond-midi-command (nth 2 value))))
|
|
(defvar org-babel-lilypond-gen-png nil
|
"Non-nil means image generation (PNG) is turned on by default.")
|
|
(defvar org-babel-lilypond-gen-svg nil
|
"Non-nil means image generation (SVG) is be turned on by default.")
|
|
(defvar org-babel-lilypond-gen-html nil
|
"Non-nil means HTML generation is turned on by default.")
|
|
(defvar org-babel-lilypond-gen-pdf nil
|
"Non-nil means PDF generation is be turned on by default.")
|
|
(defvar org-babel-lilypond-use-eps nil
|
"Non-nil forces the compiler to use the EPS backend.")
|
|
(defvar org-babel-lilypond-arrange-mode nil
|
"Non-nil turns Arrange mode on.
|
In Arrange mode the following settings are altered from default:
|
:tangle yes, :noweb yes
|
:results silent :comments yes.
|
In addition lilypond block execution causes tangling of all lilypond
|
blocks.")
|
|
(defun org-babel-expand-body:lilypond (body params)
|
"Expand BODY according to PARAMS, return the expanded body."
|
(let ((vars (org-babel--get-vars params)))
|
(mapc
|
(lambda (pair)
|
(let ((name (symbol-name (car pair)))
|
(value (cdr pair)))
|
(setq body
|
(replace-regexp-in-string
|
(concat "$" (regexp-quote name))
|
(if (stringp value) value (format "%S" value))
|
body))))
|
vars)
|
body))
|
|
(defun org-babel-execute:lilypond (body params)
|
"This function is called by `org-babel-execute-src-block'.
|
Depending on whether we are in arrange mode either:
|
1. Attempt to execute lilypond block according to header settings
|
(This is the default basic mode)
|
2. Tangle all lilypond blocks and process the result (arrange mode)"
|
(org-babel-lilypond-set-header-args org-babel-lilypond-arrange-mode)
|
(if org-babel-lilypond-arrange-mode
|
(org-babel-lilypond-tangle)
|
(org-babel-lilypond-process-basic body params)))
|
|
(defun org-babel-lilypond-tangle ()
|
"ob-lilypond specific tangle, attempts to invoke
|
=ly-execute-tangled-ly= if tangle is successful. Also passes
|
specific arguments to =org-babel-tangle="
|
(interactive)
|
(if (org-babel-tangle nil "yes" "lilypond")
|
(org-babel-lilypond-execute-tangled-ly) nil))
|
|
(defun org-babel-lilypond-process-basic (body params)
|
"Execute a lilypond block in basic mode."
|
(let* ((out-file (cdr (assq :file params)))
|
(cmdline (or (cdr (assq :cmdline params))
|
""))
|
(in-file (org-babel-temp-file "lilypond-")))
|
|
(with-temp-file in-file
|
(insert (org-babel-expand-body:generic body params)))
|
(org-babel-eval
|
(concat
|
org-babel-lilypond-ly-command
|
" -dbackend=eps "
|
"-dno-gs-load-fonts "
|
"-dinclude-eps-fonts "
|
(or (cdr (assoc (file-name-extension out-file)
|
'(("pdf" . "--pdf ")
|
("ps" . "--ps ")
|
("png" . "--png "))))
|
"--png ")
|
"--output="
|
(file-name-sans-extension out-file)
|
" "
|
cmdline
|
in-file) "")) nil)
|
|
(defun org-babel-prep-session:lilypond (_session _params)
|
"Return an error because LilyPond exporter does not support sessions."
|
(error "Sorry, LilyPond does not currently support sessions!"))
|
|
(defun org-babel-lilypond-execute-tangled-ly ()
|
"Compile result of block tangle with lilypond.
|
If error in compilation, attempt to mark the error in lilypond org file"
|
(when org-babel-lilypond-compile-post-tangle
|
(let ((org-babel-lilypond-tangled-file (org-babel-lilypond-switch-extension
|
(buffer-file-name) ".lilypond"))
|
(org-babel-lilypond-temp-file (org-babel-lilypond-switch-extension
|
(buffer-file-name) ".ly")))
|
(if (not (file-exists-p org-babel-lilypond-tangled-file))
|
(error "Error: Tangle Failed!")
|
(when (file-exists-p org-babel-lilypond-temp-file)
|
(delete-file org-babel-lilypond-temp-file))
|
(rename-file org-babel-lilypond-tangled-file
|
org-babel-lilypond-temp-file))
|
(switch-to-buffer-other-window "*lilypond*")
|
(erase-buffer)
|
(org-babel-lilypond-compile-lilyfile org-babel-lilypond-temp-file)
|
(goto-char (point-min))
|
(if (org-babel-lilypond-check-for-compile-error org-babel-lilypond-temp-file)
|
(error "Error in Compilation!")
|
(other-window -1)
|
(org-babel-lilypond-attempt-to-open-pdf org-babel-lilypond-temp-file)
|
(org-babel-lilypond-attempt-to-play-midi org-babel-lilypond-temp-file)))))
|
|
(defun org-babel-lilypond-compile-lilyfile (file-name &optional test)
|
"Compile lilypond file and check for compile errors
|
FILE-NAME is full path to lilypond (.ly) file"
|
(message "Compiling LilyPond...")
|
(let ((arg-1 org-babel-lilypond-ly-command) ;program
|
(arg-2 nil) ;infile
|
(arg-3 "*lilypond*") ;buffer
|
(arg-4 t) ;display
|
(arg-5 (if org-babel-lilypond-gen-png "--png" "")) ;&rest...
|
(arg-6 (if org-babel-lilypond-gen-html "--html" ""))
|
(arg-7 (if org-babel-lilypond-gen-pdf "--pdf" ""))
|
(arg-8 (if org-babel-lilypond-use-eps "-dbackend=eps" ""))
|
(arg-9 (if org-babel-lilypond-gen-svg "-dbackend=svg" ""))
|
(arg-10 (concat "--output=" (file-name-sans-extension file-name)))
|
(arg-11 file-name))
|
(if test
|
`(,arg-1 ,arg-2 ,arg-3 ,arg-4 ,arg-5 ,arg-6
|
,arg-7 ,arg-8 ,arg-9 ,arg-10 ,arg-11)
|
(call-process
|
arg-1 arg-2 arg-3 arg-4 arg-5 arg-6
|
arg-7 arg-8 arg-9 arg-10 arg-11))))
|
|
(defun org-babel-lilypond-check-for-compile-error (file-name &optional test)
|
"Check for compile error.
|
This is performed by parsing the *lilypond* buffer
|
containing the output message from the compilation.
|
FILE-NAME is full path to lilypond file.
|
If TEST is t just return nil if no error found, and pass
|
nil as file-name since it is unused in this context"
|
(let ((is-error (search-forward "error:" nil t)))
|
(if test
|
is-error
|
(when is-error
|
(org-babel-lilypond-process-compile-error file-name)))))
|
|
(defun org-babel-lilypond-process-compile-error (file-name)
|
"Process the compilation error that has occurred.
|
FILE-NAME is full path to lilypond file"
|
(let ((line-num (org-babel-lilypond-parse-line-num)))
|
(let ((error-lines (org-babel-lilypond-parse-error-line file-name line-num)))
|
(org-babel-lilypond-mark-error-line file-name error-lines)
|
(error "Error: Compilation Failed!"))))
|
|
(defun org-babel-lilypond-mark-error-line (file-name line)
|
"Mark the erroneous lines in the lilypond org buffer.
|
FILE-NAME is full path to lilypond file.
|
LINE is the erroneous line"
|
(switch-to-buffer-other-window
|
(concat (file-name-nondirectory
|
(org-babel-lilypond-switch-extension file-name ".org"))))
|
(let ((temp (point)))
|
(goto-char (point-min))
|
(setq case-fold-search nil)
|
(if (search-forward line nil t)
|
(progn
|
(outline-show-all)
|
(set-mark (point))
|
(goto-char (- (point) (length line))))
|
(goto-char temp))))
|
|
(defun org-babel-lilypond-parse-line-num (&optional buffer)
|
"Extract error line number."
|
(when buffer (set-buffer buffer))
|
(let ((start
|
(and (search-backward ":" nil t)
|
(search-backward ":" nil t)
|
(search-backward ":" nil t)
|
(search-backward ":" nil t))))
|
(when start
|
(forward-char)
|
(let ((num (string-to-number
|
(buffer-substring
|
(+ 1 start)
|
(- (search-forward ":" nil t) 1)))))
|
(and (numberp num) num)))))
|
|
(defun org-babel-lilypond-parse-error-line (file-name lineNo)
|
"Extract the erroneous line from the tangled .ly file
|
FILE-NAME is full path to lilypond file.
|
LINENO is the number of the erroneous line"
|
(with-temp-buffer
|
(insert-file-contents (org-babel-lilypond-switch-extension file-name ".ly")
|
nil nil nil t)
|
(if (> lineNo 0)
|
(progn
|
(goto-char (point-min))
|
(forward-line (- lineNo 1))
|
(buffer-substring (point) (point-at-eol)))
|
nil)))
|
|
(defun org-babel-lilypond-attempt-to-open-pdf (file-name &optional test)
|
"Attempt to display the generated pdf file
|
FILE-NAME is full path to lilypond file
|
If TEST is non-nil, the shell command is returned and is not run"
|
(when org-babel-lilypond-display-pdf-post-tangle
|
(let ((pdf-file (org-babel-lilypond-switch-extension file-name ".pdf")))
|
(if (file-exists-p pdf-file)
|
(let ((cmd-string
|
(concat org-babel-lilypond-pdf-command " " pdf-file)))
|
(if test
|
cmd-string
|
(start-process
|
"\"Audition pdf\""
|
"*lilypond*"
|
org-babel-lilypond-pdf-command
|
pdf-file)))
|
(message "No pdf file generated so can't display!")))))
|
|
(defun org-babel-lilypond-attempt-to-play-midi (file-name &optional test)
|
"Attempt to play the generated MIDI file
|
FILE-NAME is full path to lilypond file
|
If TEST is non-nil, the shell command is returned and is not run"
|
(when org-babel-lilypond-play-midi-post-tangle
|
(let ((midi-file (org-babel-lilypond-switch-extension file-name ".midi")))
|
(if (file-exists-p midi-file)
|
(let ((cmd-string
|
(concat org-babel-lilypond-midi-command " " midi-file)))
|
(if test
|
cmd-string
|
(start-process
|
"\"Audition midi\""
|
"*lilypond*"
|
org-babel-lilypond-midi-command
|
midi-file)))
|
(message "No midi file generated so can't play!")))))
|
|
(defun org-babel-lilypond-toggle-midi-play ()
|
"Toggle whether midi will be played following a successful compilation."
|
(interactive)
|
(setq org-babel-lilypond-play-midi-post-tangle
|
(not org-babel-lilypond-play-midi-post-tangle))
|
(message (concat "Post-Tangle MIDI play has been "
|
(if org-babel-lilypond-play-midi-post-tangle
|
"ENABLED." "DISABLED."))))
|
|
(defun org-babel-lilypond-toggle-pdf-display ()
|
"Toggle whether pdf will be displayed following a successful compilation."
|
(interactive)
|
(setq org-babel-lilypond-display-pdf-post-tangle
|
(not org-babel-lilypond-display-pdf-post-tangle))
|
(message (concat "Post-Tangle PDF display has been "
|
(if org-babel-lilypond-display-pdf-post-tangle
|
"ENABLED." "DISABLED."))))
|
|
(defun org-babel-lilypond-toggle-png-generation ()
|
"Toggle whether png image will be generated by compilation."
|
(interactive)
|
(setq org-babel-lilypond-gen-png (not org-babel-lilypond-gen-png))
|
(message (concat "PNG image generation has been "
|
(if org-babel-lilypond-gen-png "ENABLED." "DISABLED."))))
|
|
(defun org-babel-lilypond-toggle-html-generation ()
|
"Toggle whether html will be generated by compilation."
|
(interactive)
|
(setq org-babel-lilypond-gen-html (not org-babel-lilypond-gen-html))
|
(message (concat "HTML generation has been "
|
(if org-babel-lilypond-gen-html "ENABLED." "DISABLED."))))
|
|
(defun org-babel-lilypond-toggle-pdf-generation ()
|
"Toggle whether pdf will be generated by compilation."
|
(interactive)
|
(setq org-babel-lilypond-gen-pdf (not org-babel-lilypond-gen-pdf))
|
(message (concat "PDF generation has been "
|
(if org-babel-lilypond-gen-pdf "ENABLED." "DISABLED."))))
|
|
(defun org-babel-lilypond-toggle-arrange-mode ()
|
"Toggle whether in Arrange mode or Basic mode."
|
(interactive)
|
(setq org-babel-lilypond-arrange-mode
|
(not org-babel-lilypond-arrange-mode))
|
(message (concat "Arrange mode has been "
|
(if org-babel-lilypond-arrange-mode "ENABLED." "DISABLED."))))
|
|
(defun org-babel-lilypond-switch-extension (file-name ext)
|
"Utility command to swap current FILE-NAME extension with EXT"
|
(concat (file-name-sans-extension
|
file-name) ext))
|
|
(defun org-babel-lilypond-get-header-args (mode)
|
"Default arguments to use when evaluating a lilypond
|
source block. These depend upon whether we are in arrange
|
mode i.e. ARRANGE-MODE is t"
|
(cond (mode
|
'((:tangle . "yes")
|
(:noweb . "yes")
|
(:results . "silent")
|
(:cache . "yes")
|
(:comments . "yes")))
|
(t
|
'((:results . "file")
|
(:exports . "results")))))
|
|
(defun org-babel-lilypond-set-header-args (mode)
|
"Set org-babel-default-header-args:lilypond
|
dependent on ORG-BABEL-LILYPOND-ARRANGE-MODE"
|
(setq org-babel-default-header-args:lilypond
|
(org-babel-lilypond-get-header-args mode)))
|
|
(provide 'ob-lilypond)
|
|
;;; ob-lilypond.el ends here
|
