;;; sage-view.el --- Typeset SAGE output on the fly ;; Copyright (C) 2008 Matthias Meulien ;; Author: Matthias Meulien ;; Keywords: sage math image ;; This program 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. ;; This program 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 this program. If not, see . ;;; Commentary: ;; Put this file in a directory in `load-path' and add the following ;; line to `.emacs': ;; (add-hook 'inferior-sage-mode-hook 'sage-view) ;; This mode was inspired by doc-view.el by Tassilo Horn, preview.el ;; by David Kastrup, and imath.el by Yasuaki Honda. ;; The LaTex style used by preview.el is mandatory to use ;; sage-view.el. It is shipped with AUCTeX. ;;; Todo: ;; - Add a auto-reveal stuff to overlays so that one can copy-cut from ;; them (use convertion from pdf to text?) ;; - Check that display is image capable ;; - Disabling sage preview should remove overlays ;; - Set color, center image, enlarge overlay to window full size ;; - Split output string according to tags (split-string) ;; - Add zoom features to overlays ;; - Add XML parser error treatment ;; - Add horizontal scrolling ;; - Make variables local, so that one can run multiple instance of SAGE ;; - Delete files ;; Bugs: ;; - Seems that latex produce buggy DVI when there are overlays... It ;; happens with large matrices of polynomials ;; - error in process filter: Wrong type argument: number-or-marker-p, nil ;; - Multiple output ;; - Numpy output can be a text array... should not be inserted into $$ ;; signs ;;; Code: (require 'sage) (defvar sage-view-head "\\documentclass{article}\\usepackage[active, tightpage, pdftex, displaymath]{preview}\\begin{document}\\begin{preview}\$") ;; it should be possible to choose the conversion technique, and ;; change pdftex to dvips (defvar sage-view-tail "\$\\end{preview}\\end{document}\n") (defvar sage-view-text "") (defvar sage-view-temp-dir nil "Name of directory for temporary files") (defvar sage-view-conversion-process nil) (defvar sage-view-conversion-buffer "*sage-view*") (defvar sage-view-anti-aliasing-level 2) (defvar sage-view-ghostscript-program "gs") (defvar sage-view-ghostscript-options (list "-sDEVICE=png16m" (concat "-dTextAlphaBits=2" sage-view-anti-aliasing-level) "-dBATCH" (concat "-dGraphicsAlphaBits=" sage-view-anti-aliasing-level) "-dSAFER" "-q" "-dNOPAUSE")) (defvar sage-view-resolution nil) (defvar sage-view-scale 1.1) (defvar sage-view-current-overlay nil) (defun sage-view-math-from-tree (string) (let* ((root (with-temp-buffer (insert string) (xml-parse-region (point-min) (point-max)))) (html (car root)) (span (car (xml-get-children html 'span))) (attrs (xml-node-attributes span)) (text (car (xml-node-children span)))) (cond ((equal (cdr (assq 'class attrs)) "math") ;; First node has class 'math' text) (t "")))) (defun sage-view-alt-math-from-tree (string) (let ((head (length "")) (tail (1+ (length "")))) (substring string head (- tail)))) (defun sage-view-preoutput-filter (string) "Set `sage-view-text' to text extracted from a tag found in string; then return this text. If string is not in XML format or there's no such tag, just return string. Function to be inserted in `comint-preoutput-filter-functions'." ;; Turn string to an xml tree (cond ((and (length string) (not (string-match inferior-sage-prompt string)) (equal (substring string 0 (min 6 (length string))) "")) ;; FIXME: string could be made of trees concatenated (setq sage-view-text (sage-view-alt-math-from-tree string)) " \n") (t string))) (defun sage-view-latex->dvi (latex) "Convert LATEX to DVI asynchronously." (setq sage-view-conversion-process (apply 'start-process (append (list "latex->dvi" sage-view-conversion-buffer "latex") (list (concat "--output-directory=" (shell-quote-argument sage-view-temp-dir)) (concat "-interaction=" (shell-quote-argument "nonstopmode")) (concat "-output-format=" (shell-quote-argument "dvi"))) (list latex)))) (set-process-sentinel sage-view-conversion-process 'sage-view-latex->dvi-sentinel) (process-put sage-view-conversion-process 'dvi-file (concat (file-name-sans-extension latex) ".dvi"))) (defun sage-view-latex->pdf (latex) "Convert LATEX to PDF asynchronously." (setq sage-view-conversion-process (apply 'start-process (append (list "latex->pdf" sage-view-conversion-buffer "latex") (list (concat "--output-directory=" (shell-quote-argument sage-view-temp-dir)) (concat "-interaction=" (shell-quote-argument "nonstopmode")) (concat "-output-format=" (shell-quote-argument "pdf"))) (list latex)))) (set-process-sentinel sage-view-conversion-process 'sage-view-latex->pdf-sentinel) (process-put sage-view-conversion-process 'pdf-file (concat (file-name-sans-extension latex) ".pdf"))) (defun sage-view-dvi->ps (dvi ps) "Convert DVI to PS asynchronously." (setq sage-view-conversion-process (start-process "dvi->ps" sage-view-conversion-buffer "dvips" "-Pwww" "-E" "-o" ps dvi)) (set-process-sentinel sage-view-conversion-process 'sage-view-dvi->ps-sentinel) (process-put sage-view-conversion-process 'ps-file ps)) (defun sage-view-pdf/ps->png (ps-pdf png) "Convert PDF-PS to PNG asynchronously." (setq sage-view-conversion-process (apply 'start-process (append (list "pdf/ps->png" sage-view-conversion-buffer sage-view-ghostscript-program) sage-view-ghostscript-options (list (concat "-sOutputFile=" png)) (list (concat "-r" (sage-view-compute-resolution))) (list ps-pdf)))) (set-process-sentinel sage-view-conversion-process 'sage-view-pdf/ps->png-sentinel) (process-put sage-view-conversion-process 'png-file png)) (defun sage-view-latex->dvi-sentinel (proc event) "If LATEX->DVI conversion was successful, convert the DVI to PS." (let* ((dvi (process-get proc 'dvi-file)) (ps (concat (file-name-sans-extension dvi) ".dvi"))) (if (string-match "finished" event) (sage-view-dvi->ps dvi ps) (overlay-put sage-view-current-overlay 'display (concat "SAGE View failed (see " (file-name-sans-extension dvi) ".log" ")"))))) (defun sage-view-latex->pdf-sentinel (proc event) "If LATEX->PDF conversion was successful, convert the PDF to PNG." (let* ((pdf (process-get proc 'pdf-file)) (png (concat (file-name-sans-extension pdf) ".png"))) (if (string-match "finished" event) (sage-view-pdf/ps->png pdf png) (overlay-put sage-view-current-overlay 'display (concat "SAGE View failed (see " (file-name-sans-extension pdf) ".log" ")"))))) (defun sage-view-dvi->ps-sentinel (proc event) "If DVI->PS conversion was successful, convert the PS to PNG." (let* ((ps (process-get proc 'ps-file)) (png (concat (file-name-sans-extension ps) ".png"))) (if (string-match "finished" event) (sage-view-pdf/ps->png ps png) (overlay-put sage-view-current-overlay 'display (concat "SAGE View failed (see " (file-name-sans-extension ps) ".log" ")"))))) (defun sage-view-pdf/ps->png-sentinel (proc event) "If PDF/PS->PNG conversion was successful, update `sage-view-current-overlay' overlay." (let ((png (process-get proc 'png-file))) (if (string-match "finished" event) (let ((image (if (and png (file-readable-p png)) (create-image png 'png)))) (cond (image (overlay-put sage-view-current-overlay 'display image) (sit-for 0)) (t (overlay-put sage-view-current-overlay 'display (concat "SAGE View failed (see " (file-name-sans-extension png) ".log" ")"))))) (overlay-put sage-view-current-overlay 'display (concat "SAGE View failed (see " (file-name-sans-extension png) ".log" ")"))))) (defun sage-view-compute-resolution () (let ((w (* sage-view-scale (/ (* 25.4 (display-pixel-width)) (display-mm-width)))) (h (* sage-view-scale (/ (* 25.4 (display-pixel-height)) (display-mm-height))))) (concat (int-to-string w) "x" (int-to-string h)))) (defun sage-view-output-filter (string) "Generate and place an overlay image. This generates the filename for the image, and use it for the region between `comint-last-output-start' and `process-mark'. Function to be inserted in `comint-output-filter-function'." (if (and string sage-view-text) (let* ((start comint-last-output-start) (end (process-mark (get-buffer-process (current-buffer))))) (setq sage-view-current-overlay (make-overlay start (- end 1) nil nil nil)) (overlay-put sage-view-current-overlay 'help-echo "Overlay made by View") (if (not (file-exists-p sage-view-temp-dir)) (make-directory sage-view-temp-dir)) (let* ((base (expand-file-name (make-temp-name "output_") sage-view-temp-dir)) (file (concat base ".tex"))) (with-temp-file file (insert sage-view-head) (insert sage-view-text) (insert sage-view-tail)) (sage-view-latex->pdf file)))) (setq sage-view-text nil)) (defun sage-view-gs-open () "Start a Ghostscript conversion pass.") (defun sage-view-pretty-print-enable () (comint-send-string (get-buffer-process (current-buffer)) "pretty_print_default()\n")) (defun sage-view-pretty-print-disable () (comint-send-string (get-buffer-process (current-buffer)) "pretty_print_default(enable=false)\n")) (define-minor-mode sage-view "With this mode, output in SAGE interactive buffers is preprocessed and texify." nil :group 'sage :lighter "(View)" (if sage-view (progn (sage-view-pretty-print-enable) (setq sage-view-text nil sage-view-temp-dir (make-temp-file (expand-file-name "tmp" "~/.sage/temp/") t)) (make-local-variable 'comint-preoutput-filter-functions) (make-local-variable 'comint-output-filter-function) (add-hook 'comint-preoutput-filter-functions 'sage-view-preoutput-filter) (add-hook 'comint-output-filter-functions 'sage-view-output-filter)) (progn (remove-hook 'comint-output-filter-functions 'sage-view-output-filter) (remove-hook 'comint-preoutput-filter-functions 'sage-view-preoutput-filter) (if (and sage-view-temp-dir (file-exists-p sage-view-temp-dir)) (dired-delete-file sage-view-temp-dir 'always)) (setq sage-view-text nil) (sage-view-pretty-print-disable)))) (provide 'sage-view) ;;; sage-view.el ends here