1 ;;; ob-tangle.el --- Extract Source Code From Org Files -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2009-2016 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
6 ;; Keywords: literate programming, reproducible research
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; Extract the code from source blocks out into raw source-code files.
33 (declare-function make-directory
"files" (dir &optional parents
))
34 (declare-function org-at-heading-p
"org" (&optional ignored
))
35 (declare-function org-babel-update-block-body
"ob-core" (new-body))
36 (declare-function org-back-to-heading
"org" (&optional invisible-ok
))
37 (declare-function org-before-first-heading-p
"org" ())
38 (declare-function org-edit-special
"org" (&optional arg
))
39 (declare-function org-element-at-point
"org-element" ())
40 (declare-function org-element-type
"org-element" (element))
41 (declare-function org-fill-template
"org" (template alist
))
42 (declare-function org-heading-components
"org" ())
43 (declare-function org-in-commented-heading-p
"org" (&optional no-inheritance
))
44 (declare-function org-link-escape
"org" (text &optional table merge
))
45 (declare-function org-open-link-from-string
"org" (s &optional arg reference-buffer
))
46 (declare-function org-remove-indentation
"org" (code &optional n
))
47 (declare-function org-store-link
"org" (arg))
48 (declare-function org-string-nw-p
"org-macs" (s))
49 (declare-function org-trim
"org" (s &optional keep-lead
))
50 (declare-function outline-previous-heading
"outline" ())
52 (defvar org-link-types-re
)
54 (defcustom org-babel-tangle-lang-exts
55 '(("emacs-lisp" .
"el")
57 "Alist mapping languages to their file extensions.
58 The key is the language name, the value is the string that should
59 be inserted as the extension commonly used to identify files
60 written in this language. If no entry is found in this list,
61 then the name of the language is used."
62 :group
'org-babel-tangle
66 (string "Language name")
67 (string "File Extension"))))
69 (defcustom org-babel-tangle-use-relative-file-links t
70 "Use relative path names in links from tangled source back the Org file."
71 :group
'org-babel-tangle
74 (defcustom org-babel-post-tangle-hook nil
75 "Hook run in code files tangled by `org-babel-tangle'."
80 (defcustom org-babel-pre-tangle-hook
'(save-buffer)
81 "Hook run at the beginning of `org-babel-tangle'."
86 (defcustom org-babel-tangle-body-hook nil
87 "Hook run over the contents of each code block body."
92 (defcustom org-babel-tangle-comment-format-beg
"[[%link][%source-name]]"
93 "Format of inserted comments in tangled code files.
94 The following format strings can be used to insert special
95 information into the output using `org-fill-template'.
96 %start-line --- the line number at the start of the code block
97 %file --------- the file from which the code block was tangled
98 %link --------- Org style link to the code block
99 %source-name -- name of the code block
101 Upon insertion the formatted comment will be commented out, and
102 followed by a newline. To inhibit this post-insertion processing
103 set the `org-babel-tangle-uncomment-comments' variable to a
106 Whether or not comments are inserted during tangling is
107 controlled by the :comments header argument."
112 (defcustom org-babel-tangle-comment-format-end
"%source-name ends here"
113 "Format of inserted comments in tangled code files.
114 The following format strings can be used to insert special
115 information into the output using `org-fill-template'.
116 %start-line --- the line number at the start of the code block
117 %file --------- the file from which the code block was tangled
118 %link --------- Org style link to the code block
119 %source-name -- name of the code block
121 Upon insertion the formatted comment will be commented out, and
122 followed by a newline. To inhibit this post-insertion processing
123 set the `org-babel-tangle-uncomment-comments' variable to a
126 Whether or not comments are inserted during tangling is
127 controlled by the :comments header argument."
132 (defcustom org-babel-tangle-uncomment-comments nil
133 "Inhibits automatic commenting and addition of trailing newline
134 of tangle comments. Use `org-babel-tangle-comment-format-beg'
135 and `org-babel-tangle-comment-format-end' to customize the format
136 of tangled comments."
140 (defcustom org-babel-process-comment-text
'org-remove-indentation
141 "Function called to process raw Org text collected to be
142 inserted as comments in tangled source-code files. The function
143 should take a single string argument and return a string
144 result. The default value is `org-remove-indentation'."
149 (defun org-babel-find-file-noselect-refresh (file)
150 "Find file ensuring that the latest changes on disk are
151 represented in the file."
152 (find-file-noselect file
'nowarn
)
153 (with-current-buffer (get-file-buffer file
)
154 (revert-buffer t t t
)))
156 (defmacro org-babel-with-temp-filebuffer
(file &rest body
)
157 "Open FILE into a temporary buffer execute BODY there like
158 `progn', then kill the FILE buffer returning the result of
161 (let ((temp-path (make-symbol "temp-path"))
162 (temp-result (make-symbol "temp-result"))
163 (temp-file (make-symbol "temp-file"))
164 (visited-p (make-symbol "visited-p")))
165 `(let* ((,temp-path
,file
)
166 (,visited-p
(get-file-buffer ,temp-path
))
167 ,temp-result
,temp-file
)
168 (org-babel-find-file-noselect-refresh ,temp-path
)
169 (setf ,temp-file
(get-file-buffer ,temp-path
))
170 (with-current-buffer ,temp-file
171 (setf ,temp-result
(progn ,@body
)))
172 (unless ,visited-p
(kill-buffer ,temp-file
))
174 (def-edebug-spec org-babel-with-temp-filebuffer
(form body
))
177 (defun org-babel-tangle-file (file &optional target-file lang
)
178 "Extract the bodies of source code blocks in FILE.
179 Source code blocks are extracted with `org-babel-tangle'.
180 Optional argument TARGET-FILE can be used to specify a default
181 export file for all source blocks. Optional argument LANG can be
182 used to limit the exported source code blocks by language.
183 Return a list whose CAR is the tangled file name."
184 (interactive "fFile to tangle: \nP")
185 (let ((visited-p (get-file-buffer (expand-file-name file
)))
188 (save-window-excursion
190 (setq to-be-removed
(current-buffer))
191 (mapcar #'expand-file-name
(org-babel-tangle nil target-file lang
)))
193 (kill-buffer to-be-removed
)))))
195 (defun org-babel-tangle-publish (_ filename pub-dir
)
196 "Tangle FILENAME and place the results in PUB-DIR."
197 (unless (file-exists-p pub-dir
)
198 (make-directory pub-dir t
))
199 (mapc (lambda (el) (copy-file el pub-dir t
)) (org-babel-tangle-file filename
)))
202 (defun org-babel-tangle (&optional arg target-file lang
)
203 "Write code blocks to source-specific files.
204 Extract the bodies of all source code blocks from the current
205 file into their own source-specific files.
206 With one universal prefix argument, only tangle the block at point.
207 When two universal prefix arguments, only tangle blocks for the
208 tangle file of the block at point.
209 Optional argument TARGET-FILE can be used to specify a default
210 export file for all source blocks. Optional argument LANG can be
211 used to limit the exported source code blocks by language."
213 (run-hooks 'org-babel-pre-tangle-hook
)
214 ;; Possibly Restrict the buffer to the current code block
217 (when (equal arg
'(4))
218 (let ((head (org-babel-where-is-src-block-head)))
221 (user-error "Point is not in a source code block"))))
222 (let ((block-counter 0)
223 (org-babel-default-header-args
225 (org-babel-merge-params org-babel-default-header-args
226 (list (cons :tangle target-file
)))
227 org-babel-default-header-args
))
229 (when (equal arg
'(16))
230 (or (cdr (assq :tangle
(nth 2 (org-babel-get-src-block-info 'light
))))
231 (user-error "Point is not in a source code block"))))
233 (mapc ;; map over all languages
235 (let* ((lang (car by-lang
))
236 (specs (cdr by-lang
))
237 (ext (or (cdr (assoc lang org-babel-tangle-lang-exts
)) lang
))
240 (or (and (cdr (assoc lang org-src-lang-modes
))
242 (cdr (assoc lang org-src-lang-modes
))))
248 (let ((get-spec (lambda (name) (cdr (assoc name
(nth 4 spec
))))))
249 (let* ((tangle (funcall get-spec
:tangle
))
250 (she-bang (let ((sheb (funcall get-spec
:shebang
)))
251 (when (> (length sheb
) 0) sheb
)))
252 (tangle-mode (funcall get-spec
:tangle-mode
))
254 ((string= "yes" tangle
)
255 (file-name-sans-extension
257 ((string= "no" tangle
) nil
)
258 ((> (length tangle
) 0) tangle
)))
259 (file-name (when base-name
260 ;; decide if we want to add ext to base-name
261 (if (and ext
(string= "yes" tangle
))
262 (concat base-name
"." ext
) base-name
))))
264 ;; Possibly create the parent directories for file.
265 (let ((m (funcall get-spec
:mkdirp
))
266 (fnd (file-name-directory file-name
)))
267 (and m fnd
(not (string= m
"no"))
268 (make-directory fnd
'parents
)))
269 ;; delete any old versions of file
270 (and (file-exists-p file-name
)
271 (not (member file-name
(mapcar #'car path-collector
)))
272 (delete-file file-name
))
273 ;; drop source-block to file
275 (when (fboundp lang-f
) (ignore-errors (funcall lang-f
)))
276 (when (and she-bang
(not (member file-name she-banged
)))
277 (insert (concat she-bang
"\n"))
278 (setq she-banged
(cons file-name she-banged
)))
279 (org-babel-spec-to-string spec
)
280 ;; We avoid append-to-file as it does not work with tramp.
281 (let ((content (buffer-string)))
283 (when (file-exists-p file-name
)
284 (insert-file-contents file-name
))
285 (goto-char (point-max))
286 ;; Handle :padlines unless first line in file
287 (unless (or (string= "no" (cdr (assq :padline
(nth 4 spec
))))
288 (= (point) (point-min)))
291 (write-region nil nil file-name
))))
292 ;; if files contain she-bangs, then make the executable
294 (unless tangle-mode
(setq tangle-mode
#o755
)))
296 (setq block-counter
(+ 1 block-counter
))
297 (unless (assoc file-name path-collector
)
298 (push (cons file-name tangle-mode
) path-collector
))))))
301 (org-babel-tangle-single-block 1 t
)
302 (org-babel-tangle-collect-blocks lang tangle-file
)))
303 (message "Tangled %d code block%s from %s" block-counter
304 (if (= block-counter
1) "" "s")
305 (file-name-nondirectory
307 (or (buffer-base-buffer) (current-buffer)))))
308 ;; run `org-babel-post-tangle-hook' in all tangled files
309 (when org-babel-post-tangle-hook
312 (org-babel-with-temp-filebuffer file
313 (run-hooks 'org-babel-post-tangle-hook
)))
314 (mapcar #'car path-collector
)))
315 ;; set permissions on tangled files
317 (when (cdr pair
) (set-file-modes (car pair
) (cdr pair
))))
319 (mapcar #'car path-collector
)))))
321 (defun org-babel-tangle-clean ()
322 "Remove comments inserted by `org-babel-tangle'.
323 Call this function inside of a source-code file generated by
324 `org-babel-tangle' to remove all comments inserted automatically
325 by `org-babel-tangle'. Warning, this comment removes any lines
326 containing constructs which resemble Org file links or noweb
329 (goto-char (point-min))
330 (while (or (re-search-forward "\\[\\[file:.*\\]\\[.*\\]\\]" nil t
)
331 (re-search-forward (org-babel-noweb-wrap) nil t
))
332 (delete-region (save-excursion (beginning-of-line 1) (point))
333 (save-excursion (end-of-line 1) (forward-char 1) (point)))))
335 (defvar org-stored-links
)
336 (defvar org-bracket-link-regexp
)
337 (defun org-babel-spec-to-string (spec)
338 "Insert SPEC into the current file.
340 Insert the source-code specified by SPEC into the current source
341 code file. This function uses `comment-region' which assumes
342 that the appropriate major-mode is set. SPEC has the form:
344 (start-line file link source-name params body comment)"
345 (let* ((start-line (nth 0 spec
))
347 (file (if org-babel-tangle-use-relative-file-links
348 (file-relative-name (nth 1 spec
))
350 (link (let ((link (nth 2 spec
)))
351 (if org-babel-tangle-use-relative-file-links
352 (when (string-match org-link-types-re link
)
353 (let ((type (match-string 0 link
))
354 (link (substring link
(match-end 0))))
359 (file-name-directory (cdr (assq :tangle info
)))))))
361 (source-name (nth 3 spec
))
363 (comment (nth 6 spec
))
364 (comments (cdr (assq :comments info
)))
365 (link-p (or (string= comments
"both") (string= comments
"link")
366 (string= comments
"yes") (string= comments
"noweb")))
367 (link-data `(("start-line" .
,(number-to-string start-line
))
370 ("source-name" .
,source-name
)))
371 (insert-comment (lambda (text)
373 (not (string= comments
"no"))
374 (org-string-nw-p text
))
375 (if org-babel-tangle-uncomment-comments
376 ;; Plain comments: no processing.
378 ;; Ensure comments are made to be
379 ;; comments, and add a trailing
380 ;; newline. Also ignore invisible
381 ;; characters when commenting.
384 (progn (insert (org-no-properties text
))
388 (when comment
(funcall insert-comment comment
))
392 (org-fill-template org-babel-tangle-comment-format-beg link-data
)))
394 (org-unescape-code-in-string
395 (if org-src-preserve-indentation
(org-trim body t
)
396 (org-trim (org-remove-indentation body
))))
401 (org-fill-template org-babel-tangle-comment-format-end link-data
)))))
403 (defun org-babel-tangle-collect-blocks (&optional language tangle-file
)
404 "Collect source blocks in the current Org file.
405 Return an association list of source-code block specifications of
406 the form used by `org-babel-spec-to-string' grouped by language.
407 Optional argument LANGUAGE can be used to limit the collected
408 source code blocks by language. Optional argument TANGLE-FILE
409 can be used to limit the collected code blocks by target file."
410 (let ((counter 0) last-heading-pos blocks
)
411 (org-babel-map-src-blocks (buffer-file-name)
412 (let ((current-heading-pos
413 (org-with-wide-buffer
414 (org-with-limited-levels (outline-previous-heading)))))
415 (if (eq last-heading-pos current-heading-pos
) (cl-incf counter
)
417 (setq last-heading-pos current-heading-pos
)))
418 (unless (org-in-commented-heading-p)
419 (let* ((info (org-babel-get-src-block-info 'light
))
420 (src-lang (nth 0 info
))
421 (src-tfile (cdr (assq :tangle
(nth 2 info
)))))
422 (unless (or (string= src-tfile
"no")
423 (and tangle-file
(not (equal tangle-file src-tfile
)))
424 (and language
(not (string= language src-lang
))))
425 ;; Add the spec for this block to blocks under its
427 (let ((by-lang (assoc src-lang blocks
))
428 (block (org-babel-tangle-single-block counter
)))
429 (if by-lang
(setcdr by-lang
(cons block
(cdr by-lang
)))
430 (push (cons src-lang
(list block
)) blocks
)))))))
431 ;; Ensure blocks are in the correct order.
432 (mapcar (lambda (b) (cons (car b
) (nreverse (cdr b
)))) blocks
)))
434 (defun org-babel-tangle-single-block
435 (block-counter &optional only-this-block
)
436 "Collect the tangled source for current block.
437 Return the list of block attributes needed by
438 `org-babel-tangle-collect-blocks'.
439 When ONLY-THIS-BLOCK is non-nil, return the full association
440 list to be used by `org-babel-tangle' directly."
441 (let* ((info (org-babel-get-src-block-info))
443 (save-restriction (widen)
444 (+ 1 (line-number-at-pos (point)))))
445 (file (buffer-file-name (buffer-base-buffer)))
446 (src-lang (nth 0 info
))
447 (params (nth 2 info
))
449 (cref-fmt (or (and (string-match "-l \"\\(.+\\)\"" extra
)
450 (match-string 1 extra
))
451 org-coderef-label-format
))
452 (link (let ((link (org-no-properties
453 (org-store-link nil
))))
454 (and (string-match org-bracket-link-regexp link
)
455 (match-string 1 link
))))
459 (or (ignore-errors (nth 4 (org-heading-components)))
463 (intern (concat "org-babel-expand-body:" src-lang
)))
465 (intern (concat "org-babel-variable-assignments:" src-lang
)))
467 ;; Run the tangle-body-hook.
468 (let* ((body ;; Expand the body in language specific manner.
469 (if (org-babel-noweb-p params
:tangle
)
470 (org-babel-expand-noweb-references info
)
473 (if (assq :no-expand params
)
475 (if (fboundp expand-cmd
)
476 (funcall expand-cmd body params
)
477 (org-babel-expand-body:generic
479 (and (fboundp assignments-cmd
)
480 (funcall assignments-cmd params
)))))))
483 (when (string-match "-r" extra
)
484 (goto-char (point-min))
485 (while (re-search-forward
486 (replace-regexp-in-string "%s" ".+" cref-fmt
) nil t
)
488 (run-hooks 'org-babel-tangle-body-hook
)
491 (when (or (string= "both" (cdr (assq :comments params
)))
492 (string= "org" (cdr (assq :comments params
))))
493 ;; From the previous heading or code-block end
495 org-babel-process-comment-text
497 (max (condition-case nil
499 (org-back-to-heading t
) ; Sets match data
503 (if (re-search-backward
504 org-babel-src-block-regexp nil t
)
509 (list start-line file link source-name params body comment
)))
511 (list (cons src-lang
(list result
)))
514 (defun org-babel-tangle-comment-links (&optional info
)
515 "Return a list of begin and end link comments for the code block at point."
517 `(("start-line" .
,(number-to-string
518 (org-babel-where-is-src-block-head)))
519 ("file" .
,(buffer-file-name))
520 ("link" .
,(org-link-escape
522 (call-interactively #'org-store-link
)
523 (org-no-properties (car (pop org-stored-links
))))))
525 ,(nth 4 (or info
(org-babel-get-src-block-info 'light
)))))))
526 (list (org-fill-template org-babel-tangle-comment-format-beg link-data
)
527 (org-fill-template org-babel-tangle-comment-format-end link-data
))))
529 ;; de-tangling functions
530 (defvar org-bracket-link-analytic-regexp
)
531 (defun org-babel-detangle (&optional source-code-file
)
532 "Propagate changes in source file back original to Org file.
533 This requires that code blocks were tangled with link comments
534 which enable the original code blocks to be found."
537 (when source-code-file
(find-file source-code-file
))
538 (goto-char (point-min))
539 (let ((counter 0) new-body end
)
540 (while (re-search-forward org-bracket-link-analytic-regexp nil t
)
541 (when (re-search-forward
542 (concat " " (regexp-quote (match-string 5)) " ends here"))
543 (setq end
(match-end 0))
546 (when (setq new-body
(org-babel-tangle-jump-to-org))
547 (org-babel-update-block-body new-body
)))
548 (setq counter
(+ 1 counter
)))
550 (prog1 counter
(message "Detangled %d code blocks" counter
)))))
552 (defun org-babel-tangle-jump-to-org ()
553 "Jump from a tangled code file to the related Org mode file."
557 target-buffer target-char link path block-name body
)
558 (save-window-excursion
560 (while (and (re-search-backward org-bracket-link-analytic-regexp nil t
)
561 (not ; ever wider searches until matching block comments
562 (and (setq start
(line-beginning-position))
563 (setq body-start
(line-beginning-position 2))
564 (setq link
(match-string 0))
565 (setq path
(match-string 3))
566 (setq block-name
(match-string 5))
570 (concat " " (regexp-quote block-name
)
572 (setq end
(line-beginning-position))))))))
573 (unless (and start
(< start mid
) (< mid end
))
574 (error "Not in tangled code"))
575 (setq body
(buffer-substring body-start end
)))
576 (when (string-match "::" path
)
577 (setq path
(substring path
0 (match-beginning 0))))
579 (setq target-buffer
(current-buffer))
580 ;; Go to the beginning of the relative block in Org file.
581 (org-open-link-from-string link
)
582 (if (string-match "[^ \t\n\r]:\\([[:digit:]]+\\)" block-name
)
583 (let ((n (string-to-number (match-string 1 block-name
))))
584 (if (org-before-first-heading-p) (goto-char (point-min))
585 (org-back-to-heading t
))
586 ;; Do not skip the first block if it begins at point min.
587 (cond ((or (org-at-heading-p)
588 (not (eq (org-element-type (org-element-at-point))
590 (org-babel-next-src-block n
))
592 (t (org-babel-next-src-block (1- n
)))))
593 (org-babel-goto-named-src-block block-name
))
594 (goto-char (org-babel-where-is-src-block-head))
595 ;; Preserve location of point within the source code in tangled
598 (forward-char (- mid body-start
))
599 (setq target-char
(point)))
600 (org-src-switch-to-buffer target-buffer t
)
601 (goto-char target-char
)
607 ;; generated-autoload-file: "org-loaddefs.el"
610 ;;; ob-tangle.el ends here