2010-06-11 19:02:42 -04:00
|
|
|
;;; ob-C.el --- org-babel functions for C and similar languages
|
2010-03-26 15:16:56 -04:00
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
;; Copyright (C) 2010 Free Software Foundation, Inc.
|
2010-03-26 15:16:56 -04:00
|
|
|
|
|
|
|
;; Author: Eric Schulte
|
|
|
|
;; Keywords: literate programming, reproducible research
|
|
|
|
;; Homepage: http://orgmode.org
|
2010-07-19 02:33:24 -04:00
|
|
|
;; Version: 7.01trans
|
2010-03-26 15:16:56 -04:00
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
;; This file is part of GNU Emacs.
|
2010-03-26 15:16:56 -04:00
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2010-03-26 15:16:56 -04:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2010-06-25 12:32:35 -04:00
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
2010-03-26 15:16:56 -04: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.
|
2010-06-25 12:32:35 -04:00
|
|
|
|
2010-03-26 15:16:56 -04:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2010-06-25 12:32:35 -04:00
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
2010-03-26 15:16:56 -04:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Org-Babel support for evaluating C code.
|
|
|
|
;;
|
|
|
|
;; very limited implementation:
|
|
|
|
;; - currently only support :results output
|
|
|
|
;; - not much in the way of error feedback
|
|
|
|
|
|
|
|
;;; Code:
|
2010-06-11 19:02:42 -04:00
|
|
|
(require 'ob)
|
2010-07-04 17:46:13 -04:00
|
|
|
(require 'ob-eval)
|
2010-06-25 13:26:48 -04:00
|
|
|
(require 'org)
|
2010-03-26 15:16:56 -04:00
|
|
|
(require 'cc-mode)
|
|
|
|
|
2010-07-02 22:21:31 -04:00
|
|
|
(declare-function org-entry-get "org"
|
|
|
|
(pom property &optional inherit literal-nil))
|
2010-06-25 13:26:48 -04:00
|
|
|
|
2010-06-17 13:21:14 -04:00
|
|
|
(add-to-list 'org-babel-tangle-lang-exts '("c++" . "cpp"))
|
|
|
|
|
2010-06-25 13:12:54 -04:00
|
|
|
(defvar org-babel-default-header-args:C '())
|
|
|
|
|
2010-03-26 15:16:56 -04:00
|
|
|
(defvar org-babel-C-compiler "gcc"
|
|
|
|
"Command used to compile a C source code file into an
|
|
|
|
executable.")
|
|
|
|
|
2010-03-26 20:52:16 -04:00
|
|
|
(defvar org-babel-c++-compiler "g++"
|
|
|
|
"Command used to compile a c++ source code file into an
|
|
|
|
executable.")
|
|
|
|
|
2010-06-25 13:26:48 -04:00
|
|
|
(defvar org-babel-c-variant nil
|
|
|
|
"Internal variable used to hold which type of C (e.g. C or C++)
|
|
|
|
is currently being evaluated.")
|
|
|
|
|
2010-03-26 15:16:56 -04:00
|
|
|
(defun org-babel-execute:cpp (body params)
|
2010-06-11 20:12:15 -04:00
|
|
|
"Execute BODY according to PARAMS. This function calls
|
|
|
|
`org-babel-execute:C'."
|
2010-03-26 15:16:56 -04:00
|
|
|
(org-babel-execute:C body params))
|
|
|
|
|
|
|
|
(defun org-babel-execute:c++ (body params)
|
2010-03-26 20:52:16 -04:00
|
|
|
"Execute a block of C++ code with org-babel. This function is
|
|
|
|
called by `org-babel-execute-src-block'."
|
2010-06-25 13:26:48 -04:00
|
|
|
(let ((org-babel-c-variant 'cpp)) (org-babel-C-execute body params)))
|
2010-03-26 15:16:56 -04:00
|
|
|
|
2010-04-11 16:29:02 -04:00
|
|
|
(defun org-babel-expand-body:c++ (body params &optional processed-params)
|
|
|
|
"Expand a block of C++ code with org-babel according to it's
|
|
|
|
header arguments (calls `org-babel-C-expand')."
|
2010-06-25 13:26:48 -04:00
|
|
|
(let ((org-babel-c-variant 'cpp)) (org-babel-C-expand body params processed-params)))
|
2010-04-11 16:29:02 -04:00
|
|
|
|
2010-03-26 15:16:56 -04:00
|
|
|
(defun org-babel-execute:C (body params)
|
2010-03-26 20:52:16 -04:00
|
|
|
"Execute a block of C code with org-babel. This function is
|
|
|
|
called by `org-babel-execute-src-block'."
|
2010-06-25 13:26:48 -04:00
|
|
|
(let ((org-babel-c-variant 'c)) (org-babel-C-execute body params)))
|
2010-03-26 20:52:16 -04:00
|
|
|
|
2010-04-11 16:29:02 -04:00
|
|
|
(defun org-babel-expand-body:c (body params &optional processed-params)
|
|
|
|
"Expand a block of C code with org-babel according to it's
|
|
|
|
header arguments (calls `org-babel-C-expand')."
|
2010-06-25 13:26:48 -04:00
|
|
|
(let ((org-babel-c-variant 'c)) (org-babel-C-expand body params processed-params)))
|
2010-04-11 16:29:02 -04:00
|
|
|
|
2010-03-26 20:52:16 -04:00
|
|
|
(defun org-babel-C-execute (body params)
|
2010-06-11 20:12:15 -04:00
|
|
|
"This function should only be called by `org-babel-execute:C'
|
|
|
|
or `org-babel-execute:c++'."
|
2010-04-22 21:33:01 -04:00
|
|
|
(let* ((processed-params (org-babel-process-params params))
|
|
|
|
(tmp-src-file (make-temp-file "org-babel-C-src" nil
|
2010-06-25 13:26:48 -04:00
|
|
|
(cond
|
2010-07-06 13:30:58 -04:00
|
|
|
((equal org-babel-c-variant 'c) ".c")
|
|
|
|
((equal org-babel-c-variant 'cpp) ".cpp"))))
|
2010-03-26 15:16:56 -04:00
|
|
|
(tmp-bin-file (make-temp-file "org-babel-C-bin"))
|
|
|
|
(tmp-out-file (make-temp-file "org-babel-C-out"))
|
2010-03-29 14:26:53 -04:00
|
|
|
(cmdline (cdr (assoc :cmdline params)))
|
2010-03-26 15:16:56 -04:00
|
|
|
(flags (cdr (assoc :flags params)))
|
2010-04-11 16:29:02 -04:00
|
|
|
(full-body (org-babel-C-expand body params))
|
2010-03-26 19:12:43 -04:00
|
|
|
(compile
|
2010-07-06 13:30:58 -04:00
|
|
|
(progn
|
|
|
|
(with-temp-file tmp-src-file (insert full-body))
|
|
|
|
(org-babel-eval
|
|
|
|
(format "%s -o %s %s %s"
|
|
|
|
(cond
|
|
|
|
((equal org-babel-c-variant 'c) org-babel-C-compiler)
|
|
|
|
((equal org-babel-c-variant 'cpp) org-babel-c++-compiler))
|
|
|
|
tmp-bin-file
|
|
|
|
(mapconcat 'identity
|
|
|
|
(if (listp flags) flags (list flags)) " ")
|
|
|
|
tmp-src-file) ""))))
|
2010-07-15 02:10:33 -04:00
|
|
|
((lambda (results)
|
|
|
|
(org-babel-reassemble-table
|
|
|
|
(if (member "vector" (nth 2 processed-params))
|
|
|
|
(let ((tmp-file (make-temp-file "ob-c")))
|
|
|
|
(with-temp-file tmp-file (insert results))
|
|
|
|
(org-babel-import-elisp-from-file tmp-file))
|
|
|
|
(org-babel-read results))
|
|
|
|
(org-babel-pick-name
|
|
|
|
(nth 4 processed-params) (cdr (assoc :colnames params)))
|
|
|
|
(org-babel-pick-name
|
|
|
|
(nth 5 processed-params) (cdr (assoc :rownames params)))))
|
|
|
|
(org-babel-trim
|
2010-07-06 13:30:58 -04:00
|
|
|
(org-babel-eval
|
2010-07-15 02:10:33 -04:00
|
|
|
(concat tmp-bin-file (if cmdline (concat " " cmdline) "")) "")))))
|
2010-03-26 19:12:43 -04:00
|
|
|
|
2010-04-11 16:29:02 -04:00
|
|
|
(defun org-babel-C-expand (body params &optional processed-params)
|
|
|
|
"Expand a block of C or C++ code with org-babel according to
|
|
|
|
it's header arguments."
|
2010-06-25 13:26:48 -04:00
|
|
|
(let ((vars (nth 1 (or processed-params
|
2010-04-11 16:29:02 -04:00
|
|
|
(org-babel-process-params params))))
|
|
|
|
(main-p (not (string= (cdr (assoc :main params)) "no")))
|
|
|
|
(includes (or (cdr (assoc :includes params))
|
2010-04-22 21:39:12 -04:00
|
|
|
(org-babel-read (org-entry-get nil "includes" t))))
|
2010-04-11 16:29:02 -04:00
|
|
|
(defines (org-babel-read
|
|
|
|
(or (cdr (assoc :defines params))
|
2010-04-22 21:39:12 -04:00
|
|
|
(org-babel-read (org-entry-get nil "defines" t))))))
|
2010-07-15 19:43:06 -04:00
|
|
|
(org-babel-trim
|
|
|
|
(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")
|
|
|
|
;; variables
|
|
|
|
(mapconcat 'org-babel-C-var-to-C vars "\n")
|
|
|
|
;; body
|
|
|
|
(if main-p
|
|
|
|
(org-babel-C-ensure-main-wrap body)
|
|
|
|
body) "\n") "\n"))))
|
2010-04-11 16:29:02 -04:00
|
|
|
|
2010-03-26 19:12:43 -04:00
|
|
|
(defun org-babel-C-ensure-main-wrap (body)
|
|
|
|
"Wrap body in a \"main\" function call if none exists."
|
2010-03-26 20:52:16 -04:00
|
|
|
(if (string-match "^[ \t]*[intvod]+[ \t]*main[ \t]*(.*)" body)
|
2010-03-26 19:12:43 -04:00
|
|
|
body
|
|
|
|
(format "int main() {\n%s\n}\n" body)))
|
2010-03-26 15:16:56 -04:00
|
|
|
|
|
|
|
(defun org-babel-prep-session:C (session params)
|
2010-06-11 20:12:15 -04:00
|
|
|
"This function does nothing as C is a compiled language with no
|
|
|
|
support for sessions"
|
2010-03-26 15:16:56 -04:00
|
|
|
(error "C is a compiled languages -- no support for sessions"))
|
|
|
|
|
|
|
|
(defun org-babel-load-session:C (session body params)
|
2010-06-11 20:12:15 -04:00
|
|
|
"This function does nothing as C is a compiled language with no
|
|
|
|
support for sessions"
|
2010-03-26 15:16:56 -04:00
|
|
|
(error "C is a compiled languages -- no support for sessions"))
|
|
|
|
|
|
|
|
;; helper functions
|
|
|
|
|
|
|
|
(defun org-babel-C-var-to-C (pair)
|
|
|
|
"Convert an elisp val into a string of C code specifying a var
|
2010-06-11 20:12:15 -04:00
|
|
|
of the same value."
|
|
|
|
;; TODO list support
|
2010-03-27 10:20:38 -04:00
|
|
|
(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 "int %S = %S;" var val))
|
|
|
|
((floatp val)
|
|
|
|
(format "double %S = %S;" var val))
|
|
|
|
((or (characterp val))
|
|
|
|
(format "char %S = '%S';" var val))
|
|
|
|
((stringp val)
|
|
|
|
(format "char %S[%d] = \"%s\";"
|
|
|
|
var (+ 1 (length val)) val))
|
|
|
|
(t
|
|
|
|
(format "u32 %S = %S;" var val)))))
|
|
|
|
|
2010-03-26 15:16:56 -04:00
|
|
|
|
2010-06-11 19:02:42 -04:00
|
|
|
(provide 'ob-C)
|
2010-06-25 12:32:35 -04:00
|
|
|
|
|
|
|
;; arch-tag: 8f49e462-54e3-417b-9a8d-423864893b37
|
|
|
|
|
2010-06-11 19:02:42 -04:00
|
|
|
;;; ob-C.el ends here
|