2010-06-25 12:20:39 -04:00
|
|
|
;;; ob-tangle.el --- extract source code from org-mode files
|
2009-06-14 21:30:29 -04:00
|
|
|
|
2010-06-25 12:20:39 -04:00
|
|
|
;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
|
2009-06-14 21:30:29 -04:00
|
|
|
|
2009-10-29 19:03:43 -04:00
|
|
|
;; Author: Eric Schulte
|
2009-06-14 21:30:29 -04:00
|
|
|
;; Keywords: literate programming, reproducible research
|
|
|
|
;; Homepage: http://orgmode.org
|
2011-03-07 09:27:39 -05:00
|
|
|
;; Version: 7.5
|
2009-06-14 21:30:29 -04:00
|
|
|
|
2010-06-25 12:20:39 -04:00
|
|
|
;; This file is part of GNU Emacs.
|
2009-06-14 21:30:29 -04:00
|
|
|
|
2010-06-25 12:20:39 -04:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2009-06-14 21:30:29 -04:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2010-06-25 12:20:39 -04:00
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
2009-06-14 21:30:29 -04:00
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
;; GNU General Public License for more details.
|
2010-06-25 12:20:39 -04:00
|
|
|
|
2009-06-14 21:30:29 -04:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2010-06-25 12:20:39 -04:00
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
2009-06-14 21:30:29 -04:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Extract the code from source blocks out into raw source-code files.
|
|
|
|
|
|
|
|
;;; Code:
|
2010-06-11 19:02:42 -04:00
|
|
|
(require 'ob)
|
2010-06-23 14:24:33 -04:00
|
|
|
(require 'org-src)
|
2010-06-12 21:32:23 -04:00
|
|
|
(eval-when-compile
|
|
|
|
(require 'cl))
|
2009-06-14 21:30:29 -04:00
|
|
|
|
2010-06-23 14:24:33 -04:00
|
|
|
(declare-function org-link-escape "org" (text &optional table))
|
2010-07-12 19:48:05 -04:00
|
|
|
(declare-function org-heading-components "org" ())
|
2010-09-04 10:39:19 -04:00
|
|
|
(declare-function org-back-to-heading "org" (invisible-ok))
|
2010-09-05 17:12:43 -04:00
|
|
|
(declare-function org-fill-template "org" (template alist))
|
2010-10-29 03:49:47 -04:00
|
|
|
(declare-function org-babel-update-block-body "org" (new-body))
|
2011-01-19 22:29:09 -05:00
|
|
|
(declare-function make-directory "files" (dir &optional parents))
|
2010-06-23 14:24:33 -04:00
|
|
|
|
2010-09-08 13:33:24 -04:00
|
|
|
;;;###autoload
|
2010-06-17 12:01:24 -04:00
|
|
|
(defcustom org-babel-tangle-lang-exts
|
|
|
|
'(("emacs-lisp" . "el"))
|
|
|
|
"Alist mapping languages to their file extensions.
|
|
|
|
The key is the language name, the value is the string that should
|
|
|
|
be inserted as the extension commonly used to identify files
|
|
|
|
written in this language. If no entry is found in this list,
|
|
|
|
then the name of the language is used."
|
|
|
|
:group 'org-babel-tangle
|
|
|
|
:type '(repeat
|
|
|
|
(cons
|
|
|
|
(string "Language name")
|
|
|
|
(string "File Extension"))))
|
2010-05-27 18:32:10 -04:00
|
|
|
|
2010-07-08 14:53:51 -04:00
|
|
|
(defcustom org-babel-post-tangle-hook nil
|
|
|
|
"Hook run in code files tangled by `org-babel-tangle'."
|
|
|
|
:group 'org-babel
|
|
|
|
:type 'hook)
|
|
|
|
|
2010-09-03 09:51:13 -04:00
|
|
|
(defcustom org-babel-pre-tangle-hook '(save-buffer)
|
|
|
|
"Hook run at the beginning of `org-babel-tangle'."
|
|
|
|
:group 'org-babel
|
|
|
|
:type 'hook)
|
|
|
|
|
2011-03-14 11:31:33 -04:00
|
|
|
(defcustom org-babel-tangle-body-hook nil
|
|
|
|
"Hook run over the contents of each code block body."
|
|
|
|
:group 'org-babel
|
|
|
|
:type 'hook)
|
|
|
|
|
2010-10-29 03:37:28 -04:00
|
|
|
(defcustom org-babel-tangle-comment-format-beg "[[%link][%source-name]]"
|
2010-09-05 17:12:43 -04:00
|
|
|
"Format of inserted comments in tangled code files.
|
|
|
|
The following format strings can be used to insert special
|
|
|
|
information into the output using `org-fill-template'.
|
|
|
|
%start-line --- the line number at the start of the code block
|
|
|
|
%file --------- the file from which the code block was tangled
|
|
|
|
%link --------- Org-mode style link to the code block
|
2010-10-17 13:18:20 -04:00
|
|
|
%source-name -- name of the code block
|
|
|
|
|
|
|
|
Whether or not comments are inserted during tangling is
|
|
|
|
controlled by the :comments header argument."
|
2010-09-05 17:12:43 -04:00
|
|
|
:group 'org-babel
|
|
|
|
:type 'string)
|
|
|
|
|
2010-10-29 03:37:28 -04:00
|
|
|
(defcustom org-babel-tangle-comment-format-end "%source-name ends here"
|
2010-09-05 17:12:43 -04:00
|
|
|
"Format of inserted comments in tangled code files.
|
|
|
|
The following format strings can be used to insert special
|
|
|
|
information into the output using `org-fill-template'.
|
|
|
|
%start-line --- the line number at the start of the code block
|
|
|
|
%file --------- the file from which the code block was tangled
|
|
|
|
%link --------- Org-mode style link to the code block
|
2010-10-17 13:18:20 -04:00
|
|
|
%source-name -- name of the code block
|
|
|
|
|
|
|
|
Whether or not comments are inserted during tangling is
|
|
|
|
controlled by the :comments header argument."
|
2010-09-05 17:12:43 -04:00
|
|
|
:group 'org-babel
|
|
|
|
:type 'string)
|
|
|
|
|
2011-06-15 23:18:22 -04:00
|
|
|
(defcustom org-babel-tangle-do-combine-named-blocks nil
|
2011-06-10 14:17:02 -04:00
|
|
|
"Combine blocks of the same name during tangling."
|
|
|
|
:group 'org-babel
|
2011-06-15 23:18:22 -04:00
|
|
|
:type 'bool)
|
2011-06-10 14:17:02 -04:00
|
|
|
|
2010-07-28 09:34:08 -04:00
|
|
|
(defun org-babel-find-file-noselect-refresh (file)
|
|
|
|
"Find file ensuring that the latest changes on disk are
|
|
|
|
represented in the file."
|
|
|
|
(find-file-noselect file)
|
|
|
|
(with-current-buffer (get-file-buffer file)
|
|
|
|
(revert-buffer t t t)))
|
|
|
|
|
2010-07-16 18:55:40 -04:00
|
|
|
(defmacro org-babel-with-temp-filebuffer (file &rest body)
|
|
|
|
"Open FILE into a temporary buffer execute BODY there like
|
|
|
|
`progn', then kill the FILE buffer returning the result of
|
|
|
|
evaluating BODY."
|
|
|
|
(declare (indent 1))
|
|
|
|
(let ((temp-result (make-symbol "temp-result"))
|
2010-07-28 09:34:08 -04:00
|
|
|
(temp-file (make-symbol "temp-file"))
|
2010-07-28 20:45:34 -04:00
|
|
|
(visited-p (make-symbol "visited-p")))
|
|
|
|
`(let (,temp-result ,temp-file
|
|
|
|
(,visited-p (get-file-buffer ,file)))
|
2010-07-28 09:34:08 -04:00
|
|
|
(org-babel-find-file-noselect-refresh ,file)
|
|
|
|
(setf ,temp-file (get-file-buffer ,file))
|
|
|
|
(with-current-buffer ,temp-file
|
|
|
|
(setf ,temp-result (progn ,@body)))
|
|
|
|
(unless ,visited-p (kill-buffer ,temp-file))
|
2010-07-16 18:55:40 -04:00
|
|
|
,temp-result)))
|
|
|
|
|
2010-06-23 14:24:33 -04:00
|
|
|
;;;###autoload
|
2009-07-14 21:29:28 -04:00
|
|
|
(defun org-babel-load-file (file)
|
2010-07-13 19:20:08 -04:00
|
|
|
"Load Emacs Lisp source code blocks in the Org-mode FILE.
|
|
|
|
This function exports the source code using
|
|
|
|
`org-babel-tangle' and then loads the resulting file using
|
|
|
|
`load-file'."
|
2010-11-17 15:04:10 -05:00
|
|
|
(interactive "fFile to load: ")
|
2009-07-14 23:16:51 -04:00
|
|
|
(flet ((age (file)
|
2010-06-12 21:50:05 -04:00
|
|
|
(float-time
|
2009-07-14 23:16:51 -04:00
|
|
|
(time-subtract (current-time)
|
2010-06-12 21:26:08 -04:00
|
|
|
(nth 5 (or (file-attributes (file-truename file))
|
2010-02-08 15:17:06 -05:00
|
|
|
(file-attributes file)))))))
|
2009-07-30 10:57:26 -04:00
|
|
|
(let* ((base-name (file-name-sans-extension file))
|
|
|
|
(exported-file (concat base-name ".el")))
|
|
|
|
;; tangle if the org-mode file is newer than the elisp file
|
2010-06-02 08:52:30 -04:00
|
|
|
(unless (and (file-exists-p exported-file)
|
|
|
|
(> (age file) (age exported-file)))
|
2010-03-18 14:30:54 -04:00
|
|
|
(org-babel-tangle-file file exported-file "emacs-lisp"))
|
2009-07-30 10:57:26 -04:00
|
|
|
(load-file exported-file)
|
|
|
|
(message "loaded %s" exported-file))))
|
|
|
|
|
2010-06-23 14:24:33 -04:00
|
|
|
;;;###autoload
|
2009-07-30 10:57:26 -04:00
|
|
|
(defun org-babel-tangle-file (file &optional target-file lang)
|
2010-07-13 19:20:08 -04:00
|
|
|
"Extract the bodies of source code blocks in FILE.
|
|
|
|
Source code blocks are extracted with `org-babel-tangle'.
|
|
|
|
Optional argument TARGET-FILE can be used to specify a default
|
|
|
|
export file for all source blocks. Optional argument LANG can be
|
|
|
|
used to limit the exported source code blocks by language."
|
2009-10-20 10:17:42 -04:00
|
|
|
(interactive "fFile to tangle: \nP")
|
2010-06-02 09:18:36 -04:00
|
|
|
(let ((visited-p (get-file-buffer (expand-file-name file)))
|
|
|
|
to-be-removed)
|
|
|
|
(save-window-excursion
|
|
|
|
(find-file file)
|
|
|
|
(setq to-be-removed (current-buffer))
|
|
|
|
(org-babel-tangle target-file lang))
|
|
|
|
(unless visited-p
|
|
|
|
(kill-buffer to-be-removed))))
|
2009-07-14 21:26:15 -04:00
|
|
|
|
2010-04-12 01:54:31 -04:00
|
|
|
(defun org-babel-tangle-publish (_ filename pub-dir)
|
|
|
|
"Tangle FILENAME and place the results in PUB-DIR."
|
|
|
|
(mapc (lambda (el) (copy-file el pub-dir t)) (org-babel-tangle-file filename)))
|
|
|
|
|
2010-06-23 14:24:33 -04:00
|
|
|
;;;###autoload
|
2009-07-30 10:57:26 -04:00
|
|
|
(defun org-babel-tangle (&optional target-file lang)
|
2010-07-13 19:20:08 -04:00
|
|
|
"Write code blocks to source-specific files.
|
|
|
|
Extract the bodies of all source code blocks from the current
|
2009-07-14 21:26:15 -04:00
|
|
|
file into their own source-specific files. Optional argument
|
2009-07-30 10:57:26 -04:00
|
|
|
TARGET-FILE can be used to specify a default export file for all
|
|
|
|
source blocks. Optional argument LANG can be used to limit the
|
|
|
|
exported source code blocks by language."
|
2009-06-15 18:35:11 -04:00
|
|
|
(interactive)
|
2010-09-03 09:51:13 -04:00
|
|
|
(run-hooks 'org-babel-pre-tangle-hook)
|
2009-06-27 14:58:13 -04:00
|
|
|
(save-excursion
|
2009-07-30 22:14:35 -04:00
|
|
|
(let ((block-counter 0)
|
2010-07-09 12:43:30 -04:00
|
|
|
(org-babel-default-header-args
|
|
|
|
(if target-file
|
|
|
|
(org-babel-merge-params org-babel-default-header-args
|
|
|
|
(list (cons :tangle target-file)))
|
|
|
|
org-babel-default-header-args))
|
2009-07-14 21:37:47 -04:00
|
|
|
path-collector)
|
2009-07-31 18:53:02 -04:00
|
|
|
(mapc ;; map over all languages
|
2009-06-27 14:58:13 -04:00
|
|
|
(lambda (by-lang)
|
|
|
|
(let* ((lang (car by-lang))
|
2009-07-30 10:57:26 -04:00
|
|
|
(specs (cdr by-lang))
|
2010-06-17 12:01:24 -04:00
|
|
|
(ext (or (cdr (assoc lang org-babel-tangle-lang-exts)) lang))
|
2010-06-02 08:52:30 -04:00
|
|
|
(lang-f (intern
|
|
|
|
(concat
|
|
|
|
(or (and (cdr (assoc lang org-src-lang-modes))
|
|
|
|
(symbol-name
|
|
|
|
(cdr (assoc lang org-src-lang-modes))))
|
|
|
|
lang)
|
|
|
|
"-mode")))
|
2009-11-04 17:18:50 -05:00
|
|
|
she-banged)
|
2009-07-30 10:57:26 -04:00
|
|
|
(mapc
|
|
|
|
(lambda (spec)
|
2010-02-05 21:04:50 -05:00
|
|
|
(flet ((get-spec (name)
|
2010-09-05 17:12:43 -04:00
|
|
|
(cdr (assoc name (nth 4 spec)))))
|
2010-02-05 21:04:50 -05:00
|
|
|
(let* ((tangle (get-spec :tangle))
|
2010-06-17 12:01:24 -04:00
|
|
|
(she-bang ((lambda (sheb) (when (> (length sheb) 0) sheb))
|
|
|
|
(get-spec :shebang)))
|
2010-07-09 12:43:30 -04:00
|
|
|
(base-name (cond
|
|
|
|
((string= "yes" tangle)
|
|
|
|
(file-name-sans-extension
|
|
|
|
(buffer-file-name)))
|
|
|
|
((string= "no" tangle) nil)
|
|
|
|
((> (length tangle) 0) tangle)))
|
2010-02-05 21:04:50 -05:00
|
|
|
(file-name (when base-name
|
2010-02-07 13:36:52 -05:00
|
|
|
;; decide if we want to add ext to base-name
|
2010-03-17 20:09:06 -04:00
|
|
|
(if (and ext (string= "yes" tangle))
|
2010-02-05 21:04:50 -05:00
|
|
|
(concat base-name "." ext) base-name))))
|
|
|
|
(when file-name
|
2011-01-19 22:29:09 -05:00
|
|
|
;; possibly create the parent directories for file
|
|
|
|
(when ((lambda (m) (and m (not (string= m "no"))))
|
|
|
|
(get-spec :mkdirp))
|
|
|
|
(make-directory (file-name-directory file-name) 'parents))
|
2010-02-05 21:04:50 -05:00
|
|
|
;; delete any old versions of file
|
|
|
|
(when (and (file-exists-p file-name)
|
|
|
|
(not (member file-name path-collector)))
|
|
|
|
(delete-file file-name))
|
|
|
|
;; drop source-block to file
|
|
|
|
(with-temp-buffer
|
2010-07-08 14:53:51 -04:00
|
|
|
(when (fboundp lang-f) (funcall lang-f))
|
2010-02-05 21:04:50 -05:00
|
|
|
(when (and she-bang (not (member file-name she-banged)))
|
|
|
|
(insert (concat she-bang "\n"))
|
|
|
|
(setq she-banged (cons file-name she-banged)))
|
|
|
|
(org-babel-spec-to-string spec)
|
2010-03-17 21:03:21 -04:00
|
|
|
;; We avoid append-to-file as it does not work with tramp.
|
|
|
|
(let ((content (buffer-string)))
|
|
|
|
(with-temp-buffer
|
|
|
|
(if (file-exists-p file-name)
|
|
|
|
(insert-file-contents file-name))
|
|
|
|
(goto-char (point-max))
|
|
|
|
(insert content)
|
|
|
|
(write-region nil nil file-name))))
|
2010-05-25 22:01:20 -04:00
|
|
|
;; if files contain she-bangs, then make the executable
|
Use integer syntax for the MODE argument to #'set-file-modes
Hello!
We need this change to get org-mode compiling with recent XEmacs 21.5. On
previous 21.5 and current 21.4, the problem manifests itself at runtime, not
compile time, like so:
(set-file-modes "/tmp/aidan/foo.el" ?\755)
=> Wrong type argument: integerp, ?í
One old reason to go for the ?\755 syntax instead of the #o755 syntax under
GNU Emacs was to be that older versions of GNU Emacs didn’t support #o755,
but, to my knowledge, every released GNU Emacs since March 2000 has
supported the latter syntax.
Best,
Aidan Kehoe, the XEmacs project.
ChangeLog addition:
2010-08-21 Aidan Kehoe <kehoea@parhasard.net>
* ob-tangle.el (org-babel-tangle): Change the MODE argument to
#'set-file-modes to use integer, not character syntax, avoiding
compile problems with recent XEmacs.
2010-08-22 00:17:04 -04:00
|
|
|
(when she-bang (set-file-modes file-name #o755))
|
2010-02-05 21:04:50 -05:00
|
|
|
;; update counter
|
|
|
|
(setq block-counter (+ 1 block-counter))
|
|
|
|
(add-to-list 'path-collector file-name)))))
|
2009-07-30 10:57:26 -04:00
|
|
|
specs)))
|
2011-06-15 23:18:22 -04:00
|
|
|
(funcall (if org-babel-tangle-do-combine-named-blocks
|
|
|
|
#'org-babel-tangle-combine-named-blocks
|
|
|
|
#'identity)
|
2011-06-10 14:17:02 -04:00
|
|
|
(org-babel-tangle-collect-blocks lang)))
|
2010-10-01 01:24:02 -04:00
|
|
|
(message "tangled %d code block%s from %s" block-counter
|
|
|
|
(if (= block-counter 1) "" "s")
|
2011-03-09 10:32:40 -05:00
|
|
|
(file-name-nondirectory
|
|
|
|
(buffer-file-name (or (buffer-base-buffer) (current-buffer)))))
|
2010-07-08 14:53:51 -04:00
|
|
|
;; run `org-babel-post-tangle-hook' in all tangled files
|
|
|
|
(when org-babel-post-tangle-hook
|
|
|
|
(mapc
|
|
|
|
(lambda (file)
|
2010-07-16 18:55:40 -04:00
|
|
|
(org-babel-with-temp-filebuffer file
|
2010-07-08 14:53:51 -04:00
|
|
|
(run-hooks 'org-babel-post-tangle-hook)))
|
|
|
|
path-collector))
|
2009-07-14 21:37:47 -04:00
|
|
|
path-collector)))
|
2009-06-26 14:43:50 -04:00
|
|
|
|
2009-08-20 18:32:57 -04:00
|
|
|
(defun org-babel-tangle-clean ()
|
2010-07-13 19:20:08 -04:00
|
|
|
"Remove comments inserted by `org-babel-tangle'.
|
|
|
|
Call this function inside of a source-code file generated by
|
2009-08-20 18:32:57 -04:00
|
|
|
`org-babel-tangle' to remove all comments inserted automatically
|
|
|
|
by `org-babel-tangle'. Warning, this comment removes any lines
|
|
|
|
containing constructs which resemble org-mode file links or noweb
|
|
|
|
references."
|
|
|
|
(interactive)
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (or (re-search-forward "\\[\\[file:.*\\]\\[.*\\]\\]" nil t)
|
|
|
|
(re-search-forward "<<[^[:space:]]*>>" nil t))
|
Xemacs incompatibilities
Carsten Dominik <carsten.dominik@gmail.com> writes:
> On May 17, 2010, at 4:39 PM, Michael Sperber wrote:
>
>> In particular, fixing the require won't be enough: org-babel-python.el
>> uses `run-python' and interacts with the inferior Python, whereas
>> python-mode.el defines `py-shell'.
>>
>> Should I try to abstract over the differences?
>
> Yes, this would be much appreciated. (I think, Eric or Dan?)
OK, I've attached a patch that makes `org-babel-python' work on XEmacs.
Most of the issues are pure XEmacs issues. Notes:
- XEmacs doesn't have [[:digit:]] - I hope to rectify this in the
future, but it seems there's no downside in this particular case to
replacing by [0-9].
- XEmacs doesn't have `move-end-of-line', but does have `end-of-line'.
I don't understand the intent of having both of these, but the code
seems fine with `end-of-line'.
- It seems there are way too few `require's throughout org-babel. I
don't know if it's OK to add the ones I needed.
- `org-babel-python-evaluate' looked broken as-is: It doesn't use the
`body' argument properly, the result is (I think) processed in the
wrong order and not properly split into lines. I've fixed all these,
but a review is probably in order.
2010-05-24 15:22:50 -04:00
|
|
|
(delete-region (save-excursion (beginning-of-line 1) (point))
|
|
|
|
(save-excursion (end-of-line 1) (forward-char 1) (point)))))
|
2009-08-20 18:32:57 -04:00
|
|
|
|
2010-06-23 14:24:33 -04:00
|
|
|
(defvar org-stored-links)
|
2011-06-14 14:23:56 -04:00
|
|
|
(defvar org-bracket-link-regexp)
|
2010-09-05 21:29:28 -04:00
|
|
|
(defun org-babel-tangle-collect-blocks (&optional language)
|
2010-07-13 19:20:08 -04:00
|
|
|
"Collect source blocks in the current Org-mode file.
|
2009-07-30 10:57:26 -04:00
|
|
|
Return an association list of source-code block specifications of
|
|
|
|
the form used by `org-babel-spec-to-string' grouped by language.
|
2009-07-14 21:26:15 -04:00
|
|
|
Optional argument LANG can be used to limit the collected source
|
|
|
|
code blocks by language."
|
2010-07-12 19:48:05 -04:00
|
|
|
(let ((block-counter 1) (current-heading "") blocks)
|
2010-07-12 00:35:58 -04:00
|
|
|
(org-babel-map-src-blocks (buffer-file-name)
|
2010-07-12 19:48:05 -04:00
|
|
|
((lambda (new-heading)
|
|
|
|
(if (not (string= new-heading current-heading))
|
|
|
|
(progn
|
|
|
|
(setq block-counter 1)
|
|
|
|
(setq current-heading new-heading))
|
|
|
|
(setq block-counter (+ 1 block-counter))))
|
|
|
|
(replace-regexp-in-string "[ \t]" "-"
|
2010-08-03 13:20:48 -04:00
|
|
|
(condition-case nil
|
|
|
|
(nth 4 (org-heading-components))
|
|
|
|
(error (buffer-file-name)))))
|
2010-09-05 17:12:43 -04:00
|
|
|
(let* ((start-line (save-restriction (widen)
|
|
|
|
(+ 1 (line-number-at-pos (point)))))
|
|
|
|
(file (buffer-file-name))
|
2010-10-21 03:35:43 -04:00
|
|
|
(info (org-babel-get-src-block-info 'light))
|
|
|
|
(src-lang (nth 0 info)))
|
2010-10-19 14:55:36 -04:00
|
|
|
(unless (string= (cdr (assoc :tangle (nth 2 info))) "no")
|
2010-09-05 21:29:28 -04:00
|
|
|
(unless (and language (not (string= language src-lang)))
|
2010-10-21 09:00:24 -04:00
|
|
|
(let* ((info (org-babel-get-src-block-info))
|
|
|
|
(params (nth 2 info))
|
2011-04-01 12:34:49 -04:00
|
|
|
(link ((lambda (link)
|
|
|
|
(and (string-match org-bracket-link-regexp link)
|
|
|
|
(match-string 1 link)))
|
|
|
|
(org-babel-clean-text-properties
|
|
|
|
(org-store-link nil))))
|
2010-10-19 14:55:36 -04:00
|
|
|
(source-name
|
|
|
|
(intern (or (nth 4 info)
|
|
|
|
(format "%s:%d"
|
|
|
|
current-heading block-counter))))
|
|
|
|
(expand-cmd
|
|
|
|
(intern (concat "org-babel-expand-body:" src-lang)))
|
|
|
|
(assignments-cmd
|
|
|
|
(intern (concat "org-babel-variable-assignments:" src-lang)))
|
|
|
|
(body
|
2011-03-14 11:31:33 -04:00
|
|
|
((lambda (body) ;; run the tangle-body-hook
|
|
|
|
(with-temp-buffer
|
|
|
|
(insert body)
|
|
|
|
(run-hooks 'org-babel-tangle-body-hook)
|
|
|
|
(buffer-string)))
|
|
|
|
((lambda (body) ;; expand the body in language specific manner
|
|
|
|
(if (assoc :no-expand params)
|
|
|
|
body
|
|
|
|
(if (fboundp expand-cmd)
|
|
|
|
(funcall expand-cmd body params)
|
|
|
|
(org-babel-expand-body:generic
|
|
|
|
body params
|
|
|
|
(and (fboundp assignments-cmd)
|
|
|
|
(funcall assignments-cmd params))))))
|
|
|
|
(if (and (cdr (assoc :noweb params)) ;; expand noweb refs
|
|
|
|
(let ((nowebs (split-string
|
|
|
|
(cdr (assoc :noweb params)))))
|
|
|
|
(or (member "yes" nowebs)
|
|
|
|
(member "tangle" nowebs))))
|
|
|
|
(org-babel-expand-noweb-references info)
|
|
|
|
(nth 1 info)))))
|
2010-10-19 14:55:36 -04:00
|
|
|
(comment
|
|
|
|
(when (or (string= "both" (cdr (assoc :comments params)))
|
|
|
|
(string= "org" (cdr (assoc :comments params))))
|
|
|
|
;; from the previous heading or code-block end
|
|
|
|
(buffer-substring
|
|
|
|
(max (condition-case nil
|
|
|
|
(save-excursion
|
|
|
|
(org-back-to-heading t) (point))
|
|
|
|
(error 0))
|
|
|
|
(save-excursion
|
|
|
|
(re-search-backward
|
|
|
|
org-babel-src-block-regexp nil t)
|
|
|
|
(match-end 0)))
|
|
|
|
(point))))
|
|
|
|
by-lang)
|
|
|
|
;; add the spec for this block to blocks under it's language
|
|
|
|
(setq by-lang (cdr (assoc src-lang blocks)))
|
|
|
|
(setq blocks (delq (assoc src-lang blocks) blocks))
|
|
|
|
(setq blocks (cons
|
|
|
|
(cons src-lang
|
|
|
|
(cons (list start-line file link
|
|
|
|
source-name params body comment)
|
|
|
|
by-lang)) blocks)))))))
|
2009-08-03 13:00:42 -04:00
|
|
|
;; ensure blocks in the correct order
|
|
|
|
(setq blocks
|
2010-06-02 08:52:30 -04:00
|
|
|
(mapcar
|
|
|
|
(lambda (by-lang) (cons (car by-lang) (reverse (cdr by-lang))))
|
|
|
|
blocks))
|
2009-06-27 20:25:01 -04:00
|
|
|
blocks))
|
|
|
|
|
2011-06-10 14:17:02 -04:00
|
|
|
(defun org-babel-tangle-combine-named-blocks (blocks)
|
|
|
|
"Combine blocks of the same name.
|
|
|
|
This function follows noweb behavior of appending blocks of the
|
|
|
|
same name in the order they appear in the file."
|
2011-06-15 23:18:22 -04:00
|
|
|
(let (tangled-names)
|
|
|
|
(mapcar
|
|
|
|
(lambda (by-lang)
|
|
|
|
(cons
|
|
|
|
(car by-lang)
|
|
|
|
(mapcar (lambda (spec)
|
|
|
|
(let ((name (nth 3 spec)))
|
|
|
|
(unless (member name tangled-names)
|
|
|
|
(when name
|
|
|
|
(setf (nth 5 spec)
|
|
|
|
(mapconcat
|
|
|
|
(lambda (el) (nth 5 el))
|
|
|
|
(remove-if (lambda (el) (not (equal name (nth 3 el))))
|
|
|
|
(cdr by-lang))
|
|
|
|
"\n"))
|
|
|
|
(add-to-list 'tangled-names name))
|
|
|
|
spec)))
|
|
|
|
(cdr by-lang))))
|
|
|
|
blocks)))
|
2011-06-10 14:17:02 -04:00
|
|
|
|
2009-06-25 23:17:21 -04:00
|
|
|
(defun org-babel-spec-to-string (spec)
|
2010-07-13 19:20:08 -04:00
|
|
|
"Insert SPEC into the current file.
|
|
|
|
Insert the source-code specified by SPEC into the current
|
2009-06-27 14:58:13 -04:00
|
|
|
source code file. This function uses `comment-region' which
|
|
|
|
assumes that the appropriate major-mode is set. SPEC has the
|
|
|
|
form
|
2009-06-26 15:12:23 -04:00
|
|
|
|
2010-09-05 17:12:43 -04:00
|
|
|
(start-line file link source-name params body comment)"
|
|
|
|
(let* ((start-line (nth 0 spec))
|
|
|
|
(file (nth 1 spec))
|
|
|
|
(link (org-link-escape (nth 2 spec)))
|
|
|
|
(source-name (nth 3 spec))
|
|
|
|
(body (nth 5 spec))
|
|
|
|
(comment (nth 6 spec))
|
|
|
|
(comments (cdr (assoc :comments (nth 4 spec))))
|
2011-03-15 13:11:26 -04:00
|
|
|
(padline (not (string= "no" (cdr (assoc :padline (nth 4 spec))))))
|
2010-09-04 10:39:19 -04:00
|
|
|
(link-p (or (string= comments "both") (string= comments "link")
|
2011-01-16 10:21:16 -05:00
|
|
|
(string= comments "yes") (string= comments "noweb")))
|
2010-09-05 17:12:43 -04:00
|
|
|
(link-data (mapcar (lambda (el)
|
|
|
|
(cons (symbol-name el)
|
|
|
|
((lambda (le)
|
|
|
|
(if (stringp le) le (format "%S" le)))
|
|
|
|
(eval el))))
|
|
|
|
'(start-line file link source-name))))
|
2010-06-14 20:50:28 -04:00
|
|
|
(flet ((insert-comment (text)
|
2010-10-29 03:49:47 -04:00
|
|
|
(let ((text (org-babel-trim text)))
|
2010-09-05 17:12:43 -04:00
|
|
|
(when (and comments (not (string= comments "no"))
|
|
|
|
(> (length text) 0))
|
2011-03-15 13:11:26 -04:00
|
|
|
(when padline (insert "\n"))
|
2010-09-05 17:12:43 -04:00
|
|
|
(comment-region (point) (progn (insert text) (point)))
|
|
|
|
(end-of-line nil) (insert "\n")))))
|
2010-09-04 10:39:19 -04:00
|
|
|
(when comment (insert-comment comment))
|
2010-09-05 17:12:43 -04:00
|
|
|
(when link-p
|
|
|
|
(insert-comment
|
|
|
|
(org-fill-template org-babel-tangle-comment-format-beg link-data)))
|
2011-03-15 13:11:26 -04:00
|
|
|
(when padline (insert "\n"))
|
2010-10-12 10:50:00 -04:00
|
|
|
(insert
|
|
|
|
(format
|
|
|
|
"%s\n"
|
|
|
|
(replace-regexp-in-string
|
|
|
|
"^," ""
|
|
|
|
(org-babel-trim body (if org-src-preserve-indentation "[\f\n\r\v]")))))
|
2010-09-05 17:12:43 -04:00
|
|
|
(when link-p
|
|
|
|
(insert-comment
|
|
|
|
(org-fill-template org-babel-tangle-comment-format-end link-data))))))
|
2009-06-15 18:35:11 -04:00
|
|
|
|
2011-01-16 10:21:16 -05:00
|
|
|
(defun org-babel-tangle-comment-links ( &optional info)
|
|
|
|
"Return a list of begin and end link comments for the code block at point."
|
|
|
|
(let* ((start-line (org-babel-where-is-src-block-head))
|
|
|
|
(file (buffer-file-name))
|
|
|
|
(link (org-link-escape (progn (call-interactively 'org-store-link)
|
|
|
|
(org-babel-clean-text-properties
|
|
|
|
(car (pop org-stored-links))))))
|
|
|
|
(source-name (nth 4 (or info (org-babel-get-src-block-info 'light))))
|
|
|
|
(link-data (mapcar (lambda (el)
|
|
|
|
(cons (symbol-name el)
|
|
|
|
((lambda (le)
|
|
|
|
(if (stringp le) le (format "%S" le)))
|
|
|
|
(eval el))))
|
|
|
|
'(start-line file link source-name))))
|
|
|
|
(list (org-fill-template org-babel-tangle-comment-format-beg link-data)
|
|
|
|
(org-fill-template org-babel-tangle-comment-format-end link-data))))
|
|
|
|
|
|
|
|
;; de-tangling functions
|
2010-10-29 03:49:47 -04:00
|
|
|
(defvar org-bracket-link-analytic-regexp)
|
|
|
|
(defun org-babel-detangle (&optional source-code-file)
|
|
|
|
"Propagate changes in source file back original to Org-mode file.
|
|
|
|
This requires that code blocks were tangled with link comments
|
|
|
|
which enable the original code blocks to be found."
|
|
|
|
(interactive)
|
|
|
|
(save-excursion
|
|
|
|
(when source-code-file (find-file source-code-file))
|
|
|
|
(goto-char (point-min))
|
|
|
|
(let ((counter 0) new-body end)
|
|
|
|
(while (re-search-forward org-bracket-link-analytic-regexp nil t)
|
|
|
|
(when (re-search-forward
|
|
|
|
(concat " " (regexp-quote (match-string 5)) " ends here"))
|
|
|
|
(setq end (match-end 0))
|
|
|
|
(forward-line -1)
|
|
|
|
(save-excursion
|
|
|
|
(when (setq new-body (org-babel-tangle-jump-to-org))
|
|
|
|
(org-babel-update-block-body new-body)))
|
|
|
|
(setq counter (+ 1 counter)))
|
|
|
|
(goto-char end))
|
|
|
|
(prog1 counter (message "detangled %d code blocks" counter)))))
|
|
|
|
|
|
|
|
(defun org-babel-tangle-jump-to-org ()
|
|
|
|
"Jump from a tangled code file to the related Org-mode file."
|
|
|
|
(interactive)
|
|
|
|
(let ((mid (point))
|
2011-01-13 16:04:28 -05:00
|
|
|
start end done
|
|
|
|
target-buffer target-char link path block-name body)
|
2010-10-29 03:49:47 -04:00
|
|
|
(save-window-excursion
|
|
|
|
(save-excursion
|
2011-01-13 16:04:28 -05:00
|
|
|
(while (and (re-search-backward org-bracket-link-analytic-regexp nil t)
|
|
|
|
(not ; ever wider searches until matching block comments
|
|
|
|
(and (setq start (point-at-eol))
|
|
|
|
(setq link (match-string 0))
|
|
|
|
(setq path (match-string 3))
|
|
|
|
(setq block-name (match-string 5))
|
|
|
|
(save-excursion
|
|
|
|
(save-match-data
|
|
|
|
(re-search-forward
|
|
|
|
(concat " " (regexp-quote block-name)
|
|
|
|
" ends here") nil t)
|
|
|
|
(setq end (point-at-bol))))))))
|
|
|
|
(unless (and start (< start mid) (< mid end))
|
|
|
|
(error "not in tangled code"))
|
2010-10-29 03:49:47 -04:00
|
|
|
(setq body (org-babel-trim (buffer-substring start end))))
|
|
|
|
(when (string-match "::" path)
|
|
|
|
(setq path (substring path 0 (match-beginning 0))))
|
|
|
|
(find-file path) (setq target-buffer (current-buffer))
|
|
|
|
(goto-char start) (org-open-link-from-string link)
|
|
|
|
(if (string-match "[^ \t\n\r]:\\([[:digit:]]+\\)" block-name)
|
|
|
|
(org-babel-next-src-block
|
|
|
|
(string-to-number (match-string 1 block-name)))
|
|
|
|
(org-babel-goto-named-src-block block-name))
|
|
|
|
(setq target-char (point)))
|
|
|
|
(pop-to-buffer target-buffer)
|
|
|
|
(prog1 body (goto-char target-char))))
|
|
|
|
|
2010-06-11 19:02:42 -04:00
|
|
|
(provide 'ob-tangle)
|
2010-06-25 12:20:39 -04:00
|
|
|
|
|
|
|
;; arch-tag: 413ced93-48f5-4216-86e4-3fc5df8c8f24
|
|
|
|
|
2010-06-11 19:02:42 -04:00
|
|
|
;;; ob-tangle.el ends here
|