1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
| | ;;; help-fns-tests.el --- tests for help-fns.el -*- lexical-binding: t -*-
;; Copyright (C) 2014-2020 Free Software Foundation, Inc.
;; Maintainer: emacs-devel@gnu.org
;; This file is part of GNU Emacs.
;; 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 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
;; 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. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'ert)
(autoload 'help-fns-test--macro "help-fns" nil nil t)
\f
;;; Several tests for describe-function
(defun help-fns-tests--describe-function (func)
"Helper function for `describe-function' tests.
FUNC is the function to describe, a symbol.
Return first line of the output of (describe-function-1 FUNC)."
(let ((string (with-output-to-string
(describe-function-1 func))))
(string-match "\\(.+\\)\n" string)
(match-string-no-properties 1 string)))
(ert-deftest help-fns-test-bug17410 ()
"Test for https://debbugs.gnu.org/17410 ."
(let ((regexp "autoloaded Lisp macro")
(result (help-fns-tests--describe-function 'help-fns-test--macro)))
(should (string-match regexp result))))
(ert-deftest help-fns-test-built-in ()
(let ((regexp "a built-in function in .C source code")
(result (help-fns-tests--describe-function 'mapcar)))
(should (string-match regexp result))))
(ert-deftest help-fns-test-interactive-built-in ()
(let ((regexp "an interactive built-in function in .C source code")
(result (help-fns-tests--describe-function 're-search-forward)))
(should (string-match regexp result))))
(ert-deftest help-fns-test-lisp-macro ()
(let ((regexp "a Lisp macro in .subr\.el")
(result (help-fns-tests--describe-function 'when)))
(should (string-match regexp result))))
(ert-deftest help-fns-test-lisp-defun ()
(let ((regexp "a compiled Lisp function in .subr\.el")
(result (help-fns-tests--describe-function 'last)))
(should (string-match regexp result))))
(ert-deftest help-fns-test-lisp-defsubst ()
(let ((regexp "a compiled Lisp function in .subr\.el")
(result (help-fns-tests--describe-function 'posn-window)))
(should (string-match regexp result))))
(ert-deftest help-fns-test-alias-to-defun ()
(let ((regexp "an alias for .set-file-modes. in .subr\.el")
(result (help-fns-tests--describe-function 'chmod)))
(should (string-match regexp result))))
(ert-deftest help-fns-test-bug23887 ()
"Test for https://debbugs.gnu.org/23887 ."
(let ((regexp "an alias for .re-search-forward. in .subr\.el")
(result (help-fns-tests--describe-function 'search-forward-regexp)))
(should (string-match regexp result))))
(ert-deftest help-fns-test-dangling-alias ()
"Make sure we don't burp on bogus aliases."
(let ((f (make-symbol "bogus-alias")))
(define-obsolete-function-alias f 'help-fns-test--undefined-function "past")
(describe-symbol f)))
\f
;;; Test describe-function over functions with funny names
(defun abc\\\[universal-argument\]b\`c\'d\\e\"f (x)
"A function with a funny name.
\(fn XYZZY)"
x)
(defun defgh\\\[universal-argument\]b\`c\'d\\e\"f (x)
"Another function with a funny name."
x)
(ert-deftest help-fns-test-funny-names ()
"Test for help with functions with funny names."
(describe-function 'abc\\\[universal-argument\]b\`c\'d\\e\"f)
(with-current-buffer "*Help*"
(goto-char (point-min))
(should (search-forward
"(abc\\\\\\[universal-argument\\]b\\`c\\'d\\\\e\\\"f XYZZY)")))
(describe-function 'defgh\\\[universal-argument\]b\`c\'d\\e\"f)
(with-current-buffer "*Help*"
(goto-char (point-min))
(should (search-forward
"(defgh\\\\\\[universal-argument\\]b\\`c\\'d\\\\e\\\"f X)"))))
\f
;;; Test for describe-symbol
(ert-deftest help-fns-test-describe-symbol ()
"Test the `describe-symbol' function."
;; 'describe-symbol' would originally signal an error for
;; 'font-lock-comment-face'.
(describe-symbol 'font-lock-comment-face)
(with-current-buffer "*Help*"
(should (> (point-max) 1))
(goto-char (point-min))
(should (looking-at "^font-lock-comment-face is "))))
;;; help-fns-tests.el ends here
|