d41cff489f
* module: add :input bidi Co-authored-by: Yoav Marco <yoavm448@gmail.com> * docs(bidi): flesh out README.org Co-authored-by: Itai Y. Efrat <itai3397@gmail.com> * feat(bidi): add +bidi-global-mode * docs(bidi): improve font setting instructions * feat(bidi): add +bidi-(hebrew|arabic)-font Since the Hebrew and Arabic unicode blocks cover the vast majority of RTL languages used today, we provide these fonts so end users don't have to bother with setting up the hooks themselves. * feat(bidi): add smart fontify Adds support for using the bidi fonts on surrounding whitespace and punctuation through. On by default, customizable through +bidi-want-smart-fontify and +bidi-smart-fontify-keywords. Also adds face versions of the bidi fonts. * docs(bidi): recommend known good nastaliq fonts * fix(bidi): re-set bidi faces after changing fonts * feat(bidi): add +bidi-paragraph-direction This allows users to choose what bidi-paragraph-direction is set to when +bidi-mode is on, so they can choose if they want per paragraph alignment (the default) or to force everything to be aligned RTL * docs(bidi): conform to verbatim/code conventions * docs(bidi): add font overview to Features * docs(bidi): warn on rtl forced alignment footgun +bidi-paragraph-direction is a nice variable to have if you primarily use +bidi-mode for rtl text buffers, but it shouldn't be used in conjunction with +bidi-global-mode since it messes up English buffers. Co-authored-by: Yoav Marco <yoavm448@gmail.com>
94 lines
3.6 KiB
EmacsLisp
94 lines
3.6 KiB
EmacsLisp
;;; input/bidi/config.el -*- lexical-binding: t; -*-
|
|
|
|
(defvar +bidi-mode-map (make-sparse-keymap)
|
|
"Keymap for `+bidi-mode'.")
|
|
|
|
(defvar +bidi-hebrew-font (font-spec :family "DejaVu Sans")
|
|
"Overriding font for hebrew script.
|
|
Must be a `font-spec', see `doom-font' for examples.
|
|
|
|
WARNING: if you specify a size for this font it will hard-lock any usage of this
|
|
font to that size. It's rarely a good idea to do so!")
|
|
|
|
(defface +bidi-hebrew-face `((t :font ,+bidi-hebrew-font)) "")
|
|
|
|
(defvar +bidi-arabic-font (font-spec :family "DejaVu Sans")
|
|
"Overriding font for arabic and arabic-derived scripts.
|
|
Must be a `font-spec', see `doom-font' for examples.
|
|
|
|
WARNING: if you specify a size for this font it will hard-lock any usage of this
|
|
font to that size. It's rarely a good idea to do so!")
|
|
|
|
(defface +bidi-arabic-face `((t :font ,+bidi-arabic-font)) "")
|
|
|
|
(defcustom +bidi-want-smart-fontify t
|
|
"Use bidi override fonts on surrounding space and punctuation as well.
|
|
Add `+bidi-smart-fontify-keywords' to `font-lock-keywords' on editable buffers
|
|
when `+bidi-mode' is on."
|
|
:type 'boolean)
|
|
|
|
(defvar +bidi-smart-fontify-keywords
|
|
`((,(rx (any (#x0590 . #x05FF)) ; Hebrew
|
|
(group (one-or-more (any " " punctuation))))
|
|
(1 '+bidi-hebrew-face t))
|
|
(,(rx (or (any (#x0600 . #x06FF)) ; Arabic
|
|
(any (#x0750 . #x077F)) ; Arabic Supplement
|
|
(any (#x0870 . #x089F)) ; Arabic Extended-B
|
|
(any (#x08A0 . #x08FF))) ; Arabic Extended-A
|
|
(group (one-or-more (any " " punctuation))))
|
|
(1 '+bidi-arabic-face t)))
|
|
|
|
"`font-lock' keywords matching spaces and punctuation after RTL characters.
|
|
See the variable `font-lock-keywords' for information on the format.")
|
|
|
|
(defcustom +bidi-paragraph-direction nil
|
|
"The value of `bidi-paragragh-direction' when `+bidi-mode' is on.
|
|
See the `bidi-paragraph-direction' for more info.
|
|
|
|
Warning: do not change this if you are using `+bidi-global-mode'.'"
|
|
:type '(choice
|
|
(const :tag "Left to Right" left-to-right)
|
|
(const :tag "Right to Left" right-to-left)
|
|
(const :tag "Dynamic, according to paragraph text" nil)))
|
|
|
|
;;;###autoload
|
|
(define-minor-mode +bidi-mode
|
|
"Minor mode for using bidirectional text in a buffer.
|
|
|
|
Note that the whole buffer doesn't have to contain any
|
|
bidirectional text at all, this mode just makes bidi editing
|
|
easier."
|
|
:keymap +bidi-mode-map
|
|
(if +bidi-mode
|
|
(progn
|
|
(setq bidi-paragraph-direction +bidi-paragraph-direction ; Better paragraph alignment
|
|
bidi-paragraph-separate-re "^" ; No need for empty lines to switch alignment
|
|
bidi-paragraph-start-re "^" ; ^
|
|
bidi-inhibit-bpa nil) ; Better bidi paren logic
|
|
(when (and +bidi-want-smart-fontify
|
|
(not buffer-read-only))
|
|
(font-lock-add-keywords
|
|
nil
|
|
+bidi-smart-fontify-keywords
|
|
'append)
|
|
(font-lock-flush)))
|
|
(setq bidi-paragraph-direction 'left-to-right
|
|
bidi-paragraph-separate-re nil
|
|
bidi-paragraph-start-re nil
|
|
bidi-inhibit-bpa t)
|
|
(when (and +bidi-want-smart-fontify
|
|
(not buffer-read-only))
|
|
(font-lock-remove-keywords
|
|
nil
|
|
+bidi-smart-fontify-keywords)
|
|
(font-lock-flush))))
|
|
|
|
(define-globalized-minor-mode +bidi-global-mode +bidi-mode +bidi-mode)
|
|
|
|
(add-hook! 'after-setting-font-hook
|
|
(defun +bidi-set-fonts-h ()
|
|
(set-fontset-font t 'hebrew +bidi-hebrew-font)
|
|
(set-fontset-font t 'arabic +bidi-arabic-font)
|
|
(set-face-font '+bidi-arabic-face +bidi-arabic-font)
|
|
(set-face-font '+bidi-hebrew-face +bidi-hebrew-font)))
|