mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-08-22 12:18:40 +00:00
201 lines
7.6 KiB
EmacsLisp
201 lines
7.6 KiB
EmacsLisp
;;; ob-latex.el --- org-babel functions for latex "evaluation"
|
|
|
|
;; Copyright (C) 2009-2013 Free Software Foundation, Inc.
|
|
|
|
;; Author: Eric Schulte
|
|
;; Keywords: literate programming, reproducible research
|
|
;; Homepage: http://orgmode.org
|
|
|
|
;; 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
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; Org-Babel support for evaluating LaTeX source code.
|
|
;;
|
|
;; 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.
|
|
|
|
;;; Code:
|
|
(require 'ob)
|
|
|
|
(declare-function org-create-formula-image "org" (string tofile options buffer))
|
|
(declare-function org-splice-latex-header "org"
|
|
(tpl def-pkg pkg snippets-p &optional extra))
|
|
(declare-function org-export-latex-fix-inputenc "org-latex" ())
|
|
(defvar org-babel-tangle-lang-exts)
|
|
(add-to-list 'org-babel-tangle-lang-exts '("latex" . "tex"))
|
|
|
|
(defvar org-format-latex-header)
|
|
(defvar org-format-latex-header-extra)
|
|
(defvar org-export-latex-packages-alist)
|
|
(defvar org-export-latex-default-packages-alist)
|
|
(defvar org-export-pdf-logfiles)
|
|
(defvar org-latex-to-pdf-process)
|
|
(defvar org-export-pdf-remove-logfiles)
|
|
(defvar org-format-latex-options)
|
|
(defvar org-export-latex-packages-alist)
|
|
|
|
(defvar org-babel-default-header-args:latex
|
|
'((:results . "latex") (:exports . "results"))
|
|
"Default arguments to use when evaluating a LaTeX source block.")
|
|
|
|
(defun org-babel-expand-body:latex (body params)
|
|
"Expand BODY according to PARAMS, return the expanded body."
|
|
(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)))
|
|
body))) (mapcar #'cdr (org-babel-get-header params :var)))
|
|
(org-babel-trim body))
|
|
|
|
(defun org-babel-execute:latex (body params)
|
|
"Execute a block of Latex code with Babel.
|
|
This function is called by `org-babel-execute-src-block'."
|
|
(setq body (org-babel-expand-body:latex body params))
|
|
(if (cdr (assoc :file params))
|
|
(let* ((out-file (cdr (assoc :file params)))
|
|
(tex-file (org-babel-temp-file "latex-" ".tex"))
|
|
(border (cdr (assoc :border params)))
|
|
(imagemagick (cdr (assoc :imagemagick params)))
|
|
(im-in-options (cdr (assoc :iminoptions params)))
|
|
(im-out-options (cdr (assoc :imoutoptions params)))
|
|
(pdfpng (cdr (assoc :pdfpng params)))
|
|
(fit (or (cdr (assoc :fit params)) border))
|
|
(height (and fit (cdr (assoc :pdfheight params))))
|
|
(width (and fit (cdr (assoc :pdfwidth params))))
|
|
(headers (cdr (assoc :headers params)))
|
|
(in-buffer (not (string= "no" (cdr (assoc :buffer params)))))
|
|
(org-export-latex-packages-alist
|
|
(append (cdr (assoc :packages params))
|
|
org-export-latex-packages-alist)))
|
|
(cond
|
|
((and (string-match "\\.png$" out-file) (not imagemagick))
|
|
(org-create-formula-image
|
|
body out-file org-format-latex-options in-buffer))
|
|
((or (string-match "\\.pdf$" out-file) imagemagick)
|
|
(require 'org-latex)
|
|
(with-temp-file tex-file
|
|
(insert
|
|
(org-splice-latex-header
|
|
org-format-latex-header
|
|
(delq
|
|
nil
|
|
(mapcar
|
|
(lambda (el)
|
|
(unless (and (listp el) (string= "hyperref" (cadr el)))
|
|
el))
|
|
org-export-latex-default-packages-alist))
|
|
org-export-latex-packages-alist
|
|
org-format-latex-header-extra)
|
|
(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 org-format-latex-header-extra
|
|
(concat "\n" org-format-latex-header-extra)
|
|
"")
|
|
(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")))
|
|
(org-export-latex-fix-inputenc))
|
|
(when (file-exists-p out-file) (delete-file out-file))
|
|
(let ((transient-pdf-file (org-babel-latex-tex-to-pdf tex-file)))
|
|
(cond
|
|
((string-match "\\.pdf$" out-file)
|
|
(rename-file transient-pdf-file out-file))
|
|
(imagemagick
|
|
(convert-pdf
|
|
transient-pdf-file out-file im-in-options im-out-options)
|
|
(when (file-exists-p transient-pdf-file)
|
|
(delete-file transient-pdf-file))))))
|
|
((string-match "\\.\\([^\\.]+\\)$" out-file)
|
|
(error "Can not create %s files, please specify a .png or .pdf file or try the :imagemagick header argument"
|
|
(match-string 1 out-file))))
|
|
nil) ;; signal that output has already been written to file
|
|
body))
|
|
|
|
|
|
(defun convert-pdf (pdffile out-file im-in-options im-out-options)
|
|
"Generate a file from a pdf file using imagemagick."
|
|
(let ((cmd (concat "convert " im-in-options " " pdffile " "
|
|
im-out-options " " out-file)))
|
|
(message (concat "Converting pdffile file " cmd "..."))
|
|
(shell-command cmd)))
|
|
|
|
(defun org-babel-latex-tex-to-pdf (file)
|
|
"Generate a pdf file according to the contents FILE.
|
|
Extracted from `org-export-as-pdf' in org-latex.el."
|
|
(let* ((wconfig (current-window-configuration))
|
|
(default-directory (file-name-directory file))
|
|
(base (file-name-sans-extension file))
|
|
(pdffile (concat base ".pdf"))
|
|
(cmds org-latex-to-pdf-process)
|
|
(outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
|
|
output-dir cmd)
|
|
(with-current-buffer outbuf (erase-buffer))
|
|
(message (concat "Processing LaTeX file " file "..."))
|
|
(setq output-dir (file-name-directory file))
|
|
(if (and cmds (symbolp cmds))
|
|
(funcall cmds (shell-quote-argument file))
|
|
(while cmds
|
|
(setq cmd (pop cmds))
|
|
(while (string-match "%b" cmd)
|
|
(setq cmd (replace-match
|
|
(save-match-data
|
|
(shell-quote-argument base))
|
|
t t cmd)))
|
|
(while (string-match "%f" cmd)
|
|
(setq cmd (replace-match
|
|
(save-match-data
|
|
(shell-quote-argument file))
|
|
t t cmd)))
|
|
(while (string-match "%o" cmd)
|
|
(setq cmd (replace-match
|
|
(save-match-data
|
|
(shell-quote-argument output-dir))
|
|
t t cmd)))
|
|
(shell-command cmd outbuf)))
|
|
(message (concat "Processing LaTeX file " file "...done"))
|
|
(if (not (file-exists-p pdffile))
|
|
(error (concat "PDF file " pdffile " was not produced"))
|
|
(set-window-configuration wconfig)
|
|
(when org-export-pdf-remove-logfiles
|
|
(dolist (ext org-export-pdf-logfiles)
|
|
(setq file (concat base "." ext))
|
|
(and (file-exists-p file) (delete-file file))))
|
|
(message "Exporting to PDF...done")
|
|
pdffile)))
|
|
|
|
(defun org-babel-prep-session:latex (session params)
|
|
"Return an error because LaTeX doesn't support sessions."
|
|
(error "LaTeX does not support sessions"))
|
|
|
|
(provide 'ob-latex)
|
|
|
|
|
|
|
|
;;; ob-latex.el ends here
|