* jit-lock.el (jit-lock-stealth-chunk-start): Fix typo in docstring.

[gnu-emacs] / lisp / msb.el

diff --git a/lisp/msb.el b/lisp/msb.el
index 11c9cfc4d370737f4a831947d34f7cca75eb6013..6bc8254e5e405c85c871d905e8668f40814014b5 100644 (file)
--- a/lisp/msb.el
+++ b/lisp/msb.el
@@ -1,7 +1,7 @@
 ;;; msb.el --- customizable buffer-selection with multiple menus
 
 ;; Copyright (C) 1993, 1994, 1995, 1997, 1998, 1999, 2000, 2001, 2002,
 ;;; msb.el --- customizable buffer-selection with multiple menus
 
 ;; Copyright (C) 1993, 1994, 1995, 1997, 1998, 1999, 2000, 2001, 2002,

-;;   2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
+;;   2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.

 
 ;; Author: Lars Lindberg <lars.lindberg@home.se>
 ;; Maintainer: FSF
 
 ;; Author: Lars Lindberg <lars.lindberg@home.se>
 ;; Maintainer: FSF


@@ -11,10 +11,10 @@
 
 ;; This file is part of GNU Emacs.
 
 
 ;; 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
 ;; it under the terms of the GNU General Public License as published by

-;; the Free Software Foundation; either version 3, 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 Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of


@@ -22,9 +22,7 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
 ;; 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/>.

 
 ;;; Commentary:
 
 
 ;;; Commentary:
 


@@ -190,9 +188,6 @@
      3099
      "Other files (%d)")))
 
      3099
      "Other files (%d)")))
 

-;; msb--many-menus is obsolete
-(defvar msb--many-menus msb--very-many-menus)
-

 ;;;
 ;;; Customizable variables
 ;;;
 ;;;
 ;;; Customizable variables
 ;;;


@@ -211,7 +206,7 @@
       (msb-menu-bar-update-buffers t)))
 
 (defcustom msb-menu-cond msb--very-many-menus
       (msb-menu-bar-update-buffers t)))
 
 (defcustom msb-menu-cond msb--very-many-menus

-  "*List of criteria for splitting the mouse buffer menu.
+  "List of criteria for splitting the mouse buffer menu.

 The elements in the list should be of this type:
  (CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLING-FN ITEM-SORT-FN).
 
 The elements in the list should be of this type:
  (CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLING-FN ITEM-SORT-FN).
 


@@ -235,12 +230,12 @@ A value of nil means don't display this menu.
 MENU-TITLE is really a format.  If you add %d in it, the %d is
 replaced with the number of items in that menu.
 
 MENU-TITLE is really a format.  If you add %d in it, the %d is
 replaced with the number of items in that menu.
 

-ITEM-HANDLING-FN, is optional.  If it is supplied and is a function,
-than it is used for displaying the items in that particular buffer
+ITEM-HANDLING-FN is optional.  If it is supplied and is a function,
+then it is used for displaying the items in that particular buffer

 menu, otherwise the function pointed out by
 `msb-item-handling-function' is used.
 
 menu, otherwise the function pointed out by
 `msb-item-handling-function' is used.
 

-ITEM-SORT-FN, is also optional.
+ITEM-SORT-FN is also optional.

 If it is not supplied, the function pointed out by
 `msb-item-sort-function' is used.
 If it is nil, then no sort takes place and the buffers are presented
 If it is not supplied, the function pointed out by
 `msb-item-sort-function' is used.
 If it is nil, then no sort takes place and the buffers are presented


@@ -269,7 +264,7 @@ error every time you do \\[msb]."
   :version "20.3")
 
 (defcustom msb-separator-diff 100
   :version "20.3")
 
 (defcustom msb-separator-diff 100

-  "*Non-nil means use separators.
+  "Non-nil means use separators.

 The separators will appear between all menus that have a sorting key
 that differs by this value or more."
   :type '(choice integer (const nil))
 The separators will appear between all menus that have a sorting key
 that differs by this value or more."
   :type '(choice integer (const nil))


@@ -280,15 +275,15 @@ that differs by this value or more."
   "*The sort key for files sorted by directory.")
 
 (defcustom msb-max-menu-items 15
   "*The sort key for files sorted by directory.")
 
 (defcustom msb-max-menu-items 15

-  "*The maximum number of items in a menu.
+  "The maximum number of items in a menu.

 If this variable is set to 15 for instance, then the submenu will be
 If this variable is set to 15 for instance, then the submenu will be

-split up in minor parts, 15 items each.  nil means no limit."
+split up in minor parts, 15 items each.  A value of nil means no limit."

   :type '(choice integer (const nil))
   :set 'msb-custom-set
   :group 'msb)
 
 (defcustom msb-max-file-menu-items 10
   :type '(choice integer (const nil))
   :set 'msb-custom-set
   :group 'msb)
 
 (defcustom msb-max-file-menu-items 10

-  "*The maximum number of items from different directories.
+  "The maximum number of items from different directories.

 
 When the menu is of type `file by directory', this is the maximum
 number of buffers that are clumped together from different
 
 When the menu is of type `file by directory', this is the maximum
 number of buffers that are clumped together from different


@@ -303,20 +298,20 @@ If the value is not a number, then the value 10 is used."
   :group 'msb)
 
 (defcustom msb-most-recently-used-sort-key -1010
   :group 'msb)
 
 (defcustom msb-most-recently-used-sort-key -1010

-  "*Where should the menu with the most recently used buffers be placed?"
+  "Where should the menu with the most recently used buffers be placed?"

   :type 'integer
   :set 'msb-custom-set
   :group 'msb)
 
 (defcustom msb-display-most-recently-used 15
   :type 'integer
   :set 'msb-custom-set
   :group 'msb)
 
 (defcustom msb-display-most-recently-used 15

-  "*How many buffers should be in the most-recently-used menu.
+  "How many buffers should be in the most-recently-used menu.

 No buffers at all if less than 1 or nil (or any non-number)."
   :type 'integer
   :set 'msb-custom-set
   :group 'msb)
 
 (defcustom msb-most-recently-used-title "Most recently used (%d)"
 No buffers at all if less than 1 or nil (or any non-number)."
   :type 'integer
   :set 'msb-custom-set
   :group 'msb)
 
 (defcustom msb-most-recently-used-title "Most recently used (%d)"

-  "*The title for the most-recently-used menu."
+  "The title for the most-recently-used menu."

   :type 'string
   :set 'msb-custom-set
   :group 'msb)
   :type 'string
   :set 'msb-custom-set
   :group 'msb)


@@ -325,7 +320,7 @@ No buffers at all if less than 1 or nil (or any non-number)."
   "*Function that specifies how many pixels to shift the top menu leftwards.")
 
 (defcustom msb-display-invisible-buffers-p nil
   "*Function that specifies how many pixels to shift the top menu leftwards.")
 
 (defcustom msb-display-invisible-buffers-p nil

-  "*Show invisible buffers or not.
+  "Show invisible buffers or not.

 Non-nil means that the buffer menu should include buffers that have
 names that starts with a space character."
   :type 'boolean
 Non-nil means that the buffer menu should include buffers that have
 names that starts with a space character."
   :type 'boolean


@@ -336,7 +331,7 @@ names that starts with a space character."
   "*The appearance of a buffer menu.
 
 The default function to call for handling the appearance of a menu
   "*The appearance of a buffer menu.
 
 The default function to call for handling the appearance of a menu

-item.  It should take to arguments, BUFFER and MAX-BUFFER-NAME-LENGTH,
+item.  It should take two arguments, BUFFER and MAX-BUFFER-NAME-LENGTH,

 where the latter is the max length of all buffer names.
 
 The function should return the string to use in the menu.
 where the latter is the max length of all buffer names.
 
 The function should return the string to use in the menu.


@@ -347,7 +342,7 @@ nil as ITEM-HANDLING-FUNCTION.  See `msb-menu-cond' for more
 information.")
 
 (defcustom msb-item-sort-function 'msb-sort-by-name
 information.")
 
 (defcustom msb-item-sort-function 'msb-sort-by-name

-  "*The order of items in a buffer menu.
+  "The order of items in a buffer menu.

 
 The default function to call for handling the order of items in a menu
 item.  This function is called like a sort function.  The items look
 
 The default function to call for handling the order of items in a menu
 item.  This function is called like a sort function.  The items look


@@ -364,7 +359,7 @@ Set this to nil or t if you don't want any sorting (faster)."
   :group 'msb)
 
 (defcustom msb-files-by-directory nil
   :group 'msb)
 
 (defcustom msb-files-by-directory nil

-  "*Non-nil means that files should be sorted by directory.
+  "Non-nil means that files should be sorted by directory.

 This is instead of the groups in `msb-menu-cond'."
   :type 'boolean
   :set 'msb-custom-set
 This is instead of the groups in `msb-menu-cond'."
   :type 'boolean
   :set 'msb-custom-set


@@ -664,7 +659,7 @@ If the argument is left out or nil, then the current buffer is considered."
 (defun msb--create-function-info (menu-cond-elt)
   "Create a vector from an element MENU-COND-ELT of `msb-menu-cond'.
 This takes the form:
 (defun msb--create-function-info (menu-cond-elt)
   "Create a vector from an element MENU-COND-ELT of `msb-menu-cond'.
 This takes the form:

-\]BUFFER-LIST-VARIABLE CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLER SORTER)
+\[BUFFER-LIST-VARIABLE CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLER SORTER]

 See `msb-menu-cond' for a description of its elements."
   (let* ((list-symbol (make-symbol "-msb-buffer-list"))
         (tmp-ih (and (> (length menu-cond-elt) 3)
 See `msb-menu-cond' for a description of its elements."
   (let* ((list-symbol (make-symbol "-msb-buffer-list"))
         (tmp-ih (and (> (length menu-cond-elt) 3)


@@ -727,7 +722,7 @@ See `msb-menu-cond' for a description of its elements."
 (defun msb--add-to-menu (buffer function-info max-buffer-name-length)
   "Add BUFFER to the menu depicted by FUNCTION-INFO.
 All side-effects.  Adds an element of form (BUFFER-TITLE . BUFFER)
 (defun msb--add-to-menu (buffer function-info max-buffer-name-length)
   "Add BUFFER to the menu depicted by FUNCTION-INFO.
 All side-effects.  Adds an element of form (BUFFER-TITLE . BUFFER)

-to the buffer-list variable in function-info."
+to the buffer-list variable in FUNCTION-INFO."

   (let ((list-symbol (aref function-info 0))) ;BUFFER-LIST-VARIABLE
     ;; Here comes the hairy side-effect!
     (set list-symbol
   (let ((list-symbol (aref function-info 0))) ;BUFFER-LIST-VARIABLE
     ;; Here comes the hairy side-effect!
     (set list-symbol


@@ -832,7 +827,8 @@ results in
                 (with-current-buffer buffer
                   (when (and (not (msb-invisible-buffer-p))
                              (not (assq major-mode mode-list)))
                 (with-current-buffer buffer
                   (when (and (not (msb-invisible-buffer-p))
                              (not (assq major-mode mode-list)))

-                    (push (cons major-mode mode-name)
+                    (push (cons major-mode
+                                 (format-mode-line mode-name nil nil buffer))

                           mode-list))))
               mode-list)
             (lambda (item1 item2)
                           mode-list))))
               mode-list)
             (lambda (item1 item2)


@@ -955,13 +951,13 @@ It takes the form ((TITLE . BUFFER-LIST)...)."
                             "*Files by directory*")
                           'msb--toggle-menu-type)))))))
 
                             "*Files by directory*")
                           'msb--toggle-menu-type)))))))
 

-(defun msb--create-buffer-menu  ()
+(defun msb--create-buffer-menu ()

   (save-match-data
     (save-excursion
       (msb--create-buffer-menu-2))))
 
 (defun msb--toggle-menu-type ()
   (save-match-data
     (save-excursion
       (msb--create-buffer-menu-2))))
 
 (defun msb--toggle-menu-type ()

-  "Multi purpose function for selecting a buffer with the mouse."
+  "Multi-purpose function for selecting a buffer with the mouse."

   (interactive)
   (setq msb-files-by-directory (not msb-files-by-directory))
   ;; This gets a warning, but it is correct,
   (interactive)
   (setq msb-files-by-directory (not msb-files-by-directory))
   ;; This gets a warning, but it is correct,


@@ -1104,7 +1100,7 @@ variable `msb-menu-cond'."
               (f-title  (format "Frames (%d)" frame-length)))
          ;; List only the N most recently selected frames
          (when (and (integerp msb-max-menu-items)
               (f-title  (format "Frames (%d)" frame-length)))
          ;; List only the N most recently selected frames
          (when (and (integerp msb-max-menu-items)

-                    (>  msb-max-menu-items 1)
+                    (> msb-max-menu-items 1)

                     (> frame-length msb-max-menu-items))
            (setcdr (nthcdr msb-max-menu-items frames) nil))
          (setq frames-menu
                     (> frame-length msb-max-menu-items))
            (setcdr (nthcdr msb-max-menu-items frames) nil))
          (setq frames-menu


@@ -1149,9 +1145,11 @@ different buffer menu using the function `msb'."
     (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
     (menu-bar-update-buffers t)))
 
     (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
     (menu-bar-update-buffers t)))
 

-(defun msb-unload-hook ()
-  (msb-mode 0))
-(add-hook 'msb-unload-hook 'msb-unload-hook)
+(defun msb-unload-function ()
+  "Unload the Msb library."
+  (msb-mode -1)
+  ;; continue standard unloading
+  nil)

 
 (provide 'msb)
 (eval-after-load "msb" '(run-hooks 'msb-after-load-hook 'msb-after-load-hooks))
 
 (provide 'msb)
 (eval-after-load "msb" '(run-hooks 'msb-after-load-hook 'msb-after-load-hooks))