Republish org-odt-20111011.tar
[org-mode/org-jambu.git] / lisp / ob-tangle.el
blob7b089f66db499a799f7690803eb72d99b06d8a82
1 ;;; ob-tangle.el --- extract source code from org-mode files
3 ;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
6 ;; Keywords: literate programming, reproducible research
7 ;; Homepage: http://orgmode.org
8 ;; Version: 7.5
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/>.
25 ;;; Commentary:
27 ;; Extract the code from source blocks out into raw source-code files.
29 ;;; Code:
30 (require 'ob)
31 (require 'org-src)
32 (eval-when-compile
33 (require 'cl))
35 (declare-function org-link-escape "org" (text &optional table))
36 (declare-function org-heading-components "org" ())
37 (declare-function org-back-to-heading "org" (invisible-ok))
38 (declare-function org-fill-template "org" (template alist))
39 (declare-function org-babel-update-block-body "org" (new-body))
40 (declare-function make-directory "files" (dir &optional parents))
42 ;;;###autoload
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 :type '(repeat
52 (cons
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'."
58 :group 'org-babel
59 :type 'hook)
61 (defcustom org-babel-pre-tangle-hook '(save-buffer)
62 "Hook run at the beginning of `org-babel-tangle'."
63 :group 'org-babel
64 :type 'hook)
66 (defcustom org-babel-tangle-body-hook nil
67 "Hook run over the contents of each code block body."
68 :group 'org-babel
69 :type 'hook)
71 (defcustom org-babel-tangle-comment-format-beg "[[%link][%source-name]]"
72 "Format of inserted comments in tangled code files.
73 The following format strings can be used to insert special
74 information into the output using `org-fill-template'.
75 %start-line --- the line number at the start of the code block
76 %file --------- the file from which the code block was tangled
77 %link --------- Org-mode style link to the code block
78 %source-name -- name of the code block
80 Whether or not comments are inserted during tangling is
81 controlled by the :comments header argument."
82 :group 'org-babel
83 :type 'string)
85 (defcustom org-babel-tangle-comment-format-end "%source-name ends here"
86 "Format of inserted comments in tangled code files.
87 The following format strings can be used to insert special
88 information into the output using `org-fill-template'.
89 %start-line --- the line number at the start of the code block
90 %file --------- the file from which the code block was tangled
91 %link --------- Org-mode style link to the code block
92 %source-name -- name of the code block
94 Whether or not comments are inserted during tangling is
95 controlled by the :comments header argument."
96 :group 'org-babel
97 :type 'string)
99 (defun org-babel-find-file-noselect-refresh (file)
100 "Find file ensuring that the latest changes on disk are
101 represented in the file."
102 (find-file-noselect file)
103 (with-current-buffer (get-file-buffer file)
104 (revert-buffer t t t)))
106 (defmacro org-babel-with-temp-filebuffer (file &rest body)
107 "Open FILE into a temporary buffer execute BODY there like
108 `progn', then kill the FILE buffer returning the result of
109 evaluating BODY."
110 (declare (indent 1))
111 (let ((temp-result (make-symbol "temp-result"))
112 (temp-file (make-symbol "temp-file"))
113 (visited-p (make-symbol "visited-p")))
114 `(let (,temp-result ,temp-file
115 (,visited-p (get-file-buffer ,file)))
116 (org-babel-find-file-noselect-refresh ,file)
117 (setf ,temp-file (get-file-buffer ,file))
118 (with-current-buffer ,temp-file
119 (setf ,temp-result (progn ,@body)))
120 (unless ,visited-p (kill-buffer ,temp-file))
121 ,temp-result)))
123 ;;;###autoload
124 (defun org-babel-load-file (file)
125 "Load Emacs Lisp source code blocks in the Org-mode FILE.
126 This function exports the source code using
127 `org-babel-tangle' and then loads the resulting file using
128 `load-file'."
129 (interactive "fFile to load: ")
130 (flet ((age (file)
131 (float-time
132 (time-subtract (current-time)
133 (nth 5 (or (file-attributes (file-truename file))
134 (file-attributes file)))))))
135 (let* ((base-name (file-name-sans-extension file))
136 (exported-file (concat base-name ".el")))
137 ;; tangle if the org-mode file is newer than the elisp file
138 (unless (and (file-exists-p exported-file)
139 (> (age file) (age exported-file)))
140 (org-babel-tangle-file file exported-file "emacs-lisp"))
141 (load-file exported-file)
142 (message "loaded %s" exported-file))))
144 ;;;###autoload
145 (defun org-babel-tangle-file (file &optional target-file lang)
146 "Extract the bodies of source code blocks in FILE.
147 Source code blocks are extracted with `org-babel-tangle'.
148 Optional argument TARGET-FILE can be used to specify a default
149 export file for all source blocks. Optional argument LANG can be
150 used to limit the exported source code blocks by language."
151 (interactive "fFile to tangle: \nP")
152 (let ((visited-p (get-file-buffer (expand-file-name file)))
153 to-be-removed)
154 (save-window-excursion
155 (find-file file)
156 (setq to-be-removed (current-buffer))
157 (org-babel-tangle nil target-file lang))
158 (unless visited-p
159 (kill-buffer to-be-removed))))
161 (defun org-babel-tangle-publish (_ filename pub-dir)
162 "Tangle FILENAME and place the results in PUB-DIR."
163 (mapc (lambda (el) (copy-file el pub-dir t)) (org-babel-tangle-file filename)))
165 ;;;###autoload
166 (defun org-babel-tangle (&optional only-this-block target-file lang)
167 "Write code blocks to source-specific files.
168 Extract the bodies of all source code blocks from the current
169 file into their own source-specific files. Optional argument
170 TARGET-FILE can be used to specify a default export file for all
171 source blocks. Optional argument LANG can be used to limit the
172 exported source code blocks by language."
173 (interactive "P")
174 (run-hooks 'org-babel-pre-tangle-hook)
175 ;; possibly restrict the buffer to the current code block
176 (save-restriction
177 (when only-this-block
178 (unless (org-babel-where-is-src-block-head)
179 (error "Point is not currently inside of a code block"))
180 (unless target-file
181 (setq target-file
182 (read-from-minibuffer "Tangle to: " (buffer-file-name))))
183 (narrow-to-region (match-beginning 0) (match-end 0)))
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 path-collector)
192 (mapc ;; map over all languages
193 (lambda (by-lang)
194 (let* ((lang (car by-lang))
195 (specs (cdr by-lang))
196 (ext (or (cdr (assoc lang org-babel-tangle-lang-exts)) lang))
197 (lang-f (intern
198 (concat
199 (or (and (cdr (assoc lang org-src-lang-modes))
200 (symbol-name
201 (cdr (assoc lang org-src-lang-modes))))
202 lang)
203 "-mode")))
204 she-banged)
205 (mapc
206 (lambda (spec)
207 (flet ((get-spec (name)
208 (cdr (assoc name (nth 4 spec)))))
209 (let* ((tangle (get-spec :tangle))
210 (she-bang ((lambda (sheb) (when (> (length sheb) 0) sheb))
211 (get-spec :shebang)))
212 (base-name (cond
213 ((string= "yes" tangle)
214 (file-name-sans-extension
215 (buffer-file-name)))
216 ((string= "no" tangle) nil)
217 ((> (length tangle) 0) tangle)))
218 (file-name (when base-name
219 ;; decide if we want to add ext to base-name
220 (if (and ext (string= "yes" tangle))
221 (concat base-name "." ext) base-name))))
222 (when file-name
223 ;; possibly create the parent directories for file
224 (when ((lambda (m) (and m (not (string= m "no"))))
225 (get-spec :mkdirp))
226 (make-directory (file-name-directory file-name) 'parents))
227 ;; delete any old versions of file
228 (when (and (file-exists-p file-name)
229 (not (member file-name path-collector)))
230 (delete-file file-name))
231 ;; drop source-block to file
232 (with-temp-buffer
233 (when (fboundp lang-f) (funcall lang-f))
234 (when (and she-bang (not (member file-name she-banged)))
235 (insert (concat she-bang "\n"))
236 (setq she-banged (cons file-name she-banged)))
237 (org-babel-spec-to-string spec)
238 ;; We avoid append-to-file as it does not work with tramp.
239 (let ((content (buffer-string)))
240 (with-temp-buffer
241 (if (file-exists-p file-name)
242 (insert-file-contents file-name))
243 (goto-char (point-max))
244 (insert content)
245 (write-region nil nil file-name))))
246 ;; if files contain she-bangs, then make the executable
247 (when she-bang (set-file-modes file-name #o755))
248 ;; update counter
249 (setq block-counter (+ 1 block-counter))
250 (add-to-list 'path-collector file-name)))))
251 specs)))
252 (org-babel-tangle-collect-blocks lang))
253 (message "tangled %d code block%s from %s" block-counter
254 (if (= block-counter 1) "" "s")
255 (file-name-nondirectory
256 (buffer-file-name (or (buffer-base-buffer) (current-buffer)))))
257 ;; run `org-babel-post-tangle-hook' in all tangled files
258 (when org-babel-post-tangle-hook
259 (mapc
260 (lambda (file)
261 (org-babel-with-temp-filebuffer file
262 (run-hooks 'org-babel-post-tangle-hook)))
263 path-collector))
264 path-collector))))
266 (defun org-babel-tangle-clean ()
267 "Remove comments inserted by `org-babel-tangle'.
268 Call this function inside of a source-code file generated by
269 `org-babel-tangle' to remove all comments inserted automatically
270 by `org-babel-tangle'. Warning, this comment removes any lines
271 containing constructs which resemble org-mode file links or noweb
272 references."
273 (interactive)
274 (goto-char (point-min))
275 (while (or (re-search-forward "\\[\\[file:.*\\]\\[.*\\]\\]" nil t)
276 (re-search-forward "<<[^[:space:]]*>>" nil t))
277 (delete-region (save-excursion (beginning-of-line 1) (point))
278 (save-excursion (end-of-line 1) (forward-char 1) (point)))))
280 (defvar org-stored-links)
281 (defvar org-bracket-link-regexp)
282 (defun org-babel-tangle-collect-blocks (&optional language)
283 "Collect source blocks in the current Org-mode file.
284 Return an association list of source-code block specifications of
285 the form used by `org-babel-spec-to-string' grouped by language.
286 Optional argument LANG can be used to limit the collected source
287 code blocks by language."
288 (let ((block-counter 1) (current-heading "") blocks)
289 (org-babel-map-src-blocks (buffer-file-name)
290 ((lambda (new-heading)
291 (if (not (string= new-heading current-heading))
292 (progn
293 (setq block-counter 1)
294 (setq current-heading new-heading))
295 (setq block-counter (+ 1 block-counter))))
296 (replace-regexp-in-string "[ \t]" "-"
297 (condition-case nil
298 (nth 4 (org-heading-components))
299 (error (buffer-file-name)))))
300 (let* ((start-line (save-restriction (widen)
301 (+ 1 (line-number-at-pos (point)))))
302 (file (buffer-file-name))
303 (info (org-babel-get-src-block-info 'light))
304 (src-lang (nth 0 info)))
305 (unless (string= (cdr (assoc :tangle (nth 2 info))) "no")
306 (unless (and language (not (string= language src-lang)))
307 (let* ((info (org-babel-get-src-block-info))
308 (params (nth 2 info))
309 (link ((lambda (link)
310 (and (string-match org-bracket-link-regexp link)
311 (match-string 1 link)))
312 (org-babel-clean-text-properties
313 (org-store-link nil))))
314 (source-name
315 (intern (or (nth 4 info)
316 (format "%s:%d"
317 current-heading block-counter))))
318 (expand-cmd
319 (intern (concat "org-babel-expand-body:" src-lang)))
320 (assignments-cmd
321 (intern (concat "org-babel-variable-assignments:" src-lang)))
322 (body
323 ((lambda (body) ;; run the tangle-body-hook
324 (with-temp-buffer
325 (insert body)
326 (run-hooks 'org-babel-tangle-body-hook)
327 (buffer-string)))
328 ((lambda (body) ;; expand the body in language specific manner
329 (if (assoc :no-expand params)
330 body
331 (if (fboundp expand-cmd)
332 (funcall expand-cmd body params)
333 (org-babel-expand-body:generic
334 body params
335 (and (fboundp assignments-cmd)
336 (funcall assignments-cmd params))))))
337 (if (and (cdr (assoc :noweb params)) ;; expand noweb refs
338 (let ((nowebs (split-string
339 (cdr (assoc :noweb params)))))
340 (or (member "yes" nowebs)
341 (member "tangle" nowebs))))
342 (org-babel-expand-noweb-references info)
343 (nth 1 info)))))
344 (comment
345 (when (or (string= "both" (cdr (assoc :comments params)))
346 (string= "org" (cdr (assoc :comments params))))
347 ;; from the previous heading or code-block end
348 (buffer-substring
349 (max (condition-case nil
350 (save-excursion
351 (org-back-to-heading t) (point))
352 (error 0))
353 (save-excursion
354 (re-search-backward
355 org-babel-src-block-regexp nil t)
356 (match-end 0)))
357 (point))))
358 by-lang)
359 ;; add the spec for this block to blocks under it's language
360 (setq by-lang (cdr (assoc src-lang blocks)))
361 (setq blocks (delq (assoc src-lang blocks) blocks))
362 (setq blocks (cons
363 (cons src-lang
364 (cons (list start-line file link
365 source-name params body comment)
366 by-lang)) blocks)))))))
367 ;; ensure blocks in the correct order
368 (setq blocks
369 (mapcar
370 (lambda (by-lang) (cons (car by-lang) (reverse (cdr by-lang))))
371 blocks))
372 blocks))
374 (defun org-babel-spec-to-string (spec)
375 "Insert SPEC into the current file.
376 Insert the source-code specified by SPEC into the current
377 source code file. This function uses `comment-region' which
378 assumes that the appropriate major-mode is set. SPEC has the
379 form
381 (start-line file link source-name params body comment)"
382 (let* ((start-line (nth 0 spec))
383 (file (nth 1 spec))
384 (link (org-link-escape (nth 2 spec)))
385 (source-name (nth 3 spec))
386 (body (nth 5 spec))
387 (comment (nth 6 spec))
388 (comments (cdr (assoc :comments (nth 4 spec))))
389 (padline (not (string= "no" (cdr (assoc :padline (nth 4 spec))))))
390 (link-p (or (string= comments "both") (string= comments "link")
391 (string= comments "yes") (string= comments "noweb")))
392 (link-data (mapcar (lambda (el)
393 (cons (symbol-name el)
394 ((lambda (le)
395 (if (stringp le) le (format "%S" le)))
396 (eval el))))
397 '(start-line file link source-name))))
398 (flet ((insert-comment (text)
399 (let ((text (org-babel-trim text)))
400 (when (and comments (not (string= comments "no"))
401 (> (length text) 0))
402 (when padline (insert "\n"))
403 (comment-region (point) (progn (insert text) (point)))
404 (end-of-line nil) (insert "\n")))))
405 (when comment (insert-comment comment))
406 (when link-p
407 (insert-comment
408 (org-fill-template org-babel-tangle-comment-format-beg link-data)))
409 (when padline (insert "\n"))
410 (insert
411 (format
412 "%s\n"
413 (replace-regexp-in-string
414 "^," ""
415 (org-babel-trim body (if org-src-preserve-indentation "[\f\n\r\v]")))))
416 (when link-p
417 (insert-comment
418 (org-fill-template org-babel-tangle-comment-format-end link-data))))))
420 (defun org-babel-tangle-comment-links ( &optional info)
421 "Return a list of begin and end link comments for the code block at point."
422 (let* ((start-line (org-babel-where-is-src-block-head))
423 (file (buffer-file-name))
424 (link (org-link-escape (progn (call-interactively 'org-store-link)
425 (org-babel-clean-text-properties
426 (car (pop org-stored-links))))))
427 (source-name (nth 4 (or info (org-babel-get-src-block-info 'light))))
428 (link-data (mapcar (lambda (el)
429 (cons (symbol-name el)
430 ((lambda (le)
431 (if (stringp le) le (format "%S" le)))
432 (eval el))))
433 '(start-line file link source-name))))
434 (list (org-fill-template org-babel-tangle-comment-format-beg link-data)
435 (org-fill-template org-babel-tangle-comment-format-end link-data))))
437 ;; de-tangling functions
438 (defvar org-bracket-link-analytic-regexp)
439 (defun org-babel-detangle (&optional source-code-file)
440 "Propagate changes in source file back original to Org-mode file.
441 This requires that code blocks were tangled with link comments
442 which enable the original code blocks to be found."
443 (interactive)
444 (save-excursion
445 (when source-code-file (find-file source-code-file))
446 (goto-char (point-min))
447 (let ((counter 0) new-body end)
448 (while (re-search-forward org-bracket-link-analytic-regexp nil t)
449 (when (re-search-forward
450 (concat " " (regexp-quote (match-string 5)) " ends here"))
451 (setq end (match-end 0))
452 (forward-line -1)
453 (save-excursion
454 (when (setq new-body (org-babel-tangle-jump-to-org))
455 (org-babel-update-block-body new-body)))
456 (setq counter (+ 1 counter)))
457 (goto-char end))
458 (prog1 counter (message "detangled %d code blocks" counter)))))
460 (defun org-babel-tangle-jump-to-org ()
461 "Jump from a tangled code file to the related Org-mode file."
462 (interactive)
463 (let ((mid (point))
464 start end done
465 target-buffer target-char link path block-name body)
466 (save-window-excursion
467 (save-excursion
468 (while (and (re-search-backward org-bracket-link-analytic-regexp nil t)
469 (not ; ever wider searches until matching block comments
470 (and (setq start (point-at-eol))
471 (setq link (match-string 0))
472 (setq path (match-string 3))
473 (setq block-name (match-string 5))
474 (save-excursion
475 (save-match-data
476 (re-search-forward
477 (concat " " (regexp-quote block-name)
478 " ends here") nil t)
479 (setq end (point-at-bol))))))))
480 (unless (and start (< start mid) (< mid end))
481 (error "not in tangled code"))
482 (setq body (org-babel-trim (buffer-substring start end))))
483 (when (string-match "::" path)
484 (setq path (substring path 0 (match-beginning 0))))
485 (find-file path) (setq target-buffer (current-buffer))
486 (goto-char start) (org-open-link-from-string link)
487 (if (string-match "[^ \t\n\r]:\\([[:digit:]]+\\)" block-name)
488 (org-babel-next-src-block
489 (string-to-number (match-string 1 block-name)))
490 (org-babel-goto-named-src-block block-name))
491 (setq target-char (point)))
492 (pop-to-buffer target-buffer)
493 (prog1 body (goto-char target-char))))
495 (provide 'ob-tangle)
497 ;; arch-tag: 413ced93-48f5-4216-86e4-3fc5df8c8f24
499 ;;; ob-tangle.el ends here