comparison lisp/emacs-lisp/check-declare.el @ 86300:96fee69c65a2

(check-declare-verify): Implement arglist checking for C files.

86299:061a530122b6

;; The entry points are `check-declare-file' and `check-declare-directory'.

;;; TODO:

;; 1. Handle defstructs (eg uniquify-item-base in desktop.el).

;; 2. Argument checking for functions defined in C.

;;; Code:

(defconst check-declare-warning-buffer "*Check Declarations Warnings*"
  "Name of buffer used to display any `check-declare' warnings.")

FNFILE with the specified ARGLIST.  Returns nil if all claims are
found to be true, otherwise a list of errors with elements of the form
\(FILE FN TYPE), where TYPE is a string giving details of the error."
  (let ((m (format "Checking %s..." fnfile))
        (cflag (string-equal "c" (file-name-extension fnfile)))
        re fn sig siglist arglist type errlist)
    (message "%s" m)
    (or cflag
        (file-exists-p fnfile)
        (setq fnfile (concat fnfile ".el")))
    (if (file-exists-p fnfile)

            (skip-chars-forward " \t\n")
            (setq fn (match-string 2)
                  ;; (min . max) for a fixed number of arguments, or
                  ;; arglists with optional elements.
                  ;; (min) for arglists with &rest.
                  sig (cond ((string-equal (match-string 1)
                                           "define-derived-mode")
                             '(0 . 0))
                            ((string-equal (match-string 1)
                                           "define-minor-mode")
                             '(0 . 1))

            type
            (if re                   ; re non-nil means found a file
                (if (setq sig (assoc (cadr e) siglist))
                    ;; Recall we use t to mean no arglist specified,
                    ;; to distinguish from an empty arglist.
                    ;; FIXME c arg checking not yet implemented.
                    (unless (or cflag
                                (eq arglist t)
                                (eq sig t))
                      (unless (equal (byte-compile-arglist-signature arglist)
                                     (cdr sig))
                        "arglist mismatch"))
                  "function not found")

86300:96fee69c65a2

;; The entry points are `check-declare-file' and `check-declare-directory'.

;;; TODO:

;; 1. Handle defstructs (eg uniquify-item-base in desktop.el).

;;; Code:

(defconst check-declare-warning-buffer "*Check Declarations Warnings*"
  "Name of buffer used to display any `check-declare' warnings.")

FNFILE with the specified ARGLIST.  Returns nil if all claims are
found to be true, otherwise a list of errors with elements of the form
\(FILE FN TYPE), where TYPE is a string giving details of the error."
  (let ((m (format "Checking %s..." fnfile))
        (cflag (string-equal "c" (file-name-extension fnfile)))
        re fn sig siglist arglist type errlist minargs maxargs)
    (message "%s" m)
    (or cflag
        (file-exists-p fnfile)
        (setq fnfile (concat fnfile ".el")))
    (if (file-exists-p fnfile)

            (skip-chars-forward " \t\n")
            (setq fn (match-string 2)
                  ;; (min . max) for a fixed number of arguments, or
                  ;; arglists with optional elements.
                  ;; (min) for arglists with &rest.
                  sig (cond (cflag
                             (re-search-forward "," nil t 3)
                             (skip-chars-forward " \t\n")
                             ;; Assuming minargs and maxargs on same line.
                             (when (looking-at "\\([0-9]+\\)[ \t]*,[ \t]*\
\\([0-9]+\\|MANY\\|UNEVALLED\\)")
                               (setq minargs (string-to-number (match-string 1))
                                     maxargs (match-string 2))
                               (cons minargs (unless (string-match "[^0-9]"
                                                                   maxargs)
                                               (string-to-number maxargs)))))
                            ((string-equal (match-string 1)
                                           "define-derived-mode")
                             '(0 . 0))
                            ((string-equal (match-string 1)
                                           "define-minor-mode")
                             '(0 . 1))

            type
            (if re                   ; re non-nil means found a file
                (if (setq sig (assoc (cadr e) siglist))
                    ;; Recall we use t to mean no arglist specified,
                    ;; to distinguish from an empty arglist.
                    (unless (or (eq arglist t)
                                (eq sig t))
                      (unless (equal (byte-compile-arglist-signature arglist)
                                     (cdr sig))
                        "arglist mismatch"))
                  "function not found")