ob-latex.el 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. ;;; ob-latex.el --- Babel Functions for LaTeX -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2009-2018 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. ;; Org-Babel support for evaluating LaTeX source code.
  19. ;;
  20. ;; Currently on evaluation this returns raw LaTeX code, unless a :file
  21. ;; header argument is given in which case small png or pdf files will
  22. ;; be created directly form the latex source code.
  23. ;;; Code:
  24. (require 'ob)
  25. (require 'org-macs)
  26. (declare-function org-create-formula-image "org" (string tofile options buffer &optional type))
  27. (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
  28. (declare-function org-latex-guess-inputenc "ox-latex" (header))
  29. (declare-function org-splice-latex-header "org" (tpl def-pkg pkg snippets-p &optional extra))
  30. (defvar org-babel-tangle-lang-exts)
  31. (add-to-list 'org-babel-tangle-lang-exts '("latex" . "tex"))
  32. (defvar org-format-latex-header) ; From org.el
  33. (defvar org-format-latex-options) ; From org.el
  34. (defvar org-latex-default-packages-alist) ; From org.el
  35. (defvar org-latex-packages-alist) ; From org.el
  36. (defvar org-babel-default-header-args:latex
  37. '((:results . "latex") (:exports . "results"))
  38. "Default arguments to use when evaluating a LaTeX source block.")
  39. (defconst org-babel-header-args:latex
  40. '((border . :any)
  41. (fit . :any)
  42. (imagemagick . ((nil t)))
  43. (iminoptions . :any)
  44. (imoutoptions . :any)
  45. (packages . :any)
  46. (pdfheight . :any)
  47. (pdfpng . :any)
  48. (pdfwidth . :any)
  49. (headers . :any)
  50. (packages . :any)
  51. (buffer . ((yes no))))
  52. "LaTeX-specific header arguments.")
  53. (defcustom org-babel-latex-htlatex "htlatex"
  54. "The htlatex command to enable conversion of latex to SVG or HTML."
  55. :group 'org-babel
  56. :type 'string)
  57. (defcustom org-babel-latex-htlatex-packages
  58. '("[usenames]{color}" "{tikz}" "{color}" "{listings}" "{amsmath}")
  59. "Packages to use for htlatex export."
  60. :group 'org-babel
  61. :type '(repeat (string)))
  62. (defun org-babel-expand-body:latex (body params)
  63. "Expand BODY according to PARAMS, return the expanded body."
  64. (mapc (lambda (pair) ;; replace variables
  65. (setq body
  66. (replace-regexp-in-string
  67. (regexp-quote (format "%S" (car pair)))
  68. (if (stringp (cdr pair))
  69. (cdr pair) (format "%S" (cdr pair)))
  70. body))) (org-babel--get-vars params))
  71. (org-trim body))
  72. (defun org-babel-execute:latex (body params)
  73. "Execute a block of Latex code with Babel.
  74. This function is called by `org-babel-execute-src-block'."
  75. (setq body (org-babel-expand-body:latex body params))
  76. (if (cdr (assq :file params))
  77. (let* ((out-file (cdr (assq :file params)))
  78. (extension (file-name-extension out-file))
  79. (tex-file (org-babel-temp-file "latex-" ".tex"))
  80. (border (cdr (assq :border params)))
  81. (imagemagick (cdr (assq :imagemagick params)))
  82. (im-in-options (cdr (assq :iminoptions params)))
  83. (im-out-options (cdr (assq :imoutoptions params)))
  84. (fit (or (cdr (assq :fit params)) border))
  85. (height (and fit (cdr (assq :pdfheight params))))
  86. (width (and fit (cdr (assq :pdfwidth params))))
  87. (headers (cdr (assq :headers params)))
  88. (in-buffer (not (string= "no" (cdr (assq :buffer params)))))
  89. (org-latex-packages-alist
  90. (append (cdr (assq :packages params)) org-latex-packages-alist)))
  91. (cond
  92. ((and (string-suffix-p ".png" out-file) (not imagemagick))
  93. (org-create-formula-image
  94. body out-file org-format-latex-options in-buffer))
  95. ((string-suffix-p ".tikz" out-file)
  96. (when (file-exists-p out-file) (delete-file out-file))
  97. (with-temp-file out-file
  98. (insert body)))
  99. ((and (or (string= "svg" extension)
  100. (string= "html" extension))
  101. (executable-find org-babel-latex-htlatex))
  102. ;; TODO: this is a very different way of generating the
  103. ;; frame latex document than in the pdf case. Ideally, both
  104. ;; would be unified. This would prevent bugs creeping in
  105. ;; such as the one fixed on Aug 16 2014 whereby :headers was
  106. ;; not included in the SVG/HTML case.
  107. (with-temp-file tex-file
  108. (insert (concat
  109. "\\documentclass[preview]{standalone}
  110. \\def\\pgfsysdriver{pgfsys-tex4ht.def}
  111. "
  112. (mapconcat (lambda (pkg)
  113. (concat "\\usepackage" pkg))
  114. org-babel-latex-htlatex-packages
  115. "\n")
  116. (if headers
  117. (concat "\n"
  118. (if (listp headers)
  119. (mapconcat #'identity headers "\n")
  120. headers) "\n")
  121. "")
  122. "\\begin{document}"
  123. body
  124. "\\end{document}")))
  125. (when (file-exists-p out-file) (delete-file out-file))
  126. (let ((default-directory (file-name-directory tex-file)))
  127. (shell-command (format "%s %s" org-babel-latex-htlatex tex-file)))
  128. (cond
  129. ((file-exists-p (concat (file-name-sans-extension tex-file) "-1.svg"))
  130. (if (string-suffix-p ".svg" out-file)
  131. (progn
  132. (shell-command "pwd")
  133. (shell-command (format "mv %s %s"
  134. (concat (file-name-sans-extension tex-file) "-1.svg")
  135. out-file)))
  136. (error "SVG file produced but HTML file requested")))
  137. ((file-exists-p (concat (file-name-sans-extension tex-file) ".html"))
  138. (if (string-suffix-p ".html" out-file)
  139. (shell-command "mv %s %s"
  140. (concat (file-name-sans-extension tex-file)
  141. ".html")
  142. out-file)
  143. (error "HTML file produced but SVG file requested")))))
  144. ((or (string= "pdf" extension) imagemagick)
  145. (with-temp-file tex-file
  146. (require 'ox-latex)
  147. (insert
  148. (org-latex-guess-inputenc
  149. (org-splice-latex-header
  150. org-format-latex-header
  151. (delq
  152. nil
  153. (mapcar
  154. (lambda (el)
  155. (unless (and (listp el) (string= "hyperref" (cadr el)))
  156. el))
  157. org-latex-default-packages-alist))
  158. org-latex-packages-alist
  159. nil))
  160. (if fit "\n\\usepackage[active, tightpage]{preview}\n" "")
  161. (if border (format "\\setlength{\\PreviewBorder}{%s}" border) "")
  162. (if height (concat "\n" (format "\\pdfpageheight %s" height)) "")
  163. (if width (concat "\n" (format "\\pdfpagewidth %s" width)) "")
  164. (if headers
  165. (concat "\n"
  166. (if (listp headers)
  167. (mapconcat #'identity headers "\n")
  168. headers) "\n")
  169. "")
  170. (if fit
  171. (concat "\n\\begin{document}\n\\begin{preview}\n" body
  172. "\n\\end{preview}\n\\end{document}\n")
  173. (concat "\n\\begin{document}\n" body "\n\\end{document}\n"))))
  174. (when (file-exists-p out-file) (delete-file out-file))
  175. (let ((transient-pdf-file (org-babel-latex-tex-to-pdf tex-file)))
  176. (cond
  177. ((string= "pdf" extension)
  178. (rename-file transient-pdf-file out-file))
  179. (imagemagick
  180. (org-babel-latex-convert-pdf
  181. transient-pdf-file out-file im-in-options im-out-options)
  182. (when (file-exists-p transient-pdf-file)
  183. (delete-file transient-pdf-file)))
  184. (t
  185. (error "Can not create %s files, please specify a .png or .pdf file or try the :imagemagick header argument"
  186. extension))))))
  187. nil) ;; signal that output has already been written to file
  188. body))
  189. (defun org-babel-latex-convert-pdf (pdffile out-file im-in-options im-out-options)
  190. "Generate a file from a pdf file using imagemagick."
  191. (let ((cmd (concat "convert " im-in-options " " pdffile " "
  192. im-out-options " " out-file)))
  193. (message "Converting pdffile file %s..." cmd)
  194. (shell-command cmd)))
  195. (defun org-babel-latex-tex-to-pdf (file)
  196. "Generate a pdf file according to the contents FILE."
  197. (require 'ox-latex)
  198. (org-latex-compile file))
  199. (defun org-babel-prep-session:latex (_session _params)
  200. "Return an error because LaTeX doesn't support sessions."
  201. (error "LaTeX does not support sessions"))
  202. (provide 'ob-latex)
  203. ;;; ob-latex.el ends here