1 ;;; ob-core.el --- working with code blocks in org-mode
3 ;; Copyright (C) 2009-2014 Free Software Foundation, Inc.
5 ;; Authors: Eric Schulte
7 ;; Keywords: literate programming, reproducible research
8 ;; Homepage: http://orgmode.org
10 ;; This file is part of GNU Emacs.
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.
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.
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/>.
32 (defconst org-babel-exeext
33 (if (memq system-type
'(windows-nt cygwin
))
36 ;; dynamically scoped for tramp
37 (defvar org-babel-call-process-region-original nil
)
38 (defvar org-src-lang-modes
)
39 (defvar org-babel-library-of-babel
)
40 (declare-function show-all
"outline" ())
41 (declare-function org-every
"org" (pred seq
))
42 (declare-function org-remove-indentation
"org" (code &optional n
))
43 (declare-function org-reduce
"org" (CL-FUNC CL-SEQ
&rest CL-KEYS
))
44 (declare-function org-mark-ring-push
"org" (&optional pos buffer
))
45 (declare-function tramp-compat-make-temp-file
"tramp-compat"
46 (filename &optional dir-flag
))
47 (declare-function tramp-dissect-file-name
"tramp" (name &optional nodefault
))
48 (declare-function tramp-file-name-user
"tramp" (vec))
49 (declare-function tramp-file-name-host
"tramp" (vec))
50 (declare-function with-parsed-tramp-file-name
"tramp" (filename var
&rest body
))
51 (declare-function org-icompleting-read
"org" (&rest args
))
52 (declare-function org-edit-src-code
"org-src"
53 (&optional context code edit-buffer-name quietp
))
54 (declare-function org-edit-src-exit
"org-src" (&optional context
))
55 (declare-function org-open-at-point
"org" (&optional in-emacs reference-buffer
))
56 (declare-function org-save-outline-visibility
"org-macs" (use-markers &rest body
))
57 (declare-function org-outline-overlay-data
"org" (&optional use-markers
))
58 (declare-function org-set-outline-overlay-data
"org" (data))
59 (declare-function org-narrow-to-subtree
"org" ())
60 (declare-function org-split-string
"org" (string &optional separators
))
61 (declare-function org-entry-get
"org"
62 (pom property
&optional inherit literal-nil
))
63 (declare-function org-make-options-regexp
"org" (kwds &optional extra
))
64 (declare-function org-do-remove-indentation
"org" (&optional n
))
65 (declare-function org-next-block
"org" (arg &optional backward block-regexp
))
66 (declare-function org-previous-block
"org" (arg &optional block-regexp
))
67 (declare-function org-show-context
"org" (&optional key
))
68 (declare-function org-at-table-p
"org" (&optional table-type
))
69 (declare-function org-cycle
"org" (&optional arg
))
70 (declare-function org-uniquify
"org" (list))
71 (declare-function org-current-level
"org" ())
72 (declare-function org-table-import
"org-table" (file arg
))
73 (declare-function org-add-hook
"org-compat"
74 (hook function
&optional append local
))
75 (declare-function org-table-align
"org-table" ())
76 (declare-function org-table-end
"org-table" (&optional table-type
))
77 (declare-function orgtbl-to-generic
"org-table" (table params
))
78 (declare-function orgtbl-to-orgtbl
"org-table" (table params
))
79 (declare-function org-babel-tangle-comment-links
"ob-tangle" (&optional info
))
80 (declare-function org-babel-lob-get-info
"ob-lob" nil
)
81 (declare-function org-babel-ref-split-args
"ob-ref" (arg-string))
82 (declare-function org-babel-ref-parse
"ob-ref" (assignment))
83 (declare-function org-babel-ref-resolve
"ob-ref" (ref))
84 (declare-function org-babel-ref-goto-headline-id
"ob-ref" (id))
85 (declare-function org-babel-ref-headline-body
"ob-ref" ())
86 (declare-function org-babel-lob-execute-maybe
"ob-lob" ())
87 (declare-function org-number-sequence
"org-compat" (from &optional to inc
))
88 (declare-function org-at-item-p
"org-list" ())
89 (declare-function org-list-parse-list
"org-list" (&optional delete
))
90 (declare-function org-list-to-generic
"org-list" (LIST PARAMS
))
91 (declare-function org-list-struct
"org-list" ())
92 (declare-function org-list-prevs-alist
"org-list" (struct))
93 (declare-function org-list-get-list-end
"org-list" (item struct prevs
))
94 (declare-function org-remove-if
"org" (predicate seq
))
95 (declare-function org-completing-read
"org" (&rest args
))
96 (declare-function org-escape-code-in-region
"org-src" (beg end
))
97 (declare-function org-unescape-code-in-string
"org-src" (s))
98 (declare-function org-table-to-lisp
"org-table" (&optional txt
))
99 (declare-function org-reverse-string
"org" (string))
100 (declare-function org-element-context
"org-element" (&optional ELEMENT
))
101 (declare-function org-every
"org" (pred seq
))
103 (defgroup org-babel nil
104 "Code block evaluation and management in `org-mode' documents."
108 (defcustom org-confirm-babel-evaluate t
109 "Confirm before evaluation.
110 Require confirmation before interactively evaluating code
111 blocks in Org-mode buffers. The default value of this variable
112 is t, meaning confirmation is required for any code block
113 evaluation. This variable can be set to nil to inhibit any
114 future confirmation requests. This variable can also be set to a
115 function which takes two arguments the language of the code block
116 and the body of the code block. Such a function should then
117 return a non-nil value if the user should be prompted for
118 execution or nil if no prompt is required.
120 Warning: Disabling confirmation may result in accidental
121 evaluation of potentially harmful code. It may be advisable
122 remove code block execution from C-c C-c as further protection
123 against accidental code block evaluation. The
124 `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can be used to
125 remove code block execution from the C-c C-c keybinding."
128 :type
'(choice boolean function
))
129 ;; don't allow this variable to be changed through file settings
130 (put 'org-confirm-babel-evaluate
'safe-local-variable
(lambda (x) (eq x t
)))
132 (defcustom org-babel-no-eval-on-ctrl-c-ctrl-c nil
133 "Remove code block evaluation from the C-c C-c key binding."
138 (defcustom org-babel-results-keyword
"RESULTS"
139 "Keyword used to name results generated by code blocks.
140 Should be either RESULTS or NAME however any capitalization may
144 :package-version
'(Org .
"8.0")
147 (defcustom org-babel-noweb-wrap-start
"<<"
148 "String used to begin a noweb reference in a code block.
149 See also `org-babel-noweb-wrap-end'."
153 (defcustom org-babel-noweb-wrap-end
">>"
154 "String used to end a noweb reference in a code block.
155 See also `org-babel-noweb-wrap-start'."
159 (defcustom org-babel-inline-result-wrap
"=%s="
160 "Format string used to wrap inline results.
161 This string must include a \"%s\" which will be replaced by the results."
164 (put 'org-babel-inline-result-wrap
168 (string-match-p "%s" value
))))
170 (defun org-babel-noweb-wrap (&optional regexp
)
171 (concat org-babel-noweb-wrap-start
172 (or regexp
"\\([^ \t\n].+?[^ \t]\\|[^ \t\n]\\)")
173 org-babel-noweb-wrap-end
))
175 (defvar org-babel-src-name-regexp
176 "^[ \t]*#\\+name:[ \t]*"
177 "Regular expression used to match a source name line.")
179 (defvar org-babel-multi-line-header-regexp
180 "^[ \t]*#\\+headers?:[ \t]*\\([^\n]*\\)$"
181 "Regular expression used to match multi-line header arguments.")
183 (defvar org-babel-src-name-w-name-regexp
184 (concat org-babel-src-name-regexp
186 org-babel-multi-line-header-regexp
188 "\\([^ ()\f\t\n\r\v]+\\)")
189 "Regular expression matching source name lines with a name.")
191 (defvar org-babel-src-block-regexp
193 ;; (1) indentation (2) lang
194 "^\\([ \t]*\\)#\\+begin_src[ \t]+\\([^ \f\t\n\r\v]+\\)[ \t]*"
196 "\\([^\":\n]*\"[^\"\n*]*\"[^\":\n]*\\|[^\":\n]*\\)"
197 ;; (4) header arguments
200 "\\([^\000]*?\n\\)??[ \t]*#\\+end_src")
201 "Regexp used to identify code blocks.")
203 (defvar org-babel-inline-src-block-regexp
205 ;; (1) replacement target (2) lang
206 "\\(?:^\\|[^-[:alnum:]]\\)\\(src_\\([^ \f\t\n\r\v]+\\)"
207 ;; (3,4) (unused, headers)
208 "\\(\\|\\[\\(.*?\\)\\]\\)"
210 "{\\([^\f\n\r\v]+?\\)}\\)")
211 "Regexp used to identify inline src-blocks.")
213 (defun org-babel-get-header (params key
&optional others
)
214 "Select only header argument of type KEY from a list.
215 Optional argument OTHERS indicates that only the header that do
216 not match KEY should be returned."
219 (lambda (p) (when (funcall (if others
#'not
#'identity
) (eq (car p
) key
)) p
))
222 (defun org-babel-get-inline-src-block-matches ()
223 "Set match data if within body of an inline source block.
224 Returns non-nil if match-data set"
225 (let ((src-at-0-p (save-excursion
226 (beginning-of-line 1)
227 (string= "src" (thing-at-point 'word
))))
228 (first-line-p (= (line-beginning-position) (point-min)))
230 (let ((search-for (cond ((and src-at-0-p first-line-p
"src_"))
231 (first-line-p "[[:punct:] \t]src_")
232 (t "[[:punct:] \f\t\n\r\v]src_")))
233 (lower-limit (if first-line-p
235 (- (point-at-bol) 1))))
237 (when (or (and src-at-0-p
(bobp))
238 (and (re-search-forward "}" (point-at-eol) t
)
239 (re-search-backward search-for lower-limit t
)
241 (when (looking-at org-babel-inline-src-block-regexp
)
244 (defvar org-babel-inline-lob-one-liner-regexp
)
245 (defun org-babel-get-lob-one-liner-matches ()
246 "Set match data if on line of an lob one liner.
247 Returns non-nil if match-data set"
249 (unless (= (point) (point-at-bol)) ;; move before inline block
250 (re-search-backward "[ \f\t\n\r\v]" nil t
))
251 (if (looking-at org-babel-inline-lob-one-liner-regexp
)
255 (defun org-babel-get-src-block-info (&optional light
)
256 "Get information on the current source block.
258 Optional argument LIGHT does not resolve remote variable
259 references; a process which could likely result in the execution
260 of other code blocks.
263 (language body header-arguments-alist switches name indent block-head)."
264 (let ((case-fold-search t
) head info name indent
)
266 (if (setq head
(org-babel-where-is-src-block-head))
269 (setq info
(org-babel-parse-src-block-match))
270 (setq indent
(car (last info
)))
271 (setq info
(butlast info
))
272 (while (and (forward-line -
1)
273 (looking-at org-babel-multi-line-header-regexp
))
275 (org-babel-merge-params
277 (org-babel-parse-header-arguments (match-string 1)))))
278 (when (looking-at org-babel-src-name-w-name-regexp
)
279 (setq name
(org-no-properties (match-string 3)))))
280 ;; inline source block
281 (when (org-babel-get-inline-src-block-matches)
282 (setq head
(match-beginning 0))
283 (setq info
(org-babel-parse-inline-src-block-match))))
284 ;; resolve variable references and add summary parameters
285 (when (and info
(not light
))
286 (setf (nth 2 info
) (org-babel-process-params (nth 2 info
))))
288 (setf (nth 2 info
) (org-babel-generate-file-param name
(nth 2 info
))))
289 (when info
(append info
(list name indent head
)))))
291 (defvar org-babel-exp-reference-buffer nil
292 "Buffer containing original contents of the exported buffer.
293 This is used by Babel to resolve references in source blocks.
294 Its value is dynamically bound during export.")
296 (defmacro org-babel-check-confirm-evaluate
(info &rest body
)
297 "Evaluate BODY with special execution confirmation variables set.
299 Specifically; NOEVAL will indicate if evaluation is allowed,
300 QUERY will indicate if a user query is required, CODE-BLOCK will
301 hold the language of the code block, and BLOCK-NAME will hold the
302 name of the code block."
303 (declare (indent defun
))
305 (lang block-body headers name head eval eval-no export eval-no-export
)
306 `(let* ((,lang
(nth 0 ,info
))
307 (,block-body
(nth 1 ,info
))
308 (,headers
(nth 2 ,info
))
309 (,name
(nth 4 ,info
))
310 (,head
(nth 6 ,info
))
311 (,eval
(or (cdr (assoc :eval
,headers
))
312 (when (assoc :noeval
,headers
) "no")))
313 (,eval-no
(or (equal ,eval
"no")
314 (equal ,eval
"never")))
315 (,export org-babel-exp-reference-buffer
)
316 (,eval-no-export
(and ,export
(or (equal ,eval
"no-export")
317 (equal ,eval
"never-export"))))
318 (noeval (or ,eval-no
,eval-no-export
))
319 (query (or (equal ,eval
"query")
320 (and ,export
(equal ,eval
"query-export"))
321 (if (functionp org-confirm-babel-evaluate
)
324 (funcall org-confirm-babel-evaluate
326 org-confirm-babel-evaluate
)))
327 (code-block (if ,info
(format " %s " ,lang
) " "))
328 (block-name (if ,name
(format " (%s) " ,name
) " ")))
331 (defsubst org-babel-check-evaluate
(info)
332 "Check if code block INFO should be evaluated.
333 Do not query the user."
334 (org-babel-check-confirm-evaluate info
336 (message (format "Evaluation of this%scode-block%sis disabled."
337 code-block block-name
))))))
339 ;; dynamically scoped for asynchronous export
340 (defvar org-babel-confirm-evaluate-answer-no
)
342 (defsubst org-babel-confirm-evaluate
(info)
343 "Confirm evaluation of the code block INFO.
345 If the variable `org-babel-confirm-evaluate-answer-no' is bound
346 to a non-nil value, auto-answer with \"no\".
348 This query can also be suppressed by setting the value of
349 `org-confirm-babel-evaluate' to nil, in which case all future
350 interactive code block evaluations will proceed without any
351 confirmation from the user.
353 Note disabling confirmation may result in accidental evaluation
354 of potentially harmful code."
355 (org-babel-check-confirm-evaluate info
358 (and (not (org-bound-and-true-p
359 org-babel-confirm-evaluate-answer-no
))
361 (format "Evaluate this%scode block%son your system? "
362 code-block block-name
)))
363 (message (format "Evaluation of this%scode-block%sis aborted."
364 code-block block-name
)))))))
367 (defun org-babel-execute-safely-maybe ()
368 (unless org-babel-no-eval-on-ctrl-c-ctrl-c
369 (org-babel-execute-maybe)))
371 (add-hook 'org-ctrl-c-ctrl-c-hook
'org-babel-execute-safely-maybe
)
374 (defun org-babel-execute-maybe ()
376 (or (org-babel-execute-src-block-maybe)
377 (org-babel-lob-execute-maybe)))
379 (defmacro org-babel-when-in-src-block
(&rest body
)
380 "Execute BODY if point is in a source block and return t.
382 Otherwise do nothing and return nil."
383 `(if (or (org-babel-where-is-src-block-head)
384 (org-babel-get-inline-src-block-matches))
390 (defun org-babel-execute-src-block-maybe ()
391 "Conditionally execute a source block.
392 Detect if this is context for a Babel src-block and if so
393 then run `org-babel-execute-src-block'."
395 (org-babel-when-in-src-block
396 (org-babel-eval-wipe-error-buffer)
397 (org-babel-execute-src-block current-prefix-arg
)))
400 (defun org-babel-view-src-block-info ()
401 "Display information on the current source block.
402 This includes header arguments, language and name, and is largely
403 a window into the `org-babel-get-src-block-info' function."
405 (let ((info (org-babel-get-src-block-info 'light
))
406 (full (lambda (it) (> (length it
) 0)))
407 (printf (lambda (fmt &rest args
) (princ (apply #'format fmt args
)))))
409 (with-help-window (help-buffer)
410 (let ((name (nth 4 info
))
412 (switches (nth 3 info
))
413 (header-args (nth 2 info
)))
414 (when name
(funcall printf
"Name: %s\n" name
))
415 (when lang
(funcall printf
"Lang: %s\n" lang
))
416 (when (funcall full switches
) (funcall printf
"Switches: %s\n" switches
))
417 (funcall printf
"Header Arguments:\n")
418 (dolist (pair (sort header-args
419 (lambda (a b
) (string< (symbol-name (car a
))
420 (symbol-name (car b
))))))
421 (when (funcall full
(cdr pair
))
422 (funcall printf
"\t%S%s\t%s\n"
424 (if (> (length (format "%S" (car pair
))) 7) "" "\t")
428 (defun org-babel-expand-src-block-maybe ()
429 "Conditionally expand a source block.
430 Detect if this is context for a org-babel src-block and if so
431 then run `org-babel-expand-src-block'."
433 (org-babel-when-in-src-block
434 (org-babel-expand-src-block current-prefix-arg
)))
437 (defun org-babel-load-in-session-maybe ()
438 "Conditionally load a source block in a session.
439 Detect if this is context for a org-babel src-block and if so
440 then run `org-babel-load-in-session'."
442 (org-babel-when-in-src-block
443 (org-babel-load-in-session current-prefix-arg
)))
445 (add-hook 'org-metaup-hook
'org-babel-load-in-session-maybe
)
448 (defun org-babel-pop-to-session-maybe ()
449 "Conditionally pop to a session.
450 Detect if this is context for a org-babel src-block and if so
451 then run `org-babel-switch-to-session'."
453 (org-babel-when-in-src-block
454 (org-babel-switch-to-session current-prefix-arg
)))
456 (add-hook 'org-metadown-hook
'org-babel-pop-to-session-maybe
)
458 (defconst org-babel-common-header-args-w-values
459 '((cache .
((no yes
)))
461 (colnames .
((nil no yes
)))
462 (comments .
((no link yes org both noweb
)))
464 (eval .
((never query
)))
465 (exports .
((code results both none
)))
469 (hlines .
((no yes
)))
470 (mkdirp .
((yes no
)))
473 (noweb .
((yes no tangle no-export strip-export
)))
477 (padline .
((yes no
)))
480 (results .
((file list vector table scalar verbatim
)
481 (raw html latex org code pp drawer
)
482 (replace silent none append prepend
)
484 (rownames .
((no yes
)))
488 (tangle .
((tangle yes no
:any
)))
489 (tangle-mode .
((#o755
#o555
#o444
:any
)))
493 (defconst org-babel-header-arg-names
494 (mapcar #'car org-babel-common-header-args-w-values
)
495 "Common header arguments used by org-babel.
496 Note that individual languages may define their own language
497 specific header arguments as well.")
499 (defconst org-babel-safe-header-args
500 '(:cache
:colnames
:comments
:exports
:epilogue
:hlines
:noeval
501 :noweb
:noweb-ref
:noweb-sep
:padline
:prologue
:rownames
502 :sep
:session
:tangle
:wrap
503 (:eval .
("never" "query"))
504 (:results .
(lambda (str) (not (string-match "file" str
)))))
505 "A list of safe header arguments for babel source blocks.
507 The list can have entries of the following forms:
508 - :ARG -> :ARG is always a safe header arg
509 - (:ARG . (VAL1 VAL2 ...)) -> :ARG is safe as a header arg if it is
510 `equal' to one of the VALs.
511 - (:ARG . FN) -> :ARG is safe as a header arg if the function FN
512 returns non-nil. FN is passed one
513 argument, the value of the header arg
516 (defmacro org-babel-header-args-safe-fn
(safe-list)
517 "Return a function that determines whether a list of header args are safe.
520 \(put 'org-babel-default-header-args 'safe-local-variable
521 (org-babel-header-args-safe-p org-babel-safe-header-args)
523 This allows org-babel languages to extend the list of safe values for
524 their `org-babel-default-header-args:foo' variable.
526 For the format of SAFE-LIST, see `org-babel-safe-header-args'."
532 (org-babel-one-header-arg-safe-p pair
,safe-list
)))
535 (defvar org-babel-default-header-args
536 '((:session .
"none") (:results .
"replace") (:exports .
"code")
537 (:cache .
"no") (:noweb .
"no") (:hlines .
"no") (:tangle .
"no"))
538 "Default arguments to use when evaluating a source block.")
539 (put 'org-babel-default-header-args
'safe-local-variable
540 (org-babel-header-args-safe-fn org-babel-safe-header-args
))
542 (defvar org-babel-default-inline-header-args
543 '((:session .
"none") (:results .
"replace")
544 (:exports .
"results") (:hlines .
"yes"))
545 "Default arguments to use when evaluating an inline source block.")
546 (put 'org-babel-default-inline-header-args
'safe-local-variable
547 (org-babel-header-args-safe-fn org-babel-safe-header-args
))
549 (defvar org-babel-data-names
'("tblname" "results" "name"))
551 (defvar org-babel-result-regexp
552 (concat "^[ \t]*#\\+"
553 (regexp-opt org-babel-data-names t
)
555 ;; FIXME The string below is `org-ts-regexp'
556 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
557 " \\)?\\([[:alnum:]]+\\)\\]\\)?\\:[ \t]*")
558 "Regular expression used to match result lines.
559 If the results are associated with a hash key then the hash will
560 be saved in the second match data.")
562 (defvar org-babel-result-w-name-regexp
563 (concat org-babel-result-regexp
564 "\\([^ ()\f\t\n\r\v]+\\)\\(\(\\(.*\\)\)\\|\\)"))
566 (defvar org-babel-min-lines-for-block-output
10
567 "The minimum number of lines for block output.
568 If number of lines of output is equal to or exceeds this
569 value, the output is placed in a #+begin_example...#+end_example
570 block. Otherwise the output is marked as literal by inserting
571 colons at the starts of the lines. This variable only takes
572 effect if the :results output option is in effect.")
574 (defvar org-babel-noweb-error-all-langs nil
575 "Raise errors when noweb references don't resolve.
576 Also see `org-babel-noweb-error-langs' to control noweb errors on
577 a language by language bases.")
579 (defvar org-babel-noweb-error-langs nil
580 "Languages for which Babel will raise literate programming errors.
581 List of languages for which errors should be raised when the
582 source code block satisfying a noweb reference in this language
583 can not be resolved. Also see `org-babel-noweb-error-all-langs'
584 to raise errors for all languages.")
586 (defvar org-babel-hash-show
4
587 "Number of initial characters to show of a hidden results hash.")
589 (defvar org-babel-hash-show-time nil
590 "Non-nil means show the time the code block was evaluated in the result hash.")
592 (defvar org-babel-after-execute-hook nil
593 "Hook for functions to be called after `org-babel-execute-src-block'")
595 (defun org-babel-named-src-block-regexp-for-name (name)
596 "This generates a regexp used to match a src block named NAME."
597 (concat org-babel-src-name-regexp
(regexp-quote name
)
598 "[ \t(]*[\r\n]\\(?:^[[:space:]]*#.*[\r\n]\\)*"
599 (substring org-babel-src-block-regexp
1)))
601 (defun org-babel-named-data-regexp-for-name (name)
602 "This generates a regexp used to match data named NAME."
603 (concat org-babel-result-regexp
(regexp-quote name
) "\\([ \t]\\|$\\)"))
606 (defvar call-process-region
)
607 (defvar org-babel-current-src-block-location nil
608 "Marker pointing to the src block currently being executed.
609 This may also point to a call line or an inline code block. If
610 multiple blocks are being executed (e.g., in chained execution
611 through use of the :var header argument) this marker points to
612 the outer-most code block.")
615 (defun org-babel-execute-src-block (&optional arg info params
)
616 "Execute the current source code block.
617 Insert the results of execution into the buffer. Source code
618 execution and the collection and formatting of results can be
619 controlled through a variety of header arguments.
621 With prefix argument ARG, force re-execution even if an existing
622 result cached in the buffer would otherwise have been returned.
624 Optionally supply a value for INFO in the form returned by
625 `org-babel-get-src-block-info'.
627 Optionally supply a value for PARAMS which will be merged with
628 the header arguments specified at the front of the source code
631 (let* ((org-babel-current-src-block-location
632 (or org-babel-current-src-block-location
634 (org-babel-where-is-src-block-head)
636 (and (org-babel-get-inline-src-block-matches)
637 (match-beginning 0))))
640 (org-babel-get-src-block-info)))
641 (merged-params (org-babel-merge-params (nth 2 info
) params
)))
642 (when (org-babel-check-evaluate
643 (let ((i info
)) (setf (nth 2 i
) merged-params
) i
))
644 (let* ((params (if params
645 (org-babel-process-params merged-params
)
647 (cachep (and (not arg
) (cdr (assoc :cache params
))
648 (string= "yes" (cdr (assoc :cache params
)))))
649 (new-hash (when cachep
(org-babel-sha1-hash info
)))
650 (old-hash (when cachep
(org-babel-current-result-hash)))
651 (cache-current-p (and (not arg
) new-hash
652 (equal new-hash old-hash
))))
655 (save-excursion ;; return cached result
656 (goto-char (org-babel-where-is-src-block-result nil info
))
657 (end-of-line 1) (forward-char 1)
658 (let ((result (org-babel-read-result)))
659 (message (replace-regexp-in-string
660 "%" "%%" (format "%S" result
))) result
)))
661 ((org-babel-confirm-evaluate
662 (let ((i info
)) (setf (nth 2 i
) merged-params
) i
))
663 (let* ((lang (nth 0 info
))
664 (result-params (cdr (assoc :result-params params
)))
665 (body (setf (nth 1 info
)
666 (if (org-babel-noweb-p params
:eval
)
667 (org-babel-expand-noweb-references info
)
669 (dir (cdr (assoc :dir params
)))
671 (or (and dir
(file-name-as-directory (expand-file-name dir
)))
673 (org-babel-call-process-region-original ;; for tramp handler
674 (or (org-bound-and-true-p
675 org-babel-call-process-region-original
)
676 (symbol-function 'call-process-region
)))
677 (indent (nth 5 info
))
680 (let ((call-process-region
682 (apply 'org-babel-tramp-handle-call-process-region
686 (let ((f (intern (concat "org-babel-execute:" f
))))
687 (when (fboundp f
) f
)))))
689 (or (funcall lang-check lang
)
692 (cdr (assoc lang org-src-lang-modes
))))
693 (error "No org-babel-execute function for %s!"
695 (message "executing %s code block%s..."
697 (if (nth 4 info
) (format " (%s)" (nth 4 info
)) ""))
698 (if (member "none" result-params
)
700 (funcall cmd body params
)
701 (message "result silenced")
704 (let ((result (funcall cmd body params
)))
705 (if (and (eq (cdr (assoc :result-type params
))
707 (or (member "vector" result-params
)
708 (member "table" result-params
))
709 (not (listp result
)))
710 (list (list result
)) result
)))
711 ;; If non-empty result and :file then write to :file.
712 (when (cdr (assoc :file params
))
714 (with-temp-file (cdr (assoc :file params
))
716 (org-babel-format-result
717 result
(cdr (assoc :sep
(nth 2 info
)))))))
718 (setq result
(cdr (assoc :file params
))))
719 ;; Possibly perform post process provided its appropriate.
720 (when (cdr (assoc :post params
))
721 (let ((*this
* (if (cdr (assoc :file params
))
722 (org-babel-result-to-file
723 (cdr (assoc :file params
))
724 (when (assoc :file-desc params
)
725 (or (cdr (assoc :file-desc params
))
728 (setq result
(org-babel-ref-resolve
729 (cdr (assoc :post params
))))
730 (when (cdr (assoc :file params
))
732 (remove "file" result-params
)))))
733 (org-babel-insert-result
734 result result-params info new-hash indent lang
))
735 (run-hooks 'org-babel-after-execute-hook
)
737 (setq call-process-region
738 'org-babel-call-process-region-original
)))))))))
740 (defun org-babel-expand-body:generic
(body params
&optional var-lines
)
741 "Expand BODY with PARAMS.
742 Expand a block of code with org-babel according to its header
743 arguments. This generic implementation of body expansion is
744 called for languages which have not defined their own specific
745 org-babel-expand-body:lang function."
746 (let ((pro (cdr (assoc :prologue params
)))
747 (epi (cdr (assoc :epilogue params
))))
748 (mapconcat #'identity
749 (append (when pro
(list pro
))
752 (when epi
(list epi
)))
756 (defun org-babel-expand-src-block (&optional arg info params
)
757 "Expand the current source code block.
758 Expand according to the source code block's header
759 arguments and pop open the results in a preview buffer."
761 (let* ((info (or info
(org-babel-get-src-block-info)))
763 (params (setf (nth 2 info
)
764 (sort (org-babel-merge-params (nth 2 info
) params
)
765 (lambda (el1 el2
) (string< (symbol-name (car el1
))
766 (symbol-name (car el2
)))))))
767 (body (setf (nth 1 info
)
768 (if (org-babel-noweb-p params
:eval
)
769 (org-babel-expand-noweb-references info
) (nth 1 info
))))
770 (expand-cmd (intern (concat "org-babel-expand-body:" lang
)))
771 (assignments-cmd (intern (concat "org-babel-variable-assignments:"
774 (if (fboundp expand-cmd
) (funcall expand-cmd body params
)
775 (org-babel-expand-body:generic
776 body params
(and (fboundp assignments-cmd
)
777 (funcall assignments-cmd params
))))))
778 (if (org-called-interactively-p 'any
)
781 (concat "*Org-Babel Preview " (buffer-name) "[ " lang
" ]*"))
784 (defun org-babel-edit-distance (s1 s2
)
785 "Return the edit (levenshtein) distance between strings S1 S2."
786 (let* ((l1 (length s1
))
788 (dist (vconcat (mapcar (lambda (_) (make-vector (1+ l2
) nil
))
789 (number-sequence 1 (1+ l1
)))))
790 (in (lambda (i j
) (aref (aref dist i
) j
))))
791 (setf (aref (aref dist
0) 0) 0)
792 (dolist (j (number-sequence 1 l2
))
793 (setf (aref (aref dist
0) j
) j
))
794 (dolist (i (number-sequence 1 l1
))
795 (setf (aref (aref dist i
) 0) i
)
796 (dolist (j (number-sequence 1 l2
))
797 (setf (aref (aref dist i
) j
)
799 (1+ (funcall in
(1- i
) j
))
800 (1+ (funcall in i
(1- j
)))
801 (+ (if (equal (aref s1
(1- i
)) (aref s2
(1- j
))) 0 1)
802 (funcall in
(1- i
) (1- j
)))))))
805 (defun org-babel-combine-header-arg-lists (original &rest others
)
806 "Combine a number of lists of header argument names and arguments."
807 (let ((results (copy-sequence original
)))
808 (dolist (new-list others
)
809 (dolist (arg-pair new-list
)
810 (let ((header (car arg-pair
))
811 (args (cdr arg-pair
)))
813 (cons arg-pair
(org-remove-if
814 (lambda (pair) (equal header
(car pair
)))
819 (defun org-babel-check-src-block ()
820 "Check for misspelled header arguments in the current code block."
822 ;; TODO: report malformed code block
823 ;; TODO: report incompatible combinations of header arguments
824 ;; TODO: report uninitialized variables
825 (let ((too-close 2) ;; <- control closeness to report potential match
826 (names (mapcar #'symbol-name org-babel-header-arg-names
)))
827 (dolist (header (mapcar (lambda (arg) (substring (symbol-name (car arg
)) 1))
828 (and (org-babel-where-is-src-block-head)
829 (org-babel-parse-header-arguments
831 (match-string 4))))))
833 (when (and (not (string= header name
))
834 (<= (org-babel-edit-distance header name
) too-close
)
835 (not (member header names
)))
836 (error "Supplied header \"%S\" is suspiciously close to \"%S\""
838 (message "No suspicious header arguments found.")))
841 (defun org-babel-insert-header-arg (&optional header-arg value
)
842 "Insert a header argument selecting from lists of common args and values."
844 (let* ((info (org-babel-get-src-block-info 'light
))
847 (lang-headers (intern (concat "org-babel-header-args:" lang
)))
848 (headers (org-babel-combine-header-arg-lists
849 org-babel-common-header-args-w-values
850 (when (boundp lang-headers
) (eval lang-headers
))))
851 (header-arg (or header-arg
852 (org-icompleting-read
855 (lambda (header-spec) (symbol-name (car header-spec
)))
857 (vals (cdr (assoc (intern header-arg
) headers
)))
861 (read-from-minibuffer "value: "))
865 (let ((arg (org-icompleting-read
868 (mapcar #'symbol-name group
)))))
869 (if (and arg
(not (string= "default" arg
)))
875 (goto-char (point-at-eol))
876 (unless (= (char-before (point)) ?\
) (insert " "))
877 (insert ":" header-arg
) (when value
(insert " " value
)))))
879 ;; Add support for completing-read insertion of header arguments after ":"
880 (defun org-babel-header-arg-expand ()
881 "Call `org-babel-enter-header-arg-w-completion' in appropriate contexts."
882 (when (and (equal (char-before) ?\
:) (org-babel-where-is-src-block-head))
883 (org-babel-enter-header-arg-w-completion (match-string 2))))
885 (defun org-babel-enter-header-arg-w-completion (&optional lang
)
886 "Insert header argument appropriate for LANG with completion."
887 (let* ((lang-headers-var (intern (concat "org-babel-header-args:" lang
)))
888 (lang-headers (when (boundp lang-headers-var
) (eval lang-headers-var
)))
889 (headers-w-values (org-babel-combine-header-arg-lists
890 org-babel-common-header-args-w-values lang-headers
))
891 (headers (mapcar #'symbol-name
(mapcar #'car headers-w-values
)))
892 (header (org-completing-read "Header Arg: " headers
))
893 (args (cdr (assoc (intern header
) headers-w-values
)))
894 (arg (when (and args
(listp args
))
896 (format "%s: " header
)
897 (mapcar #'symbol-name
(apply #'append args
))))))
898 (insert (concat header
" " (or arg
"")))
901 (add-hook 'org-tab-first-hook
'org-babel-header-arg-expand
)
904 (defun org-babel-load-in-session (&optional arg info
)
905 "Load the body of the current source-code block.
906 Evaluate the header arguments for the source block before
907 entering the session. After loading the body this pops open the
910 (let* ((info (or info
(org-babel-get-src-block-info)))
912 (params (nth 2 info
))
914 (user-error "No src code block at point")
916 (if (org-babel-noweb-p params
:eval
)
917 (org-babel-expand-noweb-references info
)
919 (session (cdr (assoc :session params
)))
920 (dir (cdr (assoc :dir params
)))
922 (or (and dir
(file-name-as-directory dir
)) default-directory
))
923 (cmd (intern (concat "org-babel-load-session:" lang
))))
924 (unless (fboundp cmd
)
925 (error "No org-babel-load-session function for %s!" lang
))
926 (pop-to-buffer (funcall cmd session body params
))
930 (defun org-babel-initiate-session (&optional arg info
)
931 "Initiate session for current code block.
932 If called with a prefix argument then resolve any variable
933 references in the header arguments and assign these variables in
934 the session. Copy the body of the code block to the kill ring."
936 (let* ((info (or info
(org-babel-get-src-block-info (not arg
))))
939 (params (nth 2 info
))
940 (session (cdr (assoc :session params
)))
941 (dir (cdr (assoc :dir params
)))
943 (or (and dir
(file-name-as-directory dir
)) default-directory
))
944 (init-cmd (intern (format "org-babel-%s-initiate-session" lang
)))
945 (prep-cmd (intern (concat "org-babel-prep-session:" lang
))))
946 (if (and (stringp session
) (string= session
"none"))
947 (error "This block is not using a session!"))
948 (unless (fboundp init-cmd
)
949 (error "No org-babel-initiate-session function for %s!" lang
))
950 (with-temp-buffer (insert (org-babel-trim body
))
951 (copy-region-as-kill (point-min) (point-max)))
953 (unless (fboundp prep-cmd
)
954 (error "No org-babel-prep-session function for %s!" lang
))
955 (funcall prep-cmd session params
))
956 (funcall init-cmd session params
)))
959 (defun org-babel-switch-to-session (&optional arg info
)
960 "Switch to the session of the current code block.
961 Uses `org-babel-initiate-session' to start the session. If called
962 with a prefix argument then this is passed on to
963 `org-babel-initiate-session'."
965 (pop-to-buffer (org-babel-initiate-session arg info
))
968 (defalias 'org-babel-pop-to-session
'org-babel-switch-to-session
)
970 (defvar org-src-window-setup
)
973 (defun org-babel-switch-to-session-with-code (&optional arg info
)
974 "Switch to code buffer and display session."
978 (let ((other-window-buffer (window-buffer (next-window))))
979 (set-window-buffer (next-window) (current-buffer))
980 (set-window-buffer (selected-window) other-window-buffer
))
982 (info (org-babel-get-src-block-info))
983 (org-src-window-setup 'reorganize-frame
))
985 (org-babel-switch-to-session arg info
))
987 (funcall swap-windows
)))
990 (defmacro org-babel-do-in-edit-buffer
(&rest body
)
991 "Evaluate BODY in edit buffer if there is a code block at point.
992 Return t if a code block was found at point, nil otherwise."
993 `(let ((org-src-window-setup 'switch-invisibly
))
994 (when (and (org-babel-where-is-src-block-head)
996 (unwind-protect (progn ,@body
)
997 (if (org-bound-and-true-p org-edit-src-from-org-mode
)
998 (org-edit-src-exit)))
1000 (def-edebug-spec org-babel-do-in-edit-buffer
(body))
1002 (defun org-babel-do-key-sequence-in-edit-buffer (key)
1003 "Read key sequence and execute the command in edit buffer.
1004 Enter a key sequence to be executed in the language major-mode
1005 edit buffer. For example, TAB will alter the contents of the
1006 Org-mode code block according to the effect of TAB in the
1007 language major-mode buffer. For languages that support
1008 interactive sessions, this can be used to send code from the Org
1009 buffer to the session for evaluation using the native major-mode
1010 evaluation mechanisms."
1011 (interactive "kEnter key-sequence to execute in edit buffer: ")
1012 (org-babel-do-in-edit-buffer
1014 (key-binding (or key
(read-key-sequence nil
))))))
1016 (defvar org-bracket-link-regexp
)
1018 (defun org-babel-active-location-p ()
1019 (memq (car (save-match-data (org-element-context)))
1020 '(babel-call inline-babel-call inline-src-block src-block
)))
1023 (defun org-babel-open-src-block-result (&optional re-run
)
1024 "If `point' is on a src block then open the results of the
1025 source code block, otherwise return nil. With optional prefix
1026 argument RE-RUN the source-code block is evaluated even if
1027 results already exist."
1029 (let ((info (org-babel-get-src-block-info 'light
)))
1032 ;; go to the results, if there aren't any then run the block
1033 (goto-char (or (and (not re-run
) (org-babel-where-is-src-block-result))
1034 (progn (org-babel-execute-src-block)
1035 (org-babel-where-is-src-block-result))))
1037 (while (looking-at "[\n\r\t\f ]") (forward-char 1))
1039 (if (looking-at org-bracket-link-regexp
)
1042 (let ((r (org-babel-format-result
1043 (org-babel-read-result) (cdr (assoc :sep
(nth 2 info
))))))
1044 (pop-to-buffer (get-buffer-create "*Org-Babel Results*"))
1045 (delete-region (point-min) (point-max))
1050 (defmacro org-babel-map-src-blocks
(file &rest body
)
1051 "Evaluate BODY forms on each source-block in FILE.
1052 If FILE is nil evaluate BODY forms on source blocks in current
1053 buffer. During evaluation of BODY the following local variables
1054 are set relative to the currently matched code block.
1056 full-block ------- string holding the entirety of the code block
1057 beg-block -------- point at the beginning of the code block
1058 end-block -------- point at the end of the matched code block
1059 lang ------------- string holding the language of the code block
1060 beg-lang --------- point at the beginning of the lang
1061 end-lang --------- point at the end of the lang
1062 switches --------- string holding the switches
1063 beg-switches ----- point at the beginning of the switches
1064 end-switches ----- point at the end of the switches
1065 header-args ------ string holding the header-args
1066 beg-header-args -- point at the beginning of the header-args
1067 end-header-args -- point at the end of the header-args
1068 body ------------- string holding the body of the code block
1069 beg-body --------- point at the beginning of the body
1070 end-body --------- point at the end of the body"
1071 (declare (indent 1))
1072 (let ((tempvar (make-symbol "file")))
1073 `(let* ((,tempvar
,file
)
1074 (visited-p (or (null ,tempvar
)
1075 (get-file-buffer (expand-file-name ,tempvar
))))
1076 (point (point)) to-be-removed
)
1077 (save-window-excursion
1078 (when ,tempvar
(find-file ,tempvar
))
1079 (setq to-be-removed
(current-buffer))
1080 (goto-char (point-min))
1081 (while (re-search-forward org-babel-src-block-regexp nil t
)
1082 (when (org-babel-active-location-p)
1083 (goto-char (match-beginning 0))
1084 (let ((full-block (match-string 0))
1085 (beg-block (match-beginning 0))
1086 (end-block (match-end 0))
1087 (lang (match-string 2))
1088 (beg-lang (match-beginning 2))
1089 (end-lang (match-end 2))
1090 (switches (match-string 3))
1091 (beg-switches (match-beginning 3))
1092 (end-switches (match-end 3))
1093 (header-args (match-string 4))
1094 (beg-header-args (match-beginning 4))
1095 (end-header-args (match-end 4))
1096 (body (match-string 5))
1097 (beg-body (match-beginning 5))
1098 (end-body (match-end 5)))
1100 (goto-char end-block
)))))
1101 (unless visited-p
(kill-buffer to-be-removed
))
1102 (goto-char point
))))
1103 (def-edebug-spec org-babel-map-src-blocks
(form body
))
1106 (defmacro org-babel-map-inline-src-blocks
(file &rest body
)
1107 "Evaluate BODY forms on each inline source-block in FILE.
1108 If FILE is nil evaluate BODY forms on source blocks in current
1110 (declare (indent 1))
1111 (let ((tempvar (make-symbol "file")))
1112 `(let* ((,tempvar
,file
)
1113 (visited-p (or (null ,tempvar
)
1114 (get-file-buffer (expand-file-name ,tempvar
))))
1115 (point (point)) to-be-removed
)
1116 (save-window-excursion
1117 (when ,tempvar
(find-file ,tempvar
))
1118 (setq to-be-removed
(current-buffer))
1119 (goto-char (point-min))
1120 (while (re-search-forward org-babel-inline-src-block-regexp nil t
)
1121 (when (org-babel-active-location-p)
1122 (goto-char (match-beginning 1))
1123 (save-match-data ,@body
))
1124 (goto-char (match-end 0))))
1125 (unless visited-p
(kill-buffer to-be-removed
))
1126 (goto-char point
))))
1127 (def-edebug-spec org-babel-map-inline-src-blocks
(form body
))
1129 (defvar org-babel-lob-one-liner-regexp
)
1132 (defmacro org-babel-map-call-lines
(file &rest body
)
1133 "Evaluate BODY forms on each call line in FILE.
1134 If FILE is nil evaluate BODY forms on source blocks in current
1136 (declare (indent 1))
1137 (let ((tempvar (make-symbol "file")))
1138 `(let* ((,tempvar
,file
)
1139 (visited-p (or (null ,tempvar
)
1140 (get-file-buffer (expand-file-name ,tempvar
))))
1141 (point (point)) to-be-removed
)
1142 (save-window-excursion
1143 (when ,tempvar
(find-file ,tempvar
))
1144 (setq to-be-removed
(current-buffer))
1145 (goto-char (point-min))
1146 (while (re-search-forward org-babel-lob-one-liner-regexp nil t
)
1147 (when (org-babel-active-location-p)
1148 (goto-char (match-beginning 1))
1149 (save-match-data ,@body
))
1150 (goto-char (match-end 0))))
1151 (unless visited-p
(kill-buffer to-be-removed
))
1152 (goto-char point
))))
1153 (def-edebug-spec org-babel-map-call-lines
(form body
))
1156 (defmacro org-babel-map-executables
(file &rest body
)
1157 (declare (indent 1))
1158 (let ((tempvar (make-symbol "file"))
1159 (rx (make-symbol "rx")))
1160 `(let* ((,tempvar
,file
)
1161 (,rx
(concat "\\(" org-babel-src-block-regexp
1162 "\\|" org-babel-inline-src-block-regexp
1163 "\\|" org-babel-lob-one-liner-regexp
"\\)"))
1164 (visited-p (or (null ,tempvar
)
1165 (get-file-buffer (expand-file-name ,tempvar
))))
1166 (point (point)) to-be-removed
)
1167 (save-window-excursion
1168 (when ,tempvar
(find-file ,tempvar
))
1169 (setq to-be-removed
(current-buffer))
1170 (goto-char (point-min))
1171 (while (re-search-forward ,rx nil t
)
1172 (when (org-babel-active-location-p)
1173 (goto-char (match-beginning 1))
1174 (when (looking-at org-babel-inline-src-block-regexp
)
1176 (save-match-data ,@body
))
1177 (goto-char (match-end 0))))
1178 (unless visited-p
(kill-buffer to-be-removed
))
1179 (goto-char point
))))
1180 (def-edebug-spec org-babel-map-executables
(form body
))
1183 (defun org-babel-execute-buffer (&optional arg
)
1184 "Execute source code blocks in a buffer.
1185 Call `org-babel-execute-src-block' on every source block in
1186 the current buffer."
1188 (org-babel-eval-wipe-error-buffer)
1189 (org-save-outline-visibility t
1190 (org-babel-map-executables nil
1191 (if (looking-at org-babel-lob-one-liner-regexp
)
1192 (org-babel-lob-execute-maybe)
1193 (org-babel-execute-src-block arg
)))))
1196 (defun org-babel-execute-subtree (&optional arg
)
1197 "Execute source code blocks in a subtree.
1198 Call `org-babel-execute-src-block' on every source block in
1199 the current subtree."
1203 (org-narrow-to-subtree)
1204 (org-babel-execute-buffer arg
)
1208 (defun org-babel-sha1-hash (&optional info
)
1209 "Generate an sha1 hash based on the value of info."
1211 (let ((print-level nil
)
1212 (info (or info
(org-babel-get-src-block-info))))
1214 (sort (copy-sequence (nth 2 info
))
1215 (lambda (a b
) (string< (car a
) (car b
)))))
1216 (let* ((rm (lambda (lst)
1217 (dolist (p '("replace" "silent" "none"
1218 "append" "prepend"))
1219 (setq lst
(remove p lst
)))
1222 (let ((v (if (and (listp (cdr arg
)) (null (cddr arg
)))
1223 (copy-sequence (cdr arg
))
1225 (when (and v
(not (and (sequencep v
)
1229 ((and (listp v
) ; lists are sorted
1230 (member (car arg
) '(:result-params
)))
1231 (sort (funcall rm v
) #'string
<))
1232 ((and (stringp v
) ; strings are sorted
1233 (member (car arg
) '(:results
:exports
)))
1234 (mapconcat #'identity
(sort (funcall rm
(split-string v
))
1239 (params (nth 2 info
))
1240 (body (if (org-babel-noweb-p params
:eval
)
1241 (org-babel-expand-noweb-references info
) (nth 1 info
)))
1242 (expand-cmd (intern (concat "org-babel-expand-body:" lang
)))
1243 (assignments-cmd (intern (concat "org-babel-variable-assignments:"
1246 (if (fboundp expand-cmd
) (funcall expand-cmd body params
)
1247 (org-babel-expand-body:generic
1248 body params
(and (fboundp assignments-cmd
)
1249 (funcall assignments-cmd params
))))))
1250 (let* ((it (format "%s-%s"
1253 (delq nil
(mapcar (lambda (arg)
1254 (let ((normalized (funcall norm arg
)))
1256 (format "%S" normalized
))))
1260 (when (org-called-interactively-p 'interactive
) (message hash
))
1263 (defun org-babel-current-result-hash (&optional info
)
1264 "Return the current in-buffer hash."
1265 (org-babel-where-is-src-block-result nil info
)
1266 (org-no-properties (match-string 5)))
1268 (defun org-babel-set-current-result-hash (hash info
)
1269 "Set the current in-buffer hash to HASH."
1270 (org-babel-where-is-src-block-result nil info
)
1271 (save-excursion (goto-char (match-beginning 5))
1272 (mapc #'delete-overlay
(overlays-at (point)))
1273 (forward-char org-babel-hash-show
)
1274 (mapc #'delete-overlay
(overlays-at (point)))
1275 (replace-match hash nil nil nil
5)
1276 (goto-char (point-at-bol))
1277 (org-babel-hide-hash)))
1279 (defun org-babel-hide-hash ()
1280 "Hide the hash in the current results line.
1281 Only the initial `org-babel-hash-show' characters of the hash
1282 will remain visible."
1283 (add-to-invisibility-spec '(org-babel-hide-hash . t
))
1285 (when (and (re-search-forward org-babel-result-regexp nil t
)
1287 (let* ((start (match-beginning 5))
1288 (hide-start (+ org-babel-hash-show start
))
1290 (hash (match-string 5))
1292 (setq ov1
(make-overlay start hide-start
))
1293 (setq ov2
(make-overlay hide-start end
))
1294 (overlay-put ov2
'invisible
'org-babel-hide-hash
)
1295 (overlay-put ov1
'babel-hash hash
)))))
1297 (defun org-babel-hide-all-hashes ()
1298 "Hide the hash in the current buffer.
1299 Only the initial `org-babel-hash-show' characters of each hash
1300 will remain visible. This function should be called as part of
1301 the `org-mode-hook'."
1303 (while (and (not org-babel-hash-show-time
)
1304 (re-search-forward org-babel-result-regexp nil t
))
1305 (goto-char (match-beginning 0))
1306 (org-babel-hide-hash)
1307 (goto-char (match-end 0)))))
1308 (add-hook 'org-mode-hook
'org-babel-hide-all-hashes
)
1310 (defun org-babel-hash-at-point (&optional point
)
1311 "Return the value of the hash at POINT.
1312 The hash is also added as the last element of the kill ring.
1313 This can be called with C-c C-c."
1315 (let ((hash (car (delq nil
(mapcar
1316 (lambda (ol) (overlay-get ol
'babel-hash
))
1317 (overlays-at (or point
(point))))))))
1318 (when hash
(kill-new hash
) (message hash
))))
1319 (add-hook 'org-ctrl-c-ctrl-c-hook
'org-babel-hash-at-point
)
1321 (defun org-babel-result-hide-spec ()
1322 "Hide portions of results lines.
1323 Add `org-babel-hide-result' as an invisibility spec for hiding
1324 portions of results lines."
1325 (add-to-invisibility-spec '(org-babel-hide-result . t
)))
1326 (add-hook 'org-mode-hook
'org-babel-result-hide-spec
)
1328 (defvar org-babel-hide-result-overlays nil
1329 "Overlays hiding results.")
1331 (defun org-babel-result-hide-all ()
1332 "Fold all results in the current buffer."
1334 (org-babel-show-result-all)
1336 (while (re-search-forward org-babel-result-regexp nil t
)
1337 (save-excursion (goto-char (match-beginning 0))
1338 (org-babel-hide-result-toggle-maybe)))))
1340 (defun org-babel-show-result-all ()
1341 "Unfold all results in the current buffer."
1342 (mapc 'delete-overlay org-babel-hide-result-overlays
)
1343 (setq org-babel-hide-result-overlays nil
))
1346 (defun org-babel-hide-result-toggle-maybe ()
1347 "Toggle visibility of result at point."
1349 (let ((case-fold-search t
))
1351 (beginning-of-line 1)
1352 (looking-at org-babel-result-regexp
))
1353 (progn (org-babel-hide-result-toggle)
1354 t
) ;; to signal that we took action
1355 nil
))) ;; to signal that we did not
1357 (defun org-babel-hide-result-toggle (&optional force
)
1358 "Toggle the visibility of the current result."
1362 (if (re-search-forward org-babel-result-regexp nil t
)
1363 (let ((start (progn (beginning-of-line 2) (- (point) 1)))
1365 (while (looking-at org-babel-multi-line-header-regexp
)
1367 (goto-char (- (org-babel-result-end) 1)) (point)))
1369 (if (memq t
(mapcar (lambda (overlay)
1370 (eq (overlay-get overlay
'invisible
)
1371 'org-babel-hide-result
))
1372 (overlays-at start
)))
1373 (if (or (not force
) (eq force
'off
))
1375 (when (member ov org-babel-hide-result-overlays
)
1376 (setq org-babel-hide-result-overlays
1377 (delq ov org-babel-hide-result-overlays
)))
1378 (when (eq (overlay-get ov
'invisible
)
1379 'org-babel-hide-result
)
1380 (delete-overlay ov
)))
1381 (overlays-at start
)))
1382 (setq ov
(make-overlay start end
))
1383 (overlay-put ov
'invisible
'org-babel-hide-result
)
1384 ;; make the block accessible to isearch
1386 ov
'isearch-open-invisible
1388 (when (member ov org-babel-hide-result-overlays
)
1389 (setq org-babel-hide-result-overlays
1390 (delq ov org-babel-hide-result-overlays
)))
1391 (when (eq (overlay-get ov
'invisible
)
1392 'org-babel-hide-result
)
1393 (delete-overlay ov
))))
1394 (push ov org-babel-hide-result-overlays
)))
1395 (error "Not looking at a result line"))))
1397 ;; org-tab-after-check-for-cycling-hook
1398 (add-hook 'org-tab-first-hook
'org-babel-hide-result-toggle-maybe
)
1399 ;; Remove overlays when changing major mode
1400 (add-hook 'org-mode-hook
1401 (lambda () (org-add-hook 'change-major-mode-hook
1402 'org-babel-show-result-all
'append
'local
)))
1404 (defvar org-file-properties
)
1405 (defun org-babel-params-from-properties (&optional lang
)
1406 "Retrieve parameters specified as properties.
1407 Return a list of association lists of source block params
1408 specified in the properties of the current outline entry."
1411 ;; DEPRECATED header arguments specified as separate property at
1412 ;; point of definition
1414 (org-babel-parse-multiple-vars
1417 (lambda (header-arg)
1418 (and (setq val
(org-entry-get (point) header-arg t
))
1419 (cons (intern (concat ":" header-arg
))
1420 (org-babel-read val
))))
1425 (org-babel-combine-header-arg-lists
1426 org-babel-common-header-args-w-values
1428 (setq sym
(intern (concat "org-babel-header-args:" lang
)))
1429 (and (boundp sym
) (eval sym
))))))))))
1430 ;; header arguments specified with the header-args property at
1432 (org-babel-parse-header-arguments
1433 (org-entry-get org-babel-current-src-block-location
1434 "header-args" 'inherit
))
1435 (when lang
;; language-specific header arguments at point of call
1436 (org-babel-parse-header-arguments
1437 (org-entry-get org-babel-current-src-block-location
1438 (concat "header-args:" lang
) 'inherit
))))))
1440 (defvar org-src-preserve-indentation
) ;; declare defcustom from org-src
1441 (defun org-babel-parse-src-block-match ()
1442 "Parse the results from a match of the `org-babel-src-block-regexp'."
1443 (let* ((block-indentation (length (match-string 1)))
1444 (lang (org-no-properties (match-string 2)))
1445 (lang-headers (intern (concat "org-babel-default-header-args:" lang
)))
1446 (switches (match-string 3))
1447 (body (org-no-properties
1448 (let* ((body (match-string 5))
1449 (sub-length (- (length body
) 1)))
1450 (if (and (> sub-length
0)
1451 (string= "\n" (substring body sub-length
)))
1452 (substring body
0 sub-length
)
1454 (preserve-indentation (or org-src-preserve-indentation
1456 (string-match "-i\\>" switches
)))))
1458 ;; get block body less properties, protective commas, and indentation
1461 (insert (org-unescape-code-in-string body
))
1462 (unless preserve-indentation
(org-do-remove-indentation))
1464 (apply #'org-babel-merge-params
1465 org-babel-default-header-args
1466 (when (boundp lang-headers
) (eval lang-headers
))
1468 (org-babel-params-from-properties lang
)
1469 (list (org-babel-parse-header-arguments
1470 (org-no-properties (or (match-string 4) ""))))))
1472 block-indentation
)))
1474 (defun org-babel-parse-inline-src-block-match ()
1475 "Parse the results from a match of the `org-babel-inline-src-block-regexp'."
1476 (let* ((lang (org-no-properties (match-string 2)))
1477 (lang-headers (intern (concat "org-babel-default-header-args:" lang
))))
1479 (org-unescape-code-in-string (org-no-properties (match-string 5)))
1480 (apply #'org-babel-merge-params
1481 org-babel-default-inline-header-args
1482 (if (boundp lang-headers
) (eval lang-headers
) nil
)
1484 (org-babel-params-from-properties lang
)
1485 (list (org-babel-parse-header-arguments
1486 (org-no-properties (or (match-string 4) ""))))))
1489 (defun org-babel-balanced-split (string alts
)
1490 "Split STRING on instances of ALTS.
1491 ALTS is a cons of two character options where each option may be
1492 either the numeric code of a single character or a list of
1493 character alternatives. For example to split on balanced
1494 instances of \"[ \t]:\" set ALTS to '((32 9) . 58)."
1495 (let* ((matches (lambda (ch spec
) (if (listp spec
) (member ch spec
) (equal spec ch
))))
1496 (matched (lambda (ch last
)
1498 (and (funcall matches ch
(cdr alts
))
1499 (funcall matches last
(car alts
)))
1500 (funcall matches ch alts
))))
1501 (balance 0) (last 0)
1503 (mapc (lambda (ch) ; split on [], (), "" balanced instances of [ \t]:
1504 (setq balance
(+ balance
1505 (cond ((or (equal 91 ch
) (equal 40 ch
)) 1)
1506 ((or (equal 93 ch
) (equal 41 ch
)) -
1)
1508 (when (and (equal 34 ch
) (not (equal 92 last
)))
1509 (setq quote
(not quote
)))
1510 (setq partial
(cons ch partial
))
1511 (when (and (= balance
0) (not quote
) (funcall matched ch last
))
1512 (setq lst
(cons (apply #'string
(nreverse
1519 (string-to-list string
))
1520 (nreverse (cons (apply #'string
(nreverse partial
)) lst
))))
1522 (defun org-babel-join-splits-near-ch (ch list
)
1523 "Join splits where \"=\" is on either end of the split."
1524 (let ((last= (lambda (str) (= ch
(aref str
(1- (length str
))))))
1525 (first= (lambda (str) (= ch
(aref str
0)))))
1527 (org-reduce (lambda (acc el
)
1528 (let ((head (car acc
)))
1529 (if (and head
(or (funcall last
= head
) (funcall first
= el
)))
1530 (cons (concat head el
) (cdr acc
))
1532 list
:initial-value nil
))))
1534 (defun org-babel-parse-header-arguments (arg-string)
1535 "Parse a string of header arguments returning an alist."
1536 (when (> (length arg-string
) 0)
1537 (org-babel-parse-multiple-vars
1542 "\\([^ \f\t\n\r\v]+\\)[ \f\t\n\r\v]+\\([^ \f\t\n\r\v]+.*\\)"
1544 (cons (intern (match-string 1 arg
))
1545 (org-babel-read (org-babel-chomp (match-string 2 arg
))))
1546 (cons (intern (org-babel-chomp arg
)) nil
)))
1547 (let ((raw (org-babel-balanced-split arg-string
'((32 9) .
58))))
1548 (cons (car raw
) (mapcar (lambda (r) (concat ":" r
)) (cdr raw
)))))))))
1550 (defun org-babel-parse-multiple-vars (header-arguments)
1551 "Expand multiple variable assignments behind a single :var keyword.
1553 This allows expression of multiple variables with one :var as
1556 #+PROPERTY: var foo=1, bar=2"
1558 (mapc (lambda (pair)
1559 (if (eq (car pair
) :var
)
1560 (mapcar (lambda (v) (push (cons :var
(org-babel-trim v
)) results
))
1561 (org-babel-join-splits-near-ch
1562 61 (org-babel-balanced-split (cdr pair
) 32)))
1563 (push pair results
)))
1565 (nreverse results
)))
1567 (defun org-babel-process-params (params)
1568 "Expand variables in PARAMS and add summary parameters."
1569 (let* ((processed-vars (mapcar (lambda (el)
1570 (if (consp (cdr el
))
1572 (org-babel-ref-parse (cdr el
))))
1573 (org-babel-get-header params
:var
)))
1574 (vars-and-names (if (and (assoc :colname-names params
)
1575 (assoc :rowname-names params
))
1576 (list processed-vars
)
1577 (org-babel-disassemble-tables
1579 (cdr (assoc :hlines params
))
1580 (cdr (assoc :colnames params
))
1581 (cdr (assoc :rownames params
)))))
1582 (raw-result (or (cdr (assoc :results params
)) ""))
1583 (result-params (append
1584 (split-string (if (stringp raw-result
)
1587 (cdr (assoc :result-params params
)))))
1589 (mapcar (lambda (var) (cons :var var
)) (car vars-and-names
))
1591 (cons :colname-names
(or (cdr (assoc :colname-names params
))
1592 (cadr vars-and-names
)))
1593 (cons :rowname-names
(or (cdr (assoc :rowname-names params
))
1594 (caddr vars-and-names
)))
1595 (cons :result-params result-params
)
1596 (cons :result-type
(cond ((member "output" result-params
) 'output
)
1597 ((member "value" result-params
) 'value
)
1599 (org-babel-get-header params
:var
'other
))))
1601 ;; row and column names
1602 (defun org-babel-del-hlines (table)
1603 "Remove all 'hlines from TABLE."
1604 (remq 'hline table
))
1606 (defun org-babel-get-colnames (table)
1607 "Return the column names of TABLE.
1608 Return a cons cell, the `car' of which contains the TABLE less
1609 colnames, and the `cdr' of which contains a list of the column
1611 (if (equal 'hline
(nth 1 table
))
1612 (cons (cddr table
) (car table
))
1613 (cons (cdr table
) (car table
))))
1615 (defun org-babel-get-rownames (table)
1616 "Return the row names of TABLE.
1617 Return a cons cell, the `car' of which contains the TABLE less
1618 rownames, and the `cdr' of which contains a list of the rownames.
1619 Note: this function removes any hlines in TABLE."
1620 (let* ((table (org-babel-del-hlines table
))
1621 (rownames (funcall (lambda ()
1627 (setq tp
(cdr tp
))))
1629 (cons table rownames
)))
1631 (defun org-babel-put-colnames (table colnames
)
1632 "Add COLNAMES to TABLE if they exist."
1633 (if colnames
(apply 'list colnames
'hline table
) table
))
1635 (defun org-babel-put-rownames (table rownames
)
1636 "Add ROWNAMES to TABLE if they exist."
1638 (mapcar (lambda (row)
1640 (cons (or (pop rownames
) "") row
)
1644 (defun org-babel-pick-name (names selector
)
1645 "Select one out of an alist of row or column names.
1646 SELECTOR can be either a list of names in which case those names
1647 will be returned directly, or an index into the list NAMES in
1648 which case the indexed names will be return."
1649 (if (listp selector
)
1652 (if (and selector
(symbolp selector
) (not (equal t selector
)))
1653 (cdr (assoc selector names
))
1654 (if (integerp selector
)
1655 (nth (- selector
1) names
)
1656 (cdr (car (last names
))))))))
1658 (defun org-babel-disassemble-tables (vars hlines colnames rownames
)
1659 "Parse tables for further processing.
1660 Process the variables in VARS according to the HLINES,
1661 ROWNAMES and COLNAMES header arguments. Return a list consisting
1662 of the vars, cnames and rnames."
1663 (let (cnames rnames
)
1667 (when (listp (cdr var
))
1668 (when (and (not (equal colnames
"no"))
1669 (or colnames
(and (equal (nth 1 (cdr var
)) 'hline
)
1670 (not (member 'hline
(cddr (cdr var
)))))))
1671 (let ((both (org-babel-get-colnames (cdr var
))))
1672 (setq cnames
(cons (cons (car var
) (cdr both
))
1674 (setq var
(cons (car var
) (car both
)))))
1675 (when (and rownames
(not (equal rownames
"no")))
1676 (let ((both (org-babel-get-rownames (cdr var
))))
1677 (setq rnames
(cons (cons (car var
) (cdr both
))
1679 (setq var
(cons (car var
) (car both
)))))
1680 (when (and hlines
(not (equal hlines
"yes")))
1681 (setq var
(cons (car var
) (org-babel-del-hlines (cdr var
))))))
1684 (reverse cnames
) (reverse rnames
))))
1686 (defun org-babel-reassemble-table (table colnames rownames
)
1687 "Add column and row names to a table.
1688 Given a TABLE and set of COLNAMES and ROWNAMES add the names
1689 to the table for reinsertion to org-mode."
1691 (let ((table (if (and rownames
(= (length table
) (length rownames
)))
1692 (org-babel-put-rownames table rownames
) table
)))
1693 (if (and colnames
(listp (car table
)) (= (length (car table
))
1695 (org-babel-put-colnames table colnames
) table
))
1698 (defun org-babel-where-is-src-block-head ()
1699 "Find where the current source block begins.
1700 Return the point at the beginning of the current source
1701 block. Specifically at the beginning of the #+BEGIN_SRC line.
1702 If the point is not on a source block then return nil."
1703 (let ((initial (point)) (case-fold-search t
) top bottom
)
1705 (save-excursion ;; on a source name line or a #+header line
1706 (beginning-of-line 1)
1707 (and (or (looking-at org-babel-src-name-regexp
)
1708 (looking-at org-babel-multi-line-header-regexp
))
1710 (while (and (forward-line 1)
1711 (or (looking-at org-babel-src-name-regexp
)
1712 (looking-at org-babel-multi-line-header-regexp
))))
1713 (looking-at org-babel-src-block-regexp
))
1715 (save-excursion ;; on a #+begin_src line
1716 (beginning-of-line 1)
1717 (and (looking-at org-babel-src-block-regexp
)
1719 (save-excursion ;; inside a src block
1721 (re-search-backward "^[ \t]*#\\+begin_src" nil t
) (setq top
(point))
1722 (re-search-forward "^[ \t]*#\\+end_src" nil t
) (setq bottom
(point))
1723 (< top initial
) (< initial bottom
)
1724 (progn (goto-char top
) (beginning-of-line 1)
1725 (looking-at org-babel-src-block-regexp
))
1729 (defun org-babel-goto-src-block-head ()
1730 "Go to the beginning of the current code block."
1732 (let ((head (org-babel-where-is-src-block-head)))
1733 (if head
(goto-char head
) (error "Not currently in a code block"))))
1736 (defun org-babel-goto-named-src-block (name)
1737 "Go to a named source-code block."
1739 (let ((completion-ignore-case t
)
1740 (case-fold-search t
)
1741 (under-point (thing-at-point 'line
)))
1742 (list (org-icompleting-read
1743 "source-block name: " (org-babel-src-block-names) nil t
1746 ((string-match (org-babel-noweb-wrap) under-point
)
1747 (let ((block-name (match-string 1 under-point
)))
1748 (string-match "[^(]*" block-name
)
1749 (match-string 0 block-name
)))
1751 ((string-match org-babel-lob-one-liner-regexp under-point
)
1752 (let ((source-info (car (org-babel-lob-get-info))))
1753 (if (string-match "^\\([^\\[]+?\\)\\(\\[.*\\]\\)?(" source-info
)
1754 (let ((source-name (match-string 1 source-info
)))
1757 ((string-match (concat "#\\+" org-babel-results-keyword
1758 "\\:\s+\\([^\\(]*\\)") under-point
)
1759 (match-string 1 under-point
))
1761 ((and (thing-at-point 'symbol
))
1762 (org-babel-find-named-block (thing-at-point 'symbol
))
1763 (thing-at-point 'symbol
))
1765 (let ((point (org-babel-find-named-block name
)))
1767 ;; taken from `org-open-at-point'
1768 (progn (org-mark-ring-push) (goto-char point
) (org-show-context))
1769 (message "source-code block '%s' not found in this buffer" name
))))
1771 (defun org-babel-find-named-block (name)
1772 "Find a named source-code block.
1773 Return the location of the source block identified by source
1774 NAME, or nil if no such block exists. Set match data according to
1775 org-babel-named-src-block-regexp."
1777 (let ((case-fold-search t
)
1778 (regexp (org-babel-named-src-block-regexp-for-name name
)) msg
)
1779 (goto-char (point-min))
1780 (when (or (re-search-forward regexp nil t
)
1781 (re-search-backward regexp nil t
))
1782 (match-beginning 0)))))
1784 (defun org-babel-src-block-names (&optional file
)
1785 "Returns the names of source blocks in FILE or the current buffer."
1787 (when file
(find-file file
)) (goto-char (point-min))
1788 (let ((case-fold-search t
) names
)
1789 (while (re-search-forward org-babel-src-name-w-name-regexp nil t
)
1790 (setq names
(cons (match-string 3) names
)))
1794 (defun org-babel-goto-named-result (name)
1795 "Go to a named result."
1797 (let ((completion-ignore-case t
))
1798 (list (org-icompleting-read "source-block name: "
1799 (org-babel-result-names) nil t
))))
1800 (let ((point (org-babel-find-named-result name
)))
1802 ;; taken from `org-open-at-point'
1803 (progn (goto-char point
) (org-show-context))
1804 (message "result '%s' not found in this buffer" name
))))
1806 (defun org-babel-find-named-result (name &optional point
)
1807 "Find a named result.
1808 Return the location of the result named NAME in the current
1809 buffer or nil if no such result exists."
1811 (let ((case-fold-search t
))
1812 (goto-char (or point
(point-min)))
1813 (catch 'is-a-code-block
1814 (when (re-search-forward
1815 (concat org-babel-result-regexp
1816 "[ \t]" (regexp-quote name
) "[ \t]*[\n\f\v\r]") nil t
)
1817 (when (and (string= "name" (downcase (match-string 1)))
1818 (or (beginning-of-line 1)
1819 (looking-at org-babel-src-block-regexp
)
1820 (looking-at org-babel-multi-line-header-regexp
)
1821 (looking-at org-babel-lob-one-liner-regexp
)))
1822 (throw 'is-a-code-block
(org-babel-find-named-result name
(point))))
1823 (beginning-of-line 0) (point))))))
1825 (defun org-babel-result-names (&optional file
)
1826 "Returns the names of results in FILE or the current buffer."
1828 (when file
(find-file file
)) (goto-char (point-min))
1829 (let ((case-fold-search t
) names
)
1830 (while (re-search-forward org-babel-result-w-name-regexp nil t
)
1831 (setq names
(cons (match-string 4) names
)))
1835 (defun org-babel-next-src-block (&optional arg
)
1836 "Jump to the next source block.
1837 With optional prefix argument ARG, jump forward ARG many source blocks."
1839 (org-next-block arg nil org-babel-src-block-regexp
))
1842 (defun org-babel-previous-src-block (&optional arg
)
1843 "Jump to the previous source block.
1844 With optional prefix argument ARG, jump backward ARG many source blocks."
1846 (org-previous-block arg org-babel-src-block-regexp
))
1848 (defvar org-babel-load-languages
)
1851 (defun org-babel-mark-block ()
1852 "Mark current src block."
1854 (let ((head (org-babel-where-is-src-block-head)))
1858 (looking-at org-babel-src-block-regexp
))
1859 (push-mark (match-end 5) nil t
)
1860 (goto-char (match-beginning 5)))))
1862 (defun org-babel-demarcate-block (&optional arg
)
1863 "Wrap or split the code in the region or on the point.
1864 When called from inside of a code block the current block is
1865 split. When called from outside of a code block a new code block
1866 is created. In both cases if the region is demarcated and if the
1867 region is not active then the point is demarcated."
1869 (let* ((info (org-babel-get-src-block-info 'light
))
1870 (block (progn (org-babel-where-is-src-block-head) (match-string 0)))
1871 (headers (progn (org-babel-where-is-src-block-head) (match-string 4)))
1872 (stars (concat (make-string (or (org-current-level) 1) ?
*) " "))
1874 (if (let (case-fold-search) (string-match "#\\+begin_src" block
))
1875 (setq lower-case-p t
))
1881 (let ((lang (nth 0 info
))
1882 (indent (make-string (nth 5 info
) ?
)))
1883 (when (string-match "^[[:space:]]*$"
1884 (buffer-substring (point-at-bol)
1886 (delete-region (point-at-bol) (point-at-eol)))
1888 (if (looking-at "^") "" "\n")
1889 indent
(funcall (if lower-case-p
'downcase
'upcase
) "#+end_src\n")
1890 (if arg stars indent
) "\n"
1891 indent
(funcall (if lower-case-p
'downcase
'upcase
) "#+begin_src ")
1893 (if (> (length headers
) 1)
1894 (concat " " headers
) headers
)
1895 (if (looking-at "[\n\r]")
1897 (concat "\n" (make-string (current-column) ?
)))))))
1898 (move-end-of-line 2))
1899 (sort (if (org-region-active-p) (list (mark) (point)) (list (point))) #'>))
1900 (let ((start (point))
1901 (lang (org-icompleting-read
1903 (mapcar #'symbol-name
1905 (append (mapcar #'car org-babel-load-languages
)
1906 (mapcar (lambda (el) (intern (car el
)))
1907 org-src-lang-modes
))))))
1908 (body (delete-and-extract-region
1909 (if (org-region-active-p) (mark) (point)) (point))))
1910 (insert (concat (if (looking-at "^") "" "\n")
1911 (if arg
(concat stars
"\n") "")
1912 (funcall (if lower-case-p
'downcase
'upcase
) "#+begin_src ")
1915 (if (or (= (length body
) 0)
1916 (string-match "[\r\n]$" body
)) "" "\n")
1917 (funcall (if lower-case-p
'downcase
'upcase
) "#+end_src\n")))
1918 (goto-char start
) (move-end-of-line 1)))))
1920 (defvar org-babel-lob-one-liner-regexp
)
1921 (defun org-babel-where-is-src-block-result (&optional insert info hash indent
)
1922 "Find where the current source block results begin.
1923 Return the point at the beginning of the result of the current
1924 source block. Specifically at the beginning of the results line.
1925 If no result exists for this block then create a results line
1926 following the source block."
1928 (let* ((case-fold-search t
)
1929 (on-lob-line (save-excursion
1930 (beginning-of-line 1)
1931 (looking-at org-babel-lob-one-liner-regexp
)))
1932 (inlinep (when (org-babel-get-inline-src-block-matches)
1934 (name (nth 4 (or info
(org-babel-get-src-block-info 'light
))))
1935 (head (unless on-lob-line
(org-babel-where-is-src-block-head)))
1937 (when head
(goto-char head
))
1938 (org-with-wide-buffer
1940 found
;; was there a result (before we potentially insert one)
1945 ;; - return t if it is found, else return nil
1946 ;; - if it does not need to be rebuilt, then don't set end
1947 ;; - if it does need to be rebuilt then do set end
1948 name
(setq beg
(org-babel-find-named-result name
))
1950 (when (and hash
(not (string= hash
(match-string 5))))
1951 (goto-char beg
) (setq end beg
) ;; beginning of result
1953 (delete-region end
(org-babel-result-end)) nil
)))
1956 ;; - return t if it is found, else return nil
1957 ;; - if it is found, and the hash doesn't match, delete and set end
1958 (or on-lob-line
(re-search-forward "^[ \t]*#\\+end_src" nil t
))
1959 (progn (end-of-line 1)
1960 (if (eobp) (insert "\n") (forward-char 1))
1964 (progn ;; unnamed results line already exists
1966 (while (re-search-forward "[^ \f\t\n\r\v]" nil t
)
1967 (beginning-of-line 1)
1969 ((looking-at (concat org-babel-result-regexp
"\n"))
1970 (throw 'non-comment t
))
1971 ((and (looking-at "^[ \t]*#")
1973 org-babel-lob-one-liner-regexp
)))
1975 (t (throw 'non-comment nil
))))))
1976 (let ((this-hash (match-string 5)))
1978 ;; must remove and rebuild if hash!=old-hash
1979 (if (and hash
(not (string= hash this-hash
)))
1981 (setq end
(point-at-bol))
1983 (delete-region end
(org-babel-result-end))
1985 (setq end nil
))))))))))
1986 (if (not (and insert end
)) found
1989 (if (looking-at "[\n\r]") (forward-char 1) (insert "\n")))
1991 (when (wholenump indent
) (make-string indent ?
))
1992 "#+" org-babel-results-keyword
1994 (if org-babel-hash-show-time
1996 "["(format-time-string "<%Y-%m-%d %H:%M:%S>")" "hash
"]")
1997 (concat "["hash
"]")))
1999 (when name
(concat " " name
)) "\n"))
2000 (unless beg
(insert "\n") (backward-char))
2001 (beginning-of-line 0)
2002 (if hash
(org-babel-hide-hash))
2005 (defvar org-block-regexp
)
2006 (defun org-babel-read-result ()
2007 "Read the result at `point' into emacs-lisp."
2008 (let ((case-fold-search t
) result-string
)
2010 ((org-at-table-p) (org-babel-read-table))
2011 ((org-at-item-p) (org-babel-read-list))
2012 ((looking-at org-bracket-link-regexp
) (org-babel-read-link))
2013 ((looking-at org-block-regexp
) (org-remove-indentation (match-string 4)))
2014 ((or (looking-at "^[ \t]*: ") (looking-at "^[ \t]*:$"))
2017 (mapconcat (lambda (line)
2018 (or (and (> (length line
) 1)
2019 (string-match "^[ \t]*: ?\\(.+\\)" line
)
2020 (match-string 1 line
))
2024 (point) (org-babel-result-end)) "[\r\n]+")
2026 (or (org-babel-number-p result-string
) result-string
))
2027 ((looking-at org-babel-result-regexp
)
2028 (save-excursion (forward-line 1) (org-babel-read-result))))))
2030 (defun org-babel-read-table ()
2031 "Read the table at `point' into emacs-lisp."
2032 (mapcar (lambda (row)
2033 (if (and (symbolp row
) (equal row
'hline
)) row
2034 (mapcar (lambda (el) (org-babel-read el
'inhibit-lisp-eval
)) row
)))
2035 (org-table-to-lisp)))
2037 (defun org-babel-read-list ()
2038 "Read the list at `point' into emacs-lisp."
2039 (mapcar (lambda (el) (org-babel-read el
'inhibit-lisp-eval
))
2040 (mapcar #'cadr
(cdr (org-list-parse-list)))))
2042 (defvar org-link-types-re
)
2043 (defun org-babel-read-link ()
2044 "Read the link at `point' into emacs-lisp.
2045 If the path of the link is a file path it is expanded using
2046 `expand-file-name'."
2047 (let* ((case-fold-search t
)
2048 (raw (and (looking-at org-bracket-link-regexp
)
2049 (org-no-properties (match-string 1))))
2050 (type (and (string-match org-link-types-re raw
)
2051 (match-string 1 raw
))))
2053 ((not type
) (expand-file-name raw
))
2054 ((string= type
"file")
2055 (and (string-match "file\\(.*\\):\\(.+\\)" raw
)
2056 (expand-file-name (match-string 2 raw
))))
2059 (defun org-babel-format-result (result &optional sep
)
2060 "Format RESULT for writing to file."
2061 (let ((echo-res (lambda (r) (if (stringp r
) r
(format "%S" r
)))))
2065 result
(list :sep
(or sep
"\t") :fmt echo-res
))
2067 (funcall echo-res result
))))
2069 (defun org-babel-insert-result
2070 (result &optional result-params info hash indent lang
)
2071 "Insert RESULT into the current buffer.
2072 By default RESULT is inserted after the end of the
2073 current source block. With optional argument RESULT-PARAMS
2074 controls insertion of results in the org-mode file.
2075 RESULT-PARAMS can take the following values:
2077 replace - (default option) insert results after the source block
2078 replacing any previously inserted results
2080 silent -- no results are inserted into the Org-mode buffer but
2081 the results are echoed to the minibuffer and are
2082 ingested by Emacs (a potentially time consuming
2085 file ---- the results are interpreted as a file path, and are
2086 inserted into the buffer using the Org-mode file syntax
2088 list ---- the results are interpreted as an Org-mode list.
2090 raw ----- results are added directly to the Org-mode file. This
2091 is a good option if you code block will output org-mode
2094 drawer -- results are added directly to the Org-mode file as with
2095 \"raw\", but are wrapped in a RESULTS drawer, allowing
2096 them to later be replaced or removed automatically.
2098 org ----- results are added inside of a \"#+BEGIN_SRC org\" block.
2099 They are not comma-escaped when inserted, but Org syntax
2100 here will be discarded when exporting the file.
2102 html ---- results are added inside of a #+BEGIN_HTML block. This
2103 is a good option if you code block will output html
2106 latex --- results are added inside of a #+BEGIN_LATEX block.
2107 This is a good option if you code block will output
2108 latex formatted text.
2110 code ---- the results are extracted in the syntax of the source
2111 code of the language being evaluated and are added
2112 inside of a #+BEGIN_SRC block with the source-code
2113 language set appropriately. Note this relies on the
2114 optional LANG argument."
2115 (if (stringp result
)
2117 (setq result
(org-no-properties result
))
2118 (when (member "file" result-params
)
2119 (setq result
(org-babel-result-to-file
2120 result
(when (assoc :file-desc
(nth 2 info
))
2121 (or (cdr (assoc :file-desc
(nth 2 info
)))
2123 (unless (listp result
) (setq result
(format "%S" result
))))
2124 (if (and result-params
(member "silent" result-params
))
2126 (message (replace-regexp-in-string "%" "%%" (format "%S" result
)))
2131 (when (or (org-babel-get-inline-src-block-matches)
2132 (org-babel-get-lob-one-liner-matches))
2133 (goto-char (match-end 0))
2134 (insert (if (listp result
) "\n" " "))
2136 (existing-result (unless inlinep
2137 (org-babel-where-is-src-block-result
2138 t info hash indent
)))
2140 (cdr (assoc :results_switches
(nth 2 info
))))
2141 (visible-beg (copy-marker (point-min)))
2142 (visible-end (copy-marker (point-max)))
2143 ;; When results exist outside of the current visible
2144 ;; region of the buffer, be sure to widen buffer to
2146 (outside-scope-p (and existing-result
2147 (or (> visible-beg existing-result
)
2148 (<= visible-end existing-result
))))
2150 (when (and (stringp result
) ; ensure results end in a newline
2152 (> (length result
) 0)
2153 (not (or (string-equal (substring result -
1) "\n")
2154 (string-equal (substring result -
1) "\r"))))
2155 (setq result
(concat result
"\n")))
2158 (when outside-scope-p
(widen))
2159 (if (not existing-result
)
2160 (setq beg
(or inlinep
(point)))
2161 (goto-char existing-result
)
2163 (re-search-forward "#" nil t
)
2164 (setq indent
(- (current-column) 1)))
2168 ((member "replace" result-params
)
2169 (delete-region (point) (org-babel-result-end)))
2170 ((member "append" result-params
)
2171 (goto-char (org-babel-result-end)) (setq beg
(point-marker)))
2172 ((member "prepend" result-params
)))) ; already there
2173 (setq results-switches
2174 (if results-switches
(concat " " results-switches
) ""))
2175 (let ((wrap (lambda (start finish
&optional no-escape
)
2176 (goto-char end
) (insert (concat finish
"\n"))
2177 (goto-char beg
) (insert (concat start
"\n"))
2179 (org-escape-code-in-region (min (point) end
) end
))
2180 (goto-char end
) (goto-char (point-at-eol))
2181 (setq end
(point-marker))))
2182 (proper-list-p (lambda (it) (and (listp it
) (null (cdr (last it
)))))))
2183 ;; insert results based on type
2185 ;; do nothing for an empty result
2187 ;; insert a list if preferred
2188 ((member "list" result-params
)
2191 (org-list-to-generic
2194 (lambda (el) (list nil
(if (stringp el
) el
(format "%S" el
))))
2195 (if (listp result
) result
(split-string result
"\n" t
))))
2196 '(:splicep nil
:istart
"- " :iend
"\n")))
2198 ;; assume the result is a table if it's not a string
2199 ((funcall proper-list-p result
)
2201 (insert (concat (orgtbl-to-orgtbl
2203 (lambda (el) (or (listp el
) (eq el
'hline
)))
2205 result
(list result
))
2206 '(:fmt
(lambda (cell) (format "%s" cell
)))) "\n"))
2207 (goto-char beg
) (when (org-at-table-p) (org-table-align)))
2208 ((and (listp result
) (not (funcall proper-list-p result
)))
2209 (insert (format "%s\n" result
)))
2210 ((member "file" result-params
)
2211 (when inlinep
(goto-char inlinep
))
2213 (t (goto-char beg
) (insert result
)))
2214 (when (funcall proper-list-p result
) (goto-char (org-table-end)))
2215 (setq end
(point-marker))
2216 ;; possibly wrap result
2218 ((assoc :wrap
(nth 2 info
))
2219 (let ((name (or (cdr (assoc :wrap
(nth 2 info
))) "RESULTS")))
2220 (funcall wrap
(concat "#+BEGIN_" name
)
2221 (concat "#+END_" (car (org-split-string name
))))))
2222 ((member "html" result-params
)
2223 (funcall wrap
"#+BEGIN_HTML" "#+END_HTML"))
2224 ((member "latex" result-params
)
2225 (funcall wrap
"#+BEGIN_LaTeX" "#+END_LaTeX"))
2226 ((member "org" result-params
)
2227 (goto-char beg
) (if (org-at-table-p) (org-cycle))
2228 (funcall wrap
"#+BEGIN_SRC org" "#+END_SRC"))
2229 ((member "code" result-params
)
2230 (funcall wrap
(format "#+BEGIN_SRC %s%s" (or lang
"none") results-switches
)
2232 ((member "raw" result-params
)
2233 (goto-char beg
) (if (org-at-table-p) (org-cycle)))
2234 ((or (member "drawer" result-params
)
2235 ;; Stay backward compatible with <7.9.2
2236 (member "wrap" result-params
))
2237 (goto-char beg
) (if (org-at-table-p) (org-cycle))
2238 (funcall wrap
":RESULTS:" ":END:" 'no-escape
))
2239 ((and (not (funcall proper-list-p result
))
2240 (not (member "file" result-params
)))
2241 (org-babel-examplify-region beg end results-switches
)
2242 (setq end
(point)))))
2243 ;; possibly indent the results to match the #+results line
2244 (when (and (not inlinep
) (numberp indent
) indent
(> indent
0)
2245 ;; in this case `table-align' does the work for us
2246 (not (and (listp result
)
2247 (member "append" result-params
))))
2248 (indent-rigidly beg end indent
))
2250 (if (member "value" result-params
)
2251 (message "Code block returned no value.")
2252 (message "Code block produced no output."))
2253 (message "Code block evaluation complete.")))
2254 (when outside-scope-p
(narrow-to-region visible-beg visible-end
))
2255 (set-marker visible-beg nil
)
2256 (set-marker visible-end nil
))))))
2258 (defun org-babel-remove-result (&optional info keep-keyword
)
2259 "Remove the result of the current source block."
2261 (let ((location (org-babel-where-is-src-block-result nil info
)))
2264 (goto-char location
)
2265 (when (looking-at (concat org-babel-result-regexp
".*$"))
2267 (if keep-keyword
(1+ (match-end 0)) (1- (match-beginning 0)))
2268 (progn (forward-line 1) (org-babel-result-end))))))))
2270 (defun org-babel-remove-result-one-or-many (x)
2271 "Remove the result of the current source block.
2272 If called with a prefix argument, remove all result blocks
2276 (org-babel-map-src-blocks nil
(org-babel-remove-result))
2277 (org-babel-remove-result)))
2279 (defun org-babel-result-end ()
2280 "Return the point at the end of the current set of results."
2283 ((org-at-table-p) (progn (goto-char (org-table-end)) (point)))
2284 ((org-at-item-p) (let* ((struct (org-list-struct))
2285 (prvs (org-list-prevs-alist struct
)))
2286 (org-list-get-list-end (point-at-bol) struct prvs
)))
2287 ((let ((case-fold-search t
)) (looking-at "^\\([ \t]*\\):results:"))
2288 (progn (re-search-forward (concat "^" (match-string 1) ":END:"))
2289 (forward-char 1) (point)))
2291 (let ((case-fold-search t
))
2292 (if (looking-at (concat "[ \t]*#\\+begin_\\([^ \t\n\r]+\\)"))
2293 (progn (re-search-forward (concat "[ \t]*#\\+end_" (match-string 1))
2296 (while (looking-at "[ \t]*\\(: \\|:$\\|\\[\\[\\)")
2300 (defun org-babel-result-to-file (result &optional description
)
2301 "Convert RESULT into an `org-mode' link with optional DESCRIPTION.
2302 If the `default-directory' is different from the containing
2303 file's directory then expand relative links."
2304 (when (stringp result
)
2305 (format "[[file:%s]%s]"
2306 (if (and default-directory
2308 (not (string= (expand-file-name default-directory
)
2310 (file-name-directory buffer-file-name
)))))
2311 (expand-file-name result default-directory
)
2313 (if description
(concat "[" description
"]") ""))))
2315 (defvar org-babel-capitalize-example-region-markers nil
2316 "Make true to capitalize begin/end example markers inserted by code blocks.")
2318 (define-obsolete-function-alias
2319 'org-babel-examplize-region
2320 'org-babel-examplify-region
"24.5")
2322 (defun org-babel-examplify-region (beg end
&optional results-switches
)
2323 "Comment out region using the inline '==' or ': ' org example quote."
2325 (let ((chars-between (lambda (b e
)
2326 (not (string-match "^[\\s]*$"
2327 (buffer-substring b e
)))))
2328 (maybe-cap (lambda (str) (if org-babel-capitalize-example-region-markers
2330 (beg-bol (save-excursion (goto-char beg
) (point-at-bol)))
2331 (end-bol (save-excursion (goto-char end
) (point-at-bol)))
2332 (end-eol (save-excursion (goto-char end
) (point-at-eol))))
2333 (if (and (not (= end end-bol
))
2334 (or (funcall chars-between beg-bol beg
)
2335 (funcall chars-between end end-eol
)))
2338 (insert (format org-babel-inline-result-wrap
2339 (prog1 (buffer-substring beg end
)
2340 (delete-region beg end
)))))
2341 (let ((size (count-lines beg end
)))
2343 (cond ((= size
0)) ; do nothing for an empty result
2344 ((< size org-babel-min-lines-for-block-output
)
2347 (beginning-of-line 1) (insert ": ") (forward-line 1)))
2350 (insert (if results-switches
2352 (funcall maybe-cap
"#+begin_example")
2354 (funcall maybe-cap
"#+begin_example\n")))
2355 (if (markerp end
) (goto-char end
) (forward-char (- end beg
)))
2356 (insert (funcall maybe-cap
"#+end_example\n")))))))))
2358 (defun org-babel-update-block-body (new-body)
2359 "Update the body of the current code block to NEW-BODY."
2360 (if (not (org-babel-where-is-src-block-head))
2361 (error "Not in a source block")
2363 (replace-match (concat (org-babel-trim (org-remove-indentation new-body
))
2365 (indent-rigidly (match-beginning 5) (match-end 5) 2)))
2367 (defun org-babel-merge-params (&rest plists
)
2368 "Combine all parameter association lists in PLISTS.
2369 Later elements of PLISTS override the values of previous elements.
2370 This takes into account some special considerations for certain
2371 parameters when merging lists."
2372 (let* ((results-exclusive-groups
2373 (mapcar (lambda (group) (mapcar #'symbol-name group
))
2374 (cdr (assoc 'results org-babel-common-header-args-w-values
))))
2375 (exports-exclusive-groups
2376 (mapcar (lambda (group) (mapcar #'symbol-name group
))
2377 (cdr (assoc 'exports org-babel-common-header-args-w-values
))))
2379 (e-merge (lambda (exclusive-groups &rest result-params
)
2380 ;; maintain exclusivity of mutually exclusive parameters
2382 (mapc (lambda (new-params)
2383 (mapc (lambda (new-param)
2384 (mapc (lambda (exclusive-group)
2385 (when (member new-param exclusive-group
)
2386 (mapcar (lambda (excluded-param)
2393 (setq output
(org-uniquify
2394 (cons new-param output
))))
2398 params results exports tangle noweb cache vars shebang comments padline
2407 (let ((name (if (listp (cdr pair
))
2409 (and (string-match "^\\([^= \f\t\n\r\v]+\\)[ \t]*="
2411 (intern (match-string 1 (cdr pair
)))))))
2415 (if (member name
(mapcar #'car vars
))
2417 (push name clearnames
)
2421 (unless (equal (car p
) name
) p
))
2424 (list (cons name pair
))))
2425 ;; if no name is given and we already have named variables
2426 ;; then assign to named variables in order
2427 (if (and vars
(nth variable-index vars
))
2428 (let ((name (car (nth variable-index vars
))))
2429 (push name clearnames
) ; clear out colnames
2432 (prog1 (setf (cddr (nth variable-index vars
))
2433 (concat (symbol-name name
) "=" (cdr pair
)))
2434 (incf variable-index
)))
2435 (error "Variable \"%s\" must be assigned a default value"
2438 (setq results
(funcall e-merge results-exclusive-groups
2441 (let ((r (cdr pair
)))
2442 (if (stringp r
) r
(eval r
)))))))
2445 (setq results
(funcall e-merge results-exclusive-groups
2447 (unless (or (member "both" exports
)
2448 (member "none" exports
)
2449 (member "code" exports
))
2450 (setq exports
(funcall e-merge exports-exclusive-groups
2451 exports
'("results"))))
2452 (setq params
(cons pair
(assq-delete-all (car pair
) params
)))))
2455 (setq results
(funcall e-merge results-exclusive-groups
2457 (unless (or (member "both" exports
)
2458 (member "none" exports
)
2459 (member "code" exports
))
2460 (setq exports
(funcall e-merge exports-exclusive-groups
2461 exports
'("results"))))
2462 (setq params
(cons pair
(assq-delete-all (car pair
) params
)))))
2464 (setq exports
(funcall e-merge exports-exclusive-groups
2465 exports
(split-string (cdr pair
)))))
2466 (:tangle
;; take the latest -- always overwrite
2467 (setq tangle
(or (list (cdr pair
)) tangle
)))
2469 (setq noweb
(funcall e-merge
2470 '(("yes" "no" "tangle" "no-export"
2471 "strip-export" "eval"))
2473 (split-string (or (cdr pair
) "")))))
2475 (setq cache
(funcall e-merge
'(("yes" "no")) cache
2476 (split-string (or (cdr pair
) "")))))
2478 (setq padline
(funcall e-merge
'(("yes" "no")) padline
2479 (split-string (or (cdr pair
) "")))))
2480 (:shebang
;; take the latest -- always overwrite
2481 (setq shebang
(or (list (cdr pair
)) shebang
)))
2483 (setq comments
(funcall e-merge
'(("yes" "no")) comments
2484 (split-string (or (cdr pair
) "")))))
2485 (t ;; replace: this covers e.g. :session
2486 (setq params
(cons pair
(assq-delete-all (car pair
) params
))))))
2489 (setq vars
(reverse vars
))
2490 (while vars
(setq params
(cons (cons :var
(cddr (pop vars
))) params
)))
2491 ;; clear out col-names and row-names for replaced variables
2496 (when (assoc param params
)
2497 (setf (cdr (assoc param params
))
2498 (org-remove-if (lambda (pair) (equal (car pair
) name
))
2499 (cdr (assoc param params
))))
2500 (setf params
(org-remove-if (lambda (pair) (and (equal (car pair
) param
)
2503 (list :colname-names
:rowname-names
)))
2507 (let ((key (intern (concat ":" (symbol-name hd
))))
2509 (setf params
(cons (cons key
(mapconcat 'identity val
" ")) params
))))
2510 '(results exports tangle noweb padline cache shebang comments
))
2513 (defvar org-babel-use-quick-and-dirty-noweb-expansion nil
2514 "Set to true to use regular expressions to expand noweb references.
2515 This results in much faster noweb reference expansion but does
2516 not properly allow code blocks to inherit the \":noweb-ref\"
2517 header argument from buffer or subtree wide properties.")
2519 (defun org-babel-noweb-p (params context
)
2520 "Check if PARAMS require expansion in CONTEXT.
2521 CONTEXT may be one of :tangle, :export or :eval."
2523 (intersect (lambda (as bs
)
2525 (if (member (car as
) bs
)
2527 (funcall intersect
(cdr as
) bs
))))))
2528 (funcall intersect
(case context
2529 (:tangle
'("yes" "tangle" "no-export" "strip-export"))
2530 (:eval
'("yes" "no-export" "strip-export" "eval"))
2532 (split-string (or (cdr (assoc :noweb params
)) "")))))
2534 (defun org-babel-expand-noweb-references (&optional info parent-buffer
)
2535 "Expand Noweb references in the body of the current source code block.
2537 For example the following reference would be replaced with the
2538 body of the source-code block named 'example-block'.
2542 Note that any text preceding the <<foo>> construct on a line will
2543 be interposed between the lines of the replacement text. So for
2544 example if <<foo>> is placed behind a comment, then the entire
2545 replacement text will also be commented.
2547 This function must be called from inside of the buffer containing
2548 the source-code block which holds BODY.
2550 In addition the following syntax can be used to insert the
2551 results of evaluating the source-code block named 'example-block'.
2555 Any optional arguments can be passed to example-block by placing
2556 the arguments inside the parenthesis following the convention
2557 defined by `org-babel-lob'. For example
2559 <<example-block(a=9)>>
2561 would set the value of argument \"a\" equal to \"9\". Note that
2562 these arguments are not evaluated in the current source-code
2563 block but are passed literally to the \"example-block\"."
2564 (let* ((parent-buffer (or parent-buffer
(current-buffer)))
2565 (info (or info
(org-babel-get-src-block-info 'light
)))
2568 (ob-nww-start org-babel-noweb-wrap-start
)
2569 (ob-nww-end org-babel-noweb-wrap-end
)
2570 (comment (string= "noweb" (cdr (assoc :comments
(nth 2 info
)))))
2571 (rx-prefix (concat "\\(" org-babel-src-name-regexp
"\\|"
2572 ":noweb-ref[ \t]+" "\\)"))
2574 (nb-add (lambda (text) (setq new-body
(concat new-body text
))))
2575 (c-wrap (lambda (text)
2577 (funcall (intern (concat lang
"-mode")))
2578 (comment-region (point) (progn (insert text
) (point)))
2579 (org-babel-trim (buffer-string)))))
2580 index source-name evaluate prefix
)
2582 (org-set-local 'org-babel-noweb-wrap-start ob-nww-start
)
2583 (org-set-local 'org-babel-noweb-wrap-end ob-nww-end
)
2584 (insert body
) (goto-char (point-min))
2585 (setq index
(point))
2586 (while (and (re-search-forward (org-babel-noweb-wrap) nil t
))
2587 (save-match-data (setf source-name
(match-string 1)))
2588 (save-match-data (setq evaluate
(string-match "\(.*\)" source-name
)))
2591 (buffer-substring (match-beginning 0)
2593 (beginning-of-line 1) (point)))))
2594 ;; add interval to new-body (removing noweb reference)
2595 (goto-char (match-beginning 0))
2596 (funcall nb-add
(buffer-substring index
(point)))
2597 (goto-char (match-end 0))
2598 (setq index
(point))
2601 (with-current-buffer parent-buffer
2604 (mapconcat ;; Interpose PREFIX between every line.
2608 (let ((raw (org-babel-ref-resolve source-name
)))
2609 (if (stringp raw
) raw
(format "%S" raw
)))
2611 ;; Retrieve from the library of babel.
2612 (nth 2 (assoc (intern source-name
)
2613 org-babel-library-of-babel
))
2614 ;; Return the contents of headlines literally.
2616 (when (org-babel-ref-goto-headline-id source-name
)
2617 (org-babel-ref-headline-body)))
2618 ;; Find the expansion of reference in this buffer.
2619 (let ((rx (concat rx-prefix source-name
"[ \t\n]"))
2622 (goto-char (point-min))
2623 (if org-babel-use-quick-and-dirty-noweb-expansion
2624 (while (re-search-forward rx nil t
)
2625 (let* ((i (org-babel-get-src-block-info 'light
))
2626 (body (org-babel-expand-noweb-references i
))
2627 (sep (or (cdr (assoc :noweb-sep
(nth 2 i
)))
2630 (let ((cs (org-babel-tangle-comment-links i
)))
2631 (concat (funcall c-wrap
(car cs
)) "\n"
2633 (funcall c-wrap
(cadr cs
))))
2635 (setq expansion
(cons sep
(cons full expansion
)))))
2636 (org-babel-map-src-blocks nil
2637 (let ((i (org-babel-get-src-block-info 'light
)))
2638 (when (equal (or (cdr (assoc :noweb-ref
(nth 2 i
)))
2641 (let* ((body (org-babel-expand-noweb-references i
))
2642 (sep (or (cdr (assoc :noweb-sep
(nth 2 i
)))
2645 (let ((cs (org-babel-tangle-comment-links i
)))
2646 (concat (funcall c-wrap
(car cs
)) "\n"
2648 (funcall c-wrap
(cadr cs
))))
2651 (cons sep
(cons full expansion
)))))))))
2653 (mapconcat #'identity
(nreverse (cdr expansion
)) "")))
2654 ;; Possibly raise an error if named block doesn't exist.
2655 (if (or org-babel-noweb-error-all-langs
2656 (member lang org-babel-noweb-error-langs
))
2658 (org-babel-noweb-wrap source-name
)
2659 "could not be resolved (see "
2660 "`org-babel-noweb-error-langs')"))
2662 "[\n\r]") (concat "\n" prefix
))))))
2663 (funcall nb-add
(buffer-substring index
(point-max))))
2666 (defun org-babel-script-escape (str &optional force
)
2667 "Safely convert tables into elisp lists."
2672 (or (and (string-equal "[" (substring str
0 1))
2673 (string-equal "]" (substring str -
1)))
2674 (and (string-equal "{" (substring str
0 1))
2675 (string-equal "}" (substring str -
1)))
2676 (and (string-equal "(" (substring str
0 1))
2677 (string-equal ")" (substring str -
1))))))
2681 (let (in-single in-double out
)
2687 (91 (if (or in-double in-single
) ; [
2690 (93 (if (or in-double in-single
) ; ]
2693 (123 (if (or in-double in-single
) ; {
2696 (125 (if (or in-double in-single
) ; }
2699 (44 (if (or in-double in-single
) ; ,
2700 (cons 44 out
) (cons 32 out
)))
2701 (39 (if in-double
; '
2703 (setq in-single
(not in-single
)) (cons 34 out
)))
2704 (34 (if in-single
; "
2705 (append (list 34 32) out
)
2706 (setq in-double
(not in-double
)) (cons 34 out
)))
2707 (t (cons ch out
)))))
2708 (string-to-list str
))
2709 (apply #'string
(reverse out
)))))
2711 (condition-case nil
(org-babel-read escaped
) (error escaped
))))
2713 (defun org-babel-read (cell &optional inhibit-lisp-eval
)
2714 "Convert the string value of CELL to a number if appropriate.
2715 Otherwise if cell looks like lisp (meaning it starts with a
2716 \"(\", \"'\", \"`\" or a \"[\") then read it as lisp,
2717 otherwise return it unmodified as a string. Optional argument
2718 NO-LISP-EVAL inhibits lisp evaluation for situations in which is
2719 it not appropriate."
2720 (if (and (stringp cell
) (not (equal cell
"")))
2721 (or (org-babel-number-p cell
)
2722 (if (and (not inhibit-lisp-eval
)
2723 (or (member (substring cell
0 1) '("(" "'" "`" "["))
2724 (string= cell
"*this*")))
2726 (if (string= (substring cell
0 1) "\"")
2728 (progn (set-text-properties 0 (length cell
) nil cell
) cell
))))
2731 (defun org-babel-number-p (string)
2732 "If STRING represents a number return its value."
2733 (if (and (string-match "[0-9]+" string
)
2734 (string-match "^-?[0-9]*\\.?[0-9]*$" string
)
2735 (= (length (substring string
(match-beginning 0)
2738 (string-to-number string
)))
2740 (defun org-babel-import-elisp-from-file (file-name &optional separator
)
2741 "Read the results located at FILE-NAME into an elisp table.
2742 If the table is trivial, then return it as a scalar."
2744 (save-window-excursion
2748 (org-table-import file-name separator
)
2749 (delete-file file-name
)
2750 (setq result
(mapcar (lambda (row)
2751 (mapcar #'org-babel-string-read row
))
2752 (org-table-to-lisp))))
2753 (error (message "Error reading results: %s" err
) nil
)))
2754 (if (null (cdr result
)) ;; if result is trivial vector, then scalarize it
2755 (if (consp (car result
))
2756 (if (null (cdr (car result
)))
2762 (defun org-babel-string-read (cell)
2763 "Strip nested \"s from around strings."
2764 (org-babel-read (or (and (stringp cell
)
2765 (string-match "\\\"\\(.+\\)\\\"" cell
)
2766 (match-string 1 cell
))
2769 (defun org-babel-chomp (string &optional regexp
)
2770 "Strip a trailing space or carriage return from STRING.
2771 The default regexp used is \"[ \\f\\t\\n\\r\\v]\" but another one
2772 can be specified as the REGEXP argument."
2773 (let ((regexp (or regexp
"[ \f\t\n\r\v]")))
2774 (while (and (> (length string
) 0)
2775 (string-match regexp
(substring string -
1)))
2776 (setq string
(substring string
0 -
1)))
2779 (defun org-babel-trim (string &optional regexp
)
2780 "Strip a leading and trailing space or carriage return from STRING.
2781 Like `org-babel-chomp', but run on both the first and last
2782 character of the string."
2785 (org-babel-chomp (org-reverse-string string
) regexp
)) regexp
))
2787 (defun org-babel-tramp-handle-call-process-region
2788 (start end program
&optional delete buffer display
&rest args
)
2789 "Use Tramp to handle `call-process-region'.
2790 Fixes a bug in `tramp-handle-call-process-region'."
2791 (if (and (featurep 'tramp
) (file-remote-p default-directory
))
2792 (let ((tmpfile (tramp-compat-make-temp-file "")))
2793 (write-region start end tmpfile
)
2794 (when delete
(delete-region start end
))
2796 ;; (apply 'call-process program tmpfile buffer display args)
2798 (apply 'process-file program tmpfile buffer display args
)
2799 (delete-file tmpfile
)))
2800 ;; org-babel-call-process-region-original is the original emacs
2801 ;; definition. It is in scope from the let binding in
2802 ;; org-babel-execute-src-block
2803 (apply org-babel-call-process-region-original
2804 start end program delete buffer display args
)))
2806 (defun org-babel-local-file-name (file)
2807 "Return the local name component of FILE."
2808 (or (file-remote-p file
'localname
) file
))
2810 (defun org-babel-process-file-name (name &optional no-quote-p
)
2811 "Prepare NAME to be used in an external process.
2812 If NAME specifies a remote location, the remote portion of the
2813 name is removed, since in that case the process will be executing
2814 remotely. The file name is then processed by `expand-file-name'.
2815 Unless second argument NO-QUOTE-P is non-nil, the file name is
2816 additionally processed by `shell-quote-argument'"
2817 (let ((f (org-babel-local-file-name (expand-file-name name
))))
2818 (if no-quote-p f
(shell-quote-argument f
))))
2820 (defvar org-babel-temporary-directory
)
2821 (unless (or noninteractive
(boundp 'org-babel-temporary-directory
))
2822 (defvar org-babel-temporary-directory
2823 (or (and (boundp 'org-babel-temporary-directory
)
2824 (file-exists-p org-babel-temporary-directory
)
2825 org-babel-temporary-directory
)
2826 (make-temp-file "babel-" t
))
2827 "Directory to hold temporary files created to execute code blocks.
2828 Used by `org-babel-temp-file'. This directory will be removed on
2831 (defcustom org-babel-remote-temporary-directory
"/tmp/"
2832 "Directory to hold temporary files on remote hosts."
2836 (defmacro org-babel-result-cond
(result-params scalar-form
&rest table-forms
)
2837 "Call the code to parse raw string results according to RESULT-PARAMS."
2839 (debug (form form
&rest form
)))
2840 (org-with-gensyms (params)
2841 `(let ((,params
,result-params
))
2842 (unless (member "none" ,params
)
2843 (if (or (member "scalar" ,params
)
2844 (member "verbatim" ,params
)
2845 (member "html" ,params
)
2846 (member "code" ,params
)
2847 (member "pp" ,params
)
2848 (and (or (member "output" ,params
)
2849 (member "raw" ,params
)
2850 (member "org" ,params
)
2851 (member "drawer" ,params
))
2852 (not (member "table" ,params
))))
2855 (def-edebug-spec org-babel-result-cond
(form form body
))
2857 (defun org-babel-temp-file (prefix &optional suffix
)
2858 "Create a temporary file in the `org-babel-temporary-directory'.
2859 Passes PREFIX and SUFFIX directly to `make-temp-file' with the
2860 value of `temporary-file-directory' temporarily set to the value
2861 of `org-babel-temporary-directory'."
2862 (if (file-remote-p default-directory
)
2864 (concat (file-remote-p default-directory
)
2866 prefix org-babel-remote-temporary-directory
))))
2867 (make-temp-file prefix nil suffix
))
2868 (let ((temporary-file-directory
2869 (or (and (boundp 'org-babel-temporary-directory
)
2870 (file-exists-p org-babel-temporary-directory
)
2871 org-babel-temporary-directory
)
2872 temporary-file-directory
)))
2873 (make-temp-file prefix nil suffix
))))
2875 (defun org-babel-remove-temporary-directory ()
2876 "Remove `org-babel-temporary-directory' on Emacs shutdown."
2877 (when (and (boundp 'org-babel-temporary-directory
)
2878 (file-exists-p org-babel-temporary-directory
))
2879 ;; taken from `delete-directory' in files.el
2882 (mapc (lambda (file)
2883 ;; This test is equivalent to
2884 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2885 ;; but more efficient
2886 (if (eq t
(car (file-attributes file
)))
2887 (delete-directory file
)
2888 (delete-file file
)))
2889 ;; We do not want to delete "." and "..".
2890 (directory-files org-babel-temporary-directory
'full
2891 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"))
2892 (delete-directory org-babel-temporary-directory
))
2894 (message "Failed to remove temporary Org-babel directory %s"
2895 (if (boundp 'org-babel-temporary-directory
)
2896 org-babel-temporary-directory
2897 "[directory not defined]"))))))
2899 (add-hook 'kill-emacs-hook
'org-babel-remove-temporary-directory
)
2901 (defun org-babel-one-header-arg-safe-p (pair safe-list
)
2902 "Determine if the PAIR is a safe babel header arg according to SAFE-LIST.
2904 For the format of SAFE-LIST, see `org-babel-safe-header-args'."
2906 (keywordp (car pair
))
2907 (stringp (cdr pair
))
2909 (memq (car pair
) safe-list
)
2910 (let ((entry (assq (car pair
) safe-list
)))
2913 (cond ((functionp (cdr entry
))
2914 (funcall (cdr entry
) (cdr pair
)))
2915 ((listp (cdr entry
))
2916 (member (cdr pair
) (cdr entry
)))
2919 (defun org-babel-generate-file-param (src-name params
)
2920 "Calculate the filename for source block results.
2922 The directory is calculated from the :output-dir property of the
2923 source block; if not specified, use the current directory.
2925 If the source block has a #+NAME and the :file parameter does not
2926 contain any period characters, then the :file parameter is
2927 treated as an extension, and the output file name is the
2928 concatenation of the directory (as calculated above), the block
2929 name, a period, and the parameter value as a file extension.
2930 Otherwise, the :file parameter is treated as a full file name,
2931 and the output file name is the directory (as calculated above)
2932 plus the parameter value."
2933 (let* ((file-cons (assq :file params
))
2934 (file-ext-cons (assq :file-ext params
))
2935 (file-ext (cdr-safe file-ext-cons
))
2936 (dir (cdr-safe (assq :output-dir params
)))
2938 ;; create the output-dir if it does not exist
2940 (make-directory dir t
))
2942 ;; :file given; add :output-dir if given
2944 (setcdr file-cons
(concat (file-name-as-directory dir
) (cdr file-cons
))))
2945 ;; :file not given; compute from name and :file-ext if possible
2946 (when (and src-name file-ext
)
2948 (setq fname
(concat (file-name-as-directory (or dir
""))
2949 src-name
"." file-ext
))
2950 (setq fname
(concat src-name
"." file-ext
)))
2951 (setq params
(cons (cons :file fname
) params
))))
2954 ;;; Used by backends: R, Maxima, Octave.
2955 (defun org-babel-graphical-output-file (params)
2956 "File where a babel block should send graphical output, per PARAMS."
2957 (unless (assq :file params
)
2958 (if (assq :file-ext params
)
2959 (user-error ":file-ext given but no :file generated; did you forget to give a block a #+NAME?")
2960 (user-error "No :file header argument given; cannot create graphical result.")))
2961 (and (member "graphics" (cdr (assq :result-params params
)))
2962 (cdr (assq :file params
))))
2967 ;; generated-autoload-file: "org-loaddefs.el"
2970 ;;; ob-core.el ends here
