;;; ob-msc.el --- Babel Functions for Mscgen -*- lexical-binding: t; -*-
|
|
;; Copyright (C) 2010-2018 Free Software Foundation, Inc.
|
|
;; Author: Juan Pechiar
|
;; Keywords: literate programming, reproducible research
|
;; Homepage: https://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:
|
;;
|
;; This software provides EMACS org-babel export support for message
|
;; sequence charts. The mscgen utility is used for processing the
|
;; sequence definition, and must therefore be installed in the system.
|
;;
|
;; Mscgen is available and documented at
|
;; http://www.mcternan.me.uk/mscgen/index.html
|
;;
|
;; This code is directly inspired by Eric Schulte's ob-dot.el
|
;;
|
;; Example:
|
;;
|
;; #+begin_src mscgen :file example.png
|
;; msc {
|
;; A,B;
|
;; A -> B [ label = "send message" ];
|
;; A <- B [ label = "get answer" ];
|
;; }
|
;; #+end_src
|
;;
|
;; Header for alternative file type:
|
;;
|
;; #+begin_src mscgen :file ex2.svg :filetype svg
|
|
;; This differs from most standard languages in that
|
;;
|
;; 1) there is no such thing as a "session" in mscgen
|
;; 2) we are generally only going to return results of type "file"
|
;; 3) we are adding the "file" and "filetype" header arguments
|
;; 4) there are no variables
|
|
;;; Code:
|
(require 'ob)
|
|
(defvar org-babel-default-header-args:mscgen
|
'((:results . "file") (:exports . "results"))
|
"Default arguments to use when evaluating a mscgen source block.")
|
|
(defun org-babel-execute:mscgen (body params)
|
"Execute a block of Mscgen code with Babel.
|
This function is called by `org-babel-execute-src-block'.
|
Default filetype is png. Modify by setting :filetype parameter to
|
mscgen supported formats."
|
(let* ((out-file (or (cdr (assq :file params)) "output.png" ))
|
(filetype (or (cdr (assq :filetype params)) "png" )))
|
(unless (cdr (assq :file params))
|
(error "
|
ERROR: no output file specified. Add \":file name.png\" to the src header"))
|
(org-babel-eval (concat "mscgen -T " filetype " -o " out-file) body)
|
nil)) ;; signal that output has already been written to file
|
|
(defun org-babel-prep-session:mscgen (_session _params)
|
"Raise an error because Mscgen doesn't support sessions."
|
(error "Mscgen does not support sessions"))
|
|
(provide 'ob-mscgen)
|
|
|
|
;;; ob-msc.el ends here
|
