1 ;;; ob-core.el --- Working with Code Blocks -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2009-2017 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/>.
31 (defconst org-babel-exeext
32 (if (memq system-type
'(windows-nt cygwin
))
36 (defvar org-babel-library-of-babel
)
37 (defvar org-edit-src-content-indentation
)
38 (defvar org-src-lang-modes
)
39 (defvar org-src-preserve-indentation
)
41 (declare-function org-at-item-p
"org-list" ())
42 (declare-function org-at-table-p
"org" (&optional table-type
))
43 (declare-function org-babel-lob-execute-maybe
"ob-lob" ())
44 (declare-function org-babel-ref-goto-headline-id
"ob-ref" (id))
45 (declare-function org-babel-ref-headline-body
"ob-ref" ())
46 (declare-function org-babel-ref-parse
"ob-ref" (assignment))
47 (declare-function org-babel-ref-resolve
"ob-ref" (ref))
48 (declare-function org-babel-ref-split-args
"ob-ref" (arg-string))
49 (declare-function org-babel-tangle-comment-links
"ob-tangle" (&optional info
))
50 (declare-function org-completing-read
"org" (&rest args
))
51 (declare-function org-current-level
"org" ())
52 (declare-function org-cycle
"org" (&optional arg
))
53 (declare-function org-do-remove-indentation
"org" (&optional n
))
54 (declare-function org-edit-src-code
"org-src" (&optional code edit-buffer-name
))
55 (declare-function org-edit-src-exit
"org-src" ())
56 (declare-function org-element-at-point
"org-element" ())
57 (declare-function org-element-context
"org-element" (&optional element
))
58 (declare-function org-element-normalize-string
"org-element" (s))
59 (declare-function org-element-property
"org-element" (property element
))
60 (declare-function org-element-type
"org-element" (element))
61 (declare-function org-entry-get
"org" (pom property
&optional inherit literal-nil
))
62 (declare-function org-escape-code-in-region
"org-src" (beg end
))
63 (declare-function org-get-indentation
"org" (&optional line
))
64 (declare-function org-get-indentation
"org" (&optional line
))
65 (declare-function org-in-regexp
"org" (regexp &optional nlines visually
))
66 (declare-function org-indent-line
"org" ())
67 (declare-function org-list-get-list-end
"org-list" (item struct prevs
))
68 (declare-function org-list-prevs-alist
"org-list" (struct))
69 (declare-function org-list-struct
"org-list" ())
70 (declare-function org-list-to-generic
"org-list" (LIST PARAMS
))
71 (declare-function org-list-to-lisp
"org-list" (&optional delete
))
72 (declare-function org-macro-escape-arguments
"org-macro" (&rest args
))
73 (declare-function org-make-options-regexp
"org" (kwds &optional extra
))
74 (declare-function org-mark-ring-push
"org" (&optional pos buffer
))
75 (declare-function org-narrow-to-subtree
"org" ())
76 (declare-function org-next-block
"org" (arg &optional backward block-regexp
))
77 (declare-function org-number-sequence
"org-compat" (from &optional to inc
))
78 (declare-function org-open-at-point
"org" (&optional in-emacs reference-buffer
))
79 (declare-function org-outline-overlay-data
"org" (&optional use-markers
))
80 (declare-function org-previous-block
"org" (arg &optional block-regexp
))
81 (declare-function org-remove-indentation
"org" (code &optional n
))
82 (declare-function org-reverse-string
"org" (string))
83 (declare-function org-set-outline-overlay-data
"org" (data))
84 (declare-function org-show-context
"org" (&optional key
))
85 (declare-function org-split-string
"org" (string &optional separators
))
86 (declare-function org-src-coderef-format
"org-src" (element))
87 (declare-function org-src-coderef-regexp
"org-src" (fmt &optional label
))
88 (declare-function org-table-align
"org-table" ())
89 (declare-function org-table-end
"org-table" (&optional table-type
))
90 (declare-function org-table-import
"org-table" (file arg
))
91 (declare-function org-table-to-lisp
"org-table" (&optional txt
))
92 (declare-function org-trim
"org" (s &optional keep-lead
))
93 (declare-function org-unescape-code-in-string
"org-src" (s))
94 (declare-function org-uniquify
"org" (list))
95 (declare-function orgtbl-to-generic
"org-table" (table params
))
96 (declare-function orgtbl-to-orgtbl
"org-table" (table params
))
97 (declare-function outline-show-all
"outline" ())
98 (declare-function tramp-compat-make-temp-file
"tramp-compat" (filename &optional dir-flag
))
100 (defgroup org-babel nil
101 "Code block evaluation and management in `org-mode' documents."
105 (defcustom org-confirm-babel-evaluate t
106 "Confirm before evaluation.
108 Require confirmation before interactively evaluating code
109 blocks in Org buffers. The default value of this variable is t,
110 meaning confirmation is required for any code block evaluation.
111 This variable can be set to nil to inhibit any future
112 confirmation requests. This variable can also be set to a
113 function which takes two arguments the language of the code block
114 and the body of the code block. Such a function should then
115 return a non-nil value if the user should be prompted for
116 execution or nil if no prompt is required.
118 Warning: Disabling confirmation may result in accidental
119 evaluation of potentially harmful code. It may be advisable
120 remove code block execution from `\\[org-ctrl-c-ctrl-c]' \
121 as further protection
122 against accidental code block evaluation. The
123 `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can be used to
124 remove code block execution from the `\\[org-ctrl-c-ctrl-c]' keybinding."
127 :type
'(choice boolean function
))
128 ;; don't allow this variable to be changed through file settings
129 (put 'org-confirm-babel-evaluate
'safe-local-variable
(lambda (x) (eq x t
)))
131 (defcustom org-babel-no-eval-on-ctrl-c-ctrl-c nil
133 Remove code block evaluation from the `\\[org-ctrl-c-ctrl-c]' key binding."
138 (defcustom org-babel-results-keyword
"RESULTS"
139 "Keyword used to name results generated by code blocks.
140 It should be \"RESULTS\". However any capitalization may be
144 :package-version
'(Org .
"8.0")
148 (eq (compare-strings "RESULTS" nil nil v nil nil t
)
151 (defcustom org-babel-noweb-wrap-start
"<<"
152 "String used to begin a noweb reference in a code block.
153 See also `org-babel-noweb-wrap-end'."
157 (defcustom org-babel-noweb-wrap-end
">>"
158 "String used to end a noweb reference in a code block.
159 See also `org-babel-noweb-wrap-start'."
163 (defcustom org-babel-inline-result-wrap
"=%s="
164 "Format string used to wrap inline results.
165 This string must include a \"%s\" which will be replaced by the results."
168 (put 'org-babel-inline-result-wrap
172 (string-match-p "%s" value
))))
174 (defcustom org-babel-hash-show-time nil
175 "Non-nil means show the time the code block was evaluated in the result hash."
179 :package-version
'(Org .
"9.0")
182 (defun org-babel-noweb-wrap (&optional regexp
)
183 (concat org-babel-noweb-wrap-start
184 (or regexp
"\\([^ \t\n].+?[^ \t]\\|[^ \t\n]\\)")
185 org-babel-noweb-wrap-end
))
187 (defvar org-babel-src-name-regexp
188 "^[ \t]*#\\+name:[ \t]*"
189 "Regular expression used to match a source name line.")
191 (defvar org-babel-multi-line-header-regexp
192 "^[ \t]*#\\+headers?:[ \t]*\\([^\n]*\\)$"
193 "Regular expression used to match multi-line header arguments.")
195 (defvar org-babel-src-block-regexp
197 ;; (1) indentation (2) lang
198 "^\\([ \t]*\\)#\\+begin_src[ \t]+\\([^ \f\t\n\r\v]+\\)[ \t]*"
200 "\\([^\":\n]*\"[^\"\n*]*\"[^\":\n]*\\|[^\":\n]*\\)"
201 ;; (4) header arguments
204 "\\([^\000]*?\n\\)??[ \t]*#\\+end_src")
205 "Regexp used to identify code blocks.")
207 (defun org-babel--get-vars (params)
208 "Return the babel variable assignments in PARAMS.
210 PARAMS is a quasi-alist of header args, which may contain
211 multiple entries for the key `:var'. This function returns a
212 list of the cdr of all the `:var' entries."
214 (cl-remove-if-not (lambda (x) (eq (car x
) :var
)) params
)))
216 (defvar org-babel-exp-reference-buffer nil
217 "Buffer containing original contents of the exported buffer.
218 This is used by Babel to resolve references in source blocks.
219 Its value is dynamically bound during export.")
221 (defun org-babel-check-confirm-evaluate (info)
222 "Check whether INFO allows code block evaluation.
224 Returns nil if evaluation is disallowed, t if it is
225 unconditionally allowed, and the symbol `query' if the user
226 should be asked whether to allow evaluation."
227 (let* ((headers (nth 2 info
))
228 (eval (or (cdr (assq :eval headers
))
229 (when (assq :noeval headers
) "no")))
230 (eval-no (member eval
'("no" "never")))
231 (export org-babel-exp-reference-buffer
)
232 (eval-no-export (and export
(member eval
'("no-export" "never-export"))))
233 (noeval (or eval-no eval-no-export
))
234 (query (or (equal eval
"query")
235 (and export
(equal eval
"query-export"))
236 (if (functionp org-confirm-babel-evaluate
)
238 (goto-char (nth 5 info
))
239 (funcall org-confirm-babel-evaluate
240 ;; language, code block body
241 (nth 0 info
) (nth 1 info
)))
242 org-confirm-babel-evaluate
))))
248 (defun org-babel-check-evaluate (info)
249 "Check if code block INFO should be evaluated.
250 Do not query the user, but do display an informative message if
251 evaluation is blocked. Returns non-nil if evaluation is not blocked."
252 (let ((confirmed (org-babel-check-confirm-evaluate info
)))
254 (message "Evaluation of this %s code block%sis disabled."
256 (let ((name (nth 4 info
)))
257 (if name
(format " (%s) " name
) " "))))
260 ;; Dynamically scoped for asynchronous export.
261 (defvar org-babel-confirm-evaluate-answer-no
)
263 (defun org-babel-confirm-evaluate (info)
264 "Confirm evaluation of the code block INFO.
266 This query can also be suppressed by setting the value of
267 `org-confirm-babel-evaluate' to nil, in which case all future
268 interactive code block evaluations will proceed without any
269 confirmation from the user.
271 Note disabling confirmation may result in accidental evaluation
272 of potentially harmful code.
274 The variable `org-babel-confirm-evaluate-answer-no' is used by
275 the async export process, which requires a non-interactive
276 environment, to override this check."
277 (let* ((evalp (org-babel-check-confirm-evaluate info
))
280 (name-string (if name
(format " (%s) " name
) " ")))
285 (and (not (bound-and-true-p
286 org-babel-confirm-evaluate-answer-no
))
288 (format "Evaluate this %s code block%son your system? "
291 (message "Evaluation of this %s code block%sis aborted."
294 (x (error "Unexpected value `%s' from `org-babel-check-confirm-evaluate'" x
)))))
297 (defun org-babel-execute-safely-maybe ()
298 (unless org-babel-no-eval-on-ctrl-c-ctrl-c
299 (org-babel-execute-maybe)))
302 (defun org-babel-execute-maybe ()
304 (or (org-babel-execute-src-block-maybe)
305 (org-babel-lob-execute-maybe)))
307 (defmacro org-babel-when-in-src-block
(&rest body
)
308 "Execute BODY if point is in a source block and return t.
310 Otherwise do nothing and return nil."
311 `(if (memq (org-element-type (org-element-context))
312 '(inline-src-block src-block
))
318 (defun org-babel-execute-src-block-maybe ()
319 "Conditionally execute a source block.
320 Detect if this is context for a Babel src-block and if so
321 then run `org-babel-execute-src-block'."
323 (org-babel-when-in-src-block
324 (org-babel-eval-wipe-error-buffer)
325 (org-babel-execute-src-block current-prefix-arg
)))
328 (defun org-babel-view-src-block-info ()
329 "Display information on the current source block.
330 This includes header arguments, language and name, and is largely
331 a window into the `org-babel-get-src-block-info' function."
333 (let ((info (org-babel-get-src-block-info 'light
))
334 (full (lambda (it) (> (length it
) 0)))
335 (printf (lambda (fmt &rest args
) (princ (apply #'format fmt args
)))))
337 (with-help-window (help-buffer)
338 (let ((name (nth 4 info
))
340 (switches (nth 3 info
))
341 (header-args (nth 2 info
)))
342 (when name
(funcall printf
"Name: %s\n" name
))
343 (when lang
(funcall printf
"Lang: %s\n" lang
))
344 (funcall printf
"Properties:\n")
345 (funcall printf
"\t:header-args \t%s\n" (org-entry-get (point) "header-args" t
))
346 (funcall printf
"\t:header-args:%s \t%s\n" lang
(org-entry-get (point) (concat "header-args:" lang
) t
))
348 (when (funcall full switches
) (funcall printf
"Switches: %s\n" switches
))
349 (funcall printf
"Header Arguments:\n")
350 (dolist (pair (sort header-args
351 (lambda (a b
) (string< (symbol-name (car a
))
352 (symbol-name (car b
))))))
353 (when (funcall full
(format "%s" (cdr pair
)))
354 (funcall printf
"\t%S%s\t%s\n"
356 (if (> (length (format "%S" (car pair
))) 7) "" "\t")
360 (defun org-babel-expand-src-block-maybe ()
361 "Conditionally expand a source block.
362 Detect if this is context for a org-babel src-block and if so
363 then run `org-babel-expand-src-block'."
365 (org-babel-when-in-src-block
366 (org-babel-expand-src-block current-prefix-arg
)))
369 (defun org-babel-load-in-session-maybe ()
370 "Conditionally load a source block in a session.
371 Detect if this is context for a org-babel src-block and if so
372 then run `org-babel-load-in-session'."
374 (org-babel-when-in-src-block
375 (org-babel-load-in-session current-prefix-arg
)))
377 (add-hook 'org-metaup-hook
'org-babel-load-in-session-maybe
)
380 (defun org-babel-pop-to-session-maybe ()
381 "Conditionally pop to a session.
382 Detect if this is context for a org-babel src-block and if so
383 then run `org-babel-switch-to-session'."
385 (org-babel-when-in-src-block
386 (org-babel-switch-to-session current-prefix-arg
)))
388 (add-hook 'org-metadown-hook
'org-babel-pop-to-session-maybe
)
390 (defconst org-babel-common-header-args-w-values
391 '((cache .
((no yes
)))
393 (colnames .
((nil no yes
)))
394 (comments .
((no link yes org both noweb
)))
396 (eval .
((yes no no-export strip-export never-export eval never
398 (exports .
((code results both none
)))
403 (hlines .
((no yes
)))
404 (mkdirp .
((yes no
)))
407 (noweb .
((yes no tangle no-export strip-export
)))
411 (padline .
((yes no
)))
414 (results .
((file list vector table scalar verbatim
)
415 (raw html latex org code pp drawer
)
416 (replace silent none append prepend
)
418 (rownames .
((no yes
)))
422 (tangle .
((tangle yes no
:any
)))
423 (tangle-mode .
((#o755
#o555
#o444
:any
)))
427 (defconst org-babel-header-arg-names
428 (mapcar #'car org-babel-common-header-args-w-values
)
429 "Common header arguments used by org-babel.
430 Note that individual languages may define their own language
431 specific header arguments as well.")
433 (defconst org-babel-safe-header-args
434 '(:cache
:colnames
:comments
:exports
:epilogue
:hlines
:noeval
435 :noweb
:noweb-ref
:noweb-sep
:padline
:prologue
:rownames
436 :sep
:session
:tangle
:wrap
437 (:eval .
("never" "query"))
438 (:results .
(lambda (str) (not (string-match "file" str
)))))
439 "A list of safe header arguments for babel source blocks.
441 The list can have entries of the following forms:
442 - :ARG -> :ARG is always a safe header arg
443 - (:ARG . (VAL1 VAL2 ...)) -> :ARG is safe as a header arg if it is
444 `equal' to one of the VALs.
445 - (:ARG . FN) -> :ARG is safe as a header arg if the function FN
446 returns non-nil. FN is passed one
447 argument, the value of the header arg
450 (defmacro org-babel-header-args-safe-fn
(safe-list)
451 "Return a function that determines whether a list of header args are safe.
454 \(put \\='org-babel-default-header-args \\='safe-local-variable
455 (org-babel-header-args-safe-p org-babel-safe-header-args)
457 This allows org-babel languages to extend the list of safe values for
458 their `org-babel-default-header-args:foo' variable.
460 For the format of SAFE-LIST, see `org-babel-safe-header-args'."
466 (org-babel-one-header-arg-safe-p pair
,safe-list
)))
469 (defvar org-babel-default-header-args
470 '((:session .
"none") (:results .
"replace") (:exports .
"code")
471 (:cache .
"no") (:noweb .
"no") (:hlines .
"no") (:tangle .
"no"))
472 "Default arguments to use when evaluating a source block.")
473 (put 'org-babel-default-header-args
'safe-local-variable
474 (org-babel-header-args-safe-fn org-babel-safe-header-args
))
476 (defvar org-babel-default-inline-header-args
477 '((:session .
"none") (:results .
"replace")
478 (:exports .
"results") (:hlines .
"yes"))
479 "Default arguments to use when evaluating an inline source block.")
480 (put 'org-babel-default-inline-header-args
'safe-local-variable
481 (org-babel-header-args-safe-fn org-babel-safe-header-args
))
483 (defconst org-babel-name-regexp
484 (format "^[ \t]*#\\+%s:[ \t]*"
485 ;; FIXME: TBLNAME is for backward compatibility.
486 (regexp-opt '("NAME" "TBLNAME")))
487 "Regexp matching a NAME keyword.")
489 (defconst org-babel-result-regexp
490 (format "^[ \t]*#\\+%s\\(?:\\[\\(?:%s \\)?\\([[:alnum:]]+\\)\\]\\)?:[ \t]*"
491 org-babel-results-keyword
492 ;; <%Y-%m-%d %H:%M:%S>
493 "<\\(?:[0-9]\\{4\\}-[0-1][0-9]-[0-3][0-9] \
494 [0-2][0-9]\\(?::[0-5][0-9]\\)\\{2\\}\\)>")
495 "Regular expression used to match result lines.
496 If the results are associated with a hash key then the hash will
497 be saved in match group 1.")
499 (defconst org-babel-result-w-name-regexp
500 (concat org-babel-result-regexp
"\\(?9:[^ \t\n\r\v\f]+\\)")
501 "Regexp matching a RESULTS keyword with a name.
502 Name is saved in match group 9.")
504 (defvar org-babel-min-lines-for-block-output
10
505 "The minimum number of lines for block output.
506 If number of lines of output is equal to or exceeds this
507 value, the output is placed in a #+begin_example...#+end_example
508 block. Otherwise the output is marked as literal by inserting
509 colons at the starts of the lines. This variable only takes
510 effect if the :results output option is in effect.")
512 (defvar org-babel-noweb-error-all-langs nil
513 "Raise errors when noweb references don't resolve.
514 Also see `org-babel-noweb-error-langs' to control noweb errors on
515 a language by language bases.")
517 (defvar org-babel-noweb-error-langs nil
518 "Languages for which Babel will raise literate programming errors.
519 List of languages for which errors should be raised when the
520 source code block satisfying a noweb reference in this language
521 can not be resolved. Also see `org-babel-noweb-error-all-langs'
522 to raise errors for all languages.")
524 (defvar org-babel-hash-show
4
525 "Number of initial characters to show of a hidden results hash.")
527 (defvar org-babel-after-execute-hook nil
528 "Hook for functions to be called after `org-babel-execute-src-block'")
530 (defun org-babel-named-src-block-regexp-for-name (&optional name
)
531 "This generates a regexp used to match a src block named NAME.
532 If NAME is nil, match any name. Matched name is then put in
533 match group 9. Other match groups are defined in
534 `org-babel-src-block-regexp'."
535 (concat org-babel-src-name-regexp
536 (concat (if name
(regexp-quote name
) "\\(?9:.*?\\)") "[ \t]*" )
537 "\\(?:\n[ \t]*#\\+\\S-+:.*\\)*?"
539 (substring org-babel-src-block-regexp
1)))
541 (defun org-babel-named-data-regexp-for-name (name)
542 "This generates a regexp used to match data named NAME."
543 (concat org-babel-name-regexp
(regexp-quote name
) "[ \t]*$"))
545 (defun org-babel--normalize-body (datum)
546 "Normalize body for element or object DATUM.
547 DATUM is a source block element or an inline source block object.
548 Remove final newline character and spurious indentation."
549 (let* ((value (org-element-property :value datum
))
550 (body (if (string-suffix-p "\n" value
)
551 (substring value
0 -
1)
553 (cond ((eq (org-element-type datum
) 'inline-src-block
)
554 ;; Newline characters and indentation in an inline
555 ;; src-block are not meaningful, since they could come from
556 ;; some paragraph filling. Treat them as a white space.
557 (replace-regexp-in-string "\n[ \t]*" " " body
))
558 ((or org-src-preserve-indentation
559 (org-element-property :preserve-indent datum
))
561 (t (org-remove-indentation body
)))))
564 (defvar org-babel-current-src-block-location nil
565 "Marker pointing to the src block currently being executed.
566 This may also point to a call line or an inline code block. If
567 multiple blocks are being executed (e.g., in chained execution
568 through use of the :var header argument) this marker points to
569 the outer-most code block.")
573 (defun org-babel-get-src-block-info (&optional light datum
)
574 "Extract information from a source block or inline source block.
576 Optional argument LIGHT does not resolve remote variable
577 references; a process which could likely result in the execution
578 of other code blocks.
580 By default, consider the block at point. However, when optional
581 argument DATUM is provided, extract information from that parsed
584 Return nil if point is not on a source block. Otherwise, return
585 a list with the following pattern:
587 (language body arguments switches name start coderef)"
588 (let* ((datum (or datum
(org-element-context)))
589 (type (org-element-type datum
))
590 (inline (eq type
'inline-src-block
)))
591 (when (memq type
'(inline-src-block src-block
))
592 (let* ((lang (org-element-property :language datum
))
593 (lang-headers (intern
594 (concat "org-babel-default-header-args:" lang
)))
595 (name (org-element-property :name datum
))
599 (org-babel--normalize-body datum
)
600 (apply #'org-babel-merge-params
601 (if inline org-babel-default-inline-header-args
602 org-babel-default-header-args
)
603 (and (boundp lang-headers
) (eval lang-headers t
))
605 ;; If DATUM is provided, make sure we get node
606 ;; properties applicable to its location within
608 (org-with-point-at (org-element-property :begin datum
)
609 (org-babel-params-from-properties lang
))
610 (mapcar #'org-babel-parse-header-arguments
611 (cons (org-element-property :parameters datum
)
612 (org-element-property :header datum
)))))
613 (or (org-element-property :switches datum
) "")
615 (org-element-property (if inline
:begin
:post-affiliated
)
617 (and (not inline
) (org-src-coderef-format datum
)))))
619 (setf (nth 2 info
) (org-babel-process-params (nth 2 info
))))
620 (setf (nth 2 info
) (org-babel-generate-file-param name
(nth 2 info
)))
624 (defun org-babel-execute-src-block (&optional arg info params
)
625 "Execute the current source code block.
626 Insert the results of execution into the buffer. Source code
627 execution and the collection and formatting of results can be
628 controlled through a variety of header arguments.
630 With prefix argument ARG, force re-execution even if an existing
631 result cached in the buffer would otherwise have been returned.
633 Optionally supply a value for INFO in the form returned by
634 `org-babel-get-src-block-info'.
636 Optionally supply a value for PARAMS which will be merged with
637 the header arguments specified at the front of the source code
640 (let* ((org-babel-current-src-block-location
641 (or org-babel-current-src-block-location
643 (org-babel-where-is-src-block-head)))
644 (info (if info
(copy-tree info
) (org-babel-get-src-block-info))))
645 ;; Merge PARAMS with INFO before considering source block
646 ;; evaluation since both could disagree.
647 (cl-callf org-babel-merge-params
(nth 2 info
) params
)
648 (when (org-babel-check-evaluate info
)
649 (cl-callf org-babel-process-params
(nth 2 info
))
650 (let* ((params (nth 2 info
))
651 (cache (let ((c (cdr (assq :cache params
))))
652 (and (not arg
) c
(string= "yes" c
))))
653 (new-hash (and cache
(org-babel-sha1-hash info
)))
654 (old-hash (and cache
(org-babel-current-result-hash)))
655 (current-cache (and new-hash
(equal new-hash old-hash
))))
658 (save-excursion ;Return cached result.
659 (goto-char (org-babel-where-is-src-block-result nil info
))
661 (skip-chars-forward " \t")
662 (let ((result (org-babel-read-result)))
663 (message (replace-regexp-in-string "%" "%%" (format "%S" result
)))
665 ((org-babel-confirm-evaluate info
)
666 (let* ((lang (nth 0 info
))
667 (result-params (cdr (assq :result-params params
)))
668 ;; Expand noweb references in BODY and remove any
671 (let ((coderef (nth 6 info
))
673 (if (org-babel-noweb-p params
:eval
)
674 (org-babel-expand-noweb-references info
)
676 (if (not coderef
) expand
677 (replace-regexp-in-string
678 (org-src-coderef-regexp coderef
) "" expand nil nil
1))))
679 (dir (cdr (assq :dir params
)))
681 (or (and dir
(file-name-as-directory (expand-file-name dir
)))
683 (cmd (intern (concat "org-babel-execute:" lang
)))
685 (unless (fboundp cmd
)
686 (error "No org-babel-execute function for %s!" lang
))
687 (message "executing %s code block%s..."
689 (let ((name (nth 4 info
)))
690 (if name
(format " (%s)" name
) "")))
691 (if (member "none" result-params
)
692 (progn (funcall cmd body params
)
693 (message "result silenced"))
695 (let ((r (funcall cmd body params
)))
696 (if (and (eq (cdr (assq :result-type params
)) 'value
)
697 (or (member "vector" result-params
)
698 (member "table" result-params
))
702 (let ((file (cdr (assq :file params
))))
703 ;; If non-empty result and :file then write to :file.
707 (insert (org-babel-format-result
708 result
(cdr (assq :sep params
))))))
710 ;; Possibly perform post process provided its
711 ;; appropriate. Dynamically bind "*this*" to the
712 ;; actual results of the block.
713 (let ((post (cdr (assq :post params
))))
715 (let ((*this
* (if (not file
) result
716 (org-babel-result-to-file
718 (let ((desc (assq :file-desc params
)))
719 (and desc
(or (cdr desc
) result
)))))))
720 (setq result
(org-babel-ref-resolve post
))
722 (setq result-params
(remove "file" result-params
))))))
723 (org-babel-insert-result
724 result result-params info new-hash lang
)))
725 (run-hooks 'org-babel-after-execute-hook
)
728 (defun org-babel-expand-body:generic
(body params
&optional var-lines
)
729 "Expand BODY with PARAMS.
730 Expand a block of code with org-babel according to its header
731 arguments. This generic implementation of body expansion is
732 called for languages which have not defined their own specific
733 org-babel-expand-body:lang function."
734 (let ((pro (cdr (assq :prologue params
)))
735 (epi (cdr (assq :epilogue params
))))
736 (mapconcat #'identity
737 (append (when pro
(list pro
))
740 (when epi
(list epi
)))
744 (defun org-babel-expand-src-block (&optional _arg info params
)
745 "Expand the current source code block.
746 Expand according to the source code block's header
747 arguments and pop open the results in a preview buffer."
749 (let* ((info (or info
(org-babel-get-src-block-info)))
751 (params (setf (nth 2 info
)
752 (sort (org-babel-merge-params (nth 2 info
) params
)
753 (lambda (el1 el2
) (string< (symbol-name (car el1
))
754 (symbol-name (car el2
)))))))
755 (body (setf (nth 1 info
)
756 (if (org-babel-noweb-p params
:eval
)
757 (org-babel-expand-noweb-references info
) (nth 1 info
))))
758 (expand-cmd (intern (concat "org-babel-expand-body:" lang
)))
759 (assignments-cmd (intern (concat "org-babel-variable-assignments:"
762 (if (fboundp expand-cmd
) (funcall expand-cmd body params
)
763 (org-babel-expand-body:generic
764 body params
(and (fboundp assignments-cmd
)
765 (funcall assignments-cmd params
))))))
766 (if (called-interactively-p 'any
)
768 expanded
(concat "*Org-Babel Preview " (buffer-name) "[ " lang
" ]*"))
771 (defun org-babel-edit-distance (s1 s2
)
772 "Return the edit (levenshtein) distance between strings S1 S2."
773 (let* ((l1 (length s1
))
775 (dist (vconcat (mapcar (lambda (_) (make-vector (1+ l2
) nil
))
776 (number-sequence 1 (1+ l1
)))))
777 (in (lambda (i j
) (aref (aref dist i
) j
))))
778 (setf (aref (aref dist
0) 0) 0)
779 (dolist (j (number-sequence 1 l2
))
780 (setf (aref (aref dist
0) j
) j
))
781 (dolist (i (number-sequence 1 l1
))
782 (setf (aref (aref dist i
) 0) i
)
783 (dolist (j (number-sequence 1 l2
))
784 (setf (aref (aref dist i
) j
)
786 (1+ (funcall in
(1- i
) j
))
787 (1+ (funcall in i
(1- j
)))
788 (+ (if (equal (aref s1
(1- i
)) (aref s2
(1- j
))) 0 1)
789 (funcall in
(1- i
) (1- j
)))))))
792 (defun org-babel-combine-header-arg-lists (original &rest others
)
793 "Combine a number of lists of header argument names and arguments."
794 (let ((results (copy-sequence original
)))
795 (dolist (new-list others
)
796 (dolist (arg-pair new-list
)
797 (let ((header (car arg-pair
)))
799 (cons arg-pair
(cl-remove-if
800 (lambda (pair) (equal header
(car pair
)))
805 (defun org-babel-check-src-block ()
806 "Check for misspelled header arguments in the current code block."
808 ;; TODO: report malformed code block
809 ;; TODO: report incompatible combinations of header arguments
810 ;; TODO: report uninitialized variables
811 (let ((too-close 2) ;; <- control closeness to report potential match
812 (names (mapcar #'symbol-name org-babel-header-arg-names
)))
813 (dolist (header (mapcar (lambda (arg) (substring (symbol-name (car arg
)) 1))
814 (and (org-babel-where-is-src-block-head)
815 (org-babel-parse-header-arguments
817 (match-string 4))))))
819 (when (and (not (string= header name
))
820 (<= (org-babel-edit-distance header name
) too-close
)
821 (not (member header names
)))
822 (error "Supplied header \"%S\" is suspiciously close to \"%S\""
824 (message "No suspicious header arguments found.")))
827 (defun org-babel-insert-header-arg (&optional header-arg value
)
828 "Insert a header argument selecting from lists of common args and values."
830 (let* ((info (org-babel-get-src-block-info 'light
))
833 (lang-headers (intern (concat "org-babel-header-args:" lang
)))
834 (headers (org-babel-combine-header-arg-lists
835 org-babel-common-header-args-w-values
836 (when (boundp lang-headers
) (eval lang-headers t
))))
837 (header-arg (or header-arg
841 (lambda (header-spec) (symbol-name (car header-spec
)))
843 (vals (cdr (assoc (intern header-arg
) headers
)))
847 (read-from-minibuffer "value: "))
851 (let ((arg (completing-read
854 (mapcar #'symbol-name group
)))))
855 (if (and arg
(not (string= "default" arg
)))
861 (goto-char (point-at-eol))
862 (unless (= (char-before (point)) ?\
) (insert " "))
863 (insert ":" header-arg
) (when value
(insert " " value
)))))
865 ;; Add support for completing-read insertion of header arguments after ":"
866 (defun org-babel-header-arg-expand ()
867 "Call `org-babel-enter-header-arg-w-completion' in appropriate contexts."
868 (when (and (equal (char-before) ?\
:) (org-babel-where-is-src-block-head))
869 (org-babel-enter-header-arg-w-completion (match-string 2))))
871 (defun org-babel-enter-header-arg-w-completion (&optional lang
)
872 "Insert header argument appropriate for LANG with completion."
873 (let* ((lang-headers-var (intern (concat "org-babel-header-args:" lang
)))
874 (lang-headers (when (boundp lang-headers-var
) (eval lang-headers-var t
)))
875 (headers-w-values (org-babel-combine-header-arg-lists
876 org-babel-common-header-args-w-values lang-headers
))
877 (headers (mapcar #'symbol-name
(mapcar #'car headers-w-values
)))
878 (header (org-completing-read "Header Arg: " headers
))
879 (args (cdr (assoc (intern header
) headers-w-values
)))
880 (arg (when (and args
(listp args
))
882 (format "%s: " header
)
883 (mapcar #'symbol-name
(apply #'append args
))))))
884 (insert (concat header
" " (or arg
"")))
887 (add-hook 'org-tab-first-hook
'org-babel-header-arg-expand
)
890 (defun org-babel-load-in-session (&optional _arg info
)
891 "Load the body of the current source-code block.
892 Evaluate the header arguments for the source block before
893 entering the session. After loading the body this pops open the
896 (let* ((info (or info
(org-babel-get-src-block-info)))
898 (params (nth 2 info
))
900 (user-error "No src code block at point")
902 (if (org-babel-noweb-p params
:eval
)
903 (org-babel-expand-noweb-references info
)
905 (session (cdr (assq :session params
)))
906 (dir (cdr (assq :dir params
)))
908 (or (and dir
(file-name-as-directory dir
)) default-directory
))
909 (cmd (intern (concat "org-babel-load-session:" lang
))))
910 (unless (fboundp cmd
)
911 (error "No org-babel-load-session function for %s!" lang
))
912 (pop-to-buffer (funcall cmd session body params
))
916 (defun org-babel-initiate-session (&optional arg info
)
917 "Initiate session for current code block.
918 If called with a prefix argument then resolve any variable
919 references in the header arguments and assign these variables in
920 the session. Copy the body of the code block to the kill ring."
922 (let* ((info (or info
(org-babel-get-src-block-info (not arg
))))
925 (params (nth 2 info
))
926 (session (cdr (assq :session params
)))
927 (dir (cdr (assq :dir params
)))
929 (or (and dir
(file-name-as-directory dir
)) default-directory
))
930 (init-cmd (intern (format "org-babel-%s-initiate-session" lang
)))
931 (prep-cmd (intern (concat "org-babel-prep-session:" lang
))))
932 (when (and (stringp session
) (string= session
"none"))
933 (error "This block is not using a session!"))
934 (unless (fboundp init-cmd
)
935 (error "No org-babel-initiate-session function for %s!" lang
))
936 (with-temp-buffer (insert (org-trim body
))
937 (copy-region-as-kill (point-min) (point-max)))
939 (unless (fboundp prep-cmd
)
940 (error "No org-babel-prep-session function for %s!" lang
))
941 (funcall prep-cmd session params
))
942 (funcall init-cmd session params
)))
945 (defun org-babel-switch-to-session (&optional arg info
)
946 "Switch to the session of the current code block.
947 Uses `org-babel-initiate-session' to start the session. If called
948 with a prefix argument then this is passed on to
949 `org-babel-initiate-session'."
951 (pop-to-buffer (org-babel-initiate-session arg info
))
954 (defalias 'org-babel-pop-to-session
'org-babel-switch-to-session
)
956 (defvar org-src-window-setup
)
959 (defun org-babel-switch-to-session-with-code (&optional arg _info
)
960 "Switch to code buffer and display session."
964 (let ((other-window-buffer (window-buffer (next-window))))
965 (set-window-buffer (next-window) (current-buffer))
966 (set-window-buffer (selected-window) other-window-buffer
))
968 (info (org-babel-get-src-block-info))
969 (org-src-window-setup 'reorganize-frame
))
971 (org-babel-switch-to-session arg info
))
973 (funcall swap-windows
)))
976 (defmacro org-babel-do-in-edit-buffer
(&rest body
)
977 "Evaluate BODY in edit buffer if there is a code block at point.
978 Return t if a code block was found at point, nil otherwise."
979 `(let ((org-src-window-setup 'switch-invisibly
))
980 (when (and (org-babel-where-is-src-block-head)
982 (unwind-protect (progn ,@body
)
985 (def-edebug-spec org-babel-do-in-edit-buffer
(body))
987 (defun org-babel-do-key-sequence-in-edit-buffer (key)
988 "Read key sequence and execute the command in edit buffer.
989 Enter a key sequence to be executed in the language major-mode
990 edit buffer. For example, TAB will alter the contents of the
991 Org code block according to the effect of TAB in the language
992 major mode buffer. For languages that support interactive
993 sessions, this can be used to send code from the Org buffer
994 to the session for evaluation using the native major mode
995 evaluation mechanisms."
996 (interactive "kEnter key-sequence to execute in edit buffer: ")
997 (org-babel-do-in-edit-buffer
999 (key-binding (or key
(read-key-sequence nil
))))))
1001 (defvar org-bracket-link-regexp
)
1003 (defun org-babel-active-location-p ()
1004 (memq (org-element-type (save-match-data (org-element-context)))
1005 '(babel-call inline-babel-call inline-src-block src-block
)))
1008 (defun org-babel-open-src-block-result (&optional re-run
)
1009 "If `point' is on a src block then open the results of the
1010 source code block, otherwise return nil. With optional prefix
1011 argument RE-RUN the source-code block is evaluated even if
1012 results already exist."
1014 (let ((info (org-babel-get-src-block-info 'light
)))
1017 ;; go to the results, if there aren't any then run the block
1018 (goto-char (or (and (not re-run
) (org-babel-where-is-src-block-result))
1019 (progn (org-babel-execute-src-block)
1020 (org-babel-where-is-src-block-result))))
1022 (while (looking-at "[\n\r\t\f ]") (forward-char 1))
1024 (if (looking-at org-bracket-link-regexp
)
1027 (let ((r (org-babel-format-result
1028 (org-babel-read-result) (cdr (assq :sep
(nth 2 info
))))))
1029 (pop-to-buffer (get-buffer-create "*Org-Babel Results*"))
1030 (delete-region (point-min) (point-max))
1035 (defmacro org-babel-map-src-blocks
(file &rest body
)
1036 "Evaluate BODY forms on each source-block in FILE.
1037 If FILE is nil evaluate BODY forms on source blocks in current
1038 buffer. During evaluation of BODY the following local variables
1039 are set relative to the currently matched code block.
1041 full-block ------- string holding the entirety of the code block
1042 beg-block -------- point at the beginning of the code block
1043 end-block -------- point at the end of the matched code block
1044 lang ------------- string holding the language of the code block
1045 beg-lang --------- point at the beginning of the lang
1046 end-lang --------- point at the end of the lang
1047 switches --------- string holding the switches
1048 beg-switches ----- point at the beginning of the switches
1049 end-switches ----- point at the end of the switches
1050 header-args ------ string holding the header-args
1051 beg-header-args -- point at the beginning of the header-args
1052 end-header-args -- point at the end of the header-args
1053 body ------------- string holding the body of the code block
1054 beg-body --------- point at the beginning of the body
1055 end-body --------- point at the end of the body"
1056 (declare (indent 1))
1057 (let ((tempvar (make-symbol "file")))
1058 `(let* ((case-fold-search t
)
1060 (visited-p (or (null ,tempvar
)
1061 (get-file-buffer (expand-file-name ,tempvar
))))
1062 (point (point)) to-be-removed
)
1063 (save-window-excursion
1064 (when ,tempvar
(find-file ,tempvar
))
1065 (setq to-be-removed
(current-buffer))
1066 (goto-char (point-min))
1067 (while (re-search-forward org-babel-src-block-regexp nil t
)
1068 (when (org-babel-active-location-p)
1069 (goto-char (match-beginning 0))
1070 (let ((full-block (match-string 0))
1071 (beg-block (match-beginning 0))
1072 (end-block (match-end 0))
1073 (lang (match-string 2))
1074 (beg-lang (match-beginning 2))
1075 (end-lang (match-end 2))
1076 (switches (match-string 3))
1077 (beg-switches (match-beginning 3))
1078 (end-switches (match-end 3))
1079 (header-args (match-string 4))
1080 (beg-header-args (match-beginning 4))
1081 (end-header-args (match-end 4))
1082 (body (match-string 5))
1083 (beg-body (match-beginning 5))
1084 (end-body (match-end 5)))
1085 ;; Silence byte-compiler in case `body' doesn't use all
1087 (ignore full-block beg-block end-block lang
1088 beg-lang end-lang switches beg-switches
1089 end-switches header-args beg-header-args
1090 end-header-args body beg-body end-body
)
1092 (goto-char end-block
)))))
1093 (unless visited-p
(kill-buffer to-be-removed
))
1094 (goto-char point
))))
1095 (def-edebug-spec org-babel-map-src-blocks
(form body
))
1098 (defmacro org-babel-map-inline-src-blocks
(file &rest body
)
1099 "Evaluate BODY forms on each inline source block in FILE.
1100 If FILE is nil evaluate BODY forms on source blocks in current
1102 (declare (indent 1) (debug (form body
)))
1103 (org-with-gensyms (datum end point tempvar to-be-removed visitedp
)
1104 `(let* ((case-fold-search t
)
1106 (,visitedp
(or (null ,tempvar
)
1107 (get-file-buffer (expand-file-name ,tempvar
))))
1110 (save-window-excursion
1111 (when ,tempvar
(find-file ,tempvar
))
1112 (setq ,to-be-removed
(current-buffer))
1113 (goto-char (point-min))
1114 (while (re-search-forward "src_\\S-" nil t
)
1115 (let ((,datum
(save-match-data (org-element-context))))
1116 (when (eq (org-element-type ,datum
) 'inline-src-block
)
1117 (goto-char (match-beginning 0))
1118 (let ((,end
(copy-marker (org-element-property :end
,datum
))))
1121 (set-marker ,end nil
))))))
1122 (unless ,visitedp
(kill-buffer ,to-be-removed
))
1123 (goto-char ,point
))))
1126 (defmacro org-babel-map-call-lines
(file &rest body
)
1127 "Evaluate BODY forms on each call line in FILE.
1128 If FILE is nil evaluate BODY forms on source blocks in current
1130 (declare (indent 1) (debug (form body
)))
1131 (org-with-gensyms (datum end point tempvar to-be-removed visitedp
)
1132 `(let* ((case-fold-search t
)
1134 (,visitedp
(or (null ,tempvar
)
1135 (get-file-buffer (expand-file-name ,tempvar
))))
1138 (save-window-excursion
1139 (when ,tempvar
(find-file ,tempvar
))
1140 (setq ,to-be-removed
(current-buffer))
1141 (goto-char (point-min))
1142 (while (re-search-forward "call_\\S-\\|^[ \t]*#\\+CALL:" nil t
)
1143 (let ((,datum
(save-match-data (org-element-context))))
1144 (when (memq (org-element-type ,datum
)
1145 '(babel-call inline-babel-call
))
1146 (goto-char (match-beginning 0))
1147 (let ((,end
(copy-marker (org-element-property :end
,datum
))))
1150 (set-marker ,end nil
))))))
1151 (unless ,visitedp
(kill-buffer ,to-be-removed
))
1152 (goto-char ,point
))))
1155 (defmacro org-babel-map-executables
(file &rest body
)
1156 "Evaluate BODY forms on each active Babel code in FILE.
1157 If FILE is nil evaluate BODY forms on source blocks in current
1159 (declare (indent 1) (debug (form body
)))
1160 (org-with-gensyms (datum end point tempvar to-be-removed visitedp
)
1161 `(let* ((case-fold-search t
)
1163 (,visitedp
(or (null ,tempvar
)
1164 (get-file-buffer (expand-file-name ,tempvar
))))
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
1172 "\\(call\\|src\\)_\\|^[ \t]*#\\+\\(BEGIN_SRC\\|CALL:\\)" nil t
)
1173 (let ((,datum
(save-match-data (org-element-context))))
1174 (when (memq (org-element-type ,datum
)
1175 '(babel-call inline-babel-call inline-src-block
1177 (goto-char (match-beginning 0))
1178 (let ((,end
(copy-marker (org-element-property :end
,datum
))))
1181 (set-marker ,end nil
))))))
1182 (unless ,visitedp
(kill-buffer ,to-be-removed
))
1183 (goto-char ,point
))))
1186 (defun org-babel-execute-buffer (&optional arg
)
1187 "Execute source code blocks in a buffer.
1188 Call `org-babel-execute-src-block' on every source block in
1189 the current buffer."
1191 (org-babel-eval-wipe-error-buffer)
1192 (org-save-outline-visibility t
1193 (org-babel-map-executables nil
1194 (if (memq (org-element-type (org-element-context))
1195 '(babel-call inline-babel-call
))
1196 (org-babel-lob-execute-maybe)
1197 (org-babel-execute-src-block arg
)))))
1200 (defun org-babel-execute-subtree (&optional arg
)
1201 "Execute source code blocks in a subtree.
1202 Call `org-babel-execute-src-block' on every source block in
1203 the current subtree."
1207 (org-narrow-to-subtree)
1208 (org-babel-execute-buffer arg
)
1212 (defun org-babel-sha1-hash (&optional info
)
1213 "Generate an sha1 hash based on the value of info."
1215 (let ((print-level nil
)
1216 (info (or info
(org-babel-get-src-block-info))))
1218 (sort (copy-sequence (nth 2 info
))
1219 (lambda (a b
) (string< (car a
) (car b
)))))
1220 (let* ((rm (lambda (lst)
1221 (dolist (p '("replace" "silent" "none"
1222 "append" "prepend"))
1223 (setq lst
(remove p lst
)))
1226 (let ((v (if (and (listp (cdr arg
)) (null (cddr arg
)))
1227 (copy-sequence (cdr arg
))
1229 (when (and v
(not (and (sequencep v
)
1233 ((and (listp v
) ; lists are sorted
1234 (member (car arg
) '(:result-params
)))
1235 (sort (funcall rm v
) #'string
<))
1236 ((and (stringp v
) ; strings are sorted
1237 (member (car arg
) '(:results
:exports
)))
1238 (mapconcat #'identity
(sort (funcall rm
(split-string v
))
1243 (params (nth 2 info
))
1244 (body (if (org-babel-noweb-p params
:eval
)
1245 (org-babel-expand-noweb-references info
) (nth 1 info
)))
1246 (expand-cmd (intern (concat "org-babel-expand-body:" lang
)))
1247 (assignments-cmd (intern (concat "org-babel-variable-assignments:"
1250 (if (fboundp expand-cmd
) (funcall expand-cmd body params
)
1251 (org-babel-expand-body:generic
1252 body params
(and (fboundp assignments-cmd
)
1253 (funcall assignments-cmd params
))))))
1254 (let* ((it (format "%s-%s"
1257 (delq nil
(mapcar (lambda (arg)
1258 (let ((normalized (funcall norm arg
)))
1260 (format "%S" normalized
))))
1264 (when (called-interactively-p 'interactive
) (message hash
))
1267 (defun org-babel-current-result-hash (&optional info
)
1268 "Return the current in-buffer hash."
1269 (let ((result (org-babel-where-is-src-block-result nil info
)))
1271 (org-with-wide-buffer
1273 (looking-at org-babel-result-regexp
)
1274 (match-string-no-properties 1)))))
1276 (defun org-babel-set-current-result-hash (hash info
)
1277 "Set the current in-buffer hash to HASH."
1278 (org-with-wide-buffer
1279 (goto-char (org-babel-where-is-src-block-result nil info
))
1280 (looking-at org-babel-result-regexp
)
1281 (goto-char (match-beginning 1))
1282 (mapc #'delete-overlay
(overlays-at (point)))
1283 (forward-char org-babel-hash-show
)
1284 (mapc #'delete-overlay
(overlays-at (point)))
1285 (replace-match hash nil nil nil
1)
1287 (org-babel-hide-hash)))
1289 (defun org-babel-hide-hash ()
1290 "Hide the hash in the current results line.
1291 Only the initial `org-babel-hash-show' characters of the hash
1292 will remain visible."
1293 (add-to-invisibility-spec '(org-babel-hide-hash . t
))
1295 (when (and (re-search-forward org-babel-result-regexp nil t
)
1297 (let* ((start (match-beginning 1))
1298 (hide-start (+ org-babel-hash-show start
))
1300 (hash (match-string 1))
1302 (setq ov1
(make-overlay start hide-start
))
1303 (setq ov2
(make-overlay hide-start end
))
1304 (overlay-put ov2
'invisible
'org-babel-hide-hash
)
1305 (overlay-put ov1
'babel-hash hash
)))))
1307 (defun org-babel-hide-all-hashes ()
1308 "Hide the hash in the current buffer.
1309 Only the initial `org-babel-hash-show' characters of each hash
1310 will remain visible. This function should be called as part of
1311 the `org-mode-hook'."
1313 (while (and (not org-babel-hash-show-time
)
1314 (re-search-forward org-babel-result-regexp nil t
))
1315 (goto-char (match-beginning 0))
1316 (org-babel-hide-hash)
1317 (goto-char (match-end 0)))))
1318 (add-hook 'org-mode-hook
'org-babel-hide-all-hashes
)
1320 (defun org-babel-hash-at-point (&optional point
)
1321 "Return the value of the hash at POINT.
1323 The hash is also added as the last element of the kill ring.
1324 This can be called with `\\[org-ctrl-c-ctrl-c]'."
1326 (let ((hash (car (delq nil
(mapcar
1327 (lambda (ol) (overlay-get ol
'babel-hash
))
1328 (overlays-at (or point
(point))))))))
1329 (when hash
(kill-new hash
) (message hash
))))
1331 (defun org-babel-result-hide-spec ()
1332 "Hide portions of results lines.
1333 Add `org-babel-hide-result' as an invisibility spec for hiding
1334 portions of results lines."
1335 (add-to-invisibility-spec '(org-babel-hide-result . t
)))
1336 (add-hook 'org-mode-hook
'org-babel-result-hide-spec
)
1338 (defvar org-babel-hide-result-overlays nil
1339 "Overlays hiding results.")
1341 (defun org-babel-result-hide-all ()
1342 "Fold all results in the current buffer."
1344 (org-babel-show-result-all)
1346 (while (re-search-forward org-babel-result-regexp nil t
)
1347 (save-excursion (goto-char (match-beginning 0))
1348 (org-babel-hide-result-toggle-maybe)))))
1350 (defun org-babel-show-result-all ()
1351 "Unfold all results in the current buffer."
1352 (mapc 'delete-overlay org-babel-hide-result-overlays
)
1353 (setq org-babel-hide-result-overlays nil
))
1356 (defun org-babel-hide-result-toggle-maybe ()
1357 "Toggle visibility of result at point."
1359 (let ((case-fold-search t
))
1361 (beginning-of-line 1)
1362 (looking-at org-babel-result-regexp
))
1363 (progn (org-babel-hide-result-toggle)
1364 t
) ;; to signal that we took action
1365 nil
))) ;; to signal that we did not
1367 (defun org-babel-hide-result-toggle (&optional force
)
1368 "Toggle the visibility of the current result."
1372 (if (re-search-forward org-babel-result-regexp nil t
)
1373 (let ((start (progn (beginning-of-line 2) (- (point) 1)))
1375 (while (looking-at org-babel-multi-line-header-regexp
)
1377 (goto-char (- (org-babel-result-end) 1)) (point)))
1379 (if (memq t
(mapcar (lambda (overlay)
1380 (eq (overlay-get overlay
'invisible
)
1381 'org-babel-hide-result
))
1382 (overlays-at start
)))
1383 (when (or (not force
) (eq force
'off
))
1385 (when (member ov org-babel-hide-result-overlays
)
1386 (setq org-babel-hide-result-overlays
1387 (delq ov org-babel-hide-result-overlays
)))
1388 (when (eq (overlay-get ov
'invisible
)
1389 'org-babel-hide-result
)
1390 (delete-overlay ov
)))
1391 (overlays-at start
)))
1392 (setq ov
(make-overlay start end
))
1393 (overlay-put ov
'invisible
'org-babel-hide-result
)
1394 ;; make the block accessible to isearch
1396 ov
'isearch-open-invisible
1398 (when (member ov org-babel-hide-result-overlays
)
1399 (setq org-babel-hide-result-overlays
1400 (delq ov org-babel-hide-result-overlays
)))
1401 (when (eq (overlay-get ov
'invisible
)
1402 'org-babel-hide-result
)
1403 (delete-overlay ov
))))
1404 (push ov org-babel-hide-result-overlays
)))
1405 (error "Not looking at a result line"))))
1407 ;; org-tab-after-check-for-cycling-hook
1408 (add-hook 'org-tab-first-hook
'org-babel-hide-result-toggle-maybe
)
1409 ;; Remove overlays when changing major mode
1410 (add-hook 'org-mode-hook
1411 (lambda () (add-hook 'change-major-mode-hook
1412 'org-babel-show-result-all
'append
'local
)))
1414 (defvar org-file-properties
)
1415 (defun org-babel-params-from-properties (&optional lang
)
1416 "Retrieve parameters specified as properties.
1417 Return a list of association lists of source block params
1418 specified in the properties of the current outline entry."
1421 ;; header arguments specified with the header-args property at
1423 (org-babel-parse-header-arguments
1424 (org-entry-get org-babel-current-src-block-location
1427 (and lang
; language-specific header arguments at point of call
1428 (org-babel-parse-header-arguments
1429 (org-entry-get org-babel-current-src-block-location
1430 (concat "header-args:" lang
)
1433 (defun org-babel-balanced-split (string alts
)
1434 "Split STRING on instances of ALTS.
1435 ALTS is a character, or cons of two character options where each
1436 option may be either the numeric code of a single character or
1437 a list of character alternatives. For example, to split on
1438 balanced instances of \"[ \t]:\", set ALTS to ((32 9) . 58)."
1441 (goto-char (point-min))
1442 (let ((splitp (lambda (past next
)
1443 ;; Non-nil when there should be a split after NEXT
1444 ;; character. PAST is the character before NEXT.
1446 (`(,(and first
(pred consp
)) .
,(and second
(pred consp
)))
1447 (and (memq past first
) (memq next second
)))
1448 (`(,first .
,(and second
(pred consp
)))
1449 (and (eq past first
) (memq next second
)))
1450 (`(,(and first
(pred consp
)) .
,second
)
1451 (and (memq past first
) (eq next second
)))
1452 (`(,first .
,second
)
1453 (and (eq past first
) (eq next second
)))
1454 ((pred (eq next
)) t
)
1460 ((funcall splitp
(char-before) (char-after))
1461 ;; There is a split after point. If ALTS is two-folds,
1462 ;; remove last parsed character as it belongs to ALTS.
1463 (when (consp alts
) (pop partial
))
1464 ;; Include elements parsed so far in RESULTS and flush
1467 (push (apply #'string
(nreverse partial
)) result
)
1470 ((memq (char-after) '(?\
( ?\
[))
1471 ;; Include everything between balanced brackets.
1472 (let* ((origin (point))
1473 (after (char-after))
1474 (openings (list after
)))
1476 (while (and openings
(re-search-forward "[]()]" nil t
))
1477 (pcase (char-before)
1478 ((and match
(or ?\
[ ?\
()) (push match openings
))
1479 (?\
] (when (eq ?\
[ (car openings
)) (pop openings
)))
1480 (_ (when (eq ?\
( (car openings
)) (pop openings
)))))
1483 (nconc (nreverse (string-to-list
1484 (buffer-substring origin
(point))))
1486 ;; Un-balanced bracket. Backtrack.
1487 (push after partial
)
1488 (goto-char (1+ origin
)))))
1489 ((and (eq ?
\" (char-after)) (not (eq ?
\\ (char-before))))
1490 ;; Include everything from current double quote to next
1491 ;; non-escaped double quote.
1492 (let ((origin (point)))
1493 (if (re-search-forward "[^\\]\"" nil t
)
1495 (nconc (nreverse (string-to-list
1496 (buffer-substring origin
(point))))
1498 ;; No closing double quote. Backtrack.
1501 (t (push (char-after) partial
)
1503 ;; Add pending parsing and return result.
1504 (when partial
(push (apply #'string
(nreverse partial
)) result
))
1505 (nreverse result
))))
1507 (defun org-babel-join-splits-near-ch (ch list
)
1508 "Join splits where \"=\" is on either end of the split."
1509 (let ((last= (lambda (str) (= ch
(aref str
(1- (length str
))))))
1510 (first= (lambda (str) (= ch
(aref str
0)))))
1512 (cl-reduce (lambda (acc el
)
1513 (let ((head (car acc
)))
1514 (if (and head
(or (funcall last
= head
) (funcall first
= el
)))
1515 (cons (concat head el
) (cdr acc
))
1517 list
:initial-value nil
))))
1519 (defun org-babel-parse-header-arguments (arg-string)
1520 "Parse a string of header arguments returning an alist."
1521 (when (> (length arg-string
) 0)
1522 (org-babel-parse-multiple-vars
1527 "\\([^ \f\t\n\r\v]+\\)[ \f\t\n\r\v]+\\([^ \f\t\n\r\v]+.*\\)"
1529 (cons (intern (match-string 1 arg
))
1530 (org-babel-read (org-babel-chomp (match-string 2 arg
))))
1531 (cons (intern (org-babel-chomp arg
)) nil
)))
1532 (let ((raw (org-babel-balanced-split arg-string
'((32 9) .
58))))
1533 (cons (car raw
) (mapcar (lambda (r) (concat ":" r
)) (cdr raw
)))))))))
1535 (defun org-babel-parse-multiple-vars (header-arguments)
1536 "Expand multiple variable assignments behind a single :var keyword.
1538 This allows expression of multiple variables with one :var as
1541 #+PROPERTY: var foo=1, bar=2"
1543 (mapc (lambda (pair)
1544 (if (eq (car pair
) :var
)
1545 (mapcar (lambda (v) (push (cons :var
(org-trim v
)) results
))
1546 (org-babel-join-splits-near-ch
1547 61 (org-babel-balanced-split (cdr pair
) 32)))
1548 (push pair results
)))
1550 (nreverse results
)))
1552 (defun org-babel-process-params (params)
1553 "Expand variables in PARAMS and add summary parameters."
1554 (let* ((processed-vars (mapcar (lambda (el)
1557 (org-babel-ref-parse el
)))
1558 (org-babel--get-vars params
)))
1559 (vars-and-names (if (and (assq :colname-names params
)
1560 (assq :rowname-names params
))
1561 (list processed-vars
)
1562 (org-babel-disassemble-tables
1564 (cdr (assq :hlines params
))
1565 (cdr (assq :colnames params
))
1566 (cdr (assq :rownames params
)))))
1567 (raw-result (or (cdr (assq :results params
)) ""))
1568 (result-params (delete-dups
1570 (split-string (if (stringp raw-result
)
1572 (eval raw-result t
)))
1573 (cdr (assq :result-params params
))))))
1575 (mapcar (lambda (var) (cons :var var
)) (car vars-and-names
))
1577 (cons :colname-names
(or (cdr (assq :colname-names params
))
1578 (cadr vars-and-names
)))
1579 (cons :rowname-names
(or (cdr (assq :rowname-names params
))
1580 (cl-caddr vars-and-names
)))
1581 (cons :result-params result-params
)
1582 (cons :result-type
(cond ((member "output" result-params
) 'output
)
1583 ((member "value" result-params
) 'value
)
1586 (lambda (x) (memq (car x
) '(:colname-names
:rowname-names
:result-params
1587 :result-type
:var
)))
1590 ;; row and column names
1591 (defun org-babel-del-hlines (table)
1592 "Remove all `hline's from TABLE."
1593 (remq 'hline table
))
1595 (defun org-babel-get-colnames (table)
1596 "Return the column names of TABLE.
1597 Return a cons cell, the `car' of which contains the TABLE less
1598 colnames, and the `cdr' of which contains a list of the column
1600 (if (eq 'hline
(nth 1 table
))
1601 (cons (cddr table
) (car table
))
1602 (cons (cdr table
) (car table
))))
1604 (defun org-babel-get-rownames (table)
1605 "Return the row names of TABLE.
1606 Return a cons cell, the `car' of which contains the TABLE less
1607 rownames, and the `cdr' of which contains a list of the rownames.
1608 Note: this function removes any hlines in TABLE."
1609 (let* ((table (org-babel-del-hlines table
))
1610 (rownames (funcall (lambda ()
1616 (setq tp
(cdr tp
))))
1618 (cons table rownames
)))
1620 (defun org-babel-put-colnames (table colnames
)
1621 "Add COLNAMES to TABLE if they exist."
1622 (if colnames
(apply 'list colnames
'hline table
) table
))
1624 (defun org-babel-put-rownames (table rownames
)
1625 "Add ROWNAMES to TABLE if they exist."
1627 (mapcar (lambda (row)
1629 (cons (or (pop rownames
) "") row
)
1633 (defun org-babel-pick-name (names selector
)
1634 "Select one out of an alist of row or column names.
1635 SELECTOR can be either a list of names in which case those names
1636 will be returned directly, or an index into the list NAMES in
1637 which case the indexed names will be return."
1638 (if (listp selector
)
1641 (if (and selector
(symbolp selector
) (not (equal t selector
)))
1642 (cdr (assoc selector names
))
1643 (if (integerp selector
)
1644 (nth (- selector
1) names
)
1645 (cdr (car (last names
))))))))
1647 (defun org-babel-disassemble-tables (vars hlines colnames rownames
)
1648 "Parse tables for further processing.
1649 Process the variables in VARS according to the HLINES,
1650 ROWNAMES and COLNAMES header arguments. Return a list consisting
1651 of the vars, cnames and rnames."
1652 (let (cnames rnames
)
1656 (when (listp (cdr var
))
1657 (when (and (not (equal colnames
"no"))
1658 (or colnames
(and (eq (nth 1 (cdr var
)) 'hline
)
1659 (not (member 'hline
(cddr (cdr var
)))))))
1660 (let ((both (org-babel-get-colnames (cdr var
))))
1661 (setq cnames
(cons (cons (car var
) (cdr both
))
1663 (setq var
(cons (car var
) (car both
)))))
1664 (when (and rownames
(not (equal rownames
"no")))
1665 (let ((both (org-babel-get-rownames (cdr var
))))
1666 (setq rnames
(cons (cons (car var
) (cdr both
))
1668 (setq var
(cons (car var
) (car both
)))))
1669 (when (and hlines
(not (equal hlines
"yes")))
1670 (setq var
(cons (car var
) (org-babel-del-hlines (cdr var
))))))
1673 (reverse cnames
) (reverse rnames
))))
1675 (defun org-babel-reassemble-table (table colnames rownames
)
1676 "Add column and row names to a table.
1677 Given a TABLE and set of COLNAMES and ROWNAMES add the names
1678 to the table for reinsertion to org-mode."
1680 (let ((table (if (and rownames
(= (length table
) (length rownames
)))
1681 (org-babel-put-rownames table rownames
) table
)))
1682 (if (and colnames
(listp (car table
)) (= (length (car table
))
1684 (org-babel-put-colnames table colnames
) table
))
1687 (defun org-babel-where-is-src-block-head (&optional src-block
)
1688 "Find where the current source block begins.
1690 If optional argument SRC-BLOCK is `src-block' type element, find
1691 its current beginning instead.
1693 Return the point at the beginning of the current source block.
1694 Specifically at the beginning of the #+BEGIN_SRC line. Also set
1695 match-data relatively to `org-babel-src-block-regexp', which see.
1696 If the point is not on a source block then return nil."
1697 (let ((element (or src-block
(org-element-at-point))))
1698 (when (eq (org-element-type element
) 'src-block
)
1699 (let ((end (org-element-property :end element
)))
1700 (org-with-wide-buffer
1701 ;; Ensure point is not on a blank line after the block.
1703 (skip-chars-forward " \r\t\n" end
)
1704 (when (< (point) end
)
1705 (prog1 (goto-char (org-element-property :post-affiliated element
))
1706 (looking-at org-babel-src-block-regexp
))))))))
1709 (defun org-babel-goto-src-block-head ()
1710 "Go to the beginning of the current code block."
1712 (let ((head (org-babel-where-is-src-block-head)))
1713 (if head
(goto-char head
) (error "Not currently in a code block"))))
1716 (defun org-babel-goto-named-src-block (name)
1717 "Go to a named source-code block."
1719 (let ((completion-ignore-case t
)
1720 (case-fold-search t
)
1721 (all-block-names (org-babel-src-block-names)))
1722 (list (completing-read
1723 "source-block name: " all-block-names nil t
1724 (let* ((context (org-element-context))
1725 (type (org-element-type context
))
1727 (and (memq type
'(inline-src-block src-block
))
1728 (org-in-regexp (org-babel-noweb-wrap)))))
1732 (+ (car noweb-ref
) (length org-babel-noweb-wrap-start
))
1733 (- (cdr noweb-ref
) (length org-babel-noweb-wrap-end
))))
1734 ((memq type
'(babel-call inline-babel-call
)) ;#+CALL:
1735 (org-element-property :call context
))
1736 ((car (org-element-property :results context
))) ;#+RESULTS:
1737 ((let ((symbol (thing-at-point 'symbol
))) ;Symbol.
1739 (member-ignore-case symbol all-block-names
)
1742 (let ((point (org-babel-find-named-block name
)))
1744 ;; Taken from `org-open-at-point'.
1745 (progn (org-mark-ring-push) (goto-char point
) (org-show-context))
1746 (message "source-code block `%s' not found in this buffer" name
))))
1748 (defun org-babel-find-named-block (name)
1749 "Find a named source-code block.
1750 Return the location of the source block identified by source
1751 NAME, or nil if no such block exists. Set match data according
1752 to `org-babel-named-src-block-regexp'."
1754 (goto-char (point-min))
1756 (org-next-block 1 nil
(org-babel-named-src-block-regexp-for-name name
)))))
1758 (defun org-babel-src-block-names (&optional file
)
1759 "Returns the names of source blocks in FILE or the current buffer."
1760 (when file
(find-file file
))
1762 (goto-char (point-min))
1763 (let ((re (org-babel-named-src-block-regexp-for-name))
1765 (while (ignore-errors (org-next-block 1 nil re
))
1766 (push (match-string-no-properties 9) names
))
1770 (defun org-babel-goto-named-result (name)
1771 "Go to a named result."
1773 (let ((completion-ignore-case t
))
1774 (list (completing-read "Source-block name: "
1775 (org-babel-result-names) nil t
))))
1776 (let ((point (org-babel-find-named-result name
)))
1778 ;; taken from `org-open-at-point'
1779 (progn (goto-char point
) (org-show-context))
1780 (message "result `%s' not found in this buffer" name
))))
1782 (defun org-babel-find-named-result (name)
1783 "Find a named result.
1784 Return the location of the result named NAME in the current
1785 buffer or nil if no such result exists."
1787 (goto-char (point-min))
1788 (let ((case-fold-search t
)
1789 (re (format "^[ \t]*#\\+%s.*?:[ \t]*%s[ \t]*$"
1790 org-babel-results-keyword
1791 (regexp-quote name
))))
1793 (while (re-search-forward re nil t
)
1794 (let ((element (org-element-at-point)))
1795 (when (or (eq (org-element-type element
) 'keyword
)
1797 (org-element-property :post-affiliated element
)))
1798 (throw :found
(line-beginning-position)))))))))
1800 (defun org-babel-result-names (&optional file
)
1801 "Returns the names of results in FILE or the current buffer."
1803 (when file
(find-file file
)) (goto-char (point-min))
1804 (let ((case-fold-search t
) names
)
1805 (while (re-search-forward org-babel-result-w-name-regexp nil t
)
1806 (setq names
(cons (match-string-no-properties 9) names
)))
1810 (defun org-babel-next-src-block (&optional arg
)
1811 "Jump to the next source block.
1812 With optional prefix argument ARG, jump forward ARG many source blocks."
1814 (org-next-block arg nil org-babel-src-block-regexp
))
1817 (defun org-babel-previous-src-block (&optional arg
)
1818 "Jump to the previous source block.
1819 With optional prefix argument ARG, jump backward ARG many source blocks."
1821 (org-previous-block arg org-babel-src-block-regexp
))
1823 (defvar org-babel-load-languages
)
1826 (defun org-babel-mark-block ()
1827 "Mark current src block."
1829 (let ((head (org-babel-where-is-src-block-head)))
1833 (looking-at org-babel-src-block-regexp
))
1834 (push-mark (match-end 5) nil t
)
1835 (goto-char (match-beginning 5)))))
1837 (defun org-babel-demarcate-block (&optional arg
)
1838 "Wrap or split the code in the region or on the point.
1839 When called from inside of a code block the current block is
1840 split. When called from outside of a code block a new code block
1841 is created. In both cases if the region is demarcated and if the
1842 region is not active then the point is demarcated."
1844 (let* ((info (org-babel-get-src-block-info 'light
))
1845 (start (org-babel-where-is-src-block-head))
1846 (block (and start
(match-string 0)))
1847 (headers (and start
(match-string 4)))
1848 (stars (concat (make-string (or (org-current-level) 1) ?
*) " "))
1849 (lower-case-p (and block
1850 (let (case-fold-search)
1851 (string-match-p "#\\+begin_src" block
)))))
1857 (let ((lang (nth 0 info
))
1858 (indent (make-string (org-get-indentation) ?\s
)))
1859 (when (string-match "^[[:space:]]*$"
1860 (buffer-substring (point-at-bol)
1862 (delete-region (point-at-bol) (point-at-eol)))
1864 (if (looking-at "^") "" "\n")
1865 indent
(funcall (if lower-case-p
'downcase
'upcase
) "#+end_src\n")
1866 (if arg stars indent
) "\n"
1867 indent
(funcall (if lower-case-p
'downcase
'upcase
) "#+begin_src ")
1869 (if (> (length headers
) 1)
1870 (concat " " headers
) headers
)
1871 (if (looking-at "[\n\r]")
1873 (concat "\n" (make-string (current-column) ?
)))))))
1874 (move-end-of-line 2))
1875 (sort (if (org-region-active-p) (list (mark) (point)) (list (point))) #'>))
1876 (let ((start (point))
1877 (lang (completing-read
1879 (mapcar #'symbol-name
1881 (append (mapcar #'car org-babel-load-languages
)
1882 (mapcar (lambda (el) (intern (car el
)))
1883 org-src-lang-modes
))))))
1884 (body (delete-and-extract-region
1885 (if (org-region-active-p) (mark) (point)) (point))))
1886 (insert (concat (if (looking-at "^") "" "\n")
1887 (if arg
(concat stars
"\n") "")
1888 (funcall (if lower-case-p
'downcase
'upcase
) "#+begin_src ")
1891 (if (or (= (length body
) 0)
1892 (string-suffix-p "\r" body
)
1893 (string-suffix-p "\n" body
)) "" "\n")
1894 (funcall (if lower-case-p
'downcase
'upcase
) "#+end_src\n")))
1895 (goto-char start
) (move-end-of-line 1)))))
1897 (defun org-babel--insert-results-keyword (name hash
)
1898 "Insert RESULTS keyword with NAME value at point.
1899 If NAME is nil, results are anonymous. HASH is a string used as
1900 the results hash, or nil. Leave point before the keyword."
1901 (save-excursion (insert "\n")) ;open line to indent.
1904 (insert (concat "#+" org-babel-results-keyword
1905 (cond ((not hash
) nil
)
1906 (org-babel-hash-show-time
1908 (format-time-string "<%F %T>")
1910 (t (format "[%s]" hash
)))
1912 (when name
(concat " " name
))
1914 ;; Make sure results are going to be followed by at least one blank
1915 ;; line so they do not get merged with the next element, e.g.,
1920 ;; : fixed-width area, unrelated to the above.
1921 (unless (looking-at "^[ \t]*$") (save-excursion (insert "\n")))
1922 (beginning-of-line 0)
1923 (when hash
(org-babel-hide-hash)))
1925 (defun org-babel--clear-results-maybe (hash)
1926 "Clear results when hash doesn't match HASH.
1928 When results hash does not match HASH, remove RESULTS keyword at
1929 point, along with related contents. Do nothing if HASH is nil.
1931 Return a non-nil value if results were cleared. In this case,
1932 leave point where new results should be inserted."
1934 (looking-at org-babel-result-regexp
)
1935 (unless (string= (match-string 1) hash
)
1936 (let* ((e (org-element-at-point))
1937 (post (copy-marker (org-element-property :post-affiliated e
))))
1941 (goto-char (org-element-property :end e
))
1942 (skip-chars-backward " \t\n")
1943 (line-beginning-position 2)))
1944 ;; Delete RESULT keyword. However, if RESULTS keyword is
1945 ;; orphaned, ignore this part. The deletion above already
1947 (unless (= (point) post
)
1948 (delete-region (line-beginning-position)
1949 (line-beginning-position 2)))
1951 (set-marker post nil
)
1954 (defun org-babel-where-is-src-block-result (&optional insert _info hash
)
1955 "Find where the current source block results begin.
1957 Return the point at the beginning of the result of the current
1958 source block, specifically at the beginning of the results line.
1960 If no result exists for this block return nil, unless optional
1961 argument INSERT is non-nil. In this case, create a results line
1962 following the source block and return the position at its
1963 beginning. In the case of inline code, remove the results part
1966 If optional argument HASH is a string, remove contents related to
1967 RESULTS keyword if its hash is different. Then update the latter
1969 (let ((context (org-element-context)))
1971 (org-with-wide-buffer
1972 (pcase (org-element-type context
)
1973 ((or `inline-babel-call
`inline-src-block
)
1974 ;; Results for inline objects are located right after them.
1975 ;; There is no RESULTS line to insert either.
1976 (let ((limit (org-element-property
1977 :contents-end
(org-element-property :parent context
))))
1978 (goto-char (org-element-property :end context
))
1979 (skip-chars-forward " \t\n" limit
)
1983 (let ((result (org-element-context)))
1984 (and (eq (org-element-type result
) 'macro
)
1985 (string= (org-element-property :key result
)
1987 (if (not insert
) (point)
1991 (goto-char (org-element-property :end result
))
1992 (skip-chars-backward " \t")
1995 ((or `babel-call
`src-block
)
1996 (let* ((name (org-element-property :name context
))
1997 (named-results (and name
(org-babel-find-named-result name
))))
1998 (goto-char (or named-results
(org-element-property :end context
)))
2000 ;; Existing results named after the current source.
2002 (when (org-babel--clear-results-maybe hash
)
2003 (org-babel--insert-results-keyword name hash
))
2004 (throw :found
(point)))
2005 ;; Named results expect but none to be found.
2007 ;; No possible anonymous results at the very end of
2008 ;; buffer or outside CONTEXT parent.
2010 (or (org-element-property
2011 :contents-end
(org-element-property :parent context
))
2013 ;; Check if next element is an anonymous result below
2014 ;; the current block.
2015 ((let* ((next (org-element-at-point))
2016 (end (save-excursion
2018 (org-element-property :post-affiliated next
))
2019 (line-end-position)))
2020 (empty-result-re (concat org-babel-result-regexp
"$"))
2021 (case-fold-search t
))
2022 (re-search-forward empty-result-re end t
))
2024 (when (org-babel--clear-results-maybe hash
)
2025 (org-babel--insert-results-keyword nil hash
))
2026 (throw :found
(point))))))
2027 ;; Ignore other elements.
2028 (_ (throw :found nil
))))
2029 ;; No result found. Insert a RESULTS keyword below element, if
2030 ;; appropriate. In this case, ensure there is an empty line
2031 ;; after the previous element.
2034 (goto-char (min (org-element-property :end context
) (point-max)))
2035 (skip-chars-backward " \t\n")
2037 (unless (bolp) (insert "\n"))
2039 (org-babel--insert-results-keyword
2040 (org-element-property :name context
) hash
)
2043 (defun org-babel-read-element (element)
2044 "Read ELEMENT into emacs-lisp.
2045 Return nil if ELEMENT cannot be read."
2046 (org-with-wide-buffer
2047 (goto-char (org-element-property :post-affiliated element
))
2048 (pcase (org-element-type element
)
2050 (let ((v (org-trim (org-element-property :value element
))))
2051 (or (org-babel--string-to-number v
) v
)))
2052 (`table
(org-babel-read-table))
2053 (`plain-list
(org-babel-read-list))
2055 (let ((v (org-element-property :value element
)))
2056 (if (or org-src-preserve-indentation
2057 (org-element-property :preserve-indent element
))
2059 (org-remove-indentation v
))))
2061 (org-remove-indentation (org-element-property :value element
)))
2063 ;; Treat paragraphs containing a single link specially.
2064 (skip-chars-forward " \t")
2065 (if (and (looking-at org-bracket-link-regexp
)
2067 (goto-char (match-end 0))
2068 (skip-chars-forward " \r\t\n")
2069 (<= (org-element-property :end element
)
2071 (org-babel-read-link)
2072 (buffer-substring-no-properties
2073 (org-element-property :contents-begin element
)
2074 (org-element-property :contents-end element
))))
2075 ((or `center-block
`quote-block
`verse-block
`special-block
)
2076 (org-remove-indentation
2077 (buffer-substring-no-properties
2078 (org-element-property :contents-begin element
)
2079 (org-element-property :contents-end element
))))
2082 (defun org-babel-read-result ()
2083 "Read the result at point into emacs-lisp."
2084 (and (not (save-excursion
2086 (looking-at-p "[ \t]*$")))
2087 (org-babel-read-element (org-element-at-point))))
2089 (defun org-babel-read-table ()
2090 "Read the table at point into emacs-lisp."
2091 (mapcar (lambda (row)
2092 (if (and (symbolp row
) (equal row
'hline
)) row
2093 (mapcar (lambda (el) (org-babel-read el
'inhibit-lisp-eval
)) row
)))
2094 (org-table-to-lisp)))
2096 (defun org-babel-read-list ()
2097 "Read the list at point into emacs-lisp."
2098 (mapcar (lambda (el) (org-babel-read el
'inhibit-lisp-eval
))
2099 (cdr (org-list-to-lisp))))
2101 (defvar org-link-types-re
)
2102 (defun org-babel-read-link ()
2103 "Read the link at point into emacs-lisp.
2104 If the path of the link is a file path it is expanded using
2105 `expand-file-name'."
2106 (let* ((case-fold-search t
)
2107 (raw (and (looking-at org-bracket-link-regexp
)
2108 (org-no-properties (match-string 1))))
2109 (type (and (string-match org-link-types-re raw
)
2110 (match-string 1 raw
))))
2112 ((not type
) (expand-file-name raw
))
2113 ((string= type
"file")
2114 (and (string-match "file\\(.*\\):\\(.+\\)" raw
)
2115 (expand-file-name (match-string 2 raw
))))
2118 (defun org-babel-format-result (result &optional sep
)
2119 "Format RESULT for writing to file."
2120 (let ((echo-res (lambda (r) (if (stringp r
) r
(format "%S" r
)))))
2124 result
(list :sep
(or sep
"\t") :fmt echo-res
))
2126 (funcall echo-res result
))))
2128 (defun org-babel-insert-result (result &optional result-params info hash lang
)
2129 "Insert RESULT into the current buffer.
2131 By default RESULT is inserted after the end of the current source
2132 block. The RESULT of an inline source block usually will be
2133 wrapped inside a `results' macro and placed on the same line as
2134 the inline source block. The macro is stripped upon export.
2135 Multiline and non-scalar RESULTS from inline source blocks are
2136 not allowed. With optional argument RESULT-PARAMS controls
2137 insertion of results in the Org mode file. RESULT-PARAMS can
2138 take the following values:
2140 replace - (default option) insert results after the source block
2141 or inline source block replacing any previously
2144 silent -- no results are inserted into the Org buffer but
2145 the results are echoed to the minibuffer and are
2146 ingested by Emacs (a potentially time consuming
2149 file ---- the results are interpreted as a file path, and are
2150 inserted into the buffer using the Org file syntax.
2152 list ---- the results are interpreted as an Org list.
2154 raw ----- results are added directly to the Org file. This is
2155 a good option if you code block will output Org
2158 drawer -- results are added directly to the Org file as with
2159 \"raw\", but are wrapped in a RESULTS drawer or results
2160 macro, allowing them to later be replaced or removed
2163 org ----- results are added inside of a \"src_org{}\" or \"#+BEGIN_SRC
2164 org\" block depending on whether the current source block is
2165 inline or not. They are not comma-escaped when inserted,
2166 but Org syntax here will be discarded when exporting the
2169 html ---- results are added inside of a #+BEGIN_EXPORT HTML block
2170 or html export snippet depending on whether the current
2171 source block is inline or not. This is a good option
2172 if your code block will output html formatted text.
2174 latex --- results are added inside of a #+BEGIN_EXPORT LATEX
2175 block or latex export snippet depending on whether the
2176 current source block is inline or not. This is a good
2177 option if your code block will output latex formatted
2180 code ---- the results are extracted in the syntax of the source
2181 code of the language being evaluated and are added
2182 inside of a source block with the source-code language
2183 set appropriately. Also, source block inlining is
2184 preserved in this case. Note this relies on the
2185 optional LANG argument.
2187 list ---- the results are rendered as a list. This option not
2188 allowed for inline src blocks.
2190 table --- the results are rendered as a table. This option not
2191 allowed for inline src blocks.
2193 INFO may provide the values of these header arguments (in the
2194 `header-arguments-alist' see the docstring for
2195 `org-babel-get-src-block-info'):
2197 :file --- the name of the file to which output should be written.
2199 :wrap --- the effect is similar to `latex' in RESULT-PARAMS but
2200 using the argument supplied to specify the export block
2202 (cond ((stringp result
)
2203 (setq result
(org-no-properties result
))
2204 (when (member "file" result-params
)
2205 (setq result
(org-babel-result-to-file
2206 result
(when (assq :file-desc
(nth 2 info
))
2207 (or (cdr (assq :file-desc
(nth 2 info
)))
2210 (t (setq result
(format "%S" result
))))
2211 (if (and result-params
(member "silent" result-params
))
2212 (progn (message (replace-regexp-in-string "%" "%%" (format "%S" result
)))
2214 (let ((inline (let ((context (org-element-context)))
2215 (and (memq (org-element-type context
)
2216 '(inline-babel-call inline-src-block
))
2220 (or (and (member "table" result-params
) "`:results table'")
2221 (and (listp result
) "list result")
2222 (and (string-match-p "\n." result
) "multiline result")
2223 (and (member "list" result-params
) "`:results list'"))))
2225 (user-error "Inline error: %s cannot be used" warning
))))
2227 (let* ((visible-beg (point-min-marker))
2228 (visible-end (copy-marker (point-max) t
))
2229 (inline (let ((context (org-element-context)))
2230 (and (memq (org-element-type context
)
2231 '(inline-babel-call inline-src-block
))
2233 (existing-result (org-babel-where-is-src-block-result t nil hash
))
2234 (results-switches (cdr (assq :results_switches
(nth 2 info
))))
2235 ;; When results exist outside of the current visible
2236 ;; region of the buffer, be sure to widen buffer to
2238 (outside-scope (and existing-result
2240 (or (> visible-beg existing-result
)
2241 (<= visible-end existing-result
))))
2243 ;; Ensure non-inline results end in a newline.
2244 (when (and (org-string-nw-p result
)
2246 (not (string-equal (substring result -
1) "\n")))
2247 (setq result
(concat result
"\n")))
2250 (when outside-scope
(widen))
2251 (if existing-result
(goto-char existing-result
)
2252 (goto-char (org-element-property :end inline
))
2253 (skip-chars-backward " \t"))
2255 (setq indent
(org-get-indentation))
2260 ;; Make sure new results are separated from the
2261 ;; source code by one space.
2262 (unless existing-result
2264 (setq beg
(point))))
2265 ((member "replace" result-params
)
2266 (delete-region (point) (org-babel-result-end)))
2267 ((member "append" result-params
)
2268 (goto-char (org-babel-result-end)) (setq beg
(point-marker)))
2269 ((member "prepend" result-params
))) ; already there
2270 (setq results-switches
2271 (if results-switches
(concat " " results-switches
) ""))
2272 (let ((wrap (lambda (start finish
&optional no-escape no-newlines
2273 inline-start inline-finish
)
2275 (setq start inline-start
)
2276 (setq finish inline-finish
)
2277 (setq no-newlines t
))
2279 (insert (concat finish
(unless no-newlines
"\n")))
2281 (insert (concat start
(unless no-newlines
"\n")))
2283 (org-escape-code-in-region (min (point) end
) end
))
2285 (unless no-newlines
(goto-char (point-at-eol)))
2286 (setq end
(point-marker))))
2289 ;; Non-nil when result R can be turned into
2292 (null (cdr (last r
)))
2294 (lambda (e) (or (atom e
) (null (cdr (last e
)))))
2296 ;; insert results based on type
2298 ;; Do nothing for an empty result.
2300 ;; Insert a list if preferred.
2301 ((member "list" result-params
)
2304 (org-list-to-generic
2308 (list (if (stringp e
) e
(format "%S" e
))))
2309 (if (listp result
) result
2310 (split-string result
"\n" t
))))
2311 '(:splicep nil
:istart
"- " :iend
"\n")))
2313 ;; Try hard to print RESULT as a table. Give up if
2314 ;; it contains an improper list.
2315 ((funcall tabulablep result
)
2317 (insert (concat (orgtbl-to-orgtbl
2320 (or (eq e
'hline
) (listp e
)))
2327 (when (org-at-table-p) (org-table-align))
2328 (goto-char (org-table-end)))
2329 ;; Print verbatim a list that cannot be turned into
2331 ((listp result
) (insert (format "%s\n" result
)))
2332 ((member "file" result-params
)
2334 (setq result
(org-macro-escape-arguments result
)))
2336 ((and inline
(not (member "raw" result-params
)))
2337 (insert (org-macro-escape-arguments
2338 (org-babel-chomp result
"\n"))))
2339 (t (goto-char beg
) (insert result
)))
2340 (setq end
(point-marker))
2341 ;; possibly wrap result
2343 ((assq :wrap
(nth 2 info
))
2344 (let ((name (or (cdr (assq :wrap
(nth 2 info
))) "RESULTS")))
2345 (funcall wrap
(concat "#+BEGIN_" name
)
2346 (concat "#+END_" (car (org-split-string name
)))
2347 nil nil
(concat "{{{results(@@" name
":") "@@)}}}")))
2348 ((member "html" result-params
)
2349 (funcall wrap
"#+BEGIN_EXPORT html" "#+END_EXPORT" nil nil
2350 "{{{results(@@html:" "@@)}}}"))
2351 ((member "latex" result-params
)
2352 (funcall wrap
"#+BEGIN_EXPORT latex" "#+END_EXPORT" nil nil
2353 "{{{results(@@latex:" "@@)}}}"))
2354 ((member "org" result-params
)
2355 (goto-char beg
) (when (org-at-table-p) (org-cycle))
2356 (funcall wrap
"#+BEGIN_SRC org" "#+END_SRC" nil nil
2357 "{{{results(src_org{" "})}}}"))
2358 ((member "code" result-params
)
2359 (let ((lang (or lang
"none")))
2360 (funcall wrap
(format "#+BEGIN_SRC %s%s" lang results-switches
)
2362 (format "{{{results(src_%s[%s]{" lang results-switches
)
2364 ((member "raw" result-params
)
2365 (goto-char beg
) (when (org-at-table-p) (org-cycle)))
2366 ((or (member "drawer" result-params
)
2367 ;; Stay backward compatible with <7.9.2
2368 (member "wrap" result-params
))
2369 (goto-char beg
) (when (org-at-table-p) (org-cycle))
2370 (funcall wrap
":RESULTS:" ":END:" 'no-escape nil
2371 "{{{results(" ")}}}"))
2372 ((and inline
(member "file" result-params
))
2373 (funcall wrap nil nil nil nil
"{{{results(" ")}}}"))
2374 ((and (not (funcall tabulablep result
))
2375 (not (member "file" result-params
)))
2376 (let ((org-babel-inline-result-wrap
2377 ;; Hard code {{{results(...)}}} on top of customization.
2378 (format "{{{results(%s)}}}"
2379 org-babel-inline-result-wrap
)))
2380 (org-babel-examplify-region beg end results-switches inline
)
2381 (setq end
(point))))))
2382 ;; Possibly indent results in par with #+results line.
2383 (when (and (not inline
) (numberp indent
) (> indent
0)
2384 ;; In this case `table-align' does the work
2386 (not (and (listp result
)
2387 (member "append" result-params
))))
2388 (indent-rigidly beg end indent
))
2390 (if (member "value" result-params
)
2391 (message "Code block returned no value.")
2392 (message "Code block produced no output."))
2393 (message "Code block evaluation complete.")))
2394 (when outside-scope
(narrow-to-region visible-beg visible-end
))
2395 (set-marker visible-beg nil
)
2396 (set-marker visible-end nil
)))))))
2398 (defun org-babel-remove-result (&optional info keep-keyword
)
2399 "Remove the result of the current source block."
2401 (let ((location (org-babel-where-is-src-block-result nil info
)))
2404 (goto-char location
)
2405 (when (looking-at (concat org-babel-result-regexp
".*$"))
2407 (if keep-keyword
(1+ (match-end 0)) (1- (match-beginning 0)))
2408 (progn (forward-line 1) (org-babel-result-end))))))))
2410 (defun org-babel-remove-inline-result (&optional datum
)
2411 "Remove the result of the current inline-src-block or babel call.
2412 The result must be wrapped in a `results' macro to be removed.
2413 Leading white space is trimmed."
2415 (let* ((el (or datum
(org-element-context))))
2416 (when (memq (org-element-type el
) '(inline-src-block inline-babel-call
))
2417 (org-with-wide-buffer
2418 (goto-char (org-element-property :end el
))
2419 (skip-chars-backward " \t")
2420 (let ((result (save-excursion
2423 (org-element-property
2424 :contents-end
(org-element-property :parent el
)))
2425 (org-element-context))))
2426 (when (and (eq (org-element-type result
) 'macro
)
2427 (string= (org-element-property :key result
) "results"))
2428 (delete-region ; And leading whitespace.
2430 (progn (goto-char (org-element-property :end result
))
2431 (skip-chars-backward " \t\n")
2434 (defun org-babel-remove-result-one-or-many (x)
2435 "Remove the result of the current source block.
2436 If called with a prefix argument, remove all result blocks
2440 (org-babel-map-src-blocks nil
(org-babel-remove-result))
2441 (org-babel-remove-result)))
2443 (defun org-babel-result-end ()
2444 "Return the point at the end of the current set of results."
2447 ((org-at-table-p) (progn (goto-char (org-table-end)) (point)))
2448 ((org-at-item-p) (let* ((struct (org-list-struct))
2449 (prvs (org-list-prevs-alist struct
)))
2450 (org-list-get-list-end (point-at-bol) struct prvs
)))
2451 ((let ((case-fold-search t
)) (looking-at "^\\([ \t]*\\):results:"))
2452 (progn (re-search-forward (concat "^" (match-string 1) ":END:"))
2453 (forward-char 1) (point)))
2455 (let ((case-fold-search t
))
2456 (if (looking-at (concat "[ \t]*#\\+begin_\\([^ \t\n\r]+\\)"))
2457 (progn (re-search-forward (concat "[ \t]*#\\+end_" (match-string 1))
2460 (while (looking-at "[ \t]*\\(: \\|:$\\|\\[\\[\\)")
2464 (defun org-babel-result-to-file (result &optional description
)
2465 "Convert RESULT into an `org-mode' link with optional DESCRIPTION.
2466 If the `default-directory' is different from the containing
2467 file's directory then expand relative links."
2468 (when (stringp result
)
2469 (format "[[file:%s]%s]"
2470 (if (and default-directory
2472 (not (string= (expand-file-name default-directory
)
2474 (file-name-directory buffer-file-name
)))))
2475 (expand-file-name result default-directory
)
2477 (if description
(concat "[" description
"]") ""))))
2479 (defvar org-babel-capitalize-example-region-markers nil
2480 "Make true to capitalize begin/end example markers inserted by code blocks.")
2482 (defun org-babel-examplify-region (beg end
&optional results-switches inline
)
2483 "Comment out region using the inline `==' or `: ' org example quote."
2487 (if org-babel-capitalize-example-region-markers
(upcase str
) str
))))
2491 (insert (format org-babel-inline-result-wrap
2492 (delete-and-extract-region beg end
))))
2493 (let ((size (count-lines beg end
)))
2495 (cond ((= size
0)) ; do nothing for an empty result
2496 ((< size org-babel-min-lines-for-block-output
)
2499 (beginning-of-line 1) (insert ": ") (forward-line 1)))
2502 (insert (if results-switches
2504 (funcall maybe-cap
"#+begin_example")
2506 (funcall maybe-cap
"#+begin_example\n")))
2508 (if (markerp end
) (goto-char end
) (forward-char (- end beg
)))
2509 (org-escape-code-in-region p
(point)))
2510 (insert (funcall maybe-cap
"#+end_example\n")))))))))
2512 (defun org-babel-update-block-body (new-body)
2513 "Update the body of the current code block to NEW-BODY."
2514 (let ((element (org-element-at-point)))
2515 (unless (eq (org-element-type element
) 'src-block
)
2516 (error "Not in a source block"))
2517 (goto-char (org-babel-where-is-src-block-head element
))
2518 (let* ((ind (org-get-indentation))
2519 (body-start (line-beginning-position 2))
2520 (body (org-element-normalize-string
2521 (if (or org-src-preserve-indentation
2522 (org-element-property :preserve-indent element
))
2525 (insert (org-remove-indentation new-body
))
2529 (+ ind org-edit-src-content-indentation
))
2530 (buffer-string))))))
2531 (delete-region body-start
2532 (org-with-wide-buffer
2533 (goto-char (org-element-property :end element
))
2534 (skip-chars-backward " \t\n")
2535 (line-beginning-position)))
2536 (goto-char body-start
)
2539 (defun org-babel-merge-params (&rest plists
)
2540 "Combine all parameter association lists in PLISTS.
2541 Later elements of PLISTS override the values of previous elements.
2542 This takes into account some special considerations for certain
2543 parameters when merging lists."
2544 (let* ((results-exclusive-groups
2545 (mapcar (lambda (group) (mapcar #'symbol-name group
))
2546 (cdr (assq 'results org-babel-common-header-args-w-values
))))
2547 (exports-exclusive-groups
2548 (mapcar (lambda (group) (mapcar #'symbol-name group
))
2549 (cdr (assq 'exports org-babel-common-header-args-w-values
))))
2551 (lambda (exclusive-groups &rest result-params
)
2552 ;; Maintain exclusivity of mutually exclusive parameters,
2553 ;; as defined in EXCLUSIVE-GROUPS while merging lists in
2556 (dolist (new-params result-params
(delete-dups output
))
2557 (dolist (new-param new-params
)
2558 (dolist (exclusive-group exclusive-groups
)
2559 (when (member new-param exclusive-group
)
2560 (setq output
(cl-remove-if
2561 (lambda (o) (member o exclusive-group
))
2563 (push new-param output
))))))
2564 (variable-index 0) ;Handle positional arguments.
2566 params
;Final parameters list.
2567 ;; Some keywords accept multiple values. We need to treat
2569 vars results exports
)
2570 (dolist (plist plists
)
2571 (dolist (pair plist
)
2575 ((listp value
) (car value
))
2576 ((string-match "^\\([^= \f\t\n\r\v]+\\)[ \t]*=" value
)
2577 (intern (match-string 1 value
)))
2582 (append (if (not (assoc name vars
)) vars
2583 (push name clearnames
)
2584 (cl-remove-if (lambda (p) (equal name
(car p
)))
2586 (list (cons name pair
)))))
2587 ((and vars
(nth variable-index vars
))
2588 ;; If no name is given and we already have named
2589 ;; variables then assign to named variables in order.
2590 (let ((name (car (nth variable-index vars
))))
2591 ;; Clear out colnames and rownames for replace vars.
2592 (push name clearnames
)
2593 (setf (cddr (nth variable-index vars
))
2594 (concat (symbol-name name
) "=" value
))
2595 (cl-incf variable-index
)))
2596 (t (error "Variable \"%s\" must be assigned a default value"
2598 (`(:results .
,value
)
2599 (setq results
(funcall merge
2600 results-exclusive-groups
2603 (if (stringp value
) value
(eval value t
))))))
2604 (`(,(or :file
:file-ext
) .
,value
)
2605 ;; `:file' and `:file-ext' are regular keywords but they
2606 ;; imply a "file" `:results' and a "results" `:exports'.
2609 (funcall merge results-exclusive-groups results
'("file")))
2610 (unless (or (member "both" exports
)
2611 (member "none" exports
)
2612 (member "code" exports
))
2615 exports-exclusive-groups exports
'("results"))))
2616 (push pair params
)))
2617 (`(:exports .
,value
)
2618 (setq exports
(funcall merge
2619 exports-exclusive-groups
2621 (split-string (or value
"")))))
2622 ;; Regular keywords: any value overwrites the previous one.
2623 (_ (setq params
(cons pair
(assq-delete-all (car pair
) params
)))))))
2624 ;; Handle `:var' and clear out colnames and rownames for replaced
2626 (setq params
(nconc (mapcar (lambda (v) (cons :var
(cddr v
))) vars
)
2628 (dolist (name clearnames
)
2629 (dolist (param '(:colname-names
:rowname-names
))
2630 (when (assq param params
)
2631 (setf (cdr (assq param params
))
2632 (cl-remove-if (lambda (pair) (equal name
(car pair
)))
2633 (cdr (assq param params
))))
2635 (cl-remove-if (lambda (pair) (and (equal (car pair
) param
)
2638 ;; Handle other special keywords, which accept multiple values.
2639 (setq params
(nconc (list (cons :results
(mapconcat #'identity results
" "))
2640 (cons :exports
(mapconcat #'identity exports
" ")))
2642 ;; Return merged params.
2645 (defvar org-babel-use-quick-and-dirty-noweb-expansion nil
2646 "Set to true to use regular expressions to expand noweb references.
2647 This results in much faster noweb reference expansion but does
2648 not properly allow code blocks to inherit the \":noweb-ref\"
2649 header argument from buffer or subtree wide properties.")
2651 (defun org-babel-noweb-p (params context
)
2652 "Check if PARAMS require expansion in CONTEXT.
2653 CONTEXT may be one of :tangle, :export or :eval."
2654 (let ((allowed-values (cl-case context
2655 (:tangle
'("yes" "tangle" "no-export" "strip-export"))
2656 (:eval
'("yes" "no-export" "strip-export" "eval"))
2657 (:export
'("yes")))))
2658 (cl-some (lambda (v) (member v allowed-values
))
2659 (split-string (or (cdr (assq :noweb params
)) "")))))
2661 (defun org-babel-expand-noweb-references (&optional info parent-buffer
)
2662 "Expand Noweb references in the body of the current source code block.
2664 For example the following reference would be replaced with the
2665 body of the source-code block named `example-block'.
2669 Note that any text preceding the <<foo>> construct on a line will
2670 be interposed between the lines of the replacement text. So for
2671 example if <<foo>> is placed behind a comment, then the entire
2672 replacement text will also be commented.
2674 This function must be called from inside of the buffer containing
2675 the source-code block which holds BODY.
2677 In addition the following syntax can be used to insert the
2678 results of evaluating the source-code block named `example-block'.
2682 Any optional arguments can be passed to example-block by placing
2683 the arguments inside the parenthesis following the convention
2684 defined by `org-babel-lob'. For example
2686 <<example-block(a=9)>>
2688 would set the value of argument \"a\" equal to \"9\". Note that
2689 these arguments are not evaluated in the current source-code
2690 block but are passed literally to the \"example-block\"."
2691 (let* ((parent-buffer (or parent-buffer
(current-buffer)))
2692 (info (or info
(org-babel-get-src-block-info 'light
)))
2695 (ob-nww-start org-babel-noweb-wrap-start
)
2696 (ob-nww-end org-babel-noweb-wrap-end
)
2697 (comment (string= "noweb" (cdr (assq :comments
(nth 2 info
)))))
2698 (rx-prefix (concat "\\(" org-babel-src-name-regexp
"\\|"
2699 ":noweb-ref[ \t]+" "\\)"))
2701 (nb-add (lambda (text) (setq new-body
(concat new-body text
))))
2702 (c-wrap (lambda (text)
2704 (funcall (intern (concat lang
"-mode")))
2705 (comment-region (point) (progn (insert text
) (point)))
2706 (org-trim (buffer-string)))))
2707 index source-name evaluate prefix
)
2709 (setq-local org-babel-noweb-wrap-start ob-nww-start
)
2710 (setq-local org-babel-noweb-wrap-end ob-nww-end
)
2711 (insert body
) (goto-char (point-min))
2712 (setq index
(point))
2713 (while (and (re-search-forward (org-babel-noweb-wrap) nil t
))
2714 (save-match-data (setf source-name
(match-string 1)))
2715 (save-match-data (setq evaluate
(string-match "(.*)" source-name
)))
2718 (buffer-substring (match-beginning 0)
2720 (beginning-of-line 1) (point)))))
2721 ;; add interval to new-body (removing noweb reference)
2722 (goto-char (match-beginning 0))
2723 (funcall nb-add
(buffer-substring index
(point)))
2724 (goto-char (match-end 0))
2725 (setq index
(point))
2728 (with-current-buffer parent-buffer
2731 (mapconcat ;; Interpose PREFIX between every line.
2735 (let ((raw (org-babel-ref-resolve source-name
)))
2736 (if (stringp raw
) raw
(format "%S" raw
)))
2738 ;; Retrieve from the library of babel.
2739 (nth 2 (assoc (intern source-name
)
2740 org-babel-library-of-babel
))
2741 ;; Return the contents of headlines literally.
2743 (when (org-babel-ref-goto-headline-id source-name
)
2744 (org-babel-ref-headline-body)))
2745 ;; Find the expansion of reference in this buffer.
2746 (let ((rx (concat rx-prefix source-name
"[ \t\n]"))
2749 (goto-char (point-min))
2750 (if org-babel-use-quick-and-dirty-noweb-expansion
2751 (while (re-search-forward rx nil t
)
2752 (let* ((i (org-babel-get-src-block-info 'light
))
2753 (body (org-babel-expand-noweb-references i
))
2754 (sep (or (cdr (assq :noweb-sep
(nth 2 i
)))
2757 (let ((cs (org-babel-tangle-comment-links i
)))
2758 (concat (funcall c-wrap
(car cs
)) "\n"
2760 (funcall c-wrap
(cadr cs
))))
2762 (setq expansion
(cons sep
(cons full expansion
)))))
2763 (org-babel-map-src-blocks nil
2764 (let ((i (org-babel-get-src-block-info 'light
)))
2765 (when (equal (or (cdr (assq :noweb-ref
(nth 2 i
)))
2768 (let* ((body (org-babel-expand-noweb-references i
))
2769 (sep (or (cdr (assq :noweb-sep
(nth 2 i
)))
2772 (let ((cs (org-babel-tangle-comment-links i
)))
2773 (concat (funcall c-wrap
(car cs
)) "\n"
2775 (funcall c-wrap
(cadr cs
))))
2778 (cons sep
(cons full expansion
)))))))))
2780 (mapconcat #'identity
(nreverse (cdr expansion
)) "")))
2781 ;; Possibly raise an error if named block doesn't exist.
2782 (if (or org-babel-noweb-error-all-langs
2783 (member lang org-babel-noweb-error-langs
))
2785 (org-babel-noweb-wrap source-name
)
2786 "could not be resolved (see "
2787 "`org-babel-noweb-error-langs')"))
2789 "[\n\r]") (concat "\n" prefix
))))))
2790 (funcall nb-add
(buffer-substring index
(point-max))))
2793 (defun org-babel--script-escape-inner (str)
2794 (let (in-single in-double backslash out
)
2801 (setq backslash nil
)
2803 ((and in-single
(eq ch ?
'))
2804 ;; Escaped single quote inside single quoted string:
2805 ;; emit just a single quote, since we've changed the
2806 ;; outer quotes to double.
2809 ;; Escaped double quote
2811 ;; This should be interpreted as backslash+quote,
2812 ;; not an escape. Emit a three backslashes
2813 ;; followed by a quote (because one layer of
2814 ;; quoting will be stripped by `org-babel-read').
2815 (append (list ch ?
\\ ?
\\ ?
\\) out
)
2816 ;; Otherwise we are in a double-quoted string. Emit
2817 ;; a single escaped quote
2818 (append (list ch ?
\\) out
)))
2820 ;; Escaped backslash: emit a single escaped backslash
2821 (append (list ?
\\ ?
\\) out
))
2822 ;; Other: emit a quoted backslash followed by whatever
2823 ;; the character was (because one layer of quoting will
2824 ;; be stripped by `org-babel-read').
2825 (t (append (list ch ?
\\ ?
\\) out
))))
2827 (?\
[ (if (or in-double in-single
)
2830 (?\
] (if (or in-double in-single
)
2833 (?\
{ (if (or in-double in-single
)
2836 (?\
} (if (or in-double in-single
)
2839 (?
, (if (or in-double in-single
)
2840 (cons ?
, out
) (cons ?\s out
)))
2843 (setq in-single
(not in-single
)) (cons ?
\" out
)))
2845 (append (list ?
\" ?
\\) out
)
2846 (setq in-double
(not in-double
)) (cons ?
\" out
)))
2847 (?
\\ (unless (or in-single in-double
)
2848 (error "Can't handle backslash outside string in `org-babel-script-escape'"))
2851 (t (cons ch out
))))))
2852 (string-to-list str
))
2853 (when (or in-single in-double
)
2854 (error "Unterminated string in `org-babel-script-escape'"))
2855 (apply #'string
(reverse out
))))
2857 (defun org-babel-script-escape (str &optional force
)
2858 "Safely convert tables into elisp lists."
2859 (unless (stringp str
)
2860 (error "`org-babel-script-escape' expects a string"))
2863 ((and (> (length str
) 2)
2864 (or (and (string-equal "[" (substring str
0 1))
2865 (string-equal "]" (substring str -
1)))
2866 (and (string-equal "{" (substring str
0 1))
2867 (string-equal "}" (substring str -
1)))
2868 (and (string-equal "(" (substring str
0 1))
2869 (string-equal ")" (substring str -
1)))))
2871 (concat "'" (org-babel--script-escape-inner str
)))
2873 (and (> (length str
) 2)
2874 (or (and (string-equal "'" (substring str
0 1))
2875 (string-equal "'" (substring str -
1)))
2876 ;; We need to pass double-quoted strings
2877 ;; through the backslash-twiddling bits, even
2878 ;; though we don't need to change their
2880 (and (string-equal "\"" (substring str
0 1))
2881 (string-equal "\"" (substring str -
1))))))
2882 (org-babel--script-escape-inner str
))
2884 (condition-case nil
(org-babel-read escaped
) (error escaped
))))
2886 (defun org-babel-read (cell &optional inhibit-lisp-eval
)
2887 "Convert the string value of CELL to a number if appropriate.
2888 Otherwise if CELL looks like lisp (meaning it starts with a
2889 \"(\", \"\\='\", \"\\=`\" or a \"[\") then read and evaluate it as
2890 lisp, otherwise return it unmodified as a string. Optional
2891 argument INHIBIT-LISP-EVAL inhibits lisp evaluation for
2892 situations in which is it not appropriate."
2893 (cond ((not (org-string-nw-p cell
)) cell
)
2894 ((org-babel--string-to-number cell
))
2895 ((and (not inhibit-lisp-eval
)
2896 (or (memq (string-to-char cell
) '(?\
( ?
' ?
` ?\
[))
2897 (string= cell
"*this*")))
2898 (eval (read cell
) t
))
2899 ((eq (string-to-char cell
) ?
\") (read cell
))
2900 (t (org-no-properties cell
))))
2902 (defun org-babel--string-to-number (string)
2903 "If STRING represents a number return its value.
2904 Otherwise return nil."
2905 (and (string-match-p "\\`-?[0-9]*\\.?[0-9]*\\'" string
)
2906 (string-to-number string
)))
2908 (defun org-babel-import-elisp-from-file (file-name &optional separator
)
2909 "Read the results located at FILE-NAME into an elisp table.
2910 If the table is trivial, then return it as a scalar."
2912 (save-window-excursion
2916 (org-table-import file-name separator
)
2917 (delete-file file-name
)
2918 (setq result
(mapcar (lambda (row)
2919 (mapcar #'org-babel-string-read row
))
2920 (org-table-to-lisp))))
2921 (error (message "Error reading results: %s" err
) nil
)))
2922 (if (null (cdr result
)) ;; if result is trivial vector, then scalarize it
2923 (if (consp (car result
))
2924 (if (null (cdr (car result
)))
2930 (defun org-babel-string-read (cell)
2931 "Strip nested \"s from around strings."
2932 (org-babel-read (or (and (stringp cell
)
2933 (string-match "\\\"\\(.+\\)\\\"" cell
)
2934 (match-string 1 cell
))
2937 (defun org-babel-chomp (string &optional regexp
)
2938 "Strip a trailing space or carriage return from STRING.
2939 The default regexp used is \"[ \\f\\t\\n\\r\\v]\" but another one
2940 can be specified as the REGEXP argument."
2941 (let ((regexp (or regexp
"[ \f\t\n\r\v]")))
2942 (while (and (> (length string
) 0)
2943 (string-match regexp
(substring string -
1)))
2944 (setq string
(substring string
0 -
1)))
2947 (defun org-babel-process-file-name (name &optional no-quote-p
)
2948 "Prepare NAME to be used in an external process.
2949 If NAME specifies a remote location, the remote portion of the
2950 name is removed, since in that case the process will be executing
2951 remotely. The file name is then processed by `expand-file-name'.
2952 Unless second argument NO-QUOTE-P is non-nil, the file name is
2953 additionally processed by `shell-quote-argument'"
2954 (let ((f (org-babel-local-file-name (expand-file-name name
))))
2955 (if no-quote-p f
(shell-quote-argument f
))))
2957 (defvar org-babel-temporary-directory
)
2958 (unless (or noninteractive
(boundp 'org-babel-temporary-directory
))
2959 (defvar org-babel-temporary-directory
2960 (or (and (boundp 'org-babel-temporary-directory
)
2961 (file-exists-p org-babel-temporary-directory
)
2962 org-babel-temporary-directory
)
2963 (make-temp-file "babel-" t
))
2964 "Directory to hold temporary files created to execute code blocks.
2965 Used by `org-babel-temp-file'. This directory will be removed on
2968 (defcustom org-babel-remote-temporary-directory
"/tmp/"
2969 "Directory to hold temporary files on remote hosts."
2973 (defmacro org-babel-result-cond
(result-params scalar-form
&rest table-forms
)
2974 "Call the code to parse raw string results according to RESULT-PARAMS."
2976 (debug (form form
&rest form
)))
2977 (org-with-gensyms (params)
2978 `(let ((,params
,result-params
))
2979 (unless (member "none" ,params
)
2980 (if (or (member "scalar" ,params
)
2981 (member "verbatim" ,params
)
2982 (member "html" ,params
)
2983 (member "code" ,params
)
2984 (member "pp" ,params
)
2985 (member "file" ,params
)
2986 (and (or (member "output" ,params
)
2987 (member "raw" ,params
)
2988 (member "org" ,params
)
2989 (member "drawer" ,params
))
2990 (not (member "table" ,params
))))
2993 (def-edebug-spec org-babel-result-cond
(form form body
))
2995 (defun org-babel-temp-file (prefix &optional suffix
)
2996 "Create a temporary file in the `org-babel-temporary-directory'.
2997 Passes PREFIX and SUFFIX directly to `make-temp-file' with the
2998 value of `temporary-file-directory' temporarily set to the value
2999 of `org-babel-temporary-directory'."
3000 (if (file-remote-p default-directory
)
3002 (concat (file-remote-p default-directory
)
3004 prefix org-babel-remote-temporary-directory
))))
3005 (make-temp-file prefix nil suffix
))
3006 (let ((temporary-file-directory
3007 (or (and (boundp 'org-babel-temporary-directory
)
3008 (file-exists-p org-babel-temporary-directory
)
3009 org-babel-temporary-directory
)
3010 temporary-file-directory
)))
3011 (make-temp-file prefix nil suffix
))))
3013 (defun org-babel-remove-temporary-directory ()
3014 "Remove `org-babel-temporary-directory' on Emacs shutdown."
3015 (when (and (boundp 'org-babel-temporary-directory
)
3016 (file-exists-p org-babel-temporary-directory
))
3017 ;; taken from `delete-directory' in files.el
3020 (mapc (lambda (file)
3021 ;; This test is equivalent to
3022 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
3023 ;; but more efficient
3024 (if (eq t
(car (file-attributes file
)))
3025 (delete-directory file
)
3026 (delete-file file
)))
3027 ;; We do not want to delete "." and "..".
3028 (directory-files org-babel-temporary-directory
'full
3029 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"))
3030 (delete-directory org-babel-temporary-directory
))
3032 (message "Failed to remove temporary Org-babel directory %s"
3033 (if (boundp 'org-babel-temporary-directory
)
3034 org-babel-temporary-directory
3035 "[directory not defined]"))))))
3037 (add-hook 'kill-emacs-hook
'org-babel-remove-temporary-directory
)
3039 (defun org-babel-one-header-arg-safe-p (pair safe-list
)
3040 "Determine if the PAIR is a safe babel header arg according to SAFE-LIST.
3042 For the format of SAFE-LIST, see `org-babel-safe-header-args'."
3044 (keywordp (car pair
))
3045 (stringp (cdr pair
))
3047 (memq (car pair
) safe-list
)
3048 (let ((entry (assq (car pair
) safe-list
)))
3051 (cond ((functionp (cdr entry
))
3052 (funcall (cdr entry
) (cdr pair
)))
3053 ((listp (cdr entry
))
3054 (member (cdr pair
) (cdr entry
)))
3057 (defun org-babel-generate-file-param (src-name params
)
3058 "Calculate the filename for source block results.
3060 The directory is calculated from the :output-dir property of the
3061 source block; if not specified, use the current directory.
3063 If the source block has a #+NAME and the :file parameter does not
3064 contain any period characters, then the :file parameter is
3065 treated as an extension, and the output file name is the
3066 concatenation of the directory (as calculated above), the block
3067 name, a period, and the parameter value as a file extension.
3068 Otherwise, the :file parameter is treated as a full file name,
3069 and the output file name is the directory (as calculated above)
3070 plus the parameter value."
3071 (let* ((file-cons (assq :file params
))
3072 (file-ext-cons (assq :file-ext params
))
3073 (file-ext (cdr-safe file-ext-cons
))
3074 (dir (cdr-safe (assq :output-dir params
)))
3076 ;; create the output-dir if it does not exist
3078 (make-directory dir t
))
3080 ;; :file given; add :output-dir if given
3082 (setcdr file-cons
(concat (file-name-as-directory dir
) (cdr file-cons
))))
3083 ;; :file not given; compute from name and :file-ext if possible
3084 (when (and src-name file-ext
)
3086 (setq fname
(concat (file-name-as-directory (or dir
""))
3087 src-name
"." file-ext
))
3088 (setq fname
(concat src-name
"." file-ext
)))
3089 (setq params
(cons (cons :file fname
) params
))))
3092 (defun org-babel-graphical-output-file (params)
3093 "File where a babel block should send graphical output, per PARAMS.
3094 Return nil if no graphical output is expected. Raise an error if
3095 the output file is ill-defined."
3096 (let ((file (cdr (assq :file params
))))
3097 (cond (file (and (member "graphics" (cdr (assq :result-params params
)))
3099 ((assq :file-ext params
)
3100 (user-error ":file-ext given but no :file generated; did you forget \
3102 (t (user-error "No :file header argument given; cannot create \
3103 graphical result")))))
3105 (defun org-babel-make-language-alias (new old
)
3106 "Make source blocks of type NEW aliases for those of type OLD.
3108 NEW and OLD should be strings. This function should be called
3109 after the babel API for OLD-type source blocks is fully defined.
3111 Callers of this function will probably want to add an entry to
3112 `org-src-lang-modes' as well."
3113 (dolist (fn '("execute" "expand-body" "prep-session"
3114 "variable-assignments" "load-session"))
3115 (let ((sym (intern-soft (concat "org-babel-" fn
":" old
))))
3116 (when (and sym
(fboundp sym
))
3117 (defalias (intern (concat "org-babel-" fn
":" new
)) sym
))))
3118 ;; Technically we don't need a `dolist' for just one variable, but
3119 ;; we keep it for symmetry/ease of future expansion.
3120 (dolist (var '("default-header-args"))
3121 (let ((sym (intern-soft (concat "org-babel-" var
":" old
))))
3122 (when (and sym
(boundp sym
))
3123 (defvaralias (intern (concat "org-babel-" var
":" new
)) sym
)))))
3125 (defun org-babel-strip-quotes (string)
3126 "Strip \\\"s from around a string, if applicable."
3127 (org-unbracket-string "\"" "\"" string
))
3132 ;; generated-autoload-file: "org-loaddefs.el"
3135 ;;; ob-core.el ends here
