1 ;;; srfi-1.scm --- List Library
3 ;; Copyright (C) 2001, 2002 Free Software Foundation, Inc.
5 ;; This program is free software; you can redistribute it and/or
6 ;; modify it under the terms of the GNU General Public License as
7 ;; published by the Free Software Foundation; either version 2, or
8 ;; (at your option) any later version.
10 ;; This program is distributed in the hope that it will be useful,
11 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 ;; General Public License for more details.
15 ;; You should have received a copy of the GNU General Public License
16 ;; along with this software; see the file COPYING. If not, write to
17 ;; the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 ;; Boston, MA 02111-1307 USA
20 ;; As a special exception, the Free Software Foundation gives permission
21 ;; for additional uses of the text contained in its release of GUILE.
23 ;; The exception is that, if you link the GUILE library with other files
24 ;; to produce an executable, this does not by itself cause the
25 ;; resulting executable to be covered by the GNU General Public License.
26 ;; Your use of that executable is in no way restricted on account of
27 ;; linking the GUILE library code into it.
29 ;; This exception does not however invalidate any other reasons why
30 ;; the executable file might be covered by the GNU General Public License.
32 ;; This exception applies only to the code released by the
33 ;; Free Software Foundation under the name GUILE. If you copy
34 ;; code from other Free Software Foundation releases into a copy of
35 ;; GUILE, as the General Public License permits, the exception does
36 ;; not apply to the code that you add in this way. To avoid misleading
37 ;; anyone as to the status of such modified files, you must delete
38 ;; this exception notice from them.
40 ;; If you write modifications of your own for GUILE, it is your choice
41 ;; whether to permit this exception to apply to your modifications.
42 ;; If you do not wish that, delete this exception notice.
44 ;;; Author: Martin Grabmueller <mgrabmue@cs.tu-berlin.de>
49 ;; This is an implementation of SRFI-1 (List Library).
51 ;; All procedures defined in SRFI-1, which are not already defined in
52 ;; the Guile core library, are exported. The procedures in this
53 ;; implementation work, but they have not been tuned for speed or
56 ;; This module is fully documented in the Guile Reference Manual.
60 (define-module (srfi srfi-1)
61 :use-module (ice-9 session)
62 :use-module (ice-9 receive))
65 ;; Prevent `export' from re-exporting core bindings. This behaviour
66 ;; of `export' is deprecated and will disappear in one of the next
70 (define map-in-order #f)
72 (define list-index #f)
80 ;; cons <= in the core
81 ;; list <= in the core
83 ;; cons* <= in the core
84 ;; make-list <= in the core
86 ;; list-copy <= in the core
94 ;; pair? <= in the core
95 ;; null? <= in the core
101 ;; car <= in the core
102 ;; cdr <= in the core
103 ;; caar <= in the core
104 ;; cadr <= in the core
105 ;; cdar <= in the core
106 ;; cddr <= in the core
107 ;; caaar <= in the core
108 ;; caadr <= in the core
109 ;; cadar <= in the core
110 ;; caddr <= in the core
111 ;; cdaar <= in the core
112 ;; cdadr <= in the core
113 ;; cddar <= in the core
114 ;; cdddr <= in the core
115 ;; caaaar <= in the core
116 ;; caaadr <= in the core
117 ;; caadar <= in the core
118 ;; caaddr <= in the core
119 ;; cadaar <= in the core
120 ;; cadadr <= in the core
121 ;; caddar <= in the core
122 ;; cadddr <= in the core
123 ;; cdaaar <= in the core
124 ;; cdaadr <= in the core
125 ;; cdadar <= in the core
126 ;; cdaddr <= in the core
127 ;; cddaar <= in the core
128 ;; cddadr <= in the core
129 ;; cdddar <= in the core
130 ;; cddddr <= in the core
131 ;; list-ref <= in the core
152 ;; last-pair <= in the core
154 ;;; Miscelleneous: length, append, concatenate, reverse, zip & count
155 ;; length <= in the core
157 ;; append <= in the core
158 ;; append! <= in the core
161 ;; reverse <= in the core
162 ;; reverse! <= in the core
173 ;;; Fold, unfold & map
187 map-in-order ; Extended.
191 ;;; Filtering & partitioning
211 list-index ; Extended.
213 ;; memq <= in the core
214 ;; memv <= in the core
222 ;;; Association lists
224 ;; assq <= in the core
225 ;; assv <= in the core
231 ;;; Set operations on lists
239 lset-diff+intersection
244 lset-diff+intersection!
246 ;;; Primitive side-effects
247 ;; set-car! <= in the core
248 ;; set-cdr! <= in the core
251 (cond-expand-provide (current-module) '(srfi-1))
258 ;; internal helper, similar to (scsh utilities) check-arg.
259 (define (check-arg-type pred arg caller)
262 (scm-error 'wrong-type-arg caller
263 "Wrong type argument: ~S" (list arg) '())))
265 ;; the srfi spec doesn't seem to forbid inexact integers.
266 (define (non-negative-integer? x) (and (integer? x) (>= x 0)))
268 (define (list-tabulate n init-proc)
269 (check-arg-type non-negative-integer? n "list-tabulate")
270 (let lp ((n n) (acc '()))
273 (lp (- n 1) (cons (init-proc (- n 1)) acc)))))
275 (define (circular-list elt1 . rest)
276 (let ((start (cons elt1 '())))
277 (let lp ((r rest) (p start))
283 (set-cdr! p (cons (car r) '()))
284 (lp (cdr r) (cdr p)))))))
286 (define (iota count . rest)
287 (check-arg-type non-negative-integer? count "iota")
288 (let ((start (if (pair? rest) (car rest) 0))
289 (step (if (and (pair? rest) (pair? (cdr rest))) (cadr rest) 1)))
290 (let lp ((n 0) (acc '()))
293 (lp (+ n 1) (cons (+ start (* n step)) acc))))))
297 (define (proper-list? x)
300 (define (circular-list? x)
303 (let lp ((hare (cdr x)) (tortoise x))
306 (let ((hare (cdr hare)))
309 (if (eq? hare tortoise)
311 (lp (cdr hare) (cdr tortoise)))))))))
313 (define (dotted-list? x)
318 (let lp ((hare (cdr x)) (tortoise x))
321 ((not-pair? hare) #t)
323 (let ((hare (cdr hare)))
326 ((not-pair? hare) #t)
327 ((eq? hare tortoise) #f)
329 (lp (cdr hare) (cdr tortoise)))))))))))
331 (define (null-list? x)
338 (error "not a proper list in null-list?"))))
340 (define (not-pair? x)
343 (define (list= elt= . rest)
344 (define (lists-equal a b)
345 (let lp ((a a) (b b))
351 (and (elt= (car a) (car b))
352 (lp (cdr a) (cdr b)))))))
354 (let ((first (car rest)))
355 (let lp ((lists rest))
357 (and (lists-equal first (car lists))
358 (lp (cdr lists))))))))
365 (define fourth cadddr)
366 (define (fifth x) (car (cddddr x)))
367 (define (sixth x) (cadr (cddddr x)))
368 (define (seventh x) (caddr (cddddr x)))
369 (define (eighth x) (cadddr (cddddr x)))
370 (define (ninth x) (car (cddddr (cddddr x))))
371 (define (tenth x) (cadr (cddddr (cddddr x))))
373 (define (car+cdr x) (values (car x) (cdr x)))
376 (let lp ((n i) (l x) (acc '()))
379 (lp (- n 1) (cdr l) (cons (car l) acc)))))
381 (let lp ((n i) (l x))
384 (lp (- n 1) (cdr l)))))
385 (define (take-right flist i)
386 (let lp ((n i) (l flist))
388 (let lp0 ((s flist) (l l))
391 (lp0 (cdr s) (cdr l))))
392 (lp (- n 1) (cdr l)))))
394 (define (drop-right flist i)
395 (let lp ((n i) (l flist))
397 (let lp0 ((s flist) (l l) (acc '()))
400 (lp0 (cdr s) (cdr l) (cons (car s) acc))))
401 (lp (- n 1) (cdr l)))))
406 (let lp ((n (- i 1)) (l x))
411 (lp (- n 1) (cdr l))))))
413 (define (drop-right! flist i)
416 (let lp ((n (+ i 1)) (l flist))
418 (let lp0 ((s flist) (l l))
423 (lp0 (cdr s) (cdr l))))
426 (lp (- n 1) (cdr l)))))))
428 (define (split-at x i)
429 (let lp ((l x) (n i) (acc '()))
431 (values (reverse! acc) l)
432 (lp (cdr l) (- n 1) (cons (car l) acc)))))
434 (define (split-at! x i)
437 (let lp ((l x) (n (- i 1)))
442 (lp (cdr l) (- n 1))))))
445 (car (last-pair pair)))
447 ;;; Miscelleneous: length, append, concatenate, reverse, zip & count
449 (define (length+ clist)
452 (let lp ((hare (cdr clist)) (tortoise clist) (l 1))
455 (let ((hare (cdr hare)))
458 (if (eq? hare tortoise)
460 (lp (cdr hare) (cdr tortoise) (+ l 2)))))))))
462 (define (concatenate l-o-l)
463 (let lp ((l l-o-l) (acc '()))
466 (let lp0 ((ll (car l)) (acc acc))
469 (lp0 (cdr ll) (cons (car ll) acc)))))))
471 (define (concatenate! l-o-l)
472 (let lp0 ((l-o-l l-o-l))
479 (let ((result (car l-o-l)) (tail (last-pair (car l-o-l))))
480 (let lp ((l (cdr l-o-l)) (ntail tail))
484 (set-cdr! ntail (car l))
485 (lp (cdr l) (last-pair ntail))))))))))
488 (define (append-reverse rev-head tail)
489 (let lp ((l rev-head) (acc tail))
492 (lp (cdr l) (cons (car l) acc)))))
494 (define (append-reverse! rev-head tail)
495 (append-reverse rev-head tail)) ; XXX:optimize
497 (define (zip clist1 . rest)
498 (let lp ((l (cons clist1 rest)) (acc '()))
501 (lp (map1 cdr l) (cons (map1 car l) acc)))))
507 (values (map1 first l) (map1 second l)))
509 (values (map1 first l) (map1 second l) (map1 third l)))
511 (values (map1 first l) (map1 second l) (map1 third l) (map1 fourth l)))
513 (values (map1 first l) (map1 second l) (map1 third l) (map1 fourth l)
516 (define (count pred clist1 . rest)
519 (let lp ((lists (cons clist1 rest)))
520 (cond ((any1 null? lists)
523 (if (apply pred (map1 car lists))
524 (+ 1 (lp (map1 cdr lists)))
525 (lp (map1 cdr lists))))))))
527 (define (count1 pred clist)
528 (let lp ((result 0) (rest clist))
531 (if (pred (car rest))
532 (lp (+ 1 result) (cdr rest))
533 (lp result (cdr rest))))))
535 ;;; Fold, unfold & map
537 (define (fold kons knil list1 . rest)
539 (let f ((knil knil) (list1 list1))
542 (f (kons (car list1) knil) (cdr list1))))
543 (let f ((knil knil) (lists (cons list1 rest)))
544 (if (any null? lists)
546 (let ((cars (map1 car lists))
547 (cdrs (map1 cdr lists)))
548 (f (apply kons (append! cars (list knil))) cdrs))))))
550 (define (fold-right kons knil clist1 . rest)
552 (let f ((list1 clist1))
555 (kons (car list1) (f (cdr list1)))))
556 (let f ((lists (cons clist1 rest)))
557 (if (any null? lists)
559 (apply kons (append! (map1 car lists) (list (f (map1 cdr lists)))))))))
561 (define (pair-fold kons knil clist1 . rest)
563 (let f ((knil knil) (list1 clist1))
566 (let ((tail (cdr list1)))
567 (f (kons list1 knil) tail))))
568 (let f ((knil knil) (lists (cons clist1 rest)))
569 (if (any null? lists)
571 (let ((tails (map1 cdr lists)))
572 (f (apply kons (append! lists (list knil))) tails))))))
575 (define (pair-fold-right kons knil clist1 . rest)
577 (let f ((list1 clist1))
580 (kons list1 (f (cdr list1)))))
581 (let f ((lists (cons clist1 rest)))
582 (if (any null? lists)
584 (apply kons (append! lists (list (f (map1 cdr lists)))))))))
586 (define (unfold p f g seed . rest)
587 (let ((tail-gen (if (pair? rest)
588 (if (pair? (cdr rest))
589 (scm-error 'wrong-number-of-args
590 "unfold" "too many arguments" '() '())
593 (let uf ((seed seed))
599 (define (unfold-right p f g seed . rest)
600 (let ((tail (if (pair? rest)
601 (if (pair? (cdr rest))
602 (scm-error 'wrong-number-of-args
603 "unfold-right" "too many arguments" '()
607 (let uf ((seed seed) (lis tail))
610 (uf (g seed) (cons (f seed) lis))))))
612 (define (reduce f ridentity lst)
613 (fold f ridentity lst))
615 (define (reduce-right f ridentity lst)
616 (fold-right f ridentity lst))
619 ;; Internal helper procedure. Map `f' over the single list `ls'.
624 (let ((ret (list (f (car ls)))))
625 (let lp ((ls (cdr ls)) (p ret)) ; tail pointer
629 (set-cdr! p (list (f (car ls))))
630 (lp (cdr ls) (cdr p))))))))
632 ;; This `map' is extended from the standard `map'. It allows argument
633 ;; lists of different length, so that the shortest list determines the
634 ;; number of elements processed.
636 (define (map f list1 . rest)
639 (let lp ((l (cons list1 rest)))
642 (cons (apply f (map1 car l)) (lp (map1 cdr l)))))))
644 ;; extended to lists of unequal length.
645 (define map-in-order map)
647 ;; This `for-each' is extended from the standard `for-each'. It
648 ;; allows argument lists of different length, so that the shortest
649 ;; list determines the number of elements processed.
651 (define (for-each f list1 . rest)
655 (if #f #f) ; Return unspecified value.
659 (let lp ((l (cons list1 rest)))
663 (apply f (map1 car l))
664 (lp (map1 cdr l)))))))
667 (define (append-map f clist1 . rest)
672 (append (f (car l)) (lp (cdr l)))))
673 (let lp ((l (cons clist1 rest)))
676 (append (apply f (map1 car l)) (lp (map1 cdr l)))))))
679 (define (append-map! f clist1 . rest)
684 (append! (f (car l)) (lp (cdr l)))))
685 (let lp ((l (cons clist1 rest)))
688 (append! (apply f (map1 car l)) (lp (map1 cdr l)))))))
690 (define (map! f list1 . rest)
696 (set-car! l (f (car l)))
697 (set-cdr! l (lp (cdr l)))
699 (let lp ((l (cons list1 rest)) (res list1))
703 (set-car! res (apply f (map1 car l)))
704 (set-cdr! res (lp (map1 cdr l) (cdr res)))
707 (define (pair-for-each f clist1 . rest)
715 (let lp ((l (cons clist1 rest)))
720 (lp (map1 cdr l)))))))
722 (define (filter-map f clist1 . rest)
727 (let ((res (f (car l))))
729 (cons res (lp (cdr l)))
731 (let lp ((l (cons clist1 rest)))
734 (let ((res (apply f (map1 car l))))
736 (cons res (lp (map1 cdr l)))
737 (lp (map1 cdr l))))))))
739 ;;; Filtering & partitioning
741 (define (filter pred list)
742 (check-arg-type list? list "filter") ; reject circular lists.
743 (letrec ((filiter (lambda (pred rest result)
746 (filiter pred (cdr rest)
747 (cond ((pred (car rest))
748 (cons (car rest) result))
751 (filiter pred list '())))
753 (define (partition pred list)
756 (if (pred (car list))
757 (receive (in out) (partition pred (cdr list))
758 (values (cons (car list) in) out))
759 (receive (in out) (partition pred (cdr list))
760 (values in (cons (car list) out))))))
762 (define (remove pred list)
763 (filter (lambda (x) (not (pred x))) list))
765 (define (filter! pred list)
766 (filter pred list)) ; XXX:optimize
768 (define (partition! pred list)
769 (partition pred list)) ; XXX:optimize
771 (define (remove! pred list)
772 (remove pred list)) ; XXX:optimize
776 (define (find pred clist)
779 (if (pred (car clist))
781 (find pred (cdr clist)))))
783 (define (find-tail pred clist)
786 (if (pred (car clist))
788 (find-tail pred (cdr clist)))))
790 (define (take-while pred ls)
791 (cond ((null? ls) '())
792 ((not (pred (car ls))) '())
794 (let ((result (list (car ls))))
795 (let lp ((ls (cdr ls)) (p result))
796 (cond ((null? ls) result)
797 ((not (pred (car ls))) result)
799 (set-cdr! p (list (car ls)))
800 (lp (cdr ls) (cdr p)))))))))
802 (define (take-while! pred clist)
803 (take-while pred clist)) ; XXX:optimize
805 (define (drop-while pred clist)
808 (if (pred (car clist))
809 (drop-while pred (cdr clist))
812 (define (span pred clist)
815 (if (pred (car clist))
816 (receive (first last) (span pred (cdr clist))
817 (values (cons (car clist) first) last))
818 (values '() clist))))
820 (define (span! pred list)
821 (span pred list)) ; XXX:optimize
823 (define (break pred clist)
826 (if (pred (car clist))
828 (receive (first last) (break pred (cdr clist))
829 (values (cons (car clist) first) last)))))
831 (define (break! pred list)
832 (break pred list)) ; XXX:optimize
834 (define (any pred ls . lists)
837 (let lp ((lists (cons ls lists)))
838 (cond ((any1 null? lists)
840 ((any1 null? (map1 cdr lists))
841 (apply pred (map1 car lists)))
843 (or (apply pred (map1 car lists)) (lp (map1 cdr lists))))))))
845 (define (any1 pred ls)
852 (or (pred (car ls)) (lp (cdr ls)))))))
854 (define (every pred ls . lists)
857 (let lp ((lists (cons ls lists)))
858 (cond ((any1 null? lists)
860 ((any1 null? (map1 cdr lists))
861 (apply pred (map1 car lists)))
863 (and (apply pred (map1 car lists)) (lp (map1 cdr lists))))))))
865 (define (every1 pred ls)
872 (and (pred (car ls)) (lp (cdr ls)))))))
874 (define (list-index pred clist1 . rest)
876 (let lp ((l clist1) (i 0))
881 (lp (cdr l) (+ i 1)))))
882 (let lp ((lists (cons clist1 rest)) (i 0))
883 (cond ((any1 null? lists)
885 ((apply pred (map1 car lists)) i)
887 (lp (map1 cdr lists) (+ i 1)))))))
889 (define (member x list . rest)
890 (let ((l= (if (pair? rest) (car rest) equal?)))
900 (define (delete x list . rest)
901 (let ((l= (if (pair? rest) (car rest) equal?)))
907 (cons (car l) (lp (cdr l))))))))
909 (define (delete! x list . rest)
910 (let ((l= (if (pair? rest) (car rest) equal?)))
911 (delete x list l=))) ; XXX:optimize
913 (define (delete-duplicates list . rest)
914 (let ((l= (if (pair? rest) (car rest) equal?)))
918 (if (let lp1 ((l2 (cdr l1)))
921 (if (l= (car l1) (car l2))
925 (cons (car l1) (lp0 (cdr l1))))))))
927 (define (delete-duplicates list . rest)
928 (let ((l= (if (pair? rest) (car rest) equal?)))
929 (let lp ((list list))
932 (cons (car list) (lp (delete (car list) (cdr list) l=)))))))
934 (define (delete-duplicates! list . rest)
935 (let ((l= (if (pair? rest) (car rest) equal?)))
936 (delete-duplicates list l=))) ; XXX:optimize
938 ;;; Association lists
940 (define (assoc key alist . rest)
941 (let ((k= (if (pair? rest) (car rest) equal?)))
945 (if (k= key (caar a))
949 (define (alist-cons key datum alist)
950 (acons key datum alist))
952 (define (alist-copy alist)
956 (acons (caar a) (cdar a) (lp (cdr a))))))
958 (define (alist-delete key alist . rest)
959 (let ((k= (if (pair? rest) (car rest) equal?)))
963 (if (k= (caar a) key)
965 (cons (car a) (lp (cdr a))))))))
967 (define (alist-delete! key alist . rest)
968 (let ((k= (if (pair? rest) (car rest) equal?)))
969 (alist-delete key alist k=))) ; XXX:optimize
971 ;;; Set operations on lists
973 (define (lset<= = . rest)
976 (let lp ((f (car rest)) (r (cdr rest)))
978 (and (every (lambda (el) (member el (car r) =)) f)
979 (lp (car r) (cdr r)))))))
981 (define (lset= = list1 . rest)
984 (let lp ((f list1) (r rest))
986 (and (every (lambda (el) (member el (car r) =)) f)
987 (every (lambda (el) (member el f =)) (car r))
988 (lp (car r) (cdr r)))))))
990 (define (lset-adjoin = list . rest)
991 (let lp ((l rest) (acc list))
994 (if (member (car l) acc)
996 (lp (cdr l) (cons (car l) acc))))))
998 (define (lset-union = . rest)
999 (let lp0 ((l rest) (acc '()))
1002 (let lp1 ((ll (car l)) (acc acc))
1005 (if (member (car ll) acc =)
1007 (lp1 (cdr ll) (cons (car ll) acc))))))))
1009 (define (lset-intersection = list1 . rest)
1010 (let lp ((l list1) (acc '()))
1013 (if (every (lambda (ll) (member (car l) ll =)) rest)
1014 (lp (cdr l) (cons (car l) acc))
1015 (lp (cdr l) acc)))))
1017 (define (lset-difference = list1 . rest)
1020 (let lp ((l list1) (acc '()))
1023 (if (any (lambda (ll) (member (car l) ll =)) rest)
1025 (lp (cdr l) (cons (car l) acc)))))))
1027 ;(define (fold kons knil list1 . rest)
1029 (define (lset-xor = . rest)
1030 (fold (lambda (lst res)
1031 (let lp ((l lst) (acc '()))
1033 (let lp0 ((r res) (acc acc))
1036 (if (member (car r) lst =)
1038 (lp0 (cdr r) (cons (car r) acc)))))
1039 (if (member (car l) res =)
1041 (lp (cdr l) (cons (car l) acc))))))
1045 (define (lset-diff+intersection = list1 . rest)
1046 (let lp ((l list1) (accd '()) (acci '()))
1048 (values (reverse! accd) (reverse! acci))
1049 (let ((appears (every (lambda (ll) (member (car l) ll =)) rest)))
1051 (lp (cdr l) accd (cons (car l) acci))
1052 (lp (cdr l) (cons (car l) accd) acci))))))
1055 (define (lset-union! = . rest)
1056 (apply lset-union = rest)) ; XXX:optimize
1058 (define (lset-intersection! = list1 . rest)
1059 (apply lset-intersection = list1 rest)) ; XXX:optimize
1061 (define (lset-difference! = list1 . rest)
1062 (apply lset-difference = list1 rest)) ; XXX:optimize
1064 (define (lset-xor! = . rest)
1065 (apply lset-xor = rest)) ; XXX:optimize
1067 (define (lset-diff+intersection! = list1 . rest)
1068 (apply lset-diff+intersection = list1 rest)) ; XXX:optimize
1070 ;;; srfi-1.scm ends here