(bat-generic-mode): "::"-style comments don't
[bpt/emacs.git] / lisp / sort.el
index af7eb37..886d77e 100644 (file)
@@ -1,6 +1,6 @@
 ;;; sort.el --- commands to sort text in an Emacs buffer.
 
-;; Copyright (C) 1986, 1987, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1986, 1987, 1994, 1995 Free Software Foundation, Inc.
 
 ;; Author: Howie Kaye
 ;; Maintainer: FSF
 ;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
 
-;;; This package provides the sorting facilities documented in the Emacs
-;;; user's manual.
+;; 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.")
+(defgroup sort nil
+  "Commands to sort text in an Emacs buffer."
+  :group 'data)
+
+(defcustom sort-fold-case nil
+  "*Non-nil if the buffer sort functions should ignore case."
+  :group 'sort
+  :type 'boolean)
 
 ;;;###autoload
 (defun sort-subr (reverse nextrecfun endrecfun &optional startkeyfun endkeyfun)
@@ -45,6 +52,8 @@ contiguous.
 
 Usually the records are rearranged in order of ascending sort key.
 If REVERSE is non-nil, they are rearranged in order of descending sort key.
+The variable `sort-fold-case' determines whether alphabetic case affects
+the sort order.
 
 The next four arguments are functions to be called to move point
 across a sort record.  They will be called many times from within sort-subr.
@@ -191,7 +200,9 @@ same as ENDRECFUN."
 (defun sort-lines (reverse beg end) 
   "Sort lines in region alphabetically; argument means descending order.
 Called from a program, there are three arguments:
-REVERSE (non-nil means reverse order), BEG and END (region to sort)."
+REVERSE (non-nil means reverse order), BEG and END (region to sort).
+The variable `sort-fold-case' determines whether alphabetic case affects
+the sort order."
   (interactive "P\nr")
   (save-excursion
     (save-restriction
@@ -203,7 +214,9 @@ REVERSE (non-nil means reverse order), BEG and END (region to sort)."
 (defun sort-paragraphs (reverse beg end)
   "Sort paragraphs in region alphabetically; argument means descending order.
 Called from a program, there are three arguments:
-REVERSE (non-nil means reverse order), BEG and END (region to sort)."
+REVERSE (non-nil means reverse order), BEG and END (region to sort).
+The variable `sort-fold-case' determines whether alphabetic case affects
+the sort order."
   (interactive "P\nr")
   (save-excursion
     (save-restriction
@@ -220,7 +233,9 @@ REVERSE (non-nil means reverse order), BEG and END (region to sort)."
 (defun sort-pages (reverse beg end)
   "Sort pages in region alphabetically; argument means descending order.
 Called from a program, there are three arguments:
-REVERSE (non-nil means reverse order), BEG and END (region to sort)."
+REVERSE (non-nil means reverse order), BEG and END (region to sort).
+The variable `sort-fold-case' determines whether alphabetic case affects
+the sort order."
   (interactive "P\nr")
   (save-excursion
     (save-restriction
@@ -292,7 +307,9 @@ FIELD, BEG and END.  BEG and END specify region to sort."
 Fields are separated by whitespace and numbered from 1 up.
 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."
+FIELD, BEG and END.  BEG and END specify region to sort.
+The variable `sort-fold-case' determines whether alphabetic case affects
+the sort order."
   (interactive "p\nr")
   (sort-fields-1 field beg end
                 (function (lambda ()
@@ -373,17 +390,20 @@ 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)
   is to be used for sorting.
-  If it is \"\\digit\" then the digit'th \"\\(...\\)\" match field from
+  If it is \"\\\\digit\" then the digit'th \"\\\\(...\\\\)\" match field from
   RECORD-REGEXP is used.
-  If it is \"\\&\" then the whole record is used.
+  If it is \"\\\\&\" then the whole record is used.
   Otherwise, it is a regular-expression for which to search within the record.
 If a match for KEY is not found within a record then that record is ignored.
 
 With a negative prefix arg sorts in reverse order.
 
+The variable `sort-fold-case' determines whether alphabetic case affects
+the sort order.
+
 For example: to sort lines in the region by the first word on each line
  starting with the letter \"f\",
- RECORD-REGEXP would be \"^.*$\" and KEY would be \"\\=\\<f\\w*\\>\""
+ RECORD-REGEXP would be \"^.*$\" and KEY would be \"\\\\=\\<f\\\\w*\\\\>\""
   ;; using negative prefix arg to mean "reverse" is now inconsistent with
   ;; other sort-.*fields functions but then again this was before, since it
   ;; didn't use the magnitude of the arg to specify anything.
@@ -415,11 +435,8 @@ sRegexp specifying key within record: \nr")
                                        (setq n 0))
                                       (t (throw 'key nil)))
                                 (condition-case ()
-                                    (if (fboundp 'buffer-substring-lessp)
-                                        (cons (match-beginning n)
-                                              (match-end n))
-                                        (buffer-substring (match-beginning n)
-                                                          (match-end n)))
+                                    (cons (match-beginning n)
+                                          (match-end n))
                                   ;; if there was no such register
                                   (error (throw 'key nil)))))))))))
 
@@ -433,6 +450,8 @@ For the purpose of this command, the region includes
 the entire line that point is in and the entire line the mark is in.
 The column positions of point and mark bound the range of columns to sort on.
 A prefix argument means sort into reverse order.
+The variable `sort-fold-case' determines whether alphabetic case affects
+the sort order.
 
 Note that `sort-columns' rejects text that contains tabs,
 because tabs could be split across the specified columns
@@ -454,8 +473,12 @@ Use \\[untabify] to convert tabs to spaces before sorting."
       (setq col-end (max col-beg1 col-end1))
       (if (search-backward "\t" beg1 t)
          (error "sort-columns does not work with tabs.  Use M-x untabify."))
-      (if (not (eq system-type 'vax-vms))
+      (if (not (or (eq system-type 'vax-vms)
+                  (text-properties-at beg1)
+                  (< (next-property-change beg1 nil end1) end1)))
          ;; Use the sort utility if we can; it is 4 times as fast.
+         ;; Do not use it if there are any properties in the region,
+         ;; since the sort utility would lose the properties.
          (call-process-region beg1 end1 "sort" t t nil
                               (if reverse "-rt\n" "-t\n")
                               (concat "+0." col-start)