ob-tangle.el 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654
  1. ;;; ob-tangle.el --- Extract Source Code From Org Files -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2009-2022 Free Software Foundation, Inc.
  3. ;; Author: Eric Schulte
  4. ;; Keywords: literate programming, reproducible research
  5. ;; Homepage: https://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 <https://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;; Extract the code from source blocks out into raw source-code files.
  19. ;;; Code:
  20. (require 'cl-lib)
  21. (require 'org-src)
  22. (require 'org-macs)
  23. (require 'ol)
  24. (declare-function make-directory "files" (dir &optional parents))
  25. (declare-function org-at-heading-p "org" (&optional ignored))
  26. (declare-function org-babel-update-block-body "ob-core" (new-body))
  27. (declare-function org-back-to-heading "org" (&optional invisible-ok))
  28. (declare-function org-before-first-heading-p "org" ())
  29. (declare-function org-element-at-point "org-element" (&optional pom cached-only))
  30. (declare-function org-element-type "org-element" (element))
  31. (declare-function org-heading-components "org" ())
  32. (declare-function org-in-commented-heading-p "org" (&optional no-inheritance))
  33. (declare-function org-in-archived-heading-p "org" (&optional no-inheritance))
  34. (declare-function outline-previous-heading "outline" ())
  35. (defvar org-id-link-to-org-use-id nil) ; Dynamically scoped
  36. (defcustom org-babel-tangle-lang-exts
  37. '(("emacs-lisp" . "el")
  38. ("elisp" . "el"))
  39. "Alist mapping languages to their file extensions.
  40. The key is the language name, the value is the string that should
  41. be inserted as the extension commonly used to identify files
  42. written in this language. If no entry is found in this list,
  43. then the name of the language is used."
  44. :group 'org-babel-tangle
  45. :version "24.1"
  46. :type '(repeat
  47. (cons
  48. (string "Language name")
  49. (string "File Extension"))))
  50. (defcustom org-babel-tangle-use-relative-file-links t
  51. "Use relative path names in links from tangled source back the Org file."
  52. :group 'org-babel-tangle
  53. :type 'boolean)
  54. (defcustom org-babel-post-tangle-hook nil
  55. "Hook run in code files tangled by `org-babel-tangle'."
  56. :group 'org-babel
  57. :version "24.1"
  58. :type 'hook)
  59. (defcustom org-babel-pre-tangle-hook '(save-buffer)
  60. "Hook run at the beginning of `org-babel-tangle'."
  61. :group 'org-babel
  62. :version "24.1"
  63. :type 'hook)
  64. (defcustom org-babel-tangle-body-hook nil
  65. "Hook run over the contents of each code block body."
  66. :group 'org-babel
  67. :version "24.1"
  68. :type 'hook)
  69. (defcustom org-babel-tangle-comment-format-beg "[[%link][%source-name]]"
  70. "Format of inserted comments in tangled code files.
  71. The following format strings can be used to insert special
  72. information into the output using `org-fill-template'.
  73. %start-line --- the line number at the start of the code block
  74. %file --------- the file from which the code block was tangled
  75. %link --------- Org style link to the code block
  76. %source-name -- name of the code block
  77. Upon insertion the formatted comment will be commented out, and
  78. followed by a newline. To inhibit this post-insertion processing
  79. set the `org-babel-tangle-uncomment-comments' variable to a
  80. non-nil value.
  81. Whether or not comments are inserted during tangling is
  82. controlled by the :comments header argument."
  83. :group 'org-babel
  84. :version "24.1"
  85. :type 'string)
  86. (defcustom org-babel-tangle-comment-format-end "%source-name ends here"
  87. "Format of inserted comments in tangled code files.
  88. The following format strings can be used to insert special
  89. information into the output using `org-fill-template'.
  90. %start-line --- the line number at the start of the code block
  91. %file --------- the file from which the code block was tangled
  92. %link --------- Org style link to the code block
  93. %source-name -- name of the code block
  94. Upon insertion the formatted comment will be commented out, and
  95. followed by a newline. To inhibit this post-insertion processing
  96. set the `org-babel-tangle-uncomment-comments' variable to a
  97. non-nil value.
  98. Whether or not comments are inserted during tangling is
  99. controlled by the :comments header argument."
  100. :group 'org-babel
  101. :version "24.1"
  102. :type 'string)
  103. (defcustom org-babel-tangle-uncomment-comments nil
  104. "Inhibits automatic commenting and addition of trailing newline
  105. of tangle comments. Use `org-babel-tangle-comment-format-beg'
  106. and `org-babel-tangle-comment-format-end' to customize the format
  107. of tangled comments."
  108. :group 'org-babel
  109. :type 'boolean)
  110. (defcustom org-babel-process-comment-text 'org-remove-indentation
  111. "Function called to process raw Org text collected to be
  112. inserted as comments in tangled source-code files. The function
  113. should take a single string argument and return a string
  114. result. The default value is `org-remove-indentation'."
  115. :group 'org-babel
  116. :version "24.1"
  117. :type 'function)
  118. (defcustom org-babel-tangle-default-file-mode #o544
  119. "The default mode used for tangled files, as an integer.
  120. The default value 356 correspands to the octal #o544, which is
  121. read-write permissions for the user, read-only for everyone else."
  122. :group 'org-babel
  123. :package-version '(Org . "9.6")
  124. :type 'integer)
  125. (defun org-babel-find-file-noselect-refresh (file)
  126. "Find file ensuring that the latest changes on disk are
  127. represented in the file."
  128. (find-file-noselect file 'nowarn)
  129. (with-current-buffer (get-file-buffer file)
  130. (revert-buffer t t t)))
  131. (defmacro org-babel-with-temp-filebuffer (file &rest body)
  132. "Open FILE into a temporary buffer execute BODY there like
  133. `progn', then kill the FILE buffer returning the result of
  134. evaluating BODY."
  135. (declare (indent 1) (debug t))
  136. (let ((temp-path (make-symbol "temp-path"))
  137. (temp-result (make-symbol "temp-result"))
  138. (temp-file (make-symbol "temp-file"))
  139. (visited-p (make-symbol "visited-p")))
  140. `(let* ((,temp-path ,file)
  141. (,visited-p (get-file-buffer ,temp-path))
  142. ,temp-result ,temp-file)
  143. (org-babel-find-file-noselect-refresh ,temp-path)
  144. (setf ,temp-file (get-file-buffer ,temp-path))
  145. (with-current-buffer ,temp-file
  146. (setf ,temp-result (progn ,@body)))
  147. (unless ,visited-p (kill-buffer ,temp-file))
  148. ,temp-result)))
  149. ;;;###autoload
  150. (defun org-babel-tangle-file (file &optional target-file lang-re)
  151. "Extract the bodies of source code blocks in FILE.
  152. Source code blocks are extracted with `org-babel-tangle'.
  153. Optional argument TARGET-FILE can be used to specify a default
  154. export file for all source blocks.
  155. Optional argument LANG-RE can be used to limit the exported
  156. source code blocks by languages matching a regular expression.
  157. Return a list whose CAR is the tangled file name."
  158. (interactive "fFile to tangle: \nP")
  159. (let* ((visited (find-buffer-visiting file))
  160. (buffer (or visited (find-file-noselect file))))
  161. (prog1
  162. (with-current-buffer buffer
  163. (org-with-wide-buffer
  164. (mapcar #'expand-file-name
  165. (org-babel-tangle nil target-file lang-re))))
  166. (unless visited (kill-buffer buffer)))))
  167. (defun org-babel-tangle-publish (_ filename pub-dir)
  168. "Tangle FILENAME and place the results in PUB-DIR."
  169. (unless (file-exists-p pub-dir)
  170. (make-directory pub-dir t))
  171. (setq pub-dir (file-name-as-directory pub-dir))
  172. (mapc (lambda (el) (copy-file el pub-dir t)) (org-babel-tangle-file filename)))
  173. ;;;###autoload
  174. (defun org-babel-tangle (&optional arg target-file lang-re)
  175. "Write code blocks to source-specific files.
  176. Extract the bodies of all source code blocks from the current
  177. file into their own source-specific files.
  178. With one universal prefix argument, only tangle the block at point.
  179. When two universal prefix arguments, only tangle blocks for the
  180. tangle file of the block at point.
  181. Optional argument TARGET-FILE can be used to specify a default
  182. export file for all source blocks. Optional argument LANG-RE can
  183. be used to limit the exported source code blocks by languages
  184. matching a regular expression."
  185. (interactive "P")
  186. (run-hooks 'org-babel-pre-tangle-hook)
  187. ;; Possibly Restrict the buffer to the current code block
  188. (save-restriction
  189. (save-excursion
  190. (when (equal arg '(4))
  191. (let ((head (org-babel-where-is-src-block-head)))
  192. (if head
  193. (goto-char head)
  194. (user-error "Point is not in a source code block"))))
  195. (let ((block-counter 0)
  196. (org-babel-default-header-args
  197. (if target-file
  198. (org-babel-merge-params org-babel-default-header-args
  199. (list (cons :tangle target-file)))
  200. org-babel-default-header-args))
  201. (tangle-file
  202. (when (equal arg '(16))
  203. (or (cdr (assq :tangle (nth 2 (org-babel-get-src-block-info 'light))))
  204. (user-error "Point is not in a source code block"))))
  205. path-collector)
  206. (mapc ;; map over file-names
  207. (lambda (by-fn)
  208. (let ((file-name (car by-fn)))
  209. (when file-name
  210. (let ((lspecs (cdr by-fn))
  211. (fnd (file-name-directory file-name))
  212. modes make-dir she-banged lang)
  213. ;; drop source-blocks to file
  214. ;; We avoid append-to-file as it does not work with tramp.
  215. (with-temp-buffer
  216. (mapc
  217. (lambda (lspec)
  218. (let* ((block-lang (car lspec))
  219. (spec (cdr lspec))
  220. (get-spec (lambda (name) (cdr (assq name (nth 4 spec)))))
  221. (she-bang (let ((sheb (funcall get-spec :shebang)))
  222. (when (> (length sheb) 0) sheb)))
  223. (tangle-mode (funcall get-spec :tangle-mode)))
  224. (unless (string-equal block-lang lang)
  225. (setq lang block-lang)
  226. (let ((lang-f (org-src-get-lang-mode lang)))
  227. (when (fboundp lang-f) (ignore-errors (funcall lang-f)))))
  228. ;; if file contains she-bangs, then make it executable
  229. (when she-bang
  230. (unless tangle-mode (setq tangle-mode #o755)))
  231. (when tangle-mode
  232. (add-to-list 'modes (org-babel-interpret-file-mode tangle-mode)))
  233. ;; Possibly create the parent directories for file.
  234. (let ((m (funcall get-spec :mkdirp)))
  235. (and m fnd (not (string= m "no"))
  236. (setq make-dir t)))
  237. ;; Handle :padlines unless first line in file
  238. (unless (or (string= "no" (funcall get-spec :padline))
  239. (= (point) (point-min)))
  240. (insert "\n"))
  241. (when (and she-bang (not she-banged))
  242. (insert (concat she-bang "\n"))
  243. (setq she-banged t))
  244. (org-babel-spec-to-string spec)
  245. (setq block-counter (+ 1 block-counter))))
  246. lspecs)
  247. (when make-dir
  248. (make-directory fnd 'parents))
  249. ;; erase previous file
  250. (when (file-exists-p file-name)
  251. (delete-file file-name))
  252. (write-region nil nil file-name)
  253. (mapc (lambda (mode) (set-file-modes file-name mode)) modes)
  254. (push file-name path-collector))))))
  255. (if (equal arg '(4))
  256. (org-babel-tangle-single-block 1 t)
  257. (org-babel-tangle-collect-blocks lang-re tangle-file)))
  258. (message "Tangled %d code block%s from %s" block-counter
  259. (if (= block-counter 1) "" "s")
  260. (file-name-nondirectory
  261. (buffer-file-name
  262. (or (buffer-base-buffer)
  263. (current-buffer)
  264. (and (org-src-edit-buffer-p)
  265. (org-src-source-buffer))))))
  266. ;; run `org-babel-post-tangle-hook' in all tangled files
  267. (when org-babel-post-tangle-hook
  268. (mapc
  269. (lambda (file)
  270. (org-babel-with-temp-filebuffer file
  271. (run-hooks 'org-babel-post-tangle-hook)))
  272. path-collector))
  273. path-collector))))
  274. (defun org-babel-interpret-file-mode (mode)
  275. "Determine the integer representation of a file MODE specification.
  276. The following forms are currently recognised:
  277. - an integer (returned without modification)
  278. - \"o755\" (chmod style octal)
  279. - \"rwxrw-r--\" (ls style specification)
  280. - \"a=rw,u+x\" (chmod style) *
  281. * The interpretation of these forms relies on `file-modes-symbolic-to-number',
  282. and uses `org-babel-tangle-default-file-mode' as the base mode."
  283. (cond
  284. ((integerp mode)
  285. (if (string-match-p "^[0-7][0-7][0-7]$" (format "%o" mode))
  286. mode
  287. (user-error "%1$o is not a valid file mode octal. \
  288. Did you give the decimal value %1$d by mistake?" mode)))
  289. ((not (stringp mode))
  290. (error "File mode %S not recognised as a valid format." mode))
  291. ((string-match-p "^o0?[0-7][0-7][0-7]$" mode)
  292. (string-to-number (replace-regexp-in-string "^o" "" mode) 8))
  293. ((string-match-p "^[ugoa]*\\(?:[+-=][rwxXstugo]*\\)+\\(,[ugoa]*\\(?:[+-=][rwxXstugo]*\\)+\\)*$" mode)
  294. ;; Match regexp taken from `file-modes-symbolic-to-number'.
  295. (file-modes-symbolic-to-number mode org-babel-tangle-default-file-mode))
  296. ((string-match-p "^[r-][w-][xs-][r-][w-][xs-][r-][w-][x-]$" mode)
  297. (file-modes-symbolic-to-number (concat "u=" (substring mode 0 3)
  298. ",g=" (substring mode 3 6)
  299. ",o=" (substring mode 6 9))
  300. 0))
  301. (t (error "File mode %S not recognised as a valid format. See `org-babel-interpret-file-mode'." mode))))
  302. (defun org-babel-tangle-clean ()
  303. "Remove comments inserted by `org-babel-tangle'.
  304. Call this function inside of a source-code file generated by
  305. `org-babel-tangle' to remove all comments inserted automatically
  306. by `org-babel-tangle'. Warning, this comment removes any lines
  307. containing constructs which resemble Org file links or noweb
  308. references."
  309. (interactive)
  310. (goto-char (point-min))
  311. (while (or (re-search-forward "\\[\\[file:.*\\]\\[.*\\]\\]" nil t)
  312. (re-search-forward (org-babel-noweb-wrap) nil t))
  313. (delete-region (save-excursion (beginning-of-line 1) (point))
  314. (save-excursion (end-of-line 1) (forward-char 1) (point)))))
  315. (defun org-babel-spec-to-string (spec)
  316. "Insert SPEC into the current file.
  317. Insert the source-code specified by SPEC into the current source
  318. code file. This function uses `comment-region' which assumes
  319. that the appropriate major-mode is set. SPEC has the form:
  320. (start-line file link source-name params body comment)"
  321. (pcase-let*
  322. ((`(,start ,file ,link ,source ,info ,body ,comment) spec)
  323. (comments (cdr (assq :comments info)))
  324. (link? (or (string= comments "both") (string= comments "link")
  325. (string= comments "yes") (string= comments "noweb")))
  326. (link-data `(("start-line" . ,(number-to-string start))
  327. ("file" . ,file)
  328. ("link" . ,link)
  329. ("source-name" . ,source)))
  330. (insert-comment (lambda (text)
  331. (when (and comments
  332. (not (string= comments "no"))
  333. (org-string-nw-p text))
  334. (if org-babel-tangle-uncomment-comments
  335. ;; Plain comments: no processing.
  336. (insert text)
  337. ;; Ensure comments are made to be
  338. ;; comments, and add a trailing newline.
  339. ;; Also ignore invisible characters when
  340. ;; commenting.
  341. (comment-region
  342. (point)
  343. (progn (insert (org-no-properties text))
  344. (point)))
  345. (end-of-line)
  346. (insert "\n"))))))
  347. (when comment (funcall insert-comment comment))
  348. (when link?
  349. (funcall insert-comment
  350. (org-fill-template
  351. org-babel-tangle-comment-format-beg link-data)))
  352. (insert body "\n")
  353. (when link?
  354. (funcall insert-comment
  355. (org-fill-template
  356. org-babel-tangle-comment-format-end link-data)))))
  357. (defun org-babel-effective-tangled-filename (buffer-fn src-lang src-tfile)
  358. "Return effective tangled filename of a source-code block.
  359. BUFFER-FN is the name of the buffer, SRC-LANG the language of the
  360. block and SRC-TFILE is the value of the :tangle header argument,
  361. as computed by `org-babel-tangle-single-block'."
  362. (let ((base-name (cond
  363. ((string= "yes" src-tfile)
  364. ;; Use the buffer name
  365. (file-name-sans-extension buffer-fn))
  366. ((string= "no" src-tfile) nil)
  367. ((> (length src-tfile) 0) src-tfile)))
  368. (ext (or (cdr (assoc src-lang org-babel-tangle-lang-exts)) src-lang)))
  369. (when base-name
  370. ;; decide if we want to add ext to base-name
  371. (if (and ext (string= "yes" src-tfile))
  372. (concat base-name "." ext) base-name))))
  373. (defun org-babel-tangle-collect-blocks (&optional lang-re tangle-file)
  374. "Collect source blocks in the current Org file.
  375. Return an association list of language and source-code block
  376. specifications of the form used by `org-babel-spec-to-string'
  377. grouped by tangled file name.
  378. Optional argument LANG-RE can be used to limit the collected
  379. source code blocks by languages matching a regular expression.
  380. Optional argument TANGLE-FILE can be used to limit the collected
  381. code blocks by target file."
  382. (let ((counter 0) last-heading-pos blocks)
  383. (org-babel-map-src-blocks (buffer-file-name)
  384. (let ((current-heading-pos
  385. (org-with-wide-buffer
  386. (org-with-limited-levels (outline-previous-heading)))))
  387. (if (eq last-heading-pos current-heading-pos) (cl-incf counter)
  388. (setq counter 1)
  389. (setq last-heading-pos current-heading-pos)))
  390. (unless (or (org-in-commented-heading-p)
  391. (org-in-archived-heading-p))
  392. (let* ((info (org-babel-get-src-block-info 'light))
  393. (src-lang (nth 0 info))
  394. (src-tfile (cdr (assq :tangle (nth 2 info)))))
  395. (unless (or (string= src-tfile "no")
  396. (and tangle-file (not (equal tangle-file src-tfile)))
  397. (and lang-re (not (string-match-p lang-re src-lang))))
  398. ;; Add the spec for this block to blocks under its tangled
  399. ;; file name.
  400. (let* ((block (org-babel-tangle-single-block counter))
  401. (src-tfile (cdr (assq :tangle (nth 4 block))))
  402. (file-name (org-babel-effective-tangled-filename
  403. (nth 1 block) src-lang src-tfile))
  404. (by-fn (assoc file-name blocks)))
  405. (if by-fn (setcdr by-fn (cons (cons src-lang block) (cdr by-fn)))
  406. (push (cons file-name (list (cons src-lang block))) blocks)))))))
  407. ;; Ensure blocks are in the correct order.
  408. (mapcar (lambda (b) (cons (car b) (nreverse (cdr b))))
  409. (nreverse blocks))))
  410. (defun org-babel-tangle-single-block (block-counter &optional only-this-block)
  411. "Collect the tangled source for current block.
  412. Return the list of block attributes needed by
  413. `org-babel-tangle-collect-blocks'. When ONLY-THIS-BLOCK is
  414. non-nil, return the full association list to be used by
  415. `org-babel-tangle' directly."
  416. (let* ((info (org-babel-get-src-block-info))
  417. (start-line
  418. (save-restriction (widen)
  419. (+ 1 (line-number-at-pos (point)))))
  420. (file (buffer-file-name (buffer-base-buffer)))
  421. (src-lang (nth 0 info))
  422. (params (nth 2 info))
  423. (extra (nth 3 info))
  424. (coderef (nth 6 info))
  425. (cref-regexp (org-src-coderef-regexp coderef))
  426. (link (let* (
  427. ;; The created link is transient. Using ID is
  428. ;; not necessary, but could have side-effects if
  429. ;; used. An ID property may be added to
  430. ;; existing entries thus creatin unexpected file
  431. ;; modifications.
  432. (org-id-link-to-org-use-id nil)
  433. (l (org-no-properties (org-store-link nil))))
  434. (and (string-match org-link-bracket-re l)
  435. (match-string 1 l))))
  436. (source-name
  437. (or (nth 4 info)
  438. (format "%s:%d"
  439. (or (ignore-errors (nth 4 (org-heading-components)))
  440. "No heading")
  441. block-counter)))
  442. (expand-cmd (intern (concat "org-babel-expand-body:" src-lang)))
  443. (assignments-cmd
  444. (intern (concat "org-babel-variable-assignments:" src-lang)))
  445. (body
  446. ;; Run the tangle-body-hook.
  447. (let ((body (if (org-babel-noweb-p params :tangle)
  448. (org-babel-expand-noweb-references info)
  449. (nth 1 info))))
  450. (with-temp-buffer
  451. (insert
  452. ;; Expand body in language specific manner.
  453. (cond ((assq :no-expand params) body)
  454. ((fboundp expand-cmd) (funcall expand-cmd body params))
  455. (t
  456. (org-babel-expand-body:generic
  457. body params (and (fboundp assignments-cmd)
  458. (funcall assignments-cmd params))))))
  459. (when (string-match "-r" extra)
  460. (goto-char (point-min))
  461. (while (re-search-forward cref-regexp nil t)
  462. (replace-match "")))
  463. (run-hooks 'org-babel-tangle-body-hook)
  464. (buffer-string))))
  465. (comment
  466. (when (or (string= "both" (cdr (assq :comments params)))
  467. (string= "org" (cdr (assq :comments params))))
  468. ;; From the previous heading or code-block end
  469. (funcall
  470. org-babel-process-comment-text
  471. (buffer-substring
  472. (max (condition-case nil
  473. (save-excursion
  474. (org-back-to-heading t) ; Sets match data
  475. (match-end 0))
  476. (error (point-min)))
  477. (save-excursion
  478. (if (re-search-backward
  479. org-babel-src-block-regexp nil t)
  480. (match-end 0)
  481. (point-min))))
  482. (point)))))
  483. (result
  484. (list start-line
  485. (if org-babel-tangle-use-relative-file-links
  486. (file-relative-name file)
  487. file)
  488. (if (and org-babel-tangle-use-relative-file-links
  489. (string-match org-link-types-re link)
  490. (string= (match-string 1 link) "file"))
  491. (concat "file:"
  492. (file-relative-name (substring link (match-end 0))
  493. (file-name-directory
  494. (cdr (assq :tangle params)))))
  495. link)
  496. source-name
  497. params
  498. (if org-src-preserve-indentation
  499. (org-trim body t)
  500. (org-trim (org-remove-indentation body)))
  501. comment)))
  502. (if only-this-block
  503. (let* ((src-tfile (cdr (assq :tangle (nth 4 result))))
  504. (file-name (org-babel-effective-tangled-filename
  505. (nth 1 result) src-lang src-tfile)))
  506. (list (cons file-name (list (cons src-lang result)))))
  507. result)))
  508. (defun org-babel-tangle-comment-links (&optional info)
  509. "Return a list of begin and end link comments for the code block at point.
  510. INFO, when non nil, is the source block information, as returned
  511. by `org-babel-get-src-block-info'."
  512. (let ((link-data (pcase (or info (org-babel-get-src-block-info 'light))
  513. (`(,_ ,_ ,_ ,_ ,name ,start ,_)
  514. `(("start-line" . ,(org-with-point-at start
  515. (number-to-string
  516. (line-number-at-pos))))
  517. ("file" . ,(buffer-file-name))
  518. ("link" . ,(let (;; The created link is transient. Using ID is
  519. ;; not necessary, but could have side-effects if
  520. ;; used. An ID property may be added to
  521. ;; existing entries thus creatin unexpected file
  522. ;; modifications.
  523. (org-id-link-to-org-use-id nil))
  524. (org-no-properties (org-store-link nil))))
  525. ("source-name" . ,name))))))
  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))))
  528. ;; de-tangling functions
  529. (defun org-babel-detangle (&optional source-code-file)
  530. "Propagate changes in source file back original to Org file.
  531. This requires that code blocks were tangled with link comments
  532. which enable the original code blocks to be found."
  533. (interactive)
  534. (save-excursion
  535. (when source-code-file (find-file source-code-file))
  536. (goto-char (point-min))
  537. (let ((counter 0) new-body end)
  538. (while (re-search-forward org-link-bracket-re nil t)
  539. (if (and (match-string 2)
  540. (re-search-forward
  541. (concat " " (regexp-quote (match-string 2)) " ends here") nil t))
  542. (progn (setq end (match-end 0))
  543. (forward-line -1)
  544. (save-excursion
  545. (when (setq new-body (org-babel-tangle-jump-to-org))
  546. (org-babel-update-block-body new-body)))
  547. (setq counter (+ 1 counter)))
  548. (setq end (point)))
  549. (goto-char end))
  550. (prog1 counter (message "Detangled %d code blocks" counter)))))
  551. (defun org-babel-tangle-jump-to-org ()
  552. "Jump from a tangled code file to the related Org mode file."
  553. (interactive)
  554. (let ((mid (point))
  555. start body-start end target-buffer target-char link block-name body)
  556. (save-window-excursion
  557. (save-excursion
  558. (while (and (re-search-backward org-link-bracket-re nil t)
  559. (not ; ever wider searches until matching block comments
  560. (and (setq start (line-beginning-position))
  561. (setq body-start (line-beginning-position 2))
  562. (setq link (match-string 0))
  563. (setq block-name (match-string 2))
  564. (save-excursion
  565. (save-match-data
  566. (re-search-forward
  567. (concat " " (regexp-quote block-name)
  568. " ends here")
  569. nil t)
  570. (setq end (line-beginning-position))))))))
  571. (unless (and start (< start mid) (< mid end))
  572. (error "Not in tangled code"))
  573. (setq body (buffer-substring body-start end)))
  574. ;; Go to the beginning of the relative block in Org file.
  575. (org-link-open-from-string link)
  576. (setq target-buffer (current-buffer))
  577. (if (string-match "[^ \t\n\r]:\\([[:digit:]]+\\)" block-name)
  578. (let ((n (string-to-number (match-string 1 block-name))))
  579. (if (org-before-first-heading-p) (goto-char (point-min))
  580. (org-back-to-heading t))
  581. ;; Do not skip the first block if it begins at point min.
  582. (cond ((or (org-at-heading-p)
  583. (not (eq (org-element-type (org-element-at-point))
  584. 'src-block)))
  585. (org-babel-next-src-block n))
  586. ((= n 1))
  587. (t (org-babel-next-src-block (1- n)))))
  588. (org-babel-goto-named-src-block block-name))
  589. (goto-char (org-babel-where-is-src-block-head))
  590. (forward-line 1)
  591. ;; Try to preserve location of point within the source code in
  592. ;; tangled code file.
  593. (let ((offset (- mid body-start)))
  594. (when (> end (+ offset (point)))
  595. (forward-char offset)))
  596. (setq target-char (point)))
  597. (org-src-switch-to-buffer target-buffer t)
  598. (goto-char target-char)
  599. body))
  600. (provide 'ob-tangle)
  601. ;; Local variables:
  602. ;; generated-autoload-file: "org-loaddefs.el"
  603. ;; End:
  604. ;;; ob-tangle.el ends here