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