src/list.lisp

   1 ;;; list.lisp ---
   2
   3 ;; JSCL is free software: you can redistribute it and/or
   4 ;; modify it under the terms of the GNU General Public License as
   5 ;; published by the Free Software Foundation, either version 3 of the
   6 ;; License, or (at your option) any later version.
   7 ;;
   8 ;; JSCL is distributed in the hope that it will be useful, but
   9 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  10 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 ;; General Public License for more details.
  12 ;;
  13 ;; You should have received a copy of the GNU General Public License
  14 ;; along with JSCL.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 (/debug "loading list.lisp!")
  17
  18 ;;;; Various list functions
  19
  20 (defun cons (x y) (cons x y))
  21 (defun consp (x) (consp x))
  22
  23 (defun listp (x)
  24   (or (consp x) (null x)))
  25
  26 (defun null (x)
  27   (eq x nil))
  28
  29 (defun endp (x)
  30   (if (null x)
  31       t
  32       (if (consp x)
  33           nil
  34           (error "The value `~S' is not a type list." x))))
  35
  36 (defun car (x)
  37   "Return the CAR part of a cons, or NIL if X is null."
  38   (car x))
  39
  40 (defun cdr (x) (cdr x))
  41
  42 (defun rplaca (cons x)
  43   (rplaca cons x))
  44
  45 (defun rplacd (cons x)
  46   (rplacd cons x))
  47
  48 (defun first   (x) (car    x))
  49 (defun second  (x) (cadr   x))
  50 (defun third   (x) (caddr  x))
  51 (defun fourth  (x) (cadddr x))
  52 (defun fifth   (x) (car    (cddddr x)))
  53 (defun sixth   (x) (cadr   (cddddr x)))
  54 (defun seventh (x) (caddr  (cddddr x)))
  55 (defun eighth  (x) (cadddr (cddddr x)))
  56 (defun ninth   (x) (car  (cddddr (cddddr x))))
  57 (defun tenth   (x) (cadr (cddddr (cddddr x))))
  58 (defun rest    (x) (cdr x))
  59
  60 (defun list (&rest args)
  61   args)
  62
  63 (defun list* (arg &rest others)
  64   (cond ((null others) arg)
  65         ((null (cdr others)) (cons arg (car others)))
  66         (t (do ((x others (cdr x)))
  67                ((null (cddr x)) (rplacd x (cadr x))))
  68            (cons arg others))))
  69
  70 (defun list-length (list)
  71   (let ((l 0))
  72     (while (not (null list))
  73       (incf l)
  74       (setq list (cdr list)))
  75     l))
  76
  77 (defun nthcdr (n list)
  78   (while (and (plusp n) list)
  79     (setq n (1- n))
  80     (setq list (cdr list)))
  81   list)
  82
  83 (defun nth (n list)
  84   (car (nthcdr n list)))
  85
  86 (define-setf-expander nth (n list)
  87   (let ((g!list (gensym))
  88         (g!index (gensym))
  89         (g!value (gensym)))
  90     (values (list g!list g!index)
  91             (list list n)
  92             (list g!value)
  93             `(rplaca (nthcdr ,g!index ,g!list) ,g!value)
  94             `(nth ,g!index ,g!list))))
  95
  96 (defun caar (x) (car (car x)))
  97 (defun cadr (x) (car (cdr x)))
  98 (defun cdar (x) (cdr (car x)))
  99 (defun cddr (x) (cdr (cdr x)))
 100
 101 (defun caaar (x) (car (caar x)))
 102 (defun caadr (x) (car (cadr x)))
 103 (defun cadar (x) (car (cdar x)))
 104 (defun caddr (x) (car (cddr x)))
 105 (defun cdaar (x) (cdr (caar x)))
 106 (defun cdadr (x) (cdr (cadr x)))
 107 (defun cddar (x) (cdr (cdar x)))
 108 (defun cdddr (x) (cdr (cddr x)))
 109
 110 (defun caaaar (x) (car (caaar x)))
 111 (defun caaadr (x) (car (caadr x)))
 112 (defun caadar (x) (car (cadar x)))
 113 (defun caaddr (x) (car (caddr x)))
 114 (defun cadaar (x) (car (cdaar x)))
 115 (defun cadadr (x) (car (cdadr x)))
 116 (defun caddar (x) (car (cddar x)))
 117 (defun cadddr (x) (car (cdddr x)))
 118 (defun cdaaar (x) (cdr (caaar x)))
 119 (defun cdaadr (x) (cdr (caadr x)))
 120 (defun cdadar (x) (cdr (cadar x)))
 121 (defun cdaddr (x) (cdr (caddr x)))
 122 (defun cddaar (x) (cdr (cdaar x)))
 123 (defun cddadr (x) (cdr (cdadr x)))
 124 (defun cdddar (x) (cdr (cddar x)))
 125 (defun cddddr (x) (cdr (cdddr x)))
 126
 127 (defun append-two (list1 list2)
 128   (if (null list1)
 129       list2
 130       (cons (car list1)
 131             (append (cdr list1) list2))))
 132
 133 (defun append (&rest lists)
 134   (!reduce #'append-two lists nil))
 135
 136 (defun revappend (list1 list2)
 137   (while list1
 138     (push (car list1) list2)
 139     (setq list1 (cdr list1)))
 140   list2)
 141
 142 (defun reverse (list)
 143   (revappend list '()))
 144
 145 (defun sublis (alist tree &key key (test #'eql testp) (test-not #'eql test-not-p))
 146   (when (and testp test-not-p)
 147     (error "Both test and test-not are set"))
 148   (labels ((s (tree)
 149              (let* ((key-val (if key (funcall key tree) tree))
 150                     (replace (if test-not-p
 151                                  (assoc key-val alist :test-not test-not)
 152                                  (assoc key-val alist :test test)))
 153                     (x (if replace (cdr replace) tree)))
 154                (if (atom x)
 155                    x
 156                    (cons (s (car x)) (s (cdr x)))))))
 157     (s tree)))
 158
 159 (defun subst (new old tree &key key (test #'eql testp) (test-not #'eql test-not-p))
 160   (labels ((s (x)
 161              (cond ((satisfies-test-p old x :key key :test test :testp testp
 162                                       :test-not test-not :test-not-p test-not-p)
 163                     new)
 164                    ((atom x) x)
 165                    (t (let ((a (s (car x)))
 166                             (b (s (cdr x))))
 167                         (if (and (eq a (car x))
 168                                  (eq b (cdr x)))
 169                             x
 170                             (cons a b)))))))
 171     (s tree)))
 172
 173 (defun copy-list (x)
 174   (mapcar #'identity x))
 175
 176 (defun copy-tree (tree)
 177   (if (consp tree)
 178     (cons (copy-tree (car tree))
 179           (copy-tree (cdr tree)))
 180     tree))
 181
 182 (defun tree-equal (tree1 tree2 &key (test #'eql testp)
 183                          (test-not #'eql test-not-p))
 184   (when (and testp test-not-p) (error "Both test and test-not are set"))
 185   (let ((func (if test-not-p (complement test-not) test)))
 186     (labels ((%tree-equal (tree1 tree2)
 187                (if (atom tree1)
 188                  (and (atom tree2) (funcall func tree1 tree2))
 189                  (and (consp tree2)
 190                       (%tree-equal (car tree1) (car tree2))
 191                       (%tree-equal (cdr tree1) (cdr tree2))))))
 192       (%tree-equal tree1 tree2))))
 193
 194 (defun tailp (object list)
 195   (do ((tail list (cdr tail)))
 196     ((atom tail) (eq object tail))
 197     (when (eql tail object)
 198       (return-from tailp t))))
 199
 200 (defun map1 (func list)
 201   (with-collect
 202     (while list
 203       (collect (funcall func (car list)))
 204       (setq list (cdr list)))))
 205
 206 (defun mapcar (func list &rest lists)
 207   (let ((lists (cons list lists)))
 208     (with-collect
 209       (block loop
 210         (loop
 211            (let ((elems (map1 #'car lists)))
 212              (do ((tail lists (cdr tail)))
 213                  ((null tail))
 214                (when (null (car tail)) (return-from loop))
 215                (rplaca tail (cdar tail)))
 216              (collect (apply func elems))))))))
 217
 218 (defun mapn (func list)
 219   (with-collect
 220     (while list
 221       (collect (funcall func list))
 222       (setq list (cdr list)))))
 223
 224 (defun maplist (func list &rest lists)
 225   (let ((lists (cons list lists)))
 226     (with-collect
 227       (block loop
 228         (loop
 229            (let ((elems (mapn #'car lists)))
 230              (do ((tail lists (cdr tail)))
 231                  ((null tail))
 232                (when (null (car tail)) (return-from loop))
 233                (rplaca tail (cdar tail)))
 234              (collect (apply func elems))))))))
 235
 236 (defun mapc (func &rest lists)
 237   (do* ((tails lists (map1 #'cdr tails))
 238         (elems (map1 #'car tails)
 239                (map1 #'car tails)))
 240        ((dolist (x tails) (when (null x) (return t)))
 241         (car lists))
 242     (apply func elems)))
 243
 244 (defun last (x)
 245   (while (consp (cdr x))
 246     (setq x (cdr x)))
 247   x)
 248
 249 (defun butlast (x)
 250   (and (consp (cdr x))
 251        (cons (car x) (butlast (cdr x)))))
 252
 253 (defun member (x list &key key (test #'eql testp) (test-not #'eql test-not-p))
 254   (while list
 255     (when (satisfies-test-p x (car list) :key key :test test :testp testp
 256                             :test-not test-not :test-not-p test-not-p)
 257       (return list))
 258     (setq list (cdr list))))
 259
 260
 261 (defun assoc (x alist &key key (test #'eql testp) (test-not #'eql test-not-p))
 262   (while alist
 263     (if (satisfies-test-p x (caar alist) :key key :test test :testp testp
 264                           :test-not test-not :test-not-p test-not-p)
 265       (return)
 266       (setq alist (cdr alist))))
 267   (car alist))
 268
 269 (defun rassoc (x alist &key key (test #'eql) (test #'eql testp)
 270                  (test-not #'eql test-not-p))
 271   (while alist
 272     (if (satisfies-test-p x (cdar alist) :key key :test test :testp testp
 273                           :test-not test-not :test-not-p test-not-p)
 274       (return)
 275       (setq alist (cdr alist))))
 276   (car alist))
 277
 278 (defun acons (key datum alist)
 279   (cons (cons key datum) alist))
 280
 281 (defun pairlis (keys data &optional (alist ()))
 282   (while keys
 283     (setq alist (acons (car keys) (car data) alist))
 284     (setq keys (cdr keys))
 285     (setq data (cdr data)))
 286   alist)
 287
 288 (defun copy-alist (alist)
 289   (let ((new-alist ()))
 290     (while alist
 291       (push (cons (caar alist) (cdar alist)) new-alist)
 292       (setq alist (cdr alist)))
 293     (reverse new-alist)))
 294
 295
 296 (define-setf-expander car (x)
 297   (let ((cons (gensym))
 298         (new-value (gensym)))
 299     (values (list cons)
 300             (list x)
 301             (list new-value)
 302             `(progn (rplaca ,cons ,new-value) ,new-value)
 303             `(car ,cons))))
 304
 305 (define-setf-expander cdr (x)
 306   (let ((cons (gensym))
 307         (new-value (gensym)))
 308     (values (list cons)
 309             (list x)
 310             (list new-value)
 311             `(progn (rplacd ,cons ,new-value) ,new-value)
 312             `(cdr ,cons))))
 313
 314
 315 ;; The NCONC function is based on the SBCL's one.
 316 (defun nconc (&rest lists)
 317   (flet ((fail (object)
 318            (error "type-error in nconc")))
 319     (do ((top lists (cdr top)))
 320         ((null top) nil)
 321       (let ((top-of-top (car top)))
 322         (typecase top-of-top
 323           (cons
 324            (let* ((result top-of-top)
 325                   (splice result))
 326              (do ((elements (cdr top) (cdr elements)))
 327                  ((endp elements))
 328                (let ((ele (car elements)))
 329                  (typecase ele
 330                    (cons (rplacd (last splice) ele)
 331                          (setf splice ele))
 332                    (null (rplacd (last splice) nil))
 333                    (atom (if (cdr elements)
 334                              (fail ele)
 335                              (rplacd (last splice) ele))))))
 336              (return result)))
 337           (null)
 338           (atom
 339            (if (cdr top)
 340                (fail top-of-top)
 341                (return top-of-top))))))))
 342
 343
 344 (defun nreconc (x y)
 345   (do ((1st (cdr x) (if (endp 1st) 1st (cdr 1st)))
 346        (2nd x 1st)                ; 2nd follows first down the list.
 347        (3rd y 2nd))               ;3rd follows 2nd down the list.
 348       ((atom 2nd) 3rd)
 349     (rplacd 2nd 3rd)))
 350
 351
 352 (defun adjoin (item list &key (test #'eql) (key #'identity))
 353   (if (member item list :key key :test test)
 354     list
 355     (cons item list)))
 356
 357 (defun intersection (list1 list2 &key (test #'eql) (key #'identity))
 358   (let ((new-list ()))
 359     (dolist (x list1)
 360       (when (member (funcall key x) list2 :test test :key key)
 361         (push x new-list)))
 362     new-list))