-;;; easy-mmode.el --- easy definition
of minor modes .
+;;; easy-mmode.el --- easy definition f minor modes
-;; Copyright (C) 1997
Free Software Foundation, Inc.
+;; Copyright (C) 1997 Free Software Foundation, Inc.
-;; Author: Georges Brun-Cottan <Georges.Brun-Cottan@inria.fr>
+;; Author: Georges Brun-Cottan <Georges.Brun-Cottan@inria.fr>
+;; Maintainer: Stefan Monnier <firstname.lastname@example.org>
This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; This file is part of XEmacs.
+;; XEmacs 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)
GNU Emacs is distributed in the hope that it will be useful,
+;; 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; see the file COPYING. If not, write to the
+;; along with Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
+;;; Synched up with: GNU Emacs 20.7, partially with 21.2.
;; Minor modes are useful and common. This package makes defining a
;; <mode> : The minor mode predicate. A buffer-local variable.
;; <mode>-map : The keymap possibly associated to <mode>.
;; <mode>-hook,<mode>-on-hook,<mode>-off-hook and <mode>-mode:
-;; see `
+;; see `define-minor-mode' documentation
-;; (pp (macroexpand '(
easy-mmode-define-minor-mode <your-mode> <doc>)))
+;; (pp (macroexpand '(define-minor-mode <your-mode> <doc>)))
;; to check the result before using it.
;; The order in which minor modes are installed is important. Keymap
-(defun easy-mmode-define-keymap (keymap-alist &optional menu-name)
- "Return a keymap built from KEYMAP-ALIST.
-KEYMAP-ALIST must be a list of (KEYBINDING . BINDING) where
-KEYBINDING and BINDINGS are suited as for define-key.
-optional MENU-NAME is passed to `make-sparse-keymap'."
- (let ((keymap (make-sparse-keymap menu-name)))
- (function (lambda (bind)
- (car bind) (cdr bind))))
+(eval-when-compile (require 'cl))
(defmacro easy-mmode-define-toggle (mode &optional doc)
"Define a one arg toggle mode MODE function and associated hooks.
-(defmacro easy-mmode-define-minor-mode (mode doc &optional init-value lighter keymap)
+(defalias 'easy-mmode-define-minor-mode 'define-minor-mode)
+(defmacro define-minor-mode (mode doc &optional init-value lighter keymap)
"Define a new minor mode MODE.
-This function defines the associated control variable, keymap,
-toggle command, and hooks (see `easy-mmode-define-toggle').
+This function defines the associated control variable MODE, keymap MODE-map,
+toggle command MODE, and hook MODE-hook.
DOC is the documentation for the mode toggle command.
-Optional LIGHTER is displayed in the mode-bar when the mode is on.
+Optional INIT-VALUE is the initial value of the mode's variable.
+Optional LIGHTER is displayed in the modeline when the mode is on.
Optional KEYMAP is the default (defvar) keymap bound to the mode keymap.
-If it is a list, it is passed to `easy-mmode-define-keymap'
-in order to build a valid keymap.
+ If it is a list, it is passed to `easy-mmode-define-keymap'
+ in order to build a valid keymap. It's generally better to use
+ a separate MODE-map variable than to use this argument.
(MODE DOC &optional INIT-VALUE LIGHTER KEYMAP)...\)"
(cons (cons ',mode ,(intern keymap-name)) minor-mode-map-alist)))) ))
+(if (fboundp 'set-keymap-parents)
+ (defalias 'easy-mmode-set-keymap-parents 'set-keymap-parents)
+ (defun easy-mmode-set-keymap-parents (m parents)
+ ((not (consp parents)) parents)
+ ((not (cdr parents)) (car parents))
+ (t (let ((m (copy-keymap (pop parents))))
+ (easy-mmode-set-keymap-parents m parents)
+(defun easy-mmode-define-keymap (bs &optional name m args)
+ "Return a keymap built from bindings BS.
+BS must be a list of (KEY . BINDING) where
+KEY and BINDINGS are suitable for `define-key'.
+Optional NAME is passed to `make-sparse-keymap'.
+Optional map M can be used to modify an existing map.
+ARGS is a list of additional keyword arguments."
+ (let (inherit dense suppress)
+ (:name (setq name val))
+ (:dense (setq dense val))
+ (:inherit (setq inherit val))
+ ;;((eq key :suppress) (setq suppress val))
+ (t (message "Unknown argument %s in defmap" key)))))
+ (setq bs (append m bs))
+ (setq m (if dense (make-keymap name) (make-sparse-keymap name))))
+ (dolist (key (if (consp keys) keys (list keys)))
+ (substitute-key-definition key binding m global-map))
+ (unless (keymapp (lookup-key m key)) (define-key m key binding)))
+ ((let ((o (lookup-key m key)))
+ (or (null o) (numberp o) (eq o 'undefined)))
+ (define-key m key binding))))))
+ ((keymapp inherit) (set-keymap-parent m inherit))
+ ((consp inherit) (easy-mmode-set-keymap-parents m inherit)))
+(defmacro easy-mmode-defmap (m bs doc &rest args)
+ (easy-mmode-define-keymap ,bs nil (if (boundp ',m) ,m) ,(cons 'list args))
+;; XEmacs change: autoload
+(defmacro easy-mmode-define-navigation (base re &optional name endfun)
+ "Define BASE-next and BASE-prev to navigate in the buffer.
+RE determines the places the commands should move point to.
+NAME should describe the entities matched by RE. It is used to build
+ the docstrings of the two functions.
+BASE-next also tries to make sure that the whole entry is visible by
+ searching for its end (by calling ENDFUN if provided or by looking for
+ the next entry) and recentering if necessary.
+ENDFUN should return the end position (with or without moving point)."
+ (let* ((base-name (symbol-name base))
+ (prev-sym (intern (concat base-name "-prev")))
+ (next-sym (intern (concat base-name "-next"))))
+ (unless name (setq name (symbol-name base-name)))
+ (add-to-list 'debug-ignored-errors
+ ,(concat "^No \\(previous\\|next\\) " (regexp-quote name)))
+ (defun ,next-sym (&optional count)
+ ,(format "Go to the next COUNT'th %s." name)
+ (unless count (setq count 1))
+ (if (< count 0) (,prev-sym (- count))
+ (if (looking-at ,re) (incf count))
+ (if (not (re-search-forward ,re nil t count))
+ (goto-char (or ,(if endfun `(,endfun)) (point-max)))
+ (error ,(format "No next %s" name)))
+ (goto-char (match-beginning 0))
+ (when (and (eq (current-buffer) (window-buffer (selected-window)))
+ (let ((endpt (or (save-excursion
+ `(re-search-forward ,re nil t 2)))
+ ;; XEmacs change: only 2 args to pos-visible-in-window-p
+ (unless (pos-visible-in-window-p endpt nil)
+ (defun ,prev-sym (&optional count)
+ ,(format "Go to the previous COUNT'th %s" (or name base-name))
+ (unless count (setq count 1))
+ (if (< count 0) (,next-sym (- count))
+ (unless (re-search-backward ,re nil t count)
+ (error ,(format "No previous %s" name))))))))
;;; easy-mmode.el ends here