aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/elisp/urweb-flycheck.el
blob: 31433fbcd070ac0ceecea380b9ac27dc098113a2 (plain)
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
;;; urweb-flycheck.el --- Flycheck: Ur/Web support   -*- lexical-binding: t; -*-

;; Copyright (C) 2018 Artyom Shalkhakov <artyom.shalkhakov@gmail.com>

;; Author:
;;   Artyom Shalkhakov <artyom.shalkhakov@gmail.com>
;;   David Christiansen <david@davidchristiansen.dk>
;;
;; Keywords: tools, languages, convenience
;; Version: 0.2
;; Package-Requires: ((emacs "24.1") (flycheck "0.22"))

;; This file is not part of GNU Emacs, but it is distributed under the
;; same conditions.

;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2, or (at
;; your option) any later version.

;; This program is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
;; General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

;;; Commentary:

;; This Flycheck extension provides an 'urweb' syntax checker.
;;
;; # Setup
;;
;; Put the following into your 'init' file:
;;
;; (with-eval-after-load 'flycheck (urweb-flycheck-setup))
;;
;; Ensure that the Ur/Web compiler is in your PATH
;;

;;; Code:

(require 'flycheck)

(defun urweb-get-flycheck-project-file ()
  "Guess the location of the nearest urp file."
   (let ((bn (buffer-file-name)))
     (if bn
         (let
             ((x (file-name-sans-extension bn))
              (y (file-name-directory bn)))
           (cond
            ;; file with .urp extension exists? take it
            ((file-exists-p (concat x ".urp")) x)
            ;; lib.urp exists in this directory? take it
            ((file-exists-p (concat y "/lib.urp")) (concat y "/lib"))
            ;; fall back to the first .urp file in this directory
            ;; or if that fails, use the current file name
            (t (or (car (directory-files y nil "\\.urp$")) x)))))))

(flycheck-define-checker urweb
  "Ur/Web checker"
  :command ("urweb" "-tc"
            (eval (urweb-get-flycheck-project-file)))
  ;; filename:1:0: (to 1:0) syntax error found at SYMBOL
  ;; filename:1:0: (to 1:38) Some constructor unification variables are undetermined in declaration
  ;; (look for them as "<UNIF:...>")
  ;; Decl:
  ;; val rec
  ;;  help :
  ;;   {} -> <UNIF:E::Type -> Type> (xml <UNIF:G::{Unit}> <UNIF:H::{Type}> ([])) =
  ;;   fn $x : {} =>
  ;;    case $x of
  ;;     {} =>
  ;;      return [<UNIF:E::Type -> Type>]
  ;;       [xml <UNIF:G::{Unit}> <UNIF:H::{Type}> ([])] _
  ;;       (Basis.cdata [<UNIF:G::{Unit}>] [<UNIF:H::{Type}>] "Hello!")

  :error-patterns
  ((error line-start (file-name) ":" line ":" column ":"
          " (to " (1+ num) ?: (1+ num) ")"
          ;; AS: indebted to David Christiansen for this rx expression!
          (message (and (* nonl) (* "\n" (not (any "/" "~")) (* nonl))))))
  :predicate
  (lambda ()
    (buffer-file-name))
  :modes (urweb-mode))

;;;###autoload
(defun urweb-flycheck-setup ()
  "Setup Flycheck Ur/Web.

Add `urweb' to `flycheck-checkers'."
  (interactive)
  (add-to-list 'flycheck-checkers 'urweb))

(provide 'urweb-flycheck)
;;; urweb-flycheck.el ends here