lisp/sort.el

   1 ;;; sort.el --- commands to sort text in an Emacs buffer.
   2
   3 ;; Copyright (C) 1986, 1987, 1994, 1995 Free Software Foundation, Inc.
   4
   5 ;; Author: Howie Kaye
   6 ;; Maintainer: FSF
   7 ;; Keywords: unix
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; This package provides the sorting facilities documented in the Emacs
  29 ;; user's manual.
  30
  31 ;;; Code:
  32
  33 (defvar sort-fold-case nil
  34   "*Non-nil if the buffer sort functions should ignore case.")
  35
  36 ;;;###autoload
  37 (defun sort-subr (reverse nextrecfun endrecfun &optional startkeyfun endkeyfun)
  38   "General text sorting routine to divide buffer into records and sort them.
  39 Arguments are REVERSE NEXTRECFUN ENDRECFUN &optional STARTKEYFUN ENDKEYFUN.
  40
  41 We divide the accessible portion of the buffer into disjoint pieces
  42 called sort records.  A portion of each sort record (perhaps all of
  43 it) is designated as the sort key.  The records are rearranged in the
  44 buffer in order by their sort keys.  The records may or may not be
  45 contiguous.
  46
  47 Usually the records are rearranged in order of ascending sort key.
  48 If REVERSE is non-nil, they are rearranged in order of descending sort key.
  49
  50 The next four arguments are functions to be called to move point
  51 across a sort record.  They will be called many times from within sort-subr.
  52
  53 NEXTRECFUN is called with point at the end of the previous record.
  54 It moves point to the start of the next record.
  55 It should move point to the end of the buffer if there are no more records.
  56 The first record is assumed to start at the position of point when sort-subr
  57 is called.
  58
  59 ENDRECFUN is called with point within the record.
  60 It should move point to the end of the record.
  61
  62 STARTKEYFUN moves from the start of the record to the start of the key.
  63 It may return either a non-nil value to be used as the key, or
  64 else the key is the substring between the values of point after
  65 STARTKEYFUN and ENDKEYFUN are called.  If STARTKEYFUN is nil, the key
  66 starts at the beginning of the record.
  67
  68 ENDKEYFUN moves from the start of the sort key to the end of the sort key.
  69 ENDKEYFUN may be nil if STARTKEYFUN returns a value or if it would be the
  70 same as ENDRECFUN."
  71   ;; Heuristically try to avoid messages if sorting a small amt of text.
  72   (let ((messages (> (- (point-max) (point-min)) 50000)))
  73     (save-excursion
  74       (if messages (message "Finding sort keys..."))
  75       (let* ((sort-lists (sort-build-lists nextrecfun endrecfun
  76                                            startkeyfun endkeyfun))
  77              (old (reverse sort-lists))
  78              (case-fold-search sort-fold-case))
  79         (if (null sort-lists)
  80             ()
  81           (or reverse (setq sort-lists (nreverse sort-lists)))
  82           (if messages (message "Sorting records..."))
  83           (setq sort-lists
  84                 (if (fboundp 'sortcar)
  85                     (sortcar sort-lists
  86                              (cond ((numberp (car (car sort-lists)))
  87                                     ;; This handles both ints and floats.
  88                                     '<)
  89                                    ((consp (car (car sort-lists)))
  90                                     (function
  91                                      (lambda (a b)
  92                                        (> 0 (compare-buffer-substrings
  93                                              nil (car a) (cdr a)
  94                                              nil (car b) (cdr b))))))
  95                                    (t
  96                                     'string<)))
  97                   (sort sort-lists
  98                         (cond ((numberp (car (car sort-lists)))
  99                                'car-less-than-car)
 100                               ((consp (car (car sort-lists)))
 101                                (function
 102                                 (lambda (a b)
 103                                   (> 0 (compare-buffer-substrings
 104                                         nil (car (car a)) (cdr (car a))
 105                                         nil (car (car b)) (cdr (car b)))))))
 106                               (t
 107                                (function
 108                                 (lambda (a b)
 109                                   (string< (car a) (car b)))))))))
 110           (if reverse (setq sort-lists (nreverse sort-lists)))
 111           (if messages (message "Reordering buffer..."))
 112           (sort-reorder-buffer sort-lists old)))
 113       (if messages (message "Reordering buffer... Done"))))
 114   nil)
 115
 116 ;; Parse buffer into records using the arguments as Lisp expressions;
 117 ;; return a list of records.  Each record looks like (KEY STARTPOS . ENDPOS)
 118 ;; where KEY is the sort key (a number or string),
 119 ;; and STARTPOS and ENDPOS are the bounds of this record in the buffer.
 120
 121 ;; The records appear in the list lastmost first!
 122
 123 (defun sort-build-lists (nextrecfun endrecfun startkeyfun endkeyfun)
 124   (let ((sort-lists ())
 125         (start-rec nil)
 126         done key)
 127     ;; Loop over sort records.
 128     ;(goto-char (point-min)) -- it is the caller's responsibility to
 129     ;arrange this if necessary
 130     (while (not (eobp))
 131       (setq start-rec (point))          ;save record start
 132       (setq done nil)
 133       ;; Get key value, or move to start of key.
 134       (setq key (catch 'key
 135                   (or (and startkeyfun (funcall startkeyfun))
 136                       ;; If key was not returned as value,
 137                       ;; move to end of key and get key from the buffer.
 138                       (let ((start (point)))
 139                         (funcall (or endkeyfun
 140                                      (prog1 endrecfun (setq done t))))
 141                         (cons start (point))))))
 142       ;; Move to end of this record (start of next one, or end of buffer).
 143       (cond ((prog1 done (setq done nil)))
 144             (endrecfun (funcall endrecfun))
 145             (nextrecfun (funcall nextrecfun) (setq done t)))
 146       (if key (setq sort-lists (cons
 147                                  ;; consing optimization in case in which key
 148                                  ;; is same as record.
 149                                  (if (and (consp key)
 150                                           (equal (car key) start-rec)
 151                                           (equal (cdr key) (point)))
 152                                      (cons key key)
 153                                    (cons key (cons start-rec (point))))
 154                                  sort-lists)))
 155       (and (not done) nextrecfun (funcall nextrecfun)))
 156     sort-lists))
 157
 158 (defun sort-reorder-buffer (sort-lists old)
 159   (let ((inhibit-quit t)
 160         (last (point-min))
 161         (min (point-min)) (max (point-max)))
 162     ;; Make sure insertions done for reordering
 163     ;; do not go after any markers at the end of the sorted region,
 164     ;; by inserting a space to separate them.
 165     (goto-char (point-max))
 166     (insert-before-markers " ")
 167     (narrow-to-region min (1- (point-max)))
 168     (while sort-lists
 169       (goto-char (point-max))
 170       (insert-buffer-substring (current-buffer)
 171                                last
 172                                (nth 1 (car old)))
 173       (goto-char (point-max))
 174       (insert-buffer-substring (current-buffer)
 175                                (nth 1 (car sort-lists))
 176                                (cdr (cdr (car sort-lists))))
 177       (setq last (cdr (cdr (car old)))
 178             sort-lists (cdr sort-lists)
 179             old (cdr old)))
 180     (goto-char (point-max))
 181     (insert-buffer-substring (current-buffer)
 182                              last
 183                              max)
 184     ;; Delete the original copy of the text.
 185     (delete-region min max)
 186     ;; Get rid of the separator " ".
 187     (goto-char (point-max))
 188     (narrow-to-region min (1+ (point)))
 189     (delete-region (point) (1+ (point)))))
 190
 191 ;;;###autoload
 192 (defun sort-lines (reverse beg end)
 193   "Sort lines in region alphabetically; argument means descending order.
 194 Called from a program, there are three arguments:
 195 REVERSE (non-nil means reverse order), BEG and END (region to sort)."
 196   (interactive "P\nr")
 197   (save-excursion
 198     (save-restriction
 199       (narrow-to-region beg end)
 200       (goto-char (point-min))
 201       (sort-subr reverse 'forward-line 'end-of-line))))
 202
 203 ;;;###autoload
 204 (defun sort-paragraphs (reverse beg end)
 205   "Sort paragraphs in region alphabetically; argument means descending order.
 206 Called from a program, there are three arguments:
 207 REVERSE (non-nil means reverse order), BEG and END (region to sort)."
 208   (interactive "P\nr")
 209   (save-excursion
 210     (save-restriction
 211       (narrow-to-region beg end)
 212       (goto-char (point-min))
 213       (sort-subr reverse
 214                  (function
 215                   (lambda ()
 216                     (while (and (not (eobp)) (looking-at paragraph-separate))
 217                       (forward-line 1))))
 218                  'forward-paragraph))))
 219
 220 ;;;###autoload
 221 (defun sort-pages (reverse beg end)
 222   "Sort pages in region alphabetically; argument means descending order.
 223 Called from a program, there are three arguments:
 224 REVERSE (non-nil means reverse order), BEG and END (region to sort)."
 225   (interactive "P\nr")
 226   (save-excursion
 227     (save-restriction
 228       (narrow-to-region beg end)
 229       (goto-char (point-min))
 230       (sort-subr reverse
 231                  (function (lambda () (skip-chars-forward "\n")))
 232                  'forward-page))))
 233 \f
 234 (defvar sort-fields-syntax-table nil)
 235 (if sort-fields-syntax-table nil
 236   (let ((table (make-syntax-table))
 237         (i 0))
 238     (while (< i 256)
 239       (modify-syntax-entry i "w" table)
 240       (setq i (1+ i)))
 241     (modify-syntax-entry ?\  " " table)
 242     (modify-syntax-entry ?\t " " table)
 243     (modify-syntax-entry ?\n " " table)
 244     (modify-syntax-entry ?\. "_" table) ; for floating pt. numbers. -wsr
 245     (setq sort-fields-syntax-table table)))
 246
 247 ;;;###autoload
 248 (defun sort-numeric-fields (field beg end)
 249   "Sort lines in region numerically by the ARGth field of each line.
 250 Fields are separated by whitespace and numbered from 1 up.
 251 Specified field must contain a number in each line of the region.
 252 With a negative arg, sorts by the ARGth field counted from the right.
 253 Called from a program, there are three arguments:
 254 FIELD, BEG and END.  BEG and END specify region to sort."
 255   (interactive "p\nr")
 256   (sort-fields-1 field beg end
 257                  (function (lambda ()
 258                              (sort-skip-fields field)
 259                              (string-to-number
 260                               (buffer-substring
 261                                 (point)
 262                                 (save-excursion
 263                                   ;; This is just wrong! Even without floats...
 264                                   ;; (skip-chars-forward "[0-9]")
 265                                   (forward-sexp 1)
 266                                   (point))))))
 267                  nil))
 268
 269 ;;;;;###autoload
 270 ;;(defun sort-float-fields (field beg end)
 271 ;;  "Sort lines in region numerically by the ARGth field of each line.
 272 ;;Fields are separated by whitespace and numbered from 1 up.  Specified field
 273 ;;must contain a floating point number in each line of the region.  With a
 274 ;;negative arg, sorts by the ARGth field counted from the right.  Called from a
 275 ;;program, there are three arguments: FIELD, BEG and END.  BEG and END specify
 276 ;;region to sort."
 277 ;;  (interactive "p\nr")
 278 ;;  (sort-fields-1 field beg end
 279 ;;               (function (lambda ()
 280 ;;                           (sort-skip-fields field)
 281 ;;                           (string-to-number
 282 ;;                            (buffer-substring
 283 ;;                             (point)
 284 ;;                             (save-excursion
 285 ;;                               (re-search-forward
 286 ;;                                "[+-]?[0-9]*\.?[0-9]*\\([eE][+-]?[0-9]+\\)?")
 287 ;;                               (point))))))
 288 ;;               nil))
 289
 290 ;;;###autoload
 291 (defun sort-fields (field beg end)
 292   "Sort lines in region lexicographically by the ARGth field of each line.
 293 Fields are separated by whitespace and numbered from 1 up.
 294 With a negative arg, sorts by the ARGth field counted from the right.
 295 Called from a program, there are three arguments:
 296 FIELD, BEG and END.  BEG and END specify region to sort."
 297   (interactive "p\nr")
 298   (sort-fields-1 field beg end
 299                  (function (lambda ()
 300                              (sort-skip-fields field)
 301                              nil))
 302                  (function (lambda () (skip-chars-forward "^ \t\n")))))
 303
 304 (defun sort-fields-1 (field beg end startkeyfun endkeyfun)
 305   (let ((tbl (syntax-table)))
 306     (if (zerop field) (setq field 1))
 307     (unwind-protect
 308         (save-excursion
 309           (save-restriction
 310             (narrow-to-region beg end)
 311             (goto-char (point-min))
 312             (set-syntax-table sort-fields-syntax-table)
 313             (sort-subr nil
 314                        'forward-line 'end-of-line
 315                        startkeyfun endkeyfun)))
 316       (set-syntax-table tbl))))
 317
 318 ;; Position at the beginning of field N on the current line,
 319 ;; assuming point is initially at the beginning of the line.
 320 (defun sort-skip-fields (n)
 321   (if (> n 0)
 322       ;; Skip across N - 1 fields.
 323       (let ((i (1- n)))
 324         (while (> i 0)
 325           (skip-chars-forward " \t")
 326           (skip-chars-forward "^ \t\n")
 327           (setq i (1- i)))
 328         (skip-chars-forward " \t")
 329         (if (eolp)
 330             (error "Line has too few fields: %s"
 331                    (buffer-substring
 332                     (save-excursion (beginning-of-line) (point))
 333                     (save-excursion (end-of-line) (point))))))
 334     (end-of-line)
 335     ;; Skip back across - N - 1 fields.
 336     (let ((i (1- (- n))))
 337       (while (> i 0)
 338         (skip-chars-backward " \t")
 339         (skip-chars-backward "^ \t\n")
 340         (setq i (1- i)))
 341       (skip-chars-backward " \t"))
 342     (if (bolp)
 343         (error "Line has too few fields: %s"
 344                (buffer-substring
 345                 (save-excursion (beginning-of-line) (point))
 346                 (save-excursion (end-of-line) (point)))))
 347     ;; Position at the front of the field
 348     ;; even if moving backwards.
 349     (skip-chars-backward "^ \t\n")))
 350 \f
 351 (defvar sort-regexp-fields-regexp)
 352 (defvar sort-regexp-record-end)
 353
 354 ;; Move to the beginning of the next match for record-regexp,
 355 ;; and set sort-regexp-record-end to the end of that match.
 356 ;; If the next match is empty and does not advance point,
 357 ;; skip one character and try again.
 358 (defun sort-regexp-fields-next-record ()
 359   (let ((oldpos (point)))
 360     (and (re-search-forward sort-regexp-fields-regexp nil 'move)
 361          (setq sort-regexp-record-end (match-end 0))
 362          (if (= sort-regexp-record-end oldpos)
 363              (progn
 364                (forward-char 1)
 365                (re-search-forward sort-regexp-fields-regexp nil 'move)
 366                (setq sort-regexp-record-end (match-end 0)))
 367            t)
 368          (goto-char (match-beginning 0)))))
 369
 370 ;;;###autoload
 371 (defun sort-regexp-fields (reverse record-regexp key-regexp beg end)
 372   "Sort the region lexicographically as specified by RECORD-REGEXP and KEY.
 373 RECORD-REGEXP specifies the textual units which should be sorted.
 374   For example, to sort lines RECORD-REGEXP would be \"^.*$\"
 375 KEY specifies the part of each record (ie each match for RECORD-REGEXP)
 376   is to be used for sorting.
 377   If it is \"\\\\digit\" then the digit'th \"\\\\(...\\\\)\" match field from
 378   RECORD-REGEXP is used.
 379   If it is \"\\\\&\" then the whole record is used.
 380   Otherwise, it is a regular-expression for which to search within the record.
 381 If a match for KEY is not found within a record then that record is ignored.
 382
 383 With a negative prefix arg sorts in reverse order.
 384
 385 For example: to sort lines in the region by the first word on each line
 386  starting with the letter \"f\",
 387  RECORD-REGEXP would be \"^.*$\" and KEY would be \"\\\\=\\<f\\\\w*\\\\>\""
 388   ;; using negative prefix arg to mean "reverse" is now inconsistent with
 389   ;; other sort-.*fields functions but then again this was before, since it
 390   ;; didn't use the magnitude of the arg to specify anything.
 391   (interactive "P\nsRegexp specifying records to sort:
 392 sRegexp specifying key within record: \nr")
 393   (cond ((or (equal key-regexp "") (equal key-regexp "\\&"))
 394          (setq key-regexp 0))
 395         ((string-match "\\`\\\\[1-9]\\'" key-regexp)
 396          (setq key-regexp (- (aref key-regexp 1) ?0))))
 397   (save-excursion
 398     (save-restriction
 399       (narrow-to-region beg end)
 400       (goto-char (point-min))
 401       (let (sort-regexp-record-end
 402             (sort-regexp-fields-regexp record-regexp))
 403         (re-search-forward sort-regexp-fields-regexp)
 404         (setq sort-regexp-record-end (point))
 405         (goto-char (match-beginning 0))
 406         (sort-subr reverse
 407                    'sort-regexp-fields-next-record
 408                    (function (lambda ()
 409                                (goto-char sort-regexp-record-end)))
 410                    (function (lambda ()
 411                                (let ((n 0))
 412                                  (cond ((numberp key-regexp)
 413                                         (setq n key-regexp))
 414                                        ((re-search-forward
 415                                           key-regexp sort-regexp-record-end t)
 416                                         (setq n 0))
 417                                        (t (throw 'key nil)))
 418                                  (condition-case ()
 419                                      (if (fboundp 'buffer-substring-lessp)
 420                                          (cons (match-beginning n)
 421                                                (match-end n))
 422                                          (buffer-substring (match-beginning n)
 423                                                            (match-end n)))
 424                                    ;; if there was no such register
 425                                    (error (throw 'key nil)))))))))))
 426
 427 \f
 428 (defvar sort-columns-subprocess t)
 429
 430 ;;;###autoload
 431 (defun sort-columns (reverse &optional beg end)
 432   "Sort lines in region alphabetically by a certain range of columns.
 433 For the purpose of this command, the region includes
 434 the entire line that point is in and the entire line the mark is in.
 435 The column positions of point and mark bound the range of columns to sort on.
 436 A prefix argument means sort into reverse order.
 437
 438 Note that `sort-columns' rejects text that contains tabs,
 439 because tabs could be split across the specified columns
 440 and it doesn't know how to handle that.  Also, when possible,
 441 it uses the `sort' utility program, which doesn't understand tabs.
 442 Use \\[untabify] to convert tabs to spaces before sorting."
 443   (interactive "P\nr")
 444   (save-excursion
 445     (let (beg1 end1 col-beg1 col-end1 col-start col-end)
 446       (goto-char (min beg end))
 447       (setq col-beg1 (current-column))
 448       (beginning-of-line)
 449       (setq beg1 (point))
 450       (goto-char (max beg end))
 451       (setq col-end1 (current-column))
 452       (forward-line)
 453       (setq end1 (point))
 454       (setq col-start (min col-beg1 col-end1))
 455       (setq col-end (max col-beg1 col-end1))
 456       (if (search-backward "\t" beg1 t)
 457           (error "sort-columns does not work with tabs.  Use M-x untabify."))
 458       (if (not (or (eq system-type 'vax-vms)
 459                    (text-properties-at beg1)
 460                    (< (next-property-change beg1 nil end1) end1)))
 461           ;; Use the sort utility if we can; it is 4 times as fast.
 462           ;; Do not use it if there are any properties in the region,
 463           ;; since the sort utility would lose the properties.
 464           (call-process-region beg1 end1 "sort" t t nil
 465                                (if reverse "-rt\n" "-t\n")
 466                                (concat "+0." col-start)
 467                                (concat "-0." col-end))
 468         ;; On VMS, use Emacs's own facilities.
 469         (save-excursion
 470           (save-restriction
 471             (narrow-to-region beg1 end1)
 472             (goto-char beg1)
 473             (sort-subr reverse 'forward-line 'end-of-line
 474                        (function (lambda () (move-to-column col-start) nil))
 475                        (function (lambda () (move-to-column col-end) nil)))))))))
 476
 477 ;;;###autoload
 478 (defun reverse-region (beg end)
 479   "Reverse the order of lines in a region.
 480 From a program takes two point or marker arguments, BEG and END."
 481   (interactive "r")
 482   (if (> beg end)
 483       (let (mid) (setq mid end end beg beg mid)))
 484   (save-excursion
 485     ;; put beg at the start of a line and end and the end of one --
 486     ;; the largest possible region which fits this criteria
 487     (goto-char beg)
 488     (or (bolp) (forward-line 1))
 489     (setq beg (point))
 490     (goto-char end)
 491     ;; the test for bolp is for those times when end is on an empty line;
 492     ;; it is probably not the case that the line should be included in the
 493     ;; reversal; it isn't difficult to add it afterward.
 494     (or (and (eolp) (not (bolp))) (progn (forward-line -1) (end-of-line)))
 495     (setq end (point-marker))
 496     ;; the real work.  this thing cranks through memory on large regions.
 497     (let (ll (do t))
 498       (while do
 499         (goto-char beg)
 500         (setq ll (cons (buffer-substring (point) (progn (end-of-line) (point)))
 501                        ll))
 502         (setq do (/= (point) end))
 503         (delete-region beg (if do (1+ (point)) (point))))
 504       (while (cdr ll)
 505         (insert (car ll) "\n")
 506         (setq ll (cdr ll)))
 507       (insert (car ll)))))
 508
 509 (provide 'sort)
 510
 511 ;;; sort.el ends here