1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
;;; latex-preview-pane.el --- Makes LaTeX editing less painful by providing a updatable preview pane
;; Copyright (C) 2015 John L. Singleton <jsinglet@gmail.com>
;; Author: John L. Singleton <jsinglet@gmail.com>
;; Keywords: latex, preview
;; Version: 20151021
;; URL: http://www.emacswiki.org/emacs/LaTeXPreviewPane
;;; Commentary:
;; latex-preview-pane is a minor mode for Emacs that enables you to preview your LaTeX files directly in Emacs.
;; It supports PDF previews, your choice of pdflatex or xelatex, and it highlights errors in your LaTeX buffer.
;;
;; To enable, place the following in your .emacs file:
;;
;; (latex-preview-pane-enable)
;;
;; As an alternative, you may enable it on the fly with:
;;
;; M-x latex-preview-pane-mode
;;
;; The latest version of latex-preview-pane can always be found at
;; https://github.com/jsinglet/latex-preview-pane
;;
;; You can find the documentation for latex-preview-pane either on GitHub (above) or
;; on EmacsWiki at: http://www.emacswiki.org/emacs/LaTeXPreviewPane
;;; License:
;; 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 <http://www.gnu.org/licenses/>.
;;; Code:
(require 'doc-view)
(require 'cl-lib)
(defvar latex-preview-pane-current-version "20151021")
;;
;; Get rid of free variables warnings
;;
(defvar message-latex-preview-pane-welcome)
(defvar message-no-preview-yet)
;;;###autoload
(defun latex-preview-pane-enable ()
"Enable `latex-preview-pane-mode' in `latex-mode'."
(add-hook 'latex-mode-hook (lambda () (latex-preview-pane-mode 1))))
(defun lpp/window-containing-preview ()
(let (windows i docViewWindow)
(setq windows (cl-reduce #'append (mapcar `window-list (frame-list))))
(setq i 0)
(progn
(while (and (not docViewWindow) (<= i (length windows)))
(let ((currentWindow (pop windows)))
(if (window-parameter currentWindow 'is-latex-preview-pane)
(setq docViewWindow currentWindow)
))
(setq i (1+ i))
)
docViewWindow)))
;;
;; Init procedure:
;; 1) Find a window with doc-view-mode turned on in this frame.
;; 2) If no such window can be found, split this window vertically.
;; 2a) Display startup message, shortcuts, etc. Pause for 3 seconds.
;; 3) TeX the current file. (that is, start the refresh loop)
;;
;;;###autoload
(defun init-latex-preview-pane ()
(progn
;; make sure the current window isn't the preview pane
(set-window-parameter nil 'is-latex-preview-pane nil)
(if (eq (lpp/window-containing-preview) nil)
;; tag the newly created window
(set-window-parameter
(if latex-preview-pane-use-frame
(car (window-list (make-frame)))
(split-window nil nil preview-orientation))
'is-latex-preview-pane t))
(lpp/display-startup (lpp/window-containing-preview))
;; add the save hook
(add-hook 'after-save-hook 'latex-preview-pane-update nil 'make-it-local)
;; refresh that pane
(run-at-time "0 min 3 sec" nil 'latex-preview-pane-update)
)
)
(defun lpp/get-message (f)
(with-temp-buffer
(insert-file-contents f)
(buffer-string)))
(defun lpp/display-startup (where)
(let ((old-buff (current-buffer)))
(progn
(set-window-buffer where (get-buffer-create "*Latex Preview Pane Welcome*"))
(set-buffer (get-buffer "*Latex Preview Pane Welcome*"))
(erase-buffer)
(insert message-latex-preview-pane-welcome)
(set-buffer old-buff)
)))
;;
;; System specific configuration.
;;
(defvar lpp/view-buffer-command
(pcase system-type
(`windows-nt "start")
(`darwin "open")
(`gnu/linux "xdg-open")
(`gnu/kfreebsd "xdg-open"))
"Command used to view a file with the system's native tools.")
;;
;; Updates an external preview program of the current latex file
;;
;;;###autoload
(defun latex-preview-update ()
(interactive)
(let ( (pdf-file (replace-regexp-in-string "\.tex$" ".pdf" (lpp/buffer-file-name))))
(if (not (file-exists-p pdf-file))
(message (concat "File " pdf-file " does not exist. Save your current buffer to generate it."))
(if (eq system-type 'windows-nt)
(w32-shell-execute "open" pdf-file nil nil)
(start-process "Preview"
(get-buffer-create "*pdflatex-buffer*")
lpp/view-buffer-command
(replace-regexp-in-string "\.tex$" ".pdf" (lpp/buffer-file-name))
)))))
;;
;; If a preview pane is open, updates the preview pane on save.
;;
;;;###autoload
(defun latex-preview-pane-update ()
(interactive)
(when (and (boundp 'latex-preview-pane-mode) latex-preview-pane-mode)
(if (eq (lpp/window-containing-preview) nil)
(init-latex-preview-pane)
(progn
(if (not (eq (get-buffer "*pdflatex-buffer*") nil))
(let ((old-buff (current-buffer)))
(progn
(set-buffer "*pdflatex-buffer*")
(erase-buffer)
(set-buffer old-buff)
)))
(message "Updating LaTeX Preview Pane")
(latex-preview-pane-update-p)))))
(defun lpp/last-backtrace ()
(let ((old-buff (current-buffer)))
(set-buffer (get-buffer "*pdflatex-buffer*"))
(let ((error-msg (buffer-substring (point-min) (point-max))))
(set-buffer old-buff)
(mapconcat 'identity (reverse (split-string error-msg "\n")) "\n"))))
(defun latex-pp-filter (condp lst)
(delq nil
(mapcar (lambda (x) (and (funcall condp x) x)) lst)))
(defface bad-face
'((t (:foreground "White" :background "Red")))
"Face for errors"
:group 'latex-preview-pane)
(defun lpp/chomp (str)
"Chomp leading and tailing whitespace from STR."
(while (string-match "\\`\n+\\|^\\s-+\\|\\s-+$\\|\n+\\'"
str)
(setq str (replace-match "" t t str)))
str)
(defun lpp/line-errors ()
(let ((old-buff (current-buffer)))
(set-buffer (get-buffer "*pdflatex-buffer*"))
(let ((error-msg (buffer-substring (point-min) (point-max))))
(set-buffer old-buff)
;; get all the line numbers.
(mapcar (lambda (what) (lpp/chomp (substring what 2))) (latex-pp-filter (lambda (what) (eq (string-match "l\\.[0-9]*" what) 0)) (split-string error-msg "\n"))))))
(defun lpp/line-errors-to-layovers (errors)
(mapcar (lambda (what) (let ( (line (string-to-number what)))
(let (layoverStart layoverEnd)
(goto-char (point-min)) (forward-line (1- line))
(setq layoverStart (point))
(setq layoverEnd (+ 1 (line-end-position)))
;;(message (format "Adding Layover On Line: %d, Start: %d, End: %d" line layoverStart layoverEnd))
;; create the layover
(overlay-put (make-overlay layoverStart layoverEnd) 'face 'bad-face)))) errors))
(defun lpp/display-backtrace ()
(let ((old-buff (current-buffer)))
(progn
(set-window-buffer (lpp/window-containing-preview) (get-buffer-create "*Latex Preview Pane Errors*"))
(set-buffer (get-buffer "*Latex Preview Pane Errors*"))
(erase-buffer)
(insert message-no-preview-yet)
(set-buffer (get-buffer "*Latex Preview Pane Errors*"))
(insert (lpp/last-backtrace))
(set-buffer old-buff)
)))
(boundp 'TeX-master)
(defun lpp/is-tex (string)
(and (string-match (rx-to-string `(: ,".tex" eos) t)
string)
t))
(defun lpp/auctex-buffer-file-name ()
(cond
((eq (boundp 'TeX-master) nil) (message "The TeX master variable is not defined. To use this mode you must be using AUCTeX on this buffer."))
((eq TeX-master nil) (message "AUCTeX is enabled but TeX-master is not yet set. Please set it."))
((eq TeX-master t) buffer-file-name)
(t (if (lpp/is-tex TeX-master) TeX-master (concat TeX-master ".tex")))
)
)
(defun lpp/get-file ()
"Prompt user to enter a file path, with file name completion and input history support."
(read-file-name "Location of Master TeX File:"))
(defun lpp/prompt-and-save-buffer-file-name ()
(progn
(cond
((eq (boundp 'lpp-TeX-master) nil) (set (make-local-variable 'lpp-TeX-master) (lpp/get-file)))
((eq lpp-TeX-master nil) (set (make-local-variable 'lpp-TeX-master) (lpp/get-file)))
)
(if (lpp/is-tex lpp-TeX-master) lpp-TeX-master (concat lpp-TeX-master ".tex"))))
(defun lpp/buffer-file-name ()
(if (eq latex-preview-pane-multifile-mode 'off) buffer-file-name
(if (eq latex-preview-pane-multifile-mode 'auctex) (lpp/auctex-buffer-file-name)
(lpp/prompt-and-save-buffer-file-name)))
)
;;
;; Take a string like "../main" and extract: the path leading UP
;;
(defun lpp/invoke-pdf-latex-command ()
(let ((buff (expand-file-name (lpp/buffer-file-name))) (default-directory (file-name-directory (expand-file-name (lpp/buffer-file-name)))))
(if shell-escape-mode
(call-process pdf-latex-command nil "*pdflatex-buffer*" nil shell-escape-mode buff)
(call-process pdf-latex-command nil "*pdflatex-buffer*" nil buff)
)
)
)
;;;###autoload
(defun latex-preview-pane-update-p ()
(if (eq (lpp/invoke-pdf-latex-command) 1)
(progn
(lpp/display-backtrace)
(remove-overlays)
(lpp/line-errors-to-layovers (lpp/line-errors))
)
(let ((pdf-filename (replace-regexp-in-string "\.tex$" ".pdf" (lpp/buffer-file-name)))
(tex-buff (current-buffer))
(pdf-buff-name (replace-regexp-in-string "\.tex" ".pdf" (buffer-name (get-file-buffer (lpp/buffer-file-name))))))
(remove-overlays)
;; if the file doesn't exist, say that the file isn't available due to error messages
(if (file-exists-p pdf-filename)
(if (eq (get-buffer pdf-buff-name) nil)
(let ((pdf-buff (find-file-noselect pdf-filename 'nowarn)))
(buffer-disable-undo pdf-buff)
(set-window-buffer (lpp/window-containing-preview) pdf-buff))
(progn
(set-window-buffer (lpp/window-containing-preview) pdf-buff-name)
(with-current-buffer pdf-buff-name (doc-view-revert-buffer nil t))
))
))))
;;
;; Mode definition
;;
(defvar latex-preview-pane-mode-map (make-keymap) "Latex preview pane keymap")
(defun lpp/set-multifile-mode (mode) (progn
(customize-set-variable 'latex-preview-pane-multifile-mode mode)
(set (make-local-variable 'lpp-TeX-master) nil)
))
(easy-menu-define words-menu latex-preview-pane-mode-map
"Menu for working with Latex Preview Pane"
'("LaTeX Preview Pane"
["LaTeX Preview Pane Actions" nil :active nil]
["Refresh Preview" latex-preview-pane-update]
["Open Preview in External Viewer" latex-preview-update]
["Disable LaTeX Preview Pane in this Buffer" (latex-preview-pane-mode 'toggle)]
["Customize LaTeX Preview Pane" (customize-group 'latex-preview-pane)]
["--" nil]
["Multi-File Mode" nil :active nil]
["Off" (lpp/set-multifile-mode 'off) :style radio :selected (eq latex-preview-pane-multifile-mode 'off)]
["Use AUCTeX/TeX-master" (lpp/set-multifile-mode 'auctex) :style radio :selected (eq latex-preview-pane-multifile-mode 'auctex)]
["Prompt" (lpp/set-multifile-mode 'prompt) :style radio :selected (eq latex-preview-pane-multifile-mode 'prompt)]
))
(define-key latex-preview-pane-mode-map (kbd "M-p") 'latex-preview-pane-update)
(define-key latex-preview-pane-mode-map (kbd "s-p") 'latex-preview-pane-update)
(define-key latex-preview-pane-mode-map (kbd "M-P") 'latex-preview-update)
(define-key latex-preview-pane-mode-map (kbd "s-P") 'latex-preview-update)
;;;###autoload
(define-minor-mode latex-preview-pane-mode
"Toggle Latex Preview Pane Mode.
Interactively with no argument, this command toggles the mode.
A positive prefix argument enables the mode, any other prefix
argument disables it. From Lisp, argument omitted or nil enables
the mode, `toggle' toggles the state.
When Latex Preview Pane mode is enabled, saving a latex file will cause
a PDF preview pane of your document to appear."
;; The initial value.
:init-value nil
;; The indicator for the mode line.
:lighter " Latex Preview Pane"
;; The minor mode bindings.
:keymap latex-preview-pane-mode-map
:group 'latex-preview-pane
;; if we are turning on the mode, init the view
(if (and (boundp 'latex-preview-pane-mode) latex-preview-pane-mode)
(init-latex-preview-pane)
;; otherwise, kill the window
(delete-window (lpp/window-containing-preview))
))
;; set some messages for later
(let ((installation-dir (if load-file-name (file-name-as-directory (file-name-directory load-file-name)) nil)))
(defvar message-latex-preview-pane-welcome (lpp/get-message (expand-file-name "message-latex-preview-pane-welcome.txt" installation-dir)))
(defvar message-no-preview-yet (lpp/get-message (expand-file-name "message-no-preview-yet.txt" installation-dir))))
(defgroup latex-preview-pane nil
"Settings that are used in the Latex Preview Pane"
:group 'latex-preview-pane)
(defcustom pdf-latex-command "pdflatex"
"The command to produce a PDF file from a latex document."
:type 'string
:group 'latex-preview-pane)
(defcustom shell-escape-mode nil
"Should the pdflatex command use shell escaping?"
:type '(choice (const :tag "Use shell escaping (-shell-escape)" "-shell-escape")
(const :tag "Do not use shell escaping" nil)
)
:group 'latex-preview-pane)
(defcustom preview-orientation 'right
"Which orientation to display the preview pane. Valid values are above, below, left, or right. Defaults to value right."
:type '(choice (const :tag "Display preview on right" right)
(const :tag "Display preview on left" left)
(const :tag "Display preview above" above)
(const :tag "Display preview below" below)
)
:group 'latex-preview-pane)
(defcustom latex-preview-pane-multifile-mode 'off
"LaTeX Preview Pane can support multifile TeX projects. This variable tells LPP how to behave in different situations."
:type '(choice (const :tag "Off" off)
(const :tag "Use AUCTeX (via the TeX-master variable)" auctex)
(const :tag "Prompt" prompt)
)
:group 'latex-preview-pane)
(defcustom latex-preview-pane-use-frame nil
"If set, LaTeX Preview Pane will show preview in a new frame"
:type 'boolean
:group 'latex-preview-pane)
;;
;; Some utility functions
;;
(defun lpp/packing-list ()
'("README"
"README.md"
"latex-preview-pane-pkg.el"
"latex-preview-pane.el"
"message-latex-preview-pane-welcome.txt"
"message-no-preview-yet.txt"
"ss-error.PNG"
"ss.PNG")
)
;; for making distributions
(defun lpp/make-dist ()
(let ((dist-dir (concat "latex-preview-pane-" latex-preview-pane-current-version)))
(let ((dist-file (concat dist-dir ".tar")))
;; (call-process "rm" nil "*dist-buffer*" nil ("-fr" dist-dir))
(call-process "mkdir" nil "*dist-buffer*" nil dist-dir)
;; copy it over
(mapc (lambda (f)
(progn
(message (concat "Copying " f "..."))
(call-process "cp" nil "*dist-buffer*" nil f dist-dir)
))
(lpp/packing-list))
(call-process "tar" nil "*dist-buffer*" nil "-cvf" dist-file (concat dist-dir "/"))
(message (concat "Package " dist-file " created."))
)
))
;; (lpp/make-dist)
(provide 'latex-preview-pane)
;;; latex-preview-pane.el ends here
|
