-;;; 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, 1995 Free Software Foundation, Inc.
+;; Copyright (C) 1986, 1987, 1994, 1995, 2002, 2003,
+;; 2004, 2005, 2006 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., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, 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)
+(defun sort-subr (reverse nextrecfun endrecfun
+ &optional startkeyfun endkeyfun predicate)
"General text sorting routine to divide buffer into records and sort them.
-Arguments are REVERSE NEXTRECFUN ENDRECFUN &optional STARTKEYFUN ENDKEYFUN.
We divide the accessible portion of the buffer into disjoint pieces
called sort records. A portion of each sort record (perhaps all of
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.
ENDKEYFUN moves from the start of the sort key to the end of the sort key.
ENDKEYFUN may be nil if STARTKEYFUN returns a value or if it would be the
-same as ENDRECFUN."
+same as ENDRECFUN.
+
+PREDICATE is the function to use to compare keys. If keys are numbers,
+it defaults to `<', otherwise it defaults to `string<'."
;; Heuristically try to avoid messages if sorting a small amt of text.
(let ((messages (> (- (point-max) (point-min)) 50000)))
(save-excursion
(or reverse (setq sort-lists (nreverse sort-lists)))
(if messages (message "Sorting records..."))
(setq sort-lists
- (if (fboundp 'sortcar)
- (sortcar sort-lists
- (cond ((numberp (car (car sort-lists)))
- ;; This handles both ints and floats.
- '<)
- ((consp (car (car sort-lists)))
- (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)))
- 'car-less-than-car)
- ((consp (car (car sort-lists)))
- (function
- (lambda (a b)
- (> 0 (compare-buffer-substrings
- nil (car (car a)) (cdr (car a))
- nil (car (car b)) (cdr (car b)))))))
- (t
- (function
- (lambda (a b)
- (string< (car a) (car b)))))))))
+ (sort sort-lists
+ (cond (predicate
+ `(lambda (a b) (,predicate (car a) (car b))))
+ ((numberp (car (car sort-lists)))
+ 'car-less-than-car)
+ ((consp (car (car sort-lists)))
+ (lambda (a b)
+ (> 0 (compare-buffer-substrings
+ nil (car (car a)) (cdr (car a))
+ nil (car (car b)) (cdr (car b))))))
+ (t
+ (lambda (a b) (string< (car a) (car b)))))))
(if reverse (setq sort-lists (nreverse sort-lists)))
(if messages (message "Reordering buffer..."))
(sort-reorder-buffer sort-lists old)))
(cond ((prog1 done (setq done nil)))
(endrecfun (funcall endrecfun))
(nextrecfun (funcall nextrecfun) (setq done t)))
- (if key (setq sort-lists (cons
- ;; consing optimization in case in which key
- ;; is same as record.
- (if (and (consp key)
- (equal (car key) start-rec)
- (equal (cdr key) (point)))
- (cons key key)
- (cons key (cons start-rec (point))))
- sort-lists)))
+ (if key (push
+ ;; consing optimization in case in which key is same as record.
+ (if (and (consp key)
+ (equal (car key) start-rec)
+ (equal (cdr key) (point)))
+ (cons key key)
+ (cons key (cons start-rec (point))))
+ sort-lists))
(and (not done) nextrecfun (funcall nextrecfun)))
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
+ (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)
- last
- (nth 1 (car 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
+ ;; saves any markers at the end of the sorted region,
+ ;; by leaving the last character of the region.
+ (delete-region min (1- max))
+ ;; Now replace the one remaining old character with the sorted text.
+ (goto-char (point-min))
+ (insert-buffer-substring temp-buffer)
+ (delete-region max (1+ max))))))
;;;###autoload
-(defun sort-lines (reverse beg end)
+(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
(narrow-to-region beg end)
(goto-char (point-min))
- (sort-subr reverse 'forward-line 'end-of-line))))
+ (let ;; To make `end-of-line' and etc. to ignore fields.
+ ((inhibit-field-text-motion t))
+ (sort-subr reverse 'forward-line 'end-of-line)))))
;;;###autoload
(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))))))
- nil))
+ (let ;; To make `end-of-line' and etc. to ignore fields.
+ ((inhibit-field-text-motion t))
+ (sort-fields-1 field beg end
+ (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
;;(defun sort-float-fields (field beg end)
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 ()
- (sort-skip-fields field)
- nil))
- (function (lambda () (skip-chars-forward "^ \t\n")))))
+ (let ;; To make `end-of-line' and etc. to ignore fields.
+ ((inhibit-field-text-motion t))
+ (sort-fields-1 field beg end
+ (function (lambda ()
+ (sort-skip-fields field)
+ nil))
+ (function (lambda () (skip-chars-forward "^ \t\n"))))))
(defun sort-fields-1 (field beg end startkeyfun endkeyfun)
(let ((tbl (syntax-table)))
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*\\\\>\""
;; 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.
- (interactive "P\nsRegexp specifying records to sort:
+ (interactive "P\nsRegexp specifying records to sort:
sRegexp specifying key within record: \nr")
(cond ((or (equal key-regexp "") (equal key-regexp "\\&"))
(setq key-regexp 0))
(goto-char (point-min))
(let (sort-regexp-record-end
(sort-regexp-fields-regexp record-regexp))
- (re-search-forward sort-regexp-fields-regexp)
+ (re-search-forward sort-regexp-fields-regexp nil t)
(setq sort-regexp-record-end (point))
(goto-char (match-beginning 0))
(sort-subr reverse
(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
Use \\[untabify] to convert tabs to spaces before sorting."
(interactive "P\nr")
(save-excursion
- (let (beg1 end1 col-beg1 col-end1 col-start col-end)
+ (let ;; To make `end-of-line' and etc. to ignore fields.
+ ((inhibit-field-text-motion t)
+ beg1 end1 col-beg1 col-end1 col-start col-end)
(goto-char (min beg end))
(setq col-beg1 (current-column))
(beginning-of-line)
(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 (memq system-type '(vax-vms windows-nt))
+ (let ((pos beg1) plist fontified)
+ (catch 'found
+ (while (< pos end1)
+ (setq plist (text-properties-at pos))
+ (setq fontified (plist-get plist 'fontified))
+ (while (consp plist)
+ (unless (or (eq (car plist) 'fontified)
+ (and (eq (car plist) 'face)
+ fontified))
+ (throw 'found t))
+ (setq plist (cddr plist)))
+ (setq pos (next-property-change pos nil 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))
- ;; On VMS, use Emacs's own facilities.
+ ;; Do not use it if there are any non-font-lock properties
+ ;; in the region, since the sort utility would lose the
+ ;; properties.
+ (let ((sort-args (list (if reverse "-rt\n" "-t\n")
+ (format "-k1.%d,1.%d"
+ (1+ col-start)
+ (1+ col-end)))))
+ (when sort-fold-case
+ (push "-f" sort-args))
+ (apply #'call-process-region beg1 end1 "sort" t t nil sort-args))
+ ;; On VMS and ms-windows, 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)
(provide 'sort)
+;;; arch-tag: fbac12be-2a7b-4c8a-9665-264d61f70bd9
;;; sort.el ends here