2015-10-26 00:56:00 +00:00
|
|
|
;;; ob-org.el --- Babel Functions for Org Code Blocks -*- lexical-binding: t; -*-
|
2010-08-26 16:01:21 +00:00
|
|
|
|
2023-01-01 10:31:12 +00:00
|
|
|
;; Copyright (C) 2010-2023 Free Software Foundation, Inc.
|
2010-08-26 16:01:21 +00:00
|
|
|
|
|
|
|
;; Author: Eric Schulte
|
|
|
|
;; Keywords: literate programming, reproducible research
|
2021-09-26 07:44:29 +00:00
|
|
|
;; URL: https://orgmode.org
|
2010-08-26 16:01:21 +00:00
|
|
|
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
;; 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,
|
|
|
|
;; 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.
|
|
|
|
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
2017-09-13 22:52:52 +00:00
|
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
2010-08-26 16:01:21 +00:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; This is the simplest of code blocks, where upon evaluation the
|
|
|
|
;; contents of the code block are returned in a raw result.
|
|
|
|
|
|
|
|
;;; Code:
|
2022-08-04 13:53:05 +00:00
|
|
|
|
|
|
|
(require 'org-macs)
|
|
|
|
(org-assert-version)
|
|
|
|
|
2010-08-26 16:01:21 +00:00
|
|
|
(require 'ob)
|
|
|
|
|
2013-01-27 22:44:27 +00:00
|
|
|
(declare-function org-export-string-as "ox"
|
|
|
|
(string backend &optional body-only ext-plist))
|
2010-09-08 00:47:11 +00:00
|
|
|
|
2010-08-26 16:01:21 +00:00
|
|
|
(defvar org-babel-default-header-args:org
|
2012-09-28 12:58:59 +00:00
|
|
|
'((:results . "raw silent") (:exports . "code"))
|
2018-02-16 20:16:15 +00:00
|
|
|
"Default arguments for evaluating an org source block.")
|
2010-08-26 16:01:21 +00:00
|
|
|
|
2010-09-09 06:37:18 +00:00
|
|
|
(defvar org-babel-org-default-header
|
|
|
|
"#+TITLE: default empty header\n"
|
|
|
|
"Default header inserted during export of org blocks.")
|
|
|
|
|
2011-06-30 22:23:35 +00:00
|
|
|
(defun org-babel-expand-body:org (body params)
|
2023-09-29 13:27:11 +00:00
|
|
|
"Expand Org BODY according to PARAMS.
|
|
|
|
$VAR instances are replaced by VAR values defined in PARAMS."
|
2015-10-29 19:26:11 +00:00
|
|
|
(dolist (var (org-babel--get-vars params))
|
2011-06-30 22:23:35 +00:00
|
|
|
(setq body (replace-regexp-in-string
|
2013-05-03 15:53:48 +00:00
|
|
|
(regexp-quote (format "$%s" (car var)))
|
|
|
|
(format "%s" (cdr var))
|
|
|
|
body nil 'literal)))
|
2023-10-19 08:59:46 +00:00
|
|
|
|
|
|
|
(let ((prologue (cdr (assq :prologue params)))
|
|
|
|
(epilogue (cdr (assq :epilogue params))))
|
|
|
|
(concat
|
|
|
|
(and prologue (concat prologue "\n"))
|
|
|
|
body
|
|
|
|
(and epilogue (concat "\n" epilogue "\n")))))
|
2011-06-30 22:23:35 +00:00
|
|
|
|
2010-08-26 16:01:21 +00:00
|
|
|
(defun org-babel-execute:org (body params)
|
2023-09-29 13:27:11 +00:00
|
|
|
"Execute a Org BODY according to PARAMS.
|
|
|
|
The BODY is returned expanded as is or exported, if PARAMS define
|
|
|
|
latex/html/ascii result type.
|
2010-08-26 16:01:21 +00:00
|
|
|
This function is called by `org-babel-execute-src-block'."
|
2016-09-22 17:45:15 +00:00
|
|
|
(let ((result-params (split-string (or (cdr (assq :results params)) "")))
|
2011-06-30 22:23:35 +00:00
|
|
|
(body (org-babel-expand-body:org
|
|
|
|
(replace-regexp-in-string "^," "" body) params)))
|
2010-09-08 00:47:11 +00:00
|
|
|
(cond
|
2013-01-27 22:44:27 +00:00
|
|
|
((member "latex" result-params)
|
|
|
|
(org-export-string-as (concat "#+Title: \n" body) 'latex t))
|
|
|
|
((member "html" result-params) (org-export-string-as body 'html t))
|
|
|
|
((member "ascii" result-params) (org-export-string-as body 'ascii t))
|
2010-09-08 00:47:11 +00:00
|
|
|
(t body))))
|
|
|
|
|
2015-10-26 00:56:00 +00:00
|
|
|
(defun org-babel-prep-session:org (_session _params)
|
2010-08-26 16:01:21 +00:00
|
|
|
"Return an error because org does not support sessions."
|
|
|
|
(error "Org does not support sessions"))
|
|
|
|
|
|
|
|
(provide 'ob-org)
|
|
|
|
|
|
|
|
;;; ob-org.el ends here
|