lisp/org/ob-calc.el

   1 ;;; ob-calc.el --- org-babel functions for calc code evaluation
   2
   3 ;; Copyright (C) 2010-2013 Free Software Foundation, Inc.
   4
   5 ;; Author: Eric Schulte
   6 ;; Keywords: literate programming, reproducible research
   7 ;; Homepage: http://orgmode.org
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;; Org-Babel support for evaluating calc code
  27
  28 ;;; Code:
  29 (require 'ob)
  30 (require 'calc)
  31 (unless (featurep 'xemacs)
  32   (require 'calc-trail)
  33   (require 'calc-store))
  34 (eval-when-compile (require 'ob-comint))
  35
  36 (declare-function calc-store-into    "calc-store" (&optional var))
  37 (declare-function calc-recall        "calc-store" (&optional var))
  38 (declare-function math-evaluate-expr "calc-ext"   (x))
  39
  40 (defvar org-babel-default-header-args:calc nil
  41   "Default arguments for evaluating an calc source block.")
  42
  43 (defun org-babel-expand-body:calc (body params)
  44   "Expand BODY according to PARAMS, return the expanded body." body)
  45
  46 (defun org-babel-execute:calc (body params)
  47   "Execute a block of calc code with Babel."
  48   (unless (get-buffer "*Calculator*")
  49     (save-window-excursion (calc) (calc-quit)))
  50   (let* ((vars (mapcar #'cdr (org-babel-get-header params :var)))
  51          (var-syms (mapcar #'car vars))
  52          (var-names (mapcar #'symbol-name var-syms)))
  53     (mapc
  54      (lambda (pair)
  55        (calc-push-list (list (cdr pair)))
  56        (calc-store-into (car pair)))
  57      vars)
  58     (mapc
  59      (lambda (line)
  60        (when (> (length line) 0)
  61          (cond
  62           ;; simple variable name
  63           ((member line var-names) (calc-recall (intern line)))
  64           ;; stack operation
  65           ((string= "'" (substring line 0 1))
  66            (funcall (lookup-key calc-mode-map (substring line 1)) nil))
  67           ;; complex expression
  68           (t
  69            (calc-push-list
  70             (list ((lambda (res)
  71                      (cond
  72                       ((numberp res) res)
  73                       ((math-read-number res) (math-read-number res))
  74                       ((listp res) (error "Calc error \"%s\" on input \"%s\""
  75                                           (cadr res) line))
  76                       (t (replace-regexp-in-string
  77                           "'" ""
  78                           (calc-eval
  79                            (math-evaluate-expr
  80                             ;; resolve user variables, calc built in
  81                             ;; variables are handled automatically
  82                             ;; upstream by calc
  83                             (mapcar #'org-babel-calc-maybe-resolve-var
  84                                     ;; parse line into calc objects
  85                                     (car (math-read-exprs line)))))))))
  86                    (calc-eval line))))))))
  87      (mapcar #'org-babel-trim
  88              (split-string (org-babel-expand-body:calc body params) "[\n\r]"))))
  89   (save-excursion
  90     (with-current-buffer (get-buffer "*Calculator*")
  91       (calc-eval (calc-top 1)))))
  92
  93 (defvar var-syms) ; Dynamically scoped from org-babel-execute:calc
  94 (defun org-babel-calc-maybe-resolve-var (el)
  95   (if (consp el)
  96       (if (and (equal 'var (car el)) (member (cadr el) var-syms))
  97           (progn
  98             (calc-recall (cadr el))
  99             (prog1 (calc-top 1)
 100               (calc-pop 1)))
 101         (mapcar #'org-babel-calc-maybe-resolve-var el))
 102     el))
 103
 104 (provide 'ob-calc)
 105
 106
 107
 108 ;;; ob-calc.el ends here