2011-07-18 07:44:07 +00:00
|
|
|
;;; ob-fortran.el --- org-babel functions for fortran
|
2011-07-18 18:17:02 +00:00
|
|
|
|
2012-04-01 19:48:15 +00:00
|
|
|
;; Copyright (C) 2011-2012 Free Software Foundation, Inc.
|
2011-07-18 07:44:07 +00:00
|
|
|
|
2012-04-01 20:12:07 +00:00
|
|
|
;; Authors: Sergey Litvinov
|
2012-04-01 22:53:28 +00:00
|
|
|
;; Eric Schulte
|
2011-07-18 07:44:07 +00:00
|
|
|
;; Keywords: literate programming, reproducible research, fortran
|
|
|
|
;; Homepage: http://orgmode.org
|
|
|
|
|
2011-07-18 21:47:32 +00:00
|
|
|
;; This program is free software; you can redistribute it and/or modify
|
2011-07-18 07:44:07 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2011-07-18 21:47:32 +00:00
|
|
|
;; the Free Software Foundation; either version 3, or (at your option)
|
|
|
|
;; any later version.
|
|
|
|
;;
|
|
|
|
;; This program is distributed in the hope that it will be useful,
|
2011-07-18 07:44:07 +00:00
|
|
|
;; 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.
|
2011-07-18 21:47:32 +00:00
|
|
|
;;
|
2011-07-18 07:44:07 +00:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2011-07-18 21:47:32 +00:00
|
|
|
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
|
|
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
|
|
;; Boston, MA 02110-1301, USA.
|
2011-07-18 07:44:07 +00:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Org-Babel support for evaluating fortran code.
|
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
(require 'ob)
|
|
|
|
(require 'ob-eval)
|
|
|
|
(require 'cc-mode)
|
|
|
|
|
|
|
|
(declare-function org-entry-get "org"
|
|
|
|
(pom property &optional inherit literal-nil))
|
|
|
|
|
|
|
|
(defvar org-babel-tangle-lang-exts)
|
|
|
|
(add-to-list 'org-babel-tangle-lang-exts '("fortran" . "F90"))
|
|
|
|
|
|
|
|
(defvar org-babel-default-header-args:fortran '())
|
|
|
|
|
|
|
|
(defvar org-babel-fortran-compiler "gfortran"
|
|
|
|
"fortran command used to compile a fortran source code file into an
|
|
|
|
executable.")
|
|
|
|
|
|
|
|
(defun org-babel-execute:fortran (body params)
|
|
|
|
"This function should only be called by `org-babel-execute:fortran'"
|
2011-07-18 18:17:02 +00:00
|
|
|
(let* ((tmp-src-file (org-babel-temp-file "fortran-src-" ".F90"))
|
2012-07-25 17:09:08 +00:00
|
|
|
(tmp-bin-file (org-babel-temp-file "fortran-bin-" org-babel-exeext))
|
2011-07-18 07:44:07 +00:00
|
|
|
(cmdline (cdr (assoc :cmdline params)))
|
|
|
|
(flags (cdr (assoc :flags params)))
|
2011-07-18 18:17:02 +00:00
|
|
|
(full-body (org-babel-expand-body:fortran body params))
|
2011-07-18 07:44:07 +00:00
|
|
|
(compile
|
|
|
|
(progn
|
|
|
|
(with-temp-file tmp-src-file (insert full-body))
|
|
|
|
(org-babel-eval
|
|
|
|
(format "%s -o %s %s %s"
|
|
|
|
org-babel-fortran-compiler
|
|
|
|
(org-babel-process-file-name tmp-bin-file)
|
|
|
|
(mapconcat 'identity
|
|
|
|
(if (listp flags) flags (list flags)) " ")
|
|
|
|
(org-babel-process-file-name tmp-src-file)) ""))))
|
|
|
|
((lambda (results)
|
|
|
|
(org-babel-reassemble-table
|
|
|
|
(if (member "vector" (cdr (assoc :result-params params)))
|
|
|
|
(let ((tmp-file (org-babel-temp-file "f-")))
|
|
|
|
(with-temp-file tmp-file (insert results))
|
|
|
|
(org-babel-import-elisp-from-file tmp-file))
|
|
|
|
(org-babel-read results))
|
|
|
|
(org-babel-pick-name
|
|
|
|
(cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
|
|
|
|
(org-babel-pick-name
|
|
|
|
(cdr (assoc :rowname-names params)) (cdr (assoc :rownames params)))))
|
|
|
|
(org-babel-trim
|
2012-08-11 17:10:44 +00:00
|
|
|
(org-babel-eval
|
|
|
|
(concat tmp-bin-file (if cmdline (concat " " cmdline) "")) "")))))
|
2011-07-18 07:44:07 +00:00
|
|
|
|
2011-07-18 18:17:02 +00:00
|
|
|
(defun org-babel-expand-body:fortran (body params)
|
2011-07-18 07:44:07 +00:00
|
|
|
"Expand a block of fortran or fortran code with org-babel according to
|
|
|
|
it's header arguments."
|
|
|
|
(let ((vars (mapcar #'cdr (org-babel-get-header params :var)))
|
|
|
|
(main-p (not (string= (cdr (assoc :main params)) "no")))
|
|
|
|
(includes (or (cdr (assoc :includes params))
|
|
|
|
(org-babel-read (org-entry-get nil "includes" t))))
|
|
|
|
(defines (org-babel-read
|
|
|
|
(or (cdr (assoc :defines params))
|
|
|
|
(org-babel-read (org-entry-get nil "defines" t))))))
|
2012-08-11 17:10:44 +00:00
|
|
|
(mapconcat 'identity
|
|
|
|
(list
|
|
|
|
;; includes
|
|
|
|
(mapconcat
|
|
|
|
(lambda (inc) (format "#include %s" inc))
|
|
|
|
(if (listp includes) includes (list includes)) "\n")
|
|
|
|
;; defines
|
|
|
|
(mapconcat
|
|
|
|
(lambda (inc) (format "#define %s" inc))
|
|
|
|
(if (listp defines) defines (list defines)) "\n")
|
|
|
|
;; body
|
|
|
|
(if main-p
|
|
|
|
(org-babel-fortran-ensure-main-wrap
|
|
|
|
(concat
|
|
|
|
;; variables
|
|
|
|
(mapconcat 'org-babel-fortran-var-to-fortran vars "\n")
|
|
|
|
body) params)
|
|
|
|
body) "\n") "\n")))
|
2011-07-18 07:44:07 +00:00
|
|
|
|
2011-07-18 18:17:02 +00:00
|
|
|
(defun org-babel-fortran-ensure-main-wrap (body params)
|
2011-07-18 07:44:07 +00:00
|
|
|
"Wrap body in a \"program ... end program\" block if none exists."
|
|
|
|
(if (string-match "^[ \t]*program[ \t]*.*" (capitalize body))
|
2012-08-11 17:10:44 +00:00
|
|
|
(let ((vars (mapcar #'cdr (org-babel-get-header params :var))))
|
2012-08-13 03:59:44 +00:00
|
|
|
(if vars (error "Cannot use :vars if 'program' statement is present"))
|
2012-08-11 17:10:44 +00:00
|
|
|
body)
|
2011-07-18 07:44:07 +00:00
|
|
|
(format "program main\n%s\nend program main\n" body)))
|
|
|
|
|
|
|
|
(defun org-babel-prep-session:fortran (session params)
|
|
|
|
"This function does nothing as fortran is a compiled language with no
|
|
|
|
support for sessions"
|
2012-08-13 03:59:44 +00:00
|
|
|
(error "Fortran is a compiled languages -- no support for sessions"))
|
2011-07-18 07:44:07 +00:00
|
|
|
|
|
|
|
(defun org-babel-load-session:fortran (session body params)
|
|
|
|
"This function does nothing as fortran is a compiled language with no
|
|
|
|
support for sessions"
|
2012-08-13 03:59:44 +00:00
|
|
|
(error "Fortran is a compiled languages -- no support for sessions"))
|
2011-07-18 07:44:07 +00:00
|
|
|
|
|
|
|
;; helper functions
|
|
|
|
|
|
|
|
(defun org-babel-fortran-var-to-fortran (pair)
|
2012-01-10 10:56:15 +00:00
|
|
|
"Convert an elisp val into a string of fortran code specifying a var
|
2011-07-18 07:44:07 +00:00
|
|
|
of the same value."
|
|
|
|
;; TODO list support
|
|
|
|
(let ((var (car pair))
|
|
|
|
(val (cdr pair)))
|
|
|
|
(when (symbolp val)
|
|
|
|
(setq val (symbol-name val))
|
|
|
|
(when (= (length val) 1)
|
|
|
|
(setq val (string-to-char val))))
|
|
|
|
(cond
|
|
|
|
((integerp val)
|
|
|
|
(format "integer, parameter :: %S = %S\n" var val))
|
|
|
|
((floatp val)
|
|
|
|
(format "real, parameter :: %S = %S\n" var val))
|
2011-09-17 20:52:19 +00:00
|
|
|
((or (integerp val))
|
2011-07-18 07:44:07 +00:00
|
|
|
(format "character, parameter :: %S = '%S'\n" var val))
|
|
|
|
((stringp val)
|
2011-07-20 22:44:50 +00:00
|
|
|
(format "character(len=%d), parameter :: %S = '%s'\n"
|
|
|
|
(length val) var val))
|
2011-07-18 07:44:07 +00:00
|
|
|
((listp val)
|
2011-07-18 18:17:02 +00:00
|
|
|
(format "real, parameter :: %S(%d) = %s\n"
|
|
|
|
var (length val) (ob-fortran-transform-list val)))
|
2011-07-18 07:44:07 +00:00
|
|
|
(t
|
2011-07-18 18:17:02 +00:00
|
|
|
(error (format "the type of parameter %s is not supported by ob-fortran"
|
|
|
|
var))))))
|
2011-07-18 07:44:07 +00:00
|
|
|
|
|
|
|
(defun ob-fortran-transform-list (val)
|
|
|
|
"Return a fortran representation of enclose syntactic lists."
|
|
|
|
(if (listp val)
|
|
|
|
(concat "(/" (mapconcat #'ob-fortran-transform-list val ", ") "/)")
|
|
|
|
(format "%S" val)))
|
|
|
|
|
|
|
|
(provide 'ob-fortran)
|
|
|
|
|
|
|
|
;;; ob-fortran.el ends here
|