1 ;;; ob-tangle.el --- extract source code from org-mode files
3 ;; Copyright (C) 2009-2012 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.
34 (declare-function org-link-escape
"org" (text &optional table
))
35 (declare-function org-heading-components
"org" ())
36 (declare-function org-back-to-heading
"org" (invisible-ok))
37 (declare-function org-fill-template
"org" (template alist
))
38 (declare-function org-babel-update-block-body
"org" (new-body))
39 (declare-function make-directory
"files" (dir &optional parents
))
42 (defcustom org-babel-tangle-lang-exts
43 '(("emacs-lisp" .
"el"))
44 "Alist mapping languages to their file extensions.
45 The key is the language name, the value is the string that should
46 be inserted as the extension commonly used to identify files
47 written in this language. If no entry is found in this list,
48 then the name of the language is used."
49 :group
'org-babel-tangle
53 (string "Language name")
54 (string "File Extension"))))
56 (defcustom org-babel-post-tangle-hook nil
57 "Hook run in code files tangled by `org-babel-tangle'."
62 (defcustom org-babel-pre-tangle-hook
'(save-buffer)
63 "Hook run at the beginning of `org-babel-tangle'."
68 (defcustom org-babel-tangle-body-hook nil
69 "Hook run over the contents of each code block body."
74 (defcustom org-babel-tangle-comment-format-beg
"[[%link][%source-name]]"
75 "Format of inserted comments in tangled code files.
76 The following format strings can be used to insert special
77 information into the output using `org-fill-template'.
78 %start-line --- the line number at the start of the code block
79 %file --------- the file from which the code block was tangled
80 %link --------- Org-mode style link to the code block
81 %source-name -- name of the code block
83 Whether or not comments are inserted during tangling is
84 controlled by the :comments header argument."
89 (defcustom org-babel-tangle-comment-format-end
"%source-name ends here"
90 "Format of inserted comments in tangled code files.
91 The following format strings can be used to insert special
92 information into the output using `org-fill-template'.
93 %start-line --- the line number at the start of the code block
94 %file --------- the file from which the code block was tangled
95 %link --------- Org-mode style link to the code block
96 %source-name -- name of the code block
98 Whether or not comments are inserted during tangling is
99 controlled by the :comments header argument."
104 (defcustom org-babel-process-comment-text
#'org-babel-trim
105 "Function called to process raw Org-mode text collected to be
106 inserted as comments in tangled source-code files. The function
107 should take a single string argument and return a string
108 result. The default value is `org-babel-trim'."
113 (defun org-babel-find-file-noselect-refresh (file)
114 "Find file ensuring that the latest changes on disk are
115 represented in the file."
116 (find-file-noselect file
)
117 (with-current-buffer (get-file-buffer file
)
118 (revert-buffer t t t
)))
120 (defmacro org-babel-with-temp-filebuffer
(file &rest body
)
121 "Open FILE into a temporary buffer execute BODY there like
122 `progn', then kill the FILE buffer returning the result of
125 (let ((temp-path (make-symbol "temp-path"))
126 (temp-result (make-symbol "temp-result"))
127 (temp-file (make-symbol "temp-file"))
128 (visited-p (make-symbol "visited-p")))
129 `(let* ((,temp-path
,file
)
130 (,visited-p
(get-file-buffer ,temp-path
))
131 ,temp-result
,temp-file
)
132 (org-babel-find-file-noselect-refresh ,temp-path
)
133 (setf ,temp-file
(get-file-buffer ,temp-path
))
134 (with-current-buffer ,temp-file
135 (setf ,temp-result
(progn ,@body
)))
136 (unless ,visited-p
(kill-buffer ,temp-file
))
138 (def-edebug-spec org-babel-with-temp-filebuffer
(form body
))
141 (defun org-babel-load-file (file)
142 "Load Emacs Lisp source code blocks in the Org-mode FILE.
143 This function exports the source code using
144 `org-babel-tangle' and then loads the resulting file using
146 (interactive "fFile to load: ")
147 (org-flet ((age (file)
149 (time-subtract (current-time)
150 (nth 5 (or (file-attributes (file-truename file
))
151 (file-attributes file
)))))))
152 (let* ((base-name (file-name-sans-extension file
))
153 (exported-file (concat base-name
".el")))
154 ;; tangle if the org-mode file is newer than the elisp file
155 (unless (and (file-exists-p exported-file
)
156 (> (age file
) (age exported-file
)))
157 (org-babel-tangle-file file exported-file
"emacs-lisp"))
158 (load-file exported-file
)
159 (message "loaded %s" exported-file
))))
162 (defun org-babel-tangle-file (file &optional target-file lang
)
163 "Extract the bodies of source code blocks in FILE.
164 Source code blocks are extracted with `org-babel-tangle'.
165 Optional argument TARGET-FILE can be used to specify a default
166 export file for all source blocks. Optional argument LANG can be
167 used to limit the exported source code blocks by language."
168 (interactive "fFile to tangle: \nP")
169 (let ((visited-p (get-file-buffer (expand-file-name file
)))
171 (save-window-excursion
173 (setq to-be-removed
(current-buffer))
174 (org-babel-tangle nil target-file lang
))
176 (kill-buffer to-be-removed
))))
178 (defun org-babel-tangle-publish (_ filename pub-dir
)
179 "Tangle FILENAME and place the results in PUB-DIR."
180 (mapc (lambda (el) (copy-file el pub-dir t
)) (org-babel-tangle-file filename
)))
183 (defun org-babel-tangle (&optional only-this-block target-file lang
)
184 "Write code blocks to source-specific files.
185 Extract the bodies of all source code blocks from the current
186 file into their own source-specific files. Optional argument
187 TARGET-FILE can be used to specify a default export file for all
188 source blocks. Optional argument LANG can be used to limit the
189 exported source code blocks by language."
191 (run-hooks 'org-babel-pre-tangle-hook
)
192 ;; possibly restrict the buffer to the current code block
194 (when only-this-block
195 (unless (org-babel-where-is-src-block-head)
196 (error "Point is not currently inside of a code block"))
198 (unless (or (cdr (assoc :tangle
(nth 2 (org-babel-get-src-block-info))))
201 (read-from-minibuffer "Tangle to: " (buffer-file-name)))))
202 (narrow-to-region (match-beginning 0) (match-end 0)))
204 (let ((block-counter 0)
205 (org-babel-default-header-args
207 (org-babel-merge-params org-babel-default-header-args
208 (list (cons :tangle target-file
)))
209 org-babel-default-header-args
))
211 (mapc ;; map over all languages
213 (let* ((lang (car by-lang
))
214 (specs (cdr by-lang
))
215 (ext (or (cdr (assoc lang org-babel-tangle-lang-exts
)) lang
))
218 (or (and (cdr (assoc lang org-src-lang-modes
))
220 (cdr (assoc lang org-src-lang-modes
))))
226 (org-flet ((get-spec (name)
227 (cdr (assoc name
(nth 4 spec
)))))
228 (let* ((tangle (get-spec :tangle
))
229 (she-bang ((lambda (sheb) (when (> (length sheb
) 0) sheb
))
230 (get-spec :shebang
)))
232 ((string= "yes" tangle
)
233 (file-name-sans-extension
235 ((string= "no" tangle
) nil
)
236 ((> (length tangle
) 0) tangle
)))
237 (file-name (when base-name
238 ;; decide if we want to add ext to base-name
239 (if (and ext
(string= "yes" tangle
))
240 (concat base-name
"." ext
) base-name
))))
242 ;; possibly create the parent directories for file
243 (when ((lambda (m) (and m
(not (string= m
"no"))))
245 (make-directory (file-name-directory file-name
) 'parents
))
246 ;; delete any old versions of file
247 (when (and (file-exists-p file-name
)
248 (not (member file-name path-collector
)))
249 (delete-file file-name
))
250 ;; drop source-block to file
252 (when (fboundp lang-f
) (ignore-errors (funcall lang-f
)))
253 (when (and she-bang
(not (member file-name she-banged
)))
254 (insert (concat she-bang
"\n"))
255 (setq she-banged
(cons file-name she-banged
)))
256 (org-babel-spec-to-string spec
)
257 ;; We avoid append-to-file as it does not work with tramp.
258 (let ((content (buffer-string)))
260 (if (file-exists-p file-name
)
261 (insert-file-contents file-name
))
262 (goto-char (point-max))
264 (write-region nil nil file-name
))))
265 ;; if files contain she-bangs, then make the executable
266 (when she-bang
(set-file-modes file-name
#o755
))
268 (setq block-counter
(+ 1 block-counter
))
269 (add-to-list 'path-collector file-name
)))))
271 (org-babel-tangle-collect-blocks lang
))
272 (message "tangled %d code block%s from %s" block-counter
273 (if (= block-counter
1) "" "s")
274 (file-name-nondirectory
275 (buffer-file-name (or (buffer-base-buffer) (current-buffer)))))
276 ;; run `org-babel-post-tangle-hook' in all tangled files
277 (when org-babel-post-tangle-hook
280 (org-babel-with-temp-filebuffer file
281 (run-hooks 'org-babel-post-tangle-hook
)))
285 (defun org-babel-tangle-clean ()
286 "Remove comments inserted by `org-babel-tangle'.
287 Call this function inside of a source-code file generated by
288 `org-babel-tangle' to remove all comments inserted automatically
289 by `org-babel-tangle'. Warning, this comment removes any lines
290 containing constructs which resemble org-mode file links or noweb
293 (goto-char (point-min))
294 (while (or (re-search-forward "\\[\\[file:.*\\]\\[.*\\]\\]" nil t
)
295 (re-search-forward (org-babel-noweb-wrap) nil t
))
296 (delete-region (save-excursion (beginning-of-line 1) (point))
297 (save-excursion (end-of-line 1) (forward-char 1) (point)))))
299 (defvar org-stored-links
)
300 (defvar org-bracket-link-regexp
)
301 (defun org-babel-tangle-collect-blocks (&optional language
)
302 "Collect source blocks in the current Org-mode file.
303 Return an association list of source-code block specifications of
304 the form used by `org-babel-spec-to-string' grouped by language.
305 Optional argument LANG can be used to limit the collected source
306 code blocks by language."
307 (let ((block-counter 1) (current-heading "") blocks
)
308 (org-babel-map-src-blocks (buffer-file-name)
309 ((lambda (new-heading)
310 (if (not (string= new-heading current-heading
))
312 (setq block-counter
1)
313 (setq current-heading new-heading
))
314 (setq block-counter
(+ 1 block-counter
))))
315 (replace-regexp-in-string "[ \t]" "-"
317 (nth 4 (org-heading-components))
318 (error (buffer-file-name)))))
319 (let* ((start-line (save-restriction (widen)
320 (+ 1 (line-number-at-pos (point)))))
321 (file (buffer-file-name))
322 (info (org-babel-get-src-block-info 'light
))
323 (src-lang (nth 0 info
)))
324 (unless (string= (cdr (assoc :tangle
(nth 2 info
))) "no")
325 (unless (and language
(not (string= language src-lang
)))
326 (let* ((info (org-babel-get-src-block-info))
327 (params (nth 2 info
))
328 (link ((lambda (link)
329 (and (string-match org-bracket-link-regexp link
)
330 (match-string 1 link
)))
331 (org-babel-clean-text-properties
332 (org-store-link nil
))))
334 (intern (or (nth 4 info
)
336 current-heading block-counter
))))
338 (intern (concat "org-babel-expand-body:" src-lang
)))
340 (intern (concat "org-babel-variable-assignments:" src-lang
)))
342 ((lambda (body) ;; run the tangle-body-hook
345 (run-hooks 'org-babel-tangle-body-hook
)
347 ((lambda (body) ;; expand the body in language specific manner
348 (if (assoc :no-expand params
)
350 (if (fboundp expand-cmd
)
351 (funcall expand-cmd body params
)
352 (org-babel-expand-body:generic
354 (and (fboundp assignments-cmd
)
355 (funcall assignments-cmd params
))))))
356 (if (org-babel-noweb-p params
:tangle
)
357 (org-babel-expand-noweb-references info
)
360 (when (or (string= "both" (cdr (assoc :comments params
)))
361 (string= "org" (cdr (assoc :comments params
))))
362 ;; from the previous heading or code-block end
364 org-babel-process-comment-text
366 (max (condition-case nil
368 (org-back-to-heading t
) ; sets match data
372 (if (re-search-backward
373 org-babel-src-block-regexp nil t
)
378 ;; add the spec for this block to blocks under it's language
379 (setq by-lang
(cdr (assoc src-lang blocks
)))
380 (setq blocks
(delq (assoc src-lang blocks
) blocks
))
383 (cons (list start-line file link
384 source-name params body comment
)
385 by-lang
)) blocks
)))))))
386 ;; ensure blocks in the correct order
389 (lambda (by-lang) (cons (car by-lang
) (reverse (cdr by-lang
))))
393 (defun org-babel-spec-to-string (spec)
394 "Insert SPEC into the current file.
395 Insert the source-code specified by SPEC into the current
396 source code file. This function uses `comment-region' which
397 assumes that the appropriate major-mode is set. SPEC has the
400 (start-line file link source-name params body comment)"
401 (let* ((start-line (nth 0 spec
))
404 (source-name (nth 3 spec
))
406 (comment (nth 6 spec
))
407 (comments (cdr (assoc :comments
(nth 4 spec
))))
408 (padline (not (string= "no" (cdr (assoc :padline
(nth 4 spec
))))))
409 (link-p (or (string= comments
"both") (string= comments
"link")
410 (string= comments
"yes") (string= comments
"noweb")))
411 (link-data (mapcar (lambda (el)
412 (cons (symbol-name el
)
414 (if (stringp le
) le
(format "%S" le
)))
416 '(start-line file link source-name
))))
417 (org-flet ((insert-comment (text)
418 (when (and comments
(not (string= comments
"no"))
420 (when padline
(insert "\n"))
421 (comment-region (point) (progn (insert text
) (point)))
422 (end-of-line nil
) (insert "\n"))))
423 (when comment
(insert-comment comment
))
426 (org-fill-template org-babel-tangle-comment-format-beg link-data
)))
427 (when padline
(insert "\n"))
431 (replace-regexp-in-string
433 (org-babel-trim body
(if org-src-preserve-indentation
"[\f\n\r\v]")))))
436 (org-fill-template org-babel-tangle-comment-format-end link-data
))))))
438 (defun org-babel-tangle-comment-links ( &optional info
)
439 "Return a list of begin and end link comments for the code block at point."
440 (let* ((start-line (org-babel-where-is-src-block-head))
441 (file (buffer-file-name))
442 (link (org-link-escape (progn (call-interactively 'org-store-link
)
443 (org-babel-clean-text-properties
444 (car (pop org-stored-links
))))))
445 (source-name (nth 4 (or info
(org-babel-get-src-block-info 'light
))))
446 (link-data (mapcar (lambda (el)
447 (cons (symbol-name el
)
449 (if (stringp le
) le
(format "%S" le
)))
451 '(start-line file link source-name
))))
452 (list (org-fill-template org-babel-tangle-comment-format-beg link-data
)
453 (org-fill-template org-babel-tangle-comment-format-end link-data
))))
455 ;; de-tangling functions
456 (defvar org-bracket-link-analytic-regexp
)
457 (defun org-babel-detangle (&optional source-code-file
)
458 "Propagate changes in source file back original to Org-mode file.
459 This requires that code blocks were tangled with link comments
460 which enable the original code blocks to be found."
463 (when source-code-file
(find-file source-code-file
))
464 (goto-char (point-min))
465 (let ((counter 0) new-body end
)
466 (while (re-search-forward org-bracket-link-analytic-regexp nil t
)
467 (when (re-search-forward
468 (concat " " (regexp-quote (match-string 5)) " ends here"))
469 (setq end
(match-end 0))
472 (when (setq new-body
(org-babel-tangle-jump-to-org))
473 (org-babel-update-block-body new-body
)))
474 (setq counter
(+ 1 counter
)))
476 (prog1 counter
(message "detangled %d code blocks" counter
)))))
478 (defun org-babel-tangle-jump-to-org ()
479 "Jump from a tangled code file to the related Org-mode file."
483 target-buffer target-char link path block-name body
)
484 (save-window-excursion
486 (while (and (re-search-backward org-bracket-link-analytic-regexp nil t
)
487 (not ; ever wider searches until matching block comments
488 (and (setq start
(point-at-eol))
489 (setq link
(match-string 0))
490 (setq path
(match-string 3))
491 (setq block-name
(match-string 5))
495 (concat " " (regexp-quote block-name
)
497 (setq end
(point-at-bol))))))))
498 (unless (and start
(< start mid
) (< mid end
))
499 (error "not in tangled code"))
500 (setq body
(org-babel-trim (buffer-substring start end
))))
501 (when (string-match "::" path
)
502 (setq path
(substring path
0 (match-beginning 0))))
503 (find-file path
) (setq target-buffer
(current-buffer))
504 (goto-char start
) (org-open-link-from-string link
)
505 (if (string-match "[^ \t\n\r]:\\([[:digit:]]+\\)" block-name
)
506 (org-babel-next-src-block
507 (string-to-number (match-string 1 block-name
)))
508 (org-babel-goto-named-src-block block-name
))
509 (setq target-char
(point)))
510 (pop-to-buffer target-buffer
)
511 (prog1 body
(goto-char target-char
))))
517 ;;; ob-tangle.el ends here