;;; derived.el --- allow inheritance of major modes
;; (formerly mode-clone.el)
-;; Copyright (C) 1993, 1994, 1999, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007 Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1994, 1999, 2001, 2002, 2003, 2004, 2005, 2006,
+;; 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
;; Author: David Megginson (dmeggins@aix1.uottawa.ca)
;; Maintainer: FSF
;; 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
;; 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., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
\f
;;; Commentary:
See Info node `(elisp)Derived Modes' for more details."
(declare (debug (&define name symbolp sexp [&optional stringp]
- [&rest keywordp sexp] def-body)))
+ [&rest keywordp sexp] def-body))
+ (doc-string 4))
(when (and docstring (not (stringp docstring)))
;; Some trickiness, since what appears to be the docstring may really be
parent child docstring syntax abbrev))
`(progn
- (unless (get ',hook 'variable-documentation)
+ (unless (get ',hook 'variable-documentation)
(put ',hook 'variable-documentation
- ,(format "Hook run when entering %s mode.
+ (purecopy ,(format "Hook run when entering %s mode.
No problems result if this variable is not bound.
`add-hook' automatically binds it. (This is true for all hook variables.)"
- name)))
+ name))))
(unless (boundp ',map)
(put ',map 'definition-name ',child))
(defvar ,map (make-sparse-keymap))
+ (unless (get ',map 'variable-documentation)
+ (put ',map 'variable-documentation
+ (purecopy ,(format "Keymap for `%s'." child))))
,(if declare-syntax
`(progn
(unless (boundp ',syntax)
(put ',syntax 'definition-name ',child))
- (defvar ,syntax (make-syntax-table))))
+ (defvar ,syntax (make-syntax-table))
+ (unless (get ',syntax 'variable-documentation)
+ (put ',syntax 'variable-documentation
+ (purecopy ,(format "Syntax table for `%s'." child))))))
,(if declare-abbrev
`(progn
(put ',abbrev 'definition-name ',child)
(defvar ,abbrev
- (progn (define-abbrev-table ',abbrev nil) ,abbrev))))
+ (progn (define-abbrev-table ',abbrev nil) ,abbrev))
+ (unless (get ',abbrev 'variable-documentation)
+ (put ',abbrev 'variable-documentation
+ (purecopy ,(format "Abbrev table for `%s'." child))))))
(put ',child 'derived-mode-parent ',parent)
,(if group `(put ',child 'custom-mode-group ,group))