summaryrefslogtreecommitdiff
path: root/test/lisp/help-fns-tests.el
diff options
context:
space:
mode:
Diffstat (limited to 'test/lisp/help-fns-tests.el')
-rw-r--r--test/lisp/help-fns-tests.el121
1 files changed, 121 insertions, 0 deletions
diff --git a/test/lisp/help-fns-tests.el b/test/lisp/help-fns-tests.el
new file mode 100644
index 00000000000..ba0d8ed8e38
--- /dev/null
+++ b/test/lisp/help-fns-tests.el
@@ -0,0 +1,121 @@
+;;; help-fns.el --- tests for help-fns.el
+
+;; Copyright (C) 2014-2016 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 <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;;; Code:
+
+(require 'ert)
+
+(autoload 'help-fns-test--macro "help-fns" nil nil t)
+
+
+;;; 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 http://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 http://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))))
+
+
+;;; 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)"))))
+
+
+;;; 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.el ends here