mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00
Code Issues Projects Releases Wiki Activity

Various map.el improvements

Browse source 
* lisp/emacs-lisp/seq.el (seq-do-indexed): Return nil as per doc.

* lisp/emacs-lisp/map.el: Require Emacs >= 26 due to dependence on
5-arg alist-get.  Bump package to version 3.0.  Fix other
headers.  (Bug#46754)
(map--plist-p): Detect list starting with nil as plist, not alist.
(map-elt, map-filter, map-apply, map--make-pcase-bindings)
(map--make-pcase-patterns): Simplify.
(map-let, map-put, map-nested-elt, mapp): Update docstring for plist
support.
(map-delete): Fix OBOE on arrays.  Split into cl-defmethods.
(map-values, map-values-apply): Specialize for arrays.
(map-pairs, map-keys-apply, map-put!): Improve docstring.
(map-length): Clarify docstring w.r.t. duplicate keys.  Split into
cl-defmethods.  Optimize default implementation.
(map-copy): Use copy-alist on alists.  Split into cl-defmethods.
(map-contains-key): Add plist support.  Clarify docstring
w.r.t. optional argument.  Simplify default implementation.
(map-some, map-every-p, map-merge, map-merge-with, map--into-hash):
Don't use map-apply for side effects.
(map-into): Preserve plist ordering.  Improve docstrings.
(map-insert): Add hash-table and array support.
(map-inplace): Remove unused error symbol.
(map-do): Return nil as per doc.

* etc/NEWS: Announce new user-visible behavior.

* test/lisp/emacs-lisp/map-tests.el: Prefer should-not
over (should (not ...)) in general.
(with-maps-do): Fix docstring.
(with-empty-maps-do): New macro.
(test-map-elt-default, test-mapp, test-map-keys, test-map-values)
(test-map-pairs, test-map-length, test-map-copy, test-map-apply)
(test-map-do, test-map-keys-apply, test-map-values-apply)
(test-map-filter, test-map-remove, test-map-empty-p)
(test-map-contains-key, test-map-some, test-map-every-p):
Use it.

(test-map-plist-p, test-map-put!-new-keys, test-map-insert-empty)
(test-map-insert, test-map-delete-empty, test-map-copy-alist)
(test-map-contains-key-testfn, test-map-into-hash-test)
(test-map-into-empty, test-map-merge, test-map-merge-empty):
New tests.

(test-map-elt): Test array key that is within bounds but not fixnum.
(test-map-put!): Use map--plist-p.  Remove redundant tests.
(test-map-put-alist-new-key): Don't modify list literal.
(test-map-put-testfn-alist, test-map-put-return-value): Silence
obsoletion warnings.
(test-map-delete): Check for OBOE on arrays.
(test-map-delete-return-value): Remove test made redundant by
test-map-delete.
(test-map-nested-elt, test-map-into): Test plists too.
This commit is contained in:
Basil L. Contovounesios 2021-02-24 00:53:05 +00:00
parent 1d43c1854a
commit d925121b1e
4 changed files with 471 additions and 337 deletions
Download patch file Download diff file Expand all files Collapse all files

7
etc/NEWS
View file

@ -1160,6 +1160,13 @@ effect.
A pattern like '(map :sym)' binds the map's value for ':sym' to 'sym', A pattern like '(map :sym)' binds the map's value for ':sym' to 'sym',
equivalent to '(map (:sym sym))'. equivalent to '(map (:sym sym))'.
---
*** The function 'map-copy' now uses 'copy-alist' on alists.
This is a slightly deeper copy than the previous 'copy-sequence'.
---
*** The function 'map-contains-key' now supports plists.
** Package ** Package
+++ +++

320
lisp/emacs-lisp/map.el
View file

@ -3,12 +3,10 @@
;; Copyright (C) 2015-2021 Free Software Foundation, Inc. ;; Copyright (C) 2015-2021 Free Software Foundation, Inc.
;; Author: Nicolas Petton <nicolas@petton.fr> ;; Author: Nicolas Petton <nicolas@petton.fr>
;; Keywords: convenience, map, hash-table, alist, array
;; Version: 2.1
;; Package-Requires: ((emacs "25"))
;; Package: map
;; Maintainer: emacs-devel@gnu.org ;; Maintainer: emacs-devel@gnu.org
;; Keywords: extensions, lisp
;; Version: 3.0
;; Package-Requires: ((emacs "26"))
;; This file is part of GNU Emacs. ;; This file is part of GNU Emacs.
@ -27,8 +25,9 @@
;;; Commentary: ;;; Commentary:
;; map.el provides map-manipulation functions that work on alists, ;; map.el provides generic map-manipulation functions that work on
;; hash-table and arrays. All functions are prefixed with "map-". ;; alists, plists, hash-tables, and arrays. All functions are
;; prefixed with "map-".
;; ;;
;; Functions taking a predicate or iterating over a map using a ;; Functions taking a predicate or iterating over a map using a
;; function take the function as their first argument. All other ;; function take the function as their first argument. All other
@ -54,7 +53,7 @@ ARGS is a list of elements to be matched in the map.
Each element of ARGS can be of the form (KEY PAT), in which case KEY is Each element of ARGS can be of the form (KEY PAT), in which case KEY is
evaluated and searched for in the map. The match fails if for any KEY evaluated and searched for in the map. The match fails if for any KEY
found in the map, the corresponding PAT doesn't match the value found in the map, the corresponding PAT doesn't match the value
associated to the KEY. associated with the KEY.
Each element can also be a SYMBOL, which is an abbreviation of Each element can also be a SYMBOL, which is an abbreviation of
a (KEY PAT) tuple of the form (\\='SYMBOL SYMBOL). When SYMBOL a (KEY PAT) tuple of the form (\\='SYMBOL SYMBOL). When SYMBOL
@ -75,7 +74,7 @@ bound to the looked up value in MAP.
KEYS can also be a list of (KEY VARNAME) pairs, in which case KEYS can also be a list of (KEY VARNAME) pairs, in which case
KEY is an unquoted form. KEY is an unquoted form.
MAP can be a list, hash-table or array." MAP can be an alist, plist, hash-table, or array."
(declare (indent 2) (declare (indent 2)
(debug ((&rest &or symbolp ([form symbolp])) form body))) (debug ((&rest &or symbolp ([form symbolp])) form body)))
`(pcase-let ((,(map--make-pcase-patterns keys) ,map)) `(pcase-let ((,(map--make-pcase-patterns keys) ,map))
@ -101,7 +100,7 @@ Returns the result of evaluating the form associated with MAP-VAR's type."
(define-error 'map-not-inplace "Cannot modify map in-place") (define-error 'map-not-inplace "Cannot modify map in-place")
(defsubst map--plist-p (list) (defsubst map--plist-p (list)
(and (consp list) (not (listp (car list))))) (and (consp list) (atom (car list))))
(cl-defgeneric map-elt (map key &optional default testfn) (cl-defgeneric map-elt (map key &optional default testfn)
"Lookup KEY in MAP and return its associated value. "Lookup KEY in MAP and return its associated value.
@ -109,7 +108,8 @@ If KEY is not found, return DEFAULT which defaults to nil.
TESTFN is deprecated. Its default depends on the MAP argument. TESTFN is deprecated. Its default depends on the MAP argument.
In the base definition, MAP can be an alist, hash-table, or array." In the base definition, MAP can be an alist, plist, hash-table,
or array."
(declare (declare
(gv-expander (gv-expander
(lambda (do) (lambda (do)
@ -127,26 +127,25 @@ In the base definition, MAP can be an alist, hash-table, or array."
`(map-insert ,mgetter ,key ,v)))))))))) `(map-insert ,mgetter ,key ,v))))))))))
;; `testfn' is deprecated. ;; `testfn' is deprecated.
(advertised-calling-convention (map key &optional default) "27.1")) (advertised-calling-convention (map key &optional default) "27.1"))
;; Can't use `cl-defmethod' with `advertised-calling-convention'.
(map--dispatch map (map--dispatch map
:list (if (map--plist-p map) :list (if (map--plist-p map)
(let ((res (plist-get map key))) (let ((res (plist-member map key)))
(if (and default (null res) (not (plist-member map key))) (if res (cadr res) default))
default
res))
(alist-get key map default nil testfn)) (alist-get key map default nil testfn))
:hash-table (gethash key map default) :hash-table (gethash key map default)
:array (if (and (>= key 0) (< key (seq-length map))) :array (if (map-contains-key map key)
(seq-elt map key) (aref map key)
default))) default)))
(defmacro map-put (map key value &optional testfn) (defmacro map-put (map key value &optional testfn)
"Associate KEY with VALUE in MAP and return VALUE. "Associate KEY with VALUE in MAP and return VALUE.
If KEY is already present in MAP, replace the associated value If KEY is already present in MAP, replace the associated value
with VALUE. with VALUE.
When MAP is a list, test equality with TESTFN if non-nil, When MAP is an alist, test equality with TESTFN if non-nil,
otherwise use `eql'. otherwise use `eql'.
MAP can be a list, hash-table or array." MAP can be an alist, plist, hash-table, or array."
(declare (obsolete "use map-put! or (setf (map-elt ...) ...) instead" "27.1")) (declare (obsolete "use map-put! or (setf (map-elt ...) ...) instead" "27.1"))
`(setf (map-elt ,map ,key nil ,testfn) ,value)) `(setf (map-elt ,map ,key nil ,testfn) ,value))
@ -168,23 +167,30 @@ MAP can be a list, hash-table or array."
(cl-defgeneric map-delete (map key) (cl-defgeneric map-delete (map key)
"Delete KEY in-place from MAP and return MAP. "Delete KEY in-place from MAP and return MAP.
No error is signaled if KEY is not a key of MAP. Keys not present in MAP are ignored.")
If MAP is an array, store nil at the index KEY."
(map--dispatch map (cl-defmethod map-delete ((map list) key)
;; FIXME: Signal map-not-inplace i.s.o returning a different list? ;; FIXME: Signal map-not-inplace i.s.o returning a different list?
:list (if (map--plist-p map) (if (map--plist-p map)
(setq map (map--plist-delete map key)) (map--plist-delete map key)
(setf (alist-get key map nil t) nil)) (setf (alist-get key map nil t) nil)
:hash-table (remhash key map) map))
:array (and (>= key 0)
(<= key (seq-length map)) (cl-defmethod map-delete ((map hash-table) key)
(aset map key nil))) (remhash key map)
map)
(cl-defmethod map-delete ((map array) key)
"Store nil at index KEY."
(when (map-contains-key map key)
(aset map key nil))
map) map)
(defun map-nested-elt (map keys &optional default) (defun map-nested-elt (map keys &optional default)
"Traverse MAP using KEYS and return the looked up value or DEFAULT if nil. "Traverse MAP using KEYS and return the looked up value or DEFAULT if nil.
Map can be a nested map composed of alists, hash-tables and arrays." MAP can be a nested map composed of alists, plists, hash-tables,
and arrays."
(or (seq-reduce (lambda (acc key) (or (seq-reduce (lambda (acc key)
(when (mapp acc) (when (mapp acc)
(map-elt acc key))) (map-elt acc key)))
@ -202,30 +208,49 @@ The default implementation delegates to `map-apply'."
The default implementation delegates to `map-apply'." The default implementation delegates to `map-apply'."
(map-apply (lambda (_ value) value) map)) (map-apply (lambda (_ value) value) map))
(cl-defmethod map-values ((map array))
"Convert MAP into a list."
(append map ()))
(cl-defgeneric map-pairs (map) (cl-defgeneric map-pairs (map)
"Return the elements of MAP as key/value association lists. "Return the key/value pairs in MAP as an alist.
The default implementation delegates to `map-apply'." The default implementation delegates to `map-apply'."
(map-apply #'cons map)) (map-apply #'cons map))
(cl-defgeneric map-length (map) (cl-defgeneric map-length (map)
;; FIXME: Should we rename this to `map-size'? ;; FIXME: Should we rename this to `map-size'?
"Return the number of elements in the map. "Return the number of key/value pairs in MAP.
The default implementation counts `map-keys'." Note that this does not always reflect the number of unique keys.
(cond The default implementation delegates to `map-do'."
((hash-table-p map) (hash-table-count map)) (let ((size 0))
((listp map) (map-do (lambda (_k _v) (setq size (1+ size))) map)
;; FIXME: What about repeated/shadowed keys? size))
(if (map--plist-p map) (/ (length map) 2) (length map)))
((arrayp map) (length map)) (cl-defmethod map-length ((map hash-table))
(t (length (map-keys map))))) (hash-table-count map))
(cl-defmethod map-length ((map list))
(if (map--plist-p map)
(/ (length map) 2)
(length map)))
(cl-defmethod map-length ((map array))
(length map))
(cl-defgeneric map-copy (map) (cl-defgeneric map-copy (map)
"Return a copy of MAP." "Return a copy of MAP.")
;; FIXME: Clarify how deep is the copy!
(map--dispatch map (cl-defmethod map-copy ((map list))
:list (seq-copy map) ;FIXME: Probably not deep enough for alists! "Use `copy-alist' on alists and `copy-sequence' on plists."
:hash-table (copy-hash-table map) (if (map--plist-p map)
:array (seq-copy map))) (copy-sequence map)
(copy-alist map)))
(cl-defmethod map-copy ((map hash-table))
(copy-hash-table map))
(cl-defmethod map-copy ((map array))
(copy-sequence map))
(cl-defgeneric map-apply (function map) (cl-defgeneric map-apply (function map)
"Apply FUNCTION to each element of MAP and return the result as a list. "Apply FUNCTION to each element of MAP and return the result as a list.
@ -243,26 +268,28 @@ FUNCTION is called with two arguments, the key and the value.")
(cl-defmethod map-do (function (map hash-table)) (maphash function map)) (cl-defmethod map-do (function (map hash-table)) (maphash function map))
(cl-defgeneric map-keys-apply (function map) (cl-defgeneric map-keys-apply (function map)
"Return the result of applying FUNCTION to each key of MAP. "Return the result of applying FUNCTION to each key in MAP.
The default implementation delegates to `map-apply'." The default implementation delegates to `map-apply'."
(map-apply (lambda (key _) (map-apply (lambda (key _)
(funcall function key)) (funcall function key))
map)) map))
(cl-defgeneric map-values-apply (function map) (cl-defgeneric map-values-apply (function map)
"Return the result of applying FUNCTION to each value of MAP. "Return the result of applying FUNCTION to each value in MAP.
The default implementation delegates to `map-apply'." The default implementation delegates to `map-apply'."
(map-apply (lambda (_ val) (map-apply (lambda (_ val)
(funcall function val)) (funcall function val))
map)) map))
(cl-defmethod map-values-apply (function (map array))
(mapcar function map))
(cl-defgeneric map-filter (pred map) (cl-defgeneric map-filter (pred map)
"Return an alist of key/val pairs for which (PRED key val) is non-nil in MAP. "Return an alist of key/val pairs for which (PRED key val) is non-nil in MAP.
The default implementation delegates to `map-apply'." The default implementation delegates to `map-apply'."
(delq nil (map-apply (lambda (key val) (delq nil (map-apply (lambda (key val)
(if (funcall pred key val) (and (funcall pred key val)
(cons key val) (cons key val)))
nil))
map))) map)))
(cl-defgeneric map-remove (pred map) (cl-defgeneric map-remove (pred map)
@ -272,7 +299,7 @@ The default implementation delegates to `map-filter'."
map)) map))
(cl-defgeneric mapp (map) (cl-defgeneric mapp (map)
"Return non-nil if MAP is a map (alist, hash-table, array, ...)." "Return non-nil if MAP is a map (alist/plist, hash-table, array, ...)."
(or (listp map) (or (listp map)
(hash-table-p map) (hash-table-p map)
(arrayp map))) (arrayp map)))
@ -292,56 +319,58 @@ The default implementation delegates to `map-length'."
;; test function! ;; test function!
"Return non-nil if and only if MAP contains KEY. "Return non-nil if and only if MAP contains KEY.
TESTFN is deprecated. Its default depends on MAP. TESTFN is deprecated. Its default depends on MAP.
The default implementation delegates to `map-do'." The default implementation delegates to `map-some'."
(unless testfn (setq testfn #'equal)) (unless testfn (setq testfn #'equal))
(catch 'map--catch (map-some (lambda (k _v) (funcall testfn key k)) map))
(map-do (lambda (k _v)
(if (funcall testfn key k) (throw 'map--catch t)))
map)
nil))
(cl-defmethod map-contains-key ((map list) key &optional testfn) (cl-defmethod map-contains-key ((map list) key &optional testfn)
(let ((v '(nil))) "Return non-nil if MAP contains KEY.
(not (eq v (alist-get key map v nil (or testfn #'equal)))))) If MAP is an alist, TESTFN defaults to `equal'.
If MAP is a plist, `plist-member' is used instead."
(if (map--plist-p map)
(plist-member map key)
(let ((v '(nil)))
(not (eq v (alist-get key map v nil (or testfn #'equal)))))))
(cl-defmethod map-contains-key ((map array) key &optional _testfn) (cl-defmethod map-contains-key ((map array) key &optional _testfn)
(and (integerp key) "Return non-nil if KEY is an index of MAP, ignoring TESTFN."
(>= key 0) (and (natnump key) (< key (length map))))
(< key (length map))))
(cl-defmethod map-contains-key ((map hash-table) key &optional _testfn) (cl-defmethod map-contains-key ((map hash-table) key &optional _testfn)
"Return non-nil if MAP contains KEY, ignoring TESTFN."
(let ((v '(nil))) (let ((v '(nil)))
(not (eq v (gethash key map v))))) (not (eq v (gethash key map v)))))
(cl-defgeneric map-some (pred map) (cl-defgeneric map-some (pred map)
"Return the first non-nil (PRED key val) in MAP. "Return the first non-nil (PRED key val) in MAP.
The default implementation delegates to `map-apply'." Return nil if no such element is found.
The default implementation delegates to `map-do'."
;; FIXME: Not sure if there's much benefit to defining it as defgeneric, ;; FIXME: Not sure if there's much benefit to defining it as defgeneric,
;; since as defined, I can't think of a map-type where we could provide an ;; since as defined, I can't think of a map-type where we could provide an
;; algorithmically more efficient algorithm than the default. ;; algorithmically more efficient algorithm than the default.
(catch 'map--break (catch 'map--break
(map-apply (lambda (key value) (map-do (lambda (key value)
(let ((result (funcall pred key value))) (let ((result (funcall pred key value)))
(when result (when result
(throw 'map--break result)))) (throw 'map--break result))))
map) map)
nil)) nil))
(cl-defgeneric map-every-p (pred map) (cl-defgeneric map-every-p (pred map)
"Return non-nil if (PRED key val) is non-nil for all elements of MAP. "Return non-nil if (PRED key val) is non-nil for all elements of MAP.
The default implementation delegates to `map-apply'." The default implementation delegates to `map-do'."
;; FIXME: Not sure if there's much benefit to defining it as defgeneric, ;; FIXME: Not sure if there's much benefit to defining it as defgeneric,
;; since as defined, I can't think of a map-type where we could provide an ;; since as defined, I can't think of a map-type where we could provide an
;; algorithmically more efficient algorithm than the default. ;; algorithmically more efficient algorithm than the default.
(catch 'map--break (catch 'map--break
(map-apply (lambda (key value) (map-do (lambda (key value)
(or (funcall pred key value) (or (funcall pred key value)
(throw 'map--break nil))) (throw 'map--break nil)))
map) map)
t)) t))
(defun map-merge (type &rest maps) (defun map-merge (type &rest maps)
"Merge into a map of type TYPE all the key/value pairs in MAPS. "Merge into a map of TYPE all the key/value pairs in MAPS.
See `map-into' for all supported values of TYPE." See `map-into' for all supported values of TYPE."
(let ((result (map-into (pop maps) type))) (let ((result (map-into (pop maps) type)))
(while maps (while maps
@ -349,48 +378,57 @@ See `map-into' for all supported values of TYPE."
;; For small tables, this is fine, but for large tables, we ;; For small tables, this is fine, but for large tables, we
;; should probably use a hash-table internally which we convert ;; should probably use a hash-table internally which we convert
;; to an alist in the end. ;; to an alist in the end.
(map-apply (lambda (key value) (map-do (lambda (key value)
(setf (map-elt result key) value)) (setf (map-elt result key) value))
(pop maps))) (pop maps)))
result)) result))
(defun map-merge-with (type function &rest maps) (defun map-merge-with (type function &rest maps)
"Merge into a map of type TYPE all the key/value pairs in MAPS. "Merge into a map of TYPE all the key/value pairs in MAPS.
When two maps contain the same key (`eql'), call FUNCTION on the two When two maps contain the same (`eql') key, call FUNCTION on the two
values and use the value returned by it. values and use the value returned by it.
MAP can be a list, hash-table or array. Each of MAPS can be an alist, plist, hash-table, or array.
See `map-into' for all supported values of TYPE." See `map-into' for all supported values of TYPE."
(let ((result (map-into (pop maps) type)) (let ((result (map-into (pop maps) type))
(not-found (cons nil nil))) (not-found (list nil)))
(while maps (while maps
(map-apply (lambda (key value) (map-do (lambda (key value)
(cl-callf (lambda (old) (cl-callf (lambda (old)
(if (eql old not-found) (if (eql old not-found)
value value
(funcall function old value))) (funcall function old value)))
(map-elt result key not-found))) (map-elt result key not-found)))
(pop maps))) (pop maps)))
result)) result))
(cl-defgeneric map-into (map type) (cl-defgeneric map-into (map type)
"Convert the map MAP into a map of type TYPE.") "Convert MAP into a map of TYPE.")
;; FIXME: I wish there was a way to avoid this η-redex! ;; FIXME: I wish there was a way to avoid this η-redex!
(cl-defmethod map-into (map (_type (eql list))) (map-pairs map)) (cl-defmethod map-into (map (_type (eql list)))
(cl-defmethod map-into (map (_type (eql alist))) (map-pairs map)) "Convert MAP into an alist."
(map-pairs map))
(cl-defmethod map-into (map (_type (eql alist)))
"Convert MAP into an alist."
(map-pairs map))
(cl-defmethod map-into (map (_type (eql plist))) (cl-defmethod map-into (map (_type (eql plist)))
(let ((plist '())) "Convert MAP into a plist."
(map-do (lambda (k v) (setq plist `(,k ,v ,@plist))) map) (let (plist)
plist)) (map-do (lambda (k v) (setq plist `(,v ,k ,@plist))) map)
(nreverse plist)))
(cl-defgeneric map-put! (map key value &optional testfn) (cl-defgeneric map-put! (map key value &optional testfn)
"Associate KEY with VALUE in MAP. "Associate KEY with VALUE in MAP.
If KEY is already present in MAP, replace the associated value If KEY is already present in MAP, replace the associated value
with VALUE. with VALUE.
This operates by modifying MAP in place. This operates by modifying MAP in place.
If it cannot do that, it signals the `map-not-inplace' error. If it cannot do that, it signals a `map-not-inplace' error.
If you want to insert an element without modifying MAP, use `map-insert'." To insert an element without modifying MAP, use `map-insert'."
;; `testfn' only exists for backward compatibility with `map-put'! ;; `testfn' only exists for backward compatibility with `map-put'!
(declare (advertised-calling-convention (map key value) "27.1")) (declare (advertised-calling-convention (map key value) "27.1"))
;; Can't use `cl-defmethod' with `advertised-calling-convention'.
(map--dispatch map (map--dispatch map
:list :list
(if (map--plist-p map) (if (map--plist-p map)
@ -404,18 +442,20 @@ If you want to insert an element without modifying MAP, use `map-insert'."
;; and let `map-insert' grow the array? ;; and let `map-insert' grow the array?
:array (aset map key value))) :array (aset map key value)))
(define-error 'map-inplace "Can only modify map in place")
(cl-defgeneric map-insert (map key value) (cl-defgeneric map-insert (map key value)
"Return a new map like MAP except that it associates KEY with VALUE. "Return a new map like MAP except that it associates KEY with VALUE.
This does not modify MAP. This does not modify MAP.
If you want to insert an element in place, use `map-put!'." If you want to insert an element in place, use `map-put!'.
(if (listp map) The default implementation defaults to `map-copy' and `map-put!'."
(if (map--plist-p map) (let ((copy (map-copy map)))
`(,key ,value ,@map) (map-put! copy key value)
(cons (cons key value) map)) copy))
;; FIXME: Should we signal an error or use copy+put! ?
(signal 'map-inplace (list map)))) (cl-defmethod map-insert ((map list) key value)
"Cons KEY and VALUE to the front of MAP."
(if (map--plist-p map)
(cons key (cons value map))
(cons (cons key value) map)))
;; There shouldn't be old source code referring to `map--put', yet we do ;; There shouldn't be old source code referring to `map--put', yet we do
;; need to keep it for backward compatibility with .elc files where the ;; need to keep it for backward compatibility with .elc files where the
@ -425,11 +465,9 @@ If you want to insert an element in place, use `map-put!'."
(cl-defmethod map-apply (function (map list)) (cl-defmethod map-apply (function (map list))
(if (map--plist-p map) (if (map--plist-p map)
(cl-call-next-method) (cl-call-next-method)
(seq-map (lambda (pair) (mapcar (lambda (pair)
(funcall function (funcall function (car pair) (cdr pair)))
(car pair) map)))
(cdr pair)))
map)))
(cl-defmethod map-apply (function (map hash-table)) (cl-defmethod map-apply (function (map hash-table))
(let (result) (let (result)
@ -439,46 +477,40 @@ If you want to insert an element in place, use `map-put!'."
(nreverse result))) (nreverse result)))
(cl-defmethod map-apply (function (map array)) (cl-defmethod map-apply (function (map array))
(let ((index 0)) (seq-map-indexed (lambda (elt index)
(seq-map (lambda (elt) (funcall function index elt))
(prog1 map))
(funcall function index elt)
(setq index (1+ index))))
map)))
(cl-defmethod map-do (function (map list)) (cl-defmethod map-do (function (map list))
"Private function used to iterate over ALIST using FUNCTION."
(if (map--plist-p map) (if (map--plist-p map)
(while map (while map
(funcall function (pop map) (pop map))) (funcall function (pop map) (pop map)))
(seq-do (lambda (pair) (mapc (lambda (pair)
(funcall function (funcall function (car pair) (cdr pair)))
(car pair) map)
(cdr pair))) nil))
map)))
(cl-defmethod map-do (function (array array)) (cl-defmethod map-do (function (map array))
"Private function used to iterate over ARRAY using FUNCTION."
(seq-do-indexed (lambda (elt index) (seq-do-indexed (lambda (elt index)
(funcall function index elt)) (funcall function index elt))
array)) map))
(defun map--into-hash (map keyword-args) (defun map--into-hash (map keyword-args)
"Convert MAP into a hash-table. "Convert MAP into a hash-table.
KEYWORD-ARGS are forwarded to `make-hash-table'." KEYWORD-ARGS are forwarded to `make-hash-table'."
(let ((ht (apply #'make-hash-table keyword-args))) (let ((ht (apply #'make-hash-table keyword-args)))
(map-apply (lambda (key value) (map-do (lambda (key value)
(setf (gethash key ht) value)) (puthash key value ht))
map) map)
ht)) ht))
(cl-defmethod map-into (map (_type (eql hash-table))) (cl-defmethod map-into (map (_type (eql hash-table)))
"Convert MAP into a hash-table." "Convert MAP into a hash-table with keys compared with `equal'."
(map--into-hash map (list :size (map-length map) :test 'equal))) (map--into-hash map (list :size (map-length map) :test #'equal)))
(cl-defmethod map-into (map (type (head hash-table))) (cl-defmethod map-into (map (type (head hash-table)))
"Convert MAP into a hash-table. "Convert MAP into a hash-table.
TYPE is a list where the car is `hash-table' and the cdr are the TYPE is a list whose car is `hash-table' and cdr a list of
keyword-args forwarded to `make-hash-table'. keyword-args forwarded to `make-hash-table'.
Example: Example:
@ -487,23 +519,23 @@ Example:
(defun map--make-pcase-bindings (args) (defun map--make-pcase-bindings (args)
"Return a list of pcase bindings from ARGS to the elements of a map." "Return a list of pcase bindings from ARGS to the elements of a map."
(seq-map (lambda (elt) (mapcar (lambda (elt)
(cond ((consp elt) (cond ((consp elt)
`(app (pcase--flip map-elt ,(car elt)) ,(cadr elt))) `(app (pcase--flip map-elt ,(car elt)) ,(cadr elt)))
((keywordp elt) ((keywordp elt)
(let ((var (intern (substring (symbol-name elt) 1)))) (let ((var (intern (substring (symbol-name elt) 1))))
`(app (pcase--flip map-elt ,elt) ,var))) `(app (pcase--flip map-elt ,elt) ,var)))
(t `(app (pcase--flip map-elt ',elt) ,elt)))) (t `(app (pcase--flip map-elt ',elt) ,elt))))
args)) args))
(defun map--make-pcase-patterns (args) (defun map--make-pcase-patterns (args)
"Return a list of `(map ...)' pcase patterns built from ARGS." "Return a list of `(map ...)' pcase patterns built from ARGS."
(cons 'map (cons 'map
(seq-map (lambda (elt) (mapcar (lambda (elt)
(if (and (consp elt) (eq 'map (car elt))) (if (eq (car-safe elt) 'map)
(map--make-pcase-patterns elt) (map--make-pcase-patterns elt)
elt)) elt))
args))) args)))
(provide 'map) (provide 'map)
;;; map.el ends here ;;; map.el ends here

7
lisp/emacs-lisp/seq.el
View file

@ -134,9 +134,10 @@ Unlike `seq-map', FUNCTION takes two arguments: the element of
the sequence, and its index within the sequence." the sequence, and its index within the sequence."
(let ((index 0)) (let ((index 0))
(seq-do (lambda (elt) (seq-do (lambda (elt)
(funcall function elt index) (funcall function elt index)
(setq index (1+ index))) (setq index (1+ index)))
sequence))) sequence))
nil)
(cl-defgeneric seqp (object) (cl-defgeneric seqp (object)
"Return non-nil if OBJECT is a sequence, nil otherwise." "Return non-nil if OBJECT is a sequence, nil otherwise."

474
test/lisp/emacs-lisp/map-tests.el
View file

@ -22,7 +22,7 @@
;;; Commentary: ;;; Commentary:
;; Tests for map.el ;; Tests for map.el.
;;; Code: ;;; Code:
@ -30,12 +30,10 @@
(require 'map) (require 'map)
(defmacro with-maps-do (var &rest body) (defmacro with-maps-do (var &rest body)
"Successively bind VAR to an alist, vector and hash-table. "Successively bind VAR to an alist, plist, vector, and hash-table.
Each map is built from the following alist data: Each map is built from the following alist data:
'((0 . 3) (1 . 4) (2 . 5)). \\='((0 . 3) (1 . 4) (2 . 5)).
Evaluate BODY for each created map. Evaluate BODY for each created map."
\(fn (var map) body)"
(declare (indent 1) (debug (symbolp body))) (declare (indent 1) (debug (symbolp body)))
(let ((alist (make-symbol "alist")) (let ((alist (make-symbol "alist"))
(plist (make-symbol "plist")) (plist (make-symbol "plist"))
@ -53,43 +51,62 @@ Evaluate BODY for each created map.
(dolist (,var (list ,alist ,plist ,vec ,ht)) (dolist (,var (list ,alist ,plist ,vec ,ht))
,@body)))) ,@body))))
(defmacro with-empty-maps-do (var &rest body)
"Like `with-maps-do', but with empty maps."
(declare (indent 1) (debug (symbolp body)))
`(dolist (,var (list (list) (vector) (make-hash-table)))
,@body))
(ert-deftest test-map-plist-p ()
"Test `map--plist-p'."
(with-empty-maps-do map
(should-not (map--plist-p map)))
(should-not (map--plist-p ""))
(should-not (map--plist-p '((()))))
(should (map--plist-p '(:a)))
(should (map--plist-p '(a)))
(should (map--plist-p '(nil)))
(should (map--plist-p '(""))))
(ert-deftest test-map-elt () (ert-deftest test-map-elt ()
(with-maps-do map (with-maps-do map
(should (= 3 (map-elt map 0))) (should (= 3 (map-elt map 0)))
(should (= 4 (map-elt map 1))) (should (= 4 (map-elt map 1)))
(should (= 5 (map-elt map 2))) (should (= 5 (map-elt map 2)))
(should (null (map-elt map -1))) (should-not (map-elt map -1))
(should (null (map-elt map 4))))) (should-not (map-elt map 4))
(should-not (map-elt map 0.1))))
(ert-deftest test-map-elt-default () (ert-deftest test-map-elt-default ()
(with-maps-do map (with-maps-do map
(should (= 5 (map-elt map 7 5))))) (should (= 5 (map-elt map 7 5)))
(should (= 5 (map-elt map 0.1 5))))
(with-empty-maps-do map
(should (= 5 (map-elt map 0 5)))))
(ert-deftest test-map-elt-testfn () (ert-deftest test-map-elt-testfn ()
(let ((map (list (cons "a" 1) (cons "b" 2))) (let ((map (list (cons "a" 1) (cons "b" 2)))
;; Make sure to use a non-eq "a", even when compiled. ;; Make sure to use a non-eq "a", even when compiled.
(noneq-key (string ?a))) (noneq-key (string ?a)))
(should-not (map-elt map noneq-key)) (should-not (map-elt map noneq-key))
(should (map-elt map noneq-key nil 'equal)))) (should (map-elt map noneq-key nil #'equal))))
(ert-deftest test-map-elt-with-nil-value () (ert-deftest test-map-elt-with-nil-value ()
(should (null (map-elt '((a . 1) (should-not (map-elt '((a . 1) (b)) 'b 2)))
(b))
'b
'2))))
(ert-deftest test-map-put! () (ert-deftest test-map-put! ()
(with-maps-do map (with-maps-do map
(setf (map-elt map 2) 'hello) (setf (map-elt map 2) 'hello)
(should (eq (map-elt map 2) 'hello))) (should (eq (map-elt map 2) 'hello)))
(with-maps-do map (with-maps-do map
(map-put map 2 'hello) (with-suppressed-warnings ((obsolete map-put))
(map-put map 2 'hello))
(should (eq (map-elt map 2) 'hello))) (should (eq (map-elt map 2) 'hello)))
(with-maps-do map (with-maps-do map
(map-put! map 2 'hello) (map-put! map 2 'hello)
(should (eq (map-elt map 2) 'hello)) (should (eq (map-elt map 2) 'hello))
(if (not (or (hash-table-p map) (if (not (or (hash-table-p map)
(and (listp map) (not (listp (car map)))))) ;plist! (map--plist-p map)))
(should-error (map-put! map 5 'value) (should-error (map-put! map 5 'value)
;; For vectors, it could arguably signal ;; For vectors, it could arguably signal
;; map-not-inplace as well, but it currently doesn't. ;; map-not-inplace as well, but it currently doesn't.
@ -97,49 +114,88 @@ Evaluate BODY for each created map.
'map-not-inplace 'map-not-inplace
'error)) 'error))
(map-put! map 5 'value) (map-put! map 5 'value)
(should (eq (map-elt map 5) 'value)))) (should (eq (map-elt map 5) 'value)))))
(let ((ht (make-hash-table)))
(setf (map-elt ht 2) 'a) (ert-deftest test-map-put!-new-keys ()
(should (eq (map-elt ht 2) "Test `map-put!' with new keys."
'a))) (with-maps-do map
(let ((alist '((0 . a) (1 . b) (2 . c)))) (let ((size (map-length map)))
(setf (map-elt alist 2) 'a) (if (arrayp map)
(should (eq (map-elt alist 2) (progn
'a))) (should-error (setf (map-elt map 'k) 'v))
(let ((vec [3 4 5])) (should-error (setf (map-elt map size) 'v)))
(should-error (setf (map-elt vec 3) 6)))) (setf (map-elt map 'k) 'v)
(should (eq (map-elt map 'k) 'v))
(setf (map-elt map size) 'v)
(should (eq (map-elt map size) 'v))))))
(ert-deftest test-map-put-alist-new-key () (ert-deftest test-map-put-alist-new-key ()
"Regression test for Bug#23105." "Regression test for Bug#23105."
(let ((alist '((0 . a)))) (let ((alist (list (cons 0 'a))))
(map-put alist 2 'b) (with-suppressed-warnings ((obsolete map-put))
(should (eq (map-elt alist 2) (map-put alist 2 'b))
'b)))) (should (eq (map-elt alist 2) 'b))))
(ert-deftest test-map-put-testfn-alist () (ert-deftest test-map-put-testfn-alist ()
(let ((alist (list (cons "a" 1) (cons "b" 2))) (let ((alist (list (cons "a" 1) (cons "b" 2)))
;; Make sure to use a non-eq "a", even when compiled. ;; Make sure to use a non-eq "a", even when compiled.
(noneq-key (string ?a))) (noneq-key (string ?a)))
(map-put alist noneq-key 3 #'equal) (with-suppressed-warnings ((obsolete map-put))
(should-not (cddr alist)) (map-put alist noneq-key 3 #'equal)
(map-put alist noneq-key 9 #'eql) (should-not (cddr alist))
(should (cddr alist)))) (map-put alist noneq-key 9 #'eql)
(should (cddr alist)))))
(ert-deftest test-map-put-return-value () (ert-deftest test-map-put-return-value ()
(let ((ht (make-hash-table))) (let ((ht (make-hash-table)))
(should (eq (map-put ht 'a 'hello) 'hello)))) (with-suppressed-warnings ((obsolete map-put))
(should (eq (map-put ht 'a 'hello) 'hello)))))
(ert-deftest test-map-insert-empty ()
"Test `map-insert' on empty maps."
(with-empty-maps-do map
(if (arrayp map)
(should-error (map-insert map 0 6))
(let ((new (map-insert map 0 6)))
(should-not (eq map new))
(should-not (map-pairs map))
(should (= (map-elt new 0) 6))))))
(ert-deftest test-map-insert ()
"Test `map-insert'."
(with-maps-do map
(let ((pairs (map-pairs map))
(size (map-length map))
(new (map-insert map 0 6)))
(should-not (eq map new))
(should (equal (map-pairs map) pairs))
(should (= (map-elt new 0) 6))
(if (arrayp map)
(should-error (map-insert map size 7))
(setq new (map-insert map size 7))
(should-not (eq map new))
(should (equal (map-pairs map) pairs))
(should (= (map-elt new size) 7))))))
(ert-deftest test-map-delete () (ert-deftest test-map-delete ()
(with-maps-do map (with-maps-do map
(map-delete map 1) (should (map-elt map 1))
(should (null (map-elt map 1)))) (should (eq map (map-delete map 1)))
(should-not (map-elt map 1)))
(with-maps-do map (with-maps-do map
(map-delete map -2) (should-not (map-elt map -2))
(should (null (map-elt map -2))))) (should (eq map (map-delete map -2)))
(should-not (map-elt map -2)))
(with-maps-do map
;; Check for OBOE.
(let ((key (map-length map)))
(should-not (map-elt map key))
(should (eq map (map-delete map key)))
(should-not (map-elt map key)))))
(ert-deftest test-map-delete-return-value () (ert-deftest test-map-delete-empty ()
(let ((ht (make-hash-table))) (with-empty-maps-do map
(should (eq (map-delete ht 'a) ht)))) (should (eq map (map-delete map t)))))
(ert-deftest test-map-nested-elt () (ert-deftest test-map-nested-elt ()
(let ((vec [a b [c d [e f]]])) (let ((vec [a b [c d [e f]]]))
@ -149,8 +205,9 @@ Evaluate BODY for each created map.
(d . 3) (d . 3)
(e . ((f . 4) (e . ((f . 4)
(g . 5)))))))) (g . 5))))))))
(should (eq (map-nested-elt alist '(b e f)) (should (eq (map-nested-elt alist '(b e f)) 4)))
4))) (let ((plist '(a 1 b (c 2 d 3 e (f 4 g 5)))))
(should (eq (map-nested-elt plist '(b e f)) 4)))
(let ((ht (make-hash-table))) (let ((ht (make-hash-table)))
(setf (map-elt ht 'a) 1) (setf (map-elt ht 'a) 1)
(setf (map-elt ht 'b) (make-hash-table)) (setf (map-elt ht 'b) (make-hash-table))
@ -160,214 +217,238 @@ Evaluate BODY for each created map.
(ert-deftest test-map-nested-elt-default () (ert-deftest test-map-nested-elt-default ()
(let ((vec [a b [c d]])) (let ((vec [a b [c d]]))
(should (null (map-nested-elt vec '(2 3)))) (should-not (map-nested-elt vec '(2 3)))
(should (null (map-nested-elt vec '(2 1 1)))) (should-not (map-nested-elt vec '(2 1 1)))
(should (= 4 (map-nested-elt vec '(2 1 1) 4))))) (should (= 4 (map-nested-elt vec '(2 1 1) 4)))))
(ert-deftest test-mapp () (ert-deftest test-mapp ()
(should (mapp nil)) (with-empty-maps-do map
(should (mapp '((a . b) (c . d)))) (should (mapp map)))
(should (mapp '(a b c d))) (with-maps-do map
(should (mapp [])) (should (mapp map)))
(should (mapp [1 2 3])) (should (mapp ""))
(should (mapp (make-hash-table)))
(should (mapp "hello")) (should (mapp "hello"))
(should (not (mapp 1))) (should-not (mapp 1))
(should (not (mapp 'hello)))) (should-not (mapp 'hello)))
(ert-deftest test-map-keys () (ert-deftest test-map-keys ()
(with-maps-do map (with-maps-do map
(should (equal (map-keys map) '(0 1 2)))) (should (equal (map-keys map) '(0 1 2))))
(should (null (map-keys nil))) (with-empty-maps-do map
(should (null (map-keys [])))) (should-not (map-keys map))))
(ert-deftest test-map-values () (ert-deftest test-map-values ()
(with-maps-do map (with-maps-do map
(should (equal (map-values map) '(3 4 5))))) (should (equal (map-values map) '(3 4 5))))
(with-empty-maps-do map
(should-not (map-values map))))
(ert-deftest test-map-pairs () (ert-deftest test-map-pairs ()
(with-maps-do map (with-maps-do map
(should (equal (map-pairs map) '((0 . 3) (should (equal (map-pairs map)
(1 . 4) '((0 . 3)
(2 . 5)))))) (1 . 4)
(2 . 5)))))
(with-empty-maps-do map
(should-not (map-pairs map))))
(ert-deftest test-map-length () (ert-deftest test-map-length ()
(let ((ht (make-hash-table))) (with-empty-maps-do map
(puthash 'a 1 ht) (should (zerop (map-length map))))
(puthash 'b 2 ht) (with-maps-do map
(puthash 'c 3 ht) (should (= 3 (map-length map))))
(puthash 'd 4 ht) (should (= 1 (map-length '(nil 1))))
(should (= 0 (map-length nil))) (should (= 2 (map-length '(nil 1 t 2))))
(should (= 0 (map-length []))) (should (= 2 (map-length '((a . 1) (b . 2)))))
(should (= 0 (map-length (make-hash-table)))) (should (= 5 (map-length [0 1 2 3 4])))
(should (= 5 (map-length [0 1 2 3 4]))) (should (= 4 (map-length #s(hash-table data (a 1 b 2 c 3 d 4))))))
(should (= 2 (map-length '((a . 1) (b . 2)))))
(should (= 4 (map-length ht)))))
(ert-deftest test-map-copy () (ert-deftest test-map-copy ()
(with-maps-do map (with-maps-do map
(let ((copy (map-copy map))) (let ((copy (map-copy map)))
(should (equal (map-keys map) (map-keys copy))) (should (equal (map-pairs map) (map-pairs copy)))
(should (equal (map-values map) (map-values copy))) (should-not (eq map copy))
(should (not (eq map copy)))))) (map-put! map 0 0)
(should-not (equal (map-pairs map) (map-pairs copy)))))
(with-empty-maps-do map
(should-not (map-pairs (map-copy map)))))
(ert-deftest test-map-copy-alist ()
"Test use of `copy-alist' for alists."
(let* ((cons (list 'a 1 2))
(alist (list cons))
(copy (map-copy alist)))
(setcar cons 'b)
(should (equal alist '((b 1 2))))
(should (equal copy '((a 1 2))))
(setcar (cdr cons) 0)
(should (equal alist '((b 0 2))))
(should (equal copy '((a 0 2))))
(setcdr cons 3)
(should (equal alist '((b . 3))))
(should (equal copy '((a 0 2))))))
(ert-deftest test-map-apply () (ert-deftest test-map-apply ()
(with-maps-do map (let ((fn (lambda (k v) (cons (number-to-string k) v))))
(should (equal (map-apply (lambda (k v) (cons (int-to-string k) v)) (with-maps-do map
map) (should (equal (map-apply fn map)
'(("0" . 3) ("1" . 4) ("2" . 5))))) '(("0" . 3) ("1" . 4) ("2" . 5)))))
(let ((vec [a b c])) (with-empty-maps-do map
(should (equal (map-apply (lambda (k v) (cons (1+ k) v)) (should-not (map-apply fn map)))))
vec)
'((1 . a)
(2 . b)
(3 . c))))))
(ert-deftest test-map-do () (ert-deftest test-map-do ()
(with-maps-do map (let* (res
(let ((result nil)) (fn (lambda (k v)
(map-do (lambda (k v) (push (list (number-to-string k) v) res))))
(push (list (int-to-string k) v) result)) (with-empty-maps-do map
map) (should-not (map-do fn map))
(should (equal result '(("2" 5) ("1" 4) ("0" 3))))))) (should-not res))
(with-maps-do map
(setq res nil)
(should-not (map-do fn map))
(should (equal res '(("2" 5) ("1" 4) ("0" 3)))))))
(ert-deftest test-map-keys-apply () (ert-deftest test-map-keys-apply ()
(with-maps-do map (with-maps-do map
(should (equal (map-keys-apply (lambda (k) (int-to-string k)) (should (equal (map-keys-apply #'1+ map) '(1 2 3))))
map) (with-empty-maps-do map
'("0" "1" "2")))) (let (ks)
(let ((vec [a b c])) (should-not (map-keys-apply (lambda (k) (push k ks)) map))
(should (equal (map-keys-apply (lambda (k) (1+ k)) (should-not ks))))
vec)
'(1 2 3)))))
(ert-deftest test-map-values-apply () (ert-deftest test-map-values-apply ()
(with-maps-do map (with-maps-do map
(should (equal (map-values-apply (lambda (v) (1+ v)) (should (equal (map-values-apply #'1+ map) '(4 5 6))))
map) (with-empty-maps-do map
'(4 5 6)))) (let (vs)
(let ((vec [a b c])) (should-not (map-values-apply (lambda (v) (push v vs)) map))
(should (equal (map-values-apply (lambda (v) (symbol-name v)) (should-not vs))))
vec)
'("a" "b" "c")))))
(ert-deftest test-map-filter () (ert-deftest test-map-filter ()
(with-maps-do map (with-maps-do map
(should (equal (map-keys (map-filter (lambda (_k v) (should (equal (map-filter (lambda (_k v) (> v 3)) map)
(<= 4 v)) '((1 . 4) (2 . 5))))
map)) (should (equal (map-filter #'always map) (map-pairs map)))
'(1 2))) (should-not (map-filter #'ignore map)))
(should (null (map-filter (lambda (k _v) (with-empty-maps-do map
(eq 'd k)) (should-not (map-filter #'always map))
map)))) (should-not (map-filter #'ignore map))))
(should (null (map-filter (lambda (_k v)
(eq 3 v))
[1 2 4 5])))
(should (equal (map-filter (lambda (k _v)
(eq 3 k))
[1 2 4 5])
'((3 . 5)))))
(ert-deftest test-map-remove () (ert-deftest test-map-remove ()
(with-maps-do map (with-maps-do map
(should (equal (map-keys (map-remove (lambda (_k v) (should (equal (map-remove (lambda (_k v) (> v 3)) map)
(>= v 4)) '((0 . 3))))
map)) (should (equal (map-remove #'ignore map) (map-pairs map)))
'(0))) (should-not (map-remove #'always map)))
(should (equal (map-keys (map-remove (lambda (k _v) (with-empty-maps-do map
(eq 'd k)) (should-not (map-remove #'always map))
map)) (should-not (map-remove #'ignore map))))
(map-keys map))))
(should (equal (map-remove (lambda (_k v)
(eq 3 v))
[1 2 4 5])
'((0 . 1)
(1 . 2)
(2 . 4)
(3 . 5))))
(should (null (map-remove (lambda (k _v)
(>= k 0))
[1 2 4 5]))))
(ert-deftest test-map-empty-p () (ert-deftest test-map-empty-p ()
(should (map-empty-p nil)) (with-empty-maps-do map
(should (not (map-empty-p '((a . b) (c . d))))) (should (map-empty-p map)))
(should (map-empty-p [])) (should (map-empty-p ""))
(should (not (map-empty-p [1 2 3]))) (should-not (map-empty-p '((a . b) (c . d))))
(should (map-empty-p (make-hash-table))) (should-not (map-empty-p [1 2 3]))
(should (not (map-empty-p "hello"))) (should-not (map-empty-p "hello")))
(should (map-empty-p "")))
(ert-deftest test-map-contains-key () (ert-deftest test-map-contains-key ()
(should (map-contains-key '((a . 1) (b . 2)) 'a)) (with-empty-maps-do map
(should (not (map-contains-key '((a . 1) (b . 2)) 'c))) (should-not (map-contains-key map -1))
(should (map-contains-key '(("a" . 1)) "a")) (should-not (map-contains-key map 0))
(should (not (map-contains-key '(("a" . 1)) "a" #'eq))) (should-not (map-contains-key map 1))
(should (map-contains-key [a b c] 2)) (should-not (map-contains-key map (map-length map))))
(should (not (map-contains-key [a b c] 3)))) (with-maps-do map
(should-not (map-contains-key map -1))
(should (map-contains-key map 0))
(should (map-contains-key map 1))
(should-not (map-contains-key map (map-length map)))))
(ert-deftest test-map-contains-key-testfn ()
"Test `map-contains-key' under different equalities."
(let ((key (string ?a))
(plist '("a" 1 a 2))
(alist '(("a" . 1) (a . 2))))
(should (map-contains-key alist 'a))
(should (map-contains-key plist 'a))
(should (map-contains-key alist 'a #'eq))
(should (map-contains-key plist 'a #'eq))
(should (map-contains-key alist key))
(should-not (map-contains-key plist key))
(should-not (map-contains-key alist key #'eq))
(should-not (map-contains-key plist key #'eq))))
(ert-deftest test-map-some () (ert-deftest test-map-some ()
(with-maps-do map (with-maps-do map
(should (map-some (lambda (k _v) (should (eq (map-some (lambda (k _v) (and (= k 1) 'found)) map)
(eq 1 k)) 'found))
map)) (should-not (map-some #'ignore map)))
(should-not (map-some (lambda (k _v) (with-empty-maps-do map
(eq 'd k)) (should-not (map-some #'always map))
map))) (should-not (map-some #'ignore map))))
(let ((vec [a b c]))
(should (map-some (lambda (k _v)
(> k 1))
vec))
(should-not (map-some (lambda (k _v)
(> k 3))
vec))))
(ert-deftest test-map-every-p () (ert-deftest test-map-every-p ()
(with-maps-do map (with-maps-do map
(should (map-every-p (lambda (k _v) (should (map-every-p #'always map))
k) (should-not (map-every-p #'ignore map))
map)) (should-not (map-every-p (lambda (k _v) (zerop k)) map)))
(should (not (map-every-p (lambda (_k _v) (with-empty-maps-do map
nil) (should (map-every-p #'always map))
map)))) (should (map-every-p #'ignore map))
(let ((vec [a b c])) (should (map-every-p (lambda (k _v) (zerop k)) map))))
(should (map-every-p (lambda (k _v)
(>= k 0))
vec))
(should (not (map-every-p (lambda (k _v)
(> k 3))
vec)))))
(ert-deftest test-map-into () (ert-deftest test-map-into ()
(let* ((alist '((a . 1) (b . 2))) (let* ((plist '(a 1 b 2))
(alist '((a . 1) (b . 2)))
(ht (map-into alist 'hash-table)) (ht (map-into alist 'hash-table))
(ht2 (map-into alist '(hash-table :test equal)))) (ht2 (map-into alist '(hash-table :test equal))))
(should (hash-table-p ht)) (should (hash-table-p ht))
(should (equal (map-into (map-into alist 'hash-table) 'list) (should (equal (map-into ht 'list) alist))
alist)) (should (equal (map-pairs (map-into (map-into ht 'list) 'hash-table))
(should (listp (map-into ht 'list))) (map-pairs ht)))
(should (equal (map-keys (map-into (map-into ht 'list) 'hash-table))
(map-keys ht)))
(should (equal (map-values (map-into (map-into ht 'list) 'hash-table))
(map-values ht)))
(should (equal (map-into ht 'alist) (map-into ht2 'alist))) (should (equal (map-into ht 'alist) (map-into ht2 'alist)))
(should (eq (hash-table-test ht2) 'equal)) (should (equal (map-into alist 'list) alist))
(should (null (map-into nil 'list))) (should (equal (map-into alist 'alist) alist))
(should (map-empty-p (map-into nil 'hash-table))) (should (equal (map-into alist 'plist) plist))
(should-error (map-into [1 2 3] 'string)))) (should (equal (map-into plist 'alist) alist))
(should (equal (map-into plist 'plist) plist)))
(should-error (map-into [1 2 3] 'string) :type 'cl-no-applicable-method))
(ert-deftest test-map-into-hash-test ()
"Test `map-into' with different hash-table test functions."
(should (eq (hash-table-test (map-into () 'hash-table)) #'equal))
(should (eq (hash-table-test (map-into () '(hash-table))) #'eql))
(should (eq (hash-table-test (map-into () '(hash-table :test eq))) #'eq))
(should (eq (hash-table-test (map-into () '(hash-table :test eql))) #'eql))
(should (eq (hash-table-test (map-into () '(hash-table :test equal)))
#'equal)))
(ert-deftest test-map-into-empty ()
"Test `map-into' with empty maps."
(with-empty-maps-do map
(should-not (map-into map 'list))
(should-not (map-into map 'alist))
(should-not (map-into map 'plist))
(should (map-empty-p (map-into map 'hash-table)))))
(ert-deftest test-map-let () (ert-deftest test-map-let ()
(map-let (foo bar baz) '((foo . 1) (bar . 2)) (map-let (foo bar baz) '((foo . 1) (bar . 2))
(should (= foo 1)) (should (= foo 1))
(should (= bar 2)) (should (= bar 2))
(should (null baz))) (should-not baz))
(map-let (('foo a) (map-let (('foo a)
('bar b) ('bar b)
('baz c)) ('baz c))
'((foo . 1) (bar . 2)) '((foo . 1) (bar . 2))
(should (= a 1)) (should (= a 1))
(should (= b 2)) (should (= b 2))
(should (null c)))) (should-not c)))
(ert-deftest test-map-merge ()
"Test `map-merge'."
(should (equal (map-merge 'list '(a 1) '((b . 2) (c . 3))
#s(hash-table data (c 4)))
'((c . 4) (b . 2) (a . 1)))))
(ert-deftest test-map-merge-with () (ert-deftest test-map-merge-with ()
(should (equal (map-merge-with 'list #'+ (should (equal (map-merge-with 'list #'+
@ -376,6 +457,19 @@ Evaluate BODY for each created map.
'((1 . 1) (2 . 5) (3 . 0))) '((1 . 1) (2 . 5) (3 . 0)))
'((3 . 0) (2 . 9) (1 . 6))))) '((3 . 0) (2 . 9) (1 . 6)))))
(ert-deftest test-map-merge-empty ()
"Test merging of empty maps."
(should-not (map-merge 'list))
(should-not (map-merge 'alist))
(should-not (map-merge 'plist))
(should-not (map-merge-with 'list #'+))
(should-not (map-merge-with 'alist #'+))
(should-not (map-merge-with 'plist #'+))
(should (map-empty-p (map-merge 'hash-table)))
(should (map-empty-p (map-merge-with 'hash-table #'+)))
(should-error (map-merge 'array) :type 'cl-no-applicable-method)
(should-error (map-merge-with 'array #'+) :type 'cl-no-applicable-method))
(ert-deftest test-map-plist-pcase () (ert-deftest test-map-plist-pcase ()
(let ((plist '(:one 1 :two 2))) (let ((plist '(:one 1 :two 2)))
(should (equal (pcase-let (((map :one (:two two)) plist)) (should (equal (pcase-let (((map :one (:two two)) plist))