]> code.delx.au - gnu-emacs-elpa/blob - packages/sml-mode/sml-mode.el
f4d06cc69d33f34db9fe230972c54ec944d88bf3
[gnu-emacs-elpa] / packages / sml-mode / sml-mode.el
1 ;;; sml-mode.el --- Major mode for editing (Standard) ML -*- lexical-binding: t; coding: utf-8 -*-
2
3 ;; Copyright (C) 1989,1999,2000,2004,2007,2010-2014 Free Software Foundation, Inc.
4
5 ;; Maintainer: (Stefan Monnier) <monnier@iro.umontreal.ca>
6 ;; Version: 6.5
7 ;; Keywords: SML
8 ;; Author: Lars Bo Nielsen
9 ;; Olin Shivers
10 ;; Fritz Knabe (?)
11 ;; Steven Gilmore (?)
12 ;; Matthew Morley <mjm@scs.leeds.ac.uk>
13 ;; Matthias Blume <blume@cs.princeton.edu>
14 ;; (Stefan Monnier) <monnier@iro.umontreal.ca>
15
16 ;; This file is part of GNU Emacs.
17
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
22
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
27
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30
31 ;;; Commentary:
32
33 ;; A major mode to edit Standard ML (SML) code.
34 ;; Provides the following features, among others:
35 ;; - Indentation.
36 ;; - Syntax highlighting.
37 ;; - Prettified display of ->, =>, fn, ...
38 ;; - Imenu.
39 ;; - which-function-mode.
40 ;; - Skeletons/templates.
41 ;; - Electric pipe key.
42 ;; - outline-minor-mode (with some known problems).
43 ;; - Interaction with a read-eval-print loop.
44
45 ;;;; Known bugs:
46
47 ;; - Indentation after "functor toto() where type foo = bar ="
48 ;; Because the last is treated as an equality comparison.
49 ;; - indentation of a declaration after a long `datatype' can be slow.
50
51 ;;;; News:
52
53 ;;;;; Changes since 5.0:
54
55 ;; - sml-electric-pipe-mode to make the | key electric.
56 ;; - Removal of a lot of compatibility code. Requires Emacs-24.
57 ;; - Integrate in GNU ELPA.
58
59 ;;;;; Changes since 4.1:
60
61 ;; - New indentation code using SMIE when available.
62 ;; - `sml-back-to-outer-indent' is now on S-tab (aka `backtab') rather
63 ;; than M-tab.
64 ;; - Support for electric-layout-mode and electric-indent-mode.
65 ;; - `sml-mark-defun' tries to be more clever.
66 ;; - A single file (sml-mode.el) is needed unless you want to use an
67 ;; interactive process like SML/NJ, or if your Emacs does not provide SMIE.
68
69 ;;;;; Changes since 4.0:
70
71 ;; - Switch to GPLv3+.
72 ;; - When possible (i.e. running under Emacs>=23), be case-sensitive when
73 ;; expanding abbreviations, and don't expand them in comments and strings.
74 ;; - When you `next-error' to a type error, highlight the actual parts of the
75 ;; types that differ.
76 ;; - Flush the recorded errors not only upon sml-compile and friends, but also
77 ;; when typing commands directly at the prompt.
78 ;; - New command sml-mlton-typecheck.
79 ;; - Simple support to parse errors and warnings in MLton's output.
80 ;; - Simple support for MLton's def-use files.
81
82 ;;;;; Changes since 3.9.5:
83
84 ;; - No need to add the dir to your load-path any more.
85 ;; The sml-mode-startup.el file does it for you.
86 ;; - Symbols like -> can be displayed as real arrows.
87 ;; See sml-font-lock-symbols.
88 ;; - Fix some incompatibilities with the upcoming Emacs-21.4.
89 ;; - Indentation rules improved. New customizable variable
90 ;; `sml-rightalign-and'. Also `sml-symbol-indent' is now customizable.
91
92 ;;;;; Changes since 3.9.3:
93
94 ;; - New add-log support (try C-x 4 a from within an SML function).
95 ;; - Imenu support
96 ;; - sml-bindings has disappeared.
97 ;; - The code skeletons are now abbrevs as well.
98 ;; - A new *sml* process is sent the content of sml-config-file
99 ;; (~/.sml-proc.sml) if it exists.
100 ;; - `sml-compile' works yet a bit differently. The command can begin
101 ;; with `cd "path";' and it will be replaced by OS.FileSys.chDir.
102 ;; - run-sml now pops up the new buffer. It can also run the command on
103 ;; another machine. And it always prompts for the command name.
104 ;; Use a prefix argument if you want to give args or to specify a host on
105 ;; which to run the command.
106 ;; - mouse-2 to yank in *sml* should work again (but won't work for next-error
107 ;; any more).
108 ;; - New major-modes sml-cm-mode, sml-lex-mode and sml-yacc-mode.
109 ;; - sml-load-hook has disappeared as has inferior-sml-load-hook.
110 ;; - sml-mode-startup.el is now automatically generated and you're supposed to
111 ;; `load' it from .emacs or site-start.el.
112 ;; - Minor bug fixes.
113
114 ;;; Code:
115
116 (eval-when-compile (require 'cl))
117 (require 'smie nil 'noerror)
118 (require 'electric)
119
120 (defgroup sml ()
121 "Editing SML code."
122 :group 'languages)
123
124 (defcustom sml-indent-level 4
125 "Basic indentation step for SML code."
126 :type 'integer)
127
128 (defcustom sml-indent-args sml-indent-level
129 "Indentation of args placed on a separate line."
130 :type 'integer)
131
132 (defcustom sml-rightalign-and t
133 "If non-nil, right-align `and' with its leader.
134 If nil: If t:
135 datatype a = A datatype a = A
136 and b = B and b = B"
137 :type 'boolean)
138
139 (defcustom sml-electric-pipe-mode t
140 "If non-nil, automatically insert appropriate template when hitting |."
141 :type 'boolean)
142
143 (defvar sml-mode-hook nil
144 "Run upon entering `sml-mode'.
145 This is a good place to put your preferred key bindings.")
146
147 ;; font-lock setup
148
149 (defvar sml-outline-regexp
150 ;; `st' and `si' are to match structure and signature.
151 "\f\\|s[ti]\\|[ \t]*\\(let[ \t]+\\)?\\(fun\\|and\\)\\_>"
152 "Regexp matching a major heading.
153 This actually can't work without extending `outline-minor-mode' with the
154 notion of \"the end of an outline\".")
155
156 ;;
157 ;; Internal defines
158 ;;
159
160 (defvar sml-mode-map
161 (let ((map (make-sparse-keymap)))
162 ;; Text-formatting commands:
163 (define-key map "\C-c\C-m" 'sml-insert-form)
164 (define-key map "\M-|" 'sml-electric-pipe)
165 (define-key map "\M-\ " 'sml-electric-space)
166 (define-key map [backtab] 'sml-back-to-outer-indent)
167 ;; The standard binding is C-c C-z, but we add this one for compatibility.
168 (define-key map "\C-c\C-s" 'sml-prog-proc-switch-to)
169 map)
170 "The keymap used in `sml-mode'.")
171
172 (defvar sml-mode-syntax-table
173 (let ((st (make-syntax-table)))
174 (modify-syntax-entry ?\* ". 23n" st)
175 (modify-syntax-entry ?\( "()1" st)
176 (modify-syntax-entry ?\) ")(4" st)
177 (mapc (lambda (c) (modify-syntax-entry c "_" st)) "._'")
178 (mapc (lambda (c) (modify-syntax-entry c "." st)) ",;")
179 ;; `!' is not really a prefix-char, oh well!
180 (mapc (lambda (c) (modify-syntax-entry c "'" st)) "~#!")
181 (mapc (lambda (c) (modify-syntax-entry c "." st)) "%&$+-/:<=>?@`^|")
182 st)
183 "The syntax table used in `sml-mode'.")
184
185
186 (easy-menu-define sml-mode-menu sml-mode-map "Menu used in `sml-mode'."
187 '("SML"
188 ("Process"
189 ["Start SML repl" sml-run t]
190 ["-" nil nil]
191 ["Compile the project" sml-prog-proc-compile t]
192 ["Send file" sml-prog-proc-load-file t]
193 ["Switch to SML repl" sml-prog-proc-switch-to t]
194 ["--" nil nil]
195 ["Send buffer" sml-prog-proc-send-buffer t]
196 ["Send region" sml-prog-proc-send-region t]
197 ["Send function" sml-send-function t]
198 ["Goto next error" next-error t])
199 ["Insert SML form" sml-insert-form t]
200 ("Forms" :filter sml-forms-menu)
201 ["Indent region" indent-region t]
202 ["Outdent line" sml-back-to-outer-indent t]
203 ["-----" nil nil]
204 ["Customize SML-mode" (customize-group 'sml) t]
205 ["SML mode help" describe-mode t]))
206
207 ;;
208 ;; Regexps
209 ;;
210
211 (defun sml-syms-re (syms)
212 (concat "\\_<" (regexp-opt syms t) "\\_>"))
213
214 ;;
215
216 (defconst sml-module-head-syms
217 '("signature" "structure" "functor" "abstraction"))
218
219
220 (defconst sml-=-starter-syms
221 (list* "|" "val" "fun" "and" "datatype" "type" "abstype" "eqtype"
222 sml-module-head-syms)
223 "Symbols that can be followed by a `='.")
224 (defconst sml-=-starter-re
225 (concat "\\S.|\\S.\\|" (sml-syms-re (cdr sml-=-starter-syms)))
226 "Symbols that can be followed by a `='.")
227
228 (defconst sml-non-nested-of-starter-re
229 (sml-syms-re '("datatype" "abstype" "exception"))
230 "Symbols that can introduce an `of' that shouldn't behave like a paren.")
231
232 (defconst sml-starters-syms
233 (append sml-module-head-syms
234 '("abstype" "datatype" "exception" "fun"
235 "local" "infix" "infixr" "sharing" "nonfix"
236 "open" "type" "val" "and"
237 "withtype" "with"))
238 "The starters of new expressions.")
239
240 (defconst sml-pipeheads
241 '("|" "of" "fun" "fn" "and" "handle" "datatype" "abstype"
242 "(" "{" "[")
243 "A `|' corresponds to one of these.")
244
245 (defconst sml-keywords-regexp
246 (sml-syms-re '("abstraction" "abstype" "and" "andalso" "as" "before" "case"
247 "datatype" "else" "end" "eqtype" "exception" "do" "fn"
248 "fun" "functor" "handle" "if" "in" "include" "infix"
249 "infixr" "let" "local" "nonfix" "o" "of" "op" "open" "orelse"
250 "overload" "raise" "rec" "sharing" "sig" "signature"
251 "struct" "structure" "then" "type" "val" "where" "while"
252 "with" "withtype"))
253 "A regexp that matches any and all keywords of SML.")
254
255 (eval-and-compile
256 (defconst sml-id-re "\\sw\\(?:\\sw\\|\\s_\\)*"))
257
258 (defconst sml-tyvarseq-re
259 (concat "\\(?:\\(?:'+" sml-id-re "\\|(\\(?:[,']\\|" sml-id-re
260 "\\|\\s-\\)+)\\)\\s-+\\)?"))
261
262 ;;; Font-lock settings ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
263
264 (defcustom sml-font-lock-symbols nil
265 "Display \\ and -> and such using symbols in fonts.
266 This may sound like a neat trick, but be extra careful: it changes the
267 alignment and can thus lead to nasty surprises w.r.t layout."
268 :type 'boolean)
269
270 (defconst sml-font-lock-symbols-alist
271 '(("fn" . ?λ)
272 ("andalso" . ?∧) ;; ?⋀
273 ("orelse" . ?∨) ;; ?⋁
274 ;; ("as" . ?≡)
275 ("not" . ?¬)
276 ("div" . ?÷)
277 ("*" . ?×)
278 ("o" . ?○)
279 ("->" . ?→)
280 ("=>" . ?⇒)
281 ("<-" . ?←)
282 ("<>" . ?≠)
283 (">=" . ?≥)
284 ("<=" . ?≤)
285 ("..." . ?⋯)
286 ;; ("::" . ?∷)
287 ;; Some greek letters for type parameters.
288 ("'a" . ?α)
289 ("'b" . ?β)
290 ("'c" . ?γ)
291 ("'d" . ?δ)
292 ))
293
294 (defun sml-font-lock-compose-symbol ()
295 "Compose a sequence of ascii chars into a symbol.
296 Regexp match data 0 points to the chars."
297 ;; Check that the chars should really be composed into a symbol.
298 (let* ((start (match-beginning 0))
299 (end (match-end 0))
300 (syntaxes (if (eq (char-syntax (char-after start)) ?w)
301 '(?w) '(?. ?\\))))
302 (if (or (memq (char-syntax (or (char-before start) ?\ )) syntaxes)
303 (memq (char-syntax (or (char-after end) ?\ )) syntaxes)
304 (memq (get-text-property start 'face)
305 '(font-lock-doc-face font-lock-string-face
306 font-lock-comment-face)))
307 ;; No composition for you. Let's actually remove any composition
308 ;; we may have added earlier and which is now incorrect.
309 (remove-text-properties start end '(composition))
310 ;; That's a symbol alright, so add the composition.
311 (compose-region start end (cdr (assoc (match-string 0)
312 sml-font-lock-symbols-alist)))))
313 ;; Return nil because we're not adding any face property.
314 nil)
315
316 (defun sml-font-lock-symbols-keywords ()
317 (when sml-font-lock-symbols
318 `((,(regexp-opt (mapcar 'car sml-font-lock-symbols-alist) t)
319 (0 (sml-font-lock-compose-symbol))))))
320
321 ;; The font lock regular expressions.
322
323 (defconst sml-font-lock-keywords
324 `(;;(sml-font-comments-and-strings)
325 (,(concat "\\_<\\(fun\\|and\\)\\s-+" sml-tyvarseq-re
326 "\\(" sml-id-re "\\)\\s-+[^ \t\n=]")
327 (1 font-lock-keyword-face)
328 (2 font-lock-function-name-face))
329 (,(concat "\\_<\\(\\(?:data\\|abs\\|with\\|eq\\)?type\\)\\s-+"
330 sml-tyvarseq-re "\\(" sml-id-re "\\)")
331 (1 font-lock-keyword-face)
332 (2 font-lock-type-def-face))
333 (,(concat "\\_<\\(val\\)\\s-+\\(?:" sml-id-re "\\_>\\s-*\\)?\\("
334 sml-id-re "\\)\\s-*[=:]")
335 (1 font-lock-keyword-face)
336 (2 font-lock-variable-name-face))
337 (,(concat "\\_<\\(structure\\|functor\\|abstraction\\)\\s-+\\("
338 sml-id-re "\\)")
339 (1 font-lock-keyword-face)
340 (2 font-lock-module-def-face))
341 (,(concat "\\_<\\(signature\\)\\s-+\\(" sml-id-re "\\)")
342 (1 font-lock-keyword-face)
343 (2 font-lock-interface-def-face))
344
345 (,sml-keywords-regexp . font-lock-keyword-face)
346 ,@(sml-font-lock-symbols-keywords))
347 "Regexps matching standard SML keywords.")
348
349 (defface font-lock-type-def-face
350 '((t (:bold t)))
351 "Font Lock mode face used to highlight type definitions."
352 :group 'font-lock-highlighting-faces)
353 (defvar font-lock-type-def-face 'font-lock-type-def-face
354 "Face name to use for type definitions.")
355
356 (defface font-lock-module-def-face
357 '((t (:bold t)))
358 "Font Lock mode face used to highlight module definitions."
359 :group 'font-lock-highlighting-faces)
360 (defvar font-lock-module-def-face 'font-lock-module-def-face
361 "Face name to use for module definitions.")
362
363 (defface font-lock-interface-def-face
364 '((t (:bold t)))
365 "Font Lock mode face used to highlight interface definitions."
366 :group 'font-lock-highlighting-faces)
367 (defvar font-lock-interface-def-face 'font-lock-interface-def-face
368 "Face name to use for interface definitions.")
369
370 ;;
371 ;; Code to handle nested comments and unusual string escape sequences
372 ;;
373
374 (defvar sml-syntax-prop-table
375 (let ((st (make-syntax-table)))
376 (modify-syntax-entry ?\\ "." st)
377 (modify-syntax-entry ?* "." st)
378 st)
379 "Syntax table for text-properties.")
380
381 (defconst sml-font-lock-syntactic-keywords
382 `(("^\\s-*\\(\\\\\\)" (1 ',sml-syntax-prop-table))))
383
384 (defconst sml-font-lock-defaults
385 '(sml-font-lock-keywords nil nil nil nil
386 (font-lock-syntactic-keywords . sml-font-lock-syntactic-keywords)))
387
388
389 ;;; Indentation with SMIE
390
391 (defconst sml-smie-grammar
392 ;; We have several problem areas where SML's syntax can't be handled by an
393 ;; operator precedence grammar:
394 ;;
395 ;; "= A before B" is "= A) before B" if this is the
396 ;; `boolean-=' but it is "= (A before B)" if it's the `definitional-='.
397 ;; We can work around the problem by tweaking the lexer to return two
398 ;; different tokens for the two different kinds of `='.
399 ;; "of A | B" in a "case" we want "of (A | B, but in a `datatype'
400 ;; we want "of A) | B".
401 ;; "= A | B" can be "= A ) | B" if the = is from a "fun" definition,
402 ;; but it is "= (A | B" if it is a `datatype' definition (of course, if
403 ;; the previous token introducing the = is `and', deciding whether
404 ;; it's a datatype or a function requires looking even further back).
405 ;; "functor foo (...) where type a = b = ..." the first `=' looks very much
406 ;; like a `definitional-=' even tho it's just an equality constraint.
407 ;; Currently I don't even try to handle `where' at all.
408 (smie-prec2->grammar
409 (smie-merge-prec2s
410 (smie-bnf->prec2
411 '((exp ("if" exp "then" exp "else" exp)
412 ("case" exp "of" branches)
413 ("let" decls "in" cmds "end")
414 ("struct" decls "end")
415 ("sig" decls "end")
416 (sexp)
417 (sexp "handle" branches)
418 ("fn" sexp "=>" exp))
419 ;; "simple exp"s are the ones that can appear to the left of `handle'.
420 (sexp (sexp ":" type) ("(" exps ")")
421 (sexp "orelse" sexp)
422 (marg ":>" type)
423 (sexp "andalso" sexp))
424 (cmds (cmds ";" cmds) (exp))
425 (exps (exps "," exps) (exp)) ; (exps ";" exps)
426 (branches (sexp "=>" exp) (branches "|" branches))
427 ;; Operator precedence grammars handle separators much better then
428 ;; starters/terminators, so let's pretend that let/fun are separators.
429 (decls (sexp "d=" exp)
430 (sexp "d=" databranches)
431 (funbranches "|" funbranches)
432 (sexp "=of" type) ;After "exception".
433 ;; FIXME: Just like PROCEDURE in Pascal and Modula-2, this
434 ;; interacts poorly with the other constructs since I
435 ;; can't make "local" a separator like fun/val/type/...
436 ("local" decls "in" decls "end")
437 ;; (decls "local" decls "in" decls "end")
438 (decls "functor" decls)
439 (decls "signature" decls)
440 (decls "structure" decls)
441 (decls "type" decls)
442 (decls "open" decls)
443 (decls "and" decls)
444 (decls "withtype" decls)
445 (decls "infix" decls)
446 (decls "infixr" decls)
447 (decls "nonfix" decls)
448 (decls "abstype" decls)
449 (decls "datatype" decls)
450 (decls "include" decls)
451 (decls "sharing" decls)
452 (decls "exception" decls)
453 (decls "fun" decls)
454 (decls "val" decls))
455 (type (type "->" type)
456 (type "*" type))
457 (funbranches (sexp "d=" exp))
458 (databranches (sexp "=of" type) (databranches "d|" databranches))
459 ;; Module language.
460 ;; (mexp ("functor" marg "d=" mexp)
461 ;; ("structure" marg "d=" mexp)
462 ;; ("signature" marg "d=" mexp))
463 (marg (marg ":" type) (marg ":>" type))
464 (toplevel (decls) (exp) (toplevel ";" toplevel)))
465 ;; '(("local" . opener))
466 ;; '((nonassoc "else") (right "handle"))
467 '((nonassoc "of") (assoc "|")) ; "case a of b => case c of d => e | f"
468 '((nonassoc "handle") (assoc "|")) ; Idem for "handle".
469 '((assoc "->") (assoc "*"))
470 '((assoc "val" "fun" "type" "datatype" "abstype" "open" "infix" "infixr"
471 "nonfix" "functor" "signature" "structure" "exception"
472 "include" "sharing" "local")
473 (assoc "withtype")
474 (assoc "and"))
475 '((assoc "orelse") (assoc "andalso") (nonassoc ":"))
476 '((assoc ";")) '((assoc ",")) '((assoc "d|")))
477
478 (smie-precs->prec2
479 '((nonassoc "andalso") ;To anchor the prec-table.
480 (assoc "before") ;0
481 (assoc ":=" "o") ;3
482 (nonassoc ">" ">=" "<>" "<" "<=" "=") ;4
483 (assoc "::" "@") ;5
484 (assoc "+" "-" "^") ;6
485 (assoc "/" "*" "quot" "rem" "div" "mod") ;7
486 (nonassoc " -dummy- "))) ;Bogus anchor at the end.
487 )))
488
489 (defvar sml-indent-separator-outdent 2)
490
491 (defun sml--rightalign-and-p ()
492 (when sml-rightalign-and
493 ;; Only right-align the "and" if the intervening code is more deeply
494 ;; indented, to avoid things like:
495 ;; datatype foo
496 ;; = Foo of int
497 ;; and bar = Bar of string
498 (save-excursion
499 (let ((max (line-end-position 0))
500 (data (smie-backward-sexp "and"))
501 (startcol (save-excursion
502 (forward-comment (- (point)))
503 (current-column)))
504 (mincol (current-column)))
505 (save-excursion
506 (search-forward "=" max t)
507 (forward-line 1)
508 (if (< (point) max) (setq max (point))))
509 (while (and (<= (point) max) (not (eobp)))
510 (skip-chars-forward " \t")
511 (setq mincol (current-column))
512 (forward-line 1))
513 (>= mincol startcol)))))
514
515 (defun sml-smie-rules (kind token)
516 (pcase (cons kind token)
517 (`(:elem . basic) sml-indent-level)
518 (`(:elem . args) sml-indent-args)
519 (`(:list-intro . "fn") t)
520 (`(:close-all . ,_) t)
521 (`(:after . "struct") 0)
522 (`(:after . "=>") (if (smie-rule-hanging-p) 0 2))
523 (`(:after . "in") (if (smie-rule-parent-p "local") 0))
524 (`(:after . "of") 3)
525 (`(:after . ,(or `"(" `"{" `"[")) (if (not (smie-rule-hanging-p)) 2))
526 (`(:after . "else") (if (smie-rule-hanging-p) 0)) ;; (:next "if" 0)
527 (`(:after . ,(or `"|" `"d|" `";" `",")) (smie-rule-separator kind))
528 (`(:after . "d=")
529 (if (and (smie-rule-parent-p "val") (smie-rule-next-p "fn")) -3))
530 (`(:before . "=>") (if (smie-rule-parent-p "fn") 3))
531 (`(:before . "of") 1)
532 ;; In case the language is extended to allow a | directly after of.
533 (`(:before . ,(and `"|" (guard (smie-rule-prev-p "of")))) 1)
534 (`(:before . ,(or `"|" `"d|" `";" `",")) (smie-rule-separator kind))
535 ;; Treat purely syntactic block-constructs as being part of their parent,
536 ;; when the opening statement is hanging.
537 (`(:before . ,(or `"let" `"(" `"[" `"{")) ; "struct"? "sig"?
538 (if (smie-rule-hanging-p) (smie-rule-parent)))
539 ;; Treat if ... else if ... as a single long syntactic construct.
540 ;; Similarly, treat fn a => fn b => ... as a single construct.
541 (`(:before . ,(or `"if" `"fn"))
542 (and (not (smie-rule-bolp))
543 (smie-rule-prev-p (if (equal token "if") "else" "=>"))
544 (smie-rule-parent)))
545 (`(:before . "and")
546 ;; FIXME: maybe "and" (c|sh)ould be handled as an smie-separator.
547 (cond
548 ((smie-rule-parent-p "datatype" "withtype")
549 (if (sml--rightalign-and-p) 5 0))
550 ((smie-rule-parent-p "fun" "val") 0)))
551 (`(:before . "withtype") 0)
552 (`(:before . "d=")
553 (cond
554 ((smie-rule-parent-p "datatype") (if (smie-rule-bolp) 2))
555 ((smie-rule-parent-p "structure" "signature" "functor") 0)))
556 ;; Indent an expression starting with "local" as if it were starting
557 ;; with "fun".
558 (`(:before . "local") (smie-indent-keyword "fun"))
559 ;; FIXME: type/val/fun/... are separators but "local" is not, even though
560 ;; it appears in the same list. Try to fix up the problem by hand.
561 ;; ((or (equal token "local")
562 ;; (equal (cdr (assoc token smie-grammar))
563 ;; (cdr (assoc "fun" smie-grammar))))
564 ;; (let ((parent (save-excursion (smie-backward-sexp))))
565 ;; (when (or (and (equal (nth 2 parent) "local")
566 ;; (null (car parent)))
567 ;; (progn
568 ;; (setq parent (save-excursion (smie-backward-sexp "fun")))
569 ;; (eq (car parent) (nth 1 (assoc "fun" smie-grammar)))))
570 ;; (goto-char (nth 1 parent))
571 ;; (cons 'column (smie-indent-virtual)))))
572 ))
573
574 (defun sml-smie-definitional-equal-p ()
575 "Figure out which kind of \"=\" this is.
576 Assumes point is right before the = sign."
577 ;; The idea is to look backward for the first occurrence of a token that
578 ;; requires a definitional "=" and then see if there's such a definitional
579 ;; equal between that token and ourselves (in which case we're not
580 ;; a definitional = ourselves).
581 ;; The "search for =" is naive and will match "=>" and "<=", but it turns
582 ;; out to be OK in practice because such tokens very rarely (if ever) appear
583 ;; between the =-starter and the corresponding definitional equal.
584 ;; One known problem case is code like:
585 ;; "functor foo (structure s : S) where type t = s.t ="
586 ;; where the "type t = s.t" is mistaken for a type definition.
587 (save-excursion
588 (let ((res (smie-backward-sexp "=")))
589 (member (nth 2 res) `(":" ,@sml-=-starter-syms)))))
590
591 (defun sml-smie-non-nested-of-p ()
592 ;; FIXME: Maybe datatype-|-p makes this nested-of business unnecessary.
593 "Figure out which kind of \"of\" this is.
594 Assumes point is right before the \"of\" symbol."
595 (save-excursion
596 ;; (let ((case-fold-search nil))
597 ;; (and (re-search-backward (concat "\\(" sml-non-nested-of-starter-re
598 ;; "\\)\\|\\_<case\\_>")
599 ;; nil t)
600 ;; (match-beginning 1)))
601 (and (stringp (sml-smie-backward-token-1))
602 (let ((tok (sml-smie-backward-token-1)))
603 (if (equal tok "=")
604 (equal "d=" (sml-smie-forward-token))
605 (member tok '("|" "exception")))))))
606
607 (defun sml-smie-datatype-|-p ()
608 "Figure out which kind of \"|\" this is.
609 Assumes point is right before the | symbol."
610 (save-excursion
611 (forward-char 1) ;Skip the |.
612 (let ((after-type-def
613 '("|" "of" "in" "datatype" "and" "exception" "abstype" "infix"
614 "infixr" "nonfix" "local" "val" "fun" "structure" "functor"
615 "signature")))
616 (or (member (sml-smie-forward-token-1) after-type-def) ;Skip the tag.
617 (member (sml-smie-forward-token-1) after-type-def)))))
618
619 (defun sml-smie-forward-token-1 ()
620 (forward-comment (point-max))
621 (buffer-substring-no-properties
622 (point)
623 (progn
624 (or (/= 0 (skip-syntax-forward "'w_"))
625 (skip-syntax-forward ".'"))
626 (point))))
627
628 (defun sml-smie-forward-token ()
629 (let ((sym (sml-smie-forward-token-1)))
630 (cond
631 ((equal "op" sym)
632 (concat "op " (sml-smie-forward-token-1)))
633 ((member sym '("|" "of" "="))
634 ;; The important lexer for indentation's performance is the backward
635 ;; lexer, so for the forward lexer we delegate to the backward one.
636 (save-excursion (sml-smie-backward-token)))
637 (t sym))))
638
639 (defun sml-smie-backward-token-1 ()
640 (forward-comment (- (point)))
641 (buffer-substring-no-properties
642 (point)
643 (progn
644 (or (/= 0 (skip-syntax-backward ".'"))
645 (skip-syntax-backward "'w_"))
646 (point))))
647
648 (defun sml-smie-backward-token ()
649 (let ((sym (sml-smie-backward-token-1)))
650 (unless (zerop (length sym))
651 ;; FIXME: what should we do if `sym' = "op" ?
652 (let ((point (point)))
653 (if (equal "op" (sml-smie-backward-token-1))
654 (concat "op " sym)
655 (goto-char point)
656 (cond
657 ((string= sym "=") (if (sml-smie-definitional-equal-p) "d=" "="))
658 ((string= sym "of") (if (sml-smie-non-nested-of-p) "=of" "of"))
659 ((string= sym "|") (if (sml-smie-datatype-|-p) "d|" "|"))
660 (t sym)))))))
661
662 ;;;;
663 ;;;; Imenu support
664 ;;;;
665
666 (defconst sml-imenu-regexp
667 (concat "^[ \t]*\\(let[ \t]+\\)?"
668 (regexp-opt (append sml-module-head-syms
669 '("and" "fun" "datatype" "abstype" "type")) t)
670 "\\_>"))
671
672 (defun sml-imenu-create-index ()
673 (let (alist)
674 (goto-char (point-max))
675 (while (re-search-backward sml-imenu-regexp nil t)
676 (save-excursion
677 (let ((kind (match-string 2))
678 (column (progn (goto-char (match-beginning 2)) (current-column)))
679 (location
680 (progn (goto-char (match-end 0))
681 (forward-comment (point-max))
682 (when (looking-at sml-tyvarseq-re)
683 (goto-char (match-end 0)))
684 (point)))
685 (name (sml-smie-forward-token)))
686 ;; Eliminate trivial renamings.
687 (when (or (not (member kind '("structure" "signature")))
688 (when (search-forward "=" nil t)
689 (forward-comment (point-max))
690 (looking-at "sig\\|struct")))
691 (push (cons (concat (make-string (/ column 2) ?\ ) name) location)
692 alist)))))
693 alist))
694
695 ;;; Generic prog-proc interaction.
696
697 (require 'comint)
698 (require 'compile)
699
700 (defvar sml-prog-proc-mode-map
701 (let ((map (make-sparse-keymap)))
702 (define-key map [?\C-c ?\C-l] 'sml-prog-proc-load-file)
703 (define-key map [?\C-c ?\C-c] 'sml-prog-proc-compile)
704 (define-key map [?\C-c ?\C-z] 'sml-prog-proc-switch-to)
705 (define-key map [?\C-c ?\C-r] 'sml-prog-proc-send-region)
706 (define-key map [?\C-c ?\C-b] 'sml-prog-proc-send-buffer)
707 ;; FIXME: Add
708 ;; (define-key map [?\M-C-x] 'sml-prog-proc-send-defun)
709 ;; (define-key map [?\C-x ?\C-e] 'sml-prog-proc-send-last-sexp)
710 ;; FIXME: Add menu. Now, that's trickier because keymap inheritance
711 ;; doesn't play nicely with menus!
712 map)
713 "Keymap for `sml-prog-proc-mode'.")
714
715 (defvar sml-prog-proc--buffer nil
716 "The inferior-process buffer to which to send code.")
717 (make-variable-buffer-local 'sml-prog-proc--buffer)
718
719 (defstruct (sml-prog-proc-descriptor
720 (:constructor sml-prog-proc-make)
721 (:predicate nil)
722 (:copier nil))
723 (name nil :read-only t)
724 (run nil :read-only t)
725 (load-cmd nil :read-only t)
726 (chdir-cmd nil :read-only t)
727 (command-eol "\n" :read-only t)
728 (compile-commands-alist nil :read-only t))
729
730 (defvar sml-prog-proc-descriptor nil
731 "Struct containing the various functions to create a new process, ...")
732
733 (defmacro sml-prog-proc--prop (prop)
734 `(,(intern (format "sml-prog-proc-descriptor-%s" prop))
735 (or sml-prog-proc-descriptor
736 ;; FIXME: Look for available ones and pick one.
737 (error "Not a `sml-prog-proc' buffer"))))
738 (defmacro sml-prog-proc--call (method &rest args)
739 `(funcall (sml-prog-proc--prop ,method) ,@args))
740
741 ;; The inferior process and his buffer are basically interchangeable.
742 ;; Currently the code takes sml-prog-proc--buffer as the main reference,
743 ;; but all users should either use sml-prog-proc-proc or sml-prog-proc-buffer
744 ;; to find the info.
745
746 (defun sml-prog-proc-proc ()
747 "Return the inferior process for the code in current buffer."
748 (or (and (buffer-live-p sml-prog-proc--buffer)
749 (get-buffer-process sml-prog-proc--buffer))
750 (when (derived-mode-p 'sml-prog-proc-mode 'sml-prog-proc-comint-mode)
751 (setq sml-prog-proc--buffer (current-buffer))
752 (get-buffer-process sml-prog-proc--buffer))
753 (let ((ppd sml-prog-proc-descriptor)
754 (buf (sml-prog-proc--call run)))
755 (with-current-buffer buf
756 (if (and ppd (null sml-prog-proc-descriptor))
757 (set (make-local-variable 'sml-prog-proc-descriptor) ppd)))
758 (setq sml-prog-proc--buffer buf)
759 (get-buffer-process sml-prog-proc--buffer))))
760
761 (defun sml-prog-proc-buffer ()
762 "Return the buffer of the inferior process."
763 (process-buffer (sml-prog-proc-proc)))
764
765 (defun sml-prog-proc-switch-to ()
766 "Switch to the buffer running the read-eval-print process."
767 (interactive)
768 (pop-to-buffer (sml-prog-proc-buffer)))
769
770 (defun sml-prog-proc-send-string (proc str)
771 "Send command STR to PROC, with an EOL terminator appended."
772 (with-current-buffer (process-buffer proc)
773 ;; FIXME: comint-send-string does not pass the string through
774 ;; comint-input-filter-function, so we have to do it by hand.
775 ;; Maybe we should insert the command into the buffer and then call
776 ;; comint-send-input?
777 (sml-prog-proc-comint-input-filter-function nil)
778 (comint-send-string proc (concat str (sml-prog-proc--prop command-eol)))))
779
780 (defun sml-prog-proc-load-file (file &optional and-go)
781 "Load FILE into the read-eval-print process.
782 FILE is the file visited by the current buffer.
783 If prefix argument AND-GO is used, then we additionally switch
784 to the buffer where the process is running."
785 (interactive
786 (list (or buffer-file-name
787 (read-file-name "File to load: " nil nil t))
788 current-prefix-arg))
789 (comint-check-source file)
790 (let ((proc (sml-prog-proc-proc)))
791 (sml-prog-proc-send-string proc (sml-prog-proc--call load-cmd file))
792 (when and-go (pop-to-buffer (process-buffer proc)))))
793
794 (defvar sml-prog-proc--tmp-file nil)
795
796 (defun sml-prog-proc-send-region (start end &optional and-go)
797 "Send the content of the region to the read-eval-print process.
798 START..END delimit the region; AND-GO if non-nil indicate to additionally
799 switch to the process's buffer."
800 (interactive "r\nP")
801 (if (> start end) (let ((tmp end)) (setq end start) (setq start tmp))
802 (if (= start end) (error "Nothing to send: the region is empty")))
803 (let ((proc (sml-prog-proc-proc))
804 (tmp (make-temp-file "emacs-region")))
805 (write-region start end tmp nil 'silently)
806 (when sml-prog-proc--tmp-file
807 (ignore-errors (delete-file (car sml-prog-proc--tmp-file)))
808 (set-marker (cdr sml-prog-proc--tmp-file) nil))
809 (setq sml-prog-proc--tmp-file (cons tmp (copy-marker start)))
810 (sml-prog-proc-send-string proc (sml-prog-proc--call load-cmd tmp))
811 (when and-go (pop-to-buffer (process-buffer proc)))))
812
813 (defun sml-prog-proc-send-buffer (&optional and-go)
814 "Send the content of the current buffer to the read-eval-print process.
815 AND-GO if non-nil indicate to additionally switch to the process's buffer."
816 (interactive "P")
817 (sml-prog-proc-send-region (point-min) (point-max) and-go))
818
819 (define-derived-mode sml-prog-proc-mode prog-mode "Sml-Prog-Proc"
820 "Major mode for editing source code and interact with an interactive loop."
821 )
822
823 ;;; Extended comint-mode for Sml-Prog-Proc.
824
825 (defun sml-prog-proc-chdir (dir)
826 "Change the working directory of the inferior process to DIR."
827 (interactive "DChange to directory: ")
828 (let ((dir (expand-file-name dir))
829 (proc (sml-prog-proc-proc)))
830 (with-current-buffer (process-buffer proc)
831 (sml-prog-proc-send-string proc (sml-prog-proc--call chdir-cmd dir))
832 (setq default-directory (file-name-as-directory dir)))))
833
834 (defun sml-prog-proc-comint-input-filter-function (str)
835 ;; `compile.el' doesn't know that file location info from errors should be
836 ;; recomputed afresh (without using stale info from earlier compilations).
837 (compilation-forget-errors) ;Has to run before compilation-fake-loc.
838 (if (and sml-prog-proc--tmp-file (marker-buffer (cdr sml-prog-proc--tmp-file)))
839 (compilation-fake-loc (cdr sml-prog-proc--tmp-file)
840 (car sml-prog-proc--tmp-file)))
841 str)
842
843 (defvar sml-prog-proc-comint-mode-map
844 (let ((map (make-sparse-keymap)))
845 (define-key map "\C-c\C-l" 'sml-prog-proc-load-file)
846 map))
847
848 (define-derived-mode sml-prog-proc-comint-mode comint-mode "Sml-Prog-Proc-Comint"
849 "Major mode for an inferior process used to run&compile source code."
850 ;; Enable compilation-minor-mode, but only after the child mode is setup
851 ;; since the child-mode might want to add rules to
852 ;; compilation-error-regexp-alist.
853 (add-hook 'after-change-major-mode-hook #'compilation-minor-mode nil t)
854 ;; The keymap of compilation-minor-mode is too unbearable, so we
855 ;; need to hide most of the bindings.
856 (let ((map (make-sparse-keymap)))
857 (dolist (keys '([menu-bar] [follow-link]))
858 ;; Preserve some of the bindings.
859 (define-key map keys (lookup-key compilation-minor-mode-map keys)))
860 (add-to-list 'minor-mode-overriding-map-alist
861 (cons 'compilation-minor-mode map)))
862
863 (add-hook 'comint-input-filter-functions
864 #'sml-prog-proc-comint-input-filter-function nil t))
865
866 (defvar sml-prog-proc--compile-command nil
867 "The command used by default by `sml-prog-proc-compile'.")
868
869 (defun sml-prog-proc-compile (command &optional and-go)
870 "Pass COMMAND to the read-eval-loop process to compile the current file.
871
872 You can then use the command \\[next-error] to find the next error message
873 and move to the source code that caused it.
874
875 Interactively, prompts for the command if `compilation-read-command' is
876 non-nil. With prefix arg, always prompts.
877
878 Prefix arg AND-GO also means to switch to the read-eval-loop buffer afterwards."
879 (interactive
880 (let* ((dir default-directory)
881 (cmd "cd \"."))
882 ;; Look for files to determine the default command.
883 (while (and (stringp dir)
884 (progn
885 (dolist (cf (sml-prog-proc--prop compile-commands-alist))
886 (when (file-exists-p (expand-file-name (cdr cf) dir))
887 (setq cmd (concat cmd "\"; " (car cf)))
888 (return nil)))
889 (not cmd)))
890 (let ((newdir (file-name-directory (directory-file-name dir))))
891 (setq dir (unless (equal newdir dir) newdir))
892 (setq cmd (concat cmd "/.."))))
893 (setq cmd
894 (cond
895 ((local-variable-p 'sml-prog-proc--compile-command)
896 sml-prog-proc--compile-command)
897 ((string-match "^\\s-*cd\\s-+\"\\.\"\\s-*;\\s-*" cmd)
898 (substring cmd (match-end 0)))
899 ((string-match "^\\s-*cd\\s-+\"\\(\\./\\)" cmd)
900 (replace-match "" t t cmd 1))
901 ((string-match ";" cmd) cmd)
902 (t sml-prog-proc--compile-command)))
903 ;; code taken from compile.el
904 (list (if (or compilation-read-command current-prefix-arg)
905 (read-from-minibuffer "Compile command: "
906 cmd nil nil '(compile-history . 1))
907 cmd))))
908 ;; ;; now look for command's file to determine the directory
909 ;; (setq dir default-directory)
910 ;; (while (and (stringp dir)
911 ;; (dolist (cf (sml-prog-proc--prop compile-commands-alist) t)
912 ;; (when (and (equal cmd (car cf))
913 ;; (file-exists-p (expand-file-name (cdr cf) dir)))
914 ;; (return nil))))
915 ;; (let ((newdir (file-name-directory (directory-file-name dir))))
916 ;; (setq dir (unless (equal newdir dir) newdir))))
917 ;; (setq dir (or dir default-directory))
918 ;; (list cmd dir)))
919 (set (make-local-variable 'sml-prog-proc--compile-command) command)
920 (save-some-buffers (not compilation-ask-about-save) nil)
921 (let ((dir default-directory))
922 (when (string-match "^\\s-*cd\\s-+\"\\([^\"]+\\)\"\\s-*;" command)
923 (setq dir (match-string 1 command))
924 (setq command (replace-match "" t t command)))
925 (setq dir (expand-file-name dir))
926 (let ((proc (sml-prog-proc-proc))
927 (eol (sml-prog-proc--prop command-eol)))
928 (with-current-buffer (process-buffer proc)
929 (setq default-directory dir)
930 (sml-prog-proc-send-string
931 proc (concat (sml-prog-proc--call chdir-cmd dir)
932 ;; Strip the newline, to avoid adding a prompt.
933 (if (string-match "\n\\'" eol)
934 (replace-match " " t t eol) eol)
935 command))
936 (when and-go (pop-to-buffer (process-buffer proc)))))))
937
938
939 ;;; SML Sml-Prog-Proc support.
940
941 (defcustom sml-program-name "sml"
942 "Program to run as Standard SML read-eval-print loop."
943 :type 'string)
944
945 (defcustom sml-default-arg ""
946 "Default command line option to pass to `sml-program-name', if any."
947 :type 'string)
948
949 (defcustom sml-host-name ""
950 "Host on which to run `sml-program-name'."
951 :type 'string)
952
953 (defcustom sml-config-file "~/.smlproc.sml"
954 "File that should be fed to the SML process when started."
955 :type 'string)
956
957
958 (defcustom sml-prompt-regexp "^[-=>#] *"
959 "Regexp used to recognise prompts in the inferior SML process."
960 :type 'regexp)
961
962 (defcustom sml-compile-commands-alist
963 '(("CMB.make()" . "all-files.cm")
964 ("CMB.make()" . "pathconfig")
965 ("CM.make()" . "sources.cm")
966 ("use \"load-all\"" . "load-all"))
967 "Commands used by default by `sml-sml-prog-proc-compile'.
968 Each command is associated with its \"main\" file.
969 It is perfectly OK to associate several files with a command or several
970 commands with the same file.")
971
972 ;; FIXME: Try to auto-detect the process and set those vars accordingly.
973
974 (defvar sml-use-command "use \"%s\""
975 "Template for loading a file into the inferior SML process.
976 Set to \"use \\\"%s\\\"\" for SML/NJ or Edinburgh ML;
977 set to \"PolyML.use \\\"%s\\\"\" for Poly/ML, etc.")
978
979 (defvar sml-cd-command "OS.FileSys.chDir \"%s\""
980 "Command template for changing working directories under SML.
981 Set this to nil if your compiler can't change directories.
982
983 The format specifier \"%s\" will be converted into the directory name
984 specified when running the command \\[sml-cd].")
985
986 (defvar sml-error-regexp-alist
987 `( ;; Poly/ML messages
988 ("^\\(Error\\|Warning:\\) in '\\(.+\\)', line \\([0-9]+\\)" 2 3)
989 ;; Moscow ML
990 ("^File \"\\([^\"]+\\)\", line \\([0-9]+\\)\\(-\\([0-9]+\\)\\)?, characters \\([0-9]+\\)-\\([0-9]+\\):" 1 2 5)
991 ;; SML/NJ: the file-pattern is anchored to avoid
992 ;; pathological behavior with very long lines.
993 ("^[-= ]*\\(.*[^\n)]\\)\\( (.*)\\)?:\\([0-9]+\\)\\.\\([0-9]+\\)\\(-\\([0-9]+\\)\\.\\([0-9]+\\)\\)? \\(Error\\|Warnin\\(g\\)\\): .*" 1
994 (3 . 6) (4 . 7) (9))
995 ;; SML/NJ's exceptions: see above.
996 ("^ +\\(raised at: \\)?\\(.+\\):\\([0-9]+\\)\\.\\([0-9]+\\)\\(-\\([0-9]+\\)\\.\\([0-9]+\\)\\)" 2
997 (3 . 6) (4 . 7)))
998 "Alist that specifies how to match errors in compiler output.
999 See `compilation-error-regexp-alist' for a description of the format.")
1000
1001 (defconst sml-pp-functions
1002 (sml-prog-proc-make :name "SML"
1003 :run (lambda () (call-interactively #'sml-run))
1004 :load-cmd (lambda (file) (format sml-use-command file))
1005 :chdir-cmd (lambda (dir) (format sml-cd-command dir))
1006 :compile-commands-alist sml-compile-commands-alist
1007 :command-eol ";\n"
1008 ))
1009
1010 ;; font-lock support
1011 (defconst inferior-sml-font-lock-keywords
1012 `(;; prompt and following interactive command
1013 ;; FIXME: Actually, this should already be taken care of by comint.
1014 (,(concat "\\(" sml-prompt-regexp "\\)\\(.*\\)")
1015 (1 font-lock-prompt-face)
1016 (2 font-lock-command-face keep))
1017 ;; CM's messages
1018 ("^\\[\\(.*GC #.*\n\\)*.*\\]" . font-lock-comment-face)
1019 ;; SML/NJ's irritating GC messages
1020 ("^GC #.*" . font-lock-comment-face))
1021 "Font-locking specification for inferior SML mode.")
1022
1023 (defface font-lock-prompt-face
1024 '((t (:bold t)))
1025 "Font Lock mode face used to highlight prompts."
1026 :group 'font-lock-highlighting-faces)
1027 (defvar font-lock-prompt-face 'font-lock-prompt-face
1028 "Face name to use for prompts.")
1029
1030 (defface font-lock-command-face
1031 '((t (:bold t)))
1032 "Font Lock mode face used to highlight interactive commands."
1033 :group 'font-lock-highlighting-faces)
1034 (defvar font-lock-command-face 'font-lock-command-face
1035 "Face name to use for interactive commands.")
1036
1037 (defconst inferior-sml-font-lock-defaults
1038 '(inferior-sml-font-lock-keywords nil nil nil nil))
1039
1040 (defun sml--read-run-cmd ()
1041 (list
1042 (read-string "SML command: " sml-program-name)
1043 (if (or current-prefix-arg (> (length sml-default-arg) 0))
1044 (read-string "Any args: " sml-default-arg)
1045 sml-default-arg)
1046 (if (or current-prefix-arg (> (length sml-host-name) 0))
1047 (read-string "On host: " sml-host-name)
1048 sml-host-name)))
1049
1050 ;;;###autoload
1051 (defalias 'run-sml 'sml-run)
1052
1053 ;;;###autoload
1054 (defun sml-run (cmd arg &optional host)
1055 "Run the program CMD with given arguments ARG.
1056 The command is run in buffer *CMD* using mode `inferior-sml-mode'.
1057 If the buffer already exists and has a running process, then
1058 just go to this buffer.
1059
1060 If a prefix argument is used, the user is also prompted for a HOST
1061 on which to run CMD using `remote-shell-program'.
1062
1063 \(Type \\[describe-mode] in the process's buffer for a list of commands.)"
1064 (interactive (sml--read-run-cmd))
1065 (let* ((pname (file-name-nondirectory cmd))
1066 (args (split-string arg))
1067 (file (when (and sml-config-file (file-exists-p sml-config-file))
1068 sml-config-file)))
1069 ;; And this -- to keep these as defaults even if
1070 ;; they're set in the mode hooks.
1071 (setq sml-program-name cmd)
1072 (setq sml-default-arg arg)
1073 (setq sml-host-name host)
1074 ;; For remote execution, use `remote-shell-program'
1075 (when (> (length host) 0)
1076 (setq args (list* host "cd" default-directory ";" cmd args))
1077 (setq cmd remote-shell-program))
1078 ;; Go for it.
1079 (save-current-buffer
1080 (let ((exec-path (if (and (file-name-directory cmd)
1081 (not (file-name-absolute-p cmd)))
1082 ;; If the command has slashes, make sure we
1083 ;; first look relative to the current directory.
1084 ;; Emacs-21 does it for us, but not Emacs-20.
1085 (cons default-directory exec-path) exec-path)))
1086 (pop-to-buffer (apply 'make-comint pname cmd file args)))
1087
1088 (inferior-sml-mode)
1089 (goto-char (point-max))
1090 (current-buffer))))
1091
1092 (defun sml-send-function (&optional and-go)
1093 "Send current paragraph to the inferior SML process.
1094 With a prefix argument AND-GO switch to the repl buffer as well."
1095 (interactive "P")
1096 (save-excursion
1097 (sml-mark-function)
1098 (sml-prog-proc-send-region (point) (mark)))
1099 (if and-go (sml-prog-proc-switch-to)))
1100
1101 (defvar inferior-sml-mode-map
1102 (let ((map (make-sparse-keymap)))
1103 (set-keymap-parent map comint-mode-map)
1104 (define-key map "\C-c\C-s" 'sml-run)
1105 (define-key map "\t" 'completion-at-point)
1106 map)
1107 "Keymap for inferior-sml mode.")
1108
1109
1110 (declare-function smerge-refine-subst "smerge-mode"
1111 (beg1 end1 beg2 end2 props-c))
1112
1113 (defun inferior-sml-next-error-hook ()
1114 ;; Try to recognize SML/NJ type error message and to highlight finely the
1115 ;; difference between the two types (in case they're large, it's not
1116 ;; always obvious to spot it).
1117 ;;
1118 ;; Sample messages:
1119 ;;
1120 ;; Data.sml:31.9-33.33 Error: right-hand-side of clause doesn't agree with function result type [tycon mismatch]
1121 ;; expression: Hstring
1122 ;; result type: Hstring * int
1123 ;; in declaration:
1124 ;; des2hs = (fn SYM_ID hs => hs
1125 ;; | SYM_OP hs => hs
1126 ;; | SYM_CHR hs => hs)
1127 ;; Data.sml:35.44-35.63 Error: operator and operand don't agree [tycon mismatch]
1128 ;; operator domain: Hstring * Hstring
1129 ;; operand: (Hstring * int) * (Hstring * int)
1130 ;; in expression:
1131 ;; HSTRING.ieq (h1,h2)
1132 ;; vparse.sml:1861.6-1922.14 Error: case object and rules don't agree [tycon mismatch]
1133 ;; rule domain: STConstraints list list option
1134 ;; object: STConstraints list option
1135 ;; in expression:
1136 (save-current-buffer
1137 (when (and (derived-mode-p 'sml-mode 'inferior-sml-mode)
1138 (boundp 'next-error-last-buffer)
1139 (bufferp next-error-last-buffer)
1140 (set-buffer next-error-last-buffer)
1141 (derived-mode-p 'inferior-sml-mode)
1142 ;; The position of `point' is not guaranteed :-(
1143 (looking-at (concat ".*\\[tycon mismatch\\]\n"
1144 " \\(operator domain\\|expression\\|rule domain\\): +")))
1145 (require 'smerge-mode)
1146 (save-excursion
1147 (let ((b1 (match-end 0))
1148 e1 b2 e2)
1149 (when (re-search-forward "\n in \\(expression\\|declaration\\):\n"
1150 nil t)
1151 (setq e2 (match-beginning 0))
1152 (when (re-search-backward
1153 "\n \\(operand\\|result type\\|object\\): +"
1154 b1 t)
1155 (setq e1 (match-beginning 0))
1156 (setq b2 (match-end 0))
1157 (smerge-refine-subst b1 e1 b2 e2
1158 '((face . smerge-refined-change))))))))))
1159
1160 (define-derived-mode inferior-sml-mode sml-prog-proc-comint-mode "Inferior-SML"
1161 "Major mode for interacting with an inferior SML process.
1162
1163 The following commands are available:
1164 \\{inferior-sml-mode-map}
1165
1166 An SML process can be fired up (again) with \\[sml].
1167
1168 Customisation: Entry to this mode runs the hooks on `comint-mode-hook'
1169 and `inferior-sml-mode-hook' (in that order).
1170
1171 Variables controlling behaviour of this mode are
1172
1173 `sml-program-name' (default \"sml\")
1174 Program to run as SML.
1175
1176 `sml-use-command' (default \"use \\\"%s\\\"\")
1177 Template for loading a file into the inferior SML process.
1178
1179 `sml-cd-command' (default \"System.Directory.cd \\\"%s\\\"\")
1180 SML command for changing directories in SML process (if possible).
1181
1182 `sml-prompt-regexp' (default \"^[\\-=] *\")
1183 Regexp used to recognise prompts in the inferior SML process.
1184
1185 You can send text to the inferior SML process from other buffers containing
1186 SML source.
1187 `switch-to-sml' switches the current buffer to the SML process buffer.
1188 `sml-send-function' sends the current *paragraph* to the SML process.
1189 `sml-send-region' sends the current region to the SML process.
1190
1191 Prefixing the sml-send-<whatever> commands with \\[universal-argument]
1192 causes a switch to the SML process buffer after sending the text.
1193
1194 For information on running multiple processes in multiple buffers, see
1195 documentation for variable `sml-buffer'.
1196
1197 Commands:
1198 RET after the end of the process' output sends the text from the
1199 end of process to point.
1200 RET before the end of the process' output copies the current line
1201 to the end of the process' output, and sends it.
1202 DEL converts tabs to spaces as it moves back.
1203 TAB file name completion, as in shell-mode, etc.."
1204 (setq comint-prompt-regexp sml-prompt-regexp)
1205 (sml-mode-variables)
1206
1207 ;; We have to install it globally, 'cause it's run in the *source* buffer :-(
1208 (add-hook 'next-error-hook 'inferior-sml-next-error-hook)
1209
1210 ;; Make TAB add a " rather than a space at the end of a file name.
1211 (set (make-local-variable 'comint-completion-addsuffix) '("/" . "\""))
1212
1213 (set (make-local-variable 'font-lock-defaults)
1214 inferior-sml-font-lock-defaults)
1215
1216 ;; Compilation support (used for `next-error').
1217 (set (make-local-variable 'compilation-error-regexp-alist)
1218 sml-error-regexp-alist)
1219 ;; FIXME: move it to sml-mode?
1220 (set (make-local-variable 'compilation-error-screen-columns) nil)
1221
1222 (setq mode-line-process '(": %s")))
1223
1224 ;;; MORE CODE FOR SML-MODE
1225
1226 ;;;###autoload
1227 (add-to-list 'auto-mode-alist '("\\.s\\(ml\\|ig\\)\\'" . sml-mode))
1228
1229 (defvar comment-quote-nested)
1230
1231 ;;;###autoload
1232 (define-derived-mode sml-mode sml-prog-proc-mode "SML"
1233 "\\<sml-mode-map>Major mode for editing Standard ML code.
1234 This mode runs `sml-mode-hook' just before exiting.
1235 See also (info \"(sml-mode)Top\").
1236 \\{sml-mode-map}"
1237 (set (make-local-variable 'font-lock-defaults) sml-font-lock-defaults)
1238 (set (make-local-variable 'outline-regexp) sml-outline-regexp)
1239 (set (make-local-variable 'imenu-create-index-function)
1240 'sml-imenu-create-index)
1241 (set (make-local-variable 'add-log-current-defun-function)
1242 'sml-current-fun-name)
1243 ;; Treat paragraph-separators in comments as paragraph-separators.
1244 (set (make-local-variable 'paragraph-separate)
1245 (concat "\\([ \t]*\\*)?\\)?\\(" paragraph-separate "\\)"))
1246 (set (make-local-variable 'require-final-newline) t)
1247 (set (make-local-variable 'electric-indent-chars)
1248 (cons ?\; (if (boundp 'electric-indent-chars)
1249 electric-indent-chars '(?\n))))
1250 (set (make-local-variable 'electric-layout-rules)
1251 `((?\; . ,(lambda ()
1252 (save-excursion
1253 (skip-chars-backward " \t;")
1254 (unless (or (bolp)
1255 (progn (skip-chars-forward " \t;")
1256 (eolp)))
1257 'after))))))
1258 (when sml-electric-pipe-mode
1259 (add-hook 'post-self-insert-hook #'sml-post-self-insert-pipe nil t))
1260 (sml-mode-variables))
1261
1262 (defun sml-mode-variables ()
1263 (set (make-local-variable 'sml-prog-proc-descriptor) sml-pp-functions)
1264 (set-syntax-table sml-mode-syntax-table)
1265 (setq local-abbrev-table sml-mode-abbrev-table)
1266 ;; Setup indentation and sexp-navigation.
1267 (smie-setup sml-smie-grammar #'sml-smie-rules
1268 :backward-token #'sml-smie-backward-token
1269 :forward-token #'sml-smie-forward-token)
1270 (set (make-local-variable 'parse-sexp-ignore-comments) t)
1271 (set (make-local-variable 'comment-start) "(* ")
1272 (set (make-local-variable 'comment-end) " *)")
1273 (set (make-local-variable 'comment-start-skip) "(\\*+\\s-*")
1274 (set (make-local-variable 'comment-end-skip) "\\s-*\\*+)")
1275 ;; No need to quote nested comments markers.
1276 (set (make-local-variable 'comment-quote-nested) nil))
1277
1278 (defun sml-funname-of-and ()
1279 "Name of the function this `and' defines, or nil if not a function.
1280 Point has to be right after the `and' symbol and is not preserved."
1281 (forward-comment (point-max))
1282 (if (looking-at sml-tyvarseq-re) (goto-char (match-end 0)))
1283 (let ((sym (sml-smie-forward-token)))
1284 (forward-comment (point-max))
1285 (unless (or (member sym '(nil "d="))
1286 (member (sml-smie-forward-token) '("d=")))
1287 sym)))
1288
1289 (defun sml-find-forward (re)
1290 (while (progn (forward-comment (point-max))
1291 (not (looking-at re)))
1292 (or (ignore-errors (forward-sexp 1) t) (forward-char 1))))
1293
1294 (defun sml-electric-pipe ()
1295 "Insert a \"|\".
1296 Depending on the context insert the name of function, a \"=>\" etc."
1297 (interactive)
1298 (unless (save-excursion (skip-chars-backward "\t ") (bolp)) (insert "\n"))
1299 (insert "| ")
1300 (unless (sml-post-self-insert-pipe (1- (point)))
1301 (indent-according-to-mode)))
1302
1303 (defun sml-post-self-insert-pipe (&optional acp)
1304 (when (or acp (and (eq ?| last-command-event)
1305 (setq acp (electric--after-char-pos))))
1306 (let ((text
1307 (save-excursion
1308 (goto-char (1- acp)) ;Jump before the "|" we just inserted.
1309 (let ((sym (sml-find-matching-starter sml-pipeheads
1310 ;; (sml-op-prec "|" 'back)
1311 )))
1312 (sml-smie-forward-token)
1313 (forward-comment (point-max))
1314 (cond
1315 ((string= sym "|")
1316 (let ((f (sml-smie-forward-token)))
1317 (sml-find-forward "\\(=>\\|=\\||\\)\\S.")
1318 (cond
1319 ((looking-at "|") nil) ; A datatype or an OR pattern?
1320 ((looking-at "=>") " => ") ;`case', or `fn' or `handle'.
1321 ((looking-at "=") ;A function.
1322 (cons (concat f " ")" = ")))))
1323 ((string= sym "and")
1324 ;; Could be a datatype or a function.
1325 (let ((funname (sml-funname-of-and)))
1326 (if funname (cons (concat funname " ") " = ") nil)))
1327 ((string= sym "fun")
1328 (while (and (setq sym (sml-smie-forward-token))
1329 (string-match "^'" sym))
1330 (forward-comment (point-max)))
1331 (cons (concat sym " ") " = "))
1332 ((member sym '("case" "handle" "of")) " => ") ;; "fn"?
1333 ;;((member sym '("abstype" "datatype")) "")
1334 (t nil))))))
1335 (when text
1336 (save-excursion
1337 (goto-char (1- acp))
1338 (unless (save-excursion (skip-chars-backward "\t ") (bolp))
1339 (insert "\n")))
1340 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
1341 (let ((use-region (and (use-region-p) (< (point) (mark)))))
1342 ;; (skeleton-proxy-new `(nil ,(if (consp text) (pop text)) _ ,text))
1343 (when (consp text) (insert (pop text)))
1344 (if (not use-region)
1345 (save-excursion (insert text))
1346 (goto-char (mark))
1347 (insert text)))
1348 (indent-according-to-mode)
1349 t))))
1350
1351
1352 ;;; Misc
1353
1354 (defun sml-mark-function ()
1355 "Mark the surrounding function. Or try to at least."
1356 (interactive)
1357 ;; FIXME: Provide beginning-of-defun-function so mark-defun "just works".
1358 (let ((start (point)))
1359 (sml-beginning-of-defun)
1360 (let ((beg (point)))
1361 (smie-forward-sexp 'halfsexp)
1362 (if (or (< start beg) (> start (point)))
1363 (progn
1364 (goto-char start)
1365 (mark-paragraph))
1366 (push-mark nil t t)
1367 (goto-char beg)))))
1368
1369 (defun sml-back-to-outer-indent ()
1370 "Unindents to the next outer level of indentation."
1371 (interactive)
1372 (save-excursion
1373 (forward-line 0)
1374 (let ((start-column (current-indentation))
1375 indent)
1376 (when (> start-column 0)
1377 (save-excursion
1378 (while (>= (setq indent
1379 (if (re-search-backward "^[ \t]*[^\n\t]" nil t)
1380 (current-indentation)
1381 0))
1382 start-column))
1383 (skip-chars-forward " \t")
1384 (let ((pos (point)))
1385 (move-to-column start-column)
1386 (when (re-search-backward " \\([^ \t\n]\\)" pos t)
1387 (goto-char (match-beginning 1))
1388 (setq indent (current-column)))))
1389 (indent-line-to indent)))))
1390
1391 (defun sml-find-matching-starter (syms)
1392 (let ((halfsexp nil)
1393 tok)
1394 ;;(sml-smie-forward-token)
1395 (while (not (or (bobp)
1396 (member (nth 2 (setq tok (smie-backward-sexp halfsexp)))
1397 syms)))
1398 (cond
1399 ((null (car tok)) nil)
1400 ((numberp (car tok)) (setq halfsexp 'half))
1401 (t (goto-char (cadr tok)))))
1402 (if (nth 2 tok) (goto-char (cadr tok)))
1403 (nth 2 tok)))
1404
1405 (defun sml-skip-siblings ()
1406 (let (tok)
1407 (while (and (not (bobp))
1408 (progn (setq tok (smie-backward-sexp 'half))
1409 (cond
1410 ((null (car tok)) t)
1411 ((numberp (car tok)) t)
1412 (t nil)))))
1413 (if (nth 2 tok) (goto-char (cadr tok)))
1414 (nth 2 tok)))
1415
1416 (defun sml-beginning-of-defun ()
1417 (let ((sym (sml-find-matching-starter sml-starters-syms)))
1418 (if (member sym '("fun" "and" "functor" "signature" "structure"
1419 "abstraction" "datatype" "abstype"))
1420 (save-excursion (sml-smie-forward-token) (forward-comment (point-max))
1421 (sml-smie-forward-token))
1422 ;; We're inside a "non function declaration": let's skip all other
1423 ;; declarations that we find at the same level and try again.
1424 (sml-skip-siblings)
1425 ;; Obviously, let's not try again if we're at bobp.
1426 (unless (bobp) (sml-beginning-of-defun)))))
1427
1428 (defcustom sml-max-name-components 3
1429 "Maximum number of components to use for the current function name."
1430 :type 'integer)
1431
1432 (defun sml-current-fun-name ()
1433 (save-excursion
1434 (let ((count sml-max-name-components)
1435 fullname name)
1436 (end-of-line)
1437 (while (and (> count 0)
1438 (setq name (sml-beginning-of-defun)))
1439 (decf count)
1440 (setq fullname (if fullname (concat name "." fullname) name))
1441 ;; Skip all other declarations that we find at the same level.
1442 (sml-skip-siblings))
1443 fullname)))
1444
1445
1446 ;;; INSERTING PROFORMAS (COMMON SML-FORMS)
1447
1448 (defvar sml-forms-alist nil
1449 "Alist of code templates.
1450 You can extend this alist to your heart's content. For each additional
1451 template NAME in the list, declare a keyboard macro or function (or
1452 interactive command) called 'sml-form-NAME'.
1453 If 'sml-form-NAME' is a function it takes no arguments and should
1454 insert the template at point\; if this is a command it may accept any
1455 sensible interactive call arguments\; keyboard macros can't take
1456 arguments at all.
1457 `sml-forms-alist' understands let, local, case, abstype, datatype,
1458 signature, structure, and functor by default.")
1459
1460 (defmacro sml-def-skeleton (name interactor &rest elements)
1461 (let ((fsym (intern (concat "sml-form-" name))))
1462 `(progn
1463 (add-to-list 'sml-forms-alist ',(cons name fsym))
1464 (define-abbrev sml-mode-abbrev-table ,name "" ',fsym nil 'system)
1465 (let ((abbrev (abbrev-symbol ,name sml-mode-abbrev-table)))
1466 (abbrev-put abbrev :case-fixed t)
1467 (abbrev-put abbrev :enable-function
1468 (lambda () (not (nth 8 (syntax-ppss))))))
1469 (define-skeleton ,fsym
1470 ,(format "SML-mode skeleton for `%s..' expressions" name)
1471 ,interactor
1472 ,(concat name " ") >
1473 ,@elements))))
1474 (put 'sml-def-skeleton 'lisp-indent-function 2)
1475
1476 (sml-def-skeleton "let" nil
1477 @ "\nin " > _ "\nend" >)
1478
1479 (sml-def-skeleton "if" nil
1480 @ " then " > _ "\nelse " > _)
1481
1482 (sml-def-skeleton "local" nil
1483 @ "\nin" > _ "\nend" >)
1484
1485 (sml-def-skeleton "case" "Case expr: "
1486 str "\nof " > _ " => ")
1487
1488 (sml-def-skeleton "signature" "Signature name: "
1489 str " =\nsig" > "\n" > _ "\nend" >)
1490
1491 (sml-def-skeleton "structure" "Structure name: "
1492 str " =\nstruct" > "\n" > _ "\nend" >)
1493
1494 (sml-def-skeleton "functor" "Functor name: "
1495 str " () : =\nstruct" > "\n" > _ "\nend" >)
1496
1497 (sml-def-skeleton "datatype" "Datatype name and type params: "
1498 str " =" \n)
1499
1500 (sml-def-skeleton "abstype" "Abstype name and type params: "
1501 str " =" \n _ "\nwith" > "\nend" >)
1502
1503 ;;
1504
1505 (sml-def-skeleton "struct" nil
1506 _ "\nend" >)
1507
1508 (sml-def-skeleton "sig" nil
1509 _ "\nend" >)
1510
1511 (sml-def-skeleton "val" nil
1512 @ " = " > _)
1513
1514 (sml-def-skeleton "fn" nil
1515 @ " =>" > _)
1516
1517 (sml-def-skeleton "fun" nil
1518 @ " =" > _)
1519
1520 ;;
1521
1522 (defun sml-forms-menu (_menu)
1523 (mapcar (lambda (x) (vector (car x) (cdr x) t))
1524 sml-forms-alist))
1525
1526 (defvar sml-last-form "let")
1527
1528 (defun sml-electric-space ()
1529 "Expand a symbol into an SML form, or just insert a space.
1530 If the point directly precedes a symbol for which an SML form exists,
1531 the corresponding form is inserted."
1532 (interactive)
1533 (let ((abbrev-mode (not abbrev-mode))
1534 (last-command-event ?\s)
1535 ;; Bind `this-command' to fool skeleton's special abbrev handling.
1536 (this-command 'self-insert-command))
1537 (call-interactively 'self-insert-command)))
1538
1539 (defun sml-insert-form (name newline)
1540 "Interactive short-cut to insert the NAME common SML form.
1541 If a prefix argument is given insert a NEWLINE and indent first, or
1542 just move to the proper indentation if the line is blank\; otherwise
1543 insert at point (which forces indentation to current column).
1544
1545 The default form to insert is 'whatever you inserted last time'
1546 \(just hit return when prompted\)\; otherwise the command reads with
1547 completion from `sml-forms-alist'."
1548 (interactive
1549 (list (completing-read
1550 (format "Form to insert (default %s): " sml-last-form)
1551 sml-forms-alist nil t nil nil sml-forms-alist)
1552 current-prefix-arg))
1553 (setq sml-last-form name)
1554 (unless (or (not newline)
1555 (save-excursion (beginning-of-line) (looking-at "\\s-*$")))
1556 (insert "\n"))
1557 (when (memq (char-syntax (preceding-char)) '(?_ ?w)) (insert " "))
1558 (let ((f (cdr (assoc name sml-forms-alist))))
1559 (cond
1560 ((commandp f) (command-execute f))
1561 (f (funcall f))
1562 (t (error "Undefined SML form: %s" name)))))
1563
1564 ;;;
1565 ;;; MLton support
1566 ;;;
1567
1568 (defvar sml-mlton-command "mlton"
1569 "Command to run MLton. Can include arguments.")
1570
1571 (defvar sml-mlton-mainfile nil)
1572
1573 (defconst sml-mlton-error-regexp-alist
1574 ;; I wish they just changed MLton to use one of the standard
1575 ;; error formats.
1576 `(("^\\(?:Error\\|\\(Warning\\)\\): \\(.+\\) \\([0-9]+\\)\\.\\([0-9]+\\)\\.$"
1577 2 3 4
1578 ;; If subgroup 1 matched, then it's a warning, otherwise it's an error.
1579 (1))))
1580
1581 (defvar compilation-error-regexp-alist)
1582 (eval-after-load "compile"
1583 '(dolist (x sml-mlton-error-regexp-alist)
1584 (add-to-list 'compilation-error-regexp-alist x)))
1585
1586 (defun sml-mlton-typecheck (mainfile)
1587 "Typecheck using MLton.
1588 MAINFILE is the top level file of the project."
1589 (interactive
1590 (list (if (and sml-mlton-mainfile (not current-prefix-arg))
1591 sml-mlton-mainfile
1592 (read-file-name "Main file: "))))
1593 (setq sml-mlton-mainfile mainfile)
1594 (save-some-buffers)
1595 (require 'compile)
1596 (dolist (x sml-mlton-error-regexp-alist)
1597 (add-to-list 'compilation-error-regexp-alist x))
1598 (with-current-buffer (find-file-noselect mainfile)
1599 (compile (concat sml-mlton-command
1600 " -stop tc " ;Stop right after type checking.
1601 (shell-quote-argument
1602 (file-relative-name buffer-file-name))))))
1603
1604 ;;;
1605 ;;; MLton's def-use info.
1606 ;;;
1607
1608 (defvar sml-defuse-file nil)
1609
1610 (defun sml-defuse-file ()
1611 (or sml-defuse-file (sml-defuse-set-file)))
1612
1613 (defun sml-defuse-set-file ()
1614 "Specify the def-use file to use."
1615 (interactive)
1616 (setq sml-defuse-file (read-file-name "Def-use file: ")))
1617
1618 (defun sml-defuse-symdata-at-point ()
1619 (save-excursion
1620 (sml-smie-forward-token)
1621 (let ((symname (sml-smie-backward-token)))
1622 (if (equal symname "op")
1623 (save-excursion (setq symname (sml-smie-forward-token))))
1624 (when (string-match "op " symname)
1625 (setq symname (substring symname (match-end 0)))
1626 (forward-word)
1627 (forward-comment (point-max)))
1628 (list symname
1629 ;; Def-use files seem to count chars, not columns.
1630 ;; We hope here that they don't actually count bytes.
1631 ;; Also they seem to start counting at 1.
1632 (1+ (- (point) (progn (beginning-of-line) (point))))
1633 (save-restriction
1634 (widen) (1+ (count-lines (point-min) (point))))
1635 buffer-file-name))))
1636
1637 (defconst sml-defuse-def-regexp
1638 "^[[:alpha:]]+ \\([^ \n]+\\) \\(.+\\) \\([0-9]+\\)\\.\\([0-9]+\\)$")
1639 (defconst sml-defuse-use-regexp-format "^ %s %d\\.%d $")
1640
1641 (defun sml-defuse-jump-to-def ()
1642 "Jump to the definition corresponding to the symbol at point."
1643 (interactive)
1644 (let ((symdata (sml-defuse-symdata-at-point)))
1645 (if (null (car symdata))
1646 (error "Not on a symbol")
1647 (with-current-buffer (find-file-noselect (sml-defuse-file))
1648 (goto-char (point-min))
1649 (unless (re-search-forward
1650 (format sml-defuse-use-regexp-format
1651 (concat "\\(?:"
1652 ;; May be an absolute file name.
1653 (regexp-quote (nth 3 symdata))
1654 "\\|"
1655 ;; Or a relative file name.
1656 (regexp-quote (file-relative-name
1657 (nth 3 symdata)))
1658 "\\)")
1659 (nth 2 symdata)
1660 (nth 1 symdata))
1661 nil t)
1662 ;; FIXME: This is typically due to editing: any minor editing will
1663 ;; mess everything up. We should try to fail more gracefully.
1664 (error "Def-use info not found"))
1665 (unless (re-search-backward sml-defuse-def-regexp nil t)
1666 ;; This indicates a bug in this code.
1667 (error "Internal failure while looking up def-use"))
1668 (unless (equal (match-string 1) (nth 0 symdata))
1669 ;; FIXME: This again is most likely due to editing.
1670 (error "Incoherence in the def-use info found"))
1671 (let ((line (string-to-number (match-string 3)))
1672 (char (string-to-number (match-string 4))))
1673 (pop-to-buffer (find-file-noselect (match-string 2)))
1674 (goto-char (point-min))
1675 (forward-line (1- line))
1676 (forward-char (1- char)))))))
1677
1678 ;;;
1679 ;;; SML/NJ's Compilation Manager support
1680 ;;;
1681
1682 (defvar sml-cm-mode-syntax-table sml-mode-syntax-table)
1683 (defvar sml-cm-font-lock-keywords
1684 `(,(concat "\\_<" (regexp-opt '("library" "group" "is" "structure"
1685 "functor" "signature" "funsig") t)
1686 "\\_>")))
1687 ;;;###autoload
1688 (add-to-list 'completion-ignored-extensions ".cm/")
1689 ;; This was used with the old compilation manager.
1690 (add-to-list 'completion-ignored-extensions "CM/")
1691 ;;;###autoload
1692 (add-to-list 'auto-mode-alist '("\\.cm\\'" . sml-cm-mode))
1693 ;;;###autoload
1694 (define-derived-mode sml-cm-mode fundamental-mode "SML-CM"
1695 "Major mode for SML/NJ's Compilation Manager configuration files."
1696 (set (make-local-variable 'sml-prog-proc-descriptor) sml-pp-functions)
1697 (set (make-local-variable 'font-lock-defaults)
1698 '(sml-cm-font-lock-keywords nil t nil nil)))
1699
1700 ;;;
1701 ;;; ML-Lex support
1702 ;;;
1703
1704 (defvar sml-lex-font-lock-keywords
1705 (append
1706 `((,(concat "^%" sml-id-re) . font-lock-builtin-face)
1707 ("^%%" . font-lock-module-def-face))
1708 sml-font-lock-keywords))
1709 (defconst sml-lex-font-lock-defaults
1710 (cons 'sml-lex-font-lock-keywords (cdr sml-font-lock-defaults)))
1711
1712 ;;;###autoload
1713 (define-derived-mode sml-lex-mode sml-mode "SML-Lex"
1714 "Major Mode for editing ML-Lex files."
1715 (set (make-local-variable 'font-lock-defaults) sml-lex-font-lock-defaults))
1716
1717 ;;;
1718 ;;; ML-Yacc support
1719 ;;;
1720
1721 (defface sml-yacc-bnf-face
1722 '((t (:foreground "darkgreen")))
1723 "Face used to highlight (non)terminals in `sml-yacc-mode'.")
1724 (defvar sml-yacc-bnf-face 'sml-yacc-bnf-face)
1725
1726 (defcustom sml-yacc-indent-action 16
1727 "Indentation column of the opening paren of actions."
1728 :type 'integer)
1729
1730 (defcustom sml-yacc-indent-pipe nil
1731 "Indentation column of the pipe char in the BNF.
1732 If nil, align it with `:' or with previous cases."
1733 :type 'integer)
1734
1735 (defcustom sml-yacc-indent-term nil
1736 "Indentation column of the (non)term part.
1737 If nil, align it with previous cases."
1738 :type 'integer)
1739
1740 (defvar sml-yacc-font-lock-keywords
1741 (cons `((concat "^\\(" sml-id-re "\\s-*:\\|\\s-*|\\)\\(\\s-*" sml-id-re
1742 "\\)*\\s-*\\(\\(%" sml-id-re "\\)\\s-+" sml-id-re "\\|\\)")
1743 (0 (save-excursion
1744 (save-match-data
1745 (goto-char (match-beginning 0))
1746 (unless (or (re-search-forward "\\_<of\\_>"
1747 (match-end 0) 'move)
1748 (progn (forward-comment (point-max))
1749 (not (looking-at "("))))
1750 sml-yacc-bnf-face))))
1751 (4 font-lock-builtin-face t t))
1752 sml-lex-font-lock-keywords))
1753 (defconst sml-yacc-font-lock-defaults
1754 (cons 'sml-yacc-font-lock-keywords (cdr sml-font-lock-defaults)))
1755
1756 (defun sml-yacc-indent-line ()
1757 "Indent current line of ML-Yacc code."
1758 (let ((savep (> (current-column) (current-indentation)))
1759 (indent (max (or (ignore-errors (sml-yacc-indentation)) 0) 0)))
1760 (if savep
1761 (save-excursion (indent-line-to indent))
1762 (indent-line-to indent))))
1763
1764 (defun sml-yacc-indentation ()
1765 (save-excursion
1766 (back-to-indentation)
1767 (or (and (looking-at (eval-when-compile
1768 (concat "%\\|" sml-id-re "\\s-*:")))
1769 0)
1770 (when (save-excursion
1771 (condition-case nil (progn (up-list -1) nil) (scan-error t)))
1772 ;; We're outside an action.
1773 (cond
1774 ;; Special handling of indentation inside %term and %nonterm
1775 ((save-excursion
1776 (and (re-search-backward "^%\\(\\sw+\\)" nil t)
1777 (member (match-string 1) '("term" "nonterm"))))
1778 (if (numberp sml-yacc-indent-term) sml-yacc-indent-term
1779 (let ((offset (if (looking-at "|") -2 0)))
1780 (forward-line -1)
1781 (looking-at "\\s-*\\(%\\sw*\\||\\)?\\s-*")
1782 (goto-char (match-end 0))
1783 (+ offset (current-column)))))
1784 ((looking-at "(") sml-yacc-indent-action)
1785 ((looking-at "|")
1786 (if (numberp sml-yacc-indent-pipe) sml-yacc-indent-pipe
1787 (backward-sexp 1)
1788 (while (progn (forward-comment (- (point)))
1789 (/= 0 (skip-syntax-backward "w_"))))
1790 (forward-comment (- (point)))
1791 (if (not (looking-at "\\s-$"))
1792 (1- (current-column))
1793 (skip-syntax-forward " ")
1794 (- (current-column) 2))))))
1795 ;; default to SML rules
1796 (smie-indent-calculate))))
1797
1798 ;;;###autoload
1799 (add-to-list 'auto-mode-alist '("\\.grm\\'" . sml-yacc-mode))
1800 ;;;###autoload
1801 (define-derived-mode sml-yacc-mode sml-mode "SML-Yacc"
1802 "Major Mode for editing ML-Yacc files."
1803 (set (make-local-variable 'indent-line-function) 'sml-yacc-indent-line)
1804 (set (make-local-variable 'font-lock-defaults) sml-yacc-font-lock-defaults))
1805
1806 \f
1807 (provide 'sml-mode)
1808
1809 ;;; sml-mode.el ends here