ob-tangle.el 20 KB

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