From: Nicolas Berthier <nberth@member.fsf.org>
To: Bastien <bzg@gnu.org>
Cc: Aaron Ecay <aaronecay@gmail.com>,
emacs-orgmode@gnu.org, Nicolas Berthier <nberth@member.fsf.org>
Subject: Re: [babel][PATCHES] exporting inline source code
Date: Wed, 30 Jul 2014 18:06:45 +0200 [thread overview]
Message-ID: <vp0ovbqezv8q.fsf@epicea.irisa.fr> (raw)
In-Reply-To: 87a97sfgkx.fsf@bzg.ath.cx
[-- Attachment #1: Type: text/plain, Size: 554 bytes --]
You wrote:
> Hi Nicolas,
>
> Nicolas Berthier <nberth@member.fsf.org> writes:
>
>> I will investigate on this ASAP, and notice you when I receive
>> a confirmation that the FSF signed it.
>
> Thanks, we should expect longer delays during the summer I guess.
Hi,
I received the confirmation form the FSF today (should I forward it to
some of you?).
In any case, as advised earlier in the discussion, I updated one patch
to integrate new tests for the new feature. I also slightly simplified
the HTML export patch to avoid useless display attributes.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-ob-Support-for-exporting-inline-source-code.patch --]
[-- Type: text/x-patch, Size: 11114 bytes --]
From 00fc0209ba50587075e4cf271d1b9a3612574562 Mon Sep 17 00:00:00 2001
From: Nicolas Berthier <nberth@member.fsf.org>
Date: Fri, 13 Jun 2014 15:32:54 +0200
Subject: [PATCH 1/2] ob: Support for exporting inline source code
* lisp/ob-exp.el (org-babel-exp-inline-code-template): New
customizable variable to export inline source code (similar to
`org-babel-exp-code-template').
(org-babel-exp-code): New `type' argument to differentiate between
inline and standard code blocks.
* lisp/ob-core.el (org-babel-inline-src-block-regexp): Allow empty set
of switches and header arguments as in "src_sh[]{echo foo;}".
* testing/lisp/test-ob-exp.el (ob-exp/exports-inline-code): New
function for testing inline source code handling.
* testing/lisp/test-ob.el
(test-org-babel/org-babel-get-inline-src-block-matches): Test for
inline source blocks with empty header arguments.
* testing/examples/babel.org: New sections for testing (i) exported
inline source code (used by `ob-exp/exports-inline-code'); (ii)
parsing inline source blocks with empty header arguments (used by
`test-org-babel/org-babel-get-inline-src-block-matches').
Until now pieces of inline source code were handled as standard code
blocks during export. These changes enable them to be exported.
---
lisp/ob-core.el | 2 +-
lisp/ob-exp.el | 30 ++++++++++++++++---
testing/examples/babel.org | 22 ++++++++++++++
testing/lisp/test-ob-exp.el | 14 +++++++++
testing/lisp/test-ob.el | 71 ++++++++++++++++++++++++++-------------------
5 files changed, 104 insertions(+), 35 deletions(-)
diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index ccc0878..08d4c65 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -203,7 +203,7 @@ This string must include a \"%s\" which will be replaced by the results."
(defvar org-babel-inline-src-block-regexp
(concat
;; (1) replacement target (2) lang
- "\\(?:^\\|[^-[:alnum:]]\\)\\(src_\\([^ \f\t\n\r\v]+\\)"
+ "\\(?:^\\|[^-[:alnum:]]\\)\\(src_\\([^ \f\t\n\r\v\\[]+\\)"
;; (3,4) (unused, headers)
"\\(\\|\\[\\(.*?\\)\\]\\)"
;; (5) body
diff --git a/lisp/ob-exp.el b/lisp/ob-exp.el
index 3a47661..37625ab 100644
--- a/lisp/ob-exp.el
+++ b/lisp/ob-exp.el
@@ -318,10 +318,10 @@ The function respects the value of the :exports header argument."
(clean (lambda () (unless (eq type 'inline) (org-babel-remove-result info)))))
(case (intern (or (cdr (assoc :exports (nth 2 info))) "code"))
('none (funcall silently) (funcall clean) "")
- ('code (funcall silently) (funcall clean) (org-babel-exp-code info))
+ ('code (funcall silently) (funcall clean) (org-babel-exp-code info type))
('results (org-babel-exp-results info type nil hash) "")
('both (org-babel-exp-results info type nil hash)
- (org-babel-exp-code info)))))
+ (org-babel-exp-code info type)))))
(defcustom org-babel-exp-code-template
"#+BEGIN_SRC %lang%switches%flags\n%body\n#+END_SRC"
@@ -343,7 +343,27 @@ replaced with its value."
:group 'org-babel
:type 'string)
-(defun org-babel-exp-code (info)
+(defcustom org-babel-exp-inline-code-template
+ "src_%lang[%switches%flags]{%body}"
+ "Template used to export the body of inline code blocks.
+This template may be customized to include additional information
+such as the code block name, or the values of particular header
+arguments. The template is filled out using `org-fill-template',
+and the following %keys may be used.
+
+ lang ------ the language of the code block
+ name ------ the name of the code block
+ body ------ the body of the code block
+ switches -- the switches associated to the code block
+ flags ----- the flags passed to the code block
+
+In addition to the keys mentioned above, every header argument
+defined for the code block may be used as a key and will be
+replaced with its value."
+ :group 'org-babel
+ :type 'string)
+
+(defun org-babel-exp-code (info type)
"Return the original code block formatted for export."
(setf (nth 1 info)
(if (string= "strip-export" (cdr (assoc :noweb (nth 2 info))))
@@ -354,7 +374,9 @@ replaced with its value."
info org-babel-exp-reference-buffer)
(nth 1 info))))
(org-fill-template
- org-babel-exp-code-template
+ (if (eq type 'inline)
+ org-babel-exp-inline-code-template
+ org-babel-exp-code-template)
`(("lang" . ,(nth 0 info))
("body" . ,(org-escape-code-in-string (nth 1 info)))
("switches" . ,(let ((f (nth 3 info)))
diff --git a/testing/examples/babel.org b/testing/examples/babel.org
index a8015d1..8bae65b 100644
--- a/testing/examples/babel.org
+++ b/testing/examples/babel.org
@@ -200,6 +200,17 @@ Here is one in the middle src_sh{echo 1} of a line.
Here is one at the end of a line. src_sh{echo 2}
src_sh{echo 3} Here is one at the beginning of a line.
+* exported inline source block
+:PROPERTIES:
+:ID: cd54fc88-1b6b-45b6-8511-4d8fa7fc8076
+:results: silent
+:exports: code
+:END:
+Here is one in the middle src_sh{echo 1} of a line.
+Here is one at the end of a line. src_sh{echo 2}
+src_sh{echo 3} Here is one at the beginning of a line.
+Here is one that is also evaluated: src_sh[:exports both]{echo 4}
+
* mixed blocks with exports both
:PROPERTIES:
:ID: 5daa4d03-e3ea-46b7-b093-62c1b7632df3
@@ -283,6 +294,17 @@ src_sh{echo "One"} block at start of line
One spaced block in src_sh{ echo "middle" } of line
src_sh{echo 2} blocks on the src_emacs-lisp{"same"} line
Inline block with src_sh[:results silent]{ echo "parameters" }.
+
+* org-babel-get-inline-src-block-matches (with empty args)
+ :PROPERTIES:
+ :results: silent
+ :ID: d55dada7-de0e-4340-8061-787cccbedee5
+ :END:
+src_sh[]{echo "One"} block at start of line
+ One spaced block in src_sh[]{ echo "middle" } of line
+src_sh[]{echo 2} blocks on the src_emacs-lisp[]{"same"} line
+ Inline block with src_sh[:results silent]{ echo "parameters" }.
+
* exporting a code block with a name
:PROPERTIES:
:ID: b02ddd8a-eeb8-42ab-8664-8a759e6f43d9
diff --git a/testing/lisp/test-ob-exp.el b/testing/lisp/test-ob-exp.el
index 1fe810b..b2d4958 100644
--- a/testing/lisp/test-ob-exp.el
+++ b/testing/lisp/test-ob-exp.el
@@ -197,6 +197,20 @@ Here is one at the end of a line. =2=
(org-narrow-to-subtree)
(org-test-with-expanded-babel-code (buffer-string))))))
+(ert-deftest ob-exp/exports-inline-code ()
+ (should
+ (string-match
+ (replace-regexp-in-string
+ "\\\\\\[]{" "\\(?:\\[]\\)?{" ;accept both src_sh[]{...} or src_sh{...}
+ (regexp-quote "Here is one in the middle src_sh[]{echo 1} of a line.
+Here is one at the end of a line. src_sh[]{echo 2}
+src_sh[]{echo 3} Here is one at the beginning of a line.
+Here is one that is also evaluated: src_sh[]{echo 4} =4=")
+ nil t)
+ (org-test-at-id "cd54fc88-1b6b-45b6-8511-4d8fa7fc8076"
+ (org-narrow-to-subtree)
+ (org-test-with-expanded-babel-code (buffer-string))))))
+
(ert-deftest ob-exp/export-call-line-information ()
(org-test-at-id "bec63a04-491e-4caa-97f5-108f3020365c"
(org-narrow-to-subtree)
diff --git a/testing/lisp/test-ob.el b/testing/lisp/test-ob.el
index 1162162..fdb5a3e 100644
--- a/testing/lisp/test-ob.el
+++ b/testing/lisp/test-ob.el
@@ -249,38 +249,49 @@ this is simple"
(should (= 14 (org-babel-execute-src-block)))))
(ert-deftest test-org-babel/inline-src-blocks ()
- (org-test-at-id "54cb8dc3-298c-4883-a933-029b3c9d4b18"
- (macrolet ((at-next (&rest body)
- `(progn
- (move-end-of-line 1)
- (re-search-forward org-babel-inline-src-block-regexp nil t)
- (goto-char (match-beginning 1))
- (save-match-data ,@body))))
- (at-next (should (equal 1 (org-babel-execute-src-block))))
- (at-next (should (equal 2 (org-babel-execute-src-block))))
- (at-next (should (equal 3 (org-babel-execute-src-block)))))))
+ (macrolet ((at-next (&rest body)
+ `(progn
+ (move-end-of-line 1)
+ (re-search-forward org-babel-inline-src-block-regexp nil t)
+ (goto-char (match-beginning 1))
+ (save-match-data ,@body))))
+ (org-test-at-id
+ "54cb8dc3-298c-4883-a933-029b3c9d4b18"
+ (at-next (should (equal 1 (org-babel-execute-src-block))))
+ (at-next (should (equal 2 (org-babel-execute-src-block))))
+ (at-next (should (equal 3 (org-babel-execute-src-block)))))
+ (org-test-at-id
+ "cd54fc88-1b6b-45b6-8511-4d8fa7fc8076"
+ (at-next (should (equal 1 (org-babel-execute-src-block))))
+ (at-next (should (equal 2 (org-babel-execute-src-block))))
+ (at-next (should (equal 3 (org-babel-execute-src-block))))
+ (at-next (should (equal 4 (org-babel-execute-src-block)))))))
(ert-deftest test-org-babel/org-babel-get-inline-src-block-matches ()
- (org-test-at-id "0D0983D4-DE33-400A-8A05-A225A567BC74"
- (let ((test-point (point)))
- (should (fboundp 'org-babel-get-inline-src-block-matches))
- (should (re-search-forward "src_" nil t)) ;; 1
- (should (org-babel-get-inline-src-block-matches))
- (should (re-search-forward "}" nil (point-at-bol))) ;; 1
- (should-not (org-babel-get-inline-src-block-matches))
- (should (re-search-forward "in" nil t)) ;; 2
- (should-not (org-babel-get-inline-src-block-matches))
- (should (re-search-forward "echo" nil t)) ;; 2
- (should (org-babel-get-inline-src-block-matches))
- (should (re-search-forward "blocks" nil t)) ;; 3
- (backward-char 8) ;; 3
- (should (org-babel-get-inline-src-block-matches))
- (forward-char 1) ;;3
- (should-not (org-babel-get-inline-src-block-matches))
- (should (re-search-forward ":results" nil t)) ;; 4
- (should (org-babel-get-inline-src-block-matches))
- (end-of-line)
- (should-not (org-babel-get-inline-src-block-matches)))))
+ (flet ((test-at-id (id)
+ (org-test-at-id
+ id
+ (let ((test-point (point)))
+ (should (fboundp 'org-babel-get-inline-src-block-matches))
+ (should (re-search-forward "src_" nil t)) ;; 1
+ (should (org-babel-get-inline-src-block-matches))
+ (should (re-search-forward "}" nil (point-at-bol))) ;; 1
+ (should-not (org-babel-get-inline-src-block-matches))
+ (should (re-search-forward "in" nil t)) ;; 2
+ (should-not (org-babel-get-inline-src-block-matches))
+ (should (re-search-forward "echo" nil t)) ;; 2
+ (should (org-babel-get-inline-src-block-matches))
+ (should (re-search-forward "blocks" nil t)) ;; 3
+ (backward-char 8) ;; 3
+ (should (org-babel-get-inline-src-block-matches))
+ (forward-char 1) ;;3
+ (should-not (org-babel-get-inline-src-block-matches))
+ (should (re-search-forward ":results" nil t)) ;; 4
+ (should (org-babel-get-inline-src-block-matches))
+ (end-of-line)
+ (should-not (org-babel-get-inline-src-block-matches))))))
+ (test-at-id "0D0983D4-DE33-400A-8A05-A225A567BC74")
+ (test-at-id "d55dada7-de0e-4340-8061-787cccbedee5")))
(ert-deftest test-org-babel/inline-src_blk-default-results-replace-line-1 ()
(let ((test-line "src_sh{echo 1}"))
--
2.0.0.rc4
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-ox-html-Support-for-exporting-inline-source-code-to-.patch --]
[-- Type: text/x-patch, Size: 1318 bytes --]
From 41841fa8c318302884f201c9c0d39c8ebd31d0df Mon Sep 17 00:00:00 2001
From: Nicolas Berthier <nberth@member.fsf.org>
Date: Fri, 13 Jun 2014 16:39:18 +0200
Subject: [PATCH 2/2] ox-html: Support for exporting inline source code to HTML
* lisp/ox-html.el (org-html-inline-src-block): support for exporting
inline source code to HTML.
---
lisp/ox-html.el | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/lisp/ox-html.el b/lisp/ox-html.el
index af4232c..6cc030c 100644
--- a/lisp/ox-html.el
+++ b/lisp/ox-html.el
@@ -2411,7 +2411,15 @@ CONTENTS holds the contents of the item. INFO is a plist holding
contextual information."
(let* ((org-lang (org-element-property :language inline-src-block))
(code (org-element-property :value inline-src-block)))
- (error "Cannot export inline src block")))
+ (let ((lang (org-element-property :language inline-src-block))
+ (code (org-html-format-code inline-src-block info))
+ (label (let ((lbl (org-element-property :name inline-src-block)))
+ (if (not lbl) ""
+ (format " id=\"%s\""
+ (org-export-solidify-link-text lbl))))))
+ (if lang
+ (format "<code class=\"src src-%s\"%s>%s</code>" lang label code)
+ (format "<code class=\"example\"%s>\n%s</code>" label code)))))
;;;; Inlinetask
--
2.0.0.rc4
[-- Attachment #4: Type: text/plain, Size: 88 bytes --]
Regards,
--
Nicolas Berthier FSF Member #7975
next prev parent reply other threads:[~2014-07-30 16:07 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-06-13 17:37 [babel][PATCHES] exporting inline source code Nicolas Berthier
2014-06-22 4:02 ` Aaron Ecay
2014-07-27 17:23 ` Bastien
2014-07-29 7:40 ` Nicolas Berthier
2014-07-29 13:19 ` Bastien
2014-07-30 16:06 ` Nicolas Berthier [this message]
2014-07-30 19:26 ` Nicolas Goaziou
2014-07-30 20:01 ` Achim Gratz
2014-07-30 20:23 ` Nicolas Goaziou
2014-08-01 12:23 ` Nicolas Berthier
2014-08-22 12:47 ` Nicolas Goaziou
2014-08-22 13:32 ` Bastien
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=vp0ovbqezv8q.fsf@epicea.irisa.fr \
--to=nberth@member.fsf.org \
--cc=aaronecay@gmail.com \
--cc=bzg@gnu.org \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).