Commit | Line | Data |
---|---|---|
cdccfc0d ER |
1 | ;;; assoc.el --- insert/delete/sort functions on association lists |
2 | ||
ac59f99d | 3 | ;; Copyright (C) 1996, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, |
5df4f04c | 4 | ;; 2009, 2010, 2011 Free Software Foundation, Inc. |
b578f267 | 5 | |
cdccfc0d ER |
6 | ;; Author: Barry A. Warsaw <bwarsaw@cen.com> |
7 | ;; Keywords: extensions | |
8 | ||
b578f267 EN |
9 | ;; This file is part of GNU Emacs. |
10 | ||
d6cba7ae | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
b578f267 | 12 | ;; it under the terms of the GNU General Public License as published by |
d6cba7ae GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
b578f267 EN |
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 | |
d6cba7ae | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
cdccfc0d ER |
23 | |
24 | ;;; Commentary: | |
25 | ||
26 | ;; Association list utilities providing insertion, deletion, sorting | |
27 | ;; fetching off key-value pairs in association lists. | |
28 | ||
29 | ;;; Code: | |
064eee03 | 30 | (eval-when-compile (require 'cl)) |
cdccfc0d | 31 | |
6476a5fa | 32 | (defun asort (alist-symbol key) |
cdccfc0d | 33 | "Move a specified key-value pair to the head of an alist. |
6cda144f | 34 | The alist is referenced by ALIST-SYMBOL. Key-value pair to move to |
cdccfc0d ER |
35 | head is one matching KEY. Returns the sorted list and doesn't affect |
36 | the order of any other key-value pair. Side effect sets alist to new | |
37 | sorted list." | |
38 | (set alist-symbol | |
39 | (sort (copy-alist (eval alist-symbol)) | |
40 | (function (lambda (a b) (equal (car a) key)))))) | |
41 | ||
42 | ||
43 | (defun aelement (key value) | |
6cda144f | 44 | "Make a list of a cons cell containing car of KEY and cdr of VALUE. |
ac59f99d | 45 | The returned list is suitable for concatenating with an existing |
245e0faf | 46 | alist, via `nconc'." |
cdccfc0d ER |
47 | (list (cons key value))) |
48 | ||
49 | ||
50 | (defun aheadsym (alist) | |
51 | "Return the key symbol at the head of ALIST." | |
52 | (car (car alist))) | |
53 | ||
54 | ||
55 | (defun anot-head-p (alist key) | |
56 | "Find out if a specified key-value pair is not at the head of an alist. | |
57 | The alist to check is specified by ALIST and the key-value pair is the | |
58 | one matching the supplied KEY. Returns nil if ALIST is nil, or if | |
59 | key-value pair is at the head of the alist. Returns t if key-value | |
60 | pair is not at the head of alist. ALIST is not altered." | |
61 | (not (equal (aheadsym alist) key))) | |
62 | ||
63 | ||
64 | (defun aput (alist-symbol key &optional value) | |
65 | "Inserts a key-value pair into an alist. | |
6cda144f JB |
66 | The alist is referenced by ALIST-SYMBOL. The key-value pair is made |
67 | from KEY and optionally, VALUE. Returns the altered alist or nil if | |
cdccfc0d ER |
68 | ALIST is nil. |
69 | ||
70 | If the key-value pair referenced by KEY can be found in the alist, and | |
71 | VALUE is supplied non-nil, then the value of KEY will be set to VALUE. | |
72 | If VALUE is not supplied, or is nil, the key-value pair will not be | |
6cda144f | 73 | modified, but will be moved to the head of the alist. If the key-value |
cdccfc0d ER |
74 | pair cannot be found in the alist, it will be inserted into the head |
75 | of the alist (with value nil if VALUE is nil or not supplied)." | |
064eee03 CY |
76 | (lexical-let ((elem (aelement key value)) |
77 | alist) | |
cdccfc0d ER |
78 | (asort alist-symbol key) |
79 | (setq alist (eval alist-symbol)) | |
80 | (cond ((null alist) (set alist-symbol elem)) | |
81 | ((anot-head-p alist key) (set alist-symbol (nconc elem alist))) | |
82 | (value (setcar alist (car elem))) | |
83 | (t alist)))) | |
84 | ||
85 | ||
86 | (defun adelete (alist-symbol key) | |
87 | "Delete a key-value pair from the alist. | |
88 | Alist is referenced by ALIST-SYMBOL and the key-value pair to remove | |
89 | is pair matching KEY. Returns the altered alist." | |
90 | (asort alist-symbol key) | |
064eee03 | 91 | (lexical-let ((alist (eval alist-symbol))) |
cdccfc0d ER |
92 | (cond ((null alist) nil) |
93 | ((anot-head-p alist key) alist) | |
94 | (t (set alist-symbol (cdr alist)))))) | |
95 | ||
96 | ||
97 | (defun aget (alist key &optional keynil-p) | |
6cda144f | 98 | "Return the value in ALIST that is associated with KEY. |
cdccfc0d ER |
99 | Optional KEYNIL-P describes what to do if the value associated with |
100 | KEY is nil. If KEYNIL-P is not supplied or is nil, and the value is | |
101 | nil, then KEY is returned. If KEYNIL-P is non-nil, then nil would be | |
102 | returned. | |
103 | ||
104 | If no key-value pair matching KEY could be found in ALIST, or ALIST is | |
6cda144f | 105 | nil then nil is returned. ALIST is not altered." |
cdccfc0d ER |
106 | (let ((copy (copy-alist alist))) |
107 | (cond ((null alist) nil) | |
108 | ((progn (asort 'copy key) | |
109 | (anot-head-p copy key)) nil) | |
110 | ((cdr (car copy))) | |
111 | (keynil-p nil) | |
112 | ((car (car copy))) | |
113 | (t nil)))) | |
114 | ||
115 | ||
116 | (defun amake (alist-symbol keylist &optional valuelist) | |
117 | "Make an association list. | |
118 | The association list is attached to the alist referenced by | |
6cda144f JB |
119 | ALIST-SYMBOL. Each element in the KEYLIST becomes a key and is |
120 | associated with the value in VALUELIST with the same index. If | |
cdccfc0d ER |
121 | VALUELIST is not supplied or is nil, then each key in KEYLIST is |
122 | associated with nil. | |
123 | ||
124 | KEYLIST and VALUELIST should have the same number of elements, but | |
125 | this isn't enforced. If VALUELIST is smaller than KEYLIST, remaining | |
126 | keys are associated with nil. If VALUELIST is larger than KEYLIST, | |
127 | extra values are ignored. Returns the created alist." | |
064eee03 CY |
128 | (lexical-let ((keycar (car keylist)) |
129 | (keycdr (cdr keylist)) | |
130 | (valcar (car valuelist)) | |
131 | (valcdr (cdr valuelist))) | |
cdccfc0d ER |
132 | (cond ((null keycdr) |
133 | (aput alist-symbol keycar valcar)) | |
134 | (t | |
135 | (amake alist-symbol keycdr valcdr) | |
136 | (aput alist-symbol keycar valcar)))) | |
137 | (eval alist-symbol)) | |
138 | ||
139 | (provide 'assoc) | |
140 | ||
cbee283d | 141 | ;; arch-tag: 3e58bd89-d912-4b74-a0dc-6ed9735922bc |
cdccfc0d | 142 | ;;; assoc.el ends here |