-;;; sort.el --- commands to sort text in an Emacs buffer.
+;;; 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)
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.
sort-lists))
(defun sort-reorder-buffer (sort-lists old)
- (let ((inhibit-quit t)
- (last (point-min))
- (min (point-min)) (max (point-max)))
- ;; Make sure insertions done for reordering
- ;; do not go after any markers at the end of the sorted region,
- ;; by inserting a space to separate them.
- (goto-char (point-max))
- (insert-before-markers " ")
- (narrow-to-region min (1- (point-max)))
- (while sort-lists
- (goto-char (point-max))
- (insert-buffer-substring (current-buffer)
- last
- (nth 1 (car old)))
+ (let ((last (point-min))
+ (min (point-min)) (max (point-max))
+ (old-buffer (current-buffer))
+ temp-buffer)
+ (with-temp-buffer
+ ;; Record the temporary buffer.
+ (setq temp-buffer (current-buffer))
+
+ ;; Copy the sorted text into the temporary buffer.
+ (while sort-lists
+ (goto-char (point-max))
+ (insert-buffer-substring old-buffer
+ last
+ (nth 1 (car old)))
+ (goto-char (point-max))
+ (insert-buffer-substring old-buffer
+ (nth 1 (car sort-lists))
+ (cdr (cdr (car sort-lists))))
+ (setq last (cdr (cdr (car old)))
+ sort-lists (cdr sort-lists)
+ old (cdr old)))
(goto-char (point-max))
- (insert-buffer-substring (current-buffer)
- (nth 1 (car sort-lists))
- (cdr (cdr (car sort-lists))))
- (setq last (cdr (cdr (car old)))
- sort-lists (cdr sort-lists)
- old (cdr old)))
- (goto-char (point-max))
- (insert-buffer-substring (current-buffer)
- last
- max)
- ;; Delete the original copy of the text.
- (delete-region min max)
- ;; Get rid of the separator " ".
- (goto-char (point-max))
- (narrow-to-region min (1+ (point)))
- (delete-region (point) (1+ (point)))))
+ (insert-buffer-substring old-buffer last max)
+
+ ;; Copy the reordered text from the temporary buffer
+ ;; to the buffer we sorted (OLD-BUFFER).
+ (set-buffer old-buffer)
+ (let ((inhibit-quit t))
+ ;; Make sure insertions done for reordering
+ ;; do not go after any markers at the end of the sorted region,
+ ;; by inserting a space to separate them.
+ (goto-char max)
+ (insert-before-markers " ")
+ ;; Delete the original copy of the text.
+ (delete-region min max)
+ ;; Now replace the separator " " with the sorted text.
+ (goto-char (point-max))
+ (insert-buffer-substring temp-buffer)
+ (delete-region min (1+ min))))))
;;;###autoload
(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
(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
(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
(modify-syntax-entry ?\. "_" table) ; for floating pt. numbers. -wsr
(setq sort-fields-syntax-table table)))
+(defcustom sort-numeric-base 10
+ "*The default base used by `sort-numeric-fields'."
+ :group 'sort
+ :type 'integer)
+
;;;###autoload
(defun sort-numeric-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 number in each line of the region.
+Specified field must contain a number in each line of the region,
+which may begin with \"0x\" or \"0\" for hexadecimal and octal values.
+Otherwise, the number is interpreted according to sort-numeric-base.
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
- ;; This is just wrong! Even without floats...
- ;; (skip-chars-forward "[0-9]")
- (forward-sexp 1)
- (point))))))
+ (lambda ()
+ (sort-skip-fields field)
+ (let* ((case-fold-search t)
+ (base
+ (if (looking-at "\\(0x\\)[0-9a-f]\\|\\(0\\)[0-7]")
+ (cond ((match-beginning 1)
+ (goto-char (match-end 1))
+ 16)
+ ((match-beginning 2)
+ (goto-char (match-end 2))
+ 8)
+ (t nil)))))
+ (string-to-number (buffer-substring (point)
+ (save-excursion
+ (forward-sexp 1)
+ (point)))
+ (or base sort-numeric-base))))
nil))
;;;;;###autoload
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 ()
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.
(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)))))))))))
;;;###autoload
(defun sort-columns (reverse &optional beg end)
"Sort lines in region alphabetically by a certain range of columns.
-For the purpose of this command, the region includes
+For the purpose of this command, the region BEG...END 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.
+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
(setq col-start (min col-beg1 col-end1))
(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))
+ (error "sort-columns does not work with tabs -- use M-x untabify"))
+ (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.
- (call-process-region beg1 end1 "sort" t t nil
- (if reverse "-rt\n" "-t\n")
- (concat "+0." col-start)
- (concat "-0." col-end))
+ ;; Do not use it if there are any properties in the region,
+ ;; since the sort utility would lose the properties.
+ (let ((sort-args (list (if reverse "-rt\n" "-t\n")
+ (concat "+0." (int-to-string col-start))
+ (concat "-0." (int-to-string col-end)))))
+ (when sort-fold-case
+ (push "-f" sort-args))
+ (apply #'call-process-region beg1 end1 "sort" t t nil sort-args))
;; On VMS, use Emacs's own facilities.
(save-excursion
(save-restriction
(narrow-to-region beg1 end1)
(goto-char beg1)
(sort-subr reverse 'forward-line 'end-of-line
- (function (lambda () (move-to-column col-start) nil))
- (function (lambda () (move-to-column col-end) nil)))))))))
+ #'(lambda () (move-to-column col-start) nil)
+ #'(lambda () (move-to-column col-end) nil))))))))
;;;###autoload
(defun reverse-region (beg end)