(listify-key-sequence-1, event-modifiers): Don't presume internal bit layout
[bpt/emacs.git] / lisp / sort.el
index 4405b6e..11e87a1 100644 (file)
@@ -1,6 +1,6 @@
 ;;; sort.el --- commands to sort text in an Emacs buffer.
 
-;; Copyright (C) 1986, 1987 Free Software Foundation, Inc.
+;; Copyright (C) 1986, 1987, 1994 Free Software Foundation, Inc.
 
 ;; Author: Howie Kaye
 ;; Maintainer: FSF
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;;; This package provides the sorting facilities documented in the Emacs
+;;; user's manual.
+
 ;;; Code:
 
+(defvar sort-fold-case nil
+  "*Non-nil if the buffer sort functions should ignore case.")
+
+;;;###autoload
 (defun sort-subr (reverse nextrecfun endrecfun &optional startkeyfun endkeyfun)
   "General text sorting routine to divide buffer into records and sort them.
 Arguments are REVERSE NEXTRECFUN ENDRECFUN &optional STARTKEYFUN ENDKEYFUN.
@@ -46,11 +55,11 @@ It should move point to the end of the buffer if there are no more records.
 The first record is assumed to start at the position of point when sort-subr
 is called.
 
-ENDRECFUN is is called with point within the record.
+ENDRECFUN is called with point within the record.
 It should move point to the end of the record.
 
-STARTKEYFUN may moves from the start of the record to the start of the key.
-It may return either return a non-nil value to be used as the key, or
+STARTKEYFUN moves from the start of the record to the start of the key.
+It may return either a non-nil value to be used as the key, or
 else the key is the substring between the values of point after
 STARTKEYFUN and ENDKEYFUN are called.  If STARTKEYFUN is nil, the key
 starts at the beginning of the record.
@@ -64,7 +73,8 @@ same as ENDRECFUN."
       (if messages (message "Finding sort keys..."))
       (let* ((sort-lists (sort-build-lists nextrecfun endrecfun
                                           startkeyfun endkeyfun))
-            (old (reverse sort-lists)))
+            (old (reverse sort-lists))
+            (case-fold-search sort-fold-case))
        (if (null sort-lists)
            ()
          (or reverse (setq sort-lists (nreverse sort-lists)))
@@ -76,18 +86,22 @@ same as ENDRECFUN."
                                    ;; This handles both ints and floats.
                                    '<)
                                   ((consp (car (car sort-lists)))
-                                   'buffer-substring-lessp)
+                                   (function
+                                    (lambda (a b)
+                                      (> 0 (compare-buffer-substrings 
+                                            nil (car a) (cdr a)
+                                            nil (car b) (cdr b))))))
                                   (t
                                    'string<)))
                  (sort sort-lists
                        (cond ((numberp (car (car sort-lists)))
-                              (function
-                               (lambda (a b)
-                                 (< (car a) (car b)))))
+                              'car-less-than-car)
                              ((consp (car (car sort-lists)))
                               (function
                                (lambda (a b)
-                                 (buffer-substring-lessp (car a) (car b)))))
+                                 (> 0 (compare-buffer-substrings 
+                                       nil (car (car a)) (cdr (car a))
+                                       nil (car (car b)) (cdr (car b)))))))
                              (t
                               (function
                                (lambda (a b)
@@ -123,9 +137,7 @@ same as ENDRECFUN."
                      (let ((start (point)))
                        (funcall (or endkeyfun
                                     (prog1 endrecfun (setq done t))))
-                       (if (fboundp 'buffer-substring-lessp)
-                           (cons start (point))
-                         (buffer-substring start (point)))))))
+                       (cons start (point))))))
       ;; Move to end of this record (start of next one, or end of buffer).
       (cond ((prog1 done (setq done nil)))
            (endrecfun (funcall endrecfun))
@@ -198,7 +210,10 @@ REVERSE (non-nil means reverse order), BEG and END (region to sort)."
       (narrow-to-region beg end)
       (goto-char (point-min))
       (sort-subr reverse
-                (function (lambda () (skip-chars-forward "\n \t\f")))
+                (function
+                 (lambda ()
+                   (while (and (not (eobp)) (looking-at paragraph-separate))
+                     (forward-line 1))))
                 'forward-paragraph))))
 
 ;;;###autoload
@@ -239,8 +254,8 @@ FIELD, BEG and END.  BEG and END specify region to sort."
   (interactive "p\nr")
   (sort-fields-1 field beg end
                 (function (lambda ()
-                            (sort-skip-fields (1- field))
-                            (string-to-int
+                            (sort-skip-fields field)
+                            (string-to-number
                              (buffer-substring
                                (point)
                                (save-excursion
@@ -250,25 +265,26 @@ FIELD, BEG and END.  BEG and END specify region to sort."
                                  (point))))))
                 nil))
 
-(defun sort-float-fields (field beg end)
-  "Sort lines in region numerically by the ARGth field of each line.
-Fields are separated by whitespace and numbered from 1 up.  Specified field
-must contain a floating point number in each line of the region.  With a
-negative arg, sorts by the ARGth field counted from the right.  Called from a
-program, there are three arguments: FIELD, BEG and END.  BEG and END specify
-region to sort."
-  (interactive "p\nr")
-  (sort-fields-1 field beg end
-                (function (lambda ()
-                            (sort-skip-fields (1- field))
-                            (string-to-float
-                             (buffer-substring
-                              (point)
-                              (save-excursion
-                                (re-search-forward
-                                 "[+-]?[0-9]*\.?[0-9]*\\([eE][+-]?[0-9]+\\)?")
-                                (point))))))
-                nil))
+;;;;;###autoload
+;;(defun sort-float-fields (field beg end)
+;;  "Sort lines in region numerically by the ARGth field of each line.
+;;Fields are separated by whitespace and numbered from 1 up.  Specified field
+;;must contain a floating point number in each line of the region.  With a
+;;negative arg, sorts by the ARGth field counted from the right.  Called from a
+;;program, there are three arguments: FIELD, BEG and END.  BEG and END specify
+;;region to sort."
+;;  (interactive "p\nr")
+;;  (sort-fields-1 field beg end
+;;              (function (lambda ()
+;;                          (sort-skip-fields field)
+;;                          (string-to-number
+;;                           (buffer-substring
+;;                            (point)
+;;                            (save-excursion
+;;                              (re-search-forward
+;;                               "[+-]?[0-9]*\.?[0-9]*\\([eE][+-]?[0-9]+\\)?")
+;;                              (point))))))
+;;              nil))
 
 ;;;###autoload
 (defun sort-fields (field beg end)
@@ -280,7 +296,7 @@ FIELD, BEG and END.  BEG and END specify region to sort."
   (interactive "p\nr")
   (sort-fields-1 field beg end
                 (function (lambda ()
-                            (sort-skip-fields (1- field))
+                            (sort-skip-fields field)
                             nil))
                 (function (lambda () (skip-chars-forward "^ \t\n")))))
 
@@ -298,25 +314,42 @@ FIELD, BEG and END.  BEG and END specify region to sort."
                       startkeyfun endkeyfun)))
       (set-syntax-table tbl))))
 
