mirror of
https://github.com/doomemacs/doomemacs
synced 2025-08-01 12:17:25 -05:00
dac6e05b87
In the interest of slimming down Doom's core (as we near v3), I've deprecated these macros. They doesn't really need to exist. Sure, the alternatives aren't as ergonomic or elegant, but they're good enough that we don't need these trivial wrappers. Their local uses have been refactored out as well.
297 lines
12 KiB
EmacsLisp
297 lines
12 KiB
EmacsLisp
;;; lang/latex/config.el -*- lexical-binding: t; -*-
|
|
|
|
(defconst +latex-indent-item-continuation-offset 'align
|
|
"Level to indent continuation of enumeration-type environments.
|
|
|
|
I.e., this affects \\item, \\enumerate, and \\description.
|
|
|
|
Set this to `align' for:
|
|
|
|
\\item lines aligned
|
|
like this.
|
|
|
|
Set to `auto' for continuation lines to be offset by `LaTeX-indent-line':
|
|
|
|
\\item lines aligned
|
|
like this, assuming `LaTeX-indent-line' == 2
|
|
|
|
Any other fixed integer will be added to `LaTeX-item-indent' and the current
|
|
indentation level.
|
|
|
|
Set this to `nil' to disable all this behavior.
|
|
|
|
You'll need to adjust `LaTeX-item-indent' to control indentation of \\item
|
|
itself.")
|
|
|
|
(defvar +latex-enable-unicode-math nil
|
|
"If non-nil, use `company-math-symbols-unicode' backend in `LaTeX-mode',
|
|
enabling unicode symbols in math regions. This requires the unicode-math LaTeX
|
|
package to be installed.")
|
|
|
|
(defvar +latex-viewers '(skim evince sumatrapdf zathura okular pdf-tools)
|
|
"A list of enabled LaTeX viewers to use, in this order. If they don't exist,
|
|
they will be ignored. Recognized viewers are skim, evince, sumatrapdf, zathura,
|
|
okular and pdf-tools.
|
|
|
|
If no viewer is found, `latex-preview-pane-mode' is used.")
|
|
|
|
;;
|
|
(defvar +latex--company-backends nil)
|
|
|
|
|
|
;;
|
|
;; Packages
|
|
|
|
;; HACK: Doom sets `custom-dont-initialize' during the early parts of its
|
|
;; startup process. This stops tex-site's setter on `TeX-modes' from
|
|
;; activating in `tex-site', which auctex loads *very early* from its
|
|
;; autoloads file. `tex-site's existence is hacky (more a historical artifact
|
|
;; and necessary evil, given its conflicts with the built in latex modes), so
|
|
;; I fix it as a one-off problem rather than a systemic one.
|
|
(after! tex-site
|
|
(TeX-modes-set 'TeX-modes TeX-modes))
|
|
|
|
|
|
(setq TeX-parse-self t ; parse on load
|
|
TeX-auto-save t ; parse on save
|
|
;; Use hidden directories for AUCTeX files.
|
|
TeX-auto-local ".auctex-auto"
|
|
TeX-style-local ".auctex-style"
|
|
TeX-source-correlate-mode t
|
|
TeX-source-correlate-method 'synctex
|
|
;; Don't start the Emacs server when correlating sources.
|
|
TeX-source-correlate-start-server nil
|
|
;; Automatically insert braces after sub/superscript in `LaTeX-math-mode'.
|
|
TeX-electric-sub-and-superscript t
|
|
;; Just save, don't ask before each compilation.
|
|
TeX-save-query nil)
|
|
|
|
|
|
(after! tex
|
|
;; Fontify common LaTeX commands.
|
|
(load! "+fontification")
|
|
;; Select viewer.
|
|
(load! "+viewers")
|
|
;; Do not prompt for a master file.
|
|
(setq-default TeX-master t)
|
|
;; Set-up chktex.
|
|
(setcar (cdr (assoc "Check" TeX-command-list)) "chktex -v6 -H %s")
|
|
(setq-hook! 'TeX-mode-hook
|
|
;; Tell Emacs how to parse TeX files.
|
|
ispell-parser 'tex
|
|
;; Don't auto-fill in math blocks.
|
|
fill-nobreak-predicate (cons #'texmathp fill-nobreak-predicate))
|
|
;; Enable word wrapping.
|
|
(add-hook 'TeX-mode-hook #'visual-line-mode)
|
|
;; Enable `rainbow-mode' after applying styles to the buffer.
|
|
(add-hook 'TeX-update-style-hook #'rainbow-delimiters-mode)
|
|
;; Display output of LaTeX commands in a popup.
|
|
(set-popup-rules! '((" output\\*$" :size 15)
|
|
("^\\*TeX \\(?:Help\\|errors\\)"
|
|
:size 0.3 :select t :ttl nil)))
|
|
(after! smartparens-latex
|
|
;; We have to use lower case modes here, because `smartparens-mode' uses
|
|
;; the same during configuration.
|
|
(let ((modes '(tex-mode plain-tex-mode latex-mode LaTeX-mode)))
|
|
;; All these excess pairs dramatically slow down typing in LaTeX buffers,
|
|
;; so we remove them. Let snippets do their job.
|
|
(dolist (open '("\\left(" "\\left[" "\\left\\{" "\\left|"
|
|
"\\bigl(" "\\biggl(" "\\Bigl(" "\\Biggl(" "\\bigl["
|
|
"\\biggl[" "\\Bigl[" "\\Biggl[" "\\bigl\\{" "\\biggl\\{"
|
|
"\\Bigl\\{" "\\Biggl\\{"
|
|
"\\lfloor" "\\lceil" "\\langle"
|
|
"\\lVert" "\\lvert" "`"))
|
|
(sp-local-pair modes open nil :actions :rem))
|
|
;; And tweak these so that users can decide whether they want use LaTeX
|
|
;; quotes or not, via `+latex-enable-plain-double-quotes'.
|
|
(sp-local-pair modes "``" nil :unless '(:add sp-in-math-p))))
|
|
;; Hook LSP, if enabled.
|
|
(when (modulep! +lsp)
|
|
(add-hook! '(tex-mode-local-vars-hook
|
|
latex-mode-local-vars-hook
|
|
LaTeX-mode-local-vars-hook)
|
|
:append #'lsp!))
|
|
;; Define a function to compile the project.
|
|
(defun +latex/compile ()
|
|
(interactive)
|
|
(TeX-save-document (TeX-master-file))
|
|
(TeX-command TeX-command-default 'TeX-master-file -1))
|
|
(map! :localleader
|
|
:map latex-mode-map
|
|
:desc "View" "v" #'TeX-view
|
|
:desc "Compile" "c" #'+latex/compile
|
|
:desc "Run all" "a" #'TeX-command-run-all
|
|
:desc "Run a command" "m" #'TeX-command-master)
|
|
(map! :after latex
|
|
:localleader
|
|
:map LaTeX-mode-map
|
|
:desc "View" "v" #'TeX-view
|
|
:desc "Compile" "c" #'+latex/compile
|
|
:desc "Run all" "a" #'TeX-command-run-all
|
|
:desc "Run a command" "m" #'TeX-command-master)
|
|
|
|
;; HACK: The standard LaTeXMk command uses `TeX-run-format', which doesn't
|
|
;; trigger `TeX-after-compilation-finished-functions', so swap it out for
|
|
;; `TeX-run-TeX', which does.
|
|
(defadvice! +latex--run-after-compilation-finished-functions-a (&rest args)
|
|
:after #'TeX-TeX-sentinel
|
|
(unless (TeX-error-report-has-errors-p)
|
|
(run-hook-with-args 'TeX-after-compilation-finished-functions
|
|
(with-current-buffer TeX-command-buffer
|
|
(expand-file-name
|
|
(TeX-active-master (TeX-output-extension))))))))
|
|
|
|
|
|
(use-package! tex-fold
|
|
:when (modulep! +fold)
|
|
:hook (TeX-mode . +latex-TeX-fold-buffer-h)
|
|
:hook (TeX-mode . TeX-fold-mode)
|
|
:config
|
|
;; Reveal folds when moving cursor into them. This saves us the trouble of
|
|
;; having to whitelist all motion commands in `TeX-fold-auto-reveal-commands'.
|
|
(setq TeX-fold-auto-reveal t)
|
|
(defun +latex-TeX-fold-buffer-h ()
|
|
(run-with-idle-timer 0 nil 'TeX-fold-buffer))
|
|
;; Fold after all AUCTeX macro insertions.
|
|
(advice-add #'TeX-insert-macro :after #'+latex-fold-last-macro-a)
|
|
;; Fold after CDLaTeX macro insertions.
|
|
(advice-add #'cdlatex-math-symbol :after #'+latex-fold-last-macro-a)
|
|
(advice-add #'cdlatex-math-modify :after #'+latex-fold-last-macro-a)
|
|
;; Fold after snippets.
|
|
(when (modulep! :editor snippets)
|
|
(add-hook! 'TeX-fold-mode-hook
|
|
(defun +latex-fold-snippet-contents-h ()
|
|
(add-hook! 'yas-after-exit-snippet-hook :local
|
|
(when (and yas-snippet-beg yas-snippet-end)
|
|
(TeX-fold-region yas-snippet-beg yas-snippet-end))))))
|
|
|
|
(add-hook! 'mixed-pitch-mode-hook
|
|
(defun +latex-fold-set-variable-pitch-h ()
|
|
"Fix folded things invariably getting fixed pitch when using mixed-pitch.
|
|
Math faces should stay fixed by the mixed-pitch blacklist, this is mostly for
|
|
\\section etc."
|
|
(when mixed-pitch-mode
|
|
;; Adding to this list makes mixed-pitch clean the face remaps after us
|
|
(add-to-list 'mixed-pitch-fixed-cookie
|
|
(face-remap-add-relative
|
|
'TeX-fold-folded-face
|
|
:family (face-attribute 'variable-pitch :family)
|
|
:height (face-attribute 'variable-pitch :height))))))
|
|
|
|
(map! :map TeX-fold-mode-map
|
|
:localleader
|
|
:desc "Fold paragraph" "f" #'TeX-fold-paragraph
|
|
:desc "Unfold paragraph" "F" #'TeX-fold-clearout-paragraph
|
|
:desc "Unfold buffer" "C-f" #'TeX-fold-clearout-buffer))
|
|
|
|
|
|
(after! latex
|
|
;; Add the TOC entry to the sectioning hooks.
|
|
(setq LaTeX-section-hook
|
|
'(LaTeX-section-heading
|
|
LaTeX-section-title
|
|
LaTeX-section-toc
|
|
LaTeX-section-section
|
|
LaTeX-section-label)
|
|
LaTeX-fill-break-at-separators nil
|
|
LaTeX-item-indent 0)
|
|
(when +latex--company-backends
|
|
(set-company-backend! 'latex-mode +latex--company-backends))
|
|
|
|
;; Provide proper indentation for LaTeX "itemize", "enumerate", and
|
|
;; "description" environments. See
|
|
;; http://emacs.stackexchange.com/questions/3083/how-to-indent-items-in-latex-auctex-itemize-environments.
|
|
;; Set `+latex-indent-item-continuation-offset' to 0 to disable this.
|
|
(dolist (env '("itemize" "enumerate" "description"))
|
|
(add-to-list 'LaTeX-indent-environment-list `(,env +latex-indent-item-fn)))
|
|
|
|
;; Fix #1849: allow fill-paragraph in itemize/enumerate/description.
|
|
(defadvice! +latex--re-indent-itemize-and-enumerate-and-description-a (fn &rest args)
|
|
:around #'LaTeX-fill-region-as-para-do
|
|
(let ((LaTeX-indent-environment-list
|
|
(append LaTeX-indent-environment-list
|
|
'(("itemize" +latex-indent-item-fn)
|
|
("enumerate" +latex-indent-item-fn)
|
|
("description" +latex-indent-item-fn)))))
|
|
(apply fn args)))
|
|
(defadvice! +latex--dont-indent-itemize-and-enumerate-and-description-a (fn &rest args)
|
|
:around #'LaTeX-fill-region-as-paragraph
|
|
(let ((LaTeX-indent-environment-list LaTeX-indent-environment-list))
|
|
(dolist (item '("itemize" "enumerate" "description"))
|
|
(setf (alist-get item LaTeX-indent-environment-list nil t #'equal) nil))
|
|
(apply fn args))))
|
|
|
|
|
|
(use-package! preview
|
|
:hook (LaTeX-mode . LaTeX-preview-setup)
|
|
:config
|
|
(setq-default preview-scale 1.4
|
|
preview-scale-function
|
|
(lambda () (* (/ 10.0 (preview-document-pt)) preview-scale)))
|
|
;; Don't cache preamble, it creates issues with SyncTeX. Let users enable
|
|
;; caching if they have compilation times that long.
|
|
(setq preview-auto-cache-preamble nil)
|
|
(map! :map LaTeX-mode-map
|
|
:localleader
|
|
:desc "Preview" "p" #'preview-at-point
|
|
:desc "Unpreview" "P" #'preview-clearout-at-point))
|
|
|
|
|
|
(use-package! cdlatex
|
|
:when (modulep! +cdlatex)
|
|
:hook (LaTeX-mode . cdlatex-mode)
|
|
:hook (org-mode . org-cdlatex-mode)
|
|
:config
|
|
;; Use \( ... \) instead of $ ... $.
|
|
(setq cdlatex-use-dollar-to-ensure-math nil)
|
|
;; Disabling keys that have overlapping functionality with other parts of Doom.
|
|
(map! :map cdlatex-mode-map
|
|
;; Smartparens takes care of inserting closing delimiters, and if you
|
|
;; don't use smartparens you probably don't want these either.
|
|
"$" nil
|
|
"(" nil
|
|
"{" nil
|
|
"[" nil
|
|
"|" nil
|
|
"<" nil
|
|
;; TAB is used for CDLaTeX's snippets and navigation. But we have
|
|
;; Yasnippet for that.
|
|
(:when (modulep! :editor snippets)
|
|
"TAB" nil)
|
|
;; AUCTeX takes care of auto-inserting {} on _^ if you want, with
|
|
;; `TeX-electric-sub-and-superscript'.
|
|
"^" nil
|
|
"_" nil
|
|
;; AUCTeX already provides this with `LaTeX-insert-item'.
|
|
[(control return)] nil))
|
|
|
|
|
|
;; Nicely indent lines that have wrapped when visual line mode is activated.
|
|
(use-package! adaptive-wrap
|
|
:hook (LaTeX-mode . adaptive-wrap-prefix-mode)
|
|
:init (setq-default adaptive-wrap-extra-indent 0))
|
|
|
|
|
|
(use-package! evil-tex
|
|
:when (modulep! :editor evil +everywhere)
|
|
:hook (LaTeX-mode . evil-tex-mode))
|
|
|
|
|
|
(use-package! company-auctex
|
|
:when (modulep! :completion company)
|
|
:defer t
|
|
:init
|
|
(add-to-list '+latex--company-backends #'company-auctex-environments nil #'eq)
|
|
(add-to-list '+latex--company-backends #'company-auctex-macros nil #'eq))
|
|
|
|
|
|
(use-package! company-math
|
|
:when (modulep! :completion company)
|
|
:defer t
|
|
:init
|
|
(add-to-list '+latex--company-backends #'+latex-symbols-company-backend nil #'eq))
|
|
|
|
|
|
;; BibTeX + RefTeX.
|
|
(load! "+ref")
|