ob-C.el 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. ;;; ob-C.el --- org-babel functions for C and similar languages
  2. ;; Copyright (C) 2010-2012 Free Software Foundation, Inc.
  3. ;; Author: Eric Schulte
  4. ;; Keywords: literate programming, reproducible research
  5. ;; Homepage: http://orgmode.org
  6. ;; This file is part of GNU Emacs.
  7. ;; GNU Emacs is free software: you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation, either version 3 of the License, or
  10. ;; (at your option) any later version.
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;; Org-Babel support for evaluating C code.
  19. ;;
  20. ;; very limited implementation:
  21. ;; - currently only support :results output
  22. ;; - not much in the way of error feedback
  23. ;;; Code:
  24. (require 'ob)
  25. (require 'ob-eval)
  26. (require 'cc-mode)
  27. (declare-function org-entry-get "org"
  28. (pom property &optional inherit literal-nil))
  29. (defvar org-babel-tangle-lang-exts)
  30. (add-to-list 'org-babel-tangle-lang-exts '("C++" . "cpp"))
  31. (defvar org-babel-default-header-args:C '())
  32. (defvar org-babel-C-compiler "gcc"
  33. "Command used to compile a C source code file into an
  34. executable.")
  35. (defvar org-babel-C++-compiler "g++"
  36. "Command used to compile a C++ source code file into an
  37. executable.")
  38. (defvar org-babel-c-variant nil
  39. "Internal variable used to hold which type of C (e.g. C or C++)
  40. is currently being evaluated.")
  41. (defun org-babel-execute:cpp (body params)
  42. "Execute BODY according to PARAMS. This function calls
  43. `org-babel-execute:C++'."
  44. (org-babel-execute:C++ body params))
  45. (defun org-babel-execute:C++ (body params)
  46. "Execute a block of C++ code with org-babel. This function is
  47. called by `org-babel-execute-src-block'."
  48. (let ((org-babel-c-variant 'cpp)) (org-babel-C-execute body params)))
  49. (defun org-babel-expand-body:C++ (body params)
  50. "Expand a block of C++ code with org-babel according to it's
  51. header arguments (calls `org-babel-C-expand')."
  52. (let ((org-babel-c-variant 'cpp)) (org-babel-C-expand body params)))
  53. (defun org-babel-execute:C (body params)
  54. "Execute a block of C code with org-babel. This function is
  55. called by `org-babel-execute-src-block'."
  56. (let ((org-babel-c-variant 'c)) (org-babel-C-execute body params)))
  57. (defun org-babel-expand-body:c (body params)
  58. "Expand a block of C code with org-babel according to it's
  59. header arguments (calls `org-babel-C-expand')."
  60. (let ((org-babel-c-variant 'c)) (org-babel-C-expand body params)))
  61. (defun org-babel-C-execute (body params)
  62. "This function should only be called by `org-babel-execute:C'
  63. or `org-babel-execute:C++'."
  64. (let* ((tmp-src-file (org-babel-temp-file
  65. "C-src-"
  66. (cond
  67. ((equal org-babel-c-variant 'c) ".c")
  68. ((equal org-babel-c-variant 'cpp) ".cpp"))))
  69. (tmp-bin-file (org-babel-temp-file "C-bin-"))
  70. (cmdline (cdr (assoc :cmdline params)))
  71. (flags (cdr (assoc :flags params)))
  72. (full-body (org-babel-C-expand body params))
  73. (compile
  74. (progn
  75. (with-temp-file tmp-src-file (insert full-body))
  76. (org-babel-eval
  77. (format "%s -o %s %s %s"
  78. (cond
  79. ((equal org-babel-c-variant 'c) org-babel-C-compiler)
  80. ((equal org-babel-c-variant 'cpp) org-babel-C++-compiler))
  81. (org-babel-process-file-name tmp-bin-file)
  82. (mapconcat 'identity
  83. (if (listp flags) flags (list flags)) " ")
  84. (org-babel-process-file-name tmp-src-file)) ""))))
  85. ((lambda (results)
  86. (org-babel-reassemble-table
  87. (if (member "vector" (cdr (assoc :result-params params)))
  88. (let ((tmp-file (org-babel-temp-file "c-")))
  89. (with-temp-file tmp-file (insert results))
  90. (org-babel-import-elisp-from-file tmp-file))
  91. (org-babel-read results))
  92. (org-babel-pick-name
  93. (cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
  94. (org-babel-pick-name
  95. (cdr (assoc :rowname-names params)) (cdr (assoc :rownames params)))))
  96. (org-babel-trim
  97. (org-babel-eval
  98. (concat tmp-bin-file (if cmdline (concat " " cmdline) "")) "")))))
  99. (defun org-babel-C-expand (body params)
  100. "Expand a block of C or C++ code with org-babel according to
  101. it's header arguments."
  102. (let ((vars (mapcar #'cdr (org-babel-get-header params :var)))
  103. (main-p (not (string= (cdr (assoc :main params)) "no")))
  104. (includes (or (cdr (assoc :includes params))
  105. (org-babel-read (org-entry-get nil "includes" t))))
  106. (defines (org-babel-read
  107. (or (cdr (assoc :defines params))
  108. (org-babel-read (org-entry-get nil "defines" t))))))
  109. (mapconcat 'identity
  110. (list
  111. ;; includes
  112. (mapconcat
  113. (lambda (inc) (format "#include %s" inc))
  114. (if (listp includes) includes (list includes)) "\n")
  115. ;; defines
  116. (mapconcat
  117. (lambda (inc) (format "#define %s" inc))
  118. (if (listp defines) defines (list defines)) "\n")
  119. ;; variables
  120. (mapconcat 'org-babel-C-var-to-C vars "\n")
  121. ;; body
  122. (if main-p
  123. (org-babel-C-ensure-main-wrap body)
  124. body) "\n") "\n")))
  125. (defun org-babel-C-ensure-main-wrap (body)
  126. "Wrap body in a \"main\" function call if none exists."
  127. (if (string-match "^[ \t]*[intvod]+[ \t\n\r]*main[ \t]*(.*)" body)
  128. body
  129. (format "int main() {\n%s\n}\n" body)))
  130. (defun org-babel-prep-session:C (session params)
  131. "This function does nothing as C is a compiled language with no
  132. support for sessions"
  133. (error "C is a compiled languages -- no support for sessions"))
  134. (defun org-babel-load-session:C (session body params)
  135. "This function does nothing as C is a compiled language with no
  136. support for sessions"
  137. (error "C is a compiled languages -- no support for sessions"))
  138. ;; helper functions
  139. (defun org-babel-C-var-to-C (pair)
  140. "Convert an elisp val into a string of C code specifying a var
  141. of the same value."
  142. ;; TODO list support
  143. (let ((var (car pair))
  144. (val (cdr pair)))
  145. (when (symbolp val)
  146. (setq val (symbol-name val))
  147. (when (= (length val) 1)
  148. (setq val (string-to-char val))))
  149. (cond
  150. ((integerp val)
  151. (format "int %S = %S;" var val))
  152. ((floatp val)
  153. (format "double %S = %S;" var val))
  154. ((or (integerp val))
  155. (format "char %S = '%S';" var val))
  156. ((stringp val)
  157. (format "char %S[%d] = \"%s\";"
  158. var (+ 1 (length val)) val))
  159. (t
  160. (format "u32 %S = %S;" var val)))))
  161. (provide 'ob-C)
  162. ;;; ob-C.el ends here