+;; Position at the beginning of field N on the current line,
+;; assuming point is initially at the beginning of the line.
 (defun sort-skip-fields (n)
-  (let ((bol (point))
-       (eol (save-excursion (end-of-line 1) (point))))
-    (if (> n 0) (forward-word n)
-      (end-of-line)
-      (forward-word (1+ n)))
-    (if (or (and (>= (point) eol) (> n 0))
-           ;; this is marginally wrong; if the first line of the sort
-           ;; at bob has the wrong number of fields the error won't be
-           ;; reported until the next short line.
-           (and (< (point) bol) (< n 0)))
+  (if (> n 0)
+      ;; Skip across N - 1 fields.
+      (let ((i (1- n)))
+       (while (> i 0)
+         (skip-chars-forward " \t")
+         (skip-chars-forward "^ \t\n")
+         (setq i (1- i)))
+       (skip-chars-forward " \t")
+       (if (eolp)
+           (error "Line has too few fields: %s"
+                  (buffer-substring
+                   (save-excursion (beginning-of-line) (point))
+                   (save-excursion (end-of-line) (point))))))
+    (end-of-line)
+    ;; Skip back across - N - 1 fields.
+    (let ((i (1- (- n))))
+      (while (> i 0)
+       (skip-chars-backward " \t")
+       (skip-chars-backward "^ \t\n")
+       (setq i (1- i)))
+      (skip-chars-backward " \t"))
+    (if (bolp)
        (error "Line has too few fields: %s"
-              (buffer-substring bol eol)))
-    (skip-chars-forward " \t")))
-
+              (buffer-substring
+               (save-excursion (beginning-of-line) (point))
+               (save-excursion (end-of-line) (point)))))
+    ;; Position at the front of the field
+    ;; even if moving backwards.
+    (skip-chars-backward "^ \t\n")))
 \f
 ;;;###autoload
 (defun sort-regexp-fields (reverse record-regexp key-regexp beg end)
-  "Sort the region lexicographically as specifed by RECORD-REGEXP and KEY.
+  "Sort the region lexicographically as specified by RECORD-REGEXP and KEY.
 RECORD-REGEXP specifies the textual units which should be sorted.
   For example, to sort lines RECORD-REGEXP would be \"^.*$\"
 KEY specifies the part of each record (ie each match for RECORD-REGEXP)