Mercurial > emacs
annotate lisp/emacs-lisp/ring.el @ 58209:18b94da7a313
extern reseat_at_previous_visible_line_start.
author | Luc Teirlinck <teirllm@auburn.edu> |
---|---|
date | Sun, 14 Nov 2004 05:24:59 +0000 |
parents | 695cf19ef79e |
children | fe0423976eb0 375f2633d815 |
rev | line source |
---|---|
2424
dbdccee84df3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
905
diff
changeset
|
1 ;;; ring.el --- handle rings of items |
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
2 |
846
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
3 ;; Copyright (C) 1992 Free Software Foundation, Inc. |
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
4 |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
5 ;; Maintainer: FSF |
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
6 ;; Keywords: extensions |
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
7 |
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
8 ;; This file is part of GNU Emacs. |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
9 |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
10 ;; GNU Emacs is free software; you can redistribute it and/or modify |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
11 ;; it under the terms of the GNU General Public License as published by |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
12 ;; the Free Software Foundation; either version 2, or (at your option) |
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
13 ;; any later version. |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
14 |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
15 ;; GNU Emacs is distributed in the hope that it will be useful, |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
18 ;; GNU General Public License for more details. |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
19 |
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
20 ;; You should have received a copy of the GNU General Public License |
14169 | 21 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 ;; Boston, MA 02111-1307, USA. | |
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
24 |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
25 ;;; Commentary: |
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
26 |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
27 ;; This code defines a ring data structure. A ring is a |
25467 | 28 ;; (hd-index length . vector) |
17212 | 29 ;; list. You can insert to, remove from, and rotate a ring. When the ring |
14169 | 30 ;; fills up, insertions cause the oldest elts to be quietly dropped. |
31 ;; | |
32 ;; In ring-ref, 0 is the index of the newest element. Higher indexes | |
17212 | 33 ;; correspond to older elements; when the index equals the ring length, |
34 ;; it wraps to the newest element again. | |
14169 | 35 ;; |
17212 | 36 ;; hd-index = vector index of the oldest ring item. |
37 ;; Newer items follow this item; at the end of the vector, | |
25467 | 38 ;; they wrap around to the start of the vector. |
17212 | 39 ;; length = number of items currently in the ring. |
25467 | 40 ;; This never exceeds the length of the vector itself. |
14169 | 41 ;; |
42 ;; These functions are used by the input history mechanism, but they can | |
43 ;; be used for other purposes as well. | |
124 | 44 |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
45 ;;; Code: |
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
46 |
25467 | 47 ;;; User Functions: |
48 | |
905 | 49 ;;;###autoload |
25467 | 50 (defun ring-p (x) |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
51 "Return t if X is a ring; nil otherwise." |
124 | 52 (and (consp x) (integerp (car x)) |
53 (consp (cdr x)) (integerp (car (cdr x))) | |
54 (vectorp (cdr (cdr x))))) | |
55 | |
905 | 56 ;;;###autoload |
124 | 57 (defun make-ring (size) |
2574
c782b69b60a4
Added and fixed documentation.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2424
diff
changeset
|
58 "Make a ring that can contain SIZE elements." |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
59 (cons 0 (cons 0 (make-vector size nil)))) |
124 | 60 |
8031
4b45aa6d5d76
(ring-insert-at-beginning): New function.
Richard M. Stallman <rms@gnu.org>
parents:
4516
diff
changeset
|
61 (defun ring-insert-at-beginning (ring item) |
17212 | 62 "Add to RING the item ITEM. Add it at the front, as the oldest item." |
25467 | 63 (let* ((vec (cdr (cdr ring))) |
64 (veclen (length vec)) | |
65 (hd (car ring)) | |
66 (ln (car (cdr ring)))) | |
8031
4b45aa6d5d76
(ring-insert-at-beginning): New function.
Richard M. Stallman <rms@gnu.org>
parents:
4516
diff
changeset
|
67 (setq ln (min veclen (1+ ln)) |
25467 | 68 hd (ring-minus1 hd veclen)) |
8031
4b45aa6d5d76
(ring-insert-at-beginning): New function.
Richard M. Stallman <rms@gnu.org>
parents:
4516
diff
changeset
|
69 (aset vec hd item) |
4b45aa6d5d76
(ring-insert-at-beginning): New function.
Richard M. Stallman <rms@gnu.org>
parents:
4516
diff
changeset
|
70 (setcar ring hd) |
4b45aa6d5d76
(ring-insert-at-beginning): New function.
Richard M. Stallman <rms@gnu.org>
parents:
4516
diff
changeset
|
71 (setcar (cdr ring) ln))) |
4b45aa6d5d76
(ring-insert-at-beginning): New function.
Richard M. Stallman <rms@gnu.org>
parents:
4516
diff
changeset
|
72 |
124 | 73 (defun ring-plus1 (index veclen) |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
74 "Return INDEX+1, with wraparound." |
124 | 75 (let ((new-index (+ index 1))) |
76 (if (= new-index veclen) 0 new-index))) | |
77 | |
78 (defun ring-minus1 (index veclen) | |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
79 "Return INDEX-1, with wraparound." |
124 | 80 (- (if (= 0 index) veclen index) 1)) |
81 | |
82 (defun ring-length (ring) | |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
83 "Return the number of elements in the RING." |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
84 (car (cdr ring))) |
124 | 85 |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
86 (defun ring-index (index head ringlen veclen) |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
87 "Convert nominal ring index INDEX to an internal index. |
25467 | 88 The internal index refers to the items ordered from newest to oldest. |
89 HEAD is the index of the oldest element in the ring. | |
90 RINGLEN is the number of elements currently in the ring. | |
91 VECLEN is the size of the vector in the ring." | |
4516
95b9760d19e3
(ring-mod): Remove, since floor and mod
Paul Eggert <eggert@twinsun.com>
parents:
2582
diff
changeset
|
92 (setq index (mod index ringlen)) |
95b9760d19e3
(ring-mod): Remove, since floor and mod
Paul Eggert <eggert@twinsun.com>
parents:
2582
diff
changeset
|
93 (mod (1- (+ head (- ringlen index))) veclen)) |
124 | 94 |
25467 | 95 (defun ring-empty-p (ring) |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
96 "Return t if RING is empty; nil otherwise." |
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
97 (zerop (car (cdr ring)))) |
25467 | 98 |
99 (defun ring-size (ring) | |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
100 "Return the size of RING, the maximum number of elements it can contain." |
25467 | 101 (length (cdr (cdr ring)))) |
102 | |
103 (defun ring-copy (ring) | |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
104 "Return a copy of RING." |
25468 | 105 (let* ((vec (cdr (cdr ring))) |
106 (hd (car ring)) | |
107 (ln (car (cdr ring)))) | |
25467 | 108 (cons hd (cons ln (copy-sequence vec))))) |
109 | |
124 | 110 (defun ring-insert (ring item) |
8031
4b45aa6d5d76
(ring-insert-at-beginning): New function.
Richard M. Stallman <rms@gnu.org>
parents:
4516
diff
changeset
|
111 "Insert onto ring RING the item ITEM, as the newest (last) item. |
25467 | 112 If the ring is full, dump the oldest item to make room." |
113 (let* ((vec (cdr (cdr ring))) | |
114 (veclen (length vec)) | |
115 (hd (car ring)) | |
116 (ln (car (cdr ring)))) | |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
117 (prog1 |
25467 | 118 (aset vec (mod (+ hd ln) veclen) item) |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
119 (if (= ln veclen) |
25467 | 120 (setcar ring (ring-plus1 hd veclen)) |
121 (setcar (cdr ring) (1+ ln)))))) | |
124 | 122 |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
123 (defun ring-remove (ring &optional index) |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
124 "Remove an item from the RING. Return the removed item. |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
125 If optional INDEX is nil, remove the oldest item. If it's |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
126 numeric, remove the element indexed." |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
127 (if (ring-empty-p ring) |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
128 (error "Ring empty") |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
129 (let* ((hd (car ring)) |
25467 | 130 (ln (car (cdr ring))) |
131 (vec (cdr (cdr ring))) | |
132 (veclen (length vec)) | |
133 (tl (mod (1- (+ hd ln)) veclen)) | |
134 oldelt) | |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
135 (if (null index) |
25467 | 136 (setq index (1- ln))) |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
137 (setq index (ring-index index hd ln veclen)) |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
138 (setq oldelt (aref vec index)) |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
139 (while (/= index tl) |
25467 | 140 (aset vec index (aref vec (ring-plus1 index veclen))) |
141 (setq index (ring-plus1 index veclen))) | |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
142 (aset vec tl nil) |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
143 (setcar (cdr ring) (1- ln)) |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
144 oldelt))) |
124 | 145 |
146 (defun ring-ref (ring index) | |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
147 "Return RING's INDEX element. |
17212 | 148 INDEX = 0 is the most recently inserted; higher indices |
149 correspond to older elements. | |
25468 | 150 INDEX need not be <= the ring length; the appropriate modulo operation |
17212 | 151 will be performed." |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
152 (if (ring-empty-p ring) |
17212 | 153 (error "Accessing an empty ring") |
2582
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
154 (let* ((hd (car ring)) (ln (car (cdr ring))) (vec (cdr (cdr ring)))) |
e01048f32511
Rewritten. A poor choice of representation made the old code excessively
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2574
diff
changeset
|
155 (aref vec (ring-index index hd ln (length vec)))))) |
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
156 |
29055 | 157 (defun ring-elements (ring) |
51873
000e2717e1a5
2003-07-11 John Paul Wallington <jpw@gnu.org>
John Paul Wallington <jpw@pobox.com>
parents:
29055
diff
changeset
|
158 "Return a list of the elements of RING." |
29055 | 159 (mapcar #'identity (cddr ring))) |
160 | |
25467 | 161 ;;; provide ourself: |
162 | |
2574
c782b69b60a4
Added and fixed documentation.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2424
diff
changeset
|
163 (provide 'ring) |
c782b69b60a4
Added and fixed documentation.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2424
diff
changeset
|
164 |
52401 | 165 ;;; arch-tag: e707682b-ed69-47c9-b20f-cf2c68cc92d2 |
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
245
diff
changeset
|
166 ;;; ring.el ends here |