X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/bd9aba20d4dfb85686bcaea9182c795126ca2194..42f81f6412dcd756022136070dfa6bd25a3d4aa8:/admin/cus-test.el diff --git a/admin/cus-test.el b/admin/cus-test.el index 78e7ad2260..bebf89cdeb 100644 --- a/admin/cus-test.el +++ b/admin/cus-test.el @@ -1,4 +1,4 @@ -;;; cus-test.el --- functions for testing custom variable definitions +;;; cus-test.el --- tests for custom types and load problems ;; Copyright (C) 1998, 2000, 2002 Free Software Foundation, Inc. @@ -26,13 +26,23 @@ ;;; Commentary: -;; Some user options in GNU Emacs have been defined with incorrect -;; customization types. As a result the customization of these -;; options is disabled. This file provides functions to detect such -;; options. It contains also simple tests for loading libraries and -;; custom dependencies. +;; This file provides simple tests to detect custom options with +;; incorrect customization types and load problems for custom and +;; autoload dependencies. ;; -;; Usage: Load this file. Then +;; The basic tests can be run in batch mode. Invoke them with +;; +;; src/emacs -batch -l admin/cus-test.el -f cus-test-opts +;; +;; src/emacs -batch -l admin/cus-test.el -f cus-test-deps +;; +;; 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 ;; ;; M-x cus-test-apropos REGEXP RET ;; @@ -47,9 +57,13 @@ ;; Therefore `cus-test-apropos' is more efficient after loading many ;; libraries. ;; -;; M-x cus-test-load-custom-loads RET +;; M-x cus-test-load-custom-loads +;; +;; loads all (!) custom dependencies and +;; +;; M-x cus-test-load-libs ;; -;; loads all (!) custom dependencies. +;; loads all (!) libraries with autoloads. ;; ;; Options with a custom-get property, usually defined by a :get ;; declaration, are stored in the variable @@ -64,52 +78,81 @@ ;; These lists are prepared just in case one wants to investigate ;; those options further. ;; -;; For a maximal test of custom options invoke +;; The command `cus-test-opts' tests many (all?) custom options. ;; -;; M-x cus-test-opts +;; The command `cus-test-deps' is like `cus-test-load-custom-loads' +;; but reports about load errors. ;; -;; Other test routines are `cus-test-deps' and `cus-test-libs'. -;; These functions are suitable for batch mode. Invoke them with +;; The command `cus-test-libs' runs for all libraries with autoloads +;; separate emacs processes of the form "emacs -batch -l LIB". ;; -;; src/emacs -batch -l admin/cus-test.el -f cus-test-opts -;; -;; src/emacs -batch -l admin/cus-test.el -f cus-test-deps +;; The command `cus-test-noloads' returns a list of variables which +;; are somewhere declared as custom options, but not loaded by +;; `custom-load-symbol'. ;; -;; src/emacs -batch -l admin/cus-test.el -f cus-test-libs -;; -;; in the emacs source directory. +;; Some results from October 2002: ;; -;; To make cus-test work one has usually to work-around some existing -;; bugs/problems. Therefore this file contains "Fixme" and -;; "Workarounds" sections, to be edited once in a while. +;; 4523 options tested +;; The following variables might have problems: +;; ps-mule-font-info-database-default +;; grep-tree-command +;; grep-find-command ;; -;; Results from Oct 10, 2002: +;; 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)) +;; ... ;; -;; Cus Test tested 4514 options. -;; The following variables might have problems: -;; (ps-mule-font-info-database-default) - -;; Cus Test Deps loaded 332 files. +;; 422 libraries had no load errors ;; The following load problems appeared: -;; ((killing x-win (file-error Cannot open load file x-win))) - -;; Cus Test Libs loaded 424 files. -;; No load problems encountered by Cus Test Libs +;; (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: -;;; Variables for workarounds: +;;; Workarounds. For a smooth run and to avoid some side effects. (defvar cus-test-after-load-libs-hook nil - "Hook to repair the worst side effects of loading buggy libraries.") + "Used to switch off undesired side effects of loading libraries.") + +(defvar cus-test-skip-list nil + "List of variables to disregard by `cus-test-apropos'.") (defvar cus-test-libs-noloads nil - "List of libraries not to load by `cus-test-libs'.") + "List of libraries not to load by `cus-test-load-libs'.") + +;; The file eudc-export.el loads libraries "bbdb" and "bbdb-com" which +;; are not part of GNU Emacs: (locate-library "bbdb") => nil +;; We avoid the resulting errors from loading eudc-export.el: +(provide 'bbdb) +(provide 'bbdb-com) -;;; Fixme: +;; This avoids a hang of `cus-test-apropos' in 21.2. +;; (add-to-list 'cus-test-skip-list 'sh-alias-alist) -;; Loading filesets.el currently disables mini-buffer echoes. -;; (add-to-list 'cus-test-libs-noloads "filesets") +;; 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 @@ -118,33 +161,13 @@ (remove-hook 'kill-buffer-hook 'filesets-remove-from-ubl) (remove-hook 'first-change-hook 'filesets-reset-filename-on-change) )) -;; (setq cus-test-after-load-libs-hook nil) - -;; eshell must be loaded before em-script. eshell loads esh-util, -;; which must be loaded before em-cmpl, em-dirs and similar libraries. -(load "eshell") - -;; reftex must be loaded before reftex-vars. -(load "reftex") - -;;; Workarounds: - -;; The file eudc-export.el loads libraries "bbdb" and "bbdb-com" which -;; are not part of GNU Emacs: (locate-library "bbdb") => nil - -;; This avoids the resulting errors from loading eudc-export.el. -(provide 'bbdb) -(provide 'bbdb-com) ;; Loading dunnet in batch mode leads to a Dead end. -(let (noninteractive) - (load "dunnet")) +(let (noninteractive) (load "dunnet")) (add-to-list 'cus-test-libs-noloads "dunnet") -;;; Silencing: - -;; Don't create a file `filesets-menu-cache-file'. -(setq filesets-menu-cache-file "") +;; Never Viperize. +(setq viper-mode nil) ;; Don't create a file `save-place-file'. (eval-after-load "saveplace" @@ -157,41 +180,51 @@ (eval-after-load "bytecomp" '(setq ad-default-compilation-action 'never)) + +;;; Main code: + ;; We want to log all messages. (setq message-log-max t) - -;;; Main Code: - (require 'cus-edit) (require 'cus-load) -(defvar cus-test-tested-variables nil - "Options tested by last call of `cus-test-apropos'.") - (defvar cus-test-errors nil "List of problematic variables found by `cus-test-apropos'.") +(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'.") +(defvar cus-test-deps-required nil + "List of dependencies required by `cus-test-deps'. +Only unloaded features will be require'd.") + (defvar cus-test-deps-loaded nil - "Dependencies loaded by `cus-test-deps'.") + "List of dependencies loaded by `cus-test-deps'.") (defvar cus-test-libs-errors nil - "List of load problems found by `cus-test-libs'.") + "List of load problems found by `cus-test-load-libs' or `cus-test-libs'.") (defvar cus-test-libs-loaded nil - "Files loaded by `cus-test-libs'.") + "List of files loaded by `cus-test-load-libs' or `cus-test-libs'.") -;; I haven't understood this :get stuff. However, there are only very -;; few variables with a custom-get property. Such symbols are stored -;; in `cus-test-vars-with-custom-get'. -(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. @@ -199,12 +232,12 @@ The detected problematic options are stored in `cus-test-errors'." (interactive "sVariable regexp: ") (setq cus-test-errors nil) (setq cus-test-tested-variables nil) - (mapcar + (mapc (lambda (symbol) (push symbol cus-test-tested-variables) - (unless noninteractive - (message "Cus Test Running...[%s]" - (length cus-test-tested-variables))) + ;; Be verbose in case we hang. + (message "Cus Test running...%s %s" + (length cus-test-tested-variables) symbol) (condition-case alpha (let* ((type (custom-variable-type symbol)) (conv (widget-convert type)) @@ -220,14 +253,14 @@ The detected problematic options are stored in `cus-test-errors'." ;; (push (widget-get conv :value) values) ;; Check the values - (mapcar (lambda (value) - (unless (widget-apply conv :match value) - (setq mismatch 'mismatch))) - values) + (mapc (lambda (value) + (unless (widget-apply conv :match value) + (setq mismatch 'mismatch))) + values) ;; Store symbols with a custom-get property. (when (get symbol 'custom-get) - (push symbol cus-test-vars-with-custom-get)) + (add-to-list 'cus-test-vars-with-custom-get symbol)) ;; Changed outside the customize buffer? ;; This routine is not very much tested. @@ -238,7 +271,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))) - (push symbol cus-test-vars-with-changed-state))) + (add-to-list 'cus-test-vars-with-changed-state symbol))) (if mismatch (push symbol cus-test-errors))) @@ -247,7 +280,7 @@ The detected problematic options are stored in `cus-test-errors'." (push symbol cus-test-errors) (message "Error for %s: %s" symbol alpha)))) (cus-test-get-options regexp)) - (message "Cus Test tested %s options." + (message "%s options tested" (length cus-test-tested-variables)) (cus-test-errors-display)) @@ -263,7 +296,7 @@ The detected problematic options are stored in `cus-test-errors'." ;; (get symbol 'saved-value) (get symbol 'custom-type)) (string-match regexp (symbol-name symbol)) - ;; (not (member symbol cus-test-strange-vars)) + (not (member symbol cus-test-skip-list)) (push symbol found)))) found)) @@ -274,141 +307,234 @@ The detected problematic options are stored in `cus-test-errors'." (insert (format "Cus Test tested %s variables.\ See `cus-test-tested-variables'.\n\n" (length cus-test-tested-variables))) - (if cus-test-errors - (let ((L cus-test-errors)) - (insert "The following variables seem to have problems:\n\n") - (while L (insert (symbol-name (car L))) (insert "\n") - (setq L (cdr L)))) - (insert "No errors found by cus-test.")))) - -(defun cus-test-load-custom-loads nil + (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"))))) + +(defun cus-test-load-custom-loads () "Call `custom-load-symbol' on all atoms." (interactive) (mapatoms 'custom-load-symbol) (run-hooks 'cus-test-after-load-libs-hook)) +(defun cus-test-load-libs () + "Load the libraries with autoloads. +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-libs-noloads) + (load file) + (push file cus-test-libs-loaded)) + (error + (push (cons file alpha) cus-test-libs-errors) + (message "Error for %s: %s" file alpha)))) + (cus-test-get-autoload-deps)) + (message "%s libraries loaded successfully" + (length cus-test-libs-loaded)) + (if (not cus-test-libs-errors) + (message "No load problems encountered") + (message "The following load problems appeared:") + (cus-test-message cus-test-libs-errors)) + (run-hooks 'cus-test-after-load-libs-hook)) + +(defun cus-test-get-autoload-deps () + "Return the list of libraries with autoloads." + (with-temp-buffer + (insert-file-contents (locate-library "loaddefs")) + ;; This is from `customize-option'. + (let (deps file) + (while + (search-forward "\n;;; Generated autoloads from " nil t) + (goto-char (match-end 0)) + (setq file (buffer-substring (point) + (progn (end-of-line) (point)))) + (setq file (file-name-nondirectory file)) + (string-match "\\.el\\'" file) + (setq file (substring file 0 (match-beginning 0))) + (setq deps (nconc deps (list file)))) + deps))) + +(defun cus-test-message (list) + "Print the members of LIST line by line." + (dolist (m list) (message "%s" m))) + + ;;; The routines for batch mode: -(defun cus-test-opts nil +(defun cus-test-opts () "Test custom options. 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) (cus-test-apropos "") - (if cus-test-errors - (message "The following options might have problems:\n%s" - cus-test-errors) - (message "No problems found by Cus Test Opts"))) + (if (not cus-test-errors) + (message "No problems found") + (message "The following options might have problems:") + (cus-test-message cus-test-errors))) -(defun cus-test-deps nil +(defun cus-test-deps () "Run a verbose version of `custom-load-symbol' on all atoms. 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) (setq cus-test-deps-loaded nil) (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 - (progn - (require load) - (push (list symbol load) cus-test-deps-loaded)) - (error - (push (list symbol load alpha) cus-test-deps-errors) - (message "Require problem: %s %s: %s" symbol load alpha)))) - ;; 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)))) - )))))) - (message "Cus Test Deps loaded %s files." + (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" (length cus-test-deps-loaded)) - (if cus-test-deps-errors - (message "The following load problems appeared:\n%s" - cus-test-deps-errors) - (message "No load problems encountered by Cus Test Deps")) + (if (not cus-test-deps-errors) + (message "No load problems encountered") + (message "The following load problems appeared:") + (cus-test-message cus-test-deps-errors)) (run-hooks 'cus-test-after-load-libs-hook)) (defun cus-test-libs () - "Load the libraries with autoloads in loaddefs.el. -Don't load libraries in `cus-test-libs-noloads'. - + "Load the libraries with autoloads in separate processes. This function is useful to detect load problems of libraries. 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) - (setq cus-test-libs-errors nil) - (setq cus-test-libs-loaded nil) - (set-buffer (find-file-noselect (locate-library "loaddefs"))) - (goto-char (point-min)) - (let (file) - (while - (search-forward "\n;;; Generated autoloads from " nil t) - (goto-char (match-end 0)) - (setq file (buffer-substring (point) - (progn (end-of-line) (point)))) - ;; If it is, load that library. - (when file - (setq file (file-name-nondirectory file)) - (when (string-match "\\.el\\'" file) - (setq file (substring file 0 (match-beginning 0))))) - (condition-case alpha - (unless (member file cus-test-libs-noloads) - (load-library file) - (push file cus-test-libs-loaded)) - (error - (push (cons file alpha) cus-test-libs-errors) - (message "Error for %s: %s" file alpha))))) - (message "Cus Test Libs loaded %s files." - (length cus-test-libs-loaded)) - (if cus-test-libs-errors - (message "The following load problems appeared:\n%s" - cus-test-libs-errors) - (message "No load problems encountered by Cus Test Libs")) - (run-hooks 'cus-test-after-load-libs-hook)) + (with-temp-buffer + (setq cus-test-libs-errors nil) + (setq cus-test-libs-loaded nil) + (cd source-directory) + (if (not (file-executable-p "src/emacs")) + (error "No Emacs executable in %ssrc" default-directory)) + (mapc + (lambda (file) + (condition-case alpha + (let (fn cmd status) + (setq fn (locate-library file)) + (if (not fn) + (error "Library %s not found" file)) + (setq cmd (concat "src/emacs -batch -l " fn)) + (setq status (call-process shell-file-name nil nil nil + shell-command-switch cmd)) + (if (equal status 0) + (message "%s" file) + (error "%s" status)) + (push file cus-test-libs-loaded)) + (error + (push (cons file alpha) cus-test-libs-errors) + (message "Error for %s: %s" file alpha)))) + (cus-test-get-autoload-deps)) + (message "Default Directory: %s" default-directory) + (message "%s libraries had no load errors" + (length cus-test-libs-loaded)) + (if (not cus-test-libs-errors) + (message "No load problems encountered") + (message "The following load problems appeared:") + (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)