* emacs-lisp/find-func.el (find-function-noselect): Handle
[bpt/emacs.git] / lisp / emacs-lisp / cl-seq.el
CommitLineData
73217411 1;;; cl-seq.el --- Common Lisp features, part 3 -*-byte-compile-dynamic: t;-*-
fcd73769
RS
2
3;; Copyright (C) 1993 Free Software Foundation, Inc.
4
5;; Author: Dave Gillespie <daveg@synaptics.com>
6;; Version: 2.02
7;; Keywords: extensions
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
7c938215 13;; the Free Software Foundation; either version 2, or (at your option)
fcd73769
RS
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
b578f267
EN
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.
fcd73769 25
07b3798c 26;;; Commentary:
fcd73769
RS
27
28;; These are extensions to Emacs Lisp that provide a degree of
29;; Common Lisp compatibility, beyond what is already built-in
30;; in Emacs Lisp.
31;;
32;; This package was written by Dave Gillespie; it is a complete
33;; rewrite of Cesar Quiroz's original cl.el package of December 1986.
34;;
35;; This package works with Emacs 18, Emacs 19, and Lucid Emacs 19.
36;;
37;; Bug reports, comments, and suggestions are welcome!
38
39;; This file contains the Common Lisp sequence and list functions
40;; which take keyword arguments.
41
42;; See cl.el for Change Log.
43
44
07b3798c 45;;; Code:
fcd73769
RS
46
47(or (memq 'cl-19 features)
48 (error "Tried to load `cl-seq' before `cl'!"))
49
50
fcd73769
RS
51;;; Keyword parsing. This is special-cased here so that we can compile
52;;; this file independent from cl-macs.
53
54(defmacro cl-parsing-keywords (kwords other-keys &rest body)
55 (cons
56 'let*
57 (cons (mapcar
58 (function
59 (lambda (x)
60 (let* ((var (if (consp x) (car x) x))
61 (mem (list 'car (list 'cdr (list 'memq (list 'quote var)
62 'cl-keys)))))
64a4c526 63 (if (eq var :test-not)
fcd73769 64 (setq mem (list 'and mem (list 'setq 'cl-test mem) t)))
64a4c526 65 (if (eq var :if-not)
fcd73769
RS
66 (setq mem (list 'and mem (list 'setq 'cl-if mem) t)))
67 (list (intern
68 (format "cl-%s" (substring (symbol-name var) 1)))
69 (if (consp x) (list 'or mem (car (cdr x))) mem)))))
70 kwords)
71 (append
72 (and (not (eq other-keys t))
73 (list
74 (list 'let '((cl-keys-temp cl-keys))
75 (list 'while 'cl-keys-temp
76 (list 'or (list 'memq '(car cl-keys-temp)
77 (list 'quote
78 (mapcar
79 (function
80 (lambda (x)
81 (if (consp x)
82 (car x) x)))
83 (append kwords
84 other-keys))))
85 '(car (cdr (memq (quote :allow-other-keys)
86 cl-keys)))
87 '(error "Bad keyword argument %s"
88 (car cl-keys-temp)))
89 '(setq cl-keys-temp (cdr (cdr cl-keys-temp)))))))
90 body))))
91(put 'cl-parsing-keywords 'lisp-indent-function 2)
92(put 'cl-parsing-keywords 'edebug-form-spec '(sexp sexp &rest form))
93
94(defmacro cl-check-key (x)
95 (list 'if 'cl-key (list 'funcall 'cl-key x) x))
96
97(defmacro cl-check-test-nokey (item x)
98 (list 'cond
99 (list 'cl-test
100 (list 'eq (list 'not (list 'funcall 'cl-test item x))
101 'cl-test-not))
102 (list 'cl-if
103 (list 'eq (list 'not (list 'funcall 'cl-if x)) 'cl-if-not))
104 (list 't (list 'if (list 'numberp item)
105 (list 'equal item x) (list 'eq item x)))))
106
107(defmacro cl-check-test (item x)
108 (list 'cl-check-test-nokey item (list 'cl-check-key x)))
109
110(defmacro cl-check-match (x y)
111 (setq x (list 'cl-check-key x) y (list 'cl-check-key y))
112 (list 'if 'cl-test
113 (list 'eq (list 'not (list 'funcall 'cl-test x y)) 'cl-test-not)
114 (list 'if (list 'numberp x)
115 (list 'equal x y) (list 'eq x y))))
116
117(put 'cl-check-key 'edebug-form-spec 'edebug-forms)
118(put 'cl-check-test 'edebug-form-spec 'edebug-forms)
119(put 'cl-check-test-nokey 'edebug-form-spec 'edebug-forms)
120(put 'cl-check-match 'edebug-form-spec 'edebug-forms)
121
122(defvar cl-test) (defvar cl-test-not)
123(defvar cl-if) (defvar cl-if-not)
124(defvar cl-key)
125
126
127(defun reduce (cl-func cl-seq &rest cl-keys)
47bc4b3f
JB
128 "Reduce two-argument FUNCTION across SEQ.
129\nKeywords supported: :start :end :from-end :initial-value :key
130\n(fn FUNCTION SEQ [KEYWORD VALUE]...)"
fcd73769
RS
131 (cl-parsing-keywords (:from-end (:start 0) :end :initial-value :key) ()
132 (or (listp cl-seq) (setq cl-seq (append cl-seq nil)))
133 (setq cl-seq (subseq cl-seq cl-start cl-end))
134 (if cl-from-end (setq cl-seq (nreverse cl-seq)))
64a4c526 135 (let ((cl-accum (cond ((memq :initial-value cl-keys) cl-initial-value)
ca50d9e6 136 (cl-seq (cl-check-key (pop cl-seq)))
fcd73769
RS
137 (t (funcall cl-func)))))
138 (if cl-from-end
139 (while cl-seq
ca50d9e6 140 (setq cl-accum (funcall cl-func (cl-check-key (pop cl-seq))
fcd73769
RS
141 cl-accum)))
142 (while cl-seq
143 (setq cl-accum (funcall cl-func cl-accum
ca50d9e6 144 (cl-check-key (pop cl-seq))))))
fcd73769
RS
145 cl-accum)))
146
147(defun fill (seq item &rest cl-keys)
148 "Fill the elements of SEQ with ITEM.
47bc4b3f
JB
149\nKeywords supported: :start :end
150\n(fn SEQ ITEM [KEYWORD VALUE]...)"
fcd73769
RS
151 (cl-parsing-keywords ((:start 0) :end) ()
152 (if (listp seq)
153 (let ((p (nthcdr cl-start seq))
154 (n (if cl-end (- cl-end cl-start) 8000000)))
155 (while (and p (>= (setq n (1- n)) 0))
156 (setcar p item)
157 (setq p (cdr p))))
158 (or cl-end (setq cl-end (length seq)))
159 (if (and (= cl-start 0) (= cl-end (length seq)))
160 (fillarray seq item)
161 (while (< cl-start cl-end)
162 (aset seq cl-start item)
163 (setq cl-start (1+ cl-start)))))
164 seq))
165
166(defun replace (cl-seq1 cl-seq2 &rest cl-keys)
167 "Replace the elements of SEQ1 with the elements of SEQ2.
168SEQ1 is destructively modified, then returned.
47bc4b3f
JB
169\nKeywords supported: :start1 :end1 :start2 :end2
170\n(fn SEQ1 SEQ2 [KEYWORD VALUE]...)"
fcd73769
RS
171 (cl-parsing-keywords ((:start1 0) :end1 (:start2 0) :end2) ()
172 (if (and (eq cl-seq1 cl-seq2) (<= cl-start2 cl-start1))
173 (or (= cl-start1 cl-start2)
174 (let* ((cl-len (length cl-seq1))
175 (cl-n (min (- (or cl-end1 cl-len) cl-start1)
176 (- (or cl-end2 cl-len) cl-start2))))
177 (while (>= (setq cl-n (1- cl-n)) 0)
178 (cl-set-elt cl-seq1 (+ cl-start1 cl-n)
179 (elt cl-seq2 (+ cl-start2 cl-n))))))
180 (if (listp cl-seq1)
181 (let ((cl-p1 (nthcdr cl-start1 cl-seq1))
182 (cl-n1 (if cl-end1 (- cl-end1 cl-start1) 4000000)))
183 (if (listp cl-seq2)
184 (let ((cl-p2 (nthcdr cl-start2 cl-seq2))
185 (cl-n (min cl-n1
186 (if cl-end2 (- cl-end2 cl-start2) 4000000))))
187 (while (and cl-p1 cl-p2 (>= (setq cl-n (1- cl-n)) 0))
188 (setcar cl-p1 (car cl-p2))
189 (setq cl-p1 (cdr cl-p1) cl-p2 (cdr cl-p2))))
190 (setq cl-end2 (min (or cl-end2 (length cl-seq2))
191 (+ cl-start2 cl-n1)))
192 (while (and cl-p1 (< cl-start2 cl-end2))
193 (setcar cl-p1 (aref cl-seq2 cl-start2))
194 (setq cl-p1 (cdr cl-p1) cl-start2 (1+ cl-start2)))))
195 (setq cl-end1 (min (or cl-end1 (length cl-seq1))
196 (+ cl-start1 (- (or cl-end2 (length cl-seq2))
197 cl-start2))))
198 (if (listp cl-seq2)
199 (let ((cl-p2 (nthcdr cl-start2 cl-seq2)))
200 (while (< cl-start1 cl-end1)
201 (aset cl-seq1 cl-start1 (car cl-p2))
202 (setq cl-p2 (cdr cl-p2) cl-start1 (1+ cl-start1))))
203 (while (< cl-start1 cl-end1)
204 (aset cl-seq1 cl-start1 (aref cl-seq2 cl-start2))
205 (setq cl-start2 (1+ cl-start2) cl-start1 (1+ cl-start1))))))
206 cl-seq1))
207
208(defun remove* (cl-item cl-seq &rest cl-keys)
209 "Remove all occurrences of ITEM in SEQ.
210This is a non-destructive function; it makes a copy of SEQ if necessary
211to avoid corrupting the original SEQ.
47bc4b3f
JB
212\nKeywords supported: :test :test-not :key :count :start :end :from-end
213\n(fn ITEM SEQ [KEYWORD VALUE]...)"
fcd73769
RS
214 (cl-parsing-keywords (:test :test-not :key :if :if-not :count :from-end
215 (:start 0) :end) ()
216 (if (<= (or cl-count (setq cl-count 8000000)) 0)
217 cl-seq
218 (if (or (nlistp cl-seq) (and cl-from-end (< cl-count 4000000)))
219 (let ((cl-i (cl-position cl-item cl-seq cl-start cl-end
220 cl-from-end)))
221 (if cl-i
222 (let ((cl-res (apply 'delete* cl-item (append cl-seq nil)
223 (append (if cl-from-end
64a4c526
DL
224 (list :end (1+ cl-i))
225 (list :start cl-i))
fcd73769
RS
226 cl-keys))))
227 (if (listp cl-seq) cl-res
228 (if (stringp cl-seq) (concat cl-res) (vconcat cl-res))))
229 cl-seq))
230 (setq cl-end (- (or cl-end 8000000) cl-start))
231 (if (= cl-start 0)
232 (while (and cl-seq (> cl-end 0)
233 (cl-check-test cl-item (car cl-seq))
234 (setq cl-end (1- cl-end) cl-seq (cdr cl-seq))
235 (> (setq cl-count (1- cl-count)) 0))))
236 (if (and (> cl-count 0) (> cl-end 0))
237 (let ((cl-p (if (> cl-start 0) (nthcdr cl-start cl-seq)
238 (setq cl-end (1- cl-end)) (cdr cl-seq))))
239 (while (and cl-p (> cl-end 0)
240 (not (cl-check-test cl-item (car cl-p))))
241 (setq cl-p (cdr cl-p) cl-end (1- cl-end)))
242 (if (and cl-p (> cl-end 0))
243 (nconc (ldiff cl-seq cl-p)
244 (if (= cl-count 1) (cdr cl-p)
245 (and (cdr cl-p)
246 (apply 'delete* cl-item
247 (copy-sequence (cdr cl-p))
64a4c526
DL
248 :start 0 :end (1- cl-end)
249 :count (1- cl-count) cl-keys))))
fcd73769
RS
250 cl-seq))
251 cl-seq)))))
252
253(defun remove-if (cl-pred cl-list &rest cl-keys)
254 "Remove all items satisfying PREDICATE in SEQ.
255This is a non-destructive function; it makes a copy of SEQ if necessary
256to avoid corrupting the original SEQ.
47bc4b3f
JB
257\nKeywords supported: :key :count :start :end :from-end
258\n(fn PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 259 (apply 'remove* nil cl-list :if cl-pred cl-keys))
fcd73769
RS
260
261(defun remove-if-not (cl-pred cl-list &rest cl-keys)
262 "Remove all items not satisfying PREDICATE in SEQ.
263This is a non-destructive function; it makes a copy of SEQ if necessary
264to avoid corrupting the original SEQ.
47bc4b3f
JB
265\nKeywords supported: :key :count :start :end :from-end
266\n(fn PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 267 (apply 'remove* nil cl-list :if-not cl-pred cl-keys))
fcd73769
RS
268
269(defun delete* (cl-item cl-seq &rest cl-keys)
270 "Remove all occurrences of ITEM in SEQ.
271This is a destructive function; it reuses the storage of SEQ whenever possible.
47bc4b3f
JB
272\nKeywords supported: :test :test-not :key :count :start :end :from-end
273\n(fn ITEM SEQ [KEYWORD VALUE]...)"
fcd73769
RS
274 (cl-parsing-keywords (:test :test-not :key :if :if-not :count :from-end
275 (:start 0) :end) ()
276 (if (<= (or cl-count (setq cl-count 8000000)) 0)
277 cl-seq
278 (if (listp cl-seq)
279 (if (and cl-from-end (< cl-count 4000000))
280 (let (cl-i)
281 (while (and (>= (setq cl-count (1- cl-count)) 0)
282 (setq cl-i (cl-position cl-item cl-seq cl-start
283 cl-end cl-from-end)))
284 (if (= cl-i 0) (setq cl-seq (cdr cl-seq))
285 (let ((cl-tail (nthcdr (1- cl-i) cl-seq)))
286 (setcdr cl-tail (cdr (cdr cl-tail)))))
287 (setq cl-end cl-i))
288 cl-seq)
289 (setq cl-end (- (or cl-end 8000000) cl-start))
290 (if (= cl-start 0)
291 (progn
292 (while (and cl-seq
293 (> cl-end 0)
294 (cl-check-test cl-item (car cl-seq))
295 (setq cl-end (1- cl-end) cl-seq (cdr cl-seq))
296 (> (setq cl-count (1- cl-count)) 0)))
297 (setq cl-end (1- cl-end)))
298 (setq cl-start (1- cl-start)))
299 (if (and (> cl-count 0) (> cl-end 0))
300 (let ((cl-p (nthcdr cl-start cl-seq)))
301 (while (and (cdr cl-p) (> cl-end 0))
302 (if (cl-check-test cl-item (car (cdr cl-p)))
303 (progn
304 (setcdr cl-p (cdr (cdr cl-p)))
305 (if (= (setq cl-count (1- cl-count)) 0)
306 (setq cl-end 1)))
307 (setq cl-p (cdr cl-p)))
308 (setq cl-end (1- cl-end)))))
309 cl-seq)
310 (apply 'remove* cl-item cl-seq cl-keys)))))
311
312(defun delete-if (cl-pred cl-list &rest cl-keys)
313 "Remove all items satisfying PREDICATE in SEQ.
314This is a destructive function; it reuses the storage of SEQ whenever possible.
47bc4b3f
JB
315\nKeywords supported: :key :count :start :end :from-end
316\n(fn PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 317 (apply 'delete* nil cl-list :if cl-pred cl-keys))
fcd73769
RS
318
319(defun delete-if-not (cl-pred cl-list &rest cl-keys)
320 "Remove all items not satisfying PREDICATE in SEQ.
321This is a destructive function; it reuses the storage of SEQ whenever possible.
47bc4b3f
JB
322\nKeywords supported: :key :count :start :end :from-end
323\n(fn PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 324 (apply 'delete* nil cl-list :if-not cl-pred cl-keys))
fcd73769 325
fcd73769
RS
326(defun remove-duplicates (cl-seq &rest cl-keys)
327 "Return a copy of SEQ with all duplicate elements removed.
47bc4b3f
JB
328\nKeywords supported: :test :test-not :key :start :end :from-end
329\n(fn SEQ [KEYWORD VALUE]...)"
fcd73769
RS
330 (cl-delete-duplicates cl-seq cl-keys t))
331
332(defun delete-duplicates (cl-seq &rest cl-keys)
333 "Remove all duplicate elements from SEQ (destructively).
47bc4b3f
JB
334\nKeywords supported: :test :test-not :key :start :end :from-end
335\n(fn SEQ [KEYWORD VALUE]...)"
fcd73769
RS
336 (cl-delete-duplicates cl-seq cl-keys nil))
337
338(defun cl-delete-duplicates (cl-seq cl-keys cl-copy)
339 (if (listp cl-seq)
340 (cl-parsing-keywords (:test :test-not :key (:start 0) :end :from-end :if)
341 ()
342 (if cl-from-end
343 (let ((cl-p (nthcdr cl-start cl-seq)) cl-i)
344 (setq cl-end (- (or cl-end (length cl-seq)) cl-start))
345 (while (> cl-end 1)
346 (setq cl-i 0)
347 (while (setq cl-i (cl-position (cl-check-key (car cl-p))
348 (cdr cl-p) cl-i (1- cl-end)))
349 (if cl-copy (setq cl-seq (copy-sequence cl-seq)
350 cl-p (nthcdr cl-start cl-seq) cl-copy nil))
351 (let ((cl-tail (nthcdr cl-i cl-p)))
352 (setcdr cl-tail (cdr (cdr cl-tail))))
353 (setq cl-end (1- cl-end)))
354 (setq cl-p (cdr cl-p) cl-end (1- cl-end)
355 cl-start (1+ cl-start)))
356 cl-seq)
357 (setq cl-end (- (or cl-end (length cl-seq)) cl-start))
358 (while (and (cdr cl-seq) (= cl-start 0) (> cl-end 1)
359 (cl-position (cl-check-key (car cl-seq))
360 (cdr cl-seq) 0 (1- cl-end)))
361 (setq cl-seq (cdr cl-seq) cl-end (1- cl-end)))
362 (let ((cl-p (if (> cl-start 0) (nthcdr (1- cl-start) cl-seq)
363 (setq cl-end (1- cl-end) cl-start 1) cl-seq)))
364 (while (and (cdr (cdr cl-p)) (> cl-end 1))
365 (if (cl-position (cl-check-key (car (cdr cl-p)))
366 (cdr (cdr cl-p)) 0 (1- cl-end))
367 (progn
368 (if cl-copy (setq cl-seq (copy-sequence cl-seq)
369 cl-p (nthcdr (1- cl-start) cl-seq)
370 cl-copy nil))
371 (setcdr cl-p (cdr (cdr cl-p))))
372 (setq cl-p (cdr cl-p)))
373 (setq cl-end (1- cl-end) cl-start (1+ cl-start)))
374 cl-seq)))
375 (let ((cl-res (cl-delete-duplicates (append cl-seq nil) cl-keys nil)))
376 (if (stringp cl-seq) (concat cl-res) (vconcat cl-res)))))
377
378(defun substitute (cl-new cl-old cl-seq &rest cl-keys)
379 "Substitute NEW for OLD in SEQ.
380This is a non-destructive function; it makes a copy of SEQ if necessary
381to avoid corrupting the original SEQ.
47bc4b3f
JB
382\nKeywords supported: :test :test-not :key :count :start :end :from-end
383\n(fn NEW OLD SEQ [KEYWORD VALUE]...)"
fcd73769
RS
384 (cl-parsing-keywords (:test :test-not :key :if :if-not :count
385 (:start 0) :end :from-end) ()
386 (if (or (eq cl-old cl-new)
387 (<= (or cl-count (setq cl-from-end nil cl-count 8000000)) 0))
388 cl-seq
389 (let ((cl-i (cl-position cl-old cl-seq cl-start cl-end)))
390 (if (not cl-i)
391 cl-seq
392 (setq cl-seq (copy-sequence cl-seq))
393 (or cl-from-end
394 (progn (cl-set-elt cl-seq cl-i cl-new)
395 (setq cl-i (1+ cl-i) cl-count (1- cl-count))))
64a4c526
DL
396 (apply 'nsubstitute cl-new cl-old cl-seq :count cl-count
397 :start cl-i cl-keys))))))
fcd73769
RS
398
399(defun substitute-if (cl-new cl-pred cl-list &rest cl-keys)
400 "Substitute NEW for all items satisfying PREDICATE in SEQ.
401This is a non-destructive function; it makes a copy of SEQ if necessary
402to avoid corrupting the original SEQ.
47bc4b3f
JB
403\nKeywords supported: :key :count :start :end :from-end
404\n(fn NEW PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 405 (apply 'substitute cl-new nil cl-list :if cl-pred cl-keys))
fcd73769
RS
406
407(defun substitute-if-not (cl-new cl-pred cl-list &rest cl-keys)
408 "Substitute NEW for all items not satisfying PREDICATE in SEQ.
409This is a non-destructive function; it makes a copy of SEQ if necessary
410to avoid corrupting the original SEQ.
47bc4b3f
JB
411\nKeywords supported: :key :count :start :end :from-end
412\n(fn NEW PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 413 (apply 'substitute cl-new nil cl-list :if-not cl-pred cl-keys))
fcd73769
RS
414
415(defun nsubstitute (cl-new cl-old cl-seq &rest cl-keys)
416 "Substitute NEW for OLD in SEQ.
417This is a destructive function; it reuses the storage of SEQ whenever possible.
47bc4b3f
JB
418\nKeywords supported: :test :test-not :key :count :start :end :from-end
419\n(fn NEW OLD SEQ [KEYWORD VALUE]...)"
fcd73769
RS
420 (cl-parsing-keywords (:test :test-not :key :if :if-not :count
421 (:start 0) :end :from-end) ()
422 (or (eq cl-old cl-new) (<= (or cl-count (setq cl-count 8000000)) 0)
423 (if (and (listp cl-seq) (or (not cl-from-end) (> cl-count 4000000)))
424 (let ((cl-p (nthcdr cl-start cl-seq)))
425 (setq cl-end (- (or cl-end 8000000) cl-start))
426 (while (and cl-p (> cl-end 0) (> cl-count 0))
427 (if (cl-check-test cl-old (car cl-p))
428 (progn
429 (setcar cl-p cl-new)
430 (setq cl-count (1- cl-count))))
431 (setq cl-p (cdr cl-p) cl-end (1- cl-end))))
432 (or cl-end (setq cl-end (length cl-seq)))
433 (if cl-from-end
434 (while (and (< cl-start cl-end) (> cl-count 0))
435 (setq cl-end (1- cl-end))
436 (if (cl-check-test cl-old (elt cl-seq cl-end))
437 (progn
438 (cl-set-elt cl-seq cl-end cl-new)
439 (setq cl-count (1- cl-count)))))
440 (while (and (< cl-start cl-end) (> cl-count 0))
441 (if (cl-check-test cl-old (aref cl-seq cl-start))
442 (progn
443 (aset cl-seq cl-start cl-new)
444 (setq cl-count (1- cl-count))))
445 (setq cl-start (1+ cl-start))))))
446 cl-seq))
447
448(defun nsubstitute-if (cl-new cl-pred cl-list &rest cl-keys)
449 "Substitute NEW for all items satisfying PREDICATE in SEQ.
450This is a destructive function; it reuses the storage of SEQ whenever possible.
47bc4b3f
JB
451\nKeywords supported: :key :count :start :end :from-end
452\n(fn NEW PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 453 (apply 'nsubstitute cl-new nil cl-list :if cl-pred cl-keys))
fcd73769
RS
454
455(defun nsubstitute-if-not (cl-new cl-pred cl-list &rest cl-keys)
456 "Substitute NEW for all items not satisfying PREDICATE in SEQ.
457This is a destructive function; it reuses the storage of SEQ whenever possible.
47bc4b3f
JB
458\nKeywords supported: :key :count :start :end :from-end
459\n(fn NEW PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 460 (apply 'nsubstitute cl-new nil cl-list :if-not cl-pred cl-keys))
fcd73769
RS
461
462(defun find (cl-item cl-seq &rest cl-keys)
47bc4b3f 463 "Find the first occurrence of ITEM in SEQ.
fcd73769 464Return the matching ITEM, or nil if not found.
47bc4b3f
JB
465\nKeywords supported: :test :test-not :key :start :end :from-end
466\n(fn ITEM SEQ [KEYWORD VALUE]...)"
fcd73769
RS
467 (let ((cl-pos (apply 'position cl-item cl-seq cl-keys)))
468 (and cl-pos (elt cl-seq cl-pos))))
469
470(defun find-if (cl-pred cl-list &rest cl-keys)
47bc4b3f
JB
471 "Find the first item satisfying PREDICATE in SEQ.
472Return the matching item, or nil if not found.
473\nKeywords supported: :key :start :end :from-end
474\n(fn PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 475 (apply 'find nil cl-list :if cl-pred cl-keys))
fcd73769
RS
476
477(defun find-if-not (cl-pred cl-list &rest cl-keys)
47bc4b3f
JB
478 "Find the first item not satisfying PREDICATE in SEQ.
479Return the matching item, or nil if not found.
480\nKeywords supported: :key :start :end :from-end
481\n(fn PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 482 (apply 'find nil cl-list :if-not cl-pred cl-keys))
fcd73769
RS
483
484(defun position (cl-item cl-seq &rest cl-keys)
47bc4b3f 485 "Find the first occurrence of ITEM in SEQ.
fcd73769 486Return the index of the matching item, or nil if not found.
47bc4b3f
JB
487\nKeywords supported: :test :test-not :key :start :end :from-end
488\n(fn ITEM SEQ [KEYWORD VALUE]...)"
fcd73769
RS
489 (cl-parsing-keywords (:test :test-not :key :if :if-not
490 (:start 0) :end :from-end) ()
491 (cl-position cl-item cl-seq cl-start cl-end cl-from-end)))
492
493(defun cl-position (cl-item cl-seq cl-start &optional cl-end cl-from-end)
494 (if (listp cl-seq)
495 (let ((cl-p (nthcdr cl-start cl-seq)))
496 (or cl-end (setq cl-end 8000000))
497 (let ((cl-res nil))
498 (while (and cl-p (< cl-start cl-end) (or (not cl-res) cl-from-end))
499 (if (cl-check-test cl-item (car cl-p))
500 (setq cl-res cl-start))
501 (setq cl-p (cdr cl-p) cl-start (1+ cl-start)))
502 cl-res))
503 (or cl-end (setq cl-end (length cl-seq)))
504 (if cl-from-end
505 (progn
506 (while (and (>= (setq cl-end (1- cl-end)) cl-start)
507 (not (cl-check-test cl-item (aref cl-seq cl-end)))))
508 (and (>= cl-end cl-start) cl-end))
509 (while (and (< cl-start cl-end)
510 (not (cl-check-test cl-item (aref cl-seq cl-start))))
511 (setq cl-start (1+ cl-start)))
512 (and (< cl-start cl-end) cl-start))))
513
514(defun position-if (cl-pred cl-list &rest cl-keys)
47bc4b3f 515 "Find the first item satisfying PREDICATE in SEQ.
fcd73769 516Return the index of the matching item, or nil if not found.
47bc4b3f
JB
517\nKeywords supported: :key :start :end :from-end
518\n(fn PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 519 (apply 'position nil cl-list :if cl-pred cl-keys))
fcd73769
RS
520
521(defun position-if-not (cl-pred cl-list &rest cl-keys)
47bc4b3f 522 "Find the first item not satisfying PREDICATE in SEQ.
fcd73769 523Return the index of the matching item, or nil if not found.
47bc4b3f
JB
524\nKeywords supported: :key :start :end :from-end
525\n(fn PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 526 (apply 'position nil cl-list :if-not cl-pred cl-keys))
fcd73769
RS
527
528(defun count (cl-item cl-seq &rest cl-keys)
47bc4b3f
JB
529 "Count the number of occurrences of ITEM in SEQ.
530\nKeywords supported: :test :test-not :key :start :end
531\n(fn ITEM SEQ [KEYWORD VALUE]...)"
fcd73769
RS
532 (cl-parsing-keywords (:test :test-not :key :if :if-not (:start 0) :end) ()
533 (let ((cl-count 0) cl-x)
534 (or cl-end (setq cl-end (length cl-seq)))
535 (if (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
536 (while (< cl-start cl-end)
ca50d9e6 537 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
fcd73769
RS
538 (if (cl-check-test cl-item cl-x) (setq cl-count (1+ cl-count)))
539 (setq cl-start (1+ cl-start)))
540 cl-count)))
541
542(defun count-if (cl-pred cl-list &rest cl-keys)
47bc4b3f
JB
543 "Count the number of items satisfying PREDICATE in SEQ.
544\nKeywords supported: :key :start :end
545\n(fn PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 546 (apply 'count nil cl-list :if cl-pred cl-keys))
fcd73769
RS
547
548(defun count-if-not (cl-pred cl-list &rest cl-keys)
47bc4b3f
JB
549 "Count the number of items not satisfying PREDICATE in SEQ.
550\nKeywords supported: :key :start :end
551\n(fn PREDICATE SEQ [KEYWORD VALUE]...)"
64a4c526 552 (apply 'count nil cl-list :if-not cl-pred cl-keys))
fcd73769
RS
553
554(defun mismatch (cl-seq1 cl-seq2 &rest cl-keys)
555 "Compare SEQ1 with SEQ2, return index of first mismatching element.
556Return nil if the sequences match. If one sequence is a prefix of the
d22f8da4 557other, the return value indicates the end of the shorter sequence.
47bc4b3f
JB
558\nKeywords supported: :test :test-not :key :start1 :end1 :start2 :end2 :from-end
559\n(fn SEQ1 SEQ2 [KEYWORD VALUE]...)"
fcd73769
RS
560 (cl-parsing-keywords (:test :test-not :key :from-end
561 (:start1 0) :end1 (:start2 0) :end2) ()
562 (or cl-end1 (setq cl-end1 (length cl-seq1)))
563 (or cl-end2 (setq cl-end2 (length cl-seq2)))
564 (if cl-from-end
565 (progn
566 (while (and (< cl-start1 cl-end1) (< cl-start2 cl-end2)
567 (cl-check-match (elt cl-seq1 (1- cl-end1))
568 (elt cl-seq2 (1- cl-end2))))
569 (setq cl-end1 (1- cl-end1) cl-end2 (1- cl-end2)))
570 (and (or (< cl-start1 cl-end1) (< cl-start2 cl-end2))
571 (1- cl-end1)))
572 (let ((cl-p1 (and (listp cl-seq1) (nthcdr cl-start1 cl-seq1)))
573 (cl-p2 (and (listp cl-seq2) (nthcdr cl-start2 cl-seq2))))
574 (while (and (< cl-start1 cl-end1) (< cl-start2 cl-end2)
575 (cl-check-match (if cl-p1 (car cl-p1)
576 (aref cl-seq1 cl-start1))
577 (if cl-p2 (car cl-p2)
578 (aref cl-seq2 cl-start2))))
579 (setq cl-p1 (cdr cl-p1) cl-p2 (cdr cl-p2)
580 cl-start1 (1+ cl-start1) cl-start2 (1+ cl-start2)))
581 (and (or (< cl-start1 cl-end1) (< cl-start2 cl-end2))
582 cl-start1)))))
583
584(defun search (cl-seq1 cl-seq2 &rest cl-keys)
585 "Search for SEQ1 as a subsequence of SEQ2.
586Return the index of the leftmost element of the first match found;
587return nil if there are no matches.
47bc4b3f
JB
588\nKeywords supported: :test :test-not :key :start1 :end1 :start2 :end2 :from-end
589\n(fn SEQ1 SEQ2 [KEYWORD VALUE]...)"
fcd73769
RS
590 (cl-parsing-keywords (:test :test-not :key :from-end
591 (:start1 0) :end1 (:start2 0) :end2) ()
592 (or cl-end1 (setq cl-end1 (length cl-seq1)))
593 (or cl-end2 (setq cl-end2 (length cl-seq2)))
594 (if (>= cl-start1 cl-end1)
595 (if cl-from-end cl-end2 cl-start2)
596 (let* ((cl-len (- cl-end1 cl-start1))
597 (cl-first (cl-check-key (elt cl-seq1 cl-start1)))
598 (cl-if nil) cl-pos)
599 (setq cl-end2 (- cl-end2 (1- cl-len)))
600 (while (and (< cl-start2 cl-end2)
601 (setq cl-pos (cl-position cl-first cl-seq2
602 cl-start2 cl-end2 cl-from-end))
603 (apply 'mismatch cl-seq1 cl-seq2
64a4c526
DL
604 :start1 (1+ cl-start1) :end1 cl-end1
605 :start2 (1+ cl-pos) :end2 (+ cl-pos cl-len)
606 :from-end nil cl-keys))
fcd73769
RS
607 (if cl-from-end (setq cl-end2 cl-pos) (setq cl-start2 (1+ cl-pos))))
608 (and (< cl-start2 cl-end2) cl-pos)))))
609
610(defun sort* (cl-seq cl-pred &rest cl-keys)
47bc4b3f
JB
611 "Sort the argument SEQ according to PREDICATE.
612This is a destructive function; it reuses the storage of SEQ if possible.
613\nKeywords supported: :key
614\n(fn SEQ PREDICATE [KEYWORD VALUE]...)"
fcd73769
RS
615 (if (nlistp cl-seq)
616 (replace cl-seq (apply 'sort* (append cl-seq nil) cl-pred cl-keys))
617 (cl-parsing-keywords (:key) ()
618 (if (memq cl-key '(nil identity))
619 (sort cl-seq cl-pred)
620 (sort cl-seq (function (lambda (cl-x cl-y)
621 (funcall cl-pred (funcall cl-key cl-x)
622 (funcall cl-key cl-y)))))))))
623
624(defun stable-sort (cl-seq cl-pred &rest cl-keys)
47bc4b3f
JB
625 "Sort the argument SEQ stably according to PREDICATE.
626This is a destructive function; it reuses the storage of SEQ if possible.
627\nKeywords supported: :key
628\n(fn SEQ PREDICATE [KEYWORD VALUE]...)"
fcd73769
RS
629 (apply 'sort* cl-seq cl-pred cl-keys))
630
631(defun merge (cl-type cl-seq1 cl-seq2 cl-pred &rest cl-keys)
632 "Destructively merge the two sequences to produce a new sequence.
47bc4b3f
JB
633TYPE is the sequence type to return, SEQ1 and SEQ2 are the two argument
634sequences, and PREDICATE is a `less-than' predicate on the elements.
635\nKeywords supported: :key
636\n(fn TYPE SEQ1 SEQ2 PREDICATE [KEYWORD VALUE]...)"
fcd73769
RS
637 (or (listp cl-seq1) (setq cl-seq1 (append cl-seq1 nil)))
638 (or (listp cl-seq2) (setq cl-seq2 (append cl-seq2 nil)))
639 (cl-parsing-keywords (:key) ()
640 (let ((cl-res nil))
641 (while (and cl-seq1 cl-seq2)
642 (if (funcall cl-pred (cl-check-key (car cl-seq2))
643 (cl-check-key (car cl-seq1)))
ca50d9e6
SM
644 (push (pop cl-seq2) cl-res)
645 (push (pop cl-seq1) cl-res)))
fcd73769
RS
646 (coerce (nconc (nreverse cl-res) cl-seq1 cl-seq2) cl-type))))
647
648;;; See compiler macro in cl-macs.el
649(defun member* (cl-item cl-list &rest cl-keys)
650 "Find the first occurrence of ITEM in LIST.
651Return the sublist of LIST whose car is ITEM.
47bc4b3f
JB
652\nKeywords supported: :test :test-not :key
653\n(fn ITEM LIST [KEYWORD VALUE]...)"
fcd73769
RS
654 (if cl-keys
655 (cl-parsing-keywords (:test :test-not :key :if :if-not) ()
656 (while (and cl-list (not (cl-check-test cl-item (car cl-list))))
657 (setq cl-list (cdr cl-list)))
658 cl-list)
659 (if (and (numberp cl-item) (not (integerp cl-item)))
660 (member cl-item cl-list)
661 (memq cl-item cl-list))))
662
663(defun member-if (cl-pred cl-list &rest cl-keys)
664 "Find the first item satisfying PREDICATE in LIST.
665Return the sublist of LIST whose car matches.
47bc4b3f
JB
666\nKeywords supported: :key
667\n(fn PREDICATE LIST [KEYWORD VALUE]...)"
64a4c526 668 (apply 'member* nil cl-list :if cl-pred cl-keys))
fcd73769
RS
669
670(defun member-if-not (cl-pred cl-list &rest cl-keys)
671 "Find the first item not satisfying PREDICATE in LIST.
672Return the sublist of LIST whose car matches.
47bc4b3f
JB
673\nKeywords supported: :key
674\n(fn PREDICATE LIST [KEYWORD VALUE]...)"
64a4c526 675 (apply 'member* nil cl-list :if-not cl-pred cl-keys))
fcd73769
RS
676
677(defun cl-adjoin (cl-item cl-list &rest cl-keys)
678 (if (cl-parsing-keywords (:key) t
679 (apply 'member* (cl-check-key cl-item) cl-list cl-keys))
680 cl-list
681 (cons cl-item cl-list)))
682
683;;; See compiler macro in cl-macs.el
684(defun assoc* (cl-item cl-alist &rest cl-keys)
685 "Find the first item whose car matches ITEM in LIST.
47bc4b3f
JB
686\nKeywords supported: :test :test-not :key
687\n(fn ITEM LIST [KEYWORD VALUE]...)"
fcd73769
RS
688 (if cl-keys
689 (cl-parsing-keywords (:test :test-not :key :if :if-not) ()
690 (while (and cl-alist
691 (or (not (consp (car cl-alist)))
692 (not (cl-check-test cl-item (car (car cl-alist))))))
693 (setq cl-alist (cdr cl-alist)))
694 (and cl-alist (car cl-alist)))
695 (if (and (numberp cl-item) (not (integerp cl-item)))
696 (assoc cl-item cl-alist)
697 (assq cl-item cl-alist))))
698
699(defun assoc-if (cl-pred cl-list &rest cl-keys)
700 "Find the first item whose car satisfies PREDICATE in LIST.
47bc4b3f
JB
701\nKeywords supported: :key
702\n(fn PREDICATE LIST [KEYWORD VALUE]...)"
64a4c526 703 (apply 'assoc* nil cl-list :if cl-pred cl-keys))
fcd73769
RS
704
705(defun assoc-if-not (cl-pred cl-list &rest cl-keys)
706 "Find the first item whose car does not satisfy PREDICATE in LIST.
47bc4b3f
JB
707\nKeywords supported: :key
708\n(fn PREDICATE LIST [KEYWORD VALUE]...)"
64a4c526 709 (apply 'assoc* nil cl-list :if-not cl-pred cl-keys))
fcd73769
RS
710
711(defun rassoc* (cl-item cl-alist &rest cl-keys)
712 "Find the first item whose cdr matches ITEM in LIST.
47bc4b3f
JB
713\nKeywords supported: :test :test-not :key
714\n(fn ITEM LIST [KEYWORD VALUE]...)"
fcd73769
RS
715 (if (or cl-keys (numberp cl-item))
716 (cl-parsing-keywords (:test :test-not :key :if :if-not) ()
717 (while (and cl-alist
718 (or (not (consp (car cl-alist)))
719 (not (cl-check-test cl-item (cdr (car cl-alist))))))
720 (setq cl-alist (cdr cl-alist)))
721 (and cl-alist (car cl-alist)))
722 (rassq cl-item cl-alist)))
723
fcd73769
RS
724(defun rassoc-if (cl-pred cl-list &rest cl-keys)
725 "Find the first item whose cdr satisfies PREDICATE in LIST.
47bc4b3f
JB
726\nKeywords supported: :key
727\n(fn PREDICATE LIST [KEYWORD VALUE]...)"
64a4c526 728 (apply 'rassoc* nil cl-list :if cl-pred cl-keys))
fcd73769
RS
729
730(defun rassoc-if-not (cl-pred cl-list &rest cl-keys)
731 "Find the first item whose cdr does not satisfy PREDICATE in LIST.
47bc4b3f
JB
732\nKeywords supported: :key
733\n(fn PREDICATE LIST [KEYWORD VALUE]...)"
64a4c526 734 (apply 'rassoc* nil cl-list :if-not cl-pred cl-keys))
fcd73769
RS
735
736(defun union (cl-list1 cl-list2 &rest cl-keys)
737 "Combine LIST1 and LIST2 using a set-union operation.
738The result list contains all items that appear in either LIST1 or LIST2.
739This is a non-destructive function; it makes a copy of the data if necessary
740to avoid corrupting the original LIST1 and LIST2.
47bc4b3f
JB
741\nKeywords supported: :test :test-not :key
742\n(fn LIST1 LIST2 [KEYWORD VALUE]...)"
fcd73769
RS
743 (cond ((null cl-list1) cl-list2) ((null cl-list2) cl-list1)
744 ((equal cl-list1 cl-list2) cl-list1)
745 (t
746 (or (>= (length cl-list1) (length cl-list2))
747 (setq cl-list1 (prog1 cl-list2 (setq cl-list2 cl-list1))))
748 (while cl-list2
749 (if (or cl-keys (numberp (car cl-list2)))
750 (setq cl-list1 (apply 'adjoin (car cl-list2) cl-list1 cl-keys))
751 (or (memq (car cl-list2) cl-list1)
ca50d9e6
SM
752 (push (car cl-list2) cl-list1)))
753 (pop cl-list2))
fcd73769
RS
754 cl-list1)))
755
756(defun nunion (cl-list1 cl-list2 &rest cl-keys)
757 "Combine LIST1 and LIST2 using a set-union operation.
758The result list contains all items that appear in either LIST1 or LIST2.
759This is a destructive function; it reuses the storage of LIST1 and LIST2
760whenever possible.
47bc4b3f
JB
761\nKeywords supported: :test :test-not :key
762\n(fn LIST1 LIST2 [KEYWORD VALUE]...)"
fcd73769
RS
763 (cond ((null cl-list1) cl-list2) ((null cl-list2) cl-list1)
764 (t (apply 'union cl-list1 cl-list2 cl-keys))))
765
766(defun intersection (cl-list1 cl-list2 &rest cl-keys)
767 "Combine LIST1 and LIST2 using a set-intersection operation.
768The result list contains all items that appear in both LIST1 and LIST2.
769This is a non-destructive function; it makes a copy of the data if necessary
770to avoid corrupting the original LIST1 and LIST2.
47bc4b3f
JB
771\nKeywords supported: :test :test-not :key
772\n(fn LIST1 LIST2 [KEYWORD VALUE]...)"
fcd73769
RS
773 (and cl-list1 cl-list2
774 (if (equal cl-list1 cl-list2) cl-list1
775 (cl-parsing-keywords (:key) (:test :test-not)
776 (let ((cl-res nil))
777 (or (>= (length cl-list1) (length cl-list2))
778 (setq cl-list1 (prog1 cl-list2 (setq cl-list2 cl-list1))))
779 (while cl-list2
780 (if (if (or cl-keys (numberp (car cl-list2)))
781 (apply 'member* (cl-check-key (car cl-list2))
782 cl-list1 cl-keys)
783 (memq (car cl-list2) cl-list1))
ca50d9e6
SM
784 (push (car cl-list2) cl-res))
785 (pop cl-list2))
fcd73769
RS
786 cl-res)))))
787
788(defun nintersection (cl-list1 cl-list2 &rest cl-keys)
789 "Combine LIST1 and LIST2 using a set-intersection operation.
790The result list contains all items that appear in both LIST1 and LIST2.
791This is a destructive function; it reuses the storage of LIST1 and LIST2
792whenever possible.
47bc4b3f
JB
793\nKeywords supported: :test :test-not :key
794\n(fn LIST1 LIST2 [KEYWORD VALUE]...)"
fcd73769
RS
795 (and cl-list1 cl-list2 (apply 'intersection cl-list1 cl-list2 cl-keys)))
796
797(defun set-difference (cl-list1 cl-list2 &rest cl-keys)
798 "Combine LIST1 and LIST2 using a set-difference operation.
799The result list contains all items that appear in LIST1 but not LIST2.
800This is a non-destructive function; it makes a copy of the data if necessary
801to avoid corrupting the original LIST1 and LIST2.
47bc4b3f
JB
802\nKeywords supported: :test :test-not :key
803\n(fn LIST1 LIST2 [KEYWORD VALUE]...)"
fcd73769
RS
804 (if (or (null cl-list1) (null cl-list2)) cl-list1
805 (cl-parsing-keywords (:key) (:test :test-not)
806 (let ((cl-res nil))
807 (while cl-list1
808 (or (if (or cl-keys (numberp (car cl-list1)))
809 (apply 'member* (cl-check-key (car cl-list1))
810 cl-list2 cl-keys)
811 (memq (car cl-list1) cl-list2))
ca50d9e6
SM
812 (push (car cl-list1) cl-res))
813 (pop cl-list1))
fcd73769
RS
814 cl-res))))
815
816(defun nset-difference (cl-list1 cl-list2 &rest cl-keys)
817 "Combine LIST1 and LIST2 using a set-difference operation.
818The result list contains all items that appear in LIST1 but not LIST2.
819This is a destructive function; it reuses the storage of LIST1 and LIST2
820whenever possible.
47bc4b3f
JB
821\nKeywords supported: :test :test-not :key
822\n(fn LIST1 LIST2 [KEYWORD VALUE]...)"
fcd73769
RS
823 (if (or (null cl-list1) (null cl-list2)) cl-list1
824 (apply 'set-difference cl-list1 cl-list2 cl-keys)))
825
826(defun set-exclusive-or (cl-list1 cl-list2 &rest cl-keys)
827 "Combine LIST1 and LIST2 using a set-exclusive-or operation.
828The result list contains all items that appear in exactly one of LIST1, LIST2.
829This is a non-destructive function; it makes a copy of the data if necessary
830to avoid corrupting the original LIST1 and LIST2.
47bc4b3f
JB
831\nKeywords supported: :test :test-not :key
832\n(fn LIST1 LIST2 [KEYWORD VALUE]...)"
fcd73769
RS
833 (cond ((null cl-list1) cl-list2) ((null cl-list2) cl-list1)
834 ((equal cl-list1 cl-list2) nil)
835 (t (append (apply 'set-difference cl-list1 cl-list2 cl-keys)
836 (apply 'set-difference cl-list2 cl-list1 cl-keys)))))
837
838(defun nset-exclusive-or (cl-list1 cl-list2 &rest cl-keys)
839 "Combine LIST1 and LIST2 using a set-exclusive-or operation.
840The result list contains all items that appear in exactly one of LIST1, LIST2.
841This is a destructive function; it reuses the storage of LIST1 and LIST2
842whenever possible.
47bc4b3f
JB
843\nKeywords supported: :test :test-not :key
844\n(fn LIST1 LIST2 [KEYWORD VALUE]...)"
fcd73769
RS
845 (cond ((null cl-list1) cl-list2) ((null cl-list2) cl-list1)
846 ((equal cl-list1 cl-list2) nil)
847 (t (nconc (apply 'nset-difference cl-list1 cl-list2 cl-keys)
848 (apply 'nset-difference cl-list2 cl-list1 cl-keys)))))
849
850(defun subsetp (cl-list1 cl-list2 &rest cl-keys)
213233f0 851 "Return true if LIST1 is a subset of LIST2.
fcd73769 852I.e., if every element of LIST1 also appears in LIST2.
47bc4b3f
JB
853\nKeywords supported: :test :test-not :key
854\n(fn LIST1 LIST2 [KEYWORD VALUE]...)"
fcd73769
RS
855 (cond ((null cl-list1) t) ((null cl-list2) nil)
856 ((equal cl-list1 cl-list2) t)
857 (t (cl-parsing-keywords (:key) (:test :test-not)
858 (while (and cl-list1
859 (apply 'member* (cl-check-key (car cl-list1))
860 cl-list2 cl-keys))
ca50d9e6 861 (pop cl-list1))
fcd73769
RS
862 (null cl-list1)))))
863
864(defun subst-if (cl-new cl-pred cl-tree &rest cl-keys)
865 "Substitute NEW for elements matching PREDICATE in TREE (non-destructively).
866Return a copy of TREE with all matching elements replaced by NEW.
47bc4b3f
JB
867\nKeywords supported: :key
868\n(fn NEW PREDICATE TREE [KEYWORD VALUE]...)"
64a4c526 869 (apply 'sublis (list (cons nil cl-new)) cl-tree :if cl-pred cl-keys))
fcd73769
RS
870
871(defun subst-if-not (cl-new cl-pred cl-tree &rest cl-keys)
872 "Substitute NEW for elts not matching PREDICATE in TREE (non-destructively).
873Return a copy of TREE with all non-matching elements replaced by NEW.
47bc4b3f
JB
874\nKeywords supported: :key
875\n(fn NEW PREDICATE TREE [KEYWORD VALUE]...)"
64a4c526 876 (apply 'sublis (list (cons nil cl-new)) cl-tree :if-not cl-pred cl-keys))
fcd73769
RS
877
878(defun nsubst (cl-new cl-old cl-tree &rest cl-keys)
879 "Substitute NEW for OLD everywhere in TREE (destructively).
880Any element of TREE which is `eql' to OLD is changed to NEW (via a call
881to `setcar').
47bc4b3f
JB
882\nKeywords supported: :test :test-not :key
883\n(fn NEW OLD TREE [KEYWORD VALUE]...)"
fcd73769
RS
884 (apply 'nsublis (list (cons cl-old cl-new)) cl-tree cl-keys))
885
886(defun nsubst-if (cl-new cl-pred cl-tree &rest cl-keys)
887 "Substitute NEW for elements matching PREDICATE in TREE (destructively).
888Any element of TREE which matches is changed to NEW (via a call to `setcar').
47bc4b3f
JB
889\nKeywords supported: :key
890\n(fn NEW PREDICATE TREE [KEYWORD VALUE]...)"
64a4c526 891 (apply 'nsublis (list (cons nil cl-new)) cl-tree :if cl-pred cl-keys))
fcd73769
RS
892
893(defun nsubst-if-not (cl-new cl-pred cl-tree &rest cl-keys)
894 "Substitute NEW for elements not matching PREDICATE in TREE (destructively).
895Any element of TREE which matches is changed to NEW (via a call to `setcar').
47bc4b3f
JB
896\nKeywords supported: :key
897\n(fn NEW PREDICATE TREE [KEYWORD VALUE]...)"
64a4c526 898 (apply 'nsublis (list (cons nil cl-new)) cl-tree :if-not cl-pred cl-keys))
fcd73769
RS
899
900(defun sublis (cl-alist cl-tree &rest cl-keys)
901 "Perform substitutions indicated by ALIST in TREE (non-destructively).
902Return a copy of TREE with all matching elements replaced.
47bc4b3f
JB
903\nKeywords supported: :test :test-not :key
904\n(fn ALIST TREE [KEYWORD VALUE]...)"
fcd73769
RS
905 (cl-parsing-keywords (:test :test-not :key :if :if-not) ()
906 (cl-sublis-rec cl-tree)))
907
908(defvar cl-alist)
909(defun cl-sublis-rec (cl-tree) ; uses cl-alist/key/test*/if*
910 (let ((cl-temp (cl-check-key cl-tree)) (cl-p cl-alist))
911 (while (and cl-p (not (cl-check-test-nokey (car (car cl-p)) cl-temp)))
912 (setq cl-p (cdr cl-p)))
913 (if cl-p (cdr (car cl-p))
914 (if (consp cl-tree)
915 (let ((cl-a (cl-sublis-rec (car cl-tree)))
916 (cl-d (cl-sublis-rec (cdr cl-tree))))
917 (if (and (eq cl-a (car cl-tree)) (eq cl-d (cdr cl-tree)))
918 cl-tree
919 (cons cl-a cl-d)))
920 cl-tree))))
921
922(defun nsublis (cl-alist cl-tree &rest cl-keys)
923 "Perform substitutions indicated by ALIST in TREE (destructively).
924Any matching element of TREE is changed via a call to `setcar'.
47bc4b3f
JB
925\nKeywords supported: :test :test-not :key
926\n(fn ALIST TREE [KEYWORD VALUE]...)"
fcd73769
RS
927 (cl-parsing-keywords (:test :test-not :key :if :if-not) ()
928 (let ((cl-hold (list cl-tree)))
929 (cl-nsublis-rec cl-hold)
930 (car cl-hold))))
931
932(defun cl-nsublis-rec (cl-tree) ; uses cl-alist/temp/p/key/test*/if*
933 (while (consp cl-tree)
934 (let ((cl-temp (cl-check-key (car cl-tree))) (cl-p cl-alist))
935 (while (and cl-p (not (cl-check-test-nokey (car (car cl-p)) cl-temp)))
936 (setq cl-p (cdr cl-p)))
937 (if cl-p (setcar cl-tree (cdr (car cl-p)))
938 (if (consp (car cl-tree)) (cl-nsublis-rec (car cl-tree))))
939 (setq cl-temp (cl-check-key (cdr cl-tree)) cl-p cl-alist)
940 (while (and cl-p (not (cl-check-test-nokey (car (car cl-p)) cl-temp)))
941 (setq cl-p (cdr cl-p)))
942 (if cl-p
943 (progn (setcdr cl-tree (cdr (car cl-p))) (setq cl-tree nil))
944 (setq cl-tree (cdr cl-tree))))))
945
946(defun tree-equal (cl-x cl-y &rest cl-keys)
47bc4b3f 947 "Return t if trees TREE1 and TREE2 have `eql' leaves.
fcd73769 948Atoms are compared by `eql'; cons cells are compared recursively.
47bc4b3f
JB
949\nKeywords supported: :test :test-not :key
950\n(fn TREE1 TREE2 [KEYWORD VALUE]...)"
fcd73769
RS
951 (cl-parsing-keywords (:test :test-not :key) ()
952 (cl-tree-equal-rec cl-x cl-y)))
953
954(defun cl-tree-equal-rec (cl-x cl-y)
955 (while (and (consp cl-x) (consp cl-y)
956 (cl-tree-equal-rec (car cl-x) (car cl-y)))
957 (setq cl-x (cdr cl-x) cl-y (cdr cl-y)))
958 (and (not (consp cl-x)) (not (consp cl-y)) (cl-check-match cl-x cl-y)))
959
960
961(run-hooks 'cl-seq-load-hook)
962
ab5796a9 963;;; arch-tag: ec1cc072-9006-4225-b6ba-d6b07ed1710c
fcd73769 964;;; cl-seq.el ends here