2015-10-26 00:56:00 +00:00
|
|
|
;;; ob-latex.el --- Babel Functions for LaTeX -*- lexical-binding: t; -*-
|
2009-10-28 14:45:17 +00:00
|
|
|
|
2024-01-02 01:47:10 +00:00
|
|
|
;; Copyright (C) 2009-2024 Free Software Foundation, Inc.
|
2009-10-28 14:45:17 +00:00
|
|
|
|
|
|
|
;; Author: Eric Schulte
|
|
|
|
;; Keywords: literate programming, reproducible research
|
2021-09-26 07:44:29 +00:00
|
|
|
;; URL: https://orgmode.org
|
2009-10-28 14:45:17 +00:00
|
|
|
|
2010-06-25 16:32:35 +00:00
|
|
|
;; This file is part of GNU Emacs.
|
2009-10-28 14:45:17 +00:00
|
|
|
|
2010-06-25 16:32:35 +00:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2009-10-28 14:45:17 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2010-06-25 16:32:35 +00: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-10-28 14:45:17 +00: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 16:32:35 +00:00
|
|
|
|
2009-10-28 14:45:17 +00:00
|
|
|
;; 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/>.
|
2009-10-28 14:45:17 +00:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Org-Babel support for evaluating LaTeX source code.
|
|
|
|
;;
|
2010-02-06 01:02:55 +00:00
|
|
|
;; Currently on evaluation this returns raw LaTeX code, unless a :file
|
|
|
|
;; header argument is given in which case small png or pdf files will
|
|
|
|
;; be created directly form the latex source code.
|
2009-10-28 14:45:17 +00:00
|
|
|
|
|
|
|
;;; Code:
|
2022-08-04 13:53:05 +00:00
|
|
|
|
|
|
|
(require 'org-macs)
|
|
|
|
(org-assert-version)
|
|
|
|
|
2010-06-11 23:02:42 +00:00
|
|
|
(require 'ob)
|
2018-05-10 00:04:12 +00:00
|
|
|
(require 'org-macs)
|
2009-10-28 14:45:17 +00:00
|
|
|
|
2016-06-21 13:24:06 +00:00
|
|
|
(declare-function org-create-formula-image "org" (string tofile options buffer &optional type))
|
2016-05-15 02:56:53 +00:00
|
|
|
(declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
|
2016-06-21 13:24:06 +00:00
|
|
|
(declare-function org-latex-guess-inputenc "ox-latex" (header))
|
|
|
|
(declare-function org-splice-latex-header "org" (tpl def-pkg pkg snippets-p &optional extra))
|
2022-06-16 05:10:38 +00:00
|
|
|
(declare-function org-at-heading-p "org" (&optional _))
|
|
|
|
(declare-function org-back-to-heading "org" (&optional invisible-ok))
|
|
|
|
(declare-function org-next-visible-heading "org" (arg))
|
2013-02-02 19:58:39 +00:00
|
|
|
|
2011-06-21 22:34:41 +00:00
|
|
|
(defvar org-babel-tangle-lang-exts)
|
2010-06-17 17:21:14 +00:00
|
|
|
(add-to-list 'org-babel-tangle-lang-exts '("latex" . "tex"))
|
|
|
|
|
2013-02-02 19:58:39 +00:00
|
|
|
(defvar org-format-latex-header) ; From org.el
|
|
|
|
(defvar org-format-latex-options) ; From org.el
|
|
|
|
(defvar org-latex-default-packages-alist) ; From org.el
|
|
|
|
(defvar org-latex-packages-alist) ; From org.el
|
2010-08-25 01:14:14 +00:00
|
|
|
|
2009-10-28 14:45:17 +00:00
|
|
|
(defvar org-babel-default-header-args:latex
|
|
|
|
'((:results . "latex") (:exports . "results"))
|
2010-07-13 23:20:08 +00:00
|
|
|
"Default arguments to use when evaluating a LaTeX source block.")
|
2009-10-28 14:45:17 +00:00
|
|
|
|
2015-05-27 10:23:59 +00:00
|
|
|
(defconst org-babel-header-args:latex
|
|
|
|
'((border . :any)
|
|
|
|
(fit . :any)
|
2015-12-17 14:34:33 +00:00
|
|
|
(imagemagick . ((nil t)))
|
2015-05-27 10:23:59 +00:00
|
|
|
(iminoptions . :any)
|
|
|
|
(imoutoptions . :any)
|
|
|
|
(packages . :any)
|
|
|
|
(pdfheight . :any)
|
|
|
|
(pdfpng . :any)
|
2015-11-07 20:28:37 +00:00
|
|
|
(pdfwidth . :any)
|
|
|
|
(headers . :any)
|
|
|
|
(buffer . ((yes no))))
|
2015-05-27 10:23:59 +00:00
|
|
|
"LaTeX-specific header arguments.")
|
|
|
|
|
2014-12-09 06:06:28 +00:00
|
|
|
(defcustom org-babel-latex-htlatex "htlatex"
|
2020-08-29 05:26:05 +00:00
|
|
|
"The htlatex command to enable conversion of LaTeX to SVG or HTML."
|
|
|
|
:group 'org-babel
|
|
|
|
:type 'string)
|
|
|
|
|
|
|
|
(defcustom org-babel-latex-preamble
|
|
|
|
(lambda (_)
|
|
|
|
"\\documentclass[preview]{standalone}
|
|
|
|
\\def\\pgfsysdriver{pgfsys-tex4ht.def}
|
|
|
|
")
|
|
|
|
"Closure which evaluates at runtime to the LaTeX preamble.
|
|
|
|
|
|
|
|
It takes 1 argument which is the parameters of the source block."
|
|
|
|
:group 'org-babel
|
|
|
|
:type 'function)
|
|
|
|
|
|
|
|
(defcustom org-babel-latex-begin-env
|
|
|
|
(lambda (_)
|
|
|
|
"\\begin{document}")
|
2021-02-24 04:35:25 +00:00
|
|
|
"Function that evaluates to the begin part of the document environment.
|
2020-08-29 05:26:05 +00:00
|
|
|
|
|
|
|
It takes 1 argument which is the parameters of the source block.
|
|
|
|
This allows adding additional code that will be ignored when
|
|
|
|
exporting the literal LaTeX source."
|
|
|
|
:group 'org-babel
|
|
|
|
:type 'function)
|
|
|
|
|
|
|
|
(defcustom org-babel-latex-end-env
|
|
|
|
(lambda (_)
|
|
|
|
"\\end{document}")
|
|
|
|
"Closure which evaluates at runtime to the end part of the document environment.
|
|
|
|
|
|
|
|
It takes 1 argument which is the parameters of the source block.
|
|
|
|
This allows adding additional code that will be ignored when
|
|
|
|
exporting the literal LaTeX source."
|
|
|
|
:group 'org-babel
|
|
|
|
:type 'function)
|
|
|
|
|
|
|
|
(defcustom org-babel-latex-pdf-svg-process
|
2022-11-03 00:05:47 +00:00
|
|
|
"inkscape \
|
|
|
|
--pdf-poppler \
|
|
|
|
--export-area-drawing \
|
|
|
|
--export-text-to-path \
|
|
|
|
--export-plain-svg \
|
|
|
|
--export-filename=%O \
|
|
|
|
%f"
|
2021-02-24 04:35:25 +00:00
|
|
|
"Command to convert a PDF file to an SVG file."
|
2013-07-11 06:08:22 +00:00
|
|
|
:group 'org-babel
|
2022-11-13 07:29:15 +00:00
|
|
|
:type 'string
|
|
|
|
:package-version '(Org . "9.6"))
|
2013-07-11 06:08:22 +00:00
|
|
|
|
|
|
|
(defcustom org-babel-latex-htlatex-packages
|
|
|
|
'("[usenames]{color}" "{tikz}" "{color}" "{listings}" "{amsmath}")
|
|
|
|
"Packages to use for htlatex export."
|
|
|
|
:group 'org-babel
|
2013-12-30 09:30:44 +00:00
|
|
|
:type '(repeat (string)))
|
2013-07-11 06:08:22 +00:00
|
|
|
|
2010-10-16 03:35:45 +00:00
|
|
|
(defun org-babel-expand-body:latex (body params)
|
2010-06-12 00:12:15 +00:00
|
|
|
"Expand BODY according to PARAMS, return the expanded body."
|
2009-10-28 14:45:17 +00:00
|
|
|
(mapc (lambda (pair) ;; replace variables
|
|
|
|
(setq body
|
|
|
|
(replace-regexp-in-string
|
|
|
|
(regexp-quote (format "%S" (car pair)))
|
|
|
|
(if (stringp (cdr pair))
|
|
|
|
(cdr pair) (format "%S" (cdr pair)))
|
2020-02-18 21:57:37 +00:00
|
|
|
body)))
|
|
|
|
(org-babel--get-vars params))
|
2023-10-19 08:59:11 +00:00
|
|
|
(let ((prologue (cdr (assq :prologue params)))
|
|
|
|
(epilogue (cdr (assq :epilogue params))))
|
|
|
|
(org-trim
|
|
|
|
(concat
|
|
|
|
(and prologue (concat prologue "\n"))
|
|
|
|
body
|
|
|
|
(and epilogue (concat "\n" epilogue "\n"))))))
|
2010-04-16 05:03:07 +00:00
|
|
|
|
|
|
|
(defun org-babel-execute:latex (body params)
|
2023-09-19 12:49:09 +00:00
|
|
|
"Execute LaTeX BODY according to PARAMS.
|
2010-07-13 23:20:08 +00:00
|
|
|
This function is called by `org-babel-execute-src-block'."
|
2010-04-16 05:03:07 +00:00
|
|
|
(setq body (org-babel-expand-body:latex body params))
|
2016-09-22 17:45:15 +00:00
|
|
|
(if (cdr (assq :file params))
|
|
|
|
(let* ((out-file (cdr (assq :file params)))
|
2016-09-01 17:44:30 +00:00
|
|
|
(extension (file-name-extension out-file))
|
2010-08-26 01:21:42 +00:00
|
|
|
(tex-file (org-babel-temp-file "latex-" ".tex"))
|
2016-09-22 17:45:15 +00:00
|
|
|
(border (cdr (assq :border params)))
|
|
|
|
(imagemagick (cdr (assq :imagemagick params)))
|
|
|
|
(im-in-options (cdr (assq :iminoptions params)))
|
|
|
|
(im-out-options (cdr (assq :imoutoptions params)))
|
|
|
|
(fit (or (cdr (assq :fit params)) border))
|
|
|
|
(height (and fit (cdr (assq :pdfheight params))))
|
|
|
|
(width (and fit (cdr (assq :pdfwidth params))))
|
|
|
|
(headers (cdr (assq :headers params)))
|
|
|
|
(in-buffer (not (string= "no" (cdr (assq :buffer params)))))
|
2013-02-02 19:58:39 +00:00
|
|
|
(org-latex-packages-alist
|
2016-09-22 17:45:15 +00:00
|
|
|
(append (cdr (assq :packages params)) org-latex-packages-alist)))
|
2010-02-06 01:02:55 +00:00
|
|
|
(cond
|
2016-08-24 15:05:54 +00:00
|
|
|
((and (string-suffix-p ".png" out-file) (not imagemagick))
|
2020-05-06 19:50:11 +00:00
|
|
|
(let ((org-format-latex-header
|
|
|
|
(concat org-format-latex-header "\n"
|
|
|
|
(mapconcat #'identity headers "\n"))))
|
2021-09-29 07:22:47 +00:00
|
|
|
(org-create-formula-image
|
|
|
|
body out-file org-format-latex-options in-buffer)))
|
2020-08-29 05:26:05 +00:00
|
|
|
((string= "svg" extension)
|
|
|
|
(with-temp-file tex-file
|
2021-09-29 07:22:47 +00:00
|
|
|
(insert (concat (funcall org-babel-latex-preamble params)
|
|
|
|
(mapconcat #'identity headers "\n")
|
|
|
|
(funcall org-babel-latex-begin-env params)
|
|
|
|
body
|
|
|
|
(funcall org-babel-latex-end-env params))))
|
2020-08-29 05:26:05 +00:00
|
|
|
(let ((tmp-pdf (org-babel-latex-tex-to-pdf tex-file)))
|
2021-09-29 07:22:47 +00:00
|
|
|
(let* ((log-buf (get-buffer-create "*Org Babel LaTeX Output*"))
|
|
|
|
(err-msg "org babel latex failed")
|
|
|
|
(img-out (org-compile-file
|
|
|
|
tmp-pdf
|
|
|
|
(list org-babel-latex-pdf-svg-process)
|
|
|
|
extension err-msg log-buf)))
|
2023-02-18 10:03:28 +00:00
|
|
|
(rename-file img-out out-file t))))
|
2016-08-24 15:05:54 +00:00
|
|
|
((string-suffix-p ".tikz" out-file)
|
2013-07-17 14:45:32 +00:00
|
|
|
(when (file-exists-p out-file) (delete-file out-file))
|
|
|
|
(with-temp-file out-file
|
|
|
|
(insert body)))
|
2020-08-29 05:26:05 +00:00
|
|
|
((and (string= "html" extension)
|
2014-12-09 06:06:28 +00:00
|
|
|
(executable-find org-babel-latex-htlatex))
|
2014-08-16 04:43:37 +00:00
|
|
|
;; TODO: this is a very different way of generating the
|
|
|
|
;; frame latex document than in the pdf case. Ideally, both
|
|
|
|
;; would be unified. This would prevent bugs creeping in
|
|
|
|
;; such as the one fixed on Aug 16 2014 whereby :headers was
|
|
|
|
;; not included in the SVG/HTML case.
|
2013-07-11 06:08:22 +00:00
|
|
|
(with-temp-file tex-file
|
|
|
|
(insert (concat
|
|
|
|
"\\documentclass[preview]{standalone}
|
|
|
|
\\def\\pgfsysdriver{pgfsys-tex4ht.def}
|
|
|
|
"
|
|
|
|
(mapconcat (lambda (pkg)
|
|
|
|
(concat "\\usepackage" pkg))
|
|
|
|
org-babel-latex-htlatex-packages
|
|
|
|
"\n")
|
2014-08-16 04:43:37 +00:00
|
|
|
(if headers
|
|
|
|
(concat "\n"
|
|
|
|
(if (listp headers)
|
|
|
|
(mapconcat #'identity headers "\n")
|
|
|
|
headers) "\n")
|
|
|
|
"")
|
2013-07-11 06:08:22 +00:00
|
|
|
"\\begin{document}"
|
|
|
|
body
|
|
|
|
"\\end{document}")))
|
|
|
|
(when (file-exists-p out-file) (delete-file out-file))
|
|
|
|
(let ((default-directory (file-name-directory tex-file)))
|
|
|
|
(shell-command (format "%s %s" org-babel-latex-htlatex tex-file)))
|
|
|
|
(cond
|
|
|
|
((file-exists-p (concat (file-name-sans-extension tex-file) "-1.svg"))
|
2016-08-24 15:05:54 +00:00
|
|
|
(if (string-suffix-p ".svg" out-file)
|
2013-07-11 06:08:22 +00:00
|
|
|
(progn
|
|
|
|
(shell-command "pwd")
|
2023-03-11 10:53:37 +00:00
|
|
|
(rename-file (concat (file-name-sans-extension tex-file) "-1.svg")
|
|
|
|
out-file t))
|
2015-01-26 07:53:15 +00:00
|
|
|
(error "SVG file produced but HTML file requested")))
|
2013-07-11 06:08:22 +00:00
|
|
|
((file-exists-p (concat (file-name-sans-extension tex-file) ".html"))
|
2016-08-24 15:05:54 +00:00
|
|
|
(if (string-suffix-p ".html" out-file)
|
2023-03-11 10:53:37 +00:00
|
|
|
(rename-file (concat (file-name-sans-extension tex-file) ".html")
|
|
|
|
out-file t)
|
|
|
|
(error "HTML file produced but SVG file requested")))))
|
2016-09-01 17:44:30 +00:00
|
|
|
((or (string= "pdf" extension) imagemagick)
|
2015-03-21 22:22:17 +00:00
|
|
|
(with-temp-file tex-file
|
|
|
|
(require 'ox-latex)
|
|
|
|
(insert
|
|
|
|
(org-latex-guess-inputenc
|
|
|
|
(org-splice-latex-header
|
|
|
|
org-format-latex-header
|
|
|
|
(delq
|
|
|
|
nil
|
|
|
|
(mapcar
|
|
|
|
(lambda (el)
|
|
|
|
(unless (and (listp el) (string= "hyperref" (cadr el)))
|
|
|
|
el))
|
|
|
|
org-latex-default-packages-alist))
|
|
|
|
org-latex-packages-alist
|
|
|
|
nil))
|
|
|
|
(if fit "\n\\usepackage[active, tightpage]{preview}\n" "")
|
|
|
|
(if border (format "\\setlength{\\PreviewBorder}{%s}" border) "")
|
|
|
|
(if height (concat "\n" (format "\\pdfpageheight %s" height)) "")
|
|
|
|
(if width (concat "\n" (format "\\pdfpagewidth %s" width)) "")
|
|
|
|
(if headers
|
|
|
|
(concat "\n"
|
|
|
|
(if (listp headers)
|
|
|
|
(mapconcat #'identity headers "\n")
|
|
|
|
headers) "\n")
|
|
|
|
"")
|
|
|
|
(if fit
|
|
|
|
(concat "\n\\begin{document}\n\\begin{preview}\n" body
|
|
|
|
"\n\\end{preview}\n\\end{document}\n")
|
|
|
|
(concat "\n\\begin{document}\n" body "\n\\end{document}\n"))))
|
|
|
|
(when (file-exists-p out-file) (delete-file out-file))
|
|
|
|
(let ((transient-pdf-file (org-babel-latex-tex-to-pdf tex-file)))
|
|
|
|
(cond
|
2016-09-01 17:44:30 +00:00
|
|
|
((string= "pdf" extension)
|
2015-03-21 22:22:17 +00:00
|
|
|
(rename-file transient-pdf-file out-file))
|
|
|
|
(imagemagick
|
|
|
|
(org-babel-latex-convert-pdf
|
|
|
|
transient-pdf-file out-file im-in-options im-out-options)
|
|
|
|
(when (file-exists-p transient-pdf-file)
|
2016-09-01 17:44:30 +00:00
|
|
|
(delete-file transient-pdf-file)))
|
|
|
|
(t
|
|
|
|
(error "Can not create %s files, please specify a .png or .pdf file or try the :imagemagick header argument"
|
|
|
|
extension))))))
|
2010-12-21 10:21:28 +00:00
|
|
|
nil) ;; signal that output has already been written to file
|
2010-02-06 01:02:55 +00:00
|
|
|
body))
|
|
|
|
|
2014-08-16 04:43:37 +00:00
|
|
|
(defun org-babel-latex-convert-pdf (pdffile out-file im-in-options im-out-options)
|
2023-09-19 12:49:09 +00:00
|
|
|
"Generate OUT-FILE from PDFFILE using imagemagick.
|
|
|
|
IM-IN-OPTIONS are command line options for input file, as a string;
|
|
|
|
and IM-OUT-OPTIONS are the output file options."
|
2011-11-22 13:59:58 +00:00
|
|
|
(let ((cmd (concat "convert " im-in-options " " pdffile " "
|
|
|
|
im-out-options " " out-file)))
|
2015-09-20 16:40:35 +00:00
|
|
|
(message "Converting pdffile file %s..." cmd)
|
2011-11-22 13:59:58 +00:00
|
|
|
(shell-command cmd)))
|
|
|
|
|
2010-08-25 01:14:14 +00:00
|
|
|
(defun org-babel-latex-tex-to-pdf (file)
|
2013-02-02 19:58:39 +00:00
|
|
|
"Generate a pdf file according to the contents FILE."
|
|
|
|
(require 'ox-latex)
|
|
|
|
(org-latex-compile file))
|
2009-10-28 14:45:17 +00:00
|
|
|
|
2015-10-26 00:56:00 +00:00
|
|
|
(defun org-babel-prep-session:latex (_session _params)
|
2011-12-30 23:38:06 +00:00
|
|
|
"Return an error because LaTeX doesn't support sessions."
|
2010-07-13 23:20:08 +00:00
|
|
|
(error "LaTeX does not support sessions"))
|
2009-10-28 14:45:17 +00:00
|
|
|
|
2013-02-02 19:58:39 +00:00
|
|
|
(provide 'ob-latex)
|
2020-02-18 21:57:37 +00:00
|
|
|
|
2010-06-11 23:02:42 +00:00
|
|
|
;;; ob-latex.el ends here
|