-
Notifications
You must be signed in to change notification settings - Fork 0
/
mojo-mode.el
2821 lines (2610 loc) · 115 KB
/
mojo-mode.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
;;; mojo-mode.el --- Mojo support for Emacs -*- lexical-binding: t -*-
;;; Commentary:
;; Major mode for editing Mojo source code, based on Fabián E. Gallina's
;; python.el found in GNU Emacs.
;;; Code:
(require 'cl-lib)
(require 'pcase)
(require 'seq)
(add-to-list 'load-path (or (and load-file-name (directory-file-name (file-name-directory load-file-name))) (car load-path)))
;;; `mojo-mode-ext'
(require 'mojo-mode-ext)
;;;###autoload🔥
;; (add-to-list 'auto-mode-alist
;; (cons (purecopy (concat (rx "." (or "mojo" "🔥")) "\\'")) 'mojo-mode))
(add-to-list 'auto-mode-alist `(,(concat (rx "." (or "mojo" "🔥")) "\\'") . mojo-mode))
(defgroup mojo-mode nil
"Mojo support for Emacs."
:group 'languages
;; :version "29.3"
;; :link '(emacs-commentary-link "mojo")
)
;;; Bindings
(defvar mojo-mode-map
(let ((map (make-sparse-keymap)))
;; Movement
(define-key map [remap backward-sentence] #'mojo-nav-backward-block)
(define-key map [remap forward-sentence] #'mojo-nav-forward-block)
(define-key map [remap backward-up-list] #'mojo-nav-backward-up-list)
(define-key map [remap up-list] #'mojo-nav-up-list)
(define-key map [remap mark-defun] #'mojo-mark-defun)
(define-key map (kbd "C-c C-j") #'imenu)
;; Indent specific
(define-key map "\177" #'mojo-indent-dedent-line-backspace)
(define-key map (kbd "<backtab>") #'mojo-indent-dedent-line)
(define-key map (kbd "C-c <") #'mojo-indent-shift-left)
(define-key map (kbd "C-c >") #'mojo-indent-shift-right)
;; Skeletons
;; (define-key map "\C-c\C-tc" #'mojo-skeleton-class)
;; (define-key map "\C-c\C-td" #'mojo-skeleton-def)
;; (define-key map "\C-c\C-tf" #'mojo-skeleton-for)
;; (define-key map "\C-c\C-ti" #'mojo-skeleton-if)
;; (define-key map "\C-c\C-tm" #'mojo-skeleton-import)
;; (define-key map "\C-c\C-tt" #'mojo-skeleton-try)
;; (define-key map "\C-c\C-tw" #'mojo-skeleton-while)
;; Shell interaction
;; (define-key map "\C-c\C-p" #'run-mojo)
;; (define-key map "\C-c\C-s" #'mojo-shell-send-string)
;; (define-key map "\C-c\C-e" #'mojo-shell-send-statement)
;; (define-key map "\C-c\C-r" #'mojo-shell-send-region)
;; (define-key map "\C-\M-x" #'mojo-shell-send-defun)
;;(define-key map "\C-c\C-c" #'mojo-shell-send-buffer)
;; (define-key map "\C-c\C-l" #'mojo-shell-send-file)
;; (define-key map "\C-c\C-z" #'mojo-shell-switch-to-shell)
;; Some util commands
;; (define-key map "\C-c\C-v" #'mojo-check)
;; (define-key map "\C-c\C-f" #'mojo-eldoc-at-point)
;; (define-key map "\C-c\C-d" #'mojo-describe-at-point)
;; Import management
;; (define-key map "\C-c\C-ia" #'mojo-add-import)
;; (define-key map "\C-c\C-if" #'mojo-fix-imports)
;; (define-key map "\C-c\C-ir" #'mojo-remove-import)
;; (define-key map "\C-c\C-is" #'mojo-sort-imports)
;; from `mojo-mode-ext'
(define-key map (kbd "C-c C-c C-r") #'mojo-run)
(define-key map (kbd "C-c C-c C-b") #'mojo-build)
(define-key map (kbd "C-c C-c C-f") #'mojo-format)
(define-key map (kbd "C-c C-c C-t") #'mojo-test)
;; Utilities
(substitute-key-definition #'complete-symbol #'completion-at-point
map global-map)
(easy-menu-define mojo-menu map "Mojo Mode menu"
'("Mojo"
:help "Mojo-specific Features"
["Shift region left" mojo-indent-shift-left :active mark-active
:help "Shift region left by a single indentation step"]
["Shift region right" mojo-indent-shift-right :active mark-active
:help "Shift region right by a single indentation step"]
"-"
["Start of def/class" beginning-of-defun
:help "Go to start of outermost definition around point"]
["End of def/class" end-of-defun
:help "Go to end of definition around point"]
["Mark def/class" mark-defun
:help "Mark outermost definition around point"]
["Jump to def/class" imenu
:help "Jump to a class or function definition"]
"--"
;; ("Skeletons")
;; "---"
;; ["Start interpreter" run-mojo
;; :help "Run inferior Mojo process in a separate buffer"]
;; ["Switch to shell" mojo-shell-switch-to-shell
;; :help "Switch to running inferior Mojo process"]
;; ["Eval string" mojo-shell-send-string
;; :help "Eval string in inferior Mojo session"]
;; ["Eval buffer" mojo-shell-send-buffer
;; :help "Eval buffer in inferior Mojo session"]
;; ["Eval statement" mojo-shell-send-statement
;; :help "Eval statement in inferior Mojo session"]
;; ["Eval region" mojo-shell-send-region
;; :help "Eval region in inferior Mojo session"]
;; ["Eval defun" mojo-shell-send-defun
;; :help "Eval defun in inferior Mojo session"]
;; ["Eval file" mojo-shell-send-file
;; :help "Eval file in inferior Mojo session"]
;; ["Debugger" pdb :help "Run pdb under GUD"]
;; "----"
;; ["Check file" mojo-check
;; :help "Check file for errors"]
;; ["Help on symbol" mojo-eldoc-at-point
;; :help "Get help on symbol at point"]
["Complete symbol" completion-at-point
:help "Complete symbol before point"]
;; "-----"
;; ["Add import" mojo-add-import
;; :help "Add an import statement to the top of this buffer"]
;; ["Remove import" mojo-remove-import
;; :help "Remove an import statement from the top of this buffer"]
;; ["Sort imports" mojo-sort-imports
;; :help "Sort the import statements at the top of this buffer"]
;; ["Fix imports" mojo-fix-imports
;; :help "Add missing imports and remove unused ones from the current buffer"]
))
map)
"Keymap for `mojo-mode'.")
;;; Mojo specialized rx
(defmacro mojo-rx (&rest regexps)
"Mojo mode specialized rx macro.
This variant of `rx' supports common Mojo named REGEXPS."
`(rx-let ((sp-bsnl (or space (and ?\\ ?\n)))
(block-start (seq symbol-start
(or "fn" "struct" "trait"
;; Python
"def" "class" "if" "elif" "else" "try"
"except" "finally" "for" "while" "with"
;; Python 3.10+ PEP634
"match" "case"
;; Python 3.5+ PEP492
(and "async" (+ space)
(or "fn"
;; Python
"def" "for" "with")))
symbol-end))
(dedenter (seq symbol-start
(or "elif" "else" "except" "finally" "case")
symbol-end))
(block-ender (seq symbol-start
(or
"break" "continue" "pass" "raise" "return")
symbol-end))
(decorator (seq line-start (* space) ?@ (any letter ?_)
(* (any word ?_))))
(defun (seq symbol-start
(or "fn" "struct" "trait"
;; Python
"def" "class"
;; Python 3.5+ PEP492
(and "async" (+ space) (or "fn" "def")))
symbol-end))
(if-name-main (seq line-start "if" (+ space) "__name__"
(+ space) "==" (+ space)
(any ?' ?\") "__main__" (any ?' ?\")
(* space) ?:))
(symbol-name (seq (any letter ?_) (* (any word ?_))))
(assignment-target (seq (? ?*)
(* symbol-name ?.) symbol-name
(? ?\[ (+ (not ?\])) ?\])))
(grouped-assignment-target (seq (? ?*)
(* symbol-name ?.) (group symbol-name)
(? ?\[ (+ (not ?\])) ?\])))
(open-paren (or "{" "[" "("))
(close-paren (or "}" "]" ")"))
(simple-operator (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%))
(not-simple-operator (not (or simple-operator ?\n)))
(operator (or "==" ">="
"**" "//" "<<" ">>" "<=" "!="
"+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
"=" "%"))
(assignment-operator (or "+=" "-=" "*=" "/=" "//=" "%=" "**="
">>=" "<<=" "&=" "^=" "|="
"="))
(string-delimiter (seq
;; Match even number of backslashes.
(or (not (any ?\\ ?\' ?\")) point
;; Quotes might be preceded by an
;; escaped quote.
(and (or (not (any ?\\)) point) ?\\
(* ?\\ ?\\) (any ?\' ?\")))
(* ?\\ ?\\)
;; Match single or triple quotes of any kind.
(group (or "\"\"\"" "\"" "'''" "'"))))
(coding-cookie (seq line-start ?# (* space)
(or
;; # coding=<encoding name>
(: "coding" (or ?: ?=) (* space)
(group-n 1 (+ (or word ?-))))
;; # -*- coding: <encoding name> -*-
(: "-*-" (* space) "coding:" (* space)
(group-n 1 (+ (or word ?-)))
(* space) "-*-")
;; # vim: set fileencoding=<encoding name> :
(: "vim:" (* space) "set" (+ space)
"fileencoding" (* space) ?= (* space)
(group-n 1 (+ (or word ?-)))
(* space) ":"))))
(bytes-escape-sequence
(seq (not "\\")
(group (or "\\\\" "\\'" "\\a" "\\b" "\\f"
"\\n" "\\r" "\\t" "\\v"
(seq "\\" (** 1 3 (in "0-7")))
(seq "\\x" hex hex)))))
(string-escape-sequence
(or bytes-escape-sequence
(seq (not "\\")
(or (group-n 1 "\\u" (= 4 hex))
(group-n 1 "\\U" (= 8 hex))
(group-n 1 "\\N{" (*? anychar) "}"))))))
(rx ,@regexps)))
;;; Font-lock and syntax
(eval-and-compile
(defun mojo-syntax--context-compiler-macro (form type &optional syntax-ppss)
(pcase type
(''comment
`(let ((ppss (or ,syntax-ppss (syntax-ppss))))
(and (nth 4 ppss) (nth 8 ppss))))
(''string
`(let ((ppss (or ,syntax-ppss (syntax-ppss))))
(and (nth 3 ppss) (nth 8 ppss))))
(''single-quoted-string
`(let ((ppss (or ,syntax-ppss (syntax-ppss))))
(and (characterp (nth 3 ppss)) (nth 8 ppss))))
(''triple-quoted-string
`(let ((ppss (or ,syntax-ppss (syntax-ppss))))
(and (eq t (nth 3 ppss)) (nth 8 ppss))))
(''paren
`(nth 1 (or ,syntax-ppss (syntax-ppss))))
(_ form))))
(defun mojo-syntax-context (type &optional syntax-ppss)
"Return non-nil if point is on TYPE using SYNTAX-PPSS.
TYPE can be `comment', `string', `single-quoted-string',
`triple-quoted-string' or `paren'. It returns the start
character address of the specified TYPE."
(declare (compiler-macro mojo-syntax--context-compiler-macro))
(let ((ppss (or syntax-ppss (syntax-ppss))))
(pcase type
('comment (and (nth 4 ppss) (nth 8 ppss)))
('string (and (nth 3 ppss) (nth 8 ppss)))
('single-quoted-string (and (characterp (nth 3 ppss)) (nth 8 ppss)))
('triple-quoted-string (and (eq t (nth 3 ppss)) (nth 8 ppss)))
('paren (nth 1 ppss))
(_ nil))))
(defun mojo-syntax-context-type (&optional syntax-ppss)
"Return the context type using SYNTAX-PPSS.
The type returned can be `comment', `string' or `paren'."
(let ((ppss (or syntax-ppss (syntax-ppss))))
(cond
((nth 8 ppss) (if (nth 4 ppss) 'comment 'string))
((nth 1 ppss) 'paren))))
(defsubst mojo-syntax-comment-or-string-p (&optional ppss)
"Return non-nil if PPSS is inside comment or string."
(nth 8 (or ppss (syntax-ppss))))
(defsubst mojo-syntax-closing-paren-p ()
"Return non-nil if char after point is a closing paren."
(eql (syntax-class (syntax-after (point)))
(syntax-class (string-to-syntax ")"))))
(defun mojo-font-lock-syntactic-face-function (state)
"Return syntactic face given STATE."
(if (nth 3 state)
(if (mojo-info-docstring-p state)
font-lock-doc-face
font-lock-string-face)
font-lock-comment-face))
(defconst mojo--f-string-start-regexp
(rx bow
(or "f" "F" "fr" "Fr" "fR" "FR" "rf" "rF" "Rf" "RF")
(or "\"" "\"\"\"" "'" "'''"))
"A regular expression matching the beginning of an f-string.
See URL `https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals'.")
(defun mojo--f-string-p (ppss)
"Return non-nil if the pos where PPSS was found is inside an f-string."
(and (nth 3 ppss)
(let* ((spos (1- (nth 8 ppss)))
(before-quote
(buffer-substring-no-properties (max (- spos 4) (point-min))
(min (+ spos 2) (point-max)))))
(and (string-match-p mojo--f-string-start-regexp before-quote)
(or (< (point-min) spos)
(not (memq (char-syntax (char-before spos)) '(?w ?_))))))))
(defun mojo--font-lock-f-strings (limit)
"Mark {...} holes as being code.
Remove the (presumably `font-lock-string-face') `face' property from
the {...} holes that appear within f-strings."
;; FIXME: This will fail to properly highlight strings appearing
;; within the {...} of an f-string.
;; We could presumably fix it by running
;; `font-lock-default-fontify-syntactically-region' (as is done in
;; `sm-c--cpp-fontify-syntactically', for example) after removing
;; the `face' property, but I'm not sure it's worth the effort and
;; the risks.
(let ((ppss (syntax-ppss)))
(while
(progn
(while (and (not (mojo--f-string-p ppss))
(re-search-forward mojo--f-string-start-regexp limit 'move))
(setq ppss (syntax-ppss)))
(< (point) limit))
(cl-assert (mojo--f-string-p ppss))
(let ((send (save-excursion
(goto-char (nth 8 ppss))
(condition-case nil
(progn (let ((forward-sexp-function nil))
(forward-sexp 1))
(min limit (1- (point))))
(scan-error limit)))))
(while (re-search-forward "{" send t)
(if (eq ?\{ (char-after))
(forward-char 1) ;Just skip over {{
(let ((beg (match-beginning 0))
(end (condition-case nil
(progn (up-list 1) (min send (point)))
(scan-error send))))
(goto-char end)
(put-text-property beg end 'face nil))))
(goto-char (min limit (1+ send)))
(setq ppss (syntax-ppss))))))
(defconst mojo--not-raw-bytes-literal-start-regexp
(rx (or bos (not alnum)) (or "b" "B") (or "\"" "\"\"\"" "'" "'''") eos)
"A regular expression matching the start of a not-raw bytes literal.")
(defconst mojo--not-raw-string-literal-start-regexp
(rx bos (or
;; Multi-line string literals
(seq (? (? (not alnum)) (or "u" "U" "F" "f")) (or "\"\"\"" "'''"))
(seq (? anychar) (not alnum) (or "\"\"\"" "'''"))
;; Single line string literals
(seq (? (** 0 2 anychar) (not alnum)) (or "u" "U" "F" "f") (or "'" "\""))
(seq (? (** 0 3 anychar) (not (any "'\"" alnum))) (or "'" "\"")))
eos)
"A regular expression matching the start of a not-raw string literal.")
(defun mojo--string-bytes-literal-matcher (regexp start-regexp)
"Match REGEXP within a string or bytes literal whose start matches START-REGEXP."
(lambda (limit)
(cl-loop for result = (re-search-forward regexp limit t)
for result-valid = (and
result
(when-let* ((pos (nth 8 (syntax-ppss)))
(before-quote
(buffer-substring-no-properties
(max (- pos 4) (point-min))
(min (+ pos 1) (point-max)))))
(backward-char)
(string-match-p start-regexp before-quote)))
until (or (not result) result-valid)
finally return (and result-valid result))))
(defvar mojo-font-lock-keywords-level-1
`((,(mojo-rx symbol-start "def" (1+ space) (group symbol-name))
(1 font-lock-function-name-face))
(,(mojo-rx symbol-start "class" (1+ space) (group symbol-name))
(1 font-lock-type-face))
(,(mojo-rx symbol-start "fn" (1+ space) (group symbol-name))
(1 font-lock-function-name-face))
(,(mojo-rx symbol-start "struct" (1+ space) (group symbol-name))
(1 font-lock-type-face))
(,(mojo-rx symbol-start "trait" (1+ space) (group symbol-name))
(1 font-lock-type-face))
)
"Font lock keywords to use in `mojo-mode' for level 1 decoration.
This is the minimum decoration level, including function and
class declarations.")
(defvar mojo-font-lock-keywords-level-2
`(,@mojo-font-lock-keywords-level-1
,(rx symbol-start
(or
;; Mojo
"fn" "struct" "trait"
"var" "alias" "owned" "borrowed" "inout" "raises" "capturing"
;; Python
"and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
"assert" "else" "if" "pass" "yield" "break" "except" "import" "class"
"in" "raise" "continue" "finally" "is" "return" "def" "for" "lambda"
"try"
;; False, None, and True are listed as keywords on the Python 3
;; documentation, but since they also qualify as constants they are
;; fontified like that in order to keep font-lock consistent between
;; Python versions.
"nonlocal"
;; Python 3.5+ PEP492
(and "async" (+ space) (or "fn"
;; Python
"def" "for" "with"))
"await"
;; Python 3.10+
"match" "case"
;; Extra:
"self")
symbol-end)
;; Builtins
(,(rx symbol-start
(or
"abs" "all" "any" "bin" "bool" "callable" "chr" "classmethod"
"compile" "complex" "delattr" "dict" "dir" "divmod" "enumerate"
"eval" "filter" "float" "format" "frozenset" "getattr" "globals"
"hasattr" "hash" "help" "hex" "id" "input" "int" "isinstance"
"issubclass" "iter" "len" "list" "locals" "map" "max" "memoryview"
"min" "next" "object" "oct" "open" "ord" "pow" "print" "property"
"range" "repr" "reversed" "round" "set" "setattr" "slice" "sorted"
"staticmethod" "str" "sum" "super" "tuple" "type" "vars" "zip"
"__import__"
;; Python 2:
"basestring" "cmp" "execfile" "file" "long" "raw_input" "reduce"
"reload" "unichr" "unicode" "xrange" "apply" "buffer" "coerce"
"intern"
;; Python 3:
"ascii" "breakpoint" "bytearray" "bytes" "exec"
;; Special attributes:
;; https://docs.python.org/3/reference/datamodel.html
"__annotations__" "__closure__" "__code__"
"__defaults__" "__dict__" "__doc__" "__globals__"
"__kwdefaults__" "__name__" "__module__" "__package__"
"__qualname__"
;; Extras:
"__all__")
symbol-end) . font-lock-builtin-face))
"Font lock keywords to use in `mojo-mode' for level 2 decoration.
This is the medium decoration level, including everything in
`mojo-font-lock-keywords-level-1', as well as keywords and
builtins.")
(defun mojo-font-lock-assignment-matcher (regexp)
"Font lock matcher for assignments based on REGEXP.
Search for next occurrence if REGEXP matched within a `paren'
context (to avoid, e.g., default values for arguments or passing
arguments by name being treated as assignments) or is followed by
an '=' sign (to avoid '==' being treated as an assignment. Set
point to the position one character before the end of the
occurrence found so that subsequent searches can detect the '='
sign in chained assignment."
(lambda (limit)
(cl-loop while (re-search-forward regexp limit t)
unless (or (mojo-syntax-context 'paren)
(equal (char-after) ?=))
return (progn (backward-char) t))))
(defvar mojo-font-lock-keywords-maximum-decoration
`((mojo--font-lock-f-strings)
,@mojo-font-lock-keywords-level-2
;; Constants
(,(rx symbol-start
(or
"Ellipsis" "False" "None" "NotImplemented" "True" "__debug__"
;; copyright, license, credits, quit and exit are added by the site
;; module and they are not intended to be used in programs
"copyright" "credits" "exit" "license" "quit")
symbol-end)
. font-lock-constant-face)
;; Decorators.
(,(rx line-start (* (any " \t")) (group "@" (1+ (or word ?_))
(0+ "." (1+ (or word ?_)))))
(1 font-lock-type-face))
;; Builtin Exceptions
(,(rx symbol-start
(or
;; Python 2 and 3:
"ArithmeticError" "AssertionError" "AttributeError" "BaseException"
"BufferError" "BytesWarning" "DeprecationWarning" "EOFError"
"EnvironmentError" "Exception" "FloatingPointError" "FutureWarning"
"GeneratorExit" "IOError" "ImportError" "ImportWarning"
"IndentationError" "IndexError" "KeyError" "KeyboardInterrupt"
"LookupError" "MemoryError" "NameError" "NotImplementedError"
"OSError" "OverflowError" "PendingDeprecationWarning"
"ReferenceError" "RuntimeError" "RuntimeWarning" "StopIteration"
"SyntaxError" "SyntaxWarning" "SystemError" "SystemExit" "TabError"
"TypeError" "UnboundLocalError" "UnicodeDecodeError"
"UnicodeEncodeError" "UnicodeError" "UnicodeTranslateError"
"UnicodeWarning" "UserWarning" "ValueError" "Warning"
"ZeroDivisionError"
;; Python 2:
"StandardError"
;; Python 3:
"BlockingIOError" "BrokenPipeError" "ChildProcessError"
"ConnectionAbortedError" "ConnectionError" "ConnectionRefusedError"
"ConnectionResetError" "FileExistsError" "FileNotFoundError"
"InterruptedError" "IsADirectoryError" "NotADirectoryError"
"PermissionError" "ProcessLookupError" "RecursionError"
"ResourceWarning" "StopAsyncIteration" "TimeoutError"
;; OS specific
"VMSError" "WindowsError")
symbol-end)
. font-lock-type-face)
;; multiple assignment
;; (note that type hints are not allowed for multiple assignments)
;; a, b, c = 1, 2, 3
;; a, *b, c = 1, 2, 3, 4, 5
;; [a, b] = (1, 2)
;; (l[1], l[2]) = (10, 11)
;; (a, b, c, *d) = *x, y = 5, 6, 7, 8, 9
;; (a,) = 'foo'
;; (*a,) = ['foo', 'bar', 'baz']
;; d.x, d.y[0], *d.z = 'a', 'b', 'c', 'd', 'e'
;; and variants thereof
;; the cases
;; (a) = 5
;; [a] = 5,
;; [*a] = 5, 6
;; are handled separately below
(,(mojo-font-lock-assignment-matcher
(mojo-rx (? (or "[" "(") (* space))
grouped-assignment-target (* space) ?, (* space)
(* assignment-target (* space) ?, (* space))
(? assignment-target (* space))
(? ?, (* space))
(? (or ")" "]") (* space))
(group assignment-operator)))
(1 font-lock-variable-name-face)
(2 'font-lock-operator-face)
(,(mojo-rx grouped-assignment-target)
(progn
(goto-char (match-end 1)) ; go back after the first symbol
(match-beginning 2)) ; limit the search until the assignment
nil
(1 font-lock-variable-name-face)))
;; single assignment with type hints, e.g.
;; a: int = 5
;; b: Tuple[Optional[int], Union[Sequence[str], str]] = (None, 'foo')
;; c: Collection = {1, 2, 3}
;; d: Mapping[int, str] = {1: 'bar', 2: 'baz'}
(,(mojo-font-lock-assignment-matcher
(mojo-rx (or line-start ?\;) (* space)
grouped-assignment-target (* space)
(? ?: (* space) (+ not-simple-operator) (* space))
(group assignment-operator)))
(1 font-lock-variable-name-face)
(2 'font-lock-operator-face))
;; special cases
;; (a) = 5
;; [a] = 5,
;; [*a] = 5, 6
(,(mojo-font-lock-assignment-matcher
(mojo-rx (or line-start ?\; ?=) (* space)
(or "[" "(") (* space)
grouped-assignment-target (* space)
(or ")" "]") (* space)
(group assignment-operator)))
(1 font-lock-variable-name-face)
(2 'font-lock-operator-face))
;; Operators.
(,(mojo-rx operator) . 'font-lock-operator-face)
;; escape sequences within bytes literals
;; "\\" "\'" "\a" "\b" "\f" "\n" "\r" "\t" "\v"
;; "\ooo" character with octal value ooo
;; "\xhh" character with hex value hh
(,(mojo--string-bytes-literal-matcher
(mojo-rx bytes-escape-sequence)
mojo--not-raw-bytes-literal-start-regexp)
(1 font-lock-constant-face t))
;; escape sequences within string literals, the same as appear in bytes
;; literals in addition to:
;; "\uxxxx" Character with 16-bit hex value xxxx
;; "\Uxxxxxxxx" Character with 32-bit hex value xxxxxxxx
;; "\N{name}" Character named name in the Unicode database
(,(mojo--string-bytes-literal-matcher
(mojo-rx string-escape-sequence)
mojo--not-raw-string-literal-start-regexp)
(1 'font-lock-constant-face t)))
"Font lock keywords to use in `mojo-mode' for maximum decoration.
This decoration level includes everything in
`mojo-font-lock-keywords-level-2', as well as constants,
decorators, exceptions, and assignments.")
(defvar mojo-font-lock-keywords
'(mojo-font-lock-keywords-level-1 ; When `font-lock-maximum-decoration' is nil.
mojo-font-lock-keywords-level-1 ; When `font-lock-maximum-decoration' is 1.
mojo-font-lock-keywords-level-2 ; When `font-lock-maximum-decoration' is 2.
mojo-font-lock-keywords-maximum-decoration ; When `font-lock-maximum-decoration'
; is more than 1, or t (which it is,
; by default).
)
"List of font lock keyword specifications to use in `mojo-mode'.
Which one will be chosen depends on the value of
`font-lock-maximum-decoration'.")
(defconst mojo-syntax-propertize-function
(syntax-propertize-rules
((rx (or "\"\"\"" "'''"))
(0 (ignore (mojo-syntax-stringify))))))
(defsubst mojo-syntax-count-quotes (quote-char &optional point limit)
"Count number of quotes around point (max is 3).
QUOTE-CHAR is the quote char to count. Optional argument POINT is
the point where scan starts (defaults to current point), and LIMIT
is used to limit the scan."
(let ((i 0))
(while (and (< i 3)
(or (not limit) (< (+ point i) limit))
(eq (char-after (+ point i)) quote-char))
(setq i (1+ i)))
i))
(defun mojo-syntax-stringify ()
"Put `syntax-table' property correctly on single/triple quotes."
(let* ((ppss (save-excursion (backward-char 3) (syntax-ppss)))
(string-start (and (eq t (nth 3 ppss)) (nth 8 ppss)))
(quote-starting-pos (- (point) 3))
(quote-ending-pos (point)))
(cond ((or (nth 4 ppss) ;Inside a comment
(and string-start
;; Inside of a string quoted with different triple quotes.
(not (eql (char-after string-start)
(char-after quote-starting-pos)))))
;; Do nothing.
nil)
((nth 5 ppss)
;; The first quote is escaped, so it's not part of a triple quote!
(goto-char (1+ quote-starting-pos)))
((null string-start)
;; This set of quotes delimit the start of a string. Put
;; string fence syntax on last quote. (bug#49518)
;; FIXME: This makes sexp-movement a bit suboptimal since """a"""
;; is now treated as 3 strings.
;; We could probably have our cake and eat it too by
;; putting the string fence on the first quote and then
;; convincing `syntax-ppss-flush-cache' to flush to before
;; that fence when any char of the 3-char delimiter
;; is modified.
(put-text-property (1- quote-ending-pos) quote-ending-pos
'syntax-table (string-to-syntax "|")))
(t
;; This set of quotes delimit the end of a string. Put
;; string fence syntax on first quote. (bug#49518)
(put-text-property quote-starting-pos (1+ quote-starting-pos)
'syntax-table (string-to-syntax "|"))))))
(defvar mojo-mode-syntax-table
(let ((table (make-syntax-table)))
;; Give punctuation syntax to ASCII that normally has symbol
;; syntax or has word syntax and isn't a letter.
(let ((symbol (string-to-syntax "_"))
(sst (standard-syntax-table)))
(dotimes (i 128)
(unless (= i ?_)
(if (equal symbol (aref sst i))
(modify-syntax-entry i "." table)))))
(modify-syntax-entry ?$ "." table)
(modify-syntax-entry ?% "." table)
;; exceptions
(modify-syntax-entry ?# "<" table)
(modify-syntax-entry ?\n ">" table)
(modify-syntax-entry ?' "\"" table)
(modify-syntax-entry ?` "$" table)
table)
"Syntax table for Mojo files.")
(defvar mojo-dotty-syntax-table
(let ((table (make-syntax-table mojo-mode-syntax-table)))
(modify-syntax-entry ?. "w" table)
(modify-syntax-entry ?_ "w" table)
table)
"Dotty syntax table for Mojo files.
It makes underscores and dots word constituent chars.")
;;; Indentation
(defcustom mojo-indent-offset 4
"Default indentation offset for Mojo."
:type 'integer
:safe 'integerp)
(defcustom mojo-indent-guess-indent-offset t
"Non-nil tells Mojo mode to guess `mojo-indent-offset' value."
:type 'boolean
:safe 'booleanp)
(defcustom mojo-indent-guess-indent-offset-verbose t
"Non-nil means to emit a warning when indentation guessing fails."
:version "25.1"
:type 'boolean
:safe' booleanp)
(defcustom mojo-indent-trigger-commands
'(indent-for-tab-command yas-expand yas/expand)
"Commands that might trigger a `mojo-indent-line' call."
:type '(repeat symbol))
(defcustom mojo-indent-def-block-scale 2
"Multiplier applied to indentation inside multi-line def blocks."
:version "26.1"
:type 'integer
:safe 'natnump)
(defun mojo-indent-guess-indent-offset ()
"Guess and set `mojo-indent-offset' for the current buffer."
(interactive)
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(let ((block-end))
(while (and (not block-end)
(re-search-forward
(mojo-rx line-start block-start) nil t))
(when (and
(not (mojo-syntax-context-type))
(progn
(goto-char (line-end-position))
(mojo-util-forward-comment -1)
(if (equal (char-before) ?:)
t
(forward-line 1)
(when (mojo-info-block-continuation-line-p)
(while (and (mojo-info-continuation-line-p)
(not (eobp)))
(forward-line 1))
(mojo-util-forward-comment -1)
(when (equal (char-before) ?:)
t)))))
(setq block-end (point-marker))))
(let ((indentation
(when block-end
(goto-char block-end)
(mojo-util-forward-comment)
(current-indentation))))
(if (and indentation (not (zerop indentation)))
(setq-local mojo-indent-offset indentation)
(when mojo-indent-guess-indent-offset-verbose
(message "Can't guess mojo-indent-offset, using defaults: %s"
mojo-indent-offset))))))))
(defun mojo-indent-context ()
"Get information about the current indentation context.
Context is returned in a cons with the form (STATUS . START).
STATUS can be one of the following:
keyword
-------
:after-comment
- Point is after a comment line.
- START is the position of the \"#\" character.
:inside-string
- Point is inside string.
- START is the position of the first quote that starts it.
:no-indent
- No possible indentation case matches.
- START is always zero.
:inside-paren
- Fallback case when point is inside paren.
- START is the first non space char position *after* the open paren.
:inside-paren-at-closing-nested-paren
- Point is on a line that contains a nested paren closer.
- START is the position of the open paren it closes.
:inside-paren-at-closing-paren
- Point is on a line that contains a paren closer.
- START is the position of the open paren.
:inside-paren-newline-start
- Point is inside a paren with items starting in their own line.
- START is the position of the open paren.
:inside-paren-newline-start-from-block
- Point is inside a paren with items starting in their own line
from a block start.
- START is the position of the open paren.
:after-backslash
- Fallback case when point is after backslash.
- START is the char after the position of the backslash.
:after-backslash-assignment-continuation
- Point is after a backslashed assignment.
- START is the char after the position of the backslash.
:after-backslash-block-continuation
- Point is after a backslashed block continuation.
- START is the char after the position of the backslash.
:after-backslash-dotted-continuation
- Point is after a backslashed dotted continuation. Previous
line must contain a dot to align with.
- START is the char after the position of the backslash.
:after-backslash-first-line
- First line following a backslashed continuation.
- START is the char after the position of the backslash.
:after-block-end
- Point is after a line containing a block ender.
- START is the position where the ender starts.
:after-block-start
- Point is after a line starting a block.
- START is the position where the block starts.
:after-line
- Point is after a simple line.
- START is the position where the previous line starts.
:at-dedenter-block-start
- Point is on a line starting a dedenter block.
- START is the position where the dedenter block starts."
(let ((ppss (save-excursion
(beginning-of-line)
(syntax-ppss))))
(cond
;; Beginning of buffer.
((= (line-number-at-pos) 1)
(cons :no-indent 0))
;; Inside a string.
((let ((start (mojo-syntax-context 'string ppss)))
(when start
(cons (if (mojo-info-docstring-p)
:inside-docstring
:inside-string) start))))
;; Inside a paren.
((let* ((start (mojo-syntax-context 'paren ppss))
(starts-in-newline
(when start
(save-excursion
(goto-char start)
(forward-char)
(not
(= (line-number-at-pos)
(progn
(mojo-util-forward-comment)
(line-number-at-pos))))))))
(when start
(cond
;; Current line only holds the closing paren.
((save-excursion
(skip-syntax-forward " ")
(when (and (mojo-syntax-closing-paren-p)
(progn
(forward-char 1)
(not (mojo-syntax-context 'paren))))
(cons :inside-paren-at-closing-paren start))))
;; Current line only holds a closing paren for nested.
((save-excursion
(back-to-indentation)
(mojo-syntax-closing-paren-p))
(cons :inside-paren-at-closing-nested-paren start))
;; This line starts from an opening block in its own line.
((save-excursion
(goto-char start)
(when (and
starts-in-newline
(save-excursion
(back-to-indentation)
(looking-at (mojo-rx block-start))))
(cons
:inside-paren-newline-start-from-block start))))
(starts-in-newline
(cons :inside-paren-newline-start start))
;; General case.
(t (cons :inside-paren
(save-excursion
(goto-char (1+ start))
(skip-syntax-forward "(" 1)
(skip-syntax-forward " ")
(point))))))))
;; After backslash.
((let ((start (when (not (mojo-syntax-comment-or-string-p ppss))
(mojo-info-line-ends-backslash-p
(1- (line-number-at-pos))))))
(when start
(cond
;; Continuation of dotted expression.
((save-excursion
(back-to-indentation)
(when (eq (char-after) ?\.)
;; Move point back until it's not inside a paren.
(while (prog2
(forward-line -1)
(and (not (bobp))
(mojo-syntax-context 'paren))))
(goto-char (line-end-position))
(while (and (search-backward
"." (line-beginning-position) t)
(mojo-syntax-context-type)))
;; Ensure previous statement has dot to align with.
(when (and (eq (char-after) ?\.)
(not (mojo-syntax-context-type)))
(cons :after-backslash-dotted-continuation (point))))))
;; Continuation of block definition.
((let ((block-continuation-start
(mojo-info-block-continuation-line-p)))
(when block-continuation-start
(save-excursion
(goto-char block-continuation-start)
(re-search-forward
(mojo-rx block-start (* space))
(line-end-position) t)
(cons :after-backslash-block-continuation (point))))))
;; Continuation of assignment.
((let ((assignment-continuation-start
(mojo-info-assignment-continuation-line-p)))
(when assignment-continuation-start
(save-excursion
(goto-char assignment-continuation-start)
(cons :after-backslash-assignment-continuation (point))))))
;; First line after backslash continuation start.
((save-excursion
(goto-char start)
(when (or (= (line-number-at-pos) 1)
(not (mojo-info-beginning-of-backslash
(1- (line-number-at-pos)))))
(cons :after-backslash-first-line start))))
;; General case.
(t (cons :after-backslash start))))))
;; After beginning of block.
((let ((start (save-excursion
(back-to-indentation)
(mojo-util-forward-comment -1)
(when (equal (char-before) ?:)
(mojo-nav-beginning-of-block)))))
(when start
(cons :after-block-start start))))
;; At dedenter statement.
((let ((start (mojo-info-dedenter-statement-p)))
(when start
(cons :at-dedenter-block-start start))))
;; After normal line, comment or ender (default case).
((save-excursion
(back-to-indentation)
(skip-chars-backward " \t\n")
(if (bobp)
(cons :no-indent 0)
(mojo-nav-beginning-of-statement)
(cons
(cond ((mojo-info-current-line-comment-p)
:after-comment)
((save-excursion
(goto-char (line-end-position))
(mojo-util-forward-comment -1)
(mojo-nav-beginning-of-statement)
(looking-at (mojo-rx block-ender)))
:after-block-end)
(t :after-line))
(point))))))))
(defun mojo-indent--calculate-indentation ()
"Internal implementation of `mojo-indent-calculate-indentation'.
May return an integer for the maximum possible indentation at
current context or a list of integers. The latter case is only
happening for :at-dedenter-block-start context since the
possibilities can be narrowed to specific indentation points."
(save-excursion
(pcase (mojo-indent-context)
(`(:no-indent . ,_) (prog-first-column)) ; usually 0
(`(,(or :after-line
:after-comment
:inside-string
:after-backslash) . ,start)
;; Copy previous indentation.
(goto-char start)
(current-indentation))
(`(,(or :inside-paren-at-closing-paren
:inside-paren-at-closing-nested-paren) . ,start)
(goto-char (+ 1 start))
(if (looking-at "[ \t]*\\(?:#\\|$\\)")
;; Copy previous indentation.
(current-indentation)
;; Align with opening paren.
(current-column)))
(`(:inside-docstring . ,start)
(let* ((line-indentation (current-indentation))
(base-indent (progn
(goto-char start)
(current-indentation))))
(max line-indentation base-indent)))
(`(,(or :after-block-start
:after-backslash-first-line
:after-backslash-assignment-continuation
:inside-paren-newline-start) . ,start)
;; Add one indentation level.
(goto-char start)
(+ (current-indentation) mojo-indent-offset))