lisp/ob.el

   1 ;;; ob.el --- working with code blocks in org-mode
   2
   3 ;; Copyright (C) 2009-2011  Free Software Foundation, Inc.
   4
   5 ;; Author: Eric Schulte
   6 ;;      Dan Davison
   7 ;; Keywords: literate programming, reproducible research
   8 ;; Homepage: http://orgmode.org
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Code:
  26 (eval-when-compile
  27   (require 'cl))
  28 (require 'ob-eval)
  29 (require 'org-macs)
  30
  31 (defvar org-babel-call-process-region-original)
  32 (defvar org-src-lang-modes)
  33 (defvar org-babel-library-of-babel)
  34 (declare-function show-all "outline" ())
  35 (declare-function tramp-compat-make-temp-file "tramp-compat"
  36                   (filename &optional dir-flag))
  37 (declare-function tramp-dissect-file-name "tramp" (name &optional nodefault))
  38 (declare-function tramp-file-name-user "tramp" (vec))
  39 (declare-function tramp-file-name-host "tramp" (vec))
  40 (declare-function with-parsed-tramp-file-name "tramp" (filename var &rest body))
  41 (declare-function org-icompleting-read "org" (&rest args))
  42 (declare-function org-edit-src-code "org-src"
  43                   (&optional context code edit-buffer-name quietp))
  44 (declare-function org-edit-src-exit "org-src"  (&optional context))
  45 (declare-function org-open-at-point "org" (&optional in-emacs reference-buffer))
  46 (declare-function org-save-outline-visibility "org" (use-markers &rest body))
  47 (declare-function org-outline-overlay-data "org" (&optional use-markers))
  48 (declare-function org-set-outline-overlay-data "org" (data))
  49 (declare-function org-narrow-to-subtree "org" ())
  50 (declare-function org-entry-get "org"
  51                   (pom property &optional inherit literal-nil))
  52 (declare-function org-make-options-regexp "org" (kwds &optional extra))
  53 (declare-function org-do-remove-indentation "org" (&optional n))
  54 (declare-function org-show-context "org" (&optional key))
  55 (declare-function org-at-table-p "org" (&optional table-type))
  56 (declare-function org-cycle "org" (&optional arg))
  57 (declare-function org-uniquify "org" (list))
  58 (declare-function org-current-level "org" ())
  59 (declare-function org-table-import "org-table" (file arg))
  60 (declare-function org-add-hook "org-compat"
  61                   (hook function &optional append local))
  62 (declare-function org-table-align "org-table" ())
  63 (declare-function org-table-end "org-table" (&optional table-type))
  64 (declare-function orgtbl-to-generic "org-table" (table params))
  65 (declare-function orgtbl-to-orgtbl "org-table" (table params))
  66 (declare-function org-babel-tangle-comment-links "ob-tangle" (&optional info))
  67 (declare-function org-babel-lob-get-info "ob-lob" nil)
  68 (declare-function org-babel-ref-split-args "ob-ref" (arg-string))
  69 (declare-function org-babel-ref-parse "ob-ref" (assignment))
  70 (declare-function org-babel-ref-resolve "ob-ref" (ref))
  71 (declare-function org-babel-ref-goto-headline-id "ob-ref" (id))
  72 (declare-function org-babel-ref-headline-body "ob-ref" ())
  73 (declare-function org-babel-lob-execute-maybe "ob-lob" ())
  74 (declare-function org-number-sequence "org-compat" (from &optional to inc))
  75 (declare-function org-at-item-p "org-list" ())
  76 (declare-function org-list-parse-list "org-list" (&optional delete))
  77 (declare-function org-list-to-generic "org-list" (LIST PARAMS))
  78 (declare-function org-list-struct "org-list" ())
  79 (declare-function org-list-prevs-alist "org-list" (struct))
  80 (declare-function org-list-get-list-end "org-list" (item struct prevs))
  81
  82 (defgroup org-babel nil
  83   "Code block evaluation and management in `org-mode' documents."
  84   :tag "Babel"
  85   :group 'org)
  86
  87 (defcustom org-confirm-babel-evaluate t
  88   "Confirm before evaluation.
  89 Require confirmation before interactively evaluating code
  90 blocks in Org-mode buffers.  The default value of this variable
  91 is t, meaning confirmation is required for any code block
  92 evaluation.  This variable can be set to nil to inhibit any
  93 future confirmation requests.  This variable can also be set to a
  94 function which takes two arguments the language of the code block
  95 and the body of the code block.  Such a function should then
  96 return a non-nil value if the user should be prompted for
  97 execution or nil if no prompt is required.
  98
  99 Warning: Disabling confirmation may result in accidental
 100 evaluation of potentially harmful code.  It may be advisable
 101 remove code block execution from C-c C-c as further protection
 102 against accidental code block evaluation.  The
 103 `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can be used to
 104 remove code block execution from the C-c C-c keybinding."
 105     :group 'org-babel
 106     :type '(choice boolean function))
 107 ;; don't allow this variable to be changed through file settings
 108 (put 'org-confirm-babel-evaluate 'safe-local-variable (lambda (x) (eq x t)))
 109
 110 (defcustom org-babel-no-eval-on-ctrl-c-ctrl-c nil
 111   "Remove code block evaluation from the C-c C-c key binding."
 112   :group 'org-babel
 113   :type 'boolean)
 114
 115 (defvar org-babel-src-name-regexp
 116   "^[ \t]*#\\+\\(srcname\\|source\\|function\\):[ \t]*"
 117   "Regular expression used to match a source name line.")
 118
 119 (defvar org-babel-multi-line-header-regexp
 120   "^[ \t]*#\\+headers?:[ \t]*\\([^\n]*\\)$"
 121   "Regular expression used to match multi-line header arguments.")
 122
 123 (defvar org-babel-src-name-w-name-regexp
 124   (concat org-babel-src-name-regexp
 125           "\\("
 126           org-babel-multi-line-header-regexp
 127           "\\)*"
 128           "\\([^ ()\f\t\n\r\v]+\\)\\(\(\\(.*\\)\)\\|\\)")
 129   "Regular expression matching source name lines with a name.")
 130
 131 (defvar org-babel-src-block-regexp
 132   (concat
 133    ;; (1) indentation                 (2) lang
 134    "^\\([ \t]*\\)#\\+begin_src[ \t]+\\([^ \f\t\n\r\v]+\\)[ \t]*"
 135    ;; (3) switches
 136    "\\([^\":\n]*\"[^\"\n*]*\"[^\":\n]*\\|[^\":\n]*\\)"
 137    ;; (4) header arguments
 138    "\\([^\n]*\\)\n"
 139    ;; (5) body
 140    "\\([^\000]*?\n\\)?[ \t]*#\\+end_src")
 141   "Regexp used to identify code blocks.")
 142
 143 (defvar org-babel-inline-src-block-regexp
 144   (concat
 145    ;; (1) replacement target (2) lang
 146    "\\(?:^\\|[^-[:alnum:]]\\)\\(src_\\([^ \f\t\n\r\v]+\\)"
 147    ;; (3,4) (unused, headers)
 148    "\\(\\|\\[\\(.*?\\)\\]\\)"
 149    ;; (5) body
 150    "{\\([^\f\n\r\v]+?\\)}\\)")
 151   "Regexp used to identify inline src-blocks.")
 152
 153 (defun org-babel-get-header (params key &optional others)
 154   "Select only header argument of type KEY from a list.
 155 Optional argument OTHERS indicates that only the header that do
 156 not match KEY should be returned."
 157   (delq nil
 158         (mapcar
 159          (lambda (p) (when (funcall (if others #'not #'identity) (eq (car p) key)) p))
 160          params)))
 161
 162 (defun org-babel-get-src-block-info (&optional light)
 163   "Get information on the current source block.
 164
 165 Optional argument LIGHT does not resolve remote variable
 166 references; a process which could likely result in the execution
 167 of other code blocks.
 168
 169 Returns a list
 170  (language body header-arguments-alist switches name indent)."
 171   (let ((case-fold-search t) head info name indent)
 172     ;; full code block
 173     (if (setq head (org-babel-where-is-src-block-head))
 174         (save-excursion
 175           (goto-char head)
 176           (setq info (org-babel-parse-src-block-match))
 177           (setq indent (car (last info)))
 178           (setq info (butlast info))
 179           (while (and (forward-line -1)
 180                       (looking-at org-babel-multi-line-header-regexp))
 181             (setf (nth 2 info)
 182                   (org-babel-merge-params
 183                    (nth 2 info)
 184                    (org-babel-parse-header-arguments (match-string 1)))))
 185           (when (looking-at org-babel-src-name-w-name-regexp)
 186             (setq name (org-babel-clean-text-properties (match-string 4)))
 187             (when (match-string 6)
 188               (setf (nth 2 info) ;; merge functional-syntax vars and header-args
 189                     (org-babel-merge-params
 190                      (mapcar (lambda (ref) (cons :var ref))
 191                              (org-babel-ref-split-args (match-string 6)))
 192                      (nth 2 info))))))
 193       ;; inline source block
 194       (when (save-excursion (re-search-backward "[ \f\t\n\r\v]" nil t)
 195                             (looking-at org-babel-inline-src-block-regexp))
 196         (setq info (org-babel-parse-inline-src-block-match))))
 197     ;; resolve variable references and add summary parameters
 198     (when (and info (not light))
 199       (setf (nth 2 info) (org-babel-process-params (nth 2 info))))
 200     (when info (append info (list name indent)))))
 201
 202 (defun org-babel-confirm-evaluate (info)
 203   "Confirm evaluation of the code block INFO.
 204 This behavior can be suppressed by setting the value of
 205 `org-confirm-babel-evaluate' to nil, in which case all future
 206 interactive code block evaluations will proceed without any
 207 confirmation from the user.
 208
 209 Note disabling confirmation may result in accidental evaluation
 210 of potentially harmful code."
 211   (let* ((eval (or (cdr (assoc :eval (nth 2 info)))
 212                    (when (assoc :noeval (nth 2 info)) "no")))
 213          (query (cond ((equal eval "query") t)
 214                       ((functionp org-confirm-babel-evaluate)
 215                        (funcall org-confirm-babel-evaluate
 216                                 (nth 0 info) (nth 1 info)))
 217                       (t org-confirm-babel-evaluate))))
 218     (if (or (equal eval "never") (equal eval "no")
 219             (and query
 220                  (not (yes-or-no-p
 221                        (format "Evaluate this%scode block%son your system? "
 222                                (if info (format " %s " (nth 0 info)) " ")
 223                                (if (nth 4 info)
 224                                    (format " (%s) " (nth 4 info)) " "))))))
 225         (prog1 nil (message "Evaluation %s"
 226                             (if (or (equal eval "never") (equal eval "no"))
 227                                 "Disabled" "Aborted")))
 228       t)))
 229
 230 ;;;###autoload
 231 (defun org-babel-execute-safely-maybe ()
 232   (unless org-babel-no-eval-on-ctrl-c-ctrl-c
 233     (org-babel-execute-maybe)))
 234
 235 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-babel-execute-safely-maybe)
 236
 237 ;;;###autoload
 238 (defun org-babel-execute-maybe ()
 239   (interactive)
 240   (or (org-babel-execute-src-block-maybe)
 241       (org-babel-lob-execute-maybe)))
 242
 243 (defun org-babel-execute-src-block-maybe ()
 244   "Conditionally execute a source block.
 245 Detect if this is context for a Babel src-block and if so
 246 then run `org-babel-execute-src-block'."
 247   (interactive)
 248   (let ((info (org-babel-get-src-block-info)))
 249     (if info
 250         (progn (org-babel-eval-wipe-error-buffer)
 251                (org-babel-execute-src-block current-prefix-arg info) t) nil)))
 252
 253 ;;;###autoload
 254 (defun org-babel-view-src-block-info ()
 255   "Display information on the current source block.
 256 This includes header arguments, language and name, and is largely
 257 a window into the `org-babel-get-src-block-info' function."
 258   (interactive)
 259   (let ((info (org-babel-get-src-block-info 'light)))
 260     (flet ((full (it) (> (length it) 0))
 261            (printf (fmt &rest args) (princ (apply #'format fmt args))))
 262       (when info
 263         (with-help-window (help-buffer)
 264           (let ((name        (nth 4 info))
 265                 (lang        (nth 0 info))
 266                 (switches    (nth 3 info))
 267                 (header-args (nth 2 info)))
 268             (when name            (printf "Name: %s\n"     name))
 269             (when lang            (printf "Lang: %s\n"     lang))
 270             (when (full switches) (printf "Switches: %s\n" switches))
 271             (printf "Header Arguments:\n")
 272             (dolist (pair (sort header-args
 273                                 (lambda (a b) (string< (symbol-name (car a))
 274                                                   (symbol-name (car b))))))
 275               (when (full (cdr pair))
 276                 (printf "\t%S%s\t%s\n"
 277                         (car pair)
 278                         (if (> (length (format "%S" (car pair))) 7) "" "\t")
 279                         (cdr pair))))))))))
 280
 281 ;;;###autoload
 282 (defun org-babel-expand-src-block-maybe ()
 283   "Conditionally expand a source block.
 284 Detect if this is context for a org-babel src-block and if so
 285 then run `org-babel-expand-src-block'."
 286   (interactive)
 287   (let ((info (org-babel-get-src-block-info)))
 288     (if info
 289         (progn (org-babel-expand-src-block current-prefix-arg info) t)
 290       nil)))
 291
 292 ;;;###autoload
 293 (defun org-babel-load-in-session-maybe ()
 294   "Conditionally load a source block in a session.
 295 Detect if this is context for a org-babel src-block and if so
 296 then run `org-babel-load-in-session'."
 297   (interactive)
 298   (let ((info (org-babel-get-src-block-info)))
 299     (if info
 300         (progn (org-babel-load-in-session current-prefix-arg info) t)
 301       nil)))
 302
 303 (add-hook 'org-metaup-hook 'org-babel-load-in-session-maybe)
 304
 305 ;;;###autoload
 306 (defun org-babel-pop-to-session-maybe ()
 307   "Conditionally pop to a session.
 308 Detect if this is context for a org-babel src-block and if so
 309 then run `org-babel-pop-to-session'."
 310   (interactive)
 311   (let ((info (org-babel-get-src-block-info)))
 312     (if info (progn (org-babel-pop-to-session current-prefix-arg info) t) nil)))
 313
 314 (add-hook 'org-metadown-hook 'org-babel-pop-to-session-maybe)
 315
 316 (defconst org-babel-header-arg-names
 317   '(cache cmdline colnames dir exports file noweb results
 318     session tangle var eval noeval comments no-expand shebang
 319     padline noweb-ref)
 320   "Common header arguments used by org-babel.
 321 Note that individual languages may define their own language
 322 specific header arguments as well.")
 323
 324 (defvar org-babel-default-header-args
 325   '((:session . "none") (:results . "replace") (:exports . "code")
 326     (:cache . "no") (:noweb . "no") (:hlines . "no") (:tangle . "no")
 327     (:padnewline . "yes"))
 328   "Default arguments to use when evaluating a source block.")
 329
 330 (defvar org-babel-default-inline-header-args
 331   '((:session . "none") (:results . "replace") (:exports . "results"))
 332   "Default arguments to use when evaluating an inline source block.")
 333
 334 (defvar org-babel-data-names '("TBLNAME" "RESNAME" "RESULTS" "DATA"))
 335
 336 (defvar org-babel-result-regexp
 337   (concat "^[ \t]*#\\+"
 338           (regexp-opt org-babel-data-names t)
 339           "\\(\\[\\([[:alnum:]]+\\)\\]\\)?\\:[ \t]*")
 340   "Regular expression used to match result lines.
 341 If the results are associated with a hash key then the hash will
 342 be saved in the second match data.")
 343
 344 (defvar org-babel-result-w-name-regexp
 345   (concat org-babel-result-regexp
 346           "\\([^ ()\f\t\n\r\v]+\\)\\(\(\\(.*\\)\)\\|\\)"))
 347
 348 (defvar org-babel-min-lines-for-block-output 10
 349   "The minimum number of lines for block output.
 350 If number of lines of output is equal to or exceeds this
 351 value, the output is placed in a #+begin_example...#+end_example
 352 block. Otherwise the output is marked as literal by inserting
 353 colons at the starts of the lines. This variable only takes
 354 effect if the :results output option is in effect.")
 355
 356 (defvar org-babel-noweb-error-langs nil
 357   "Languages for which Babel will raise literate programming errors.
 358 List of languages for which errors should be raised when the
 359 source code block satisfying a noweb reference in this language
 360 can not be resolved.")
 361
 362 (defvar org-babel-hash-show 4
 363   "Number of initial characters to show of a hidden results hash.")
 364
 365 (defvar org-babel-after-execute-hook nil
 366   "Hook for functions to be called after `org-babel-execute-src-block'")
 367 (defun org-babel-named-src-block-regexp-for-name (name)
 368   "This generates a regexp used to match a src block named NAME."
 369   (concat org-babel-src-name-regexp (regexp-quote name) "[ \t\n]*"
 370           (substring org-babel-src-block-regexp 1)))
 371
 372 ;;; functions
 373 (defvar call-process-region)
 374 ;;;###autoload
 375
 376 (defun org-babel-execute-src-block (&optional arg info params)
 377   "Execute the current source code block.
 378 Insert the results of execution into the buffer.  Source code
 379 execution and the collection and formatting of results can be
 380 controlled through a variety of header arguments.
 381
 382 With prefix argument ARG, force re-execution even if a an
 383 existing result cached in the buffer would otherwise have been
 384 returned.
 385
 386 Optionally supply a value for INFO in the form returned by
 387 `org-babel-get-src-block-info'.
 388
 389 Optionally supply a value for PARAMS which will be merged with
 390 the header arguments specified at the front of the source code
 391 block."
 392   (interactive)
 393   (let ((info (or info (org-babel-get-src-block-info))))
 394     (when (org-babel-confirm-evaluate info)
 395       (let* ((lang (nth 0 info))
 396              (params (if params
 397                          (org-babel-process-params
 398                           (org-babel-merge-params (nth 2 info) params))
 399                        (nth 2 info)))
 400              (cache? (and (not arg) (cdr (assoc :cache params))
 401                           (string= "yes" (cdr (assoc :cache params)))))
 402              (result-params (cdr (assoc :result-params params)))
 403              (new-hash (when cache? (org-babel-sha1-hash info)))
 404              (old-hash (when cache? (org-babel-current-result-hash)))
 405              (body (setf (nth 1 info)
 406                          (let ((noweb (cdr (assoc :noweb params))))
 407                            (if (and noweb
 408                                     (or (string= "yes" noweb)
 409                                         (string= "tangle" noweb)))
 410                                (org-babel-expand-noweb-references info)
 411                              (nth 1 info)))))
 412              (dir (cdr (assoc :dir params)))
 413              (default-directory
 414                (or (and dir (file-name-as-directory dir)) default-directory))
 415              (org-babel-call-process-region-original
 416               (if (boundp 'org-babel-call-process-region-original)
 417                   org-babel-call-process-region-original
 418                 (symbol-function 'call-process-region)))
 419              (indent (car (last info)))
 420              result cmd)
 421         (unwind-protect
 422             (flet ((call-process-region (&rest args)
 423                     (apply 'org-babel-tramp-handle-call-process-region args)))
 424               (flet ((lang-check (f)
 425                        (let ((f (intern (concat "org-babel-execute:" f))))
 426                          (when (fboundp f) f))))
 427                 (setq cmd
 428                       (or (lang-check lang)
 429                           (lang-check (symbol-name
 430                                        (cdr (assoc lang org-src-lang-modes))))
 431                           (error "No org-babel-execute function for %s!" lang))))
 432               (if (and (not arg) new-hash (equal new-hash old-hash))
 433                   (save-excursion ;; return cached result
 434                     (goto-char (org-babel-where-is-src-block-result nil info))
 435                     (end-of-line 1) (forward-char 1)
 436                     (setq result (org-babel-read-result))
 437                     (message (replace-regexp-in-string
 438                               "%" "%%" (format "%S" result))) result)
 439                 (message "executing %s code block%s..."
 440                          (capitalize lang)
 441                          (if (nth 4 info) (format " (%s)" (nth 4 info)) ""))
 442                 (setq result
 443                       ((lambda (result)
 444                          (if (and (eq (cdr (assoc :result-type params)) 'value)
 445                                   (or (member "vector" result-params)
 446                                       (member "table" result-params))
 447                                   (not (listp result)))
 448                              (list (list result)) result))
 449                        (funcall cmd body params)))
 450                 ;; if non-empty result and :file then write to :file
 451                 (when (cdr (assoc :file params))
 452                   (when result
 453                     (with-temp-file (cdr (assoc :file params))
 454                       (insert
 455                        (org-babel-format-result
 456                         result (cdr (assoc :sep (nth 2 info)))))))
 457                   (setq result (cdr (assoc :file params))))
 458                 (org-babel-insert-result
 459                  result result-params info new-hash indent lang)
 460                 (run-hooks 'org-babel-after-execute-hook)
 461                 result))
 462           (setq call-process-region 'org-babel-call-process-region-original))))))
 463
 464 (defun org-babel-expand-body:generic (body params &optional var-lines)
 465   "Expand BODY with PARAMS.
 466 Expand a block of code with org-babel according to it's header
 467 arguments.  This generic implementation of body expansion is
 468 called for languages which have not defined their own specific
 469 org-babel-expand-body:lang function."
 470   (mapconcat #'identity (append var-lines (list body)) "\n"))
 471
 472 ;;;###autoload
 473 (defun org-babel-expand-src-block (&optional arg info params)
 474   "Expand the current source code block.
 475 Expand according to the source code block's header
 476 arguments and pop open the results in a preview buffer."
 477   (interactive)
 478   (let* ((info (or info (org-babel-get-src-block-info)))
 479          (lang (nth 0 info))
 480          (params (setf (nth 2 info)
 481                        (sort (org-babel-merge-params (nth 2 info) params)
 482                              (lambda (el1 el2) (string< (symbol-name (car el1))
 483                                                    (symbol-name (car el2)))))))
 484          (body (setf (nth 1 info)
 485                      (if (and (cdr (assoc :noweb params))
 486                               (string= "yes" (cdr (assoc :noweb params))))
 487                          (org-babel-expand-noweb-references info) (nth 1 info))))
 488          (expand-cmd (intern (concat "org-babel-expand-body:" lang)))
 489          (assignments-cmd (intern (concat "org-babel-variable-assignments:"
 490                                           lang)))
 491          (expanded
 492           (if (fboundp expand-cmd) (funcall expand-cmd body params)
 493             (org-babel-expand-body:generic
 494              body params (and (fboundp assignments-cmd)
 495                               (funcall assignments-cmd params))))))
 496     (org-edit-src-code
 497      nil expanded (concat "*Org-Babel Preview " (buffer-name) "[ " lang " ]*"))))
 498
 499 (defun org-babel-edit-distance (s1 s2)
 500   "Return the edit (levenshtein) distance between strings S1 S2."
 501   (let* ((l1 (length s1))
 502          (l2 (length s2))
 503          (dist (map 'vector (lambda (_) (make-vector (1+ l2) nil))
 504                     (number-sequence 1 (1+ l1)))))
 505     (flet ((in (i j) (aref (aref dist i) j))
 506            (mmin (&rest lst) (apply #'min (remove nil lst))))
 507       (setf (aref (aref dist 0) 0) 0)
 508       (dolist (i (number-sequence 1 l1))
 509         (dolist (j (number-sequence 1 l2))
 510           (setf (aref (aref dist i) j)
 511                 (+ (if (equal (aref s1 (1- i)) (aref s2 (1- j))) 0 1)
 512                    (mmin (in (1- i) j) (in i (1- j)) (in (1- i) (1- j)))))))
 513       (in l1 l2))))
 514
 515 ;;;###autoload
 516 (defun org-babel-check-src-block ()
 517   "Check for misspelled header arguments in the current code block."
 518   (interactive)
 519   ;; TODO: report malformed code block
 520   ;; TODO: report incompatible combinations of header arguments
 521   (let ((too-close 2)) ;; <- control closeness to report potential match
 522     (dolist (header (mapcar (lambda (arg) (substring (symbol-name (car arg)) 1))
 523                             (and (org-babel-where-is-src-block-head)
 524                                  (org-babel-parse-header-arguments
 525                                   (org-babel-clean-text-properties
 526                                    (match-string 4))))))
 527       (dolist (name (mapcar #'symbol-name org-babel-header-arg-names))
 528         (when (and (not (string= header name))
 529                    (<= (org-babel-edit-distance header name) too-close))
 530           (error "supplied header \"%S\" is suspiciously close to \"%S\""
 531                  header name))))
 532     (message "No suspicious header arguments found.")))
 533
 534 ;;;###autoload
 535 (defun org-babel-load-in-session (&optional arg info)
 536   "Load the body of the current source-code block.
 537 Evaluate the header arguments for the source block before
 538 entering the session.  After loading the body this pops open the
 539 session."
 540   (interactive)
 541   (let* ((info (or info (org-babel-get-src-block-info)))
 542          (lang (nth 0 info))
 543          (params (nth 2 info))
 544          (body (setf (nth 1 info)
 545                      (if (and (cdr (assoc :noweb params))
 546                               (string= "yes" (cdr (assoc :noweb params))))
 547                          (org-babel-expand-noweb-references info)
 548                        (nth 1 info))))
 549          (session (cdr (assoc :session params)))
 550          (dir (cdr (assoc :dir params)))
 551          (default-directory
 552            (or (and dir (file-name-as-directory dir)) default-directory))
 553          (cmd (intern (concat "org-babel-load-session:" lang))))
 554     (unless (fboundp cmd)
 555       (error "No org-babel-load-session function for %s!" lang))
 556     (pop-to-buffer (funcall cmd session body params))
 557     (end-of-line 1)))
 558
 559 ;;;###autoload
 560 (defun org-babel-initiate-session (&optional arg info)
 561   "Initiate session for current code block.
 562 If called with a prefix argument then resolve any variable
 563 references in the header arguments and assign these variables in
 564 the session. Copy the body of the code block to the kill ring."
 565   (interactive "P")
 566   (let* ((info (or info (org-babel-get-src-block-info (not arg))))
 567          (lang (nth 0 info))
 568          (body (nth 1 info))
 569          (params (nth 2 info))
 570          (session (cdr (assoc :session params)))
 571          (dir (cdr (assoc :dir params)))
 572          (default-directory
 573            (or (and dir (file-name-as-directory dir)) default-directory))
 574          (init-cmd (intern (format "org-babel-%s-initiate-session" lang)))
 575          (prep-cmd (intern (concat "org-babel-prep-session:" lang))))
 576     (if (and (stringp session) (string= session "none"))
 577         (error "This block is not using a session!"))
 578     (unless (fboundp init-cmd)
 579       (error "No org-babel-initiate-session function for %s!" lang))
 580     (with-temp-buffer (insert (org-babel-trim body))
 581                       (copy-region-as-kill (point-min) (point-max)))
 582     (when arg
 583       (unless (fboundp prep-cmd)
 584         (error "No org-babel-prep-session function for %s!" lang))
 585       (funcall prep-cmd session params))
 586     (funcall init-cmd session params)))
 587
 588 ;;;###autoload
 589 (defun org-babel-switch-to-session (&optional arg info)
 590   "Switch to the session of the current code block.
 591 Uses `org-babel-initiate-session' to start the session. If called
 592 with a prefix argument then this is passed on to
 593 `org-babel-initiate-session'."
 594   (interactive "P")
 595   (pop-to-buffer (org-babel-initiate-session arg info))
 596   (end-of-line 1))
 597
 598 (defalias 'org-babel-pop-to-session 'org-babel-switch-to-session)
 599
 600 ;;;###autoload
 601 (defun org-babel-switch-to-session-with-code (&optional arg info)
 602   "Switch to code buffer and display session."
 603   (interactive "P")
 604   (flet ((swap-windows
 605           ()
 606           (let ((other-window-buffer (window-buffer (next-window))))
 607             (set-window-buffer (next-window) (current-buffer))
 608             (set-window-buffer (selected-window) other-window-buffer))
 609           (other-window 1)))
 610     (let ((info (org-babel-get-src-block-info))
 611           (org-src-window-setup 'reorganize-frame))
 612       (save-excursion
 613         (org-babel-switch-to-session arg info))
 614       (org-edit-src-code))
 615     (swap-windows)))
 616
 617 (defmacro org-babel-do-in-edit-buffer (&rest body)
 618   "Evaluate BODY in edit buffer if there is a code block at point.
 619 Return t if a code block was found at point, nil otherwise."
 620   `(let ((org-src-window-setup 'switch-invisibly))
 621      (when (and (org-babel-where-is-src-block-head)
 622                 (org-edit-src-code nil nil nil))
 623        (unwind-protect (progn ,@body)
 624          (if (org-bound-and-true-p org-edit-src-from-org-mode)
 625              (org-edit-src-exit)))
 626        t)))
 627 (def-edebug-spec org-babel-do-in-edit-buffer (body))
 628
 629 (defun org-babel-do-key-sequence-in-edit-buffer (key)
 630   "Read key sequence and execute the command in edit buffer.
 631 Enter a key sequence to be executed in the language major-mode
 632 edit buffer. For example, TAB will alter the contents of the
 633 Org-mode code block according to the effect of TAB in the
 634 language major-mode buffer. For languages that support
 635 interactive sessions, this can be used to send code from the Org
 636 buffer to the session for evaluation using the native major-mode
 637 evaluation mechanisms."
 638   (interactive "kEnter key-sequence to execute in edit buffer: ")
 639   (org-babel-do-in-edit-buffer
 640    (call-interactively
 641     (key-binding (or key (read-key-sequence nil))))))
 642
 643 (defvar org-bracket-link-regexp)
 644 ;;;###autoload
 645 (defun org-babel-open-src-block-result (&optional re-run)
 646   "If `point' is on a src block then open the results of the
 647 source code block, otherwise return nil.  With optional prefix
 648 argument RE-RUN the source-code block is evaluated even if
 649 results already exist."
 650   (interactive "P")
 651   (let ((info (org-babel-get-src-block-info)))
 652     (when info
 653       (save-excursion
 654         ;; go to the results, if there aren't any then run the block
 655         (goto-char (or (and (not re-run) (org-babel-where-is-src-block-result))
 656                        (progn (org-babel-execute-src-block)
 657                               (org-babel-where-is-src-block-result))))
 658         (end-of-line 1)
 659         (while (looking-at "[\n\r\t\f ]") (forward-char 1))
 660         ;; open the results
 661         (if (looking-at org-bracket-link-regexp)
 662             ;; file results
 663             (org-open-at-point)
 664           (let ((r (org-babel-format-result
 665                     (org-babel-read-result) (cdr (assoc :sep (nth 2 info))))))
 666             (pop-to-buffer (get-buffer-create "*Org-Babel Results*"))
 667             (delete-region (point-min) (point-max))
 668             (insert r)))
 669         t))))
 670
 671 ;;;###autoload
 672 (defmacro org-babel-map-src-blocks (file &rest body)
 673   "Evaluate BODY forms on each source-block in FILE.
 674 If FILE is nil evaluate BODY forms on source blocks in current
 675 buffer.  During evaluation of BODY the following local variables
 676 are set relative to the currently matched code block.
 677
 678 full-block ------- string holding the entirety of the code block
 679 beg-block -------- point at the beginning of the code block
 680 end-block -------- point at the end of the matched code block
 681 lang ------------- string holding the language of the code block
 682 beg-lang --------- point at the beginning of the lang
 683 end-lang --------- point at the end of the lang
 684 switches --------- string holding the switches
 685 beg-switches ----- point at the beginning of the switches
 686 end-switches ----- point at the end of the switches
 687 header-args ------ string holding the header-args
 688 beg-header-args -- point at the beginning of the header-args
 689 end-header-args -- point at the end of the header-args
 690 body ------------- string holding the body of the code block
 691 beg-body --------- point at the beginning of the body
 692 end-body --------- point at the end of the body"
 693   (declare (indent 1))
 694   (let ((tempvar (make-symbol "file")))
 695     `(let* ((,tempvar ,file)
 696             (visited-p (or (null ,tempvar)
 697                            (get-file-buffer (expand-file-name ,tempvar))))
 698             (point (point)) to-be-removed)
 699        (save-window-excursion
 700          (when ,tempvar (find-file ,tempvar))
 701          (setq to-be-removed (current-buffer))
 702          (goto-char (point-min))
 703          (while (re-search-forward org-babel-src-block-regexp nil t)
 704            (goto-char (match-beginning 0))
 705            (let ((full-block (match-string 0))
 706                  (beg-block (match-beginning 0))
 707                  (end-block (match-end 0))
 708                  (lang (match-string 2))
 709                  (beg-lang (match-beginning 2))
 710                  (end-lang (match-end 2))
 711                  (switches (match-string 3))
 712                  (beg-switches (match-beginning 3))
 713                  (end-switches (match-end 3))
 714                  (header-args (match-string 4))
 715                  (beg-header-args (match-beginning 4))
 716                  (end-header-args (match-end 4))
 717                  (body (match-string 5))
 718                  (beg-body (match-beginning 5))
 719                  (end-body (match-end 5)))
 720              ,@body
 721              (goto-char end-block))))
 722        (unless visited-p (kill-buffer to-be-removed))
 723        (goto-char point))))
 724 (def-edebug-spec org-babel-map-src-blocks (form body))
 725
 726 ;;;###autoload
 727 (defmacro org-babel-map-inline-src-blocks (file &rest body)
 728   "Evaluate BODY forms on each inline source-block in FILE.
 729 If FILE is nil evaluate BODY forms on source blocks in current
 730 buffer."
 731   (declare (indent 1))
 732   (let ((tempvar (make-symbol "file")))
 733     `(let* ((,tempvar ,file)
 734             (visited-p (or (null ,tempvar)
 735                            (get-file-buffer (expand-file-name ,tempvar))))
 736             (point (point)) to-be-removed)
 737        (save-window-excursion
 738          (when ,tempvar (find-file ,tempvar))
 739          (setq to-be-removed (current-buffer))
 740          (goto-char (point-min))
 741          (while (re-search-forward org-babel-inline-src-block-regexp nil t)
 742            (goto-char (match-beginning 1))
 743            (save-match-data ,@body)
 744            (goto-char (match-end 0))))
 745        (unless visited-p (kill-buffer to-be-removed))
 746        (goto-char point))))
 747 (def-edebug-spec org-babel-map-inline-src-blocks (form body))
 748
 749 ;;;###autoload
 750 (defun org-babel-execute-buffer (&optional arg)
 751   "Execute source code blocks in a buffer.
 752 Call `org-babel-execute-src-block' on every source block in
 753 the current buffer."
 754   (interactive "P")
 755   (org-babel-eval-wipe-error-buffer)
 756   (org-save-outline-visibility t
 757     (org-babel-map-src-blocks nil
 758       (org-babel-execute-src-block arg))
 759     (org-babel-map-inline-src-blocks nil
 760       (org-babel-execute-src-block arg))))
 761
 762 ;;;###autoload
 763 (defun org-babel-execute-subtree (&optional arg)
 764   "Execute source code blocks in a subtree.
 765 Call `org-babel-execute-src-block' on every source block in
 766 the current subtree."
 767   (interactive "P")
 768   (save-restriction
 769     (save-excursion
 770       (org-narrow-to-subtree)
 771       (org-babel-execute-buffer arg)
 772       (widen))))
 773
 774 ;;;###autoload
 775 (defun org-babel-sha1-hash (&optional info)
 776   "Generate an sha1 hash based on the value of info."
 777   (interactive)
 778   (let ((print-level nil)
 779         (info (or info (org-babel-get-src-block-info))))
 780     (setf (nth 2 info)
 781           (sort (copy-sequence (nth 2 info))
 782                 (lambda (a b) (string< (car a) (car b)))))
 783     (labels ((rm (lst)
 784                  (dolist (p '("replace" "silent" "append" "prepend"))
 785                    (setq lst (remove p lst)))
 786                  lst)
 787              (norm (arg)
 788                    (let ((v (if (and (listp (cdr arg)) (null (cddr arg)))
 789                                 (copy-sequence (cdr arg))
 790                               (cdr arg))))
 791                      (when (and v (not (and (sequencep v)
 792                                             (not (consp v))
 793                                             (= (length v) 0))))
 794                        (cond
 795                         ((and (listp v) ; lists are sorted
 796                               (member (car arg) '(:result-params)))
 797                          (sort (rm v) #'string<))
 798                         ((and (stringp v) ; strings are sorted
 799                               (member (car arg) '(:results :exports)))
 800                          (mapconcat #'identity (sort (rm (split-string v))
 801                                                      #'string<) " "))
 802                         (t v))))))
 803       ((lambda (hash)
 804          (when (org-called-interactively-p 'interactive) (message hash)) hash)
 805        (let ((it (format "%s-%s"
 806                          (mapconcat
 807                           #'identity
 808                           (delq nil (mapcar (lambda (arg)
 809                                               (let ((normalized (norm arg)))
 810                                                 (when normalized
 811                                                   (format "%S" normalized))))
 812                                             (nth 2 info))) ":")
 813                          (nth 1 info))))
 814          (sha1 it))))))
 815
 816 (defun org-babel-current-result-hash ()
 817   "Return the in-buffer hash associated with INFO."
 818   (org-babel-where-is-src-block-result)
 819   (org-babel-clean-text-properties (match-string 3)))
 820
 821 (defun org-babel-hide-hash ()
 822   "Hide the hash in the current results line.
 823 Only the initial `org-babel-hash-show' characters of the hash
 824 will remain visible."
 825   (add-to-invisibility-spec '(org-babel-hide-hash . t))
 826   (save-excursion
 827     (when (and (re-search-forward org-babel-result-regexp nil t)
 828                (match-string 3))
 829       (let* ((start (match-beginning 3))
 830              (hide-start (+ org-babel-hash-show start))
 831              (end (match-end 3))
 832              (hash (match-string 3))
 833              ov1 ov2)
 834         (setq ov1 (make-overlay start hide-start))
 835         (setq ov2 (make-overlay hide-start end))
 836         (overlay-put ov2 'invisible 'org-babel-hide-hash)
 837         (overlay-put ov1 'babel-hash hash)))))
 838
 839 (defun org-babel-hide-all-hashes ()
 840   "Hide the hash in the current buffer.
 841 Only the initial `org-babel-hash-show' characters of each hash
 842 will remain visible.  This function should be called as part of
 843 the `org-mode-hook'."
 844   (save-excursion
 845     (while (re-search-forward org-babel-result-regexp nil t)
 846       (goto-char (match-beginning 0))
 847       (org-babel-hide-hash)
 848       (goto-char (match-end 0)))))
 849 (add-hook 'org-mode-hook 'org-babel-hide-all-hashes)
 850
 851 (defun org-babel-hash-at-point (&optional point)
 852   "Return the value of the hash at POINT.
 853 The hash is also added as the last element of the kill ring.
 854 This can be called with C-c C-c."
 855   (interactive)
 856   (let ((hash (car (delq nil (mapcar
 857                               (lambda (ol) (overlay-get ol 'babel-hash))
 858                               (overlays-at (or point (point))))))))
 859     (when hash (kill-new hash) (message hash))))
 860 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-babel-hash-at-point)
 861
 862 (defun org-babel-result-hide-spec ()
 863   "Hide portions of results lines.
 864 Add `org-babel-hide-result' as an invisibility spec for hiding
 865 portions of results lines."
 866   (add-to-invisibility-spec '(org-babel-hide-result . t)))
 867 (add-hook 'org-mode-hook 'org-babel-result-hide-spec)
 868
 869 (defvar org-babel-hide-result-overlays nil
 870   "Overlays hiding results.")
 871
 872 (defun org-babel-result-hide-all ()
 873   "Fold all results in the current buffer."
 874   (interactive)
 875   (org-babel-show-result-all)
 876   (save-excursion
 877     (while (re-search-forward org-babel-result-regexp nil t)
 878       (save-excursion (goto-char (match-beginning 0))
 879                       (org-babel-hide-result-toggle-maybe)))))
 880
 881 (defun org-babel-show-result-all ()
 882   "Unfold all results in the current buffer."
 883   (mapc 'delete-overlay org-babel-hide-result-overlays)
 884   (setq org-babel-hide-result-overlays nil))
 885
 886 ;;;###autoload
 887 (defun org-babel-hide-result-toggle-maybe ()
 888   "Toggle visibility of result at point."
 889   (interactive)
 890   (let ((case-fold-search t))
 891     (if (save-excursion
 892           (beginning-of-line 1)
 893           (looking-at org-babel-result-regexp))
 894         (progn (org-babel-hide-result-toggle)
 895                t) ;; to signal that we took action
 896       nil))) ;; to signal that we did not
 897
 898 (defun org-babel-hide-result-toggle (&optional force)
 899   "Toggle the visibility of the current result."
 900   (interactive)
 901   (save-excursion
 902     (beginning-of-line)
 903     (if (re-search-forward org-babel-result-regexp nil t)
 904         (let ((start (progn (beginning-of-line 2) (- (point) 1)))
 905               (end (progn (goto-char (- (org-babel-result-end) 1)) (point)))
 906               ov)
 907           (if (memq t (mapcar (lambda (overlay)
 908                                 (eq (overlay-get overlay 'invisible)
 909                                     'org-babel-hide-result))
 910                               (overlays-at start)))
 911               (if (or (not force) (eq force 'off))
 912                   (mapc (lambda (ov)
 913                           (when (member ov org-babel-hide-result-overlays)
 914                             (setq org-babel-hide-result-overlays
 915                                   (delq ov org-babel-hide-result-overlays)))
 916                           (when (eq (overlay-get ov 'invisible)
 917                                     'org-babel-hide-result)
 918                             (delete-overlay ov)))
 919                         (overlays-at start)))
 920             (setq ov (make-overlay start end))
 921             (overlay-put ov 'invisible 'org-babel-hide-result)
 922             ;; make the block accessible to isearch
 923             (overlay-put
 924              ov 'isearch-open-invisible
 925              (lambda (ov)
 926                (when (member ov org-babel-hide-result-overlays)
 927                  (setq org-babel-hide-result-overlays
 928                        (delq ov org-babel-hide-result-overlays)))
 929                (when (eq (overlay-get ov 'invisible)
 930                          'org-babel-hide-result)
 931                  (delete-overlay ov))))
 932             (push ov org-babel-hide-result-overlays)))
 933       (error "Not looking at a result line"))))
 934
 935 ;; org-tab-after-check-for-cycling-hook
 936 (add-hook 'org-tab-first-hook 'org-babel-hide-result-toggle-maybe)
 937 ;; Remove overlays when changing major mode
 938 (add-hook 'org-mode-hook
 939           (lambda () (org-add-hook 'change-major-mode-hook
 940                                    'org-babel-show-result-all 'append 'local)))
 941
 942 (defvar org-file-properties)
 943 (defun org-babel-params-from-properties (&optional lang)
 944   "Retrieve parameters specified as properties.
 945 Return an association list of any source block params which
 946 may be specified in the properties of the current outline entry."
 947   (save-match-data
 948     (let (val sym)
 949       (delq nil
 950             (mapcar
 951              (lambda (header-arg)
 952                (and (setq val (org-entry-get (point) header-arg t))
 953                     (cons (intern (concat ":" header-arg))
 954                           (org-babel-read val))))
 955              (mapcar
 956               'symbol-name
 957               (append
 958                org-babel-header-arg-names
 959                (progn
 960                  (setq sym (intern (concat "org-babel-header-arg-names:" lang)))
 961                  (and (boundp sym) (eval sym))))))))))
 962
 963 (defun org-babel-params-from-buffer ()
 964   "Retrieve per-buffer parameters.
 965  Return an association list of any source block params which
 966 may be specified in the current buffer."
 967   (let (local-properties)
 968     (save-match-data
 969       (save-excursion
 970         (save-restriction
 971           (widen)
 972           (goto-char (point-min))
 973           (while (re-search-forward
 974                   (org-make-options-regexp (list "BABEL" "PROPERTIES")) nil t)
 975             (setq local-properties
 976                   (org-babel-merge-params
 977                    local-properties
 978                    (org-babel-parse-header-arguments
 979                     (org-match-string-no-properties 2)))))
 980           local-properties)))))
 981
 982 (defvar org-src-preserve-indentation)
 983 (defun org-babel-parse-src-block-match ()
 984   "Parse the results from a match of the `org-babel-src-block-regexp'."
 985   (let* ((block-indentation (length (match-string 1)))
 986          (lang (org-babel-clean-text-properties (match-string 2)))
 987          (lang-headers (intern (concat "org-babel-default-header-args:" lang)))
 988          (switches (match-string 3))
 989          (body (org-babel-clean-text-properties
 990                 (let* ((body (match-string 5))
 991                        (sub-length (- (length body) 1)))
 992                   (if (string= "\n" (substring body sub-length))
 993                       (substring body 0 sub-length)
 994                     body))))
 995          (preserve-indentation (or org-src-preserve-indentation
 996                                    (string-match "-i\\>" switches))))
 997     (list lang
 998           ;; get block body less properties, protective commas, and indentation
 999           (with-temp-buffer
1000             (save-match-data
1001               (insert (org-babel-strip-protective-commas body))
1002               (unless preserve-indentation (org-do-remove-indentation))
1003               (buffer-string)))
1004           (org-babel-merge-params
1005            org-babel-default-header-args
1006            (org-babel-params-from-buffer)
1007            (org-babel-params-from-properties lang)
1008            (if (boundp lang-headers) (eval lang-headers) nil)
1009            (org-babel-parse-header-arguments
1010             (org-babel-clean-text-properties (or (match-string 4) ""))))
1011           switches
1012           block-indentation)))
1013
1014 (defun org-babel-parse-inline-src-block-match ()
1015   "Parse the results from a match of the `org-babel-inline-src-block-regexp'."
1016   (let* ((lang (org-babel-clean-text-properties (match-string 2)))
1017          (lang-headers (intern (concat "org-babel-default-header-args:" lang))))
1018     (list lang
1019           (org-babel-strip-protective-commas
1020            (org-babel-clean-text-properties (match-string 5)))
1021           (org-babel-merge-params
1022            org-babel-default-inline-header-args
1023            (org-babel-params-from-buffer)
1024            (org-babel-params-from-properties lang)
1025            (if (boundp lang-headers) (eval lang-headers) nil)
1026            (org-babel-parse-header-arguments
1027             (org-babel-clean-text-properties (or (match-string 4) "")))))))
1028
1029 (defun org-babel-parse-header-arguments (arg-string)
1030   "Parse a string of header arguments returning an alist."
1031   (when (> (length arg-string) 0)
1032     (delq nil
1033           (mapcar
1034            (lambda (arg)
1035              (if (string-match
1036                   "\\([^ \f\t\n\r\v]+\\)[ \f\t\n\r\v]+\\([^ \f\t\n\r\v]+.*\\)"
1037                   arg)
1038                  (cons (intern (match-string 1 arg))
1039                        (org-babel-read (org-babel-chomp (match-string 2 arg))))
1040                (cons (intern (org-babel-chomp arg)) nil)))
1041            (let ((balance 0) (partial nil) (lst nil) (last 0))
1042              (mapc (lambda (ch)  ; split on [] balanced instances of [ \t]:
1043                      (setq balance (+ balance
1044                                       (cond ((equal 91 ch) 1)
1045                                             ((equal 93 ch) -1)
1046                                             (t 0))))
1047                      (setq partial (cons ch partial))
1048                      (when (and (= ch 58) (= balance 0)
1049                                 (or (= last 32) (= last 9)))
1050                        (setq lst (cons (apply #'string (nreverse (cddr partial)))
1051                                        lst))
1052                        (setq partial (list ch)))
1053                      (setq last ch))
1054                    (string-to-list arg-string))
1055              (nreverse (cons (apply #'string (nreverse partial)) lst)))))))
1056
1057 (defun org-babel-process-params (params)
1058   "Expand variables in PARAMS and add summary parameters."
1059   (let* ((vars-and-names (org-babel-disassemble-tables
1060                           (mapcar (lambda (el)
1061                                     (if (consp (cdr el))
1062                                         (cdr el) (org-babel-ref-parse (cdr el))))
1063                                   (org-babel-get-header params :var))
1064                           (cdr (assoc :hlines params))
1065                           (cdr (assoc :colnames params))
1066                           (cdr (assoc :rownames params))))
1067          (raw-result (or (cdr (assoc :results params)) ""))
1068          (result-params (append
1069                          (split-string (if (stringp raw-result)
1070                                            raw-result
1071                                          (eval raw-result)))
1072                          (cdr (assoc :result-params params)))))
1073     (append
1074      (mapcar (lambda (var) (cons :var var)) (car vars-and-names))
1075      (list
1076       (cons :colname-names (or (cdr (assoc :colname-names params))
1077                                (cadr  vars-and-names)))
1078       (cons :rowname-names (or (cdr (assoc :rowname-names params))
1079                                (caddr vars-and-names)))
1080       (cons :result-params result-params)
1081       (cons :result-type  (cond ((member "output" result-params) 'output)
1082                                 ((member "value" result-params) 'value)
1083                                 (t 'value))))
1084      (org-babel-get-header params :var 'other))))
1085
1086 ;; row and column names
1087 (defun org-babel-del-hlines (table)
1088   "Remove all 'hlines from TABLE."
1089   (remove 'hline table))
1090
1091 (defun org-babel-get-colnames (table)
1092   "Return the column names of TABLE.
1093 Return a cons cell, the `car' of which contains the TABLE less
1094 colnames, and the `cdr' of which contains a list of the column
1095 names."
1096   (if (equal 'hline (nth 1 table))
1097       (cons (cddr table) (car table))
1098     (cons (cdr table) (car table))))
1099
1100 (defun org-babel-get-rownames (table)
1101   "Return the row names of TABLE.
1102 Return a cons cell, the `car' of which contains the TABLE less
1103 colnames, and the `cdr' of which contains a list of the column
1104 names.  Note: this function removes any hlines in TABLE."
1105   (flet ((trans (table) (apply #'mapcar* #'list table)))
1106     (let* ((width (apply 'max
1107                          (mapcar (lambda (el) (if (listp el) (length el) 0)) table)))
1108            (table (trans (mapcar (lambda (row)
1109                                    (if (not (equal row 'hline))
1110                                        row
1111                                      (setq row '())
1112                                      (dotimes (n width)
1113                                        (setq row (cons 'hline row)))
1114                                      row))
1115                                  table))))
1116       (cons (mapcar (lambda (row) (if (equal (car row) 'hline) 'hline row))
1117                     (trans (cdr table)))
1118             (remove 'hline (car table))))))
1119
1120 (defun org-babel-put-colnames (table colnames)
1121   "Add COLNAMES to TABLE if they exist."
1122   (if colnames (apply 'list colnames 'hline table) table))
1123
1124 (defun org-babel-put-rownames (table rownames)
1125   "Add ROWNAMES to TABLE if they exist."
1126   (if rownames
1127       (mapcar (lambda (row)
1128                 (if (listp row)
1129                     (cons (or (pop rownames) "") row)
1130                   row)) table)
1131     table))
1132
1133 (defun org-babel-pick-name (names selector)
1134   "Select one out of an alist of row or column names.
1135 SELECTOR can be either a list of names in which case those names
1136 will be returned directly, or an index into the list NAMES in
1137 which case the indexed names will be return."
1138   (if (listp selector)
1139       selector
1140     (when names
1141       (if (and selector (symbolp selector) (not (equal t selector)))
1142           (cdr (assoc selector names))
1143         (if (integerp selector)
1144             (nth (- selector 1) names)
1145           (cdr (car (last names))))))))
1146
1147 (defun org-babel-disassemble-tables (vars hlines colnames rownames)
1148   "Parse tables for further processing.
1149 Process the variables in VARS according to the HLINES,
1150 ROWNAMES and COLNAMES header arguments.  Return a list consisting
1151 of the vars, cnames and rnames."
1152   (let (cnames rnames)
1153     (list
1154      (mapcar
1155       (lambda (var)
1156         (when (listp (cdr var))
1157           (when (and (not (equal colnames "no"))
1158                      (or colnames (and (equal (nth 1 (cdr var)) 'hline)
1159                                        (not (member 'hline (cddr (cdr var)))))))
1160             (let ((both (org-babel-get-colnames (cdr var))))
1161               (setq cnames (cons (cons (car var) (cdr both))
1162                                  cnames))
1163               (setq var (cons (car var) (car both)))))
1164           (when (and rownames (not (equal rownames "no")))
1165             (let ((both (org-babel-get-rownames (cdr var))))
1166               (setq rnames (cons (cons (car var) (cdr both))
1167                                  rnames))
1168               (setq var (cons (car var) (car both)))))
1169           (when (and hlines (not (equal hlines "yes")))
1170             (setq var (cons (car var) (org-babel-del-hlines (cdr var))))))
1171         var)
1172       vars)
1173      cnames rnames)))
1174
1175 (defun org-babel-reassemble-table (table colnames rownames)
1176   "Add column and row names to a table.
1177 Given a TABLE and set of COLNAMES and ROWNAMES add the names
1178 to the table for reinsertion to org-mode."
1179   (if (listp table)
1180       ((lambda (table)
1181          (if (and colnames (listp (car table)) (= (length (car table))
1182                                                   (length colnames)))
1183              (org-babel-put-colnames table colnames) table))
1184        (if (and rownames (= (length table) (length rownames)))
1185            (org-babel-put-rownames table rownames) table))
1186     table))
1187
1188 (defun org-babel-where-is-src-block-head ()
1189   "Find where the current source block begins.
1190 Return the point at the beginning of the current source
1191 block.  Specifically at the beginning of the #+BEGIN_SRC line.
1192 If the point is not on a source block then return nil."
1193   (let ((initial (point)) top bottom)
1194     (or
1195      (save-excursion ;; on a source name line or a #+header line
1196        (beginning-of-line 1)
1197        (and (or (looking-at org-babel-src-name-regexp)
1198                 (looking-at org-babel-multi-line-header-regexp))
1199             (progn
1200               (while (and (forward-line 1)
1201                           (looking-at org-babel-multi-line-header-regexp)))
1202               (looking-at org-babel-src-block-regexp))
1203             (point)))
1204      (save-excursion ;; on a #+begin_src line
1205        (beginning-of-line 1)
1206        (and (looking-at org-babel-src-block-regexp)
1207             (point)))
1208      (save-excursion ;; inside a src block
1209        (and
1210         (re-search-backward "^[ \t]*#\\+begin_src" nil t) (setq top (point))
1211         (re-search-forward "^[ \t]*#\\+end_src" nil t) (setq bottom (point))
1212         (< top initial) (< initial bottom)
1213         (progn (goto-char top) (beginning-of-line 1)
1214                (looking-at org-babel-src-block-regexp))
1215         (point))))))
1216
1217 ;;;###autoload
1218 (defun org-babel-goto-src-block-head ()
1219   "Go to the beginning of the current code block."
1220   (interactive)
1221   ((lambda (head)
1222      (if head (goto-char head) (error "not currently in a code block")))
1223    (org-babel-where-is-src-block-head)))
1224
1225 ;;;###autoload
1226 (defun org-babel-goto-named-src-block (name)
1227   "Go to a named source-code block."
1228   (interactive
1229    (let ((completion-ignore-case t))
1230      (list (org-icompleting-read "source-block name: "
1231                                  (org-babel-src-block-names) nil t))))
1232   (let ((point (org-babel-find-named-block name)))
1233     (if point
1234         ;; taken from `org-open-at-point'
1235         (progn (goto-char point) (org-show-context))
1236       (message "source-code block '%s' not found in this buffer" name))))
1237
1238 (defun org-babel-find-named-block (name)
1239   "Find a named source-code block.
1240 Return the location of the source block identified by source
1241 NAME, or nil if no such block exists. Set match data according to
1242 org-babel-named-src-block-regexp."
1243   (save-excursion
1244     (let ((case-fold-search t)
1245           (regexp (org-babel-named-src-block-regexp-for-name name)) msg)
1246       (goto-char (point-min))
1247       (when (or (re-search-forward regexp nil t)
1248                 (re-search-backward regexp nil t))
1249         (match-beginning 0)))))
1250
1251 (defun org-babel-src-block-names (&optional file)
1252   "Returns the names of source blocks in FILE or the current buffer."
1253   (save-excursion
1254     (when file (find-file file)) (goto-char (point-min))
1255     (let (names)
1256       (while (re-search-forward org-babel-src-name-w-name-regexp nil t)
1257         (setq names (cons (match-string 4) names)))
1258       names)))
1259
1260 ;;;###autoload
1261 (defun org-babel-goto-named-result (name)
1262   "Go to a named result."
1263   (interactive
1264    (let ((completion-ignore-case t))
1265      (list (org-icompleting-read "source-block name: "
1266                                  (org-babel-result-names) nil t))))
1267   (let ((point (org-babel-find-named-result name)))
1268     (if point
1269         ;; taken from `org-open-at-point'
1270         (progn (goto-char point) (org-show-context))
1271       (message "result '%s' not found in this buffer" name))))
1272
1273 (defun org-babel-find-named-result (name)
1274   "Find a named result.
1275 Return the location of the result named NAME in the current
1276 buffer or nil if no such result exists."
1277   (save-excursion
1278     (goto-char (point-min))
1279     (when (re-search-forward
1280            (concat org-babel-result-regexp
1281                    "[ \t]" (regexp-quote name) "[ \t\n\f\v\r]") nil t)
1282       (beginning-of-line 0) (point))))
1283
1284 (defun org-babel-result-names (&optional file)
1285   "Returns the names of results in FILE or the current buffer."
1286   (save-excursion
1287     (when file (find-file file)) (goto-char (point-min))
1288     (let (names)
1289       (while (re-search-forward org-babel-result-w-name-regexp nil t)
1290         (setq names (cons (match-string 4) names)))
1291       names)))
1292
1293 ;;;###autoload
1294 (defun org-babel-next-src-block (&optional arg)
1295   "Jump to the next source block.
1296 With optional prefix argument ARG, jump forward ARG many source blocks."
1297   (interactive "P")
1298   (when (looking-at org-babel-src-block-regexp) (forward-char 1))
1299   (condition-case nil
1300       (re-search-forward org-babel-src-block-regexp nil nil (or arg 1))
1301     (error (error "No further code blocks")))
1302   (goto-char (match-beginning 0)) (org-show-context))
1303
1304 ;;;###autoload
1305 (defun org-babel-previous-src-block (&optional arg)
1306   "Jump to the previous source block.
1307 With optional prefix argument ARG, jump backward ARG many source blocks."
1308   (interactive "P")
1309   (condition-case nil
1310       (re-search-backward org-babel-src-block-regexp nil nil (or arg 1))
1311     (error (error "No previous code blocks")))
1312   (goto-char (match-beginning 0)) (org-show-context))
1313
1314 (defvar org-babel-load-languages)
1315
1316 ;;;###autoload
1317 (defun org-babel-mark-block ()
1318   "Mark current src block"
1319   (interactive)
1320   ((lambda (head)
1321      (when head
1322        (save-excursion
1323          (goto-char head)
1324          (looking-at org-babel-src-block-regexp))
1325        (push-mark (match-end 5) nil t)
1326        (goto-char (match-beginning 5))))
1327    (org-babel-where-is-src-block-head)))
1328
1329 (defun org-babel-demarcate-block (&optional arg)
1330   "Wrap or split the code in the region or on the point.
1331 When called from inside of a code block the current block is
1332 split.  When called from outside of a code block a new code block
1333 is created.  In both cases if the region is demarcated and if the
1334 region is not active then the point is demarcated."
1335   (interactive "P")
1336   (let ((info (org-babel-get-src-block-info 'light))
1337         (stars (concat (make-string (or (org-current-level) 1) ?*) " ")))
1338     (if info
1339         (mapc
1340          (lambda (place)
1341            (save-excursion
1342              (goto-char place)
1343              (let ((lang (nth 0 info))
1344                    (indent (make-string (nth 5 info) ? )))
1345                (when (string-match "^[[:space:]]*$"
1346                                    (buffer-substring (point-at-bol)
1347                                                      (point-at-eol)))
1348                  (delete-region (point-at-bol) (point-at-eol)))
1349                (insert (concat (if (looking-at "^") "" "\n")
1350                                indent "#+end_src\n"
1351                                (if arg stars indent) "\n"
1352                                indent "#+begin_src " lang
1353                                (if (looking-at "[\n\r]") "" "\n")))))
1354            (move-end-of-line 2))
1355          (sort (if (region-active-p) (list (mark) (point)) (list (point))) #'>))
1356       (let ((start (point))
1357             (lang (org-icompleting-read "Lang: "
1358                                         (mapcar (lambda (el) (symbol-name (car el)))
1359                                                 org-babel-load-languages)))
1360             (body (delete-and-extract-region
1361                    (if (region-active-p) (mark) (point)) (point))))
1362         (insert (concat (if (looking-at "^") "" "\n")
1363                         (if arg (concat stars "\n") "")
1364                         "#+begin_src " lang "\n"
1365                         body
1366                         (if (or (= (length body) 0)
1367                                 (string-match "[\r\n]$" body)) "" "\n")
1368                         "#+end_src\n"))
1369         (goto-char start) (move-end-of-line 1)))))
1370
1371 (defvar org-babel-lob-one-liner-regexp)
1372 (defvar org-babel-inline-lob-one-liner-regexp)
1373 (defun org-babel-where-is-src-block-result (&optional insert info hash indent)
1374   "Find where the current source block results begin.
1375 Return the point at the beginning of the result of the current
1376 source block.  Specifically at the beginning of the results line.
1377 If no result exists for this block then create a results line
1378 following the source block."
1379   (save-excursion
1380     (let* ((on-lob-line (save-excursion
1381                           (beginning-of-line 1)
1382                           (looking-at org-babel-lob-one-liner-regexp)))
1383            (inlinep (save-excursion
1384                       (re-search-backward "[ \f\t\n\r\v]" nil t)
1385                       (when (looking-at org-babel-inline-src-block-regexp)
1386                         (match-end 0))))
1387            (name (if on-lob-line
1388                      (nth 0 (org-babel-lob-get-info))
1389                    (nth 4 (or info (org-babel-get-src-block-info 'light)))))
1390            (head (unless on-lob-line (org-babel-where-is-src-block-head)))
1391            found beg end)
1392       (when head (goto-char head))
1393       (setq
1394        found ;; was there a result (before we potentially insert one)
1395        (or
1396         inlinep
1397         (and
1398          ;; named results:
1399          ;; - return t if it is found, else return nil
1400          ;; - if it does not need to be rebuilt, then don't set end
1401          ;; - if it does need to be rebuilt then do set end
1402          name (setq beg (org-babel-find-named-result name))
1403          (prog1 beg
1404            (when (and hash (not (string= hash (match-string 3))))
1405              (goto-char beg) (setq end beg) ;; beginning of result
1406              (forward-line 1)
1407              (delete-region end (org-babel-result-end)) nil)))
1408         (and
1409          ;; unnamed results:
1410          ;; - return t if it is found, else return nil
1411          ;; - if it is found, and the hash doesn't match, delete and set end
1412          (or on-lob-line (re-search-forward "^[ \t]*#\\+end_src" nil t))
1413          (progn (end-of-line 1)
1414                 (if (eobp) (insert "\n") (forward-char 1))
1415                 (setq end (point))
1416                 (or (and (not name)
1417                          (progn ;; unnamed results line already exists
1418                            (re-search-forward "[^ \f\t\n\r\v]" nil t)
1419                            (beginning-of-line 1)
1420                            (looking-at
1421                             (concat org-babel-result-regexp "\n")))
1422                          (prog1 (point)
1423                            ;; must remove and rebuild if hash!=old-hash
1424                            (if (and hash (not (string= hash (match-string 3))))
1425                                (prog1 nil
1426                                  (forward-line 1)
1427                                  (delete-region
1428                                   end (org-babel-result-end)))
1429                              (setq end nil)))))))))
1430       (if (and insert end)
1431           (progn
1432             (goto-char end)
1433             (unless beg
1434               (if (looking-at "[\n\r]") (forward-char 1) (insert "\n")))
1435             (insert (concat
1436                      (if indent
1437                          (mapconcat
1438                           (lambda (el) " ")
1439                           (org-number-sequence 1 indent) "")
1440                        "")
1441                      "#+results"
1442                      (when hash (concat "["hash"]"))
1443                      ":"
1444                      (when name (concat " " name)) "\n"))
1445             (unless beg (insert "\n") (backward-char))
1446             (beginning-of-line 0)
1447             (if hash (org-babel-hide-hash))
1448             (point))
1449         found))))
1450
1451 (defvar org-block-regexp)
1452 (defun org-babel-read-result ()
1453   "Read the result at `point' into emacs-lisp."
1454   (let ((case-fold-search t) result-string)
1455     (cond
1456      ((org-at-table-p) (org-babel-read-table))
1457      ((org-at-item-p) (org-babel-read-list))
1458      ((looking-at org-bracket-link-regexp) (org-babel-read-link))
1459      ((looking-at org-block-regexp) (org-babel-trim (match-string 4)))
1460      ((looking-at "^[ \t]*: ")
1461       (setq result-string
1462             (org-babel-trim
1463              (mapconcat (lambda (line)
1464                           (if (and (> (length line) 1)
1465                                    (string-match "^[ \t]*: \\(.+\\)" line))
1466                               (match-string 1 line)
1467                             line))
1468                         (split-string
1469                          (buffer-substring
1470                           (point) (org-babel-result-end)) "[\r\n]+")
1471                         "\n")))
1472       (or (org-babel-number-p result-string) result-string))
1473      ((looking-at org-babel-result-regexp)
1474       (save-excursion (forward-line 1) (org-babel-read-result))))))
1475
1476 (defun org-babel-read-table ()
1477   "Read the table at `point' into emacs-lisp."
1478   (mapcar (lambda (row)
1479             (if (and (symbolp row) (equal row 'hline)) row
1480               (mapcar (lambda (el) (org-babel-read el 'inhibit-lisp-eval)) row)))
1481           (org-table-to-lisp)))
1482
1483 (defun org-babel-read-list ()
1484   "Read the list at `point' into emacs-lisp."
1485   (mapcar (lambda (el) (org-babel-read el 'inhibit-lisp-eval))
1486           (mapcar #'cadr (cdr (org-list-parse-list)))))
1487
1488 (defvar org-link-types-re)
1489 (defun org-babel-read-link ()
1490   "Read the link at `point' into emacs-lisp.
1491 If the path of the link is a file path it is expanded using
1492 `expand-file-name'."
1493   (let* ((case-fold-search t)
1494          (raw (and (looking-at org-bracket-link-regexp)
1495                    (org-babel-clean-text-properties (match-string 1))))
1496          (type (and (string-match org-link-types-re raw)
1497                     (match-string 1 raw))))
1498     (cond
1499      ((not type) (expand-file-name raw))
1500      ((string= type "file")
1501       (and (string-match "file\\(.*\\):\\(.+\\)" raw)
1502            (expand-file-name (match-string 2 raw))))
1503      (t raw))))
1504
1505 (defun org-babel-format-result (result &optional sep)
1506   "Format RESULT for writing to file."
1507   (flet ((echo-res (result)
1508                    (if (stringp result) result (format "%S" result))))
1509     (if (listp result)
1510         ;; table result
1511         (orgtbl-to-generic
1512          result
1513          (list
1514           :sep (or sep "\t")
1515           :fmt 'echo-res))
1516       ;; scalar result
1517       (echo-res result))))
1518
1519 (defun org-babel-insert-result
1520   (result &optional result-params info hash indent lang)
1521   "Insert RESULT into the current buffer.
1522 By default RESULT is inserted after the end of the
1523 current source block.  With optional argument RESULT-PARAMS
1524 controls insertion of results in the org-mode file.
1525 RESULT-PARAMS can take the following values...
1526
1527 replace - (default option) insert results after the source block
1528           replacing any previously inserted results
1529
1530 silent -- no results are inserted
1531
1532 file ---- the results are interpreted as a file path, and are
1533           inserted into the buffer using the Org-mode file syntax
1534
1535 list ---- the results are interpreted as an Org-mode list.
1536
1537 raw ----- results are added directly to the Org-mode file.  This
1538           is a good option if you code block will output org-mode
1539           formatted text.
1540
1541 org ----- similar in effect to raw, only the results are wrapped
1542           in an org code block.  Similar to the raw option, on
1543           export the results will be interpreted as org-formatted
1544           text, however by wrapping the results in an org code
1545           block they can be replaced upon re-execution of the
1546           code block.
1547
1548 html ---- results are added inside of a #+BEGIN_HTML block.  This
1549           is a good option if you code block will output html
1550           formatted text.
1551
1552 latex --- results are added inside of a #+BEGIN_LATEX block.
1553           This is a good option if you code block will output
1554           latex formatted text.
1555
1556 code ---- the results are extracted in the syntax of the source
1557           code of the language being evaluated and are added
1558           inside of a #+BEGIN_SRC block with the source-code
1559           language set appropriately.  Note this relies on the
1560           optional LANG argument."
1561   (if (stringp result)
1562       (progn
1563         (setq result (org-babel-clean-text-properties result))
1564         (when (member "file" result-params)
1565           (setq result (org-babel-result-to-file result))))
1566     (unless (listp result) (setq result (format "%S" result))))
1567   (if (and result-params (member "silent" result-params))
1568       (progn
1569         (message (replace-regexp-in-string "%" "%%" (format "%S" result)))
1570         result)
1571     (save-excursion
1572       (let* ((inlinep
1573               (save-excursion
1574                 (unless (= (point) (point-at-bol)) ;; move before inline block
1575                   (re-search-backward "[ \f\t\n\r\v]" nil t))
1576                 (when (or (looking-at org-babel-inline-src-block-regexp)
1577                           (looking-at org-babel-inline-lob-one-liner-regexp))
1578                   (goto-char (match-end 0))
1579                   (insert (if (listp result) "\n" " "))
1580                   (point))))
1581              (existing-result (unless inlinep
1582                                 (org-babel-where-is-src-block-result
1583                                  t info hash indent)))
1584              (results-switches
1585               (cdr (assoc :results_switches (nth 2 info))))
1586              beg end)
1587         (when (and (stringp result)  ; ensure results end in a newline
1588                    (not inlinep)
1589                    (> (length result) 0)
1590                    (not (or (string-equal (substring result -1) "\n")
1591                             (string-equal (substring result -1) "\r"))))
1592           (setq result (concat result "\n")))
1593         (if (not existing-result)
1594             (setq beg (or inlinep (point)))
1595           (goto-char existing-result)
1596           (save-excursion
1597             (re-search-forward "#" nil t)
1598             (setq indent (- (current-column) 1)))
1599           (forward-line 1)
1600           (setq beg (point))
1601           (cond
1602            ((member "replace" result-params)
1603             (delete-region (point) (org-babel-result-end)))
1604            ((member "append" result-params)
1605             (goto-char (org-babel-result-end)) (setq beg (point-marker)))
1606            ((member "prepend" result-params)))) ; already there
1607         (setq results-switches
1608               (if results-switches (concat " " results-switches) ""))
1609         ;; insert results based on type
1610         (cond
1611          ;; do nothing for an empty result
1612          ((= (length result) 0))
1613          ;; insert a list if preferred
1614          ((member "list" result-params)
1615           (insert
1616            (org-babel-trim
1617             (org-list-to-generic
1618              (cons 'unordered
1619                    (mapcar
1620                     (lambda (el) (list nil (if (stringp el) el (format "%S" el))))
1621                     (if (listp result) result (list result))))
1622              '(:splicep nil :istart "- " :iend "\n")))
1623            "\n"))
1624          ;; assume the result is a table if it's not a string
1625          ((not (stringp result))
1626           (goto-char beg)
1627           (insert (concat (orgtbl-to-orgtbl
1628                            (if (or (eq 'hline (car result))
1629                                    (and (listp (car result))
1630                                         (listp (cdr (car result)))))
1631                                result (list result))
1632                            '(:fmt (lambda (cell) (format "%s" cell)))) "\n"))
1633           (goto-char beg) (when (org-at-table-p) (org-table-align)))
1634          ((member "file" result-params)
1635           (insert result))
1636          (t (goto-char beg) (insert result)))
1637         (when (listp result) (goto-char (org-table-end)))
1638         (setq end (point-marker))
1639         ;; possibly wrap result
1640         (flet ((wrap (start finish)
1641                      (goto-char beg) (insert (concat start "\n"))
1642                      (goto-char end) (insert (concat finish "\n"))
1643                      (setq end (point-marker))))
1644           (cond
1645            ((member "html" result-params)
1646             (wrap "#+BEGIN_HTML" "#+END_HTML"))
1647            ((member "latex" result-params)
1648             (wrap "#+BEGIN_LaTeX" "#+END_LaTeX"))
1649            ((member "code" result-params)
1650             (wrap (format "#+BEGIN_SRC %s%s" (or lang "none") results-switches)
1651                   "#+END_SRC"))
1652            ((member "org" result-params)
1653             (wrap "#+BEGIN_ORG" "#+END_ORG"))
1654            ((member "raw" result-params)
1655             (goto-char beg) (if (org-at-table-p) (org-cycle)))
1656            ((member "wrap" result-params)
1657             (when (and (stringp result) (not (member "file" result-params)))
1658               (org-babel-examplize-region beg end results-switches))
1659             (wrap "#+BEGIN_RESULT" "#+END_RESULT"))
1660            ((and (stringp result) (not (member "file" result-params)))
1661             (org-babel-examplize-region beg end results-switches)
1662             (setq end (point)))))
1663         ;; possibly indent the results to match the #+results line
1664         (when (and (not inlinep) (numberp indent) indent (> indent 0)
1665                    ;; in this case `table-align' does the work for us
1666                    (not (and (listp result)
1667                              (member "append" result-params))))
1668           (indent-rigidly beg end indent))))
1669     (if (= (length result) 0)
1670         (if (member "value" result-params)
1671             (message "Code block returned no value.")
1672           (message "Code block produced no output."))
1673       (message "Code block evaluation complete."))))
1674
1675 (defun org-babel-remove-result (&optional info)
1676   "Remove the result of the current source block."
1677   (interactive)
1678   (let ((location (org-babel-where-is-src-block-result nil info)) start)
1679     (when location
1680       (setq start (- location 1))
1681       (save-excursion
1682         (goto-char location) (forward-line 1)
1683         (delete-region start (org-babel-result-end))))))
1684
1685 (defun org-babel-result-end ()
1686   "Return the point at the end of the current set of results"
1687   (save-excursion
1688     (cond
1689      ((org-at-table-p) (progn (goto-char (org-table-end)) (point)))
1690      ((org-at-item-p) (let* ((struct (org-list-struct))
1691                              (prvs (org-list-prevs-alist struct)))
1692                         (org-list-get-list-end (point-at-bol) struct prvs)))
1693      (t
1694       (let ((case-fold-search t)
1695             (blocks-re (regexp-opt
1696                         (list "latex" "html" "example" "src" "result" "org"))))
1697         (if (looking-at (concat "[ \t]*#\\+begin_" blocks-re))
1698             (progn (re-search-forward (concat "[ \t]*#\\+end_" blocks-re) nil t)
1699                    (forward-char 1))
1700           (while (looking-at "[ \t]*\\(: \\|\\[\\[\\)")
1701             (forward-line 1))))
1702       (point)))))
1703
1704 (defun org-babel-result-to-file (result)
1705   "Convert RESULT into an `org-mode' link.
1706 If the `default-directory' is different from the containing
1707 file's directory then expand relative links."
1708   (flet ((cond-exp (file)
1709           (if (and default-directory
1710                    buffer-file-name
1711                    (not (string= (expand-file-name default-directory)
1712                                  (expand-file-name
1713                                   (file-name-directory buffer-file-name)))))
1714               (expand-file-name file default-directory)
1715             file)))
1716     (if (stringp result)
1717         (format "[[file:%s]]" (cond-exp result))
1718       (when (and (listp result) (= 2 (length result))
1719                  (stringp (car result)) (stringp (cadr result)))
1720         (format "[[file:%s][%s]]" (car result) (cadr result))))))
1721
1722 (defun org-babel-examplize-region (beg end &optional results-switches)
1723   "Comment out region using the inline '==' or ': ' org example quote."
1724   (interactive "*r")
1725   (flet ((chars-between (b e) (string-match "[\\S]" (buffer-substring b e))))
1726     (if (or (chars-between (save-excursion (goto-char beg) (point-at-bol)) beg)
1727             (chars-between end (save-excursion (goto-char end) (point-at-eol))))
1728         (save-excursion
1729           (goto-char beg)
1730           (insert (format "=%s=" (prog1 (buffer-substring beg end)
1731                                    (delete-region beg end)))))
1732       (let ((size (count-lines beg end)))
1733         (save-excursion
1734           (cond ((= size 0))          ; do nothing for an empty result
1735                 ((< size org-babel-min-lines-for-block-output)
1736                  (goto-char beg)
1737                  (dotimes (n size)
1738                    (beginning-of-line 1) (insert ": ") (forward-line 1)))
1739                 (t
1740                  (goto-char beg)
1741                  (insert (if results-switches
1742                              (format "#+begin_example%s\n" results-switches)
1743                            "#+begin_example\n"))
1744                  (if (markerp end) (goto-char end) (forward-char (- end beg)))
1745                  (insert "#+end_example\n"))))))))
1746
1747 (defun org-babel-update-block-body (new-body)
1748   "Update the body of the current code block to NEW-BODY."
1749   (if (not (org-babel-where-is-src-block-head))
1750       (error "not in source block")
1751     (save-match-data
1752       (replace-match (concat (org-babel-trim new-body) "\n") nil t nil 5))
1753     (indent-rigidly (match-beginning 5) (match-end 5) 2)))
1754
1755 (defun org-babel-merge-params (&rest plists)
1756   "Combine all parameter association lists in PLISTS.
1757 Later elements of PLISTS override the values of previous elements.
1758 This takes into account some special considerations for certain
1759 parameters when merging lists."
1760   (let ((results-exclusive-groups
1761          '(("file" "list" "vector" "table" "scalar" "verbatim" "raw" "org"
1762             "html" "latex" "code" "pp" "wrap")
1763            ("replace" "silent" "append" "prepend")
1764            ("output" "value")))
1765         (exports-exclusive-groups
1766          '(("code" "results" "both" "none")))
1767         (variable-index 0)
1768         params results exports tangle noweb cache vars shebang comments padline)
1769     (flet ((e-merge (exclusive-groups &rest result-params)
1770              ;; maintain exclusivity of mutually exclusive parameters
1771              (let (output)
1772                (mapc (lambda (new-params)
1773                        (mapc (lambda (new-param)
1774                                (mapc (lambda (exclusive-group)
1775                                        (when (member new-param exclusive-group)
1776                                          (mapcar (lambda (excluded-param)
1777                                                    (setq output
1778                                                          (delete
1779                                                           excluded-param
1780                                                           output)))
1781                                                  exclusive-group)))
1782                                      exclusive-groups)
1783                                (setq output (org-uniquify
1784                                              (cons new-param output))))
1785                              new-params))
1786                      result-params)
1787                output)))
1788       (mapc
1789        (lambda (plist)
1790          (mapc
1791           (lambda (pair)
1792             (case (car pair)
1793               (:var
1794                (let ((name (if (listp (cdr pair))
1795                                (cadr pair)
1796                              (and (string-match "^\\([^= \f\t\n\r\v]+\\)[ \t]*="
1797                                                 (cdr pair))
1798                                   (intern (match-string 1 (cdr pair)))))))
1799                  (if name
1800                      (setq vars
1801                            (append
1802                             (if (member name (mapcar #'car vars))
1803                                 (delq nil
1804                                       (mapcar
1805                                        (lambda (p)
1806                                          (unless (equal (car p) name) p))
1807                                        vars))
1808                               vars)
1809                             (list (cons name pair))))
1810                    ;; if no name is given, then assign to variables in order
1811                    (prog1 (setf (cddr (nth variable-index vars))
1812                                 (concat (symbol-name
1813                                          (car (nth variable-index vars)))
1814                                         "=" (cdr pair)))
1815                      (incf variable-index)))))
1816               (:results
1817                (setq results (e-merge results-exclusive-groups
1818                                       results
1819                                       (split-string
1820                                        (let ((r (cdr pair)))
1821                                          (if (stringp r) r (eval r)))))))
1822               (:file
1823                (when (cdr pair)
1824                  (setq results (e-merge results-exclusive-groups
1825                                         results '("file")))
1826                  (unless (or (member "both" exports)
1827                              (member "none" exports)
1828                              (member "code" exports))
1829                    (setq exports (e-merge exports-exclusive-groups
1830                                           exports '("results"))))
1831                  (setq params (cons pair (assq-delete-all (car pair) params)))))
1832               (:exports
1833                (setq exports (e-merge exports-exclusive-groups
1834                                       exports (split-string (cdr pair)))))
1835               (:tangle ;; take the latest -- always overwrite
1836                (setq tangle (or (list (cdr pair)) tangle)))
1837               (:noweb
1838                (setq noweb (e-merge '(("yes" "no" "tangle")) noweb
1839                                     (split-string (or (cdr pair) "")))))
1840               (:cache
1841                (setq cache (e-merge '(("yes" "no")) cache
1842                                     (split-string (or (cdr pair) "")))))
1843               (:padline
1844                (setq padline (e-merge '(("yes" "no")) padline
1845                                       (split-string (or (cdr pair) "")))))
1846               (:shebang ;; take the latest -- always overwrite
1847                (setq shebang (or (list (cdr pair)) shebang)))
1848               (:comments
1849                (setq comments (e-merge '(("yes" "no")) comments
1850                                        (split-string (or (cdr pair) "")))))
1851               (t ;; replace: this covers e.g. :session
1852                (setq params (cons pair (assq-delete-all (car pair) params))))))
1853           plist))
1854        plists))
1855     (setq vars (reverse vars))
1856     (while vars (setq params (cons (cons :var (cddr (pop vars))) params)))
1857     (mapc
1858      (lambda (hd)
1859        (let ((key (intern (concat ":" (symbol-name hd))))
1860              (val (eval hd)))
1861          (setf params (cons (cons key (mapconcat 'identity val " ")) params))))
1862      '(results exports tangle noweb padline cache shebang comments))
1863     params))
1864
1865 (defun org-babel-expand-noweb-references (&optional info parent-buffer)
1866   "Expand Noweb references in the body of the current source code block.
1867
1868 For example the following reference would be replaced with the
1869 body of the source-code block named 'example-block'.
1870
1871 <<example-block>>
1872
1873 Note that any text preceding the <<foo>> construct on a line will
1874 be interposed between the lines of the replacement text.  So for
1875 example if <<foo>> is placed behind a comment, then the entire
1876 replacement text will also be commented.
1877
1878 This function must be called from inside of the buffer containing
1879 the source-code block which holds BODY.
1880
1881 In addition the following syntax can be used to insert the
1882 results of evaluating the source-code block named 'example-block'.
1883
1884 <<example-block()>>
1885
1886 Any optional arguments can be passed to example-block by placing
1887 the arguments inside the parenthesis following the convention
1888 defined by `org-babel-lob'.  For example
1889
1890 <<example-block(a=9)>>
1891
1892 would set the value of argument \"a\" equal to \"9\".  Note that
1893 these arguments are not evaluated in the current source-code
1894 block but are passed literally to the \"example-block\"."
1895   (let* ((parent-buffer (or parent-buffer (current-buffer)))
1896          (info (or info (org-babel-get-src-block-info)))
1897          (lang (nth 0 info))
1898          (body (nth 1 info))
1899          (comment (string= "noweb" (cdr (assoc :comments (nth 2 info)))))
1900          (new-body "") index source-name evaluate prefix blocks-in-buffer)
1901     (flet ((nb-add (text) (setq new-body (concat new-body text)))
1902            (c-wrap (text)
1903                    (with-temp-buffer
1904                      (funcall (intern (concat lang "-mode")))
1905                      (comment-region (point) (progn (insert text) (point)))
1906                      (org-babel-trim (buffer-string))))
1907            (blocks () ;; return the info lists of all blocks in this buffer
1908                    (let (infos)
1909                      (save-restriction
1910                        (widen)
1911                        (org-babel-map-src-blocks nil
1912                          (setq infos (cons (org-babel-get-src-block-info 'light)
1913                                            infos))))
1914                      (reverse infos))))
1915       (with-temp-buffer
1916         (insert body) (goto-char (point-min))
1917         (setq index (point))
1918         (while (and (re-search-forward "<<\\(.+?\\)>>" nil t))
1919           (save-match-data (setf source-name (match-string 1)))
1920           (save-match-data (setq evaluate (string-match "\(.*\)" source-name)))
1921           (save-match-data
1922             (setq prefix
1923                   (buffer-substring (match-beginning 0)
1924                                     (save-excursion
1925                                       (beginning-of-line 1) (point)))))
1926           ;; add interval to new-body (removing noweb reference)
1927           (goto-char (match-beginning 0))
1928           (nb-add (buffer-substring index (point)))
1929           (goto-char (match-end 0))
1930           (setq index (point))
1931           (nb-add
1932            (with-current-buffer parent-buffer
1933              (mapconcat ;; interpose PREFIX between every line
1934               #'identity
1935               (split-string
1936                (if evaluate
1937                    (let ((raw (org-babel-ref-resolve source-name)))
1938                      (if (stringp raw) raw (format "%S" raw)))
1939                  (or
1940                   ;; retrieve from the library of babel
1941                   (nth 2 (assoc (intern source-name)
1942                                 org-babel-library-of-babel))
1943                   ;; return the contents of headlines literally
1944                   (save-excursion
1945                     (when (org-babel-ref-goto-headline-id source-name)
1946                       (org-babel-ref-headline-body)))
1947                   ;; find the expansion of reference in this buffer
1948                   (mapconcat
1949                    (lambda (i)
1950                      (when (string= source-name
1951                                     (or (cdr (assoc :noweb-ref (nth 2 i)))
1952                                         (nth 4 i)))
1953                        (let ((body (org-babel-expand-noweb-references i)))
1954                          (if comment
1955                              ((lambda (cs)
1956                                 (concat (c-wrap (car cs)) "\n"
1957                                         body "\n" (c-wrap (cadr cs))))
1958                               (org-babel-tangle-comment-links i))
1959                            body))))
1960                    (or blocks-in-buffer
1961                        (setq blocks-in-buffer (blocks)))
1962                    "")
1963                   ;; possibly raise an error if named block doesn't exist
1964                   (if (member lang org-babel-noweb-error-langs)
1965                       (error "%s" (concat
1966                                    "<<" source-name ">> "
1967                                    "could not be resolved (see "
1968                                    "`org-babel-noweb-error-langs')"))
1969                     "")))
1970                "[\n\r]") (concat "\n" prefix)))))
1971         (nb-add (buffer-substring index (point-max)))))
1972     new-body))
1973
1974 (defun org-babel-clean-text-properties (text)
1975   "Strip all properties from text return."
1976   (when text
1977     (set-text-properties 0 (length text) nil text) text))
1978
1979 (defun org-babel-strip-protective-commas (body)
1980   "Strip protective commas from bodies of source blocks."
1981   (when body
1982     (replace-regexp-in-string "^,#" "#" body)))
1983
1984 (defun org-babel-script-escape (str &optional force)
1985   "Safely convert tables into elisp lists."
1986   (let (in-single in-double out)
1987     ((lambda (escaped) (condition-case nil (org-babel-read escaped) (error escaped)))
1988      (if (or force
1989              (and (stringp str)
1990                   (> (length str) 2)
1991                   (or (and (string-equal "[" (substring str 0 1))
1992                            (string-equal "]" (substring str -1)))
1993                       (and (string-equal "{" (substring str 0 1))
1994                            (string-equal "}" (substring str -1)))
1995                       (and (string-equal "(" (substring str 0 1))
1996                            (string-equal ")" (substring str -1))))))
1997          (org-babel-read
1998           (concat
1999            "'"
2000            (progn
2001              (mapc
2002               (lambda (ch)
2003                 (setq
2004                  out
2005                  (case ch
2006                    (91 (if (or in-double in-single) ; [
2007                            (cons 91 out)
2008                          (cons 40 out)))
2009                    (93 (if (or in-double in-single) ; ]
2010                            (cons 93 out)
2011                          (cons 41 out)))
2012                    (123 (if (or in-double in-single) ; {
2013                             (cons 123 out)
2014                           (cons 40 out)))
2015                    (125 (if (or in-double in-single) ; }
2016                             (cons 125 out)
2017                           (cons 41 out)))
2018                    (44 (if (or in-double in-single) ; ,
2019                            (cons 44 out) (cons 32 out)))
2020                    (39 (if in-double    ; '
2021                            (cons 39 out)
2022                          (setq in-single (not in-single)) (cons 34 out)))
2023                    (34 (if in-single    ; "
2024                            (append (list 34 32) out)
2025                          (setq in-double (not in-double)) (cons 34 out)))
2026                    (t  (cons ch out)))))
2027               (string-to-list str))
2028              (apply #'string (reverse out)))))
2029        str))))
2030
2031 (defun org-babel-read (cell &optional inhibit-lisp-eval)
2032   "Convert the string value of CELL to a number if appropriate.
2033 Otherwise if cell looks like lisp (meaning it starts with a
2034 \"(\", \"'\", \"`\" or a \"[\") then read it as lisp, otherwise
2035 return it unmodified as a string.  Optional argument NO-LISP-EVAL
2036 inhibits lisp evaluation for situations in which is it not
2037 appropriate."
2038   (if (and (stringp cell) (not (equal cell "")))
2039       (or (org-babel-number-p cell)
2040           (if (and (not inhibit-lisp-eval)
2041                    (member (substring cell 0 1) '("(" "'" "`" "[")))
2042               (eval (read cell))
2043             (if (string= (substring cell 0 1) "\"")
2044                 (read cell)
2045               (progn (set-text-properties 0 (length cell) nil cell) cell))))
2046     cell))
2047
2048 (defun org-babel-number-p (string)
2049   "If STRING represents a number return it's value."
2050   (if (and (string-match "^-?[0-9]*\\.?[0-9]*$" string)
2051            (= (length (substring string (match-beginning 0)
2052                                  (match-end 0)))
2053               (length string)))
2054       (string-to-number string)))
2055
2056 (defun org-babel-import-elisp-from-file (file-name &optional separator)
2057   "Read the results located at FILE-NAME into an elisp table.
2058 If the table is trivial, then return it as a scalar."
2059   (let (result)
2060     (save-window-excursion
2061       (with-temp-buffer
2062         (condition-case nil
2063             (progn
2064               (org-table-import file-name separator)
2065               (delete-file file-name)
2066               (setq result (mapcar (lambda (row)
2067                                      (mapcar #'org-babel-string-read row))
2068                                    (org-table-to-lisp))))
2069           (error nil)))
2070       (if (null (cdr result)) ;; if result is trivial vector, then scalarize it
2071           (if (consp (car result))
2072               (if (null (cdr (car result)))
2073                   (caar result)
2074                 result)
2075             (car result))
2076         result))))
2077
2078 (defun org-babel-string-read (cell)
2079   "Strip nested \"s from around strings."
2080   (org-babel-read (or (and (stringp cell)
2081                            (string-match "\\\"\\(.+\\)\\\"" cell)
2082                            (match-string 1 cell))
2083                       cell)))
2084
2085 (defun org-babel-reverse-string (string)
2086   "Return the reverse of STRING."
2087   (apply 'string (reverse (string-to-list string))))
2088
2089 (defun org-babel-chomp (string &optional regexp)
2090   "Strip trailing spaces and carriage returns from STRING.
2091 Default regexp used is \"[ \f\t\n\r\v]\" but can be
2092 overwritten by specifying a regexp as a second argument."
2093   (let ((regexp (or regexp "[ \f\t\n\r\v]")))
2094     (while (and (> (length string) 0)
2095                 (string-match regexp (substring string -1)))
2096       (setq string (substring string 0 -1)))
2097     string))
2098
2099 (defun org-babel-trim (string &optional regexp)
2100   "Strip leading and trailing spaces and carriage returns from STRING.
2101 Like `org-babel-chomp' only it runs on both the front and back
2102 of the string."
2103   (org-babel-chomp (org-babel-reverse-string
2104                     (org-babel-chomp (org-babel-reverse-string string) regexp))
2105                    regexp))
2106
2107 (defvar org-babel-org-babel-call-process-region-original nil)
2108 (defun org-babel-tramp-handle-call-process-region
2109   (start end program &optional delete buffer display &rest args)
2110   "Use tramp to handle call-process-region.
2111 Fixes a bug in `tramp-handle-call-process-region'."
2112   (if (and (featurep 'tramp) (file-remote-p default-directory))
2113       (let ((tmpfile (tramp-compat-make-temp-file "")))
2114         (write-region start end tmpfile)
2115         (when delete (delete-region start end))
2116         (unwind-protect
2117             ;;  (apply 'call-process program tmpfile buffer display args)
2118             ;; bug in tramp
2119             (apply 'process-file program tmpfile buffer display args)
2120           (delete-file tmpfile)))
2121     ;; org-babel-call-process-region-original is the original emacs
2122     ;; definition. It is in scope from the let binding in
2123     ;; org-babel-execute-src-block
2124     (apply org-babel-call-process-region-original
2125            start end program delete buffer display args)))
2126
2127 (defun org-babel-local-file-name (file)
2128   "Return the local name component of FILE."
2129   (if (file-remote-p file)
2130       (let (localname)
2131         (with-parsed-tramp-file-name file nil
2132           localname))
2133     file))
2134
2135 (defun org-babel-process-file-name (name &optional no-quote-p)
2136   "Prepare NAME to be used in an external process.
2137 If NAME specifies a remote location, the remote portion of the
2138 name is removed, since in that case the process will be executing
2139 remotely. The file name is then processed by
2140 `expand-file-name'. Unless second argument NO-QUOTE-P is non-nil,
2141 the file name is additionally processed by
2142 `shell-quote-argument'"
2143   ((lambda (f) (if no-quote-p f (shell-quote-argument f)))
2144    (expand-file-name (org-babel-local-file-name name))))
2145
2146 (defvar org-babel-temporary-directory)
2147 (unless (or noninteractive (boundp 'org-babel-temporary-directory))
2148   (defvar org-babel-temporary-directory
2149     (or (and (boundp 'org-babel-temporary-directory)
2150              (file-exists-p org-babel-temporary-directory)
2151              org-babel-temporary-directory)
2152         (make-temp-file "babel-" t))
2153     "Directory to hold temporary files created to execute code blocks.
2154 Used by `org-babel-temp-file'.  This directory will be removed on
2155 Emacs shutdown."))
2156
2157 (defun org-babel-temp-file (prefix &optional suffix)
2158   "Create a temporary file in the `org-babel-temporary-directory'.
2159 Passes PREFIX and SUFFIX directly to `make-temp-file' with the
2160 value of `temporary-file-directory' temporarily set to the value
2161 of `org-babel-temporary-directory'."
2162   (if (file-remote-p default-directory)
2163       (make-temp-file
2164        (concat (file-remote-p default-directory)
2165                (expand-file-name
2166                 prefix temporary-file-directory)
2167                nil suffix))
2168     (let ((temporary-file-directory
2169            (or (and (boundp 'org-babel-temporary-directory)
2170                     (file-exists-p org-babel-temporary-directory)
2171                     org-babel-temporary-directory)
2172                temporary-file-directory)))
2173       (make-temp-file prefix nil suffix))))
2174
2175 (defun org-babel-remove-temporary-directory ()
2176   "Remove `org-babel-temporary-directory' on Emacs shutdown."
2177   (when (and (boundp 'org-babel-temporary-directory)
2178              (file-exists-p org-babel-temporary-directory))
2179     ;; taken from `delete-directory' in files.el
2180     (condition-case nil
2181         (progn
2182           (mapc (lambda (file)
2183                   ;; This test is equivalent to
2184                   ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2185                   ;; but more efficient
2186                   (if (eq t (car (file-attributes file)))
2187                       (delete-directory file)
2188                     (delete-file file)))
2189                 ;; We do not want to delete "." and "..".
2190                 (directory-files org-babel-temporary-directory 'full
2191                                  "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"))
2192           (delete-directory org-babel-temporary-directory))
2193       (error
2194        (message "Failed to remove temporary Org-babel directory %s"
2195                 (if (boundp 'org-babel-temporary-directory)
2196                     org-babel-temporary-directory
2197                   "[directory not defined]"))))))
2198
2199 (add-hook 'kill-emacs-hook 'org-babel-remove-temporary-directory)
2200
2201 (provide 'ob)
2202
2203
2204
2205 ;;; ob.el ends here