-;;; sort.el --- commands to sort text in an Emacs buffer.
+;;; sort.el --- commands to sort text in an Emacs buffer
-;; Copyright (C) 1986, 1987 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.
;;; Code:
+(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)
"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 it)
-is designated as the sort key. The records are rearranged in the buffer
-in order by their sort keys. The records may or may not be contiguous.
+called sort records. A portion of each sort record (perhaps all of
+it) is designated as the sort key. The records are rearranged in the
+buffer in order by their sort keys. The records may or may not be
+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.
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.
(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)))
;; 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)))))
- ((consp (car (car sort-lists)))
- (function
- (lambda (a b)
- (buffer-substring-lessp (car a) (car b)))))
- (t
- (function
- (lambda (a b)
- (string< (car a) (car b)))))))))
+ (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)))))))))
(if reverse (setq sort-lists (nreverse sort-lists)))
(if messages (message "Reordering buffer..."))
(sort-reorder-buffer sort-lists old)))
(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))
(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
(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
(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 (1- field))
- (string-to-int
- (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))
-(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)
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 (1- field))
+ (sort-skip-fields field)
nil))
(function (lambda () (skip-chars-forward "^ \t\n")))))
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
+(defvar sort-regexp-fields-regexp)
+(defvar sort-regexp-record-end)
+
+;; Move to the beginning of the next match for record-regexp,
+;; and set sort-regexp-record-end to the end of that match.
+;; If the next match is empty and does not advance point,
+;; skip one character and try again.
+(defun sort-regexp-fields-next-record ()
+ (let ((oldpos (point)))
+ (and (re-search-forward sort-regexp-fields-regexp nil 'move)
+ (setq sort-regexp-record-end (match-end 0))
+ (if (= sort-regexp-record-end oldpos)
+ (progn
+ (forward-char 1)
+ (re-search-forward sort-regexp-fields-regexp nil 'move)
+ (setq sort-regexp-record-end (match-end 0)))
+ t)
+ (goto-char (match-beginning 0)))))
+
;;;###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)
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.
(save-restriction
(narrow-to-region beg end)
(goto-char (point-min))
- (let (sort-regexp-record-end) ;isn't dynamic scoping wonderful?
- (re-search-forward record-regexp)
+ (let (sort-regexp-record-end
+ (sort-regexp-fields-regexp record-regexp))
+ (re-search-forward sort-regexp-fields-regexp)
(setq sort-regexp-record-end (point))
(goto-char (match-beginning 0))
(sort-subr reverse
- (function (lambda ()
- (and (re-search-forward record-regexp nil 'move)
- (setq sort-regexp-record-end (match-end 0))
- (goto-char (match-beginning 0)))))
+ 'sort-regexp-fields-next-record
(function (lambda ()
(goto-char sort-regexp-record-end)))
(function (lambda ()
(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)
HCoop / bpt / emacs.git / blobdiff