mlint.el

;;; mlint.el --- run mlint in a MATLAB buffer -*- lexical-binding: t -*-

;; Author: Eric M. Ludlam <eludlam@mathworks.com>
;; Maintainer: Eric M. Ludlam <eludlam@mathworks.com>
;; Created: June 25, 2002

;; Copyright (C) 2002-2025 Free Software Foundation, Inc.
;;
;; 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 3, 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:
;;
;; Run mlint, and highlight the problems in the buffer.
;;

;;; Code:

(defvar mlint-version "1.3.2"
  "The current version of mlint minor mode.")

(require 'matlab)
(require 'matlab--access)

(require 'eieio-base)
(require 'linemark)

(eval-when-compile
  (require 'font-lock))

(defgroup mlint nil
  "MLint minor mode."
  :prefix "mlint-"
  :group 'matlab)

;; `goto-line' is for interactive use only; use `forward-line' instead.
(defun mlint-goto-line (n)
  "Goto line N for mlint."
  (goto-char (point-min)) (forward-line (1- n)))

(defcustom mlint-calculate-cyclic-complexity-flag nil
  "*Non-nil means to collect cyclic complexity values."
  :group 'mlint
  :type 'boolean)

(defvar mlint-symtab-info nil
  "Symbol Table collected from highlighting cross function variables.
Each entry in the symtab is at an index indicating the line it occurs on.
Each entry is of the form:
  ( \"FUNCTION-NAME\" PARENT-IDX ( LINENO . COLNO ) ...)
and ... is a list of cross-function variable usages.")
(make-variable-buffer-local 'mlint-symtab-info)

(defvar mlint-program nil
  "MLINT executable to use.")

(defvar mlint-program-selection-fcn nil
  "Function to specify the \\=`mlint-program\\=' for the current buffer.
For example,
  (eval-after-load \"mlint\"
   \\='(setq mlint-program-selection-fcn \\='my-function-to-select-mlint-program))
will setup \\=`my-function-to-select-mlint-program\\=' to pick
the mlint for a buffer.  After opening a *.m file,
\\=`my-function-to-select-mlint-program\\=' is called and the
appropriate mlint should be returned. If there's no mlint program
available, nil should be returned and mlint will not be
activated.")

(defcustom mlint-flags '("-all" "-id") ; "-fix") % Need to support this output
  "*List of flags passed to mlint."
  :group 'mlint
  :type '(repeat (string :tag "Option: ")))

(defconst mlint-output-regex
  "^L \\([0-9]+\\) (C \\([-0-9]+\\)): \\(\\w+\\): \\([^\n]+\\)"
  "Regular expression for collecting mlint output.")

(defconst mlint-symtab-line-regex
  ;; serial number        name              parent
  (concat "^ *\\([0-9]+\\) +\\([a-zA-Z0-9_]+\\) +\\([0-9]+\\)"
          ;;   cross-function variable       function-line function-column
          " +\\(V +CH\\(Set\\|Used\\).*\\|F.* \\([0-9]+\\)/\\([0-9]+\\)\\)$")
  "Regular expression for mlint symbol table line.")

(defcustom mlint-verbose nil
  "*Non nil if command `mlint-minor-mode' should display messages while running."
  :group 'mlint
  :type 'boolean)

(defcustom mlint-scan-for-fixes-flag t
  "Non-nil means that we should scan mlint output for things to fix.
Scanning using `mlint-error-fix-alist' can slow things down, and may
be cause for being turned off in a buffer."
  :group 'mlint
  :type 'boolean)
(make-variable-buffer-local 'mlint-scan-for-fixes-flag)

(defvar mlint-error-id-fix-alist
  '(
    ( AND2  . mlint-lm-entry-logicals)
    ( OR2   . mlint-lm-entry-logicals)
    ( INUSD . mlint-lm-entry-unused-argument )
    ( NOPRT . mlint-lm-quiet )
    ( NOSEM . mlint-lm-delete-focus )
    ( NOCOM . mlint-lm-delete-focus )
    ( MSNU  . mlint-lm-delete-focus )
    ( ST2NM . mlint-lm-str2num )
    ( FDEPR . mlint-lm-entry-deprecated )
    ( ENDCT . mlint-lm-missing-end )
    ( ENDCT2 . mlint-lm-missing-end )
    ( FNDEF . mlint-lm-function-name )
    ( MCFIL . mlint-lm-function-name )
    ( MCSCC . mlint-lm-function-name )
    )
  "List of warning IDs and auto-fix functions.
If the CAR of an association matches an error id then the linemark entry
created is of the class in CDR.")

(defun mlint-column-output (string)
  "Convert the mlint column output to a cons pair.
\(COLSTART .  COLEND).
Argument STRING is the text to interpret."
  (save-match-data
    (if (string-match "\\([0-9]+\\)-\\([0-9]+\\)" string)
        (cons (string-to-number (match-string 1 string))
              (string-to-number (match-string 2 string)))
      (let ((i (string-to-number string)))
        (cons i i)))))

(defun mlint-run ()
  "Run mlint on BUFFER and return a list of issues."
  (when (and (file-exists-p (buffer-file-name)) mlint-program)
    (if (not (file-executable-p mlint-program))
        (progn
          (message "Unable to mlint, %s doesn't exist" mlint-program)
          (sit-for 2)
          nil)
      (let* ((fn (file-name-nondirectory (buffer-file-name (current-buffer))))
             (buffer-mlint-program mlint-program)
             (dd default-directory)
             (show-mlint-warnings matlab-show-mlint-warnings)
             (highlight-cross-function-variables
              (and matlab-functions-have-end
                   matlab-highlight-cross-function-variables))
             (flags (let ((tmp (if matlab-show-mlint-warnings mlint-flags nil)))
                      (setq tmp
                            (if highlight-cross-function-variables
                                (cons "-edit" tmp)
                              tmp))
                      (setq tmp
                            (if mlint-calculate-cyclic-complexity-flag
                                (cons "-cyc" tmp)
                              tmp))
                      tmp))
             (errors nil)
             (n nil)
             (symtab nil))
        (with-current-buffer (get-buffer-create "*M-Lint*")
          (erase-buffer)
          (when mlint-verbose (message "Running mlint..."))

          (setq default-directory dd)

          (apply #'call-process buffer-mlint-program nil (current-buffer) nil
                 (append flags (list fn)))

          (when mlint-verbose (message "Running mlint...done"))
          (goto-char (point-min))
          (when highlight-cross-function-variables
            (when (not (re-search-forward mlint-output-regex nil t))
              (goto-char (point-max)))
            (when (re-search-backward "^ *\\([0-9]+\\)" nil t)
              (goto-char (point-min))
              (setq n (1+ (string-to-number (match-string 1))))
              (setq symtab (make-vector n nil))
              (while (re-search-forward mlint-symtab-line-regex nil t)
                (let ((name (match-string 2))
                      (parent-index (string-to-number (match-string 3)))
                      (column (match-string 7)))
                  (if column ;; line defines a function
                      (aset symtab (string-to-number (match-string 1))
                            (list name
                                  (when (/= parent-index 0) parent-index)
                                  (cons (string-to-number (match-string 6))
                                        (string-to-number column))))
                    (let ((parent (cddr (aref symtab parent-index))))
                      (if parent
                          (rplacd parent (cons name (cdr parent))))))))))
          (when show-mlint-warnings
            (while (re-search-forward mlint-output-regex nil t)
              (setq errors (cons
                            (list (string-to-number (match-string 1))
                                  (mlint-column-output (match-string 2))
                                  (match-string 4)
                                  "" ; this was the warning code (level)
                                  (match-string 3)
                                  )
                            errors))))
          )
        (mlint-clear-nested-function-info-overlays)
        (setq mlint-symtab-info symtab)
        (when (and highlight-cross-function-variables (integerp n))
          ;; Then set up new overlays for cross-function variables
          ;; and nested functions.
          (save-excursion
            (while (> n 0)
              (setq n (1- n))
              (let ((entry (aref mlint-symtab-info n)))
                (if entry
                    (let ((where (caddr entry)))
                      (mlint-goto-line (car where))
                      (forward-char (1- (cdr where)))
                      (re-search-backward "function\\b")
                      (setq where (point))
                      (condition-case nil
                          (matlab-forward-sexp)
                        (error (goto-char (point-max))))
                      (if (cadr entry) ; nested
                          (overlay-put
                           (make-overlay where (point))
                           'nested-function t))
                      (if (cdddr entry)
                          (overlay-put
                           (make-overlay where (point))
                           'cross-function-variables
                           (concat
                            "\\b\\("
                            (mapconcat #'(lambda (x) x) (cdddr entry) "\\|")
                            "\\)\\b")))))))))
        errors
        ))))

(defclass mlint-lm-group (linemark-group)
  ()
  "Group of linemarks for mlint.")

(defclass mlint-lm-entry (linemark-entry)
  ((column :initarg :column
           :type integer
           :documentation
           "The column on which the warning occurs.")
   (column-end :initarg :column-end
               :type integer
               :documentation
               "The column on which the warning ends.")
   (coverlay :type overlay
             :documentation
             "Overlay used for the specific part of the line at issue.")
   (warning :initarg :warning
            :type string
            :documentation
            "The error message created by mlint on this line.")
   (warningid :initarg :warningid
              :type symbol
              :documentation
              "The error id provided by mlint.
Warning ID's won't change between releases, unlike the warning messages.")
   (warningcode :initarg :warningcode
                :type symbol
                :initform 'minor
                :documentation
                "mlint return code for this type of warning.")
   (fixable-p :initform nil
              :allocation :class
              :type boolean
              :documentation
              "Can this class auto-fix the problem?")
   (fix-description :initform nil
                    :allocation :class
                    :type (or string null)
                    :documentation
                    "Description of how the fix will effect the buffer.")
   )
  "A linemark entry.")

(defun mlint-linemark-create-group ()
  "Create a group object for tracking linemark entries.
Do not permit multiple groups with the same name."
  (let* ((name "mlint")
         (newgroup (mlint-lm-group :object-name name :face 'linemark-go-face))
         (foundgroup nil)
         (lmg linemark-groups))
    (while (and (not foundgroup) lmg)
      (if (string= name (eieio-object-name-string (car lmg)))
          (setq foundgroup (car lmg)))
      (setq lmg (cdr lmg)))
    (if foundgroup
        (setq newgroup foundgroup)
      (setq linemark-groups (cons newgroup linemark-groups))
      newgroup)))

(defvar mlint-mark-group (mlint-linemark-create-group)
  "Group of marked lines for mlint.")

(defun mlint-warningid->class (warningid)
  "For a given WARNINGID, return a class for that warning.
Different warnings are handled by different classes."
  (if mlint-scan-for-fixes-flag
      (let ((al mlint-error-id-fix-alist))
        (while (and al
                    (not (eq (car (car al)) warningid))
                    )
          (setq al (cdr al)))
        (or (cdr (car al)) 'mlint-lm-entry))
    'mlint-lm-entry))

(cl-defmethod linemark-new-entry ((g mlint-lm-group) &rest args)
  "Add a `linemark-entry' to G.
It will be at location FILE and LINE, and use optional FACE.
Call the new entry's activate method.
Optional ARGS specifies details about the entry."
  (ignore g)
  (let* ((f (plist-get args :filename))
         (l (plist-get args :line))
         ;; (wc (plist-get args :warningcode))
         (c (mlint-warningid->class (plist-get args :warningid)))
         )
    (when (stringp f) (setq f (file-name-nondirectory f)))
    (apply c (format "%s %d" f l) args)
    ))

(defun mlint-end-of-something ()
  "Move cursor to the end of whatever the cursor is on."
  (cond ((looking-at "\\w\\|\\s(")
         (forward-sexp 1))
        ((looking-at "\\s.")
         (skip-syntax-forward "."))
        (t (error nil))))

(defvar mlint-overlay-map) ;; quiet compiler warning with forward declaration

(cl-defmethod linemark-display ((e mlint-lm-entry) active-p)
  "Set object E to be active.
ACTIVE-P if it should be made visible."
  ;; A bug in linemark prevents individual entry colors.
  ;; Fix the color here.
  (let ((wc (oref e warningcode)))
    (oset e face
          (cond ((eq wc 'major) 'linemark-stop-face)
                ((eq wc 'medium) 'linemark-caution-face)
                (t 'linemark-go-face))))
  ;; Call our parent method
  (cl-call-next-method)
  ;; Add highlight area
  (if active-p
      (when (and (not (slot-boundp e 'coverlay))
                 (slot-boundp e 'overlay)
                 (oref e overlay))
        (with-slots (overlay column column-end warning) e
          (let ((warntxt
                 (if (mlint-is-fixable e)
                     (concat warning "\nC-c , f to "
                             (oref e fix-description))
                   warning)))
            ;; We called super first, so this should be an active overlay.
            (overlay-put overlay 'local-map mlint-overlay-map)
            (overlay-put overlay 'help-echo warntxt)
            ;; Now, if we have some column data, lets put more highlighting on.
            (with-current-buffer (overlay-buffer overlay)
              (goto-char (overlay-start overlay))
              (condition-case nil
                  (forward-char (1- column))
                ;;(move-to-column (1- column))
                (error nil))
              (oset e coverlay (make-overlay
                                (point)
                                (progn
                                  (beginning-of-line)
                                  (forward-char column-end)
                                        ;(move-to-column column-end)
                                  (point))
                                (current-buffer)))
              (with-slots (coverlay) e
                (overlay-put coverlay 'face 'linemark-funny-face)
                (overlay-put coverlay 'obj e)
                (overlay-put coverlay 'tag 'mlint)
                (overlay-put coverlay 'help-echo warntxt)
                )
              ))))
    ;; Delete our spare overlay
    (when (slot-boundp e 'coverlay)
      (with-slots (coverlay) e
        (when coverlay
          (condition-case nil
              (delete-overlay coverlay)
            (error nil))
          (slot-makeunbound e 'coverlay)))
      )))

(cl-defmethod mlint-is-fixable ((e mlint-lm-entry))
  "Return non-nil if entry E can be automatically fixed."
  (oref-default e fixable-p))

(cl-defmethod mlint-fix-entry :after ((e mlint-lm-entry))
  "Stuff to do after a warning is considered fixed.
Subclasses fulfill the duty of actually fixing the code."
  (linemark-display e nil)
  (linemark-delete e))

(cl-defmethod mlint-fix-entry ((e mlint-lm-entry))
  "This entry E cannot fix warnings, so throw an error.
Subclasses fulfill the duty of actually fixing the code."
  (ignore e)
  (error "Don't know how to fix warning"))

;;; Specialized classes
;;

(defclass mlint-lm-delete-focus (mlint-lm-entry)
  ((fixable-p :initform t)
   (fix-description :initform "Delete the offending characters.")
   )
  "Specialized entry for deleting the highlighted entry.")

(cl-defmethod mlint-fix-entry ((ent mlint-lm-delete-focus))
  "Add semi-colon to end of this line ENT."
  (save-excursion
    (mlint-goto-line (oref ent line))
    (let* ((s (progn (move-to-column (1- (oref ent column))) (point)))
           (e (progn (move-to-column (oref ent column-end)) (point)))
           )
      (goto-char s)
      (delete-region (point) e)
      ;; If this happened to be at end of line, just delete all left over whitespace.
      (when (looking-at "\\s-*$") (delete-horizontal-space))
      (point)
      ))
  )

(defclass mlint-lm-replace-focus (mlint-lm-delete-focus)
  ((fix-description :initform "Replace the offending symbol with ")
   (new-text :initform "")
   )
  "Class which can replace the focus area."
  :abstract t)

(cl-defmethod initialize-instance :after ((this mlint-lm-replace-focus)
                                          &rest fields)
  "Calculate the new fix description for THIS.
Optional argument FIELDS are the initialization arguments."
  (ignore fields)
  ;; After basic initialization, update the fix description.
  (oset this fix-description
        (concat (oref-default this fix-description)
                (oref this new-text))))

(cl-defmethod mlint-fix-entry ((ent mlint-lm-replace-focus))
  "For ENT, replace the focus area with :new-text."
  (let ((pos (cl-call-next-method)))
    (ignore pos)
    (save-excursion
      (goto-char (point))
      (insert (oref ent new-text)))))

(defclass mlint-lm-str2num (mlint-lm-replace-focus)
  ((new-text :initform "str2double"))
  "Replace str2num with str2double.")

(defclass mlint-lm-entry-deprecated (mlint-lm-replace-focus)
  ()
  "Entry for anything that is deprecated.
Extracts the replacement for the deprecated symbol from the warning message.")

(cl-defmethod initialize-instance :after ((this mlint-lm-entry-deprecated)
                                          &rest fields)
  "Calculate the \\='new text\\=' for THIS instance.
Optional argument FIELDS are the initialization arguments."
  ;; After basic initialization, update the new text field.
  (ignore fields)
  (let* ((warn (oref this warning))
         (junk (string-match "Use \\(\\w+\\) instead" warn))
         (newfcn (when junk (downcase (substring warn (match-beginning 1) (match-end 1))))))
    (oset this new-text newfcn)
    ;; After basic initialization, update the fix description.
    (oset this fix-description
          (concat (oref-default this fix-description)
                  newfcn))
    ))

(defclass mlint-lm-function-name (mlint-lm-replace-focus)
  ()
  "When function name is mismatched with the file name."
  )

(cl-defmethod initialize-instance :after ((this mlint-lm-function-name) &rest fields)
  "Compute the \\='new text\\=' for THIS to be the file name from the message.
Optional arguments FIELDS are the initialization arguments."
  (ignore fields)
  (let* ((warn (oref this warning))
         (junk (or (string-match "file name: '\\([a-zA-z][a-zA-z0-9]+\\)'" warn)
                   (string-match "do not agree: '\\([a-zA-z][a-zA-z0-9]+\\)'" warn)
                   (string-match "of the subclass '\\([a-zA-z][a-zA-z0-9]+\\)'" warn))
               )
         (newfcn (when junk (match-string 1 warn))))
    (oset this new-text newfcn)
    ;; After basic initialization, update the fix description.
    (oset this fix-description
          (concat (oref-default this fix-description)
                  newfcn))
    ))

;;; Custom auto-fix entries
;;
(defclass mlint-lm-entry-logicals (mlint-lm-entry)
  ((fixable-p :initform t)
   (fix-description :initform "perform a replacement.")
   )
  "Specialized logical and/or class.")

(cl-defmethod mlint-fix-entry ((ent mlint-lm-entry-logicals))
  "For ENT, replace the single logical with double logical."
  (save-excursion
    (mlint-goto-line (oref ent line))
    (let* ((s (progn (move-to-column (1- (oref ent column))) (point)))
           (e (progn (move-to-column (oref ent column-end)) (point)))
           (txt (buffer-substring-no-properties s e)))
      (goto-char s)
      ;; All of these are replacing single logicals with double.
      (insert txt)))
  )

(defclass mlint-lm-entry-unused-argument (mlint-lm-entry)
  ((fixable-p :initform t)
   (fix-description :initform "remove this argument.")
   )
  "Specialized logical and/or class.")

(cl-defmethod mlint-fix-entry ((ent mlint-lm-entry-unused-argument))
  "For ENT, remove the arguments."
  (save-excursion
    (mlint-goto-line (oref ent line))
    (let* ((s (progn (move-to-column (1- (oref ent column))) (point)))
           (e (progn (move-to-column (oref ent column-end)) (point)))
           )
      (goto-char s)
      (if (not (looking-at "(\\|,"))
          (forward-char -1))
      (delete-region (point) e)
      ))
  )

(defclass mlint-lm-quiet (mlint-lm-entry)
  ((fixable-p :initform t)
   (fix-description :initform "Make sure this line prints no values.")
   )
  "Specialized logical and/or class.")


(cl-defmethod mlint-fix-entry ((ent mlint-lm-quiet))
  "For ENT, add semi-colon to end of this line."
  (ignore ent)
  (save-excursion
    (matlab-end-of-command)
    (insert ";"))
  )

(defclass mlint-lm-missing-end (mlint-lm-entry)
  ((fixable-p :initform t)
   (fix-description :initform "Add matching end for this line."))
  "Missing end with guess as to where it might go."
  )

(cl-defmethod mlint-fix-entry ((ent mlint-lm-missing-end))
  "For ENT, add semi-colon to end of this line."
  (save-excursion
    (let* ((msg (oref ent warning))
           line blockname)
      ;; Extract info about this.
      (when (string-match "(after line \\([0-9]+\\))" msg)
        (setq line (match-string 1 msg)))
      (when (string-match "possibly matching \\([A-Z]+\\)\\." msg)
        (setq blockname (match-string 1 msg)))

      ;; Did we get the right kind of warning
      (if line
          ;; We have a line number, just go for it there.
          (progn
            (mlint-goto-line (string-to-number line))
            ;; add the end and indent
            (indent-region (point) (save-excursion (insert "end\n") (point)))
            )
        (if (and blockname (string= blockname "FUNCTION"))
            ;; It is a function, but no line number.  Let's guess where this end
            ;; should go.
            (save-excursion
              (mlint-goto-line (oref ent line)) ;; go to the fcn
              (end-of-line)
              (if (re-search-forward "^function " nil t)
                  (progn
                    (beginning-of-line)
                    ;; skip over comments that might be headers to the found function.
                    (matlab-previous-command-begin
                     (matlab-compute-line-context 2)) ;;(matlab-find-prev-code-line)
                    (forward-line 1)
                    (save-excursion (insert "end\n\n"))
                    (matlab-indent-line))
                (goto-char (point-max))
                (save-excursion (insert "\nend\n\n"))
                (matlab-indent-line))))
        )
      ))
  )

;;; User functions
;;
(defun mlint-highlight (err)
  "Setup ERR, an mlint message to be marked."
  (save-excursion
    (linemark-add-entry mlint-mark-group
                        :line (nth 0 err)
                        :column (car (nth 1 err))
                        :column-end (cdr (nth 1 err))
                        :warning (nth 2 err)
                        ;; Old style did this lookup, but new versions of
                        ;; MLint replace the warning code with a warning
                        ;; ID which can instead be used for auto-fix.  In addition,
                        ;; just use the default warning code.

                        ;;:warningcode 'minor
                        ;; (cdr (assoc (nth 3 err) mlint-warningcode-alist))
                        :warningid (intern (nth 4 err))
                        )))

(defun mlint-clear-warnings ()
  "Unhighlight all existing mlint warnings."
  (interactive)
  (mapc (lambda (e)
          (if (string= (oref e filename) (buffer-file-name))
              (linemark-delete e)))
        (oref mlint-mark-group marks)))

(defun mlint-clear-nested-function-info-overlays ()
  "Clear out any previous overlays with nested function information.
This includes nested-function and cross-function-variables."
  (let ((overlays (overlays-in (point-min) (point-max))))
    (while overlays
      (let* ((overlay (car overlays)))
        (if (or (overlay-get overlay 'cross-function-variables)
                (overlay-get overlay 'nested-function))
            (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))

(defun mlint-clear-cross-function-variable-highlighting ()
  "Remove cross-function-variable overlays and re-fontify buffer."
  (mlint-clear-nested-function-info-overlays)
  (if (and (boundp 'global-font-lock-mode) global-font-lock-mode
           (boundp 'font-lock-flush) (not font-lock-mode))
      (font-lock-flush (point-min) (point-max))))

(defun mlint-buffer ()
  "Run mlint on the current buffer.
Highlight problems and/or cross-function variables."
  (interactive)
  (when (and (buffer-file-name) mlint-program)
    ;; If buffer-file-truename is nil, then it's not safe to save the
    ;; buffer. magit pulls in the code into a buffer and saving during
    ;; a magit ediff will result in backing out changes.
    (if (and buffer-file-truename (buffer-modified-p)
             (y-or-n-p (format "Save %s before linting? "
                               (file-name-nondirectory (buffer-file-name)))))
        (save-buffer))
    (let ((errs (mlint-run))
          )
      (mlint-clear-warnings)
      (while errs
        (mlint-highlight (car errs))
        (setq errs (cdr errs))))))

(defun mlint-next-buffer ()
  "Move to the next warning in this buffer."
  (interactive)
  (let ((n (linemark-next-in-buffer mlint-mark-group 1 t)))
    (if n
        (progn (mlint-goto-line (oref n line))
               (message (oref n warning)))
      (ding))))

(defun mlint-prev-buffer ()
  "Move to the prev warning in this buffer."
  (interactive)
  (let ((n (linemark-next-in-buffer mlint-mark-group -1 t)))
    (if n
        (progn (mlint-goto-line (oref n line))
               (message (oref n warning)))
      (ding))))

(defun mlint-next-buffer-new ()
  "Move to the next new warning in this buffer."
  (interactive)
  (let ((p (linemark-at-point (point) mlint-mark-group))
        (n (linemark-next-in-buffer mlint-mark-group 1 t)))
    ;; Skip over messages that are the same as the one under point.
    (save-excursion
      (while (and n p (not (eq n p))
                  (string= (oref p warning) (oref n warning)))
        (mlint-goto-line (oref n line))
        (setq n (linemark-next-in-buffer mlint-mark-group 1 t))))
    (if n
        (progn (mlint-goto-line (oref n line))
               (message (oref n warning)))
      (ding))))

(defun mlint-prev-buffer-new ()
  "Move to the prev new warning in this buffer."
  (interactive)
  (let ((p (linemark-at-point (point) mlint-mark-group))
        (n (linemark-next-in-buffer mlint-mark-group -1 t)))
    ;; Skip over messages that are the same as the one under point.
    (save-excursion
      (while (and n p (not (eq n p))
                  (string= (oref p warning) (oref n warning)))
        (mlint-goto-line (oref n line))
        (setq n (linemark-next-in-buffer mlint-mark-group -1 t))))
    (if n
        (progn (mlint-goto-line (oref n line))
               (message (oref n warning)))
      (ding))))

(defun mlint-show-warning ()
  "Show the warning for the current mark."
  (interactive)
  (let ((n (linemark-at-point (point) mlint-mark-group)))
    (if (not n)
        (message "No warning at point.")
      (message (oref n warning)))))

(defun mlint-fix-warning ()
  "Show the warning for the current mark."
  (interactive)
  (let ((n (linemark-at-point (point) mlint-mark-group)))
    (if (not n)
        (message "No warning at point.")
      (if (not (mlint-is-fixable n))
          (message "No method for fixing this warning.")
        (mlint-fix-entry n)))))

(defun mlint-mark-ok ()
  "Mark this line as M-Lint Ok."
  (interactive)
  (let ((n (linemark-at-point (point) mlint-mark-group)))
    (if (not n)
        (message "No warning at point.")
      (let ((col (matlab-comment-on-line)))
        (if col
            (progn
              (goto-char col)
              (skip-chars-forward "% ")
              (insert "#ok "))
          (end-of-line)
          (insert " %#ok"))
        )
      ;; This causes inconsistencies.
      ;; (linemark-delete n)
      ))
  )


;;; Define an mlinting minor mode
;;
(defvar mlint-minor-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map "\C-c,n" #'mlint-next-buffer)
    (define-key map "\C-c,p" #'mlint-prev-buffer)
    (define-key map "\C-c,N" #'mlint-next-buffer-new)
    (define-key map "\C-c,P" #'mlint-prev-buffer-new)
    (define-key map "\C-c,g" #'mlint-buffer)
    (define-key map "\C-c,c" #'mlint-clear-warnings)
    (define-key map "\C-c, " #'mlint-show-warning)
    (define-key map "\C-c,f" #'mlint-fix-warning)
    (define-key map "\C-c,o" #'mlint-mark-ok)
    map)
  "Minor mode keymap used when mlinting a buffer.")

(easy-menu-define
  mlint-minor-menu mlint-minor-mode-map "M-Lint Minor Mode Menu."
  '("M-Lint"
    ["Get M-Lint Warnings" mlint-buffer t]
    ["Clear M-Lint Warnings" mlint-clear-warnings t]
    ["Show Warning" mlint-show-warning (linemark-at-point (point) mlint-mark-group)]
    ["Auto Fix Warning" mlint-fix-warning
     (let ((w (linemark-at-point (point) mlint-mark-group)))
       (and mlint-scan-for-fixes-flag w (mlint-is-fixable w))) ]
    ["Enable Auto-fix scanning"
     (setq mlint-scan-for-fixes-flag (not mlint-scan-for-fixes-flag))
     :style toggle :selected mlint-scan-for-fixes-flag ]
    ["This is Ok" mlint-mark-ok
     (linemark-at-point (point) mlint-mark-group) ]
    "--"
    ["Next Warning" mlint-next-buffer t]
    ["Previous Warning" mlint-prev-buffer t]
    ["Next New Warning" mlint-next-buffer-new t]
    ["Previous New Warning" mlint-prev-buffer-new t]
    ))

(defvar mlint-overlay-map
  (let ((map (make-sparse-keymap )))
    ;; FIXME: Use `context-menu-functions' instead?
    (define-key map [down-mouse-3] #'mlint-emacs-popup-kludge)
    (define-key map [(meta n)] #'mlint-next-buffer)
    (define-key map [(meta p)] #'mlint-prev-buffer)
    (define-key map [(control meta n)] #'mlint-next-buffer-new)
    (define-key map [(control meta p)] #'mlint-prev-buffer-new)
    (set-keymap-parent map matlab-mode-map)
    map)
  "Map used in overlays marking mlint warnings.")

(defun mlint-emacs-popup-kludge (e)
  "Pop up a menu related to the clicked on item.
Must be bound to event E."
  (interactive "e")
  (let ((repos nil)
        (ipos nil))
    (save-excursion
      (mouse-set-point e)
      (setq ipos (point))
      (popup-menu mlint-minor-menu)
      (if (/= (point) ipos) (setq repos (point)))
      )
    (when repos (goto-char repos))))

;;;###autoload
(define-minor-mode mlint-minor-mode
  "Toggle mlint minor mode, a mode for showing mlint errors.
With prefix ARG, turn mlint minor mode on iff ARG is positive.
\\{mlint-minor-mode-map\\}"
  :init-value nil
  :lighter " mlint"
  :keymap mlint-minor-mode-map

  (when (and mlint-minor-mode (not (eq major-mode 'matlab-mode)))
    (mlint-minor-mode -1)
    (error "M-Lint minor mode is only for MATLAB Major mode"))

  (if (not mlint-minor-mode)
      (progn
        (mlint-clear-nested-function-info-overlays)
        (mlint-clear-warnings)
        (remove-hook 'after-save-hook #'mlint-buffer t))

    ;; activate mlint if possible
    (if mlint-program-selection-fcn
        (let ((ans (funcall mlint-program-selection-fcn)))
          (when ans
            (setq-local mlint-program ans)))
      ;; else use global mlint-program for all *.m files
      (when (not mlint-program)
        (setq mlint-program (matlab--get-mlint-exe))
        (when (and (not mlint-program)
                   (y-or-n-p "No MLINT program available.  Configure it? "))
          (customize-variable 'mlint-programs))))

    (if mlint-program
        (progn
          (setq matlab-show-mlint-warnings t)
          (add-hook 'after-save-hook #'mlint-buffer nil t)
          (mlint-buffer))
      ;; Remove the mlint menu. set mlint-minor-mode variable to nil, disable mlint keybindings
      (mlint-minor-mode -1))))

(defvar mlint-minor-mode-was-enabled-before nil
  "Non nil if mlint is off, and it was auto-disabled.")
(make-variable-buffer-local 'mlint-minor-mode-was-enabled-before)

(defun mlint-ediff-metabuffer-setup-hook ()
  "Hook run when EDiff is about to do stuff to a buffer.
That buffer will be current."
  (when (and (eq major-mode 'matlab-mode)
             mlint-minor-mode)
    (setq mlint-minor-mode-was-enabled-before mlint-minor-mode)
    (mlint-minor-mode -1)
    ))

(add-hook 'ediff-prepare-buffer-hook #'mlint-ediff-metabuffer-setup-hook)

(defun mlint-ediff-cleanup-hook ()
  "Re-enable mlint for buffers being ediffed.
The buffer that was originally \"setup\" is not current, so we need to
find it."
  (mapcar (lambda (b)
            (when (with-current-buffer b
                    (and (eq major-mode 'matlab-mode)
                         mlint-minor-mode-was-enabled-before))
              (with-current-buffer b
                (mlint-minor-mode 1)
                (setq mlint-minor-mode-was-enabled-before nil))))
          (buffer-list)))

(add-hook 'ediff-cleanup-hook #'mlint-ediff-cleanup-hook)

(provide 'mlint)
;;; mlint.el ends here

;; LocalWords:  el Ludlam eludlam compat linemark eieio fboundp defalias fn defun MACHTYPE stringp
;; LocalWords:  glnx hpux nt ARCHITEW defcustom symtab COLNO setq MLint mlp cdr defconst alist lm
;; LocalWords:  NOPRT NOSEM NOCOM FDEPR COLSTART COLEND cyc aset cddr rplacd integerp caddr sexp
;; LocalWords:  cadr cdddr mapconcat defclass linemarks initarg coverlay warningid ID's warningcode
;; LocalWords:  initform newgroup foundgroup lmg defmethod plist nondirectory oref oset boundp EDiff
;; LocalWords:  warntxt progn makeunbound ent newfcn downcase mapc fontify truename magit ediff prev
;; LocalWords:  mlinting keymap repos ipos startpos mmode funcall metabuffer ediffed mapcar MSNU
;; LocalWords:  ENDCT FNDEF MCFIL MCSCC tmp aref wc blockname