-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjinx.el
1172 lines (1049 loc) · 46.8 KB
/
jinx.el
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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; jinx.el --- Enchanted Spell Checker -*- lexical-binding: t -*-
;; Copyright (C) 2023-2025 Free Software Foundation, Inc.
;; Author: Daniel Mendler <mail@daniel-mendler.de>
;; Maintainer: Daniel Mendler <mail@daniel-mendler.de>
;; Created: 2023
;; Version: 2.0
;; Package-Requires: ((emacs "28.1") (compat "30"))
;; URL: https://github.com/minad/jinx
;; Keywords: convenience, text
;; This file is part of GNU Emacs.
;; 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Jinx is a fast just-in-time spell-checker for Emacs. Jinx
;; highlights misspelled words in the text of the visible portion of
;; the buffer. For efficiency, Jinx highlights misspellings lazily,
;; recognizes window boundaries and text folding, if any. For
;; example, when unfolding or scrolling, only the newly visible part
;; of the text is checked if it has not been checked before. Each
;; misspelling can be corrected from a list of dictionary words
;; presented as a completion menu.
;; Installing Jinx is straight-forward and configuring should not need
;; much intervention. Jinx can be used completely on its own, but can
;; also safely co-exist with Emacs's built-in spell-checker Ispell.
;; Jinx's high performance and low resource usage comes from directly
;; calling the API of the Enchant library, see
;; https://rrthomas.github.io/enchant/. Jinx automatically compiles
;; jinx-mod.c and loads the dynamic module at startup. By binding
;; directly to the native Enchant API, Jinx avoids slower
;; inter-process communication.
;; See the manual for further information.
;;; Code:
(require 'compat)
(eval-when-compile
(require 'cl-lib)
(require 'subr-x))
;;;; Customization
(defgroup jinx nil
"Enchanted Spell Checker."
:link '(info-link :tag "Info Manual" "(jinx)")
:link '(url-link :tag "Website" "https://github.com/minad/jinx")
:link '(url-link :tag "Wiki" "https://github.com/minad/jinx/wiki")
:link '(emacs-library-link :tag "Library Source" "jinx.el")
:group 'text
:prefix "jinx-")
(defcustom jinx-delay 0.2
"Idle timer delay."
:type 'float)
(defcustom jinx-languages
(replace-regexp-in-string
"\\..*\\'" ""
(or (bound-and-true-p current-locale-environment)
(pcase (getenv "LANG")
((or "C" "POSIX") nil)
(lang lang))
"en_US"))
"Dictionary language codes, as a string separated by whitespace."
:type 'string)
(defcustom jinx-save-languages 'ask
"Save the variable `jinx-languages' as file-local variable?"
:type '(choice (const :tag "Never" nil)
(const :tag "Always" t)
(const :tag "Ask" ask)))
;;;###autoload
(put 'jinx-languages 'safe-local-variable #'stringp)
(defcustom jinx-include-faces
'((prog-mode font-lock-comment-face
font-lock-doc-face
font-lock-string-face)
(conf-mode font-lock-comment-face
font-lock-string-face)
;; `yaml-mode' and `yaml-ts-mode' are text-modes,
;; while they should better be conf- or prog-modes.
(yaml-mode . conf-mode)
(yaml-ts-mode . conf-mode))
"Alist of faces per major mode.
These faces mark regions which should be included in spell
checking."
:type '(alist :key-type symbol :value-type (choice symbol (repeat face))))
(defcustom jinx-camel-modes
'(java-mode java-ts-mode js-mode js-ts-mode ruby-mode ruby-ts-mode rust-mode
rust-ts-mode haskell-mode kotlin-mode swift-mode csharp-mode csharp-ts-mode
objc-mode typescript-ts-mode typescript-mode tsx-ts-mode python-mode
python-ts-mode dart-mode go-mode go-ts-mode scala-mode groovy-mode)
"Modes where camelCase or PascalCase words should be accepted.
Set to t to enable camelCase everywhere."
:type '(choice (const t) (repeat symbol)))
(defcustom jinx-exclude-faces
'((markdown-mode
markdown-code-face markdown-html-attr-name-face
markdown-html-attr-value-face markdown-html-tag-name-face
markdown-inline-code-face markdown-link-face markdown-markup-face
markdown-plain-url-face markdown-reference-face markdown-url-face)
(org-mode
org-block org-block-begin-line org-block-end-line org-code org-cite
org-cite-key org-date org-document-info-keyword org-done org-drawer
org-footnote org-formula org-latex-and-related org-link org-macro
org-meta-line org-property-value org-special-keyword org-tag org-todo
org-verbatim org-warning
;; org-modern
org-modern-tag org-modern-date-active org-modern-date-inactive)
(tex-mode
tex-math font-latex-math-face font-latex-sedate-face
font-latex-verbatim-face font-lock-function-name-face
font-lock-keyword-face font-lock-variable-name-face)
(texinfo-mode
font-lock-function-name-face font-lock-keyword-face
font-lock-variable-name-face)
(rst-mode
rst-literal rst-external rst-directive rst-definition rst-reference)
(sgml-mode
font-lock-function-name-face font-lock-variable-name-face)
(lisp-data-mode
font-lock-constant-face font-lock-warning-face)
(message-mode
message-separator message-header-cc message-header-name
message-header-newsgroups message-header-other message-header-to
message-header-xheader message-cited-text-1 message-cited-text-2
message-cited-text-3 message-cited-text-4 gnus-cite-1 gnus-cite-2
gnus-cite-3 gnus-cite-4 gnus-cite-5 gnus-cite-6 gnus-cite-7 gnus-cite-8
gnus-cite-9 gnus-cite-10 gnus-cite-11))
"Alist of faces per major mode.
These faces mark regions which should be excluded in spell
checking."
:type '(alist :key-type symbol :value-type (choice symbol (repeat face))))
(defcustom jinx-exclude-regexps
'((emacs-lisp-mode "Package-Requires:.*$")
(t "[A-Z]+\\>" ;; Uppercase words
"-+\\>" ;; Hyphens used as lines or bullet points
"\\w*?[0-9]\\w*\\>" ;; Words with numbers, hex codes
"[a-z]+://\\S-+" ;; URI
"<?[-+_.~a-zA-Z][-+_.~:a-zA-Z0-9]*@[-.a-zA-Z0-9]+>?" ;; Email
"\\(?:Local Variables\\|End\\):\\s-*$" ;; Local variable indicator
"jinx-\\(?:languages\\|local-words\\):\\s-+.*$")) ;; Local variables
"List of excluded regexps per major mode."
:type '(alist :key-type symbol :value-type (choice symbol (repeat regexp))))
(defcustom jinx-suggestion-distance 3
"Maximal edit distance for session words to be included in suggestions."
:type 'natnum)
(defcustom jinx-menu-suggestions 10
"Maximal number of suggestions shown in the context menu."
:type 'natnum)
(defvar-local jinx-local-words ""
"File-local words, as a string separated by whitespace.")
(defvar-local jinx-dir-local-words ""
"Directory-local words, as a string separated by whitespace.")
;;;###autoload
(progn
(put 'jinx-local-words 'safe-local-variable #'stringp)
(put 'jinx-dir-local-words 'safe-local-variable #'stringp)
(put 'jinx-mode 'safe-local-variable #'not))
;;;; Faces
(defgroup jinx-faces nil
"Faces used by Jinx."
:group 'jinx
:group 'faces)
(defface jinx-misspelled
'((((class color) (min-colors 88) (background dark)
(supports :underline (:style wave)))
:underline (:style wave :color "#d2b580"))
(((class color) (min-colors 88) (background light)
(supports :underline (:style wave)))
:underline (:style wave :color "#5f4400"))
(t :underline t :inherit error))
"Face used for misspelled words.")
(defface jinx-highlight
'((t :inherit isearch))
"Face used to highlight current misspelled word during correction.")
(defface jinx-save
'((t :inherit warning))
"Face used for the save actions during correction.")
(defface jinx-key
'((t :inherit completions-annotations))
"Face used for the select key during correction.")
(defface jinx-annotation
'((t :inherit completions-annotations))
"Face used for the annotation during correction.")
;;;; Keymaps
(defvar-keymap jinx-overlay-map
:doc "Keymap attached to misspelled words."
"<down-mouse-3>" `(menu-item "" (keymap) :filter ,#'jinx--correct-menu)
"M-n" #'jinx-next
"M-p" #'jinx-previous
"M-$" #'jinx-correct)
(fset 'jinx-overlay-map jinx-overlay-map)
(defvar-keymap jinx-repeat-map
:doc "Repeat keymap for navigation commands."
:repeat (:exit (jinx-correct))
"M-n" #'jinx-next
"M-p" #'jinx-previous
"n" #'jinx-next
"p" #'jinx-previous
"$" #'jinx-correct)
(defvar-keymap jinx-correct-map
:doc "Keymap active in the correction minibuffer."
"SPC" #'self-insert-command
"M-n" #'jinx-next
"M-p" #'jinx-previous
"M-$" #'jinx-previous
"0 <t>" #'jinx-correct-select)
(dotimes (i 9)
(define-key jinx-correct-map (vector (+ ?1 i)) #'jinx-correct-select))
(defvar-keymap jinx-mode-map
:doc "Keymap used when Jinx is active.")
(easy-menu-define jinx-mode-menu jinx-mode-map
"Menu used when Jinx is active."
'("Jinx"
["Correct nearest" jinx-correct]
["Correct all" (jinx-correct t)
:keys "\\[universal-argument] \\[jinx-correct]"]
["Change languages" jinx-languages]
"----"
["Manual" (info "(jinx)")]
["Customize" (customize-group 'jinx)]
["Turn off" (jinx-mode -1)]))
;;;; Internal variables
(defvar jinx--compile-flags
'("-I." "-O2" "-Wall" "-Wextra" "-fPIC" "-shared")
"List of compile flags passed to the C compiler.")
(defvar jinx--reschedule-hooks
'(window-selection-change-functions window-scroll-functions
window-state-change-hook post-command-hook)
"Hooks which reschedule the spell checking timer, see `jinx--reschedule'.")
(defvar jinx--predicates
(list #'jinx--face-ignored-p
#'jinx--regexp-ignored-p
#'jinx--word-valid-p)
"Predicate functions called at point with argument START.
Predicate should return t if the word before point is valid.
Predicate may return a position to skip forward.")
(defvar jinx--timer (timer-create)
"Global timer to check pending regions.")
(defvar jinx--base-syntax-table
(let ((st (make-syntax-table)))
(modify-syntax-entry ?$ "_" st)
(modify-syntax-entry ?% "_" st)
(modify-syntax-entry '(#xe000 . #xf8ff) "_" st) ;; Priv. use area
(modify-syntax-entry '(#xf0000 . #xffffd) "_" st) ;; Supp. priv. use area A
(modify-syntax-entry '(#x100000 . #x10fffd) "_" st);; Supp. priv. use area B
(modify-syntax-entry '(#x80 . #x9f) "_" st) ;; Control characters
(modify-syntax-entry '(#x2150 . #x2bff) "_" st) ;; Number Forms - Misc. Arrows
(modify-syntax-entry '(#xfe00 . #xfe0f) "_" st) ;; Variation Selectors
(modify-syntax-entry '(#x1cf00 . #x1d7ff) "_" st) ;; Znamenny Musical - Math. Alpha.
(modify-syntax-entry '(#x1ee00 . #x1fbff) "_" st) ;; Arabic Math. - Legacy Computing
st)
"Parent syntax table of `jinx--syntax-table'.")
(defvar jinx--syntax-overrides
'((?' . "w")
(?’ . "w")
(?. . "."))
"Syntax table overrides used for `jinx--syntax-table'.")
(defvar jinx--select-keys
"123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
"Quick select keys used by `jinx-correct'.")
(defvar jinx--save-keys
`((?@ . ,#'jinx--save-personal)
(?* . ,#'jinx--save-file)
(?/ . ,#'jinx--save-dir)
(?+ . ,#'jinx--save-session))
"Keys for save actions used by `jinx-correct'.")
(defvar-local jinx--exclude-faces nil
"List of excluded faces.")
(defvar-local jinx--include-faces nil
"List of included faces.")
(defvar-local jinx--exclude-regexp nil
"Ignore regexp.")
(defvar-local jinx--camel nil
"Accept camel case.")
(defvar-local jinx--dicts nil
"List of dictionaries.")
(defvar jinx--dicts-hash (make-hash-table :test #'equal :weakness 'value)
"Weak hash table of all loaded dictionaries.")
(defvar-local jinx--syntax-table nil
"Syntax table used during checking.
The table inherits from `jinx--base-syntax-table'. The table is
configured according to the word characters defined by the local
dictionaries. Afterwards `jinx--syntax-overrides' are applied.")
(defvar-local jinx--session-words nil
"List of words accepted in this session.")
;;;; Declarations for the bytecode compiler
(defvar repeat-mode)
(defvar jinx-mode)
(declare-function jinx--mod-check nil)
(declare-function jinx--mod-add nil)
(declare-function jinx--mod-suggest nil)
(declare-function jinx--mod-dict nil)
(declare-function jinx--mod-describe nil)
(declare-function jinx--mod-langs nil)
(declare-function jinx--mod-wordchars nil)
;;;; Overlay properties
(put 'jinx-overlay 'evaporate t)
(put 'jinx-overlay 'face 'jinx-misspelled)
(put 'jinx-overlay 'mouse-face '(jinx-misspelled jinx-highlight))
(put 'jinx-overlay 'modification-hooks (list #'jinx--overlay-modified))
(put 'jinx-overlay 'insert-in-front-hooks (list #'jinx--overlay-modified))
(put 'jinx-overlay 'insert-behind-hooks (list #'jinx--overlay-modified))
(put 'jinx-overlay 'keymap 'jinx-overlay-map)
;;;; Predicates
(defun jinx--regexp-ignored-p (start)
"Return non-nil if word at START matches ignore regexps."
(save-excursion
(goto-char start)
(when (and jinx--exclude-regexp (looking-at-p jinx--exclude-regexp))
(save-match-data
(looking-at jinx--exclude-regexp)
(match-end 0)))))
(defun jinx--face-ignored-p (start)
"Return non-nil if face at START of word is ignored."
(let ((face (get-text-property start 'face)))
(or
(and jinx--include-faces
(if (listp face)
(cl-loop for f in face never (memq f jinx--include-faces))
(not (memq face jinx--include-faces))))
(and jinx--exclude-faces
(if (listp face)
(cl-loop for f in face thereis (memq f jinx--exclude-faces))
(memq face jinx--exclude-faces))))))
(defun jinx--word-valid-p (word)
"Return non-nil if WORD is valid.
WORD can also be a start position."
(unless (stringp word)
(setq word (buffer-substring-no-properties word (point))))
(or (member word jinx--session-words)
;; Allow capitalized words
(let (case-fold-search)
(and (string-match-p "\\`[[:upper:]][[:lower:]]+\\'" word)
(cl-loop
for w in jinx--session-words
thereis (and (string-equal-ignore-case word w)
(string-match-p "\\`[[:lower:]]+\\'" w)))))
(cl-loop for dict in jinx--dicts
thereis (jinx--mod-check dict word))))
;;;; Internal functions
(defun jinx--in-base-buffer (&rest app)
"Apply APP in `buffer-base-buffer', as required by `jit-lock' functions."
(with-current-buffer (or (buffer-base-buffer) (current-buffer))
(apply app)))
(defun jinx--overlay-modified (overlay &rest _)
"Delete modified OVERLAY.
This function is a modification hook for the overlay."
(delete-overlay overlay))
(defun jinx--find-visible (start end visible)
"Find (in)visible region between START and END.
VISIBLE must be nil or t."
(while (and (< start end) (eq (not visible) (not (invisible-p start))))
(let ((next (next-single-char-property-change start 'invisible nil end)))
;; END can be outside the buffer if the buffer size has changed in
;; between. Then `next-single-property-change' will return (point-max)
;; instead of END. See gh:minad/jinx#156.
(setq start (if (> next start) next end))))
start)
(defun jinx--check-pending (start end)
"Check pending visible region between START and END."
(let ((retry (and (eq (window-buffer) (current-buffer))
(symbolp real-last-command)
(string-match-p "self-insert-command\\'"
(symbol-name real-last-command))
(window-point))))
(while (< start end)
(let* ((vfrom (jinx--find-visible start end t))
(vto (jinx--find-visible vfrom end nil)))
(while (< vfrom vto)
(let* ((pfrom (or (text-property-any vfrom vto 'jinx--pending t) vto))
(pto (or (text-property-not-all pfrom vto 'jinx--pending t) vto)))
(when (< pfrom pto)
(jinx--check-region pfrom pto retry))
(setq vfrom pto)))
(setq start vto)))))
(defun jinx--check-region (start end &optional retry)
"Check region between START and END.
Optionally RETRY word at given position. Return updated END
position."
(let ((st (syntax-table)) case-fold-search
retry-start retry-end)
(unwind-protect
(with-silent-modifications
(save-excursion
(save-match-data
;; Use dictionary-dependent syntax table
(set-syntax-table jinx--syntax-table)
;; Ensure that region starts and ends at word boundaries
(goto-char start)
(unless (looking-at-p "\\<")
(re-search-backward "\\<\\|^")
(setq start (match-beginning 0)))
(goto-char end)
(unless (looking-at-p "\\>")
(re-search-forward "\\>\\|$")
(setq end (match-beginning 0)))
(jinx--delete-overlays start end)
(goto-char start)
(while (re-search-forward "\\<\\w+\\>" end t)
(let ((word-start (match-beginning 0))
(word-end (match-end 0)))
;; No quote or apostrophe at start or end
(while (and (< word-start word-end)
(let ((c (char-after word-start)))
(or (= c ?') (= c ?’))))
(cl-incf word-start))
(while (and (< word-start word-end)
(let ((c (char-before word-end)))
(or (= c ?') (= c ?’))))
(cl-decf word-end))
(while (< word-start word-end)
(let ((subword-end word-end))
(when jinx--camel
(goto-char word-start)
(when (looking-at "\\([[:upper:]]?[[:lower:]]+\\)\\(?:[[:upper:]][[:lower:]]+\\)+\\>")
(setq subword-end (match-end 1))))
(goto-char subword-end)
(pcase (run-hook-with-args-until-success 'jinx--predicates word-start)
((and (pred integerp) skip)
(goto-char (max subword-end (min end skip))))
('nil
(if (and retry (<= word-start retry subword-end))
(setq retry-start word-start retry-end subword-end retry nil)
(overlay-put (make-overlay word-start subword-end) 'category 'jinx-overlay))))
(setq word-start subword-end)))))
(remove-list-of-text-properties start end '(jinx--pending))
(when retry-start
(put-text-property retry-start retry-end 'jinx--pending t)))))
(set-syntax-table st))))
(defun jinx--get-overlays (start end &optional visible)
"Return misspelled word overlays between START and END.
If VISIBLE is non-nil, only include visible overlays."
(let ((pt (point)) before overlays)
(dolist (ov (overlays-in start end))
(when (and (eq (overlay-get ov 'category) 'jinx-overlay)
(not (and visible (invisible-p (overlay-start ov)))))
(push ov overlays)))
(setq overlays
(sort overlays
(lambda (a b) (< (overlay-start a) (overlay-start b)))))
(while (and (cdr overlays) (<= (overlay-start (cadr overlays)) pt))
(push (pop overlays) before))
(nconc overlays (nreverse before))))
(cl-defun jinx--force-overlays (start end &key visible check)
"Return misspelled word overlays between START and END, enforce checking.
If VISIBLE is non-nil, only include visible overlays.
If CHECK is non-nil, always check first."
(or (and (not check) (jinx--get-overlays start end visible))
(progn
(with-delayed-message (1 "Fontifying...")
(jinx--in-base-buffer #'jit-lock-fontify-now start end))
(with-delayed-message (1 "Checking...")
(jinx--check-region start end))
(jinx--get-overlays start end visible))
(user-error (if visible "No misspelled word in visible text"
"No misspelled word in whole buffer"))))
(defun jinx--delete-overlays (start end)
"Delete overlays between START and END."
(dolist (ov (overlays-in start end))
(when (eq (overlay-get ov 'category) 'jinx-overlay)
(delete-overlay ov))))
(defun jinx--cleanup ()
"Cleanup all overlays and trigger fontification."
(with-silent-modifications
(without-restriction
(jinx--delete-overlays (point-min) (point-max))
(remove-list-of-text-properties (point-min) (point-max) '(jinx--pending))
(jinx--in-base-buffer #'jit-lock-refontify))))
(defun jinx--mark-pending (start end)
"Mark region between START and END as pending."
(put-text-property start end 'jinx--pending t)
(unless inhibit-quit ;; non-nil for stealth locking
(jinx--schedule))
nil)
(defun jinx--mode-list (list)
"Lookup by major mode in LIST."
(cl-loop for (mode . vals) in list
if (or (eq mode t) (derived-mode-p mode))
append (if (symbolp vals) (alist-get vals list) vals)))
(defun jinx--get-org-language ()
"Get language from Org #+language keyword."
(when (and (not (local-variable-p 'jinx-languages))
(derived-mode-p 'org-mode))
(save-excursion
(save-match-data
(goto-char (point-min))
(when (re-search-forward "^ *#\\+language: +\\([a-z_]+\\) *$" nil t)
(setq-local jinx-languages (match-string-no-properties 1)))))))
(defun jinx--timer-handler ()
"Global timer handler, checking the pending regions in all windows."
(timer-set-function jinx--timer nil)
(dolist (frame (frame-list))
(dolist (win (window-list frame 'no-miniwindow))
(when-let ((buffer (window-buffer win))
((buffer-local-value 'jinx-mode buffer)))
(with-current-buffer buffer
(jinx--check-pending (window-start win) (window-end win)))))))
(defun jinx--reschedule (&rest _)
"Restart the global idle timer."
(when (timer--function jinx--timer)
(cancel-timer jinx--timer)
(timer-set-function jinx--timer nil))
(jinx--schedule))
(defun jinx--schedule ()
"Start the global idle timer."
(when (and (not (timer--function jinx--timer))
(not completion-in-region-mode) ;; Corfu completion
(get-buffer-window)) ;; Buffer visible
(timer-set-function jinx--timer #'jinx--timer-handler)
(timer-set-idle-time jinx--timer jinx-delay)
(timer-activate-when-idle jinx--timer t)))
(defun jinx--load-module ()
"Compile and load dynamic module."
(unless (fboundp #'jinx--mod-dict)
(unless module-file-suffix
(error "Jinx: Dynamic modules are not supported"))
(let* ((mod-name (file-name-with-extension "jinx-mod" module-file-suffix))
(mod-file (locate-library mod-name t)))
(unless mod-file
(let* ((cc (or (getenv "CC")
(seq-find #'executable-find '("gcc" "clang" "cc"))
(error "Jinx: No C compiler found")))
(c-name (file-name-with-extension mod-name ".c"))
(default-directory (file-name-directory
(or (locate-library c-name t)
(error "Jinx: %s not found" c-name))))
(command
`(,cc ,@jinx--compile-flags "-o" ,mod-name ,c-name
,@(split-string-and-unquote
(condition-case nil
(car (process-lines "pkg-config" "--cflags" "--libs" "enchant-2"))
(error "-I/usr/include/enchant-2 -I/usr/local/include/enchant-2 -L/usr/local/lib -lenchant-2"))))))
(with-current-buffer (get-buffer-create "*jinx module compilation*")
(let ((inhibit-read-only t))
(erase-buffer)
(compilation-mode)
(insert (string-join command " ") "\n")
(if (equal 0 (apply #'call-process (car command) nil (current-buffer) t (cdr command)))
(insert (message "Jinx: %s compiled successfully" mod-name))
(let ((msg (format "Jinx: Compilation of %s failed" mod-name)))
(insert msg)
(pop-to-buffer (current-buffer))
(error msg)))))
(setq mod-file (expand-file-name mod-name))))
;; Initialize Mac spell checker to avoid dead lock (gh:minad/jinx#91).
(when (and (eq window-system 'mac) (fboundp 'mac-do-applescript))
(mac-do-applescript
"use framework \"AppKit\"
set spellChecker to current application's NSSpellChecker's sharedSpellChecker()"))
(module-load mod-file))))
(defmacro jinx--correct-guard (&rest body)
"Guard BODY during correction loop."
`(cl-letf (((symbol-function #'jinx--timer-handler) #'ignore) ;; Inhibit
(repeat-mode nil)) ;; No repeating of jinx-next and jinx-previous
(unless jinx-mode (jinx-mode 1))
,@body))
(defun jinx--invisible-open-temporarily ()
"Temporarily open overlays which hide the current line.
See `isearch-open-necessary-overlays' and `isearch-open-overlay-temporary'."
(let (restore)
(dolist (ov (overlays-in (pos-bol) (pos-eol)) restore)
(let ((inv (overlay-get ov 'invisible)))
(when (and (invisible-p inv) (overlay-get ov 'isearch-open-invisible))
(push (if-let ((fun (overlay-get ov 'isearch-open-invisible-temporary)))
(progn
(funcall fun ov nil)
(lambda () (funcall fun ov t)))
(overlay-put ov 'invisible nil)
(lambda () (overlay-put ov 'invisible inv)))
restore))))))
(defun jinx--invisible-open-permanently ()
"Open overlays which hide the current line.
See `isearch-open-necessary-overlays' and `isearch-open-overlay-temporary'."
(dolist (ov (overlays-in (pos-bol) (pos-eol)))
(when-let (fun (overlay-get ov 'isearch-open-invisible))
(when (invisible-p (overlay-get ov 'invisible))
(funcall fun ov)))))
(defun jinx--correct-highlight (overlay fun)
"Highlight and show OVERLAY during FUN."
(declare (indent 1))
(let (restore)
(goto-char (overlay-end overlay))
(unwind-protect
(let ((hl (make-overlay (overlay-start overlay) (overlay-end overlay))))
(overlay-put hl 'face 'jinx-highlight)
(overlay-put hl 'window (selected-window))
(setq restore (cons (lambda () (delete-overlay hl))
(jinx--invisible-open-temporarily)))
(funcall fun))
(mapc #'funcall restore))))
(defun jinx--recheck-overlays ()
"Recheck all overlays in buffer after a dictionary update."
(save-excursion
(without-restriction
(dolist (ov (overlays-in (point-min) (point-max)))
(when (eq (overlay-get ov 'category) 'jinx-overlay)
(goto-char (overlay-end ov))
(when (jinx--word-valid-p (overlay-start ov))
(delete-overlay ov)))))))
(defun jinx--correct-setup ()
"Setup minibuffer for correction."
(use-local-map (make-composed-keymap (list jinx-correct-map) (current-local-map)))
;; TODO Use `eager-display' on Emacs 31
(when (and (eq completing-read-function #'completing-read-default)
(not (bound-and-true-p vertico-mode))
(not (bound-and-true-p icomplete-mode)))
(let ((message-log-max nil)
(inhibit-message t))
(minibuffer-completion-help))))
(defun jinx--add-suggestion (list ht word group)
"Add suggestion WORD to LIST and HT.
The word will be associated with GROUP and get a prefix key."
(unless (gethash word ht)
(add-text-properties
0 (length word)
(list 'jinx--group group
'jinx--prefix
(let ((idx (1+ (hash-table-count ht))))
(cond
((< idx 10)
(format #("%d " 0 3 (face jinx-key))
idx))
((< (- idx 10) (length jinx--select-keys))
(format #("0%c " 0 4 (face jinx-key))
(aref jinx--select-keys (- idx 10)))))))
word)
(push word list)
(puthash word t ht))
list)
(defun jinx--session-suggestions (word)
"Retrieve suggestions for WORD from session."
(mapcar #'cdr
(sort (cl-loop for w in jinx--session-words
for d = (string-distance word w)
if (<= d jinx-suggestion-distance)
collect (cons d w))
#'car-less-than-car)))
(defun jinx--correct-suggestions (word)
"Retrieve suggestions for WORD from all dictionaries."
(let ((ht (make-hash-table :test #'equal))
(list nil))
(dolist (dict jinx--dicts)
(let* ((desc (jinx--mod-describe dict))
(group (format "Suggestions from dictionary ‘%s’ - %s"
(car desc) (cdr desc))))
(dolist (w (jinx--mod-suggest dict word))
(setq list (jinx--add-suggestion list ht w group)))))
(dolist (w (jinx--session-suggestions word))
(setq list (jinx--add-suggestion list ht w "Suggestions from session")))
(cl-loop for (key . fun) in jinx--save-keys
for actions = (funcall fun nil key word) do
(when (and actions (not (consp (car actions))))
(setq actions (list actions)))
(cl-loop for (k w a) in actions do
(push (propertize
(concat (propertize (if (stringp k) k (char-to-string k))
'face 'jinx-save 'rear-nonsticky t)
w)
'jinx--group "Accept and save"
'jinx--suffix (format #(" [%s]" 0 5 (face jinx-annotation)) a))
list)))
(nreverse list)))
(defun jinx--correct-affixation (cands)
"Affixate CANDS during completion."
(cl-loop for cand in cands collect
(list cand
(or (get-text-property 0 'jinx--prefix cand) "")
(or (get-text-property 0 'jinx--suffix cand) ""))))
(defun jinx--correct-annotation (cand)
"Annotate CAND during completion."
(if-let ((prefix (get-text-property 0 'jinx--prefix cand)))
(format #(" (%s)" 0 5 (face jinx-key)) (string-trim prefix))
(get-text-property 0 'jinx--suffix cand)))
(defun jinx--group (word transform)
"Group WORD during completion, TRANSFORM candidate if non-nil."
(if transform
word
(get-text-property 0 'jinx--group word)))
;; TODO: Use `completion-table-with-metadata'
(defun jinx--table-with-metadata (table metadata)
"Return new completion TABLE with METADATA."
(lambda (string pred action)
(if (eq action 'metadata)
`(metadata . ,metadata)
(complete-with-action action table string pred))))
(cl-defun jinx--correct-overlay (overlay &key info initial)
"Correct word at OVERLAY.
Optionally show prompt INFO and insert INITIAL input."
(catch 'jinx--goto
(let* ((word (buffer-substring-no-properties
(overlay-start overlay) (overlay-end overlay)))
(choice
(jinx--correct-highlight overlay
(lambda ()
(when (or (< (point) (window-start)) (> (point) (window-end nil t)))
(recenter))
(minibuffer-with-setup-hook
#'jinx--correct-setup
(or (completing-read
(format "Correct ‘%s’%s: " word (or info ""))
(jinx--table-with-metadata
(jinx--correct-suggestions word)
`((category . jinx)
(display-sort-function . ,#'identity)
(cycle-sort-function . ,#'identity)
(group-function . ,#'jinx--group)
(affixation-function . ,#'jinx--correct-affixation)
(annotation-function . ,#'jinx--correct-annotation)))
nil nil initial t word)
word)))))
(len (length choice)))
(pcase (and (> len 0) (assq (aref choice 0) jinx--save-keys))
(`(,key . ,fun)
(funcall fun 'save key
(if (> len 1) (substring-no-properties choice 1) word))
(jinx--recheck-overlays))
((guard (not (equal choice word)))
(jinx--correct-replace overlay choice)))
nil)))
(defun jinx--correct-replace (overlay word)
"Replace OVERLAY with WORD."
(when-let ((start (overlay-start overlay))
(end (overlay-end overlay)))
(undo-boundary)
(delete-overlay overlay)
(goto-char end)
(insert-before-markers word)
(delete-region start end)))
(defun jinx--correct-menu (&rest _)
"Return popup mouse menu to correct misspelling."
(when-let ((posn (event-start last-input-event))
(pt (posn-point posn))
(ov (car (jinx--get-overlays pt pt t))))
(let ((menu nil)
(word (buffer-substring-no-properties
(overlay-start ov) (overlay-end ov))))
(dolist (dict jinx--dicts)
(when-let ((desc (jinx--mod-describe dict))
(suggestions (jinx--mod-suggest dict word)))
(push `[,(concat "── " (car desc) " ─ " (cdr desc) " ──") :active nil] menu)
(cl-loop for w in suggestions repeat jinx-menu-suggestions do
(push `[,w (jinx--correct-replace ,ov ,w)] menu))))
(when-let ((suggestions (jinx--session-suggestions word)))
(push ["── Session ──" :active nil] menu)
(cl-loop for w in suggestions repeat jinx-menu-suggestions do
(push `[,w (jinx--correct-replace ,ov ,w)] menu)))
(push ["── Accept and save ──" :active nil] menu)
(cl-loop for (key . fun) in jinx--save-keys
for actions = (funcall fun nil key word) do
(unless (consp (car actions)) (setq actions (list actions)))
(cl-loop for (k w a) in actions do
(push `[,a (jinx-correct-word
,(overlay-start ov) ,(overlay-end ov)
,(concat (if (stringp k) k (char-to-string k)) w))]
menu)))
(easy-menu-create-menu (format "Correct `%s'" word)
(delete-dups (nreverse menu))))))
(defun jinx--load-dicts ()
"Load dictionaries and setup syntax table."
(setq jinx--dicts (cl-loop for lang in (split-string jinx-languages)
;; Keep a weak reference to loaded dictionaries.
;; See <gh:rrthomas/enchant#402>.
for dict = (with-memoization (gethash lang jinx--dicts-hash)
(jinx--mod-dict lang))
if dict collect dict)
jinx--syntax-table (make-syntax-table jinx--base-syntax-table))
(unless jinx--dicts
(message "Jinx: No dictionaries available for %S" jinx-languages))
(dolist (dict jinx--dicts)
(cl-loop for c across (jinx--mod-wordchars dict) do
(modify-syntax-entry c "w" jinx--syntax-table)))
(cl-loop for (k . v) in jinx--syntax-overrides do
(modify-syntax-entry k v jinx--syntax-table)))
(defun jinx--bounds-of-word ()
"Return bounds of word at point using `jinx--syntax-table'."
(save-excursion
(save-match-data
(with-syntax-table jinx--syntax-table
(unless (looking-at-p "\\<")
(re-search-backward "\\<"))
(when (re-search-forward "\\<\\w+\\>" nil t)
(cons (match-beginning 0) (match-end 0)))))))
(defun jinx--read-languages ()
"Read languages via `completing-read-multiple'."
(jinx--load-module)
(let ((langs (delete-dups
(cl-loop for (l . p) in (jinx--mod-langs) collect
(propertize l 'jinx--group (format "Provider %s" p))))))
(string-join
(or (completing-read-multiple
(format "Change languages (%s): "
(string-join (split-string jinx-languages) ", "))
(jinx--table-with-metadata langs `((group-function . ,#'jinx--group)))
nil t)
(user-error "No languages selected"))
" ")))
(defun jinx--add-local-word (var word)
"Add WORD to local word list VAR."
(add-to-list 'jinx--session-words word)
(set var
(string-join
(sort (delete-dups (cons word (split-string (symbol-value var))))
#'string<)
" ")))
;;;; Save functions
(defun jinx--save-personal (save key word)
"Save WORD in personal dictionary.
If SAVE is non-nil save, otherwise format candidate given action KEY."
(if save
(let ((idx (seq-position word key (lambda (x y) (not (equal x y))))))
(jinx--mod-add (or (nth idx jinx--dicts)
(user-error "Invalid dictionary"))
(substring word idx)))
(cl-loop
for dict in jinx--dicts for idx from 1
for at = (make-string idx key)
for ann = (format "Personal:%s" (car (jinx--mod-describe dict))) collect
(list at word ann))))
(defun jinx--save-file (save key word)
"Save WORD in file-local variable.
If SAVE is non-nil save, otherwise format candidate given action KEY."
(if save
(progn
(jinx--add-local-word 'jinx-local-words word)
(add-file-local-variable 'jinx-local-words jinx-local-words))
(list key word "File")))
(defun jinx--save-dir (save key word)
"Save WORD in directory-local variable.
Uses a .dir-locals.el file in the current directory or any parent
directory. If no .dir-locals.el file is found, it is created in the
project root. If no project root is found, it is created in the current
directory. If SAVE is non-nil save, otherwise format candidate given
action KEY."
(if save
(progn
(jinx--add-local-word 'jinx-dir-local-words word)
(let ((default-directory
(or (locate-dominating-file default-directory ".dir-locals.el")
(when-let (proj (project-current))
(declare-function project-root "project")
(project-root proj))
default-directory)))
(add-dir-local-variable nil 'jinx-dir-local-words jinx-dir-local-words)))
(list key word "Directory")))
(defun jinx--save-session (save key word)
"Save WORD for the current session.
If SAVE is non-nil save, otherwise format candidate given action KEY."
(if save
(add-to-list 'jinx--session-words word)
(list key word "Session")))
;;;; Public commands
;;;###autoload
(defun jinx-languages (langs &optional global)
"Set languages locally or globally to LANGS.
LANGS should be one or more language codes as a string, separated
by whitespace. When called interactively, the language codes are
read via `completing-read-multiple'. If the prefix argument
GLOBAL is non-nil, the languages are changed globally for all
buffers. See also the variable `jinx-languages'."
(interactive (list (jinx--read-languages) current-prefix-arg))
(unless jinx-mode (jinx-mode 1))
(cond
(global
(kill-local-variable 'jinx-languages)
(setq-default jinx-languages langs))
(t
(setq-local jinx-languages langs)
(when (or (assq 'jinx-languages file-local-variables-alist)
(if (eq jinx-save-languages 'ask)
(and buffer-file-name
(y-or-n-p "Save `jinx-languages' as file-local variable? "))
jinx-save-languages))
(add-file-local-variable 'jinx-languages jinx-languages)
(setf (alist-get 'jinx-languages file-local-variables-alist) jinx-languages))))
(jinx--load-dicts)
(jinx--cleanup))
;;;###autoload
(defun jinx-correct-all (&optional only-check)
"Correct all misspelled words in the buffer.
With prefix argument ONLY-CHECK, only check the buffer and highlight all
misspellings, but do not open the correction UI."
(interactive "*P")
(jinx--correct-guard
(let* ((overlays (jinx--force-overlays (or (use-region-beginning) (point-min))
(or (use-region-end) (point-max))
:check t))