Don't quote nil and t in doc strings
[emacs.git] / lisp / org / ob-tangle.el
blobc0846f9cd82a2eabd1cd53a8fff7caad2437c0bd
1 ;;; ob-tangle.el --- extract source code from org-mode files
3 ;; Copyright (C) 2009-2015 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/>.
24 ;;; Commentary:
26 ;; Extract the code from source blocks out into raw source-code files.
28 ;;; Code:
29 (require 'org-src)
30 (eval-when-compile
31 (require 'cl))
33 (declare-function org-edit-special "org" (&optional arg))
34 (declare-function org-link-escape "org" (text &optional table))
35 (declare-function org-store-link "org" (arg))
36 (declare-function org-open-link-from-string "org" (s &optional arg reference-buffer))
37 (declare-function org-heading-components "org" ())
38 (declare-function org-back-to-heading "org" (invisible-ok))
39 (declare-function org-fill-template "org" (template alist))
40 (declare-function org-babel-update-block-body "org" (new-body))
41 (declare-function make-directory "files" (dir &optional parents))
43 (defcustom org-babel-tangle-lang-exts
44 '(("emacs-lisp" . "el"))
45 "Alist mapping languages to their file extensions.
46 The key is the language name, the value is the string that should
47 be inserted as the extension commonly used to identify files
48 written in this language. If no entry is found in this list,
49 then the name of the language is used."
50 :group 'org-babel-tangle
51 :version "24.1"
52 :type '(repeat
53 (cons
54 (string "Language name")
55 (string "File Extension"))))
57 (defcustom org-babel-post-tangle-hook nil
58 "Hook run in code files tangled by `org-babel-tangle'."
59 :group 'org-babel
60 :version "24.1"
61 :type 'hook)
63 (defcustom org-babel-pre-tangle-hook '(save-buffer)
64 "Hook run at the beginning of `org-babel-tangle'."
65 :group 'org-babel
66 :version "24.1"
67 :type 'hook)
69 (defcustom org-babel-tangle-body-hook nil
70 "Hook run over the contents of each code block body."
71 :group 'org-babel
72 :version "24.1"
73 :type 'hook)
75 (defcustom org-babel-tangle-comment-format-beg "[[%link][%source-name]]"
76 "Format of inserted comments in tangled code files.
77 The following format strings can be used to insert special
78 information into the output using `org-fill-template'.
79 %start-line --- the line number at the start of the code block
80 %file --------- the file from which the code block was tangled
81 %link --------- Org-mode style link to the code block
82 %source-name -- name of the code block
84 Whether or not comments are inserted during tangling is
85 controlled by the :comments header argument."
86 :group 'org-babel
87 :version "24.1"
88 :type 'string)
90 (defcustom org-babel-tangle-comment-format-end "%source-name ends here"
91 "Format of inserted comments in tangled code files.
92 The following format strings can be used to insert special
93 information into the output using `org-fill-template'.
94 %start-line --- the line number at the start of the code block
95 %file --------- the file from which the code block was tangled
96 %link --------- Org-mode style link to the code block
97 %source-name -- name of the code block
99 Whether or not comments are inserted during tangling is
100 controlled by the :comments header argument."
101 :group 'org-babel
102 :version "24.1"
103 :type 'string)
105 (defcustom org-babel-process-comment-text #'org-babel-trim
106 "Function called to process raw Org-mode text collected to be
107 inserted as comments in tangled source-code files. The function
108 should take a single string argument and return a string
109 result. The default value is `org-babel-trim'."
110 :group 'org-babel
111 :version "24.1"
112 :type 'function)
114 (defun org-babel-find-file-noselect-refresh (file)
115 "Find file ensuring that the latest changes on disk are
116 represented in the file."
117 (find-file-noselect file 'nowarn)
118 (with-current-buffer (get-file-buffer file)
119 (revert-buffer t t t)))
121 (defmacro org-babel-with-temp-filebuffer (file &rest body)
122 "Open FILE into a temporary buffer execute BODY there like
123 `progn', then kill the FILE buffer returning the result of
124 evaluating BODY."
125 (declare (indent 1))
126 (let ((temp-path (make-symbol "temp-path"))
127 (temp-result (make-symbol "temp-result"))
128 (temp-file (make-symbol "temp-file"))
129 (visited-p (make-symbol "visited-p")))
130 `(let* ((,temp-path ,file)
131 (,visited-p (get-file-buffer ,temp-path))
132 ,temp-result ,temp-file)
133 (org-babel-find-file-noselect-refresh ,temp-path)
134 (setf ,temp-file (get-file-buffer ,temp-path))
135 (with-current-buffer ,temp-file
136 (setf ,temp-result (progn ,@body)))
137 (unless ,visited-p (kill-buffer ,temp-file))
138 ,temp-result)))
139 (def-edebug-spec org-babel-with-temp-filebuffer (form body))
141 ;;;###autoload
142 (defun org-babel-tangle-file (file &optional target-file lang)
143 "Extract the bodies of source code blocks in FILE.
144 Source code blocks are extracted with `org-babel-tangle'.
145 Optional argument TARGET-FILE can be used to specify a default
146 export file for all source blocks. Optional argument LANG can be
147 used to limit the exported source code blocks by language.
148 Return a list whose CAR is the tangled file name."
149 (interactive "fFile to tangle: \nP")
150 (let ((visited-p (get-file-buffer (expand-file-name file)))
151 to-be-removed)
152 (prog1
153 (save-window-excursion
154 (find-file file)
155 (setq to-be-removed (current-buffer))
156 (org-babel-tangle nil target-file lang))
157 (unless visited-p
158 (kill-buffer to-be-removed)))))
160 (defun org-babel-tangle-publish (_ filename pub-dir)
161 "Tangle FILENAME and place the results in PUB-DIR."
162 (mapc (lambda (el) (copy-file el pub-dir t)) (org-babel-tangle-file filename)))
164 ;;;###autoload
165 (defun org-babel-tangle (&optional arg target-file lang)
166 "Write code blocks to source-specific files.
167 Extract the bodies of all source code blocks from the current
168 file into their own source-specific files.
169 With one universal prefix argument, only tangle the block at point.
170 When two universal prefix arguments, only tangle blocks for the
171 tangle file of the block at point.
172 Optional argument TARGET-FILE can be used to specify a default
173 export file for all source blocks. Optional argument LANG can be
174 used to limit the exported source code blocks by language."
175 (interactive "P")
176 (run-hooks 'org-babel-pre-tangle-hook)
177 ;; Possibly Restrict the buffer to the current code block
178 (save-restriction
179 (when (equal arg '(4))
180 (let ((head (org-babel-where-is-src-block-head)))
181 (if head
182 (goto-char head)
183 (user-error "Point is not in a source code block"))))
184 (save-excursion
185 (let ((block-counter 0)
186 (org-babel-default-header-args
187 (if target-file
188 (org-babel-merge-params org-babel-default-header-args
189 (list (cons :tangle target-file)))
190 org-babel-default-header-args))
191 (tangle-file
192 (when (equal arg '(16))
193 (or (cdr (assoc :tangle (nth 2 (org-babel-get-src-block-info 'light))))
194 (user-error "Point is not in a source code block"))))
195 path-collector)
196 (mapc ;; map over all languages
197 (lambda (by-lang)
198 (let* ((lang (car by-lang))
199 (specs (cdr by-lang))
200 (ext (or (cdr (assoc lang org-babel-tangle-lang-exts)) lang))
201 (lang-f (intern
202 (concat
203 (or (and (cdr (assoc lang org-src-lang-modes))
204 (symbol-name
205 (cdr (assoc lang org-src-lang-modes))))
206 lang)
207 "-mode")))
208 she-banged)
209 (mapc
210 (lambda (spec)
211 (let ((get-spec (lambda (name) (cdr (assoc name (nth 4 spec))))))
212 (let* ((tangle (funcall get-spec :tangle))
213 (she-bang (let ((sheb (funcall get-spec :shebang)))
214 (when (> (length sheb) 0) sheb)))
215 (tangle-mode (funcall get-spec :tangle-mode))
216 (base-name (cond
217 ((string= "yes" tangle)
218 (file-name-sans-extension
219 (buffer-file-name)))
220 ((string= "no" tangle) nil)
221 ((> (length tangle) 0) tangle)))
222 (file-name (when base-name
223 ;; decide if we want to add ext to base-name
224 (if (and ext (string= "yes" tangle))
225 (concat base-name "." ext) base-name))))
226 (when file-name
227 ;; Possibly create the parent directories for file.
228 (let ((m (funcall get-spec :mkdirp))
229 (fnd (file-name-directory file-name)))
230 (and m fnd (not (string= m "no"))
231 (make-directory fnd 'parents)))
232 ;; delete any old versions of file
233 (and (file-exists-p file-name)
234 (not (member file-name (mapcar #'car path-collector)))
235 (delete-file file-name))
236 ;; drop source-block to file
237 (with-temp-buffer
238 (when (fboundp lang-f) (ignore-errors (funcall lang-f)))
239 (when (and she-bang (not (member file-name she-banged)))
240 (insert (concat she-bang "\n"))
241 (setq she-banged (cons file-name she-banged)))
242 (org-babel-spec-to-string spec)
243 ;; We avoid append-to-file as it does not work with tramp.
244 (let ((content (buffer-string)))
245 (with-temp-buffer
246 (if (file-exists-p file-name)
247 (insert-file-contents file-name))
248 (goto-char (point-max))
249 (insert content)
250 (write-region nil nil file-name))))
251 ;; if files contain she-bangs, then make the executable
252 (when she-bang
253 (unless tangle-mode (setq tangle-mode #o755)))
254 ;; update counter
255 (setq block-counter (+ 1 block-counter))
256 (add-to-list 'path-collector
257 (cons file-name tangle-mode)
259 (lambda (a b) (equal (car a) (car b))))))))
260 specs)))
261 (if (equal arg '(4))
262 (org-babel-tangle-single-block 1 t)
263 (org-babel-tangle-collect-blocks lang tangle-file)))
264 (message "Tangled %d code block%s from %s" block-counter
265 (if (= block-counter 1) "" "s")
266 (file-name-nondirectory
267 (buffer-file-name
268 (or (buffer-base-buffer) (current-buffer)))))
269 ;; run `org-babel-post-tangle-hook' in all tangled files
270 (when org-babel-post-tangle-hook
271 (mapc
272 (lambda (file)
273 (org-babel-with-temp-filebuffer file
274 (run-hooks 'org-babel-post-tangle-hook)))
275 (mapcar #'car path-collector)))
276 ;; set permissions on tangled files
277 (mapc (lambda (pair)
278 (when (cdr pair) (set-file-modes (car pair) (cdr pair))))
279 path-collector)
280 (mapcar #'car path-collector)))))
282 (defun org-babel-tangle-clean ()
283 "Remove comments inserted by `org-babel-tangle'.
284 Call this function inside of a source-code file generated by
285 `org-babel-tangle' to remove all comments inserted automatically
286 by `org-babel-tangle'. Warning, this comment removes any lines
287 containing constructs which resemble org-mode file links or noweb
288 references."
289 (interactive)
290 (goto-char (point-min))
291 (while (or (re-search-forward "\\[\\[file:.*\\]\\[.*\\]\\]" nil t)
292 (re-search-forward (org-babel-noweb-wrap) nil t))
293 (delete-region (save-excursion (beginning-of-line 1) (point))
294 (save-excursion (end-of-line 1) (forward-char 1) (point)))))
296 (defvar org-stored-links)
297 (defvar org-bracket-link-regexp)
298 (defun org-babel-spec-to-string (spec)
299 "Insert SPEC into the current file.
301 Insert the source-code specified by SPEC into the current source
302 code file. This function uses `comment-region' which assumes
303 that the appropriate major-mode is set. SPEC has the form:
305 \(start-line file link source-name params body comment)"
306 (let* ((start-line (nth 0 spec))
307 (file (nth 1 spec))
308 (link (nth 2 spec))
309 (source-name (nth 3 spec))
310 (body (nth 5 spec))
311 (comment (nth 6 spec))
312 (comments (cdr (assoc :comments (nth 4 spec))))
313 (padline (not (string= "no" (cdr (assoc :padline (nth 4 spec))))))
314 (link-p (or (string= comments "both") (string= comments "link")
315 (string= comments "yes") (string= comments "noweb")))
316 (link-data (mapcar (lambda (el)
317 (cons (symbol-name el)
318 (let ((le (eval el)))
319 (if (stringp le) le (format "%S" le)))))
320 '(start-line file link source-name)))
321 (insert-comment (lambda (text)
322 (when (and comments (not (string= comments "no"))
323 (> (length text) 0))
324 (when padline (insert "\n"))
325 (comment-region (point) (progn (insert text) (point)))
326 (end-of-line nil) (insert "\n")))))
327 (when comment (funcall insert-comment comment))
328 (when link-p
329 (funcall
330 insert-comment
331 (org-fill-template org-babel-tangle-comment-format-beg link-data)))
332 (when padline (insert "\n"))
333 (insert
334 (format
335 "%s\n"
336 (org-unescape-code-in-string
337 (org-babel-trim body (if org-src-preserve-indentation "[\f\n\r\v]")))))
338 (when link-p
339 (funcall
340 insert-comment
341 (org-fill-template org-babel-tangle-comment-format-end link-data)))))
343 (defvar org-comment-string) ;; Defined in org.el
344 (defun org-babel-tangle-collect-blocks (&optional language tangle-file)
345 "Collect source blocks in the current Org-mode file.
346 Return an association list of source-code block specifications of
347 the form used by `org-babel-spec-to-string' grouped by language.
348 Optional argument LANGUAGE can be used to limit the collected
349 source code blocks by language. Optional argument TANGLE-FILE
350 can be used to limit the collected code blocks by target file."
351 (let ((block-counter 1) (current-heading "") blocks by-lang)
352 (org-babel-map-src-blocks (buffer-file-name)
353 (lambda (new-heading)
354 (if (not (string= new-heading current-heading))
355 (progn
356 (setq block-counter 1)
357 (setq current-heading new-heading))
358 (setq block-counter (+ 1 block-counter))))
359 (replace-regexp-in-string "[ \t]" "-"
360 (condition-case nil
361 (or (nth 4 (org-heading-components))
362 "(dummy for heading without text)")
363 (error (buffer-file-name))))
364 (let* ((info (org-babel-get-src-block-info 'light))
365 (src-lang (nth 0 info))
366 (src-tfile (cdr (assoc :tangle (nth 2 info)))))
367 (unless (or (string-match (concat "^" org-comment-string) current-heading)
368 (string= (cdr (assoc :tangle (nth 2 info))) "no")
369 (and tangle-file (not (equal tangle-file src-tfile))))
370 (unless (and language (not (string= language src-lang)))
371 ;; Add the spec for this block to blocks under it's language
372 (setq by-lang (cdr (assoc src-lang blocks)))
373 (setq blocks (delq (assoc src-lang blocks) blocks))
374 (setq blocks (cons
375 (cons src-lang
376 (cons
377 (org-babel-tangle-single-block
378 block-counter)
379 by-lang)) blocks))))))
380 ;; Ensure blocks are in the correct order
381 (setq blocks
382 (mapcar
383 (lambda (by-lang) (cons (car by-lang) (reverse (cdr by-lang))))
384 blocks))
385 blocks))
387 (defun org-babel-tangle-single-block
388 (block-counter &optional only-this-block)
389 "Collect the tangled source for current block.
390 Return the list of block attributes needed by
391 `org-babel-tangle-collect-blocks'.
392 When ONLY-THIS-BLOCK is non-nil, return the full association
393 list to be used by `org-babel-tangle' directly."
394 (let* ((info (org-babel-get-src-block-info))
395 (start-line
396 (save-restriction (widen)
397 (+ 1 (line-number-at-pos (point)))))
398 (file (buffer-file-name))
399 (src-lang (nth 0 info))
400 (params (nth 2 info))
401 (extra (nth 3 info))
402 (cref-fmt (or (and (string-match "-l \"\\(.+\\)\"" extra)
403 (match-string 1 extra))
404 org-coderef-label-format))
405 (link (let ((link (org-no-properties
406 (org-store-link nil))))
407 (and (string-match org-bracket-link-regexp link)
408 (match-string 1 link))))
409 (source-name
410 (intern (or (nth 4 info)
411 (format "%s:%d"
412 (or (ignore-errors (nth 4 (org-heading-components)))
413 "No heading")
414 block-counter))))
415 (expand-cmd
416 (intern (concat "org-babel-expand-body:" src-lang)))
417 (assignments-cmd
418 (intern (concat "org-babel-variable-assignments:" src-lang)))
419 (body
420 ;; Run the tangle-body-hook.
421 (let* ((body ;; Expand the body in language specific manner.
422 (if (org-babel-noweb-p params :tangle)
423 (org-babel-expand-noweb-references info)
424 (nth 1 info)))
425 (body
426 (if (assoc :no-expand params)
427 body
428 (if (fboundp expand-cmd)
429 (funcall expand-cmd body params)
430 (org-babel-expand-body:generic
431 body params
432 (and (fboundp assignments-cmd)
433 (funcall assignments-cmd params)))))))
434 (with-temp-buffer
435 (insert body)
436 (when (string-match "-r" extra)
437 (goto-char (point-min))
438 (while (re-search-forward
439 (replace-regexp-in-string "%s" ".+" cref-fmt) nil t)
440 (replace-match "")))
441 (run-hooks 'org-babel-tangle-body-hook)
442 (buffer-string))))
443 (comment
444 (when (or (string= "both" (cdr (assoc :comments params)))
445 (string= "org" (cdr (assoc :comments params))))
446 ;; From the previous heading or code-block end
447 (funcall
448 org-babel-process-comment-text
449 (buffer-substring
450 (max (condition-case nil
451 (save-excursion
452 (org-back-to-heading t) ; Sets match data
453 (match-end 0))
454 (error (point-min)))
455 (save-excursion
456 (if (re-search-backward
457 org-babel-src-block-regexp nil t)
458 (match-end 0)
459 (point-min))))
460 (point)))))
461 (result
462 (list start-line file link source-name params body comment)))
463 (if only-this-block
464 (list (cons src-lang (list result)))
465 result)))
467 (defun org-babel-tangle-comment-links ( &optional info)
468 "Return a list of begin and end link comments for the code block at point."
469 (let* ((start-line (org-babel-where-is-src-block-head))
470 (file (buffer-file-name))
471 (link (org-link-escape (progn (call-interactively 'org-store-link)
472 (org-no-properties
473 (car (pop org-stored-links))))))
474 (source-name (nth 4 (or info (org-babel-get-src-block-info 'light))))
475 (link-data (mapcar (lambda (el)
476 (cons (symbol-name el)
477 (let ((le (eval el)))
478 (if (stringp le) le (format "%S" le)))))
479 '(start-line file link source-name))))
480 (list (org-fill-template org-babel-tangle-comment-format-beg link-data)
481 (org-fill-template org-babel-tangle-comment-format-end link-data))))
483 ;; de-tangling functions
484 (defvar org-bracket-link-analytic-regexp)
485 (defun org-babel-detangle (&optional source-code-file)
486 "Propagate changes in source file back original to Org-mode file.
487 This requires that code blocks were tangled with link comments
488 which enable the original code blocks to be found."
489 (interactive)
490 (save-excursion
491 (when source-code-file (find-file source-code-file))
492 (goto-char (point-min))
493 (let ((counter 0) new-body end)
494 (while (re-search-forward org-bracket-link-analytic-regexp nil t)
495 (when (re-search-forward
496 (concat " " (regexp-quote (match-string 5)) " ends here"))
497 (setq end (match-end 0))
498 (forward-line -1)
499 (save-excursion
500 (when (setq new-body (org-babel-tangle-jump-to-org))
501 (org-babel-update-block-body new-body)))
502 (setq counter (+ 1 counter)))
503 (goto-char end))
504 (prog1 counter (message "Detangled %d code blocks" counter)))))
506 (defun org-babel-tangle-jump-to-org ()
507 "Jump from a tangled code file to the related Org-mode file."
508 (interactive)
509 (let ((mid (point))
510 start body-start end done
511 target-buffer target-char link path block-name body)
512 (save-window-excursion
513 (save-excursion
514 (while (and (re-search-backward org-bracket-link-analytic-regexp nil t)
515 (not ; ever wider searches until matching block comments
516 (and (setq start (point-at-eol))
517 (setq body-start (save-excursion
518 (forward-line 2) (point-at-bol)))
519 (setq link (match-string 0))
520 (setq path (match-string 3))
521 (setq block-name (match-string 5))
522 (save-excursion
523 (save-match-data
524 (re-search-forward
525 (concat " " (regexp-quote block-name)
526 " ends here") nil t)
527 (setq end (point-at-bol))))))))
528 (unless (and start (< start mid) (< mid end))
529 (error "Not in tangled code"))
530 (setq body (org-babel-trim (buffer-substring start end))))
531 (when (string-match "::" path)
532 (setq path (substring path 0 (match-beginning 0))))
533 (find-file path) (setq target-buffer (current-buffer))
534 (goto-char start) (org-open-link-from-string link)
535 (if (string-match "[^ \t\n\r]:\\([[:digit:]]+\\)" block-name)
536 (org-babel-next-src-block
537 (string-to-number (match-string 1 block-name)))
538 (org-babel-goto-named-src-block block-name))
539 ;; position at the beginning of the code block body
540 (goto-char (org-babel-where-is-src-block-head))
541 (forward-line 1)
542 ;; Use org-edit-special to isolate the code.
543 (org-edit-special)
544 ;; Then move forward the correct number of characters in the
545 ;; code buffer.
546 (forward-char (- mid body-start))
547 ;; And return to the Org-mode buffer with the point in the right
548 ;; place.
549 (org-edit-src-exit)
550 (setq target-char (point)))
551 (org-src-switch-to-buffer target-buffer t)
552 (prog1 body (goto-char target-char))))
554 (provide 'ob-tangle)
556 ;; Local variables:
557 ;; generated-autoload-file: "org-loaddefs.el"
558 ;; End:
560 ;;; ob-tangle.el ends here