lisp/ob-C.el

   1 ;;; ob-C.el --- org-babel functions for C and similar languages
   2
   3 ;; Copyright (C) 2010-2013 Free Software Foundation, Inc.
   4
   5 ;; Author: Eric Schulte
   6 ;; Keywords: literate programming, reproducible research
   7 ;; Homepage: http://orgmode.org
   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 C code.
  27 ;;
  28 ;; very limited implementation:
  29 ;; - currently only support :results output
  30 ;; - not much in the way of error feedback
  31
  32 ;;; Code:
  33 (require 'ob)
  34 (require 'cc-mode)
  35
  36 (declare-function org-entry-get "org"
  37                   (pom property &optional inherit literal-nil))
  38
  39
  40 (defvar org-babel-tangle-lang-exts)
  41 (add-to-list 'org-babel-tangle-lang-exts '("C++" . "cpp"))
  42 (let ((x (member '(C . t) org-babel-load-languages)))
  43   (setcdr x  (cons '(C++ . t) (subseq x 1))))
  44
  45 (defvar org-babel-default-header-args:C '())
  46
  47 (defvar org-babel-C-compiler "gcc"
  48   "Command used to compile a C source code file into an
  49 executable.")
  50
  51 (defvar org-babel-C++-compiler "g++"
  52   "Command used to compile a C++ source code file into an
  53 executable.")
  54
  55 (defvar org-babel-c-variant nil
  56   "Internal variable used to hold which type of C (e.g. C or C++)
  57 is currently being evaluated.")
  58
  59 (defun org-babel-execute:cpp (body params)
  60   "Execute BODY according to PARAMS.
  61 This function calls `org-babel-execute:C++'."
  62   (org-babel-execute:C++ body params))
  63
  64 (defun org-babel-execute:C++ (body params)
  65   "Execute a block of C++ code with org-babel.
  66 This function is called by `org-babel-execute-src-block'."
  67   (let ((org-babel-c-variant 'cpp)) (org-babel-C-execute body params)))
  68
  69 (defun org-babel-expand-body:C++ (body params)
  70   "Expand a block of C++ code with org-babel according to it's
  71 header arguments (calls `org-babel-C-expand')."
  72   (let ((org-babel-c-variant 'cpp)) (org-babel-C-expand body params)))
  73
  74 (defun org-babel-execute:C (body params)
  75   "Execute a block of C code with org-babel.
  76 This function is called by `org-babel-execute-src-block'."
  77   (let ((org-babel-c-variant 'c)) (org-babel-C-execute body params)))
  78
  79 (defun org-babel-expand-body:c (body params)
  80   "Expand a block of C code with org-babel according to it's
  81 header arguments (calls `org-babel-C-expand')."
  82   (let ((org-babel-c-variant 'c)) (org-babel-C-expand body params)))
  83
  84 (defun org-babel-C-execute (body params)
  85   "This function should only be called by `org-babel-execute:C'
  86 or `org-babel-execute:C++'."
  87   (let* ((tmp-src-file (org-babel-temp-file
  88                         "C-src-"
  89                         (cond
  90                          ((equal org-babel-c-variant 'c) ".c")
  91                          ((equal org-babel-c-variant 'cpp) ".cpp"))))
  92          (tmp-bin-file (org-babel-temp-file "C-bin-" org-babel-exeext))
  93          (cmdline (cdr (assoc :cmdline params)))
  94          (flags (cdr (assoc :flags params)))
  95          (full-body (org-babel-C-expand body params))
  96          (compile
  97           (progn
  98             (with-temp-file tmp-src-file (insert full-body))
  99             (org-babel-eval
 100              (format "%s -o %s %s %s"
 101                      (cond
 102                       ((equal org-babel-c-variant 'c) org-babel-C-compiler)
 103                       ((equal org-babel-c-variant 'cpp) org-babel-C++-compiler))
 104                      (org-babel-process-file-name tmp-bin-file)
 105                      (mapconcat 'identity
 106                                 (if (listp flags) flags (list flags)) " ")
 107                      (org-babel-process-file-name tmp-src-file)) ""))))
 108     ((lambda (results)
 109        (org-babel-reassemble-table
 110         (org-babel-result-cond (cdr (assoc :result-params params))
 111           (org-babel-read results)
 112           (let ((tmp-file (org-babel-temp-file "c-")))
 113             (with-temp-file tmp-file (insert results))
 114             (org-babel-import-elisp-from-file tmp-file)))
 115         (org-babel-pick-name
 116          (cdr (assoc :colname-names params)) (cdr (assoc :colnames params)))
 117         (org-babel-pick-name
 118          (cdr (assoc :rowname-names params)) (cdr (assoc :rownames params)))))
 119      (org-babel-trim
 120       (org-babel-eval
 121        (concat tmp-bin-file (if cmdline (concat " " cmdline) "")) "")))))
 122
 123 (defun org-babel-C-expand (body params)
 124   "Expand a block of C or C++ code with org-babel according to
 125 it's header arguments."
 126   (let ((vars (mapcar #'cdr (org-babel-get-header params :var)))
 127         (main-p (not (string= (cdr (assoc :main params)) "no")))
 128         (includes (or (cdr (assoc :includes params))
 129                       (org-babel-read (org-entry-get nil "includes" t))))
 130         (defines (org-babel-read
 131                   (or (cdr (assoc :defines params))
 132                       (org-babel-read (org-entry-get nil "defines" t))))))
 133     (mapconcat 'identity
 134                (list
 135                 ;; includes
 136                 (mapconcat
 137                  (lambda (inc) (format "#include %s" inc))
 138                  (if (listp includes) includes (list includes)) "\n")
 139                 ;; defines
 140                 (mapconcat
 141                  (lambda (inc) (format "#define %s" inc))
 142                  (if (listp defines) defines (list defines)) "\n")
 143                 ;; variables
 144                 (mapconcat 'org-babel-C-var-to-C vars "\n")
 145                 ;; body
 146                 (if main-p
 147                     (org-babel-C-ensure-main-wrap body)
 148                   body) "\n") "\n")))
 149
 150 (defun org-babel-C-ensure-main-wrap (body)
 151   "Wrap BODY in a \"main\" function call if none exists."
 152   (if (string-match "^[ \t]*[intvod]+[ \t\n\r]*main[ \t]*(.*)" body)
 153       body
 154     (format "int main() {\n%s\nreturn 0;\n}\n" body)))
 155
 156 (defun org-babel-prep-session:C (session params)
 157   "This function does nothing as C is a compiled language with no
 158 support for sessions"
 159   (error "C is a compiled languages -- no support for sessions"))
 160
 161 (defun org-babel-load-session:C (session body params)
 162   "This function does nothing as C is a compiled language with no
 163 support for sessions"
 164   (error "C is a compiled languages -- no support for sessions"))
 165
 166 ;; helper functions
 167
 168 (defun org-babel-C-format-val (type val)
 169   "Handle the FORMAT part of TYPE with the data from VAL."
 170   (let ((format-data (cadr type)))
 171     (if (stringp format-data)
 172         (cons "" (format format-data val))
 173       (funcall format-data val))))
 174
 175 (defun org-babel-C-val-to-C-type (val)
 176   "Determine the type of VAL.
 177 Return a list (TYPE-NAME FORMAT).  TYPE-NAME should be the name of the type.
 178 FORMAT can be either a format string or a function which is called with VAL."
 179   (cond
 180    ((integerp val) '("int" "%d"))
 181    ((floatp val) '("double" "%f"))
 182    ((or (listp val) (vectorp val))
 183     (lexical-let ((type (org-babel-C-val-to-C-list-type val)))
 184       (list (car type)
 185             (lambda (val)
 186               (cons
 187                (format "[%d]%s"
 188                        (length val)
 189                        (car (org-babel-C-format-val type (elt val 0))))
 190                (concat "{ "
 191                        (mapconcat (lambda (v)
 192                                     (cdr (org-babel-C-format-val type v)))
 193                                   val
 194                                   ", ")
 195                        " }"))))))
 196    (t ;; treat unknown types as string
 197     '("char" (lambda (val)
 198                (let ((s (format "%s" val))) ;; convert to string for unknown types
 199                  (cons (format "[%d]" (1+ (length s)))
 200                        (concat "\"" s "\""))))))))
 201
 202 (defun org-babel-C-val-to-C-list-type (val)
 203   "Determine the C array type of a VAL."
 204   (let (type)
 205     (mapc
 206      #'(lambda (i)
 207          (let* ((tmp-type (org-babel-C-val-to-C-type i))
 208                 (type-name (car type))
 209                 (tmp-type-name (car tmp-type)))
 210            (when (and type (not (string= type-name tmp-type-name)))
 211              (if (and (member type-name '("int" "double" "int32_t"))
 212                       (member tmp-type-name '("int" "double" "int32_t")))
 213                  (setq tmp-type '("double" "" "%f"))
 214                (error "Only homogeneous lists are supported by C.  You can not mix %s and %s"
 215                       type-name
 216                       tmp-type-name)))
 217            (setq type tmp-type)))
 218      val)
 219     type))
 220
 221 (defun org-babel-C-var-to-C (pair)
 222   "Convert an elisp val into a string of C code specifying a var
 223 of the same value."
 224   ;; TODO list support
 225   (let ((var (car pair))
 226         (val (cdr pair)))
 227     (when (symbolp val)
 228       (setq val (symbol-name val))
 229       (when (= (length val) 1)
 230         (setq val (string-to-char val))))
 231     (let* ((type-data (org-babel-C-val-to-C-type val))
 232            (type (car type-data))
 233            (formated (org-babel-C-format-val type-data val))
 234            (suffix (car formated))
 235            (data (cdr formated)))
 236       (format "%s %s%s = %s;"
 237               type
 238               var
 239               suffix
 240               data))))
 241
 242 (provide 'ob-C)
 243
 244 ;;; ob-C.el ends here