-
Notifications
You must be signed in to change notification settings - Fork 6
/
sml-mode.el
2026 lines (1794 loc) · 76 KB
/
sml-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
;;; sml-mode.el --- Major mode for editing (Standard) ML -*- lexical-binding: t; coding: utf-8 -*-
;; Copyright (C) 1989,1999,2000,2004,2007,2010-2013 Free Software Foundation, Inc.
;; Maintainer: (Stefan Monnier) <[email protected]>
;; Version: 6.4
;; Keywords: SML
;; Author: Lars Bo Nielsen
;; Olin Shivers
;; Fritz Knabe (?)
;; Steven Gilmore (?)
;; Matthew Morley <[email protected]>
;; Matthias Blume <[email protected]>
;; (Stefan Monnier) <[email protected]>
;; This file is part of GNU Emacs.
;; GNU Emacs 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.
;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; A major mode to edit Standard ML (SML) code.
;; Provides the following features, among others:
;; - Indentation.
;; - Syntax highlighting.
;; - Prettified display of ->, =>, fn, ...
;; - Imenu.
;; - which-function-mode.
;; - Skeletons/templates.
;; - Electric pipe key.
;; - outline-minor-mode (with some known problems).
;; - Interaction with a read-eval-print loop.
;;;; Known bugs:
;; - Indentation after "functor toto() where type foo = bar ="
;; Because the last is treated as an equality comparison.
;; - indentation of a declaration after a long `datatype' can be slow.
;;;; News:
;;;;; Changes since 5.0:
;; - sml-electric-pipe-mode to make the | key electric.
;; - Removal of a lot of compatibility code. Requires Emacs-24.
;; - Integrate in GNU ELPA.
;;;;; Changes since 4.1:
;; - New indentation code using SMIE when available.
;; - `sml-back-to-outer-indent' is now on S-tab (aka `backtab') rather
;; than M-tab.
;; - Support for electric-layout-mode and electric-indent-mode.
;; - `sml-mark-defun' tries to be more clever.
;; - A single file (sml-mode.el) is needed unless you want to use an
;; interactive process like SML/NJ, or if your Emacs does not provide SMIE.
;;;;; Changes since 4.0:
;; - Switch to GPLv3+.
;; - When possible (i.e. running under Emacs>=23), be case-sensitive when
;; expanding abbreviations, and don't expand them in comments and strings.
;; - When you `next-error' to a type error, highlight the actual parts of the
;; types that differ.
;; - Flush the recorded errors not only upon sml-compile and friends, but also
;; when typing commands directly at the prompt.
;; - New command sml-mlton-typecheck.
;; - Simple support to parse errors and warnings in MLton's output.
;; - Simple support for MLton's def-use files.
;;;;; Changes since 3.9.5:
;; - No need to add the dir to your load-path any more.
;; The sml-mode-startup.el file does it for you.
;; - Symbols like -> can be displayed as real arrows.
;; See sml-font-lock-symbols.
;; - Fix some incompatibilities with the upcoming Emacs-21.4.
;; - Indentation rules improved. New customizable variable
;; `sml-rightalign-and'. Also `sml-symbol-indent' is now customizable.
;;;;; Changes since 3.9.3:
;; - New add-log support (try C-x 4 a from within an SML function).
;; - Imenu support
;; - sml-bindings has disappeared.
;; - The code skeletons are now abbrevs as well.
;; - A new *sml* process is sent the content of sml-config-file
;; (~/.sml-proc.sml) if it exists.
;; - `sml-compile' works yet a bit differently. The command can begin
;; with `cd "path";' and it will be replaced by OS.FileSys.chDir.
;; - run-sml now pops up the new buffer. It can also run the command on
;; another machine. And it always prompts for the command name.
;; Use a prefix argument if you want to give args or to specify a host on
;; which to run the command.
;; - mouse-2 to yank in *sml* should work again (but won't work for next-error
;; any more).
;; - New major-modes sml-cm-mode, sml-lex-mode and sml-yacc-mode.
;; - sml-load-hook has disappeared as has inferior-sml-load-hook.
;; - sml-mode-startup.el is now automatically generated and you're supposed to
;; `load' it from .emacs or site-start.el.
;; - Minor bug fixes.
;;; Code:
(eval-when-compile (require 'cl))
(require 'smie nil 'noerror)
(require 'electric)
(defgroup sml ()
"Editing SML code."
:group 'languages)
(defcustom sml-indent-level 4
"Basic indentation step for SML code."
:type 'integer)
(defcustom sml-indent-args sml-indent-level
"Indentation of args placed on a separate line."
:type 'integer)
(defcustom sml-rightalign-and t
"If non-nil, right-align `and' with its leader.
If nil: If t:
datatype a = A datatype a = A
and b = B and b = B"
:type 'boolean)
(defcustom sml-electric-pipe-mode t
"If non-nil, automatically insert appropriate template when hitting |."
:type 'boolean)
(defvar sml-mode-hook nil
"Run upon entering `sml-mode'.
This is a good place to put your preferred key bindings.")
;; font-lock setup
(defvar sml-outline-regexp
;; `st' and `si' are to match structure and signature.
" \\|s[ti]\\|[ \t]*\\(let[ \t]+\\)?\\(fun\\|and\\)\\_>"
"Regexp matching a major heading.
This actually can't work without extending `outline-minor-mode' with the
notion of \"the end of an outline\".")
;;
;; Internal defines
;;
(defvar sml-mode-map
(let ((map (make-sparse-keymap)))
;; Text-formatting commands:
(define-key map "\C-c\C-s" 'sml-insert-form)
(define-key map "\M-|" 'sml-electric-pipe)
(define-key map "\M-\ " 'sml-electric-space)
(define-key map [backtab] 'sml-back-to-outer-indent)
;; The standard binding is C-c C-z, but we add this one for compatibility.
(define-key map "\C-c\C-m" 'sml-prog-proc-switch-to)
map)
"The keymap used in `sml-mode'.")
(defvar sml-mode-syntax-table
(let ((st (make-syntax-table)))
(modify-syntax-entry ?\* ". 23n" st)
(modify-syntax-entry ?\( "()1" st)
(modify-syntax-entry ?\) ")(4" st)
(mapc (lambda (c) (modify-syntax-entry c "_" st)) "._'")
(mapc (lambda (c) (modify-syntax-entry c "." st)) ",;")
;; `!' is not really a prefix-char, oh well!
(mapc (lambda (c) (modify-syntax-entry c "'" st)) "~#!")
(mapc (lambda (c) (modify-syntax-entry c "." st)) "%&$+-/:<=>?@`^|")
st)
"The syntax table used in `sml-mode'.")
(easy-menu-define sml-mode-menu sml-mode-map "Menu used in `sml-mode'."
'("SML"
("Process"
["Start SML repl" sml-run t]
["-" nil nil]
["Compile the project" sml-prog-proc-compile t]
["Send file" sml-prog-proc-load-file t]
["Switch to SML repl" sml-prog-proc-switch-to t]
["--" nil nil]
["Send buffer" sml-prog-proc-send-buffer t]
["Send region" sml-prog-proc-send-region t]
["Send function" sml-send-function t]
["Goto next error" next-error t])
["Insert SML form" sml-insert-form t]
("Forms" :filter sml-forms-menu)
["Indent region" indent-region t]
["Outdent line" sml-back-to-outer-indent t]
["-----" nil nil]
["Customize SML-mode" (customize-group 'sml) t]
["SML mode help" describe-mode t]))
;;
;; Regexps
;;
(defun sml-syms-re (syms)
(concat "\\_<" (regexp-opt syms t) "\\_>"))
;;
(defconst sml-module-head-syms
'("signature" "structure" "functor" "abstraction"))
(defconst sml-=-starter-syms
(list* "|" "val" "fun" "and" "datatype" "type" "idx" "abstype" "absidx" "eqtype"
sml-module-head-syms)
"Symbols that can be followed by a `='.")
(defconst sml-=-starter-re
(concat "\\S.|\\S.\\|" (sml-syms-re (cdr sml-=-starter-syms)))
"Symbols that can be followed by a `='.")
(defconst sml-non-nested-of-starter-re
(sml-syms-re '("datatype" "abstype" "absidx" "exception"))
"Symbols that can introduce an `of' that shouldn't behave like a paren.")
(defconst sml-starters-syms
(append sml-module-head-syms
'("abstype" "absidx" "datatype" "exception" "fun"
"local" "infix" "infixr" "sharing" "nonfix"
"open" "type" "idx" "val" "and"
"withtype" "with"))
"The starters of new expressions.")
(defconst sml-pipeheads
'("|" "of" "fun" "fn" "and" "handle" "datatype" "abstype" "absidx"
"(" "{" "[")
"A `|' corresponds to one of these.")
(defconst sml-keywords-regexp
(sml-syms-re '("abstraction" "abstype" "absidx" "return" "using" "and" "andalso" "as" "before" "case"
"datatype" "else" "end" "eqtype" "exception" "do" "fn"
"fun" "functor" "handle" "if" "in" "include" "infix"
"infixr" "let" "local" "nonfix" "o" "of" "op" "open" "orelse"
"overload" "raise" "rec" "sharing" "sig" "signature"
"struct" "structure" "then" "type" "idx" "val" "where" "while"
"with" "withtype"))
"A regexp that matches any and all keywords of SML.")
(eval-and-compile
(defconst sml-id-re "\\sw\\(?:\\sw\\|\\s_\\)*"))
(defconst sml-tyvarseq-re
(concat "\\(?:\\(?:'+" sml-id-re "\\|(\\(?:[,']\\|" sml-id-re
"\\|\\s-\\)+)\\)\\s-+\\)?"))
;;; Font-lock settings ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defcustom sml-font-lock-symbols nil
"Display \\ and -> and such using symbols in fonts.
This may sound like a neat trick, but be extra careful: it changes the
alignment and can thus lead to nasty surprises w.r.t layout."
:type 'boolean)
(defconst sml-font-lock-symbols-alist
'(("fn" . ?λ)
("andalso" . ?∧) ;; ?⋀
("orelse" . ?∨) ;; ?⋁
;; ("as" . ?≡)
("not" . ?¬)
("div" . ?÷)
("*" . ?×)
("o" . ?○)
("->" . ?→)
("=>" . ?⇒)
("<-" . ?←)
("<>" . ?≠)
(">=" . ?≥)
("<=" . ?≤)
("..." . ?⋯)
;; ("::" . ?∷)
;; Some greek letters for type parameters.
("'a" . ?α)
("'b" . ?β)
("'c" . ?γ)
("'d" . ?δ)
))
(defun sml-font-lock-compose-symbol ()
"Compose a sequence of ascii chars into a symbol.
Regexp match data 0 points to the chars."
;; Check that the chars should really be composed into a symbol.
(let* ((start (match-beginning 0))
(end (match-end 0))
(syntaxes (if (eq (char-syntax (char-after start)) ?w)
'(?w) '(?. ?\\))))
(if (or (memq (char-syntax (or (char-before start) ?\ )) syntaxes)
(memq (char-syntax (or (char-after end) ?\ )) syntaxes)
(memq (get-text-property start 'face)
'(font-lock-doc-face font-lock-string-face
font-lock-comment-face)))
;; No composition for you. Let's actually remove any composition
;; we may have added earlier and which is now incorrect.
(remove-text-properties start end '(composition))
;; That's a symbol alright, so add the composition.
(compose-region start end (cdr (assoc (match-string 0)
sml-font-lock-symbols-alist)))))
;; Return nil because we're not adding any face property.
nil)
(defun sml-font-lock-symbols-keywords ()
(when sml-font-lock-symbols
`((,(regexp-opt (mapcar 'car sml-font-lock-symbols-alist) t)
(0 (sml-font-lock-compose-symbol))))))
;; The font lock regular expressions.
(defconst sml-font-lock-keywords
`(;;(sml-font-comments-and-strings)
(,(concat "\\_<\\(fun\\|and\\)\\s-+" sml-tyvarseq-re
"\\(" sml-id-re "\\)\\s-+[^ \t\n=]")
(1 font-lock-keyword-face)
(2 font-lock-function-name-face))
(,(concat "\\_<\\(\\(?:data\\|abs\\|with\\|eq\\)?type\\)\\s-+"
sml-tyvarseq-re "\\(" sml-id-re "\\)")
(1 font-lock-keyword-face)
(2 font-lock-type-def-face))
(,(concat "\\_<\\(val\\)\\s-+\\(?:" sml-id-re "\\_>\\s-*\\)?\\("
sml-id-re "\\)\\s-*[=:]")
(1 font-lock-keyword-face)
(2 font-lock-variable-name-face))
(,(concat "\\_<\\(structure\\|functor\\|abstraction\\)\\s-+\\("
sml-id-re "\\)")
(1 font-lock-keyword-face)
(2 font-lock-module-def-face))
(,(concat "\\_<\\(signature\\)\\s-+\\(" sml-id-re "\\)")
(1 font-lock-keyword-face)
(2 font-lock-interface-def-face))
(,sml-keywords-regexp . font-lock-keyword-face)
,@(sml-font-lock-symbols-keywords))
"Regexps matching standard SML keywords.")
(defface font-lock-type-def-face
'((t (:bold t)))
"Font Lock mode face used to highlight type definitions."
:group 'font-lock-highlighting-faces)
(defvar font-lock-type-def-face 'font-lock-type-def-face
"Face name to use for type definitions.")
(defface font-lock-module-def-face
'((t (:bold t)))
"Font Lock mode face used to highlight module definitions."
:group 'font-lock-highlighting-faces)
(defvar font-lock-module-def-face 'font-lock-module-def-face
"Face name to use for module definitions.")
(defface font-lock-interface-def-face
'((t (:bold t)))
"Font Lock mode face used to highlight interface definitions."
:group 'font-lock-highlighting-faces)
(defvar font-lock-interface-def-face 'font-lock-interface-def-face
"Face name to use for interface definitions.")
;;
;; Code to handle nested comments and unusual string escape sequences
;;
(defvar sml-syntax-prop-table
(let ((st (make-syntax-table)))
(modify-syntax-entry ?\\ "." st)
(modify-syntax-entry ?* "." st)
st)
"Syntax table for text-properties.")
(defconst sml-font-lock-syntactic-keywords
`(("^\\s-*\\(\\\\\\)" (1 ',sml-syntax-prop-table))))
(defconst sml-font-lock-defaults
'(sml-font-lock-keywords nil nil nil nil
(font-lock-syntactic-keywords . sml-font-lock-syntactic-keywords)))
;;; Indentation with SMIE
(defconst sml-smie-grammar
;; We have several problem areas where SML's syntax can't be handled by an
;; operator precedence grammar:
;;
;; "= A before B" is "= A) before B" if this is the
;; `boolean-=' but it is "= (A before B)" if it's the `definitional-='.
;; We can work around the problem by tweaking the lexer to return two
;; different tokens for the two different kinds of `='.
;; "of A | B" in a "case" we want "of (A | B, but in a `datatype'
;; we want "of A) | B".
;; "= A | B" can be "= A ) | B" if the = is from a "fun" definition,
;; but it is "= (A | B" if it is a `datatype' definition (of course, if
;; the previous token introducing the = is `and', deciding whether
;; it's a datatype or a function requires looking even further back).
;; "functor foo (...) where type a = b = ..." the first `=' looks very much
;; like a `definitional-=' even tho it's just an equality constraint.
;; Currently I don't even try to handle `where' at all.
(smie-prec2->grammar
(smie-merge-prec2s
(smie-bnf->prec2
'((exp ("if" exp "then" exp "else" exp)
("case" exp "of" branches)
("let" decls "in" cmds "end")
("struct" decls "end")
("sig" decls "end")
(sexp)
(sexp "handle" branches)
("fn" sexp "=>" exp))
;; "simple exp"s are the ones that can appear to the left of `handle'.
(sexp (sexp ":" type) ("(" exps ")")
(sexp "orelse" sexp)
(marg ":>" type)
(sexp "andalso" sexp))
(cmds (cmds ";" cmds) (exp))
(exps (exps "," exps) (exp)) ; (exps ";" exps)
(branches (sexp "=>" exp) (branches "|" branches))
;; Operator precedence grammars handle separators much better then
;; starters/terminators, so let's pretend that let/fun are separators.
(decls (sexp "d=" exp)
(sexp "d=" databranches)
(funbranches "|" funbranches)
(sexp "=of" type) ;After "exception".
;; FIXME: Just like PROCEDURE in Pascal and Modula-2, this
;; interacts poorly with the other constructs since I
;; can't make "local" a separator like fun/val/type/...
("local" decls "in" decls "end")
;; (decls "local" decls "in" decls "end")
(decls "functor" decls)
(decls "signature" decls)
(decls "structure" decls)
(decls "type" decls)
(decls "idx" decls)
(decls "open" decls)
(decls "and" decls)
(decls "infix" decls)
(decls "infixr" decls)
(decls "nonfix" decls)
(decls "abstype" decls)
(decls "absidx" decls)
(decls "datatype" decls)
(decls "exception" decls)
(decls "fun" decls)
(decls "val" decls))
(type (type "->" type)
(type "*" type))
(funbranches (sexp "d=" exp))
(databranches (sexp "=of" type) (databranches "d|" databranches))
;; Module language.
;; (mexp ("functor" marg "d=" mexp)
;; ("structure" marg "d=" mexp)
;; ("signature" marg "d=" mexp))
(marg (marg ":" type) (marg ":>" type))
(toplevel (decls) (exp) (toplevel ";" toplevel)))
;; '(("local" . opener))
;; '((nonassoc "else") (right "handle"))
'((nonassoc "of") (assoc "|")) ; "case a of b => case c of d => e | f"
'((nonassoc "handle") (assoc "|")) ; Idem for "handle".
'((assoc "->") (assoc "*"))
'((assoc "val" "fun" "type" "idx" "datatype" "abstype" "absidx" "open" "infix" "infixr"
"nonfix" "functor" "signature" "structure" "exception"
;; "local"
)
(assoc "and"))
'((assoc "orelse") (assoc "andalso") (nonassoc ":"))
'((assoc ";")) '((assoc ",")) '((assoc "d|")))
(smie-precs->prec2
'((nonassoc "andalso") ;To anchor the prec-table.
(assoc "before") ;0
(assoc ":=" "o") ;3
(nonassoc ">" ">=" "<>" "<" "<=" "=") ;4
(assoc "::" "@") ;5
(assoc "+" "-" "^") ;6
(assoc "/" "*" "quot" "rem" "div" "mod") ;7
(nonassoc " -dummy- "))) ;Bogus anchor at the end.
)))
(defvar sml-indent-separator-outdent 2)
(defun sml-smie-rules (kind token)
;; I much preferred the pcase version of the code, especially while
;; edebugging the code. But that will have to wait until we get rid of
;; support for Emacs-23.
(case kind
(:elem (case token
(basic sml-indent-level)
(args sml-indent-args)))
(:list-intro (member token '("fn")))
(:after
(cond
((equal token "struct") 0)
((equal token "=>") (if (smie-rule-hanging-p) 0 2))
((equal token "in") (if (smie-rule-parent-p "local") 0))
((equal token "of") 3)
((member token '("(" "{" "[")) (if (not (smie-rule-hanging-p)) 2))
((equal token "else") (if (smie-rule-hanging-p) 0)) ;; (:next "if" 0)
((member token '("|" "d|" ";" ",")) (smie-rule-separator kind))
((equal token "d=")
(if (and (smie-rule-parent-p "val") (smie-rule-next-p "fn")) -3))))
(:before
(cond
((equal token "=>") (if (smie-rule-parent-p "fn") 3))
((equal token "of") 1)
;; In case the language is extended to allow a | directly after of.
((and (equal token "|") (smie-rule-prev-p "of")) 1)
((member token '("|" "d|" ";" ",")) (smie-rule-separator kind))
;; Treat purely syntactic block-constructs as being part of their parent,
;; when the opening statement is hanging.
((member token '("let" "(" "[" "{"))
(if (smie-rule-hanging-p) (smie-rule-parent)))
;; Treat if ... else if ... as a single long syntactic construct.
;; Similarly, treat fn a => fn b => ... as a single construct.
((member token '("if" "fn"))
(and (not (smie-rule-bolp))
(smie-rule-prev-p (if (equal token "if") "else" "=>"))
(smie-rule-parent)))
((equal token "and")
;; FIXME: maybe "and" (c|sh)ould be handled as an smie-separator.
(cond
((smie-rule-parent-p "datatype") (if sml-rightalign-and 5 0))
((smie-rule-parent-p "fun" "val") 0)))
((equal token "d=")
(cond
((smie-rule-parent-p "datatype") (if (smie-rule-bolp) 2))
((smie-rule-parent-p "structure" "signature") 0)))
;; Indent an expression starting with "local" as if it were starting
;; with "fun".
((equal token "local") (smie-indent-keyword "fun"))
;; FIXME: type/val/fun/... are separators but "local" is not, even though
;; it appears in the same list. Try to fix up the problem by hand.
;; ((or (equal token "local")
;; (equal (cdr (assoc token smie-grammar))
;; (cdr (assoc "fun" smie-grammar))))
;; (let ((parent (save-excursion (smie-backward-sexp))))
;; (when (or (and (equal (nth 2 parent) "local")
;; (null (car parent)))
;; (progn
;; (setq parent (save-excursion (smie-backward-sexp "fun")))
;; (eq (car parent) (nth 1 (assoc "fun" smie-grammar)))))
;; (goto-char (nth 1 parent))
;; (cons 'column (smie-indent-virtual)))))
))))
(defun sml-smie-definitional-equal-p ()
"Figure out which kind of \"=\" this is.
Assumes point is right before the = sign."
;; The idea is to look backward for the first occurrence of a token that
;; requires a definitional "=" and then see if there's such a definitional
;; equal between that token and ourselves (in which case we're not
;; a definitional = ourselves).
;; The "search for =" is naive and will match "=>" and "<=", but it turns
;; out to be OK in practice because such tokens very rarely (if ever) appear
;; between the =-starter and the corresponding definitional equal.
;; One known problem case is code like:
;; "functor foo (structure s : S) where type t = s.t ="
;; where the "type t = s.t" is mistaken for a type definition.
(let ((re (concat "\\(" sml-=-starter-re "\\)\\|=")))
(save-excursion
(and (re-search-backward re nil t)
(or (match-beginning 1)
;; If we first hit a "=", then that = is probably definitional
;; and we're an equality, but not necessarily. One known
;; problem case is code like:
;; "functor foo (structure s : S) where type t = s.t ="
;; where the first = is more like an equality (tho it doesn't
;; matter much) and the second is definitional.
;;
;; FIXME: The test below could be used to recognize that the
;; second = is not a mere equality, but that's not enough to
;; parse the construct properly: we'd need something
;; like a third kind of = token for structure definitions, in
;; order for the parser to be able to skip the "type t = s.t"
;; as a sub-expression.
;;
;; (and (not (looking-at "=>"))
;; (not (eq ?< (char-before))) ;Not a <=
;; (re-search-backward re nil t)
;; (match-beginning 1)
;; (equal "type" (buffer-substring (- (match-end 1) 4)
;; (match-end 1))))
)))))
(defun sml-smie-non-nested-of-p ()
;; FIXME: Maybe datatype-|-p makes this nested-of business unnecessary.
"Figure out which kind of \"of\" this is.
Assumes point is right before the \"of\" symbol."
(save-excursion
(and (re-search-backward (concat "\\(" sml-non-nested-of-starter-re
"\\)\\|\\_<case\\_>") nil t)
(match-beginning 1))))
(defun sml-smie-datatype-|-p ()
"Figure out which kind of \"|\" this is.
Assumes point is right before the | symbol."
(save-excursion
(forward-char 1) ;Skip the |.
(let ((after-type-def
'("|" "of" "in" "datatype" "and" "exception" "abstype" "absidx" "infix"
"infixr" "nonfix" "local" "val" "fun" "structure" "functor"
"signature")))
(or (member (sml-smie-forward-token-1) after-type-def) ;Skip the tag.
(member (sml-smie-forward-token-1) after-type-def)))))
(defun sml-smie-forward-token-1 ()
(forward-comment (point-max))
(buffer-substring-no-properties
(point)
(progn
(or (/= 0 (skip-syntax-forward "'w_"))
(skip-syntax-forward ".'"))
(point))))
(defun sml-smie-forward-token ()
(let ((sym (sml-smie-forward-token-1)))
(cond
((equal "op" sym)
(concat "op " (sml-smie-forward-token-1)))
((member sym '("|" "of" "="))
;; The important lexer for indentation's performance is the backward
;; lexer, so for the forward lexer we delegate to the backward one.
(save-excursion (sml-smie-backward-token)))
(t sym))))
(defun sml-smie-backward-token-1 ()
(forward-comment (- (point)))
(buffer-substring-no-properties
(point)
(progn
(or (/= 0 (skip-syntax-backward ".'"))
(skip-syntax-backward "'w_"))
(point))))
(defun sml-smie-backward-token ()
(let ((sym (sml-smie-backward-token-1)))
(unless (zerop (length sym))
;; FIXME: what should we do if `sym' = "op" ?
(let ((point (point)))
(if (equal "op" (sml-smie-backward-token-1))
(concat "op " sym)
(goto-char point)
(cond
((string= sym "=") (if (sml-smie-definitional-equal-p) "d=" "="))
((string= sym "of") (if (sml-smie-non-nested-of-p) "=of" "of"))
((string= sym "|") (if (sml-smie-datatype-|-p) "d|" "|"))
(t sym)))))))
;;;;
;;;; Imenu support
;;;;
(defconst sml-imenu-regexp
(concat "^[ \t]*\\(let[ \t]+\\)?"
(regexp-opt (append sml-module-head-syms
'("and" "fun" "datatype" "abstype" "absidx" "type" "idx")) t)
"\\_>"))
(defun sml-imenu-create-index ()
(let (alist)
(goto-char (point-max))
(while (re-search-backward sml-imenu-regexp nil t)
(save-excursion
(let ((kind (match-string 2))
(column (progn (goto-char (match-beginning 2)) (current-column)))
(location
(progn (goto-char (match-end 0))
(forward-comment (point-max))
(when (looking-at sml-tyvarseq-re)
(goto-char (match-end 0)))
(point)))
(name (sml-smie-forward-token)))
;; Eliminate trivial renamings.
(when (or (not (member kind '("structure" "signature")))
(when (search-forward "=" nil t)
(forward-comment (point-max))
(looking-at "sig\\|struct")))
(push (cons (concat (make-string (/ column 2) ?\ ) name) location)
alist)))))
alist))
;;; Generic prog-proc interaction.
(require 'comint)
(require 'compile)
(defvar sml-prog-proc-mode-map
(let ((map (make-sparse-keymap)))
(define-key map [?\C-c ?\C-l] 'sml-prog-proc-load-file)
(define-key map [?\C-c ?\C-c] 'sml-prog-proc-compile)
(define-key map [?\C-c ?\C-z] 'sml-prog-proc-switch-to)
(define-key map [?\C-c ?\C-r] 'sml-prog-proc-send-region)
(define-key map [?\C-c ?\C-b] 'sml-prog-proc-send-buffer)
;; FIXME: Add
;; (define-key map [?\M-C-x] 'sml-prog-proc-send-defun)
;; (define-key map [?\C-x ?\C-e] 'sml-prog-proc-send-last-sexp)
;; FIXME: Add menu. Now, that's trickier because keymap inheritance
;; doesn't play nicely with menus!
map)
"Keymap for `sml-prog-proc-mode'.")
(defvar sml-prog-proc--buffer nil
"The inferior-process buffer to which to send code.")
(make-variable-buffer-local 'sml-prog-proc--buffer)
(defstruct (sml-prog-proc-descriptor
(:constructor sml-prog-proc-make)
(:predicate nil)
(:copier nil))
(name nil :read-only t)
(run nil :read-only t)
(load-cmd nil :read-only t)
(chdir-cmd nil :read-only t)
(command-eol "\n" :read-only t)
(compile-commands-alist nil :read-only t))
(defvar sml-prog-proc-descriptor nil
"Struct containing the various functions to create a new process, ...")
(defmacro sml-prog-proc--prop (prop)
`(,(intern (format "sml-prog-proc-descriptor-%s" prop))
(or sml-prog-proc-descriptor
;; FIXME: Look for available ones and pick one.
(error "Not a `sml-prog-proc' buffer"))))
(defmacro sml-prog-proc--call (method &rest args)
`(funcall (sml-prog-proc--prop ,method) ,@args))
;; The inferior process and his buffer are basically interchangeable.
;; Currently the code takes sml-prog-proc--buffer as the main reference,
;; but all users should either use sml-prog-proc-proc or sml-prog-proc-buffer
;; to find the info.
(defun sml-prog-proc-proc ()
"Return the inferior process for the code in current buffer."
(or (and (buffer-live-p sml-prog-proc--buffer)
(get-buffer-process sml-prog-proc--buffer))
(when (derived-mode-p 'sml-prog-proc-mode 'sml-prog-proc-comint-mode)
(setq sml-prog-proc--buffer (current-buffer))
(get-buffer-process sml-prog-proc--buffer))
(let ((ppd sml-prog-proc-descriptor)
(buf (sml-prog-proc--call run)))
(with-current-buffer buf
(if (and ppd (null sml-prog-proc-descriptor))
(set (make-local-variable 'sml-prog-proc-descriptor) ppd)))
(setq sml-prog-proc--buffer buf)
(get-buffer-process sml-prog-proc--buffer))))
(defun sml-prog-proc-buffer ()
"Return the buffer of the inferior process."
(process-buffer (sml-prog-proc-proc)))
(defun my-pop-to-buffer (buffer)
(pop-to-buffer buffer)
)
(defun sml-prog-proc-switch-to ()
"Switch to the buffer running the read-eval-print process."
(interactive)
(my-pop-to-buffer (sml-prog-proc-buffer)))
(defun sml-prog-proc-send-string (proc str)
"Send command STR to PROC, with an EOL terminator appended."
(with-current-buffer (process-buffer proc)
;; FIXME: comint-send-string does not pass the string through
;; comint-input-filter-function, so we have to do it by hand.
;; Maybe we should insert the command into the buffer and then call
;; comint-send-input?
(sml-prog-proc-comint-input-filter-function nil)
(comint-send-string proc (concat str (sml-prog-proc--prop command-eol)))))
(defun sml-prog-proc-load-file (file &optional and-go)
"Load FILE into the read-eval-print process.
FILE is the file visited by the current buffer.
If prefix argument AND-GO is used, then we additionally switch
to the buffer where the process is running."
(interactive
(list (or buffer-file-name
(read-file-name "File to load: " nil nil t))
current-prefix-arg))
(comint-check-source file)
(let ((proc (sml-prog-proc-proc)))
(sml-prog-proc-send-string proc (sml-prog-proc--call load-cmd file))
(when and-go (my-pop-to-buffer (process-buffer proc)))))
(defvar sml-prog-proc--tmp-file nil)
(defun sml-prog-proc-send-region (start end &optional and-go)
"Send the content of the region to the read-eval-print process.
START..END delimit the region; AND-GO if non-nil indicate to additionally
switch to the process's buffer."
(interactive "r\nP")
(if (> start end) (let ((tmp end)) (setq end start) (setq start tmp))
(if (= start end) (error "Nothing to send: the region is empty")))
(let ((proc (sml-prog-proc-proc))
(tmp (make-temp-file "emacs-region")))
(write-region start end tmp nil 'silently)
(when sml-prog-proc--tmp-file
(ignore-errors (delete-file (car sml-prog-proc--tmp-file)))
(set-marker (cdr sml-prog-proc--tmp-file) nil))
(setq sml-prog-proc--tmp-file (cons tmp (copy-marker start)))
(sml-prog-proc-send-string proc (sml-prog-proc--call load-cmd tmp))
(when and-go (my-pop-to-buffer (process-buffer proc)))))
(defun sml-prog-proc-send-buffer (&optional and-go)
"Send the content of the current buffer to the read-eval-print process.
AND-GO if non-nil indicate to additionally switch to the process's buffer."
(interactive "P")
(sml-prog-proc-send-region (point-min) (point-max) and-go))
(define-derived-mode sml-prog-proc-mode prog-mode "Sml-Prog-Proc"
"Major mode for editing source code and interact with an interactive loop."
)
;;; Extended comint-mode for Sml-Prog-Proc.
(defun sml-prog-proc-chdir (dir)
"Change the working directory of the inferior process to DIR."
(interactive "DChange to directory: ")
(let ((dir (expand-file-name dir))
(proc (sml-prog-proc-proc)))
(with-current-buffer (process-buffer proc)
(sml-prog-proc-send-string proc (sml-prog-proc--call chdir-cmd dir))
(setq default-directory (file-name-as-directory dir)))))
(defun sml-prog-proc-comint-input-filter-function (str)
;; `compile.el' doesn't know that file location info from errors should be
;; recomputed afresh (without using stale info from earlier compilations).
(compilation-forget-errors) ;Has to run before compilation-fake-loc.
(if (and sml-prog-proc--tmp-file (marker-buffer (cdr sml-prog-proc--tmp-file)))
(compilation-fake-loc (cdr sml-prog-proc--tmp-file)
(car sml-prog-proc--tmp-file)))
str)
(defvar sml-prog-proc-comint-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\C-c\C-l" 'sml-prog-proc-load-file)
map))
(define-derived-mode sml-prog-proc-comint-mode comint-mode "Sml-Prog-Proc-Comint"
"Major mode for an inferior process used to run&compile source code."
;; Enable compilation-minor-mode, but only after the child mode is setup
;; since the child-mode might want to add rules to
;; compilation-error-regexp-alist.
(add-hook 'after-change-major-mode-hook #'compilation-minor-mode nil t)
;; The keymap of compilation-minor-mode is too unbearable, so we
;; need to hide most of the bindings.
(let ((map (make-sparse-keymap)))
(dolist (keys '([menu-bar] [follow-link]))
;; Preserve some of the bindings.
(define-key map keys (lookup-key compilation-minor-mode-map keys)))
(add-to-list 'minor-mode-overriding-map-alist
(cons 'compilation-minor-mode map)))
(add-hook 'comint-input-filter-functions
#'sml-prog-proc-comint-input-filter-function nil t))
(defvar sml-prog-proc--compile-command nil
"The command used by default by `sml-prog-proc-compile'.")
(defun sml-prog-proc-compile (command &optional and-go)
"Pass COMMAND to the read-eval-loop process to compile the current file.
You can then use the command \\[next-error] to find the next error message
and move to the source code that caused it.
Interactively, prompts for the command if `compilation-read-command' is
non-nil. With prefix arg, always prompts.
Prefix arg AND-GO also means to switch to the read-eval-loop buffer afterwards."
(interactive
(let* ((dir default-directory)
(cmd "cd \"."))
;; Look for files to determine the default command.
(while (and (stringp dir)
(progn
(dolist (cf (sml-prog-proc--prop compile-commands-alist))
(when (file-exists-p (expand-file-name (cdr cf) dir))
(setq cmd (concat cmd "\"; " (car cf)))
(return nil)))
(not cmd)))
(let ((newdir (file-name-directory (directory-file-name dir))))
(setq dir (unless (equal newdir dir) newdir))
(setq cmd (concat cmd "/.."))))
(setq cmd
(cond
((local-variable-p 'sml-prog-proc--compile-command)
sml-prog-proc--compile-command)
((string-match "^\\s-*cd\\s-+\"\\.\"\\s-*;\\s-*" cmd)
(substring cmd (match-end 0)))
((string-match "^\\s-*cd\\s-+\"\\(\\./\\)" cmd)
(replace-match "" t t cmd 1))
((string-match ";" cmd) cmd)
(t sml-prog-proc--compile-command)))
;; code taken from compile.el
(list (if (or compilation-read-command current-prefix-arg)
(read-from-minibuffer "Compile command: "
cmd nil nil '(compile-history . 1))
cmd))))
;; ;; now look for command's file to determine the directory
;; (setq dir default-directory)
;; (while (and (stringp dir)
;; (dolist (cf (sml-prog-proc--prop compile-commands-alist) t)
;; (when (and (equal cmd (car cf))
;; (file-exists-p (expand-file-name (cdr cf) dir)))
;; (return nil))))
;; (let ((newdir (file-name-directory (directory-file-name dir))))
;; (setq dir (unless (equal newdir dir) newdir))))
;; (setq dir (or dir default-directory))
;; (list cmd dir)))
(set (make-local-variable 'sml-prog-proc--compile-command) command)
(save-some-buffers (not compilation-ask-about-save) nil)
(let ((dir default-directory))
(when (string-match "^\\s-*cd\\s-+\"\\([^\"]+\\)\"\\s-*;" command)
(setq dir (match-string 1 command))
(setq command (replace-match "" t t command)))
(setq dir (expand-file-name dir))
(let ((proc (sml-prog-proc-proc))
(eol (sml-prog-proc--prop command-eol)))
(with-current-buffer (process-buffer proc)
(setq default-directory dir)
(sml-prog-proc-send-string
proc (concat (sml-prog-proc--call chdir-cmd dir)
;; Strip the newline, to avoid adding a prompt.
(if (string-match "\n\\'" eol)
(replace-match " " t t eol) eol)
command))
(when and-go (my-pop-to-buffer (process-buffer proc)))))))
;;; SML Sml-Prog-Proc support.
(defcustom sml-program-name "sml"
"Program to run as Standard SML read-eval-print loop."
:type 'string)
(defcustom sml-default-arg ""
"Default command line option to pass to `sml-program-name', if any."
:type 'string)
(defcustom sml-host-name ""
"Host on which to run `sml-program-name'."
:type 'string)
(defcustom sml-config-file "~/.smlproc.sml"
"File that should be fed to the SML process when started."
:type 'string)
(defcustom sml-prompt-regexp "^[-=>#] *"
"Regexp used to recognise prompts in the inferior SML process."
:type 'regexp)
(defcustom sml-compile-commands-alist
'(("CMB.make()" . "all-files.cm")
("CMB.make()" . "pathconfig")
("CM.make()" . "sources.cm")
("use \"load-all\"" . "load-all"))
"Commands used by default by `sml-sml-prog-proc-compile'.
Each command is associated with its \"main\" file.
It is perfectly OK to associate several files with a command or several
commands with the same file.")
;; FIXME: Try to auto-detect the process and set those vars accordingly.
(defvar sml-use-command "use \"%s\""
"Template for loading a file into the inferior SML process.
Set to \"use \\\"%s\\\"\" for SML/NJ or Edinburgh ML;
set to \"PolyML.use \\\"%s\\\"\" for Poly/ML, etc.")
(defvar sml-cd-command "OS.FileSys.chDir \"%s\""
"Command template for changing working directories under SML.
Set this to nil if your compiler can't change directories.
The format specifier \"%s\" will be converted into the directory name
specified when running the command \\[sml-cd].")
(defvar sml-error-regexp-alist
`( ;; Poly/ML messages
("^\\(Error\\|Warning:\\) in '\\(.+\\)', line \\([0-9]+\\)" 2 3)
;; Moscow ML
("^File \"\\([^\"]+\\)\", line \\([0-9]+\\)\\(-\\([0-9]+\\)\\)?, characters \\([0-9]+\\)-\\([0-9]+\\):" 1 2 5)
;; SML/NJ: the file-pattern is anchored to avoid
;; pathological behavior with very long lines.
("^[-= ]*\\(.*[^\n)]\\)\\( (.*)\\)?:\\([0-9]+\\)\\.\\([0-9]+\\)\\(-\\([0-9]+\\)\\.\\([0-9]+\\)\\)? \\(Error\\|Warnin\\(g\\)\\): .*" 1
(3 . 6) (4 . 7) (9))
;; SML/NJ's exceptions: see above.
("^ +\\(raised at: \\)?\\(.+\\):\\([0-9]+\\)\\.\\([0-9]+\\)\\(-\\([0-9]+\\)\\.\\([0-9]+\\)\\)" 2
(3 . 6) (4 . 7)))
"Alist that specifies how to match errors in compiler output.
See `compilation-error-regexp-alist' for a description of the format.")
(defconst sml-pp-functions