ob-fortran.el 6.2 KB

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