X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/6be19e602822a4ec1b3fb128f9ca0fedd821017c..fcaf88782ba68e7c0618a663db51cf4a26cb3926:/admin/cus-test.el

diff --git a/admin/cus-test.el b/admin/cus-test.el
index 7d7717de5a..35d0412cc4 100644
--- a/admin/cus-test.el
+++ b/admin/cus-test.el
@@ -1,6 +1,7 @@
 ;;; cus-test.el --- tests for custom types and load problems
 
-;; Copyright (C) 1998, 2000, 2002 Free Software Foundation, Inc.
+;; Copyright (C) 1998, 2000, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
+;;   Free Software Foundation, Inc.
 
 ;; Author: Markus Rost <markus.rost@mathematik.uni-regensburg.de>
 ;; Maintainer: Markus Rost <rost@math.ohio-state.edu>
@@ -9,10 +10,10 @@
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs 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.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -20,9 +21,7 @@
 ;; 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, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
@@ -38,6 +37,8 @@
 ;;
 ;;   src/emacs -batch -l admin/cus-test.el -f cus-test-libs
 ;;
+;;   src/emacs -batch -l admin/cus-test.el -f cus-test-noloads
+;;
 ;; in the emacs source directory.
 ;;
 ;; For interactive use: Load this file.  Then
@@ -84,24 +85,48 @@
 ;; The command `cus-test-libs' runs for all libraries with autoloads
 ;; separate emacs processes of the form "emacs -batch -l LIB".
 ;;
+;; The command `cus-test-noloads' returns a list of variables which
+;; are somewhere declared as custom options, but not loaded by
+;; `custom-load-symbol'.
+;;
 ;; Some results from October 2002:
 ;;
 ;; 4523 options tested
 ;; The following variables might have problems:
 ;; ps-mule-font-info-database-default
+;; grep-tree-command
+;; grep-find-command
 ;;
 ;; 288 features required
 ;; 10 files loaded
 ;; The following load problems appeared:
 ;; (killing x-win (file-error Cannot open load file x-win))
 ;; Symbol faces has loaddefs as custom dependency
+;; (reftex-index-support reftex-vars (void-function reftex-set-dirty))
+;; (eshell-script em-script (void-variable eshell-directory-name))
+;; (pcomplete em-cmpl (void-function eshell-under-windows-p))
+;; (eshell-ext esh-ext (void-function eshell-under-windows-p))
 ;; ...
 ;;
 ;; 422 libraries had no load errors
 ;; The following load problems appeared:
 ;; (eudc-export error 255)
-;; ...
+;; (ada-xref error 255)
+;; (ada-stmt error 255)
+;;
+;; The following options were not loaded by custom-load-symbol:
+;; edt-bottom-scroll-margin
+;; edt-keep-current-page-delimiter
+;; edt-top-scroll-margin
+;; edt-use-EDT-control-key-bindings
+;; edt-word-entities
+;; grep-find-use-xargs
+;; master-mode-hook
+;; outline-level
+;; outline-minor-mode-hook
+;; refill-mode-hook
 
+
 ;;; Code:
 
 ;;; Workarounds.  For a smooth run and to avoid some side effects.
@@ -112,7 +137,7 @@
 (defvar cus-test-skip-list nil
   "List of variables to disregard by `cus-test-apropos'.")
 
-(defvar cus-test-noloads nil
+(defvar cus-test-libs-noloads nil
   "List of libraries not to load by `cus-test-load-libs'.")
 
 ;; The file eudc-export.el loads libraries "bbdb" and "bbdb-com" which
@@ -124,21 +149,9 @@
 ;; This avoids a hang of `cus-test-apropos' in 21.2.
 ;; (add-to-list 'cus-test-skip-list 'sh-alias-alist)
 
-;; Don't create a file `filesets-menu-cache-file'.
-(setq filesets-menu-cache-file "")
-;; Disable filesets hooks.
-(add-hook
- 'cus-test-after-load-libs-hook
- (lambda nil
-   (remove-hook 'menu-bar-update-hook 'filesets-build-menu-maybe)
-   (remove-hook 'kill-emacs-hook 'filesets-exit)
-   (remove-hook 'kill-buffer-hook 'filesets-remove-from-ubl)
-   (remove-hook 'first-change-hook 'filesets-reset-filename-on-change)
-   ))
-
 ;; Loading dunnet in batch mode leads to a Dead end.
 (let (noninteractive) (load "dunnet"))
-(add-to-list 'cus-test-noloads "dunnet")
+(add-to-list 'cus-test-libs-noloads "dunnet")
 
 ;; Never Viperize.
 (setq viper-mode nil)
@@ -169,6 +182,14 @@
 (defvar cus-test-tested-variables nil
   "List of options tested by last call of `cus-test-apropos'.")
 
+;; I haven't understood this :get stuff.  The symbols with a
+;; custom-get property are stored here.
+(defvar cus-test-vars-with-custom-get nil
+  "Set by `cus-test-apropos' to a list of options with :get property.")
+
+(defvar cus-test-vars-with-changed-state nil
+  "Set by `cus-test-apropos' to a list of options with state 'changed.")
+
 (defvar cus-test-deps-errors nil
   "List of require/load problems found by `cus-test-deps'.")
 
@@ -185,13 +206,12 @@ Only unloaded features will be require'd.")
 (defvar cus-test-libs-loaded nil
   "List of files loaded by `cus-test-load-libs' or `cus-test-libs'.")
 
-;; I haven't understood this :get stuff.  The symbols with a
-;; custom-get property are stored here.
-(defvar cus-test-vars-with-custom-get nil
-  "Set by `cus-test-apropos' to a list of options with :get property.")
+(defvar cus-test-vars-not-cus-loaded nil
+  "A list of options not loaded by `custom-load-symbol'.
+Set by `cus-test-noloads'.")
 
-(defvar cus-test-vars-with-changed-state nil
-  "Set by `cus-test-apropos' to a list of options with state 'changed.")
+;; (defvar cus-test-vars-cus-loaded nil
+;;   "A list of options loaded by `custom-load-symbol'.")
 
 (defun cus-test-apropos (regexp)
   "Check the options matching REGEXP.
@@ -227,8 +247,7 @@ The detected problematic options are stored in `cus-test-errors'."
 
 	   ;; Store symbols with a custom-get property.
 	   (when (get symbol 'custom-get)
-	     (add-to-list 'cus-test-vars-with-custom-get
-			  symbol 'append))
+	     (add-to-list 'cus-test-vars-with-custom-get symbol))
 
 	   ;; Changed outside the customize buffer?
 	   ;; This routine is not very much tested.
@@ -239,8 +258,7 @@ The detected problematic options are stored in `cus-test-errors'."
 	     (and (consp c-value)
 		  (boundp symbol)
 		  (not (equal (eval (car c-value)) (symbol-value symbol)))
-		  (add-to-list 'cus-test-vars-with-changed-state
-			       symbol 'append)))
+		  (add-to-list 'cus-test-vars-with-changed-state symbol)))
 
 	   (if mismatch
 	       (push symbol cus-test-errors)))
@@ -279,8 +297,8 @@ The detected problematic options are stored in `cus-test-errors'."
     (if (not cus-test-errors)
 	(insert "No errors found by cus-test.")
       (insert "The following variables seem to have problems:\n\n")
-      (dolist (E cus-test-errors)
-	(insert (symbol-name E) "\n")))))
+      (dolist (e cus-test-errors)
+	(insert (symbol-name e) "\n")))))
 
 (defun cus-test-load-custom-loads ()
   "Call `custom-load-symbol' on all atoms."
@@ -290,14 +308,14 @@ The detected problematic options are stored in `cus-test-errors'."
 
 (defun cus-test-load-libs ()
   "Load the libraries with autoloads.
-Don't load libraries in `cus-test-noloads'."
+Don't load libraries in `cus-test-libs-noloads'."
   (interactive)
   (setq cus-test-libs-errors nil)
   (setq cus-test-libs-loaded nil)
   (mapc
    (lambda (file)
      (condition-case alpha
-	 (unless (member file cus-test-noloads)
+	 (unless (member file cus-test-libs-noloads)
 	   (load file)
 	   (push file cus-test-libs-loaded))
        (error
@@ -342,8 +360,10 @@ This function is suitable for batch mode.  E.g., invoke
 
   src/emacs -batch -l admin/cus-test.el -f cus-test-opts
 
-in the emacs source directory."
+in the Emacs source directory."
   (interactive)
+  (message "Running %s" 'cus-test-load-libs)
+  (cus-test-load-libs)
   (message "Running %s" 'cus-test-load-custom-loads)
   (cus-test-load-custom-loads)
   (message "Running %s" 'cus-test-apropos)
@@ -359,7 +379,7 @@ This function is suitable for batch mode.  E.g., invoke
 
   src/emacs -batch -l admin/cus-test.el -f cus-test-deps
 
-in the emacs source directory."
+in the Emacs source directory."
   (interactive)
   (setq cus-test-deps-errors nil)
   (setq cus-test-deps-required nil)
@@ -367,52 +387,54 @@ in the emacs source directory."
   (mapatoms
    ;; This code is mainly from `custom-load-symbol'.
    (lambda (symbol)
-     (unless custom-load-recursion
-       (let ((custom-load-recursion t))
-	 (dolist (load (get symbol 'custom-loads))
-	   (cond
-	    ((symbolp load)
-	     ;; (condition-case nil (require load) (error nil))
-	     (condition-case alpha
-		 (unless (featurep load)
-		   (require load)
-		   (push (list symbol load) cus-test-deps-required))
-	       (error
-		(push (list symbol load alpha) cus-test-deps-errors)
-		(message "Require problem: %s %s %s" symbol load alpha))))
-	    ((equal load "loaddefs")
-	     (push
-	      (message "Symbol %s has loaddefs as custom dependency" symbol)
-	      cus-test-deps-errors))
-	    ;; This is subsumed by the test below, but it's much
-	    ;; faster.
-	    ((assoc load load-history))
-	    ;; This was just
-	    ;; (assoc (locate-library load) load-history)
-	    ;; but has been optimized not to load locate-library
-	    ;; if not necessary.
-	    ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load)
-				   "\\(\\'\\|\\.\\)"))
-		   (found nil))
-	       (dolist (loaded load-history)
-		 (and (stringp (car loaded))
-		      (string-match regexp (car loaded))
-		      (setq found t)))
-	       found))
-	    ;; Without this, we would load cus-edit recursively.
-	    ;; We are still loading it when we call this,
-	    ;; and it is not in load-history yet.
-	    ((equal load "cus-edit"))
-	    (t
-	     ;; (condition-case nil (load load) (error nil))
-	     (condition-case alpha
-		 (progn
-		   (load load)
-		   (push (list symbol load) cus-test-deps-loaded))
-	       (error
-		(push (list symbol load alpha) cus-test-deps-errors)
-		(message "Load Problem: %s %s %s" symbol load alpha))))
-	    ))))))
+     (let ((custom-load-recursion t))
+       (dolist (load (get symbol 'custom-loads))
+	 (cond
+	  ((symbolp load)
+	   ;; (condition-case nil (require load) (error nil))
+	   (condition-case alpha
+	       (unless (featurep load)
+		 (require load)
+		 (push (list symbol load) cus-test-deps-required))
+	     (error
+	      (push (list symbol load alpha) cus-test-deps-errors)
+	      (message "Require problem: %s %s %s" symbol load alpha))))
+	  ((equal load "loaddefs")
+	   (push
+	    (message "Symbol %s has loaddefs as custom dependency" symbol)
+	    cus-test-deps-errors))
+	  ;; This is subsumed by the test below, but it's much
+	  ;; faster.
+	  ((assoc load load-history))
+	  ;; This was just
+	  ;; (assoc (locate-library load) load-history)
+	  ;; but has been optimized not to load locate-library
+	  ;; if not necessary.
+	  ((let ((regexp (concat "\\(\\`\\|/\\)" (regexp-quote load)
+				 "\\(\\'\\|\\.\\)"))
+		 (found nil))
+	     (dolist (loaded load-history)
+	       (and (stringp (car loaded))
+		    (string-match regexp (car loaded))
+		    (setq found t)))
+	     found))
+	  ;; Without this, we would load cus-edit recursively.
+	  ;; We are still loading it when we call this,
+	  ;; and it is not in load-history yet.
+	  ((equal load "cus-edit"))
+	  ;; This would ignore load problems with files in
+	  ;; lisp/term/
+	  ;; ((locate-library (concat term-file-prefix load)))
+	  (t
+	   ;; (condition-case nil (load load) (error nil))
+	   (condition-case alpha
+	       (progn
+		 (load load)
+		 (push (list symbol load) cus-test-deps-loaded))
+	     (error
+	      (push (list symbol load alpha) cus-test-deps-errors)
+	      (message "Load Problem: %s %s %s" symbol load alpha))))
+	  )))))
   (message "%s features required"
 	   (length cus-test-deps-required))
   (message "%s files loaded"
@@ -430,7 +452,7 @@ It is suitable for batch mode.  E.g., invoke
 
   src/emacs -batch -l admin/cus-test.el -f cus-test-libs
 
-in the emacs source directory."
+in the Emacs source directory."
   (interactive)
   (with-temp-buffer
     (setq cus-test-libs-errors nil)
@@ -448,7 +470,7 @@ in the emacs source directory."
 	     (setq cmd (concat "src/emacs -batch -l " fn))
 	     (setq status (call-process shell-file-name nil nil nil
 					shell-command-switch cmd))
-	     (if (= status 0)
+	     (if (equal status 0)
 		 (message "%s" file)
 	       (error "%s" status))
 	     (push file cus-test-libs-loaded))
@@ -465,6 +487,43 @@ in the emacs source directory."
       (cus-test-message cus-test-libs-errors))
     (run-hooks 'cus-test-after-load-libs-hook)))
 
+(defun cus-test-noloads ()
+  "Find custom options not loaded by `custom-load-symbol'.
+Calling this function after `cus-test-load-libs' is not meaningful.
+It is suitable for batch mode.  E.g., invoke
+
+  src/emacs -batch -l admin/cus-test.el -f cus-test-noloads
+
+in the Emacs source directory."
+  (interactive)
+  (let (cus-loaded)
+
+    (message "Running %s" 'cus-test-load-custom-loads)
+    (cus-test-load-custom-loads)
+    (setq cus-loaded
+	  (cus-test-get-options ""))
+
+    (message "Running %s" 'cus-test-load-libs)
+    (cus-test-load-libs)
+    (setq cus-test-vars-not-cus-loaded
+	  (cus-test-get-options ""))
+
+    (dolist (o cus-loaded)
+      (setq cus-test-vars-not-cus-loaded
+	    (delete o cus-test-vars-not-cus-loaded)))
+
+    (if (not cus-test-vars-not-cus-loaded)
+	(message "No options not loaded by custom-load-symbol found")
+      (message "The following options were not loaded by custom-load-symbol:")
+      (cus-test-message
+       (sort cus-test-vars-not-cus-loaded 'string<)))))
+
+;; And last but not least a quiz:
+;;
+;; Evaluation of the form (customize-option 'debug-on-error) yields a
+;; *Customize* buffer with a mismatch mess.  Why?
+
 (provide 'cus-test)
 
+;;; arch-tag: a4991a31-548d-48fb-8ba1-1ebbe68eb2e7
 ;;; cus-test.el ends here