lisp/ob-fortran.el

   1 ;;; ob-fortran.el --- org-babel functions for fortran
   2
   3 ;; Copyright (C) 2011-2014 Free Software Foundation, Inc.
   4
   5 ;; Authors: Sergey Litvinov
   6 ;;       Eric Schulte
   7 ;; Keywords: literate programming, reproducible research, fortran
   8 ;; Homepage: http://orgmode.org
   9
  10 ;; This file is part of GNU Emacs.
  11 ;;
  12 ;; GNU Emacs 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 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs 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.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;; Org-Babel support for evaluating fortran code.
  28
  29 ;;; Code:
  30 (require 'ob)
  31 (require 'cc-mode)
  32
  33 (declare-function org-entry-get "org"
  34                   (pom property &optional inherit literal-nil))
  35 (declare-function org-every "org" (pred seq))
  36 (declare-function org-remove-indentation "org" (code &optional n))
  37
  38 (defvar org-babel-tangle-lang-exts)
  39 (add-to-list 'org-babel-tangle-lang-exts '("fortran" . "F90"))
  40
  41 (defvar org-babel-default-header-args:fortran '())
  42
  43 (defvar org-babel-fortran-compiler "gfortran"
  44   "fortran command used to compile a fortran source code file into an
  45   executable.")
  46
  47 (defun org-babel-execute:fortran (body params)
  48   "This function should only be called by `org-babel-execute:fortran'"
  49   (let* ((tmp-src-file (org-babel-temp-file "fortran-src-" ".F90"))
  50          (tmp-bin-file (org-babel-temp-file "fortran-bin-" org-babel-exeext))
  51          (cmdline (cdr (assoc :cmdline params)))
  52          (flags (cdr (assoc :flags params)))
  53          (full-body (org-babel-expand-body:fortran body params))
  54          (compile
  55           (progn
  56             (with-temp-file tmp-src-file (insert full-body))
  57             (org-babel-eval
  58              (format "%s -o %s %s %s"
  59                      org-babel-fortran-compiler
  60                      (org-babel-process-file-name tmp-bin-file)
  61                      (mapconcat 'identity
  62                                 (if (listp flags) flags (list flags)) " ")
  63                      (org-babel-process-file-name tmp-src-file)) ""))))
  64     (let ((results
  65            (org-babel-trim
  66             (org-remove-indentation
  67              (org-babel-eval
  68               (concat tmp-bin-file (if cmdline (concat " " cmdline) "")) "")))))
  69       (org-babel-reassemble-table
  70        (org-babel-result-cond (cdr (assoc :result-params params))
  71          (org-babel-read results)
  72          (let ((tmp-file (org-babel-temp-file "f-")))
  73            (with-temp-file tmp-file (insert results))
  74            (org-babel-import-elisp-from-file tmp-file)))
  75        (org-babel-pick-name
  76         (cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
  77        (org-babel-pick-name
  78         (cdr (assoc :rowname-names params)) (cdr (assoc :rownames params)))))))
  79
  80 (defun org-babel-expand-body:fortran (body params)
  81   "Expand a block of fortran or fortran code with org-babel according to
  82 it's header arguments."
  83   (let ((vars (mapcar #'cdr (org-babel-get-header params :var)))
  84         (main-p (not (string= (cdr (assoc :main params)) "no")))
  85         (includes (or (cdr (assoc :includes params))
  86                       (org-babel-read (org-entry-get nil "includes" t))))
  87         (defines (org-babel-read
  88                   (or (cdr (assoc :defines params))
  89                       (org-babel-read (org-entry-get nil "defines" t))))))
  90     (mapconcat 'identity
  91                (list
  92                 ;; includes
  93                 (mapconcat
  94                  (lambda (inc) (format "#include %s" inc))
  95                  (if (listp includes) includes (list includes)) "\n")
  96                 ;; defines
  97                 (mapconcat
  98                  (lambda (inc) (format "#define %s" inc))
  99                  (if (listp defines) defines (list defines)) "\n")
 100                 ;; body
 101                 (if main-p
 102                     (org-babel-fortran-ensure-main-wrap
 103                      (concat
 104                       ;; variables
 105                       (mapconcat 'org-babel-fortran-var-to-fortran vars "\n")
 106                       body) params)
 107                   body) "\n") "\n")))
 108
 109 (defun org-babel-fortran-ensure-main-wrap (body params)
 110   "Wrap body in a \"program ... end program\" block if none exists."
 111   (if (string-match "^[ \t]*program[ \t]*.*" (capitalize body))
 112       (let ((vars (mapcar #'cdr (org-babel-get-header params :var))))
 113         (if vars (error "Cannot use :vars if 'program' statement is present"))
 114         body)
 115     (format "program main\n%s\nend program main\n" body)))
 116
 117 (defun org-babel-prep-session:fortran (session params)
 118   "This function does nothing as fortran is a compiled language with no
 119 support for sessions"
 120   (error "Fortran is a compiled languages -- no support for sessions"))
 121
 122 (defun org-babel-load-session:fortran (session body params)
 123   "This function does nothing as fortran is a compiled language with no
 124 support for sessions"
 125   (error "Fortran is a compiled languages -- no support for sessions"))
 126
 127 ;; helper functions
 128
 129 (defun org-babel-fortran-var-to-fortran (pair)
 130   "Convert an elisp val into a string of fortran code specifying a var
 131 of the same value."
 132   ;; TODO list support
 133   (let ((var (car pair))
 134         (val (cdr pair)))
 135     (when (symbolp val)
 136       (setq val (symbol-name val))
 137       (when (= (length val) 1)
 138         (setq val (string-to-char val))))
 139     (cond
 140      ((integerp val)
 141       (format "integer, parameter  ::  %S = %S\n" var val))
 142      ((floatp val)
 143       (format "real, parameter ::  %S = %S\n" var val))
 144      ((or (integerp val))
 145       (format "character, parameter :: %S = '%S'\n" var val))
 146      ((stringp val)
 147       (format "character(len=%d), parameter ::  %S = '%s'\n"
 148               (length val) var val))
 149      ;; val is a matrix
 150      ((and (listp val) (org-every #'listp val))
 151       (format "real, parameter :: %S(%d,%d) = transpose( reshape( %s , (/ %d, %d /) ) )\n"
 152               var (length val) (length (car val))
 153               (org-babel-fortran-transform-list val)
 154               (length (car val)) (length val)))
 155      ((listp val)
 156       (format "real, parameter :: %S(%d) = %s\n"
 157               var (length val) (org-babel-fortran-transform-list val)))
 158      (t
 159       (error (format "the type of parameter %s is not supported by ob-fortran"
 160                      var))))))
 161
 162 (defun org-babel-fortran-transform-list (val)
 163   "Return a fortran representation of enclose syntactic lists."
 164   (if (listp val)
 165       (concat "(/" (mapconcat #'org-babel-fortran-transform-list val ", ") "/)")
 166     (format "%S" val)))
 167
 168 (provide 'ob-fortran)
 169
 170 ;;; ob-fortran.el ends here