-
-
Notifications
You must be signed in to change notification settings - Fork 62
/
julia-mode.el
1010 lines (907 loc) · 43.6 KB
/
julia-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
;;; julia-mode.el --- Major mode for editing Julia source code -*- lexical-binding: t -*-
;; Copyright (C) 2009-2014 Julia contributors, 2015-2024 julia-mode.el contributors
;; URL: https://github.com/JuliaEditorSupport/julia-emacs
;; Version: 1.0.0
;; Keywords: languages
;; Package-Requires: ((emacs "26.1"))
;;; Usage:
;; Put the following code in your .emacs, site-load.el, or other relevant file
;; (add-to-list 'load-path "path-to-julia-mode")
;; (require 'julia-mode)
;;; Commentary:
;; This is the official Emacs mode for editing Julia programs.
;;; License:
;; Permission is hereby granted, free of charge, to any person obtaining
;; a copy of this software and associated documentation files (the
;; "Software"), to deal in the Software without restriction, including
;; without limitation the rights to use, copy, modify, merge, publish,
;; distribute, sublicense, and/or sell copies of the Software, and to
;; permit persons to whom the Software is furnished to do so, subject to
;; the following conditions:
;;
;; The above copyright notice and this permission notice shall be
;; included in all copies or substantial portions of the Software.
;;
;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
;; NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
;; LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
;; OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
;; WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
;;; Code:
(require 'cl-lib)
(require 'julia-mode-latexsubs)
(eval-when-compile (require 'subr-x))
(defvar julia-mode-hook nil)
(defgroup julia ()
"Major mode for the julia programming language."
:group 'languages
:prefix "julia-")
;; all custom variables are automatically added to the most recent defgroup
(defcustom julia-indent-offset 4
"Number of spaces per indentation level."
:safe (lambda (n) (and (> n 1) (<= n 8)))
:type 'integer)
(defcustom julia-force-tab-complete t
"Use Tab for completion instead of M-Tab in `julia-mode'.
This overrides `tab-always-indent' in `julia-mode' buffers."
:type 'boolean)
(defcustom julia-automatic-latexsub t
"After completing a LaTeX symbol, replace it with corresponding unicode.
`ivy-mode' completion will not trigger automatic latexsub due to
upstream bug: <https://github.com/abo-abo/swiper/issues/2345>.
User can still use `abbrev-mode' or `expand-abbrev' to substitute
unicode for LaTeX even if disabled."
:type 'boolean)
(defcustom julia-latexsub-greedy t
"When `t', `julia-latexsub-or-indent' does not offer options when a complete match is found. Eg for \"\\bar\", \"\\barcap\" etc will not be offered in a prompt."
:type 'boolean)
(defun julia-latexsub-selector-completing-read (replacements)
"Use `completing-read' to pick an item from REPLACEMENTS."
(completing-read "LaTeX completions: " replacements (lambda (&rest _) t) t))
(defvar julia-latexsub-selector 'julia-latexsub-selector-completing-read
"A function that is called when the `julia-latexsub-or-indent' finds multiple matches for a prefix.
The argument is a list of strings. The function should ALWAYS return an item from this list, otherwise an error occurs.
The default implementation uses `completing-read'.")
(defconst julia-mode--latexsubs-partials
(let ((table-unordered (make-hash-table :test 'equal))
(table-ordered (make-hash-table :test 'equal)))
(cl-flet ((_append (key replacement)
(puthash key (cons replacement (gethash key table-unordered nil)) table-unordered)))
;; accumulate partials
(maphash (lambda (latex _unicode)
(cl-assert (string= (substring latex 0 1) "\\") nil
"LaTeX substitution does not start with \\.")
(let ((len (length latex)))
(cl-assert (< 1 len) nil "Trivially short LaTeX subtitution")
;; for \foo, put \f, \fo, \foo into the table
(cl-loop for i from 2 to len
do (_append (substring latex 0 i) latex))))
julia-mode-latexsubs)
;; order by LaTeX part
(maphash (lambda (partial replacements)
(puthash partial (sort replacements #'string<) table-ordered))
table-unordered))
table-ordered)
"A hash table containing all partial strings from the LaTeX abbreviations in
`julia-mode-latexsubs' as keys. Values are sorted lists of complete \"\\some_string\".")
(defun julia-mode--latexsubs-longest-partial-end (beg)
"Starting at `beg' (should be the \"\\\"), return the end of the longest
partial match for LaTeX completion, or `nil' when not applicable."
(save-excursion
(goto-char beg)
(when (and (= (char-after) ?\\) (not (eobp)))
(let ((beg (point)))
(forward-char) ; move past the \
(cl-flet ((next-char-matches? ()
(let* ((end (1+ (point)))
(str (buffer-substring-no-properties beg end))
(valid? (gethash str julia-mode--latexsubs-partials)))
valid?)))
(while (and (not (eobp)) (next-char-matches?))
(forward-char)))
(point)))))
(defface julia-macro-face
'((t :inherit font-lock-preprocessor-face))
"Face for Julia macro invocations.")
(defface julia-quoted-symbol-face
'((t :inherit font-lock-constant-face))
"Face for quoted Julia symbols, e.g. :foo.")
;;;###autoload
(add-to-list 'auto-mode-alist '("\\.jl\\'" . julia-mode))
(defvar julia-mode-syntax-table
(let ((table (make-syntax-table)))
(modify-syntax-entry ?_ "_" table)
(modify-syntax-entry ?@ "_" table)
;; "!" can be part of both operators (!=) and variable names (append!). Here, we treat
;; it as being part of a variable name. Care must be taken to account for the special
;; case where "!" prefixes a variable name and acts as an operator (e.g. !any(...)).
(modify-syntax-entry ?! "_" table)
(modify-syntax-entry ?# "< 14" table) ; # single-line and multiline start
(modify-syntax-entry ?= ". 23bn" table)
(modify-syntax-entry ?\n ">" table) ; \n single-line comment end
(modify-syntax-entry ?\{ "(} " table)
(modify-syntax-entry ?\} "){ " table)
(modify-syntax-entry ?\[ "(] " table)
(modify-syntax-entry ?\] ")[ " table)
(modify-syntax-entry ?\( "() " table)
(modify-syntax-entry ?\) ")( " table)
;; Here, we treat ' as punctuation (when it's used for transpose),
;; see our use of `julia-char-regex' for handling ' as a character
;; delimiter
(modify-syntax-entry ?' "." table)
(modify-syntax-entry ?\" "\"" table)
(modify-syntax-entry ?` "\"" table)
;; Backslash has escape syntax for use in strings but
;; julia-syntax-propertize-function sets punctuation syntax on it
;; outside strings.
(modify-syntax-entry ?\\ "\\" table)
(modify-syntax-entry ?. "." table)
(modify-syntax-entry ?? "." table)
(modify-syntax-entry ?$ "." table)
(modify-syntax-entry ?& "." table)
(modify-syntax-entry ?* "." table)
(modify-syntax-entry ?/ "." table)
(modify-syntax-entry ?+ "." table)
(modify-syntax-entry ?- "." table)
(modify-syntax-entry ?< "." table)
(modify-syntax-entry ?> "." table)
(modify-syntax-entry ?% "." table)
(modify-syntax-entry ?′ "w" table) ; \prime is a word constituent
table)
"Syntax table for `julia-mode'.")
(eval-when-compile
(defconst julia-char-regex
(rx (or (any "-" ";" "\\" "^" "!" "|" "?" "*" "<" "%" "," "=" ">" "+" "/" "&" "$" "~" ":")
(syntax open-parenthesis)
(syntax whitespace)
bol)
(group "'") ; start single quote of character constant
(or ; two alternatives
(not (any "\\")) ; one character, not backslash
(seq "\\" ; sequence of a backslash followed by ...
(or ; five alternatives
(any "\\'\"abfnrtv") ; single character escape
(repeat 1 3 (any "0-7")) ; octal escape
(seq "x" (repeat 1 2 hex)) ; hex escape
(seq "u" (repeat 1 4 hex)) ; unicode escape
(seq "U" (repeat 1 8 hex))))) ; extended unicode escape
(group "'")))) ; end single quote of character constant
(defconst julia-hanging-operator-regexp
;; taken from julia-parser.scm
(rx (or
;; conditional
"?"
;; assignment
"=" ":=" "+=" "-=" "*=" "/=" "//=" ".//=" ".*=" "./=" "\\=" ".\\="
"^=" ".^=" "÷=" ".÷=" "%=" ".%=" "|=" "&=" "$=" "=>" "<<=" ">>="
">>>=" "~" ".+=" ".-="
;; arrow
"--" "-->" "←" "→" "↔" "↚" "↛" "↠" "↣" "↦" "↮" "⇎" "⇏" "⇒" "⇔" "⇴"
"⇶" "⇷" "⇸" "⇹" "⇺" "⇻" "⇼" "⇽" "⇾" "⇿" "⟵" "⟶" "⟷" "⟷" "⟹"
"⟺" "⟻" "⟼" "⟽" "⟾" "⟿" "⤀" "⤁" "⤂" "⤃" "⤄" "⤅" "⤆" "⤇" "⤌"
"⤍" "⤎" "⤏" "⤐" "⤑" "⤔" "⤕" "⤖" "⤗" "⤘" "⤝" "⤞" "⤟" "⤠" "⥄" "⥅"
"⥆" "⥇" "⥈" "⥊" "⥋" "⥎" "⥐" "⥒" "⥓" "⥖" "⥗" "⥚" "⥛" "⥞" "⥟" "⥢"
"⥤" "⥦" "⥧" "⥨" "⥩" "⥪" "⥫" "⥬" "⥭" "⥰" "⧴" "⬱" "⬰" "⬲" "⬳" "⬴"
"⬵" "⬶" "⬷" "⬸" "⬹" "⬺" "⬻" "⬼" "⬽" "⬾" "⬿" "⭀" "⭁" "⭂" "⭃" "⭄"
"⭇" "⭈" "⭉" "⭊" "⭋" "⭌" "￩" "￫"
;; or and and
"&&" "||"
;; comparison
">" "<" ">=" "≥" "<=" "≤" "==" "===" "≡" "!=" "≠" "!==" "≢" ".>"
".<" ".>=" ".≥" ".<=" ".≤" ".==" ".!=" ".≠" ".=" ".!" "<:" ">:" "∈"
"∉" "∋" "∌" "⊆" "⊈" "⊂" "⊄" "⊊" "∝" "∊" "∍" "∥" "∦" "∷" "∺" "∻" "∽"
"∾" "≁" "≃" "≄" "≅" "≆" "≇" "≈" "≉" "≊" "≋" "≌" "≍" "≎" "≐" "≑" "≒"
"≓" "≔" "≕" "≖" "≗" "≘" "≙" "≚" "≛" "≜" "≝" "≞" "≟" "≣" "≦" "≧" "≨"
"≩" "≪" "≫" "≬" "≭" "≮" "≯" "≰" "≱" "≲" "≳" "≴" "≵" "≶" "≷" "≸" "≹"
"≺" "≻" "≼" "≽" "≾" "≿" "⊀" "⊁" "⊃" "⊅" "⊇" "⊉" "⊋" "⊏" "⊐" "⊑" "⊒"
"⊜" "⊩" "⊬" "⊮" "⊰" "⊱" "⊲" "⊳" "⊴" "⊵" "⊶" "⊷" "⋍" "⋐" "⋑" "⋕" "⋖"
"⋗" "⋘" "⋙" "⋚" "⋛" "⋜" "⋝" "⋞" "⋟" "⋠" "⋡" "⋢" "⋣" "⋤" "⋥" "⋦" "⋧"
"⋨" "⋩" "⋪" "⋫" "⋬" "⋭" "⋲" "⋳" "⋴" "⋵" "⋶" "⋷" "⋸" "⋹" "⋺" "⋻" "⋼"
"⋽" "⋾" "⋿" "⟈" "⟉" "⟒" "⦷" "⧀" "⧁" "⧡" "⧣" "⧤" "⧥" "⩦" "⩧" "⩪" "⩫"
"⩬" "⩭" "⩮" "⩯" "⩰" "⩱" "⩲" "⩳" "⩴" "⩵" "⩶" "⩷" "⩸" "⩹" "⩺" "⩻" "⩼"
"⩽" "⩾" "⩿" "⪀" "⪁" "⪂" "⪃" "⪄" "⪅" "⪆" "⪇" "⪈" "⪉" "⪊" "⪋" "⪌" "⪍"
"⪎" "⪏" "⪐" "⪑" "⪒" "⪓" "⪔" "⪕" "⪖" "⪗" "⪘" "⪙" "⪚" "⪛" "⪜" "⪝" "⪞"
"⪟" "⪠" "⪡" "⪢" "⪣" "⪤" "⪥" "⪦" "⪧" "⪨" "⪩" "⪪" "⪫" "⪬" "⪭" "⪮" "⪯"
"⪰" "⪱" "⪲" "⪳" "⪴" "⪵" "⪶" "⪷" "⪸" "⪹" "⪺" "⪻" "⪼" "⪽" "⪾" "⪿" "⫀"
"⫁" "⫂" "⫃" "⫄" "⫅" "⫆" "⫇" "⫈" "⫉" "⫊" "⫋" "⫌" "⫍" "⫎" "⫏" "⫐" "⫑"
"⫒" "⫓" "⫔" "⫕" "⫖" "⫗" "⫘" "⫙" "⫷" "⫸" "⫹" "⫺" "⊢" "⊣"
;; pipe, colon
"|>" "<|" ":" ".."
;; plus
"+" "-" "⊕" "⊖" "⊞" "⊟" ".+" ".-" "++" "|" "∪" "∨" "$" "⊔" "±" "∓"
"∔" "∸" "≂" "≏" "⊎" "⊻" "⊽" "⋎" "⋓" "⧺" "⧻" "⨈" "⨢" "⨣" "⨤" "⨥" "⨦"
"⨧" "⨨" "⨩" "⨪" "⨫" "⨬" "⨭" "⨮" "⨹" "⨺" "⩁" "⩂" "⩅" "⩊" "⩌" "⩏" "⩐"
"⩒" "⩔" "⩖" "⩗" "⩛" "⩝" "⩡" "⩢" "⩣"
;; bitshift
"<<" ">>" ">>>" ".<<" ".>>" ".>>>"
;; times
"*" "/" "./" "÷" ".÷" "%" "⋅" "∘" "×" ".%" ".*" "\\"
".\\" "&" "∩" "∧" "⊗" "⊘" "⊙" "⊚" "⊛" "⊠" "⊡" "⊓" "∗" "∙" "∤" "⅋"
"≀" "⊼" "⋄" "⋆" "⋇" "⋉" "⋊" "⋋" "⋌" "⋏" "⋒" "⟑" "⦸" "⦼" "⦾" "⦿" "⧶"
"⧷" "⨇" "⨰" "⨱" "⨲" "⨳" "⨴" "⨵" "⨶" "⨷" "⨸" "⨻" "⨼" "⨽" "⩀" "⩃" "⩄"
"⩋" "⩍" "⩎" "⩑" "⩓" "⩕" "⩘" "⩚" "⩜" "⩞" "⩟" "⩠" "⫛" "⊍" "▷" "⨝" "⟕"
"⟖" "⟗"
;; rational
"//" ".//"
;; power
"^" ".^" "↑" "↓" "⇵" "⟰" "⟱" "⤈" "⤉" "⤊" "⤋" "⤒" "⤓" "⥉" "⥌" "⥍"
"⥏" "⥑" "⥔" "⥕" "⥘" "⥙" "⥜" "⥝" "⥠" "⥡" "⥣" "⥥" "⥮" "⥯" "￪" "￬"
;; decl, dot
"::" ".")
(* blank)
(or eol ?#)))
(defconst julia-unquote-regex
"\\(\\s(\\|\\s-\\|-\\|[,%=<>\\+*/?&|!\\^~\\\\;:]\\|^\\)\\($[a-zA-Z0-9_]+\\)")
(defconst julia-forloop-in-regex
"for +.*[^
].* \\(in\\)\\(\\s-\\|$\\)+")
(defconst julia--forloop-=-regex
(rx "for"
(1+ ? )
;; expression can't end and no newline before = portion of forloop.
(1+ (not (any ?\n ?\; ?=)))
(group (any ?= ?∈))
;; don't want to match on == expression instead of =.
(not (any ?=))))
(defconst julia-ternary-regex
" +\\(\\?\\)[
]+[^
]* +\\(:\\)[
]+")
;; functions of form "function f(x) nothing end"
(defconst julia-function-regex
(rx line-start (* (or space "@inline" "@noinline")) symbol-start
"function"
(1+ space)
;; Don't highlight module names in function declarations:
(* (seq (1+ (or word (syntax symbol))) "."))
;; The function name itself
(group (1+ (or word (syntax symbol))))))
;; TODO: function definitions of form "x + y = 5" or "!x = true" not currently highlighted
;; functions of form "f(x) = nothing"
(defconst julia-function-assignment-regex
(rx line-start (* (or space "@inline" "@noinline")) symbol-start
(* (seq (1+ (or word (syntax symbol))) ".")) ; module name
(group (1+ (or word (syntax symbol))))
"(" (* (or
(seq "(" (* (not (any "(" ")"))) ")")
(not (any "(" ")"))))
")"
(* space)
(? "::" (* space) (1+ (not (any space))))
(* space)
(* (seq "where" (or "{" (+ space)) (+ (not (any "=")))))
"="
(not (any "="))))
(defconst julia-type-regex
(rx symbol-start (or ;;"immutable" "type" ;; remove after 0.6
"abstract type" "primitive type" "struct" "mutable struct")
(1+ space) (group (1+ (or word (syntax symbol))))))
(defconst julia-const-def-regex
(rx
symbol-start "const" (1+ space)
(group (minimal-match (seq symbol-start (one-or-more anything) symbol-end)))
(zero-or-more space)
"="))
(defconst julia-type-annotation-regex
(rx "::" (0+ space) (group (1+ (or word (syntax symbol))))))
(defconst julia-subtype-regex
(rx "<:" (0+ space) (group (1+ (or word (syntax symbol)))) (0+ space) (or "\n" "{" "}" "end" ",")))
(defconst julia-macro-regex
(rx symbol-start (0+ ?!) (group "@" (1+ (or word (syntax symbol))))))
(defconst julia-keyword-regex
(regexp-opt
'("if" "else" "elseif" "while" "for" "begin" "end" "quote"
"try" "catch" "return" "local" "function" "macro"
"finally" "break" "continue" "global" "where"
"module" "using" "import" "export" "const" "let" "do"
"baremodule"
;; "importall" ;; deprecated in 0.7
;; "immutable" "type" "bitstype" "abstract" "typealias" ;; removed in 1.0
"abstract type" "primitive type" "struct" "mutable struct")
'symbols))
(defconst julia-quoted-symbol-regex
;; :foo and :foo2 are valid, but :123 is not.
(rx (or bol whitespace "(" "[" "," "=")
(group ":" (or letter (syntax symbol)) (0+ (or word (syntax symbol))))))
(defconst julia-font-lock-keywords
;; font-lock-builtin-face intentionally unused since any name from
;; names(Base) can be aliased in a baremodule.
(list
;; Highlight quoted symbols before keywords, so :function is not
;; highlighted as a keyword.
(list julia-quoted-symbol-regex 1 ''julia-quoted-symbol-face)
(cons julia-keyword-regex 'font-lock-keyword-face)
(list julia-macro-regex 1 ''julia-macro-face)
(cons
(regexp-opt
;; constants defined in Core plus true/false
'("true" "false" "Cvoid" "Inf" "NaN" "Inf32" "NaN32" "nothing" "undef" "missing")
'symbols)
'font-lock-constant-face)
(cons "ccall" 'font-lock-builtin-face)
(list julia-unquote-regex 2 'font-lock-constant-face)
(list julia-forloop-in-regex 1 'font-lock-keyword-face)
(list julia--forloop-=-regex 1 'font-lock-keyword-face)
(list julia-ternary-regex (list 1 'font-lock-keyword-face) (list 2 'font-lock-keyword-face))
(list julia-function-regex 1 'font-lock-function-name-face)
(list julia-function-assignment-regex 1 'font-lock-function-name-face)
(list julia-type-regex 1 'font-lock-type-face)
;; Per the elisp manual, font-lock-variable-name-face is for variables being defined or
;; declared. It is difficult identify this consistently in julia (see issue #2). For now,
;; we only font-lock constant definitions.
(list julia-const-def-regex 1 'font-lock-variable-name-face)
;; font-lock-type-face is for the point of type definition rather
;; than usage, but using for type annotations is an acceptable pun.
(list julia-type-annotation-regex 1 'font-lock-type-face)
(list julia-subtype-regex 1 'font-lock-type-face)))
(defconst julia-block-start-keywords
(list "if" "while" "for" "begin" "try" "function" "let" "macro"
"quote" "do" "module" "baremodule"
;; "immutable" "type" ;; remove after 0.6
"abstract type" "primitive type" "struct" "mutable struct"))
;; For keywords that begin a block without additional indentation
(defconst julia-block-start-keywords-no-indent
(list "module" "baremodule"))
(defconst julia-block-end-keywords
(list "end" "else" "elseif" "catch" "finally"))
(defsubst julia-syntax-comment-or-string-p (&optional syntax-ppss)
"Return non-nil if SYNTAX-PPSS is inside string or comment."
(nth 8 (or syntax-ppss (syntax-ppss))))
(defun julia-in-comment (&optional syntax-ppss)
"Return non-nil if point is inside a comment using SYNTAX-PPSS.
Handles both single-line and multi-line comments."
(nth 4 (or syntax-ppss (syntax-ppss))))
(defun julia-in-string (&optional syntax-ppss)
"Return non-nil if point is inside a string using SYNTAX-PPSS.
Note this is Emacs' notion of what is highlighted as a string.
As a result, it is true inside \"foo\", \\=`foo\\=` and \\='f\\='."
(nth 3 (or syntax-ppss (syntax-ppss))))
(defconst julia-syntax-propertize-function
(syntax-propertize-rules
;; triple-quoted strings are a single string rather than 3
("\"\"\""
(0 (ignore (julia-syntax-stringify))))
;; same with triple-quoted backticks
("```"
(0 (ignore (julia-syntax-stringify))))
;; backslash acts as an operator if it's not inside a string
("\\\\"
(0 (unless (julia-in-string
(save-excursion (syntax-ppss (match-beginning 0))))
(string-to-syntax "."))))
(julia-char-regex
;; treat ' in 'c' as string-delimiter
(1 "\"")
(2 "\""))))
(defun julia-syntax-stringify ()
"Put `syntax-table' property correctly on triple-quoted strings and cmds."
(let* ((ppss (save-excursion (syntax-ppss (match-beginning 0))))
(string-open (and (not (nth 4 ppss)) (nth 8 ppss))))
(cond
;; this set of quotes delimit the start of string/cmd
((not string-open)
(put-text-property (match-beginning 0) (1+ (match-beginning 0))
'syntax-table (string-to-syntax "|")))
;; this set of quotes closes the current string/cmd
((and
;; check that """ closes """ and ``` closes ```
(eq (char-before) (char-after string-open))
;; check that triple quote isn't escaped by odd number of backslashes
(let ((i 0))
(while (and (< (point-min) (- (match-beginning 0) i))
(eq (char-before (- (match-beginning 0) i)) ?\\))
(setq i (1+ i)))
(cl-evenp i)))
(put-text-property (1- (match-end 0)) (match-end 0)
'syntax-table (string-to-syntax "|")))
;; Put point after (match-beginning 0) to account for possibility
;; of overlapping triple-quotes with first escaped
((backward-char 2)))))
(defun julia-in-multiline-string (&optional syntax-pps)
"Return non-nil if point is inside multi-line string using SYNTAX-PPS."
(and (julia-in-string syntax-pps)
(save-excursion (beginning-of-line)
(julia-in-string syntax-pps))))
(defun julia-in-brackets ()
"Return non-nil if point is inside square brackets."
(let ((start-pos (point))
(open-count 0))
;; Count all the [ and ] characters on the current line.
(save-excursion
(beginning-of-line)
(while (< (point) start-pos)
;; Don't count [ or ] inside strings, characters or comments.
(unless (julia-syntax-comment-or-string-p)
(when (looking-at (rx "["))
(cl-incf open-count))
(when (looking-at (rx "]"))
(cl-decf open-count)))
(forward-char 1)))
;; If we've opened more than we've closed, we're inside brackets.
(cl-plusp open-count)))
(defun julia-at-keyword (kw-list)
"Return the word at point if it matches any keyword in KW-LIST.
KW-LIST is a list of strings. The word at point is not considered
a keyword if used as a field name, X.word, or quoted, :word."
(and (or (bobp)
(and (not (equal (char-before (point)) ?.))
(not (equal (char-before (point)) ?:))))
(not (looking-at "(")) ; handle "function(" when on (
(member (current-word t) kw-list)
;; 'end' is not a keyword when used for indexing, e.g. foo[end-2]
(or (not (equal (current-word t) "end"))
(not (julia-in-brackets)))
(not (julia-in-comment))))
;; if backward-sexp gives an error, move back 1 char to move over the '('
(defun julia-safe-backward-sexp ()
(if (condition-case nil (backward-sexp) (error t))
(ignore-errors (backward-char))))
(defun julia-following-import-export-using ()
"If the current line follows an `export` or `import` keyword
with valid syntax, return the position of the keyword, otherwise
`nil`. Works by stepping backwards through comma-separated
symbol, gives up when this is not true."
;; Implementation accepts a single Module: right after the keyword, and saves
;; the module name for future use, but does not enforce that `export` has no
;; module name.
(let ((done nil) ; find keyword or give up
(module nil)) ; found "Module:"
(save-excursion
(beginning-of-line)
(while (and (not done) (< (point-min) (point)))
(julia-safe-backward-sexp)
(cond
((looking-at (regexp-opt (list "import" "export" "using")))
(setf done (point)))
((looking-at (rx (group (* (or word (syntax symbol)))) (0+ space) ":"))
(if module
(setf done 'broken)
(setf module (match-string-no-properties 1))))
((looking-at (rx (* (or word (syntax symbol))) (0+ space) ","))
(when module (setf done 'broken)))
((looking-at (rx (* (or word (syntax symbol))) "."))
(setf module (concat (match-string-no-properties 0) module)))
(t (setf done 'broken)))))
(if (eq done 'broken)
nil
done)))
(defun julia-last-open-block-pos (min)
"Return the position of the last open block, if one found.
Do not move back beyond position MIN."
(save-excursion
(let ((nesting-count 0))
(while (not (or (> nesting-count 0) (<= (point) min)))
(julia-safe-backward-sexp)
(setq nesting-count
(cond ((julia-at-keyword julia-block-start-keywords)
(+ nesting-count 1))
((julia-at-keyword '("end"))
(- nesting-count 1))
(t nesting-count))))
(if (> nesting-count 0)
(point)
nil))))
(defun julia-last-open-block (min)
"Move back and return indentation level for last open block.
Do not move back beyond MIN."
;; Ensure MIN is not before the start of the buffer.
(setq min (max min (point-min)))
(let ((pos (julia-last-open-block-pos min)))
(and pos
(progn
(goto-char pos)
(+ julia-indent-offset (julia-block-open-indentation))))))
(defun julia-block-open-indentation ()
"Get the current indentation or the start of a parenthetical block."
(save-excursion
(save-restriction
;; narrow to one line to only search syntax on that line
(narrow-to-region (line-beginning-position) (line-end-position))
(condition-case nil
(progn
(backward-up-list)
(1+ (current-column)))
(error (current-indentation))))))
(defcustom julia-max-block-lookback 20000
"When indenting, don't look back more than this many characters
to see if there are unclosed blocks.
This variable has a small effect on indent performance if set
too high, but stops indenting in the middle of long blocks if set
too low."
:type 'integer)
(defun julia-paren-indent ()
"Return the column of the text following the innermost
containing paren before point, so we can align succeeding code
with it. Returns nil if we're not within nested parens."
(save-excursion
(beginning-of-line)
(let ((parser-state (syntax-ppss)))
(cond ((nth 3 parser-state) nil) ;; strings
((= (nth 0 parser-state) 0) nil) ;; top level
(t
(ignore-errors ;; return nil if any of these movements fail
(beginning-of-line)
(skip-syntax-forward " ")
(let ((possibly-close-paren-point (point)))
(backward-up-list)
(let ((open-paren-point (point)))
(forward-char)
(skip-syntax-forward " ")
(if (eolp)
(progn
(up-list)
(backward-char)
(let ((paren-closed (= (point) possibly-close-paren-point)))
(goto-char open-paren-point)
(beginning-of-line)
(skip-syntax-forward " ")
(+ (current-column)
(if paren-closed
0
julia-indent-offset))))
(current-column))))))))))
(defun julia-prev-line-skip-blank-or-comment ()
"Move point to beginning of previous line skipping blank lines
and lines including only comments. Returns number of lines moved.
A return of -1 signals that we moved to the first line of
the (possibly narrowed) buffer, so there is nowhere else to go."
(catch 'result
(let ((moved 0) this-move)
(while t
(setq this-move (forward-line -1))
(cond
;; moved into comment or blank
((and (= 0 this-move)
(or (looking-at-p "^\\s-*\\(?:#.*\\)*$")
(julia-in-comment)))
(cl-incf moved))
;; success
((= 0 this-move)
(throw 'result (1+ moved)))
;; on first line and in comment
((and (bobp)
(or (looking-at-p "^\\s-*\\(?:#.*\\)*$")
(julia-in-comment)))
(throw 'result -1))
((bobp)
(throw 'result moved))
(t
(throw 'result 0)))))))
(defun julia--hanging-operator-p ()
"Return t if current line ends with a hanging operator."
(and (re-search-forward julia-hanging-operator-regexp (line-end-position) t)
(not (julia-syntax-comment-or-string-p
(save-excursion (syntax-ppss (match-beginning 0)))))))
(defun julia-indent-hanging ()
"Calculate indentation for lines that follow \"hanging\"
operators (operators that end the previous line) as defined in
`julia-hanging-operator-regexp'. An assignment operator ending
the previous line increases the indent as do the other operators
unless another operator is found two lines up. Previous line
means previous line after skipping blank lines and lines with
only comments."
(let (prev-indent)
(save-excursion
(when (> (julia-prev-line-skip-blank-or-comment) 0)
(setq prev-indent (current-indentation))
(when (julia--hanging-operator-p)
(if (and (> (julia-prev-line-skip-blank-or-comment) 0)
(julia--hanging-operator-p))
;; two preceding hanging operators => indent same as line
;; above
prev-indent
;; one preceding hanging operator => increase indent from line
;; above
(+ julia-indent-offset prev-indent)))))))
(defun julia-indent-import-export-using ()
"Indent offset for lines that follow `import` or `export`, otherwise nil."
(when (julia-following-import-export-using)
julia-indent-offset))
(defun julia-indent-line ()
"Indent current line of julia code."
(interactive)
(if (julia-in-multiline-string)
'noindent
(let* ((point-offset (- (current-column) (current-indentation))))
(indent-line-to
(or
;; indent due to hanging operators (lines ending in an operator)
(julia-indent-hanging)
;; indent for import and export
(julia-indent-import-export-using)
;; use julia-paren-indent along with block indentation
(let ((paren-indent (or (julia-paren-indent) 0)))
;; Indent according to how many nested blocks we are in.
(save-excursion
(beginning-of-line)
;; jump out of any comments
(let ((state (syntax-ppss)))
(when (nth 4 state)
(goto-char (nth 8 state))))
(forward-to-indentation 0)
(let ((endtok (julia-at-keyword julia-block-end-keywords))
(last-open-block (julia-last-open-block (- (point) julia-max-block-lookback))))
(max paren-indent (- (or last-open-block paren-indent)
;; subtract indentation if we're at the end of a block
(if (or endtok
(julia-at-keyword julia-block-start-keywords-no-indent))
julia-indent-offset 0))))))))
;; Point is now at the beginning of indentation, restore it
;; to its original position (relative to indentation).
(when (>= point-offset 0)
(move-to-column (+ (current-indentation) point-offset))))))
;;; Navigation
;; based off python.el
(defconst julia-beginning-of-defun-regex
(concat julia-function-regex "\\|"
julia-function-assignment-regex "\\|"
"\\_<macro\\_>")
"Regex matching beginning of Julia function or macro.")
(defun julia-syntax-context-type (&optional syntax-ppss)
"Return the context type using SYNTAX-PPSS.
TYPE 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))))
(defun julia-looking-at-beginning-of-defun (&optional syntax-ppss)
"Check if point is at `beginning-of-defun' using SYNTAX-PPSS."
(and (not (julia-syntax-comment-or-string-p (or syntax-ppss (syntax-ppss))))
(save-excursion
(beginning-of-line 1)
(looking-at julia-beginning-of-defun-regex))))
(defun julia--beginning-of-defun (&optional arg)
"Internal implementation of `julia-beginning-of-defun'.
With positive ARG search backwards, else search forwards."
(when (or (null arg) (= arg 0)) (setq arg 1))
(let* ((re-search-fn (if (> arg 0)
#'re-search-backward
#'re-search-forward))
(line-beg-pos (line-beginning-position))
(line-content-start (+ line-beg-pos (current-indentation)))
(pos (point-marker))
(beg-indentation
(and (> arg 0)
(save-excursion
(while (and (not (julia-looking-at-beginning-of-defun))
;; f(x) = ... function bodies may span multiple lines
(or (and (julia-indent-hanging)
(forward-line -1))
;; inside dangling parameter list
(and (eq 'paren (julia-syntax-context-type))
(backward-up-list))
(julia-last-open-block (point-min)))))
(or (and (julia-looking-at-beginning-of-defun)
(+ (current-indentation) julia-indent-offset))
0))))
(found
(progn
(when (and (< arg 0)
(julia-looking-at-beginning-of-defun))
(end-of-line 1))
(while (and (funcall re-search-fn
julia-beginning-of-defun-regex nil t)
(or (julia-syntax-comment-or-string-p)
;; handle nested defuns when moving backwards
;; by checking matching indentation
(and (> arg 0)
(not (= (current-indentation) 0))
(>= (current-indentation) beg-indentation)))))
(and (julia-looking-at-beginning-of-defun)
(or (not (= (line-number-at-pos pos)
(line-number-at-pos)))
(and (>= (point) line-beg-pos)
(<= (point) line-content-start)
(> pos line-content-start)))))))
(if found
(or (beginning-of-line 1) (point))
(and (goto-char pos) nil))))
(defun julia-beginning-of-defun (&optional arg)
"Move point to `beginning-of-defun'.
With positive ARG search backwards else search forward.
ARG nil or 0 defaults to 1. When searching backwards,
nested defuns are handled depending on current point position.
Return non-nil (point) if point moved to `beginning-of-defun'."
(when (or (null arg) (= arg 0)) (setq arg 1))
(let ((found))
(while (and (not (= arg 0))
(let ((keep-searching-p
(julia--beginning-of-defun arg)))
(when (and keep-searching-p (null found))
(setq found t))
keep-searching-p))
(setq arg (if (> arg 0) (1- arg) (1+ arg))))
found))
(defun julia-end-of-defun ()
"Move point to the end of the current function.
Return nil if point is not in a function, otherwise point."
(interactive)
(let ((beg-defun-indent))
(when (or (julia-looking-at-beginning-of-defun)
(julia-beginning-of-defun 1)
(julia-beginning-of-defun -1))
(beginning-of-line)
(if (looking-at-p julia-function-assignment-regex)
;; f(x) = ...
(progn
;; skip any dangling lines
(while (and (forward-line)
(not (eobp))
(or (julia-indent-hanging)
;; dangling closing paren
(and (eq 'paren (julia-syntax-context-type))
(search-forward ")"))))))
;; otherwise skip forward to matching indentation (not in string/comment)
(setq beg-defun-indent (current-indentation))
(while (and (not (eobp))
(forward-line 1)
(or (julia-syntax-comment-or-string-p)
(> (current-indentation) beg-defun-indent)))))
(end-of-line)
(point))))
;;; abbrev
(define-abbrev-table 'julia-mode-abbrev-table ()
"Abbrev table for Julia mode."
:parents (list julia-latexsub-abbrev-table))
;;; IMENU
(defvar julia-imenu-generic-expression
;; don't use syntax classes, screws egrep
`(("Function" ,julia-function-regex 1)
("Function" ,julia-function-assignment-regex 1)
("Const" ,julia-const-def-regex 1)
("Type" ,julia-type-regex 1)
("Require" " *\\(\\brequire\\)(\\([^ \t\n)]*\\)" 2)
("Include" " *\\(\\binclude\\)(\\([^ \t\n)]*\\)" 2)))
;;;###autoload
(define-derived-mode julia-mode prog-mode "Julia"
"Major mode for editing julia code."
:group 'julia
:abbrev-table julia-mode-abbrev-table
(set-syntax-table julia-mode-syntax-table)
(setq-local comment-start "# ")
(setq-local comment-start-skip "#+\\s-*")
(setq-local font-lock-defaults '(julia-font-lock-keywords))
(setq-local syntax-propertize-function julia-syntax-propertize-function)
(setq-local indent-line-function #'julia-indent-line)
(setq-local beginning-of-defun-function #'julia-beginning-of-defun)
(setq-local end-of-defun-function #'julia-end-of-defun)
;; If completion before point has higher priority than around, \lamb
;; can get completed to \lambdamb
(add-hook 'completion-at-point-functions
#'julia-mode-latexsub-completion-at-point-before nil t)
(add-hook 'completion-at-point-functions
#'julia-mode-latexsub-completion-at-point-around nil t)
(when julia-force-tab-complete
(setq-local tab-always-indent 'complete))
(setq indent-tabs-mode nil)
(setq imenu-generic-expression julia-imenu-generic-expression)
(imenu-add-to-menubar "Imenu"))
(defun julia-manual-deindent ()
"Deindent by `julia-indent-offset' regardless of current
indentation context. To be used to manually indent inside
strings."
(interactive)
(indent-line-to (max 0 (- (current-indentation) julia-indent-offset))))
(define-key julia-mode-map (kbd "<backtab>") 'julia-manual-deindent)
;; (See Julia issue #8947 for why we don't use the Emacs tex input mode.)
(defun julia--latexsub-start-symbol ()
"Determine the start location for LaTeX-like symbol at point.
If there is not a LaTeX-like symbol at point, return nil."
(save-excursion
;; move backward until character can't be part of LaTeX, whitespace or beginning of file
(while (not (or (bobp)
(= ?\\ (char-before))
;; Checks char not in whitespace, comment, or
;; escape. This works better than checking char is
;; in word constitutents (?w) because things like
;; "\^(", "\1/", and "\^=)" are valid.
(member (char-syntax (char-before)) '(?\s ?< ?> ?\\))))
(backward-char))
(when (= ?\\ (char-before))
(- (point) 1))))
;; Sometimes you want to complete a symbol `point' is in middle of
(defun julia-mode-latexsub-completion-at-point-around ()
"Return completion for LaTeX-like symbol around point.
Suitable for use in `completion-at-point-functions'."
(when-let ((beg (julia--latexsub-start-symbol)))
(let* ((end (julia-mode--latexsubs-longest-partial-end beg))
(buffer-symbol (buffer-substring beg end))
;; Depending on `completion-styles', completion may try to complete
;; e.g. "\hat_mean" to "\hat". This predicate ensures that any completion candidates
;; must start with "\hat_mean".
(pred (lambda (candidate _candidate-completion)
(string= buffer-symbol
(substring candidate
0 (min (length candidate) (length buffer-symbol)))))))
(julia--latexsub-capf-list beg end pred))))
;; Sometimes you want to complete a symbol point is at end of (with no space after)
(defun julia-mode-latexsub-completion-at-point-before ()
"Return completion for LaTeX-like symbol before point.
Suitable for use in `completion-at-point-functions'."
(when-let ((beg (julia--latexsub-start-symbol)))
(julia--latexsub-capf-list beg (point) nil)))
(defun julia--latexsub-capf-list (beg end pred)
"Return list suitable for use in `completion-at-point-functions' of latexsubs."
(list beg end julia-mode-latexsubs :exclusive 'no
:annotation-function (lambda (s)
(concat " " (gethash s julia-mode-latexsubs)))
:exit-function (julia--latexsub-exit-function beg)
:predicate pred))
(defun julia--latexsub-exit-function (beg)
"Return function to be used as `completion-extra-properties' `:exit-function'.
When `julia-automatic-latexsub' is non-nil, returned function will
substitute LaTeX symbols when called with a LaTeX string from before
`point' and the symbol `finished'. BEG is the point in the current
buffer where the LaTeX symbol starts."
(if julia-automatic-latexsub
;; `julia--latexsub-exit-function' returns a lambda in order to close over BEG which
;; would otherwise have to be recalculated.
(lambda (name status)
;; `ivy-mode' always calls `:exit-function' with `sole' and not `finished' (see
;; <https://github.com/abo-abo/swiper/issues/2345>). Instead of automatic
;; expansion, user can either enable `abbrev-mode' or call `expand-abbrev'.
(when-let (((eq status 'finished))
;; helm-mode passes NAME with an extra whitespace at the end. Since
;; `julia--latexsub-start-symbol' won't include whitespace, we can safely
;; strip whitespace.
(clean-name (string-trim-right name))
(symb (abbrev-symbol clean-name julia-latexsub-abbrev-table))
(end (+ beg (length clean-name))))
(abbrev-insert symb name beg end)))
#'ignore))
(defun julia-mode--latexsub-before-point ()
"When there is a LaTeX substitution that can be made before the point, return (CONS BEG LATEX).
`beg' is the position of the `\`, `latex' is the string to replace, including the `\`.
When multiple options match, ask the user to clarify via `julia-latexsub-selector', unless there is a complete match and `julia-latexsub-greedy' is `t'."
(when-let (beg (julia--latexsub-start-symbol))
(let ((partial (buffer-substring-no-properties beg (point))))
(when-let (replacements (gethash partial julia-mode--latexsubs-partials))
(let* ((complete-match (member partial replacements))
(latex (cond
;; complete match w/ greedy
((and complete-match julia-latexsub-greedy) partial)
;; multiple replacements, ask user
((cdr replacements) (funcall julia-latexsub-selector replacements))
;; single replacement, pick that
(t (car replacements)))))
(cons beg latex))))))
(defun julia-latexsub-or-indent (arg)
"Either indent according to Julia mode conventions or perform a LaTeX-like symbol substution.
When multiple options match, ask the user to clarify via `julia-latexsub-selector', unless there is a complete match and `julia-latexsub-greedy' is `t'.
Presently, this is not the default. Enable with eg
(define-key julia-mode-map (kbd \"TAB\") 'julia-latexsub-or-indent)
eg in your `julia-mode-hook'."
(interactive "*i")
(if-let (replacement (julia-mode--latexsub-before-point))
(progn
(delete-backward-char (- (point) (car replacement)))
(insert (gethash (cdr replacement) julia-mode-latexsubs)))
(julia-indent-line)))
;; Math insertion in julia. Use it with
;; (add-hook 'julia-mode-hook 'julia-math-mode)
(when (featurep 'latex)
(declare-function LaTeX-math-abbrev-prefix "latex")
(defun julia-math-insert (s)
"Inserts math symbol given by `s'"
(when s
(let ((sym (gethash (concat "\\" s) julia-mode-latexsubs)))
(when sym
(insert sym)))))
(with-no-warnings
(define-minor-mode julia-math-mode
"A minor mode with easy access to TeX math commands. The
command is only entered if it is supported in Julia. The
following commands are defined:
\\{LaTeX-math-mode-map}"
nil nil (list (cons (LaTeX-math-abbrev-prefix) LaTeX-math-keymap))