(sgml-tag-alist): Doc fix.

[gnu-emacs] / lisp / derived.el

diff --git a/lisp/derived.el b/lisp/derived.el
index 9512bae492fe779f953eb71b956d378af109a307..3586affe216448ac04b093d779833ae6b6786fbe 100644 (file)
--- a/lisp/derived.el
+++ b/lisp/derived.el
@@ -81,7 +81,7 @@
 ;;
 ;;   (define-derived-mode html-mode hypertext-mode "HTML")
 ;;   [various key definitions]
-;; 
+;;
 ;; will add a new major mode for HTML with very little fuss.
 ;;
 ;; Note also the function `derived-mode-p' which can tell if the current
@@ -91,6 +91,24 @@
 \f
 ;;; Code:
 
+;;; PRIVATE: defsubst must be defined before they are first used
+
+(defsubst derived-mode-hook-name (mode)
+  "Construct the mode hook name based on mode name MODE."
+  (intern (concat (symbol-name mode) "-hook")))
+
+(defsubst derived-mode-map-name (mode)
+  "Construct a map name based on a MODE name."
+  (intern (concat (symbol-name mode) "-map")))
+
+(defsubst derived-mode-syntax-table-name (mode)
+  "Construct a syntax-table name based on a MODE name."
+  (intern (concat (symbol-name mode) "-syntax-table")))
+
+(defsubst derived-mode-abbrev-table-name (mode)
+  "Construct an abbrev-table name based on a MODE name."
+  (intern (concat (symbol-name mode) "-abbrev-table")))
+
 ;; PUBLIC: define a new major mode which inherits from an existing one.
 
 ;;;###autoload
@@ -106,7 +124,7 @@ NAME:      a string which will appear in the status line (e.g. \"Hypertext\")
 DOCSTRING: an optional documentation string--if you do not supply one,
            the function will attempt to invent something useful.
 BODY:      forms to execute just before running the
-           hooks for the new mode.
+           hooks for the new mode.  Do not use `interactive' here.
 
 Here is how you could define LaTeX-Thesis mode as a variant of LaTeX mode:
 
@@ -139,19 +157,19 @@ been generated automatically, with a reference to the keymap."
        (abbrev (derived-mode-abbrev-table-name child))
        (hook (derived-mode-hook-name child))
        (docstring (derived-mode-make-docstring parent child docstring)))
-        
+
     `(progn
        (defvar ,map (make-sparse-keymap))
        (defvar ,syntax (make-syntax-table))
-       (defvar ,abbrev)
-       (define-abbrev-table ',abbrev nil)
+       (defvar ,abbrev
+        (progn (define-abbrev-table ',abbrev nil) ,abbrev))
        (put ',child 'derived-mode-parent ',parent)
-     
+
        (defun ,child ()
         ,docstring
         (interactive)
                                        ; Run the parent.
-        ;; (combine-run-hooks
+        (delay-mode-hooks
 
          (,(or parent 'kill-all-local-variables))
                                        ; Identify the child mode.
@@ -175,25 +193,15 @@ been generated automatically, with a reference to the keymap."
                         (define-abbrev ,abbrev (symbol-name symbol)
                           (symbol-value symbol) (symbol-function symbol))))
                   local-abbrev-table))))
-       
+
          (use-local-map ,map)
          (set-syntax-table ,syntax)
          (setq local-abbrev-table ,abbrev)
                                        ; Splice in the body (if any).
          ,@body
-         ;; )
+         )
                                        ; Run the hooks, if any.
-        (run-hooks ',hook)))))
-
-;; PUBLIC: find if the current mode derives from another.
-
-(defun derived-mode-p (&rest modes)
-  "Non-nil if the current major mode is derived from one of MODES.
-Uses the `derived-mode-parent' property of the symbol to trace backwards."
-  (let ((parent major-mode))
-    (while (and (not (memq parent modes))
-               (setq parent (get parent 'derived-mode-parent))))
-    parent))
+        (run-mode-hooks ',hook)))))
 
 ;; PUBLIC: find the ultimate class of a derived mode.
 
@@ -210,22 +218,6 @@ this function is not very useful.  Use `derived-mode-p' instead."
 \f
 ;;; PRIVATE
 
-(defsubst derived-mode-hook-name (mode)
-  "Construct the mode hook name based on mode name MODE."
-  (intern (concat (symbol-name mode) "-hook")))
-
-(defsubst derived-mode-map-name (mode)
-  "Construct a map name based on a MODE name."
-  (intern (concat (symbol-name mode) "-map")))
-
-(defsubst derived-mode-syntax-table-name (mode)
-  "Construct a syntax-table name based on a MODE name."
-  (intern (concat (symbol-name mode) "-syntax-table")))
-
-(defsubst derived-mode-abbrev-table-name (mode)
-  "Construct an abbrev-table name based on a MODE name."
-  (intern (concat (symbol-name mode) "-abbrev-table")))
-
 (defun derived-mode-make-docstring (parent child &optional docstring)
   "Construct a docstring for a new mode if none is provided."
 
@@ -248,7 +240,7 @@ abbrev table and syntax table:
 
 which more-or-less shadow %s's corresponding tables."
                      parent map abbrev syntax parent))))
-  
+
     (unless (string-match (regexp-quote (symbol-name hook)) docstring)
       ;; Make sure the docstring mentions the mode's hook
       (setq docstring
@@ -263,7 +255,7 @@ which more-or-less shadow %s's corresponding tables."
                       "might have run,\nthis mode "))
                    (format "runs the hook `%s'" hook)
                    ", as the final step\nduring initialization.")))
-    
+
     (unless (string-match "\\\\[{[]" docstring)
       ;; And don't forget to put the mode's keymap
       (setq docstring (concat docstring "\n\n\\{" (symbol-name map) "}")))
@@ -407,7 +399,7 @@ Where the new table already has an entry, nothing is copied from the old one."
             (define-abbrev new (symbol-name symbol)
               (symbol-value symbol) (symbol-function symbol))))
        old)))
-    
+
 (provide 'derived)
 
 ;;; derived.el ends here