Emacs: do not accept compiler warnings in selected elisp files

9 files changed, 112 insertions, 79 deletions

diff --git a/lib/tools/emacs/erlang-edoc.el b/lib/tools/emacs/erlang-edoc.el
index d0dcc81028..ea1e263faf 100644
--- a/lib/tools/emacs/erlang-edoc.el
+++ b/lib/tools/emacs/erlang-edoc.el
@@ -28,6 +28,7 @@
 
 (defcustom erlang-edoc-indent-level 2
   "Indentation level of xhtml in Erlang edoc."
+  :type '(integer)
   :safe 'integerp
   :group 'erlang)
 
diff --git a/lib/tools/emacs/erlang-eunit.el b/lib/tools/emacs/erlang-eunit.el
index 38c40927f4..53543d7b01 100644
--- a/lib/tools/emacs/erlang-eunit.el
+++ b/lib/tools/emacs/erlang-eunit.el
@@ -23,6 +23,7 @@
 
 (eval-when-compile
   (require 'cl))
+(require 'erlang)
 
 (defvar erlang-eunit-src-candidate-dirs '("../src" ".")
   "*Name of directories which to search for source files matching
@@ -331,8 +332,7 @@ With prefix arg, compiles for debug and runs tests with the verbose flag set."
              t)
            (apply test-fun test-args)
            (if under-cover
-               (save-excursion
-                 (set-buffer (find-file-noselect src-filename))
+               (with-current-buffer (find-file-noselect src-filename)
                  (erlang-eunit-analyze-coverage)))))))
 
 (defun erlang-eunit-compile-and-run-module-tests-under-cover ()
@@ -348,8 +348,7 @@ With prefix arg, compiles for debug and runs tests with the verbose flag set."
 
 (defun erlang-eunit-compile-file (file-path &optional under-cover)
   (if (file-readable-p file-path)
-      (save-excursion
-        (set-buffer (find-file-noselect file-path))
+      (with-current-buffer (find-file-noselect file-path)
         ;; In order to run a code coverage analysis on a
         ;; module, we have two options:
         ;;
@@ -376,8 +375,7 @@ With prefix arg, compiles for debug and runs tests with the verbose flag set."
       (error msg))))
 
 (defun erlang-eunit-last-compilation-successful-p ()
-  (save-excursion
-    (set-buffer inferior-erlang-buffer)
+  (with-current-buffer inferior-erlang-buffer
     (goto-char compilation-parsing-end)
     (erlang-eunit-all-list-elems-fulfill-p
      (lambda (re) (let ((continue t)
diff --git a/lib/tools/emacs/erlang-pkg.el b/lib/tools/emacs/erlang-pkg.el
index 02d6bebbf4..7e95e4050e 100644
--- a/lib/tools/emacs/erlang-pkg.el
+++ b/lib/tools/emacs/erlang-pkg.el
@@ -1,3 +1,6 @@
 (define-package "erlang" "2.7.0"
   "Erlang major mode"
   '((emacs "24.1")))
+;; Local Variables:
+;; no-byte-compile: t
+;; End:
diff --git a/lib/tools/emacs/erlang-skels.el b/lib/tools/emacs/erlang-skels.el
index 534f50ab33..3ebc6e8e1e 100644
--- a/lib/tools/emacs/erlang-skels.el
+++ b/lib/tools/emacs/erlang-skels.el
@@ -1985,7 +1985,7 @@ configured off."
 The first character of DD is space if the value is less than 10."
   (let ((date (current-time-string)))
     (format "%2d %s %s"
-            (string-to-int (substring date 8 10))
+            (string-to-number (substring date 8 10))
             (substring date 4 7)
             (substring date -4))))
 
diff --git a/lib/tools/emacs/erlang-test.el b/lib/tools/emacs/erlang-test.el
index efe3d515e9..ca0b641791 100644
--- a/lib/tools/emacs/erlang-test.el
+++ b/lib/tools/emacs/erlang-test.el
@@ -29,7 +29,7 @@
 
 ;; This library require GNU Emacs 25 or later.
 ;;
-;; There are two ways to run emacs unit tests.
+;; There are three ways to run the erlang emacs unit tests.
 ;;
 ;; 1. Within a running emacs process.  Load this file.  Then to run
 ;; all defined test cases:
@@ -49,11 +49,15 @@
 ;;
 ;; The -L option adds a directory to the load-path.  It should be the
 ;; directory containing erlang.el and erlang-test.el.
+;;
+;; 3. Call the script test-erlang-mode in this directory.  This script
+;; use the second method.
 
 ;;; Code:
 
+(eval-when-compile
+  (require 'cl))
 (require 'ert)
-(require 'cl-lib)
 (require 'erlang)
 
 (defvar erlang-test-code
@@ -116,8 +120,8 @@ concatenated to form an erlang file to test on.")
 
 (defun erlang-test-create-erlang-file (erlang-file)
   (with-temp-file erlang-file
-    (cl-loop for (_ . code) in erlang-test-code
-             do (insert code "\n"))))
+    (loop for (_ . code) in erlang-test-code
+          do (insert code "\n"))))
 
 (defun erlang-test-compile-tags (erlang-file tags-file)
   (should (zerop (call-process "etags" nil nil nil
@@ -132,19 +136,19 @@ concatenated to form an erlang file to test on.")
                  (sort (erlang-expected-completion-table) #'string-lessp))))
 
 (defun erlang-expected-completion-table ()
-  (append (cl-loop for (symbol . _) in erlang-test-code
-                   when (stringp symbol)
-                   append (list symbol (concat "erlang_test:" symbol)))
+  (append (loop for (symbol . _) in erlang-test-code
+                when (stringp symbol)
+                append (list symbol (concat "erlang_test:" symbol)))
           (list "erlang_test:" "erlang_test:module_info")))
 
 (defun erlang-test-xref-find-definitions (erlang-file erlang-buffer)
-  (cl-loop for (tagname . code) in erlang-test-code
-           for line = 1 then (1+ line)
-           do (when tagname
-                (switch-to-buffer erlang-buffer)
-                (erlang-test-xref-jump tagname erlang-file line)
-                (erlang-test-xref-jump (concat "erlang_test:" tagname)
-                                       erlang-file line)))
+  (loop for (tagname . code) in erlang-test-code
+        for line = 1 then (1+ line)
+        do (when tagname
+             (switch-to-buffer erlang-buffer)
+             (erlang-test-xref-jump tagname erlang-file line)
+             (erlang-test-xref-jump (concat "erlang_test:" tagname)
+                                    erlang-file line)))
   (erlang-test-xref-jump "erlang_test:" erlang-file 1))
 
 (defun erlang-test-xref-jump (id expected-file expected-line)
@@ -213,27 +217,27 @@ concatenated to form an erlang file to test on.")
 
 
 (ert-deftest erlang-test-parse-id ()
-  (cl-loop for id-string in '("fun/10"
-                              "qualified-function module:fun/10"
-                              "record reko"
-                              "macro _SYMBOL"
-                              "macro MACRO/10"
-                              "module modula"
-                              "macro"
-                              nil)
-           for id-list in '((nil nil "fun" 10)
-                            (qualified-function "module" "fun" 10)
-                            (record nil "reko" nil)
-                            (macro nil "_SYMBOL" nil)
-                            (macro nil "MACRO" 10)
-                            (module nil "modula" nil)
-                            (nil nil "macro" nil)
-                            nil)
-           for id-list2 = (erlang-id-to-list id-string)
-           do (should (equal id-list id-list2))
-           for id-string2 = (erlang-id-to-string id-list)
-           do (should (equal id-string id-string2))
-           collect id-list2))
+  (loop for id-string in '("fun/10"
+                           "qualified-function module:fun/10"
+                           "record reko"
+                           "macro _SYMBOL"
+                           "macro MACRO/10"
+                           "module modula"
+                           "macro"
+                           nil)
+        for id-list in '((nil nil "fun" 10)
+                         (qualified-function "module" "fun" 10)
+                         (record nil "reko" nil)
+                         (macro nil "_SYMBOL" nil)
+                         (macro nil "MACRO" 10)
+                         (module nil "modula" nil)
+                         (nil nil "macro" nil)
+                         nil)
+        for id-list2 = (erlang-id-to-list id-string)
+        do (should (equal id-list id-list2))
+        for id-string2 = (erlang-id-to-string id-list)
+        do (should (equal id-string id-string2))
+        collect id-list2))
 
 
 (provide 'erlang-test)
diff --git a/lib/tools/emacs/erlang.el b/lib/tools/emacs/erlang.el
index 82e5c2222d..fc6966c3e8 100644
--- a/lib/tools/emacs/erlang.el
+++ b/lib/tools/emacs/erlang.el
@@ -78,6 +78,8 @@
 
 (eval-when-compile (require 'cl))
 (require 'align)
+(require 'comint)
+(require 'tempo)
 
 ;; Variables:
 
@@ -334,6 +336,7 @@ when a new function header is generated.  When nil, no blank line is
 inserted between the current line and the new header.  When bound to a
 number it represents the number of blank lines which should be
 inserted."
+  :type '(restricted-sexp :match-alternatives (integerp 'nil))
   :group 'erlang)
 
 (defvar erlang-electric-semicolon-criteria
@@ -1711,10 +1714,10 @@ Personal extensions could be added to `erlang-menu-personal-items'.
 
 This function should be called if any variable describing the
 menu configuration is changed."
-  (erlang-menu-install "Erlang" erlang-menu-items erlang-mode-map t))
+  (erlang-menu-install "Erlang" erlang-menu-items erlang-mode-map))
 
 
-(defun erlang-menu-install (name items keymap &optional popup)
+(defun erlang-menu-install (name items keymap)
   "Install a menu in Emacs based on an abstract description.
 
 NAME is the name of the menu.
@@ -4207,22 +4210,18 @@ Return t if criteria fulfilled, nil otherwise."
           nil)))))
 
 
-(defun erlang-in-literal (&optional lim)
+(defun erlang-in-literal ()
   "Test if point is in string, quoted atom or comment.
 
 Return one of the three atoms `atom', `string', and `comment'.
 Should the point be inside none of the above mentioned types of
 context, nil is returned."
   (save-excursion
-    (let* ((lim (or lim (save-excursion
-                          (erlang-beginning-of-clause)
-                          (point))))
-           (state (funcall (symbol-function 'syntax-ppss))))
-      (cond
-       ((eq (nth 3 state) ?') 'atom)
-       ((nth 3 state) 'string)
-       ((nth 4 state) 'comment)
-       (t nil)))))
+    (let ((state (funcall (symbol-function 'syntax-ppss))))
+      (cond ((eq (nth 3 state) ?') 'atom)
+            ((nth 3 state) 'string)
+            ((nth 4 state) 'comment)
+            (t nil)))))
 
 
 (defun erlang-at-end-of-function-p ()
@@ -5041,7 +5040,10 @@ considered first when it is time to jump to the definition.")
 (defun erlang-visit-tags-table-buffer (cont cbuf)
   (if (< emacs-major-version 26)
       (visit-tags-table-buffer cont)
-    (visit-tags-table-buffer cont cbuf)))
+    ;; Remove this with-no-warnings when Emacs 26 is the required
+    ;; version minimum.
+    (with-no-warnings
+      (visit-tags-table-buffer cont cbuf))))
 
 (defun erlang-xref-find-definitions-module-tag (module
                                                 tag
@@ -5536,7 +5538,7 @@ Return the position after the newly inserted command."
     (+ insert-point insert-length)))
 
 
-(defun inferior-erlang-strip-delete (&optional s)
+(defun inferior-erlang-strip-delete (&optional _s)
   "Remove `^H' (delete) and the characters it was supposed to remove."
   (interactive)
   (if (and (boundp 'comint-last-input-end)
@@ -5554,7 +5556,7 @@ Return the position after the newly inserted command."
 
 
 ;; Basically `comint-strip-ctrl-m', with a few extra checks.
-(defun inferior-erlang-strip-ctrl-m (&optional string)
+(defun inferior-erlang-strip-ctrl-m (&optional _string)
   "Strip trailing `^M' characters from the current output group."
   (interactive)
   (if (and (boundp 'comint-last-input-end)
@@ -5591,8 +5593,8 @@ There exists two workarounds for this bug:
   (let* ((dir (inferior-erlang-compile-outdir))
          (noext (substring (erlang-local-buffer-file-name) 0 -4))
          (opts (append (list (cons 'outdir dir))
-                       (if current-prefix-arg
-                           (list 'debug_info 'export_all))
+                       (when arg
+                         (list 'debug_info 'export_all))
                        erlang-compile-extra-opts))
          end)
     (with-current-buffer inferior-erlang-buffer
@@ -5641,7 +5643,6 @@ unless the optional NO-DISPLAY is non-nil."
 
 (defun inferior-erlang-compute-compile-command (module-name opts)
   (let ((ccfn erlang-compile-command-function-alist)
-        (res (inferior-erlang-compute-erl-compile-command module-name opts))
         ccfn-entry
         done
         result)
diff --git a/lib/tools/emacs/erlang_appwiz.el b/lib/tools/emacs/erlang_appwiz.el
index ecbce66f47..b71c180739 100644
--- a/lib/tools/emacs/erlang_appwiz.el
+++ b/lib/tools/emacs/erlang_appwiz.el
@@ -103,6 +103,10 @@
 ;;  
 ;;
 
+(defvar appwiz-erlang-modulename "foo")
+(defvar appwiz-erlang-ext "_work")
+
+
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;
 ;; Erlang application wizard
@@ -245,13 +249,6 @@ creating the root directory and for naming application files."
     (insert "Application specification file for " name ".")
     (save-buffer)))
 
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;
-;; These are setq:ed 
-;;
-
-(defvar appwiz-erlang-modulename "foo")
-(defvar appwiz-erlang-ext "_work")
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;
@@ -468,7 +465,7 @@ Call the function `erlang-menu-init' after modifying this variable.")
 The first character of DD is *not* space if the value is less than 10."
   (let ((date (current-time-string)))
     (format "%d %s %s"
-	    (string-to-int (substring date 8 10))
+	    (string-to-number (substring date 8 10))
 	    (substring date 4 7)
 	    (substring date -4))))
 
diff --git a/lib/tools/emacs/test-erlang-mode b/lib/tools/emacs/test-erlang-mode
index 910af48ed8..2418d23c92 100755
--- a/lib/tools/emacs/test-erlang-mode
+++ b/lib/tools/emacs/test-erlang-mode
@@ -48,6 +48,7 @@ version="$(emacs --version | head -n1)"
 version_number="${version#GNU Emacs }"
 version_major="${version_number%%\.*}"
 
+echo "Emacs version $version"
 
 case "$version_major" in
     [0-9][0-9])
@@ -60,22 +61,50 @@ case "$version_major" in
         echo "Skipping emacs test due to unsupported emacs version ($version)"
         exit "$invalid_emacs_rc";;
 esac
-     
+
 set -x
 
 # Test interpreted erlang-mode.
 emacs -Q -batch -L . -l erlang.el -f erlang-mode
 
-# Compile.
-emacs -Q -batch -L . -f batch-byte-compile *.el
+# Compile everything except erldoc.el.
+for el in *.el
+do
+    [ "$el" = "erldoc.el" ] && continue
+    emacs -Q -batch -L . -f batch-byte-compile "$el"
+done
 
 # Test compiled erlang-mode.
 emacs -Q -batch -L . -l erlang.elc -f erlang-mode
 
-# Run unit tests in interpreted mode.
-emacs -Q -batch -L . -l erlang.el -l erlang-test.el \
-      -f ert-run-tests-batch-and-exit
-
-# Run unit tests in compiled mode.
-emacs -Q -batch -L . -l erlang.elc -l erlang-test.elc \
-      -f ert-run-tests-batch-and-exit
+if [ "$version_major" -ge 25 ]
+then
+    # Run unit tests in interpreted mode.
+    emacs -Q -batch -L . -l erlang.el -l erlang-test.el \
+          -f ert-run-tests-batch-and-exit
+
+    # Run unit tests in compiled mode.
+    emacs -Q -batch -L . -l erlang.elc -l erlang-test.elc \
+          -f ert-run-tests-batch-and-exit
+
+    # Compile erldoc which depends on cl-lib which was introduced in
+    # Emacs 25.
+    emacs -Q -batch -L . -f batch-byte-compile erldoc.el
+    
+    # Compile selected files again and this time do not accept any
+    # warnings.  Add files here whenever they are cleaned of warnings.
+    if [ "$version_major" -ge 26 ]
+    then
+        unforgiving="(setq byte-compile-error-on-warn t)"
+    else
+        # Workaround byte-compile-error-on-warn which seem broken in
+        # Emacs 25.
+        unforgiving="(advice-add #'display-warning :after \
+         (lambda (_ f _ _) (error \"%s\" f)))"
+    fi
+    for el in erlang.el erlang-test.el erlang-edoc.el \
+                        erlang-start.el erldoc.el
+    do
+        emacs -Q -batch -L . --eval "$unforgiving" -f batch-byte-compile "$el"
+    done
+fi
diff --git a/lib/tools/test/emacs_SUITE.erl b/lib/tools/test/emacs_SUITE.erl
index 387c93f9fa..0ad00d8fdb 100644
--- a/lib/tools/test/emacs_SUITE.erl
+++ b/lib/tools/test/emacs_SUITE.erl
@@ -150,7 +150,7 @@ test_erlang_mode_script(_Config) ->
     Script = filename:join([emacs_dir(), "test-erlang-mode"]),
     RcFile = string:trim(os:cmd("mktemp /tmp/emacs_SUITE.XXXXXX")),
     Output = os:cmd(Script ++ " -f; echo $? > " ++ RcFile),
-    io:format("~s output:~n~ts~n", [Script, Output]),
+    io:format("~s output:~n~n~ts~n", [Script, Output]),
     {ok, RcBin} = file:read_file(RcFile),
     ok = file:delete(RcFile),
     RcString = binary:bin_to_list(RcBin),