(completion-fixup-function): Variable deleted.

[bpt/emacs.git] / lisp / imenu.el

diff --git a/lisp/imenu.el b/lisp/imenu.el
index e10e703..2f353e1 100644 (file)
--- a/lisp/imenu.el
+++ b/lisp/imenu.el
@@ -116,6 +116,7 @@ Another non-nil value means always display the index in a completion buffer."
                 (other :tag "Always" t))
   :group 'imenu)
 
+;;;###autoload
 (defcustom imenu-sort-function nil
   "*The function to use for sorting the index mouse-menu.
 
@@ -127,7 +128,7 @@ in the buffer.
 
 Set it to `imenu--sort-by-name' if you want alphabetic sorting.
 
-The function should take two arguments and return T if the first
+The function should take two arguments and return t if the first
 element should come before the second.  The arguments are cons cells;
 \(NAME . POSITION).  Look at `imenu--sort-by-name' for an example."
   :type '(choice (const :tag "No sorting" nil)
@@ -151,9 +152,9 @@ which case you might as well set this to nil."
                 (const :tag "None" nil))
   :group 'imenu)
 
-(defcustom imenu-space-replacement "^"
+(defcustom imenu-space-replacement "."
   "*The replacement string for spaces in index names.
-Used when presenting the index in a completion-buffer to make the
+Used when presenting the index in a completion buffer to make the
 names work as tokens."
   :type 'string
   :group 'imenu)
@@ -208,6 +209,7 @@ syntax \"word\" syntax during matching.")
 
 ;;;; Hooks
 
+;;;###autoload
 (defvar imenu-create-index-function 'imenu-default-create-index-function
   "The function to use for creating a buffer index.
 
@@ -223,8 +225,10 @@ if it is a sub-alist.
 This function is called within a `save-excursion'.
 
 The variable is buffer-local.")
+;;;###autoload
 (make-variable-buffer-local 'imenu-create-index-function)
 
+;;;###autoload
 (defvar imenu-prev-index-position-function 'beginning-of-defun
   "Function for finding the next index position.
 
@@ -237,9 +241,10 @@ The function should leave point at the place to be connected to the
 index and it should return nil when it doesn't find another index.
 
 This variable is local in all buffers.")
-
+;;;###autoload
 (make-variable-buffer-local 'imenu-prev-index-position-function)
 
+;;;###autoload
 (defvar imenu-extract-index-name-function nil
   "Function for extracting the index item name, given a position.
 
@@ -248,12 +253,14 @@ finds a position for an index item, with point at that position.
 It should return the name for that index item.
 
 This variable is local in all buffers.")
-
+;;;###autoload
 (make-variable-buffer-local 'imenu-extract-index-name-function)
 
+;;;###autoload
 (defvar imenu-default-goto-function 'imenu-default-goto-function
   "The default function called when selecting an Imenu item.
 The function in this variable is called when selecting a normal index-item.")
+;;;###autoload
 (make-variable-buffer-local 'imenu-default-goto-function)
 
 
@@ -436,11 +443,14 @@ This variable is local in all buffers, once set.")
 ;;;
 ;;; Sort function
 ;;; Sorts the items depending on their index name.
-;;; An item look like (NAME . POSITION).
+;;; An item looks like (NAME . POSITION).
 ;;;
 (defun imenu--sort-by-name (item1 item2)
   (string-lessp (car item1) (car item2)))
 
+(defun imenu--sort-by-position (item1 item2)
+  (< (cdr item1) (cdr item2)))
+
 (defun imenu--relative-position (&optional reverse)
   ;; Support function to calculate relative position in buffer
   ;; Beginning of buffer is 0 and end of buffer is 100
@@ -807,15 +817,24 @@ PATTERNS."
                                    rest)
                           (cons (match-string-no-properties index)
                                 beg)))
-                       (menu (cdr (assoc menu-title index-alist))))
-                   ;; avoid duplicates from, e.g. cc-mode patterns
-                   (unless (member item menu)
-                     ;; insert the item after the (sub-)menu title
-                     (setcdr (assoc menu-title index-alist)
-                             (cons item menu))))))))
+                       ;; This is the desired submenu,
+                       ;; starting with its title (or nil).
+                       (menu (assoc menu-title index-alist)))
+                   ;; Insert the item unless it is already present.
+                   (unless (member item (cdr menu))
+                     (setcdr menu
+                             (cons item (cdr menu)))))))))
           patterns)
          (set-syntax-table old-table)))
     (imenu-progress-message prev-pos 100 t)
+    ;; Sort each submenu by position.
+    ;; This is in case one submenu gets items from two different regexps.
+    (let ((tail index-alist))
+      (while tail
+       (if (listp (car tail))
+           (setcdr (car tail)
+                   (sort (cdr (car tail)) 'imenu--sort-by-position)))
+       (setq tail (cdr tail))))
     (let ((main-element (assq nil index-alist)))
       (nconc (delq main-element (delq 'dummy index-alist))
             (cdr main-element)))))