flycheck-ats2.el

;;; flycheck-ats2.el --- Flycheck: ATS2 support      -*- lexical-binding: t; -*-

;; Copyright (C) 2015  Mark Laws <mdl@60hz.org>

;; Author: Mark Laws <mdl@60hz.org>
;; URL: http://github.com/drvink/flycheck-ats2
;; Keywords: convenience, tools, languages
;; Version: 1.0
;; Package-Requires: ((emacs "24.1") (flycheck "0.22"))

;; This file is not part of GNU Emacs.

;; Permission is hereby granted, free of charge, to any person obtaining a copy
;; of this software and associated documentation files (the "Software"), to deal
;; in the Software without restriction, including without limitation the rights
;; to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
;; copies of the Software, and to permit persons to whom the Software is
;; furnished to do so, subject to the following conditions:
;;
;; The above copyright notice and this permission notice shall be included in
;; all copies or substantial portions of the Software.
;;
;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
;; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
;; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
;; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
;; OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
;; SOFTWARE.

;;; Commentary:

;; This Flycheck extension provides an `ats2' syntax checker.
;;
;; # Setup
;;
;; Add the following to your init file:
;;
;; (with-eval-after-load 'flycheck
;;   (flycheck-ats2-setup))
;;
;; The ATSHOME environment variable may need to be set from within Emacs:
;;
;; (setenv "ATSHOME" "/path/to/ats2")
;;
;; If you use PATSHOME instead of ATSHOME, please set PATSHOME as follows:
;;
;; (setenv "PATSHOME" "/path/to/ats2")

;;; Code:

(require 'flycheck)

(defun flycheck-ats2-rx-level (level)
  "Return a flycheck-rx form for an ATS-Postiats error message with LEVEL."
  ;; This will catch all single-line messages:
  ;;
  ;; filename: 3120(line=151, offs=1) -- 3124(line=151, offs=5): error(3): the applied dynamic expression is of non-function type: S2Ecst(bool_t0ype)
  ;; filename: 3120(line=151, offs=1) -- 3124(line=151, offs=5): error(3): the dynamic expression cannot be assigned the type [S2Ecst(bool_t0ype)].
  ;;
  ;; ...and multi-line messages of the same form that end with a colon, in
  ;; which case we assume there will be two following lines that should be
  ;; grouped with the first line, e.g.:
  ;;
  ;; filename: 3120(line=151, offs=1) -- 3124(line=151, offs=5): error(3): mismatch of static terms (tyleq):
  ;; The actual term is: S2Eerr()
  ;; The needed term is: S2Ecst(bool_t0ype)
  ;;
  ;; See: https://github.com/githwxi/ATS-Postiats/blob/1c0a515f8fb0f757359f7bf096e8a5541683a6ff/src/pats_errmsg.dats

  ;; file name
  `(bol
    (file-name)
    ;; offset of error start
    ":" space (1+ num)
    ;; line, column; start of error span
    "(line=" line "," space "offs=" column ")"
    ;; offset of error end
    space "--" space (1+ num)
    ;; line, column; end of error span
    "(line=" (1+ num) "," space "offs=" (1+ num) "):"
    space ,level "(" (id (one-or-more alnum)) "):"
    ;; error message; up to three lines long
    (message
     (+? not-newline)
     (or (: ?: ?\n (repeat 2 (: (1+ not-newline) ?\n)))
         ?\n))))

(flycheck-define-command-checker 'ats2
  "ATS2 checker using patscc."
  :command '("patscc" "-tcats" source-inplace)
  :error-patterns
  `((error   ,@(flycheck-ats2-rx-level "error"))
    (warning ,@(flycheck-ats2-rx-level "warning")))
  :modes 'ats-mode)

;;;###autoload
(defun flycheck-ats2-setup ()
  "Set up Flycheck ATS2.

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

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