contrib/babel/langs/ob-fortran.el

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