-
-
Notifications
You must be signed in to change notification settings - Fork 39
/
lists.texi
1838 lines (1563 loc) · 56.6 KB
/
lists.texi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
@c -*-texinfo-*-
@c This is part of the GNU Emacs Lisp Reference Manual.
@c Copyright (C) 1990-1995, 1998-1999, 2001-2016 Free Software
@c Foundation, Inc.
@c See the file elisp.texi for copying conditions.
@node Lists
@chapter Lists
@cindex lists
@cindex element (of list)
A @dfn{list} represents a sequence of zero or more elements (which may
be any Lisp objects). The important difference between lists and
vectors is that two or more lists can share part of their structure; in
addition, you can insert or delete elements in a list without copying
the whole list.
@menu
* Cons Cells:: How lists are made out of cons cells.
* List-related Predicates:: Is this object a list? Comparing two lists.
* List Elements:: Extracting the pieces of a list.
* Building Lists:: Creating list structure.
* List Variables:: Modifying lists stored in variables.
* Modifying Lists:: Storing new pieces into an existing list.
* Sets And Lists:: A list can represent a finite mathematical set.
* Association Lists:: A list can represent a finite relation or mapping.
* Property Lists:: A list of paired elements.
@end menu
@node Cons Cells
@section Lists and Cons Cells
@cindex lists and cons cells
Lists in Lisp are not a primitive data type; they are built up from
@dfn{cons cells} (@pxref{Cons Cell Type}). A cons cell is a data
object that represents an ordered pair. That is, it has two slots,
and each slot @dfn{holds}, or @dfn{refers to}, some Lisp object. One
slot is known as the @sc{car}, and the other is known as the @sc{cdr}.
(These names are traditional; see @ref{Cons Cell Type}.) @sc{cdr} is
pronounced ``could-er''.
We say that ``the @sc{car} of this cons cell is'' whatever object
its @sc{car} slot currently holds, and likewise for the @sc{cdr}.
A list is a series of cons cells chained together, so that each
cell refers to the next one. There is one cons cell for each element
of the list. By convention, the @sc{car}s of the cons cells hold the
elements of the list, and the @sc{cdr}s are used to chain the list
(this asymmetry between @sc{car} and @sc{cdr} is entirely a matter of
convention; at the level of cons cells, the @sc{car} and @sc{cdr}
slots have similar properties). Hence, the @sc{cdr} slot of each cons
cell in a list refers to the following cons cell.
@cindex true list
Also by convention, the @sc{cdr} of the last cons cell in a list is
@code{nil}. We call such a @code{nil}-terminated structure a
@dfn{true list}. In Emacs Lisp, the symbol @code{nil} is both a
symbol and a list with no elements. For convenience, the symbol
@code{nil} is considered to have @code{nil} as its @sc{cdr} (and also
as its @sc{car}).
Hence, the @sc{cdr} of a true list is always a true list. The
@sc{cdr} of a nonempty true list is a true list containing all the
elements except the first.
@cindex dotted list
@cindex circular list
If the @sc{cdr} of a list's last cons cell is some value other than
@code{nil}, we call the structure a @dfn{dotted list}, since its
printed representation would use dotted pair notation (@pxref{Dotted
Pair Notation}). There is one other possibility: some cons cell's
@sc{cdr} could point to one of the previous cons cells in the list.
We call that structure a @dfn{circular list}.
For some purposes, it does not matter whether a list is true,
circular or dotted. If a program doesn't look far enough down the
list to see the @sc{cdr} of the final cons cell, it won't care.
However, some functions that operate on lists demand true lists and
signal errors if given a dotted list. Most functions that try to find
the end of a list enter infinite loops if given a circular list.
@cindex list structure
Because most cons cells are used as part of lists, we refer to any
structure made out of cons cells as a @dfn{list structure}.
@node List-related Predicates
@section Predicates on Lists
@cindex predicates for lists
@cindex list predicates
The following predicates test whether a Lisp object is an atom,
whether it is a cons cell or is a list, or whether it is the
distinguished object @code{nil}. (Many of these predicates can be
defined in terms of the others, but they are used so often that it is
worth having them.)
@defun consp object
This function returns @code{t} if @var{object} is a cons cell, @code{nil}
otherwise. @code{nil} is not a cons cell, although it @emph{is} a list.
@end defun
@defun atom object
This function returns @code{t} if @var{object} is an atom, @code{nil}
otherwise. All objects except cons cells are atoms. The symbol
@code{nil} is an atom and is also a list; it is the only Lisp object
that is both.
@example
(atom @var{object}) @equiv{} (not (consp @var{object}))
@end example
@end defun
@defun listp object
This function returns @code{t} if @var{object} is a cons cell or
@code{nil}. Otherwise, it returns @code{nil}.
@example
@group
(listp '(1))
@result{} t
@end group
@group
(listp '())
@result{} t
@end group
@end example
@end defun
@defun nlistp object
This function is the opposite of @code{listp}: it returns @code{t} if
@var{object} is not a list. Otherwise, it returns @code{nil}.
@example
(listp @var{object}) @equiv{} (not (nlistp @var{object}))
@end example
@end defun
@defun null object
This function returns @code{t} if @var{object} is @code{nil}, and
returns @code{nil} otherwise. This function is identical to @code{not},
but as a matter of clarity we use @code{null} when @var{object} is
considered a list and @code{not} when it is considered a truth value
(see @code{not} in @ref{Combining Conditions}).
@example
@group
(null '(1))
@result{} nil
@end group
@group
(null '())
@result{} t
@end group
@end example
@end defun
@node List Elements
@section Accessing Elements of Lists
@cindex list elements
@defun car cons-cell
This function returns the value referred to by the first slot of the
cons cell @var{cons-cell}. In other words, it returns the @sc{car} of
@var{cons-cell}.
As a special case, if @var{cons-cell} is @code{nil}, this function
returns @code{nil}. Therefore, any list is a valid argument. An
error is signaled if the argument is not a cons cell or @code{nil}.
@example
@group
(car '(a b c))
@result{} a
@end group
@group
(car '())
@result{} nil
@end group
@end example
@end defun
@defun cdr cons-cell
This function returns the value referred to by the second slot of the
cons cell @var{cons-cell}. In other words, it returns the @sc{cdr} of
@var{cons-cell}.
As a special case, if @var{cons-cell} is @code{nil}, this function
returns @code{nil}; therefore, any list is a valid argument. An error
is signaled if the argument is not a cons cell or @code{nil}.
@example
@group
(cdr '(a b c))
@result{} (b c)
@end group
@group
(cdr '())
@result{} nil
@end group
@end example
@end defun
@defun car-safe object
This function lets you take the @sc{car} of a cons cell while avoiding
errors for other data types. It returns the @sc{car} of @var{object} if
@var{object} is a cons cell, @code{nil} otherwise. This is in contrast
to @code{car}, which signals an error if @var{object} is not a list.
@example
@group
(car-safe @var{object})
@equiv{}
(let ((x @var{object}))
(if (consp x)
(car x)
nil))
@end group
@end example
@end defun
@defun cdr-safe object
This function lets you take the @sc{cdr} of a cons cell while
avoiding errors for other data types. It returns the @sc{cdr} of
@var{object} if @var{object} is a cons cell, @code{nil} otherwise.
This is in contrast to @code{cdr}, which signals an error if
@var{object} is not a list.
@example
@group
(cdr-safe @var{object})
@equiv{}
(let ((x @var{object}))
(if (consp x)
(cdr x)
nil))
@end group
@end example
@end defun
@defmac pop listname
This macro provides a convenient way to examine the @sc{car} of a
list, and take it off the list, all at once. It operates on the list
stored in @var{listname}. It removes the first element from the list,
saves the @sc{cdr} into @var{listname}, then returns the removed
element.
In the simplest case, @var{listname} is an unquoted symbol naming a
list; in that case, this macro is equivalent to @w{@code{(prog1
(car listname) (setq listname (cdr listname)))}}.
@example
x
@result{} (a b c)
(pop x)
@result{} a
x
@result{} (b c)
@end example
More generally, @var{listname} can be a generalized variable. In that
case, this macro saves into @var{listname} using @code{setf}.
@xref{Generalized Variables}.
For the @code{push} macro, which adds an element to a list,
@xref{List Variables}.
@end defmac
@defun nth n list
@anchor{Definition of nth}
This function returns the @var{n}th element of @var{list}. Elements
are numbered starting with zero, so the @sc{car} of @var{list} is
element number zero. If the length of @var{list} is @var{n} or less,
the value is @code{nil}.
@c Behavior for -ve n undefined since 2013/08; see bug#15059.
@ignore
If @var{n} is negative, @code{nth} returns the first element of @var{list}.
@end ignore
@example
@group
(nth 2 '(1 2 3 4))
@result{} 3
@end group
@group
(nth 10 '(1 2 3 4))
@result{} nil
(nth n x) @equiv{} (car (nthcdr n x))
@end group
@end example
The function @code{elt} is similar, but applies to any kind of sequence.
For historical reasons, it takes its arguments in the opposite order.
@xref{Sequence Functions}.
@end defun
@defun nthcdr n list
This function returns the @var{n}th @sc{cdr} of @var{list}. In other
words, it skips past the first @var{n} links of @var{list} and returns
what follows.
@c "or negative" removed 2013/08; see bug#15059.
If @var{n} is zero, @code{nthcdr} returns all of
@var{list}. If the length of @var{list} is @var{n} or less,
@code{nthcdr} returns @code{nil}.
@example
@group
(nthcdr 1 '(1 2 3 4))
@result{} (2 3 4)
@end group
@group
(nthcdr 10 '(1 2 3 4))
@result{} nil
@end group
@group
(nthcdr 0 '(1 2 3 4))
@result{} (1 2 3 4)
@end group
@end example
@end defun
@defun last list &optional n
This function returns the last link of @var{list}. The @code{car} of
this link is the list's last element. If @var{list} is null,
@code{nil} is returned. If @var{n} is non-@code{nil}, the
@var{n}th-to-last link is returned instead, or the whole of @var{list}
if @var{n} is bigger than @var{list}'s length.
@end defun
@defun safe-length list
@anchor{Definition of safe-length}
This function returns the length of @var{list}, with no risk of either
an error or an infinite loop. It generally returns the number of
distinct cons cells in the list. However, for circular lists,
the value is just an upper bound; it is often too large.
If @var{list} is not @code{nil} or a cons cell, @code{safe-length}
returns 0.
@end defun
The most common way to compute the length of a list, when you are not
worried that it may be circular, is with @code{length}. @xref{Sequence
Functions}.
@defun caar cons-cell
This is the same as @code{(car (car @var{cons-cell}))}.
@end defun
@defun cadr cons-cell
This is the same as @code{(car (cdr @var{cons-cell}))}
or @code{(nth 1 @var{cons-cell})}.
@end defun
@defun cdar cons-cell
This is the same as @code{(cdr (car @var{cons-cell}))}.
@end defun
@defun cddr cons-cell
This is the same as @code{(cdr (cdr @var{cons-cell}))}
or @code{(nthcdr 2 @var{cons-cell})}.
@end defun
@defun butlast x &optional n
This function returns the list @var{x} with the last element,
or the last @var{n} elements, removed. If @var{n} is greater
than zero it makes a copy of the list so as not to damage the
original list. In general, @code{(append (butlast @var{x} @var{n})
(last @var{x} @var{n}))} will return a list equal to @var{x}.
@end defun
@defun nbutlast x &optional n
This is a version of @code{butlast} that works by destructively
modifying the @code{cdr} of the appropriate element, rather than
making a copy of the list.
@end defun
@node Building Lists
@section Building Cons Cells and Lists
@cindex cons cells
@cindex building lists
Many functions build lists, as lists reside at the very heart of Lisp.
@code{cons} is the fundamental list-building function; however, it is
interesting to note that @code{list} is used more times in the source
code for Emacs than @code{cons}.
@defun cons object1 object2
This function is the most basic function for building new list
structure. It creates a new cons cell, making @var{object1} the
@sc{car}, and @var{object2} the @sc{cdr}. It then returns the new
cons cell. The arguments @var{object1} and @var{object2} may be any
Lisp objects, but most often @var{object2} is a list.
@example
@group
(cons 1 '(2))
@result{} (1 2)
@end group
@group
(cons 1 '())
@result{} (1)
@end group
@group
(cons 1 2)
@result{} (1 . 2)
@end group
@end example
@cindex consing
@code{cons} is often used to add a single element to the front of a
list. This is called @dfn{consing the element onto the list}.
@footnote{There is no strictly equivalent way to add an element to
the end of a list. You can use @code{(append @var{listname} (list
@var{newelt}))}, which creates a whole new list by copying @var{listname}
and adding @var{newelt} to its end. Or you can use @code{(nconc
@var{listname} (list @var{newelt}))}, which modifies @var{listname}
by following all the @sc{cdr}s and then replacing the terminating
@code{nil}. Compare this to adding an element to the beginning of a
list with @code{cons}, which neither copies nor modifies the list.}
For example:
@example
(setq list (cons newelt list))
@end example
Note that there is no conflict between the variable named @code{list}
used in this example and the function named @code{list} described below;
any symbol can serve both purposes.
@end defun
@defun list &rest objects
This function creates a list with @var{objects} as its elements. The
resulting list is always @code{nil}-terminated. If no @var{objects}
are given, the empty list is returned.
@example
@group
(list 1 2 3 4 5)
@result{} (1 2 3 4 5)
@end group
@group
(list 1 2 '(3 4 5) 'foo)
@result{} (1 2 (3 4 5) foo)
@end group
@group
(list)
@result{} nil
@end group
@end example
@end defun
@defun make-list length object
This function creates a list of @var{length} elements, in which each
element is @var{object}. Compare @code{make-list} with
@code{make-string} (@pxref{Creating Strings}).
@example
@group
(make-list 3 'pigs)
@result{} (pigs pigs pigs)
@end group
@group
(make-list 0 'pigs)
@result{} nil
@end group
@group
(setq l (make-list 3 '(a b)))
@result{} ((a b) (a b) (a b))
(eq (car l) (cadr l))
@result{} t
@end group
@end example
@end defun
@defun append &rest sequences
@cindex copying lists
This function returns a list containing all the elements of
@var{sequences}. The @var{sequences} may be lists, vectors,
bool-vectors, or strings, but the last one should usually be a list.
All arguments except the last one are copied, so none of the arguments
is altered. (See @code{nconc} in @ref{Rearrangement}, for a way to join
lists with no copying.)
More generally, the final argument to @code{append} may be any Lisp
object. The final argument is not copied or converted; it becomes the
@sc{cdr} of the last cons cell in the new list. If the final argument
is itself a list, then its elements become in effect elements of the
result list. If the final element is not a list, the result is a
dotted list since its final @sc{cdr} is not @code{nil} as required
in a true list.
@end defun
Here is an example of using @code{append}:
@example
@group
(setq trees '(pine oak))
@result{} (pine oak)
(setq more-trees (append '(maple birch) trees))
@result{} (maple birch pine oak)
@end group
@group
trees
@result{} (pine oak)
more-trees
@result{} (maple birch pine oak)
@end group
@group
(eq trees (cdr (cdr more-trees)))
@result{} t
@end group
@end example
You can see how @code{append} works by looking at a box diagram. The
variable @code{trees} is set to the list @code{(pine oak)} and then the
variable @code{more-trees} is set to the list @code{(maple birch pine
oak)}. However, the variable @code{trees} continues to refer to the
original list:
@smallexample
@group
more-trees trees
| |
| --- --- --- --- -> --- --- --- ---
--> | | |--> | | |--> | | |--> | | |--> nil
--- --- --- --- --- --- --- ---
| | | |
| | | |
--> maple -->birch --> pine --> oak
@end group
@end smallexample
An empty sequence contributes nothing to the value returned by
@code{append}. As a consequence of this, a final @code{nil} argument
forces a copy of the previous argument:
@example
@group
trees
@result{} (pine oak)
@end group
@group
(setq wood (append trees nil))
@result{} (pine oak)
@end group
@group
wood
@result{} (pine oak)
@end group
@group
(eq wood trees)
@result{} nil
@end group
@end example
@noindent
This once was the usual way to copy a list, before the function
@code{copy-sequence} was invented. @xref{Sequences Arrays Vectors}.
Here we show the use of vectors and strings as arguments to @code{append}:
@example
@group
(append [a b] "cd" nil)
@result{} (a b 99 100)
@end group
@end example
With the help of @code{apply} (@pxref{Calling Functions}), we can append
all the lists in a list of lists:
@example
@group
(apply 'append '((a b c) nil (x y z) nil))
@result{} (a b c x y z)
@end group
@end example
If no @var{sequences} are given, @code{nil} is returned:
@example
@group
(append)
@result{} nil
@end group
@end example
Here are some examples where the final argument is not a list:
@example
(append '(x y) 'z)
@result{} (x y . z)
(append '(x y) [z])
@result{} (x y . [z])
@end example
@noindent
The second example shows that when the final argument is a sequence but
not a list, the sequence's elements do not become elements of the
resulting list. Instead, the sequence becomes the final @sc{cdr}, like
any other non-list final argument.
@defun copy-tree tree &optional vecp
This function returns a copy of the tree @code{tree}. If @var{tree} is a
cons cell, this makes a new cons cell with the same @sc{car} and
@sc{cdr}, then recursively copies the @sc{car} and @sc{cdr} in the
same way.
Normally, when @var{tree} is anything other than a cons cell,
@code{copy-tree} simply returns @var{tree}. However, if @var{vecp} is
non-@code{nil}, it copies vectors too (and operates recursively on
their elements).
@end defun
@defun number-sequence from &optional to separation
This returns a list of numbers starting with @var{from} and
incrementing by @var{separation}, and ending at or just before
@var{to}. @var{separation} can be positive or negative and defaults
to 1. If @var{to} is @code{nil} or numerically equal to @var{from},
the value is the one-element list @code{(@var{from})}. If @var{to} is
less than @var{from} with a positive @var{separation}, or greater than
@var{from} with a negative @var{separation}, the value is @code{nil}
because those arguments specify an empty sequence.
If @var{separation} is 0 and @var{to} is neither @code{nil} nor
numerically equal to @var{from}, @code{number-sequence} signals an
error, since those arguments specify an infinite sequence.
All arguments are numbers.
Floating-point arguments can be tricky, because floating-point
arithmetic is inexact. For instance, depending on the machine, it may
quite well happen that @code{(number-sequence 0.4 0.6 0.2)} returns
the one element list @code{(0.4)}, whereas
@code{(number-sequence 0.4 0.8 0.2)} returns a list with three
elements. The @var{n}th element of the list is computed by the exact
formula @code{(+ @var{from} (* @var{n} @var{separation}))}. Thus, if
one wants to make sure that @var{to} is included in the list, one can
pass an expression of this exact type for @var{to}. Alternatively,
one can replace @var{to} with a slightly larger value (or a slightly
more negative value if @var{separation} is negative).
Some examples:
@example
(number-sequence 4 9)
@result{} (4 5 6 7 8 9)
(number-sequence 9 4 -1)
@result{} (9 8 7 6 5 4)
(number-sequence 9 4 -2)
@result{} (9 7 5)
(number-sequence 8)
@result{} (8)
(number-sequence 8 5)
@result{} nil
(number-sequence 5 8 -1)
@result{} nil
(number-sequence 1.5 6 2)
@result{} (1.5 3.5 5.5)
@end example
@end defun
@node List Variables
@section Modifying List Variables
@cindex modify a list
@cindex list modification
These functions, and one macro, provide convenient ways
to modify a list which is stored in a variable.
@defmac push element listname
This macro creates a new list whose @sc{car} is @var{element} and
whose @sc{cdr} is the list specified by @var{listname}, and saves that
list in @var{listname}. In the simplest case, @var{listname} is an
unquoted symbol naming a list, and this macro is equivalent
to @w{@code{(setq @var{listname} (cons @var{element} @var{listname}))}}.
@example
(setq l '(a b))
@result{} (a b)
(push 'c l)
@result{} (c a b)
l
@result{} (c a b)
@end example
More generally, @code{listname} can be a generalized variable. In
that case, this macro does the equivalent of @w{@code{(setf
@var{listname} (cons @var{element} @var{listname}))}}.
@xref{Generalized Variables}.
For the @code{pop} macro, which removes the first element from a list,
@xref{List Elements}.
@end defmac
Two functions modify lists that are the values of variables.
@defun add-to-list symbol element &optional append compare-fn
This function sets the variable @var{symbol} by consing @var{element}
onto the old value, if @var{element} is not already a member of that
value. It returns the resulting list, whether updated or not. The
value of @var{symbol} had better be a list already before the call.
@code{add-to-list} uses @var{compare-fn} to compare @var{element}
against existing list members; if @var{compare-fn} is @code{nil}, it
uses @code{equal}.
Normally, if @var{element} is added, it is added to the front of
@var{symbol}, but if the optional argument @var{append} is
non-@code{nil}, it is added at the end.
The argument @var{symbol} is not implicitly quoted; @code{add-to-list}
is an ordinary function, like @code{set} and unlike @code{setq}. Quote
the argument yourself if that is what you want.
@end defun
Here's a scenario showing how to use @code{add-to-list}:
@example
(setq foo '(a b))
@result{} (a b)
(add-to-list 'foo 'c) ;; @r{Add @code{c}.}
@result{} (c a b)
(add-to-list 'foo 'b) ;; @r{No effect.}
@result{} (c a b)
foo ;; @r{@code{foo} was changed.}
@result{} (c a b)
@end example
An equivalent expression for @code{(add-to-list '@var{var}
@var{value})} is this:
@example
(or (member @var{value} @var{var})
(setq @var{var} (cons @var{value} @var{var})))
@end example
@defun add-to-ordered-list symbol element &optional order
This function sets the variable @var{symbol} by inserting
@var{element} into the old value, which must be a list, at the
position specified by @var{order}. If @var{element} is already a
member of the list, its position in the list is adjusted according
to @var{order}. Membership is tested using @code{eq}.
This function returns the resulting list, whether updated or not.
The @var{order} is typically a number (integer or float), and the
elements of the list are sorted in non-decreasing numerical order.
@var{order} may also be omitted or @code{nil}. Then the numeric order
of @var{element} stays unchanged if it already has one; otherwise,
@var{element} has no numeric order. Elements without a numeric list
order are placed at the end of the list, in no particular order.
Any other value for @var{order} removes the numeric order of @var{element}
if it already has one; otherwise, it is equivalent to @code{nil}.
The argument @var{symbol} is not implicitly quoted;
@code{add-to-ordered-list} is an ordinary function, like @code{set}
and unlike @code{setq}. Quote the argument yourself if necessary.
The ordering information is stored in a hash table on @var{symbol}'s
@code{list-order} property.
@end defun
Here's a scenario showing how to use @code{add-to-ordered-list}:
@example
(setq foo '())
@result{} nil
(add-to-ordered-list 'foo 'a 1) ;; @r{Add @code{a}.}
@result{} (a)
(add-to-ordered-list 'foo 'c 3) ;; @r{Add @code{c}.}
@result{} (a c)
(add-to-ordered-list 'foo 'b 2) ;; @r{Add @code{b}.}
@result{} (a b c)
(add-to-ordered-list 'foo 'b 4) ;; @r{Move @code{b}.}
@result{} (a c b)
(add-to-ordered-list 'foo 'd) ;; @r{Append @code{d}.}
@result{} (a c b d)
(add-to-ordered-list 'foo 'e) ;; @r{Add @code{e}}.
@result{} (a c b e d)
foo ;; @r{@code{foo} was changed.}
@result{} (a c b e d)
@end example
@node Modifying Lists
@section Modifying Existing List Structure
@cindex destructive list operations
You can modify the @sc{car} and @sc{cdr} contents of a cons cell with the
primitives @code{setcar} and @code{setcdr}. These are destructive
operations because they change existing list structure.
@cindex CL note---@code{rplaca} vs @code{setcar}
@quotation
@findex rplaca
@findex rplacd
@b{Common Lisp note:} Common Lisp uses functions @code{rplaca} and
@code{rplacd} to alter list structure; they change structure the same
way as @code{setcar} and @code{setcdr}, but the Common Lisp functions
return the cons cell while @code{setcar} and @code{setcdr} return the
new @sc{car} or @sc{cdr}.
@end quotation
@menu
* Setcar:: Replacing an element in a list.
* Setcdr:: Replacing part of the list backbone.
This can be used to remove or add elements.
* Rearrangement:: Reordering the elements in a list; combining lists.
@end menu
@node Setcar
@subsection Altering List Elements with @code{setcar}
@cindex replace list element
@cindex list, replace element
Changing the @sc{car} of a cons cell is done with @code{setcar}. When
used on a list, @code{setcar} replaces one element of a list with a
different element.
@defun setcar cons object
This function stores @var{object} as the new @sc{car} of @var{cons},
replacing its previous @sc{car}. In other words, it changes the
@sc{car} slot of @var{cons} to refer to @var{object}. It returns the
value @var{object}. For example:
@example
@group
(setq x '(1 2))
@result{} (1 2)
@end group
@group
(setcar x 4)
@result{} 4
@end group
@group
x
@result{} (4 2)
@end group
@end example
@end defun
When a cons cell is part of the shared structure of several lists,
storing a new @sc{car} into the cons changes one element of each of
these lists. Here is an example:
@example
@group
;; @r{Create two lists that are partly shared.}
(setq x1 '(a b c))
@result{} (a b c)
(setq x2 (cons 'z (cdr x1)))
@result{} (z b c)
@end group
@group
;; @r{Replace the @sc{car} of a shared link.}
(setcar (cdr x1) 'foo)
@result{} foo
x1 ; @r{Both lists are changed.}
@result{} (a foo c)
x2
@result{} (z foo c)
@end group
@group
;; @r{Replace the @sc{car} of a link that is not shared.}
(setcar x1 'baz)
@result{} baz
x1 ; @r{Only one list is changed.}
@result{} (baz foo c)
x2
@result{} (z foo c)
@end group
@end example
Here is a graphical depiction of the shared structure of the two lists
in the variables @code{x1} and @code{x2}, showing why replacing @code{b}
changes them both:
@example
@group
--- --- --- --- --- ---
x1---> | | |----> | | |--> | | |--> nil
--- --- --- --- --- ---
| --> | |
| | | |
--> a | --> b --> c
|
--- --- |
x2--> | | |--
--- ---
|
|
--> z
@end group
@end example
Here is an alternative form of box diagram, showing the same relationship:
@example
@group
x1:
-------------- -------------- --------------
| car | cdr | | car | cdr | | car | cdr |
| a | o------->| b | o------->| c | nil |
| | | -->| | | | | |
-------------- | -------------- --------------
|
x2: |
-------------- |
| car | cdr | |
| z | o----
| | |
--------------
@end group
@end example
@node Setcdr
@subsection Altering the CDR of a List
@cindex replace part of list
The lowest-level primitive for modifying a @sc{cdr} is @code{setcdr}:
@defun setcdr cons object
This function stores @var{object} as the new @sc{cdr} of @var{cons},
replacing its previous @sc{cdr}. In other words, it changes the
@sc{cdr} slot of @var{cons} to refer to @var{object}. It returns the
value @var{object}.
@end defun
Here is an example of replacing the @sc{cdr} of a list with a
different list. All but the first element of the list are removed in
favor of a different sequence of elements. The first element is
unchanged, because it resides in the @sc{car} of the list, and is not
reached via the @sc{cdr}.
@example
@group
(setq x '(1 2 3))
@result{} (1 2 3)
@end group
@group
(setcdr x '(4))
@result{} (4)
@end group
@group
x
@result{} (1 4)
@end group
@end example
You can delete elements from the middle of a list by altering the
@sc{cdr}s of the cons cells in the list. For example, here we delete
the second element, @code{b}, from the list @code{(a b c)}, by changing
the @sc{cdr} of the first cons cell:
@example
@group
(setq x1 '(a b c))
@result{} (a b c)
(setcdr x1 (cdr (cdr x1)))
@result{} (c)
x1
@result{} (a c)
@end group
@end example
Here is the result in box notation:
@smallexample
@group
--------------------
| |
-------------- | -------------- | --------------
| car | cdr | | | car | cdr | -->| car | cdr |
| a | o----- | b | o-------->| c | nil |
| | | | | | | | |
-------------- -------------- --------------
@end group
@end smallexample
@noindent
The second cons cell, which previously held the element @code{b}, still
exists and its @sc{car} is still @code{b}, but it no longer forms part
of this list.
It is equally easy to insert a new element by changing @sc{cdr}s: