annotate lisp/emacs-lisp/assoc.el @ 74184:5a58eecaafcb

(CFLAGS_SOUND): Edit out.
author Eli Zaretskii <eliz@gnu.org>
date Sat, 25 Nov 2006 14:32:48 +0000
parents 067115a6e738
children 1d4b1a32fd66 c5406394f567
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2567
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
1 ;;; assoc.el --- insert/delete/sort functions on association lists
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
2
68648
067115a6e738 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64751
diff changeset
3 ;; Copyright (C) 1996, 2002, 2003, 2004, 2005,
067115a6e738 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64751
diff changeset
4 ;; 2006 Free Software Foundation, Inc.
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
5
2567
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
6 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
7 ;; Keywords: extensions
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
8
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
9 ;; This file is part of GNU Emacs.
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
10
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
14 ;; any later version.
2567
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
15
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
19 ;; GNU General Public License for more details.
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
20
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
21 ;; You should have received a copy of the GNU General Public License
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 4098
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64085
18a818a2ee7c Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18a818a2ee7c Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
24 ;; Boston, MA 02110-1301, USA.
2567
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
25
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
26 ;;; Commentary:
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
27
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
28 ;; Association list utilities providing insertion, deletion, sorting
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
29 ;; fetching off key-value pairs in association lists.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
30
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
31 ;;; Code:
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
32
4098
0a02227f8417 * assoc.el (asort): First argument should be named alist-symbol,
Jim Blandy <jimb@redhat.com>
parents: 3768
diff changeset
33 (defun asort (alist-symbol key)
2567
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
34 "Move a specified key-value pair to the head of an alist.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
35 The alist is referenced by ALIST-SYMBOL. Key-value pair to move to
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
36 head is one matching KEY. Returns the sorted list and doesn't affect
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
37 the order of any other key-value pair. Side effect sets alist to new
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
38 sorted list."
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
39 (set alist-symbol
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
40 (sort (copy-alist (eval alist-symbol))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
41 (function (lambda (a b) (equal (car a) key))))))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
42
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
43
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
44 (defun aelement (key value)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
45 "Makes a list of a cons cell containing car of KEY and cdr of VALUE.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
46 The returned list is suitable as an element of an alist."
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
47 (list (cons key value)))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
48
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
49
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
50 (defun aheadsym (alist)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
51 "Return the key symbol at the head of ALIST."
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
52 (car (car alist)))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
53
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
54
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
55 (defun anot-head-p (alist key)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
56 "Find out if a specified key-value pair is not at the head of an alist.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
57 The alist to check is specified by ALIST and the key-value pair is the
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
58 one matching the supplied KEY. Returns nil if ALIST is nil, or if
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
59 key-value pair is at the head of the alist. Returns t if key-value
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
60 pair is not at the head of alist. ALIST is not altered."
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
61 (not (equal (aheadsym alist) key)))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
62
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
63
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
64 (defun aput (alist-symbol key &optional value)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
65 "Inserts a key-value pair into an alist.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
66 The alist is referenced by ALIST-SYMBOL. The key-value pair is made
3768
d3fd7bcefd84 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 2567
diff changeset
67 from KEY and optionally, VALUE. Returns the altered alist or nil if
2567
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
68 ALIST is nil.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
69
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
70 If the key-value pair referenced by KEY can be found in the alist, and
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
71 VALUE is supplied non-nil, then the value of KEY will be set to VALUE.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
72 If VALUE is not supplied, or is nil, the key-value pair will not be
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
73 modified, but will be moved to the head of the alist. If the key-value
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
74 pair cannot be found in the alist, it will be inserted into the head
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
75 of the alist (with value nil if VALUE is nil or not supplied)."
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
76 (let ((elem (aelement key value))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
77 alist)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
78 (asort alist-symbol key)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
79 (setq alist (eval alist-symbol))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
80 (cond ((null alist) (set alist-symbol elem))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
81 ((anot-head-p alist key) (set alist-symbol (nconc elem alist)))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
82 (value (setcar alist (car elem)))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
83 (t alist))))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
84
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
85
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
86 (defun adelete (alist-symbol key)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
87 "Delete a key-value pair from the alist.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
88 Alist is referenced by ALIST-SYMBOL and the key-value pair to remove
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
89 is pair matching KEY. Returns the altered alist."
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
90 (asort alist-symbol key)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
91 (let ((alist (eval alist-symbol)))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
92 (cond ((null alist) nil)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
93 ((anot-head-p alist key) alist)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
94 (t (set alist-symbol (cdr alist))))))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
95
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
96
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
97 (defun aget (alist key &optional keynil-p)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
98 "Returns the value in ALIST that is associated with KEY.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
99 Optional KEYNIL-P describes what to do if the value associated with
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
100 KEY is nil. If KEYNIL-P is not supplied or is nil, and the value is
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
101 nil, then KEY is returned. If KEYNIL-P is non-nil, then nil would be
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
102 returned.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
103
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
104 If no key-value pair matching KEY could be found in ALIST, or ALIST is
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
105 nil then nil is returned. ALIST is not altered."
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
106 (let ((copy (copy-alist alist)))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
107 (cond ((null alist) nil)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
108 ((progn (asort 'copy key)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
109 (anot-head-p copy key)) nil)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
110 ((cdr (car copy)))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
111 (keynil-p nil)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
112 ((car (car copy)))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
113 (t nil))))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
114
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
115
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
116 (defun amake (alist-symbol keylist &optional valuelist)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
117 "Make an association list.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
118 The association list is attached to the alist referenced by
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
119 ALIST-SYMBOL. Each element in the KEYLIST becomes a key and is
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
120 associated with the value in VALUELIST with the same index. If
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
121 VALUELIST is not supplied or is nil, then each key in KEYLIST is
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
122 associated with nil.
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
123
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
124 KEYLIST and VALUELIST should have the same number of elements, but
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
125 this isn't enforced. If VALUELIST is smaller than KEYLIST, remaining
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
126 keys are associated with nil. If VALUELIST is larger than KEYLIST,
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
127 extra values are ignored. Returns the created alist."
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
128 (let ((keycar (car keylist))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
129 (keycdr (cdr keylist))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
130 (valcar (car valuelist))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
131 (valcdr (cdr valuelist)))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
132 (cond ((null keycdr)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
133 (aput alist-symbol keycar valcar))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
134 (t
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
135 (amake alist-symbol keycdr valcdr)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
136 (aput alist-symbol keycar valcar))))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
137 (eval alist-symbol))
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
138
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
139 (provide 'assoc)
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
140
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 14169
diff changeset
141 ;;; arch-tag: 3e58bd89-d912-4b74-a0dc-6ed9735922bc
2567
2cd6cb337d7c Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
142 ;;; assoc.el ends here