2011-02-17 21:19:13 +00:00
|
|
|
;;; pcase.el --- ML-style pattern-matching macro for Elisp -*- lexical-binding: t -*-
|
2010-08-10 13:18:14 +00:00
|
|
|
|
2011-01-25 04:08:28 +00:00
|
|
|
;; Copyright (C) 2010-2011 Free Software Foundation, Inc.
|
2010-08-10 13:18:14 +00:00
|
|
|
|
|
|
|
;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
|
|
|
|
;; Keywords:
|
|
|
|
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
;; GNU General Public License for more details.
|
|
|
|
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; ML-style pattern matching.
|
|
|
|
;; The entry points are autoloaded.
|
|
|
|
|
2010-10-29 01:05:38 +00:00
|
|
|
;; Todo:
|
|
|
|
|
|
|
|
;; - provide ways to extend the set of primitives, with some kind of
|
|
|
|
;; define-pcase-matcher. We could easily make it so that (guard BOOLEXP)
|
|
|
|
;; could be defined this way, as a shorthand for (pred (lambda (_) BOOLEXP)).
|
|
|
|
;; But better would be if we could define new ways to match by having the
|
2010-11-24 16:39:51 +00:00
|
|
|
;; extension provide its own `pcase--split-<foo>' thingy.
|
2010-10-29 01:05:38 +00:00
|
|
|
;; - ideally we'd want (pcase s ((re RE1) E1) ((re RE2) E2)) to be able to
|
|
|
|
;; generate a lex-style DFA to decide whether to run E1 or E2.
|
|
|
|
|
2010-08-10 13:18:14 +00:00
|
|
|
;;; Code:
|
|
|
|
|
|
|
|
;; Macro-expansion of pcase is reasonably fast, so it's not a problem
|
|
|
|
;; when byte-compiling a file, but when interpreting the code, if the pcase
|
|
|
|
;; is in a loop, the repeated macro-expansion becomes terribly costly, so we
|
|
|
|
;; memoize previous macro expansions to try and avoid recomputing them
|
|
|
|
;; over and over again.
|
2011-03-06 04:48:17 +00:00
|
|
|
(defconst pcase--memoize (make-hash-table :weakness 'key :test 'eq))
|
2010-08-10 13:18:14 +00:00
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defconst pcase--dontcare-upats '(t _ dontcare))
|
|
|
|
|
2010-08-10 13:18:14 +00:00
|
|
|
;;;###autoload
|
|
|
|
(defmacro pcase (exp &rest cases)
|
|
|
|
"Perform ML-style pattern matching on EXP.
|
|
|
|
CASES is a list of elements of the form (UPATTERN CODE...).
|
|
|
|
|
|
|
|
UPatterns can take the following forms:
|
|
|
|
_ matches anything.
|
|
|
|
SYMBOL matches anything and binds it to SYMBOL.
|
|
|
|
(or UPAT...) matches if any of the patterns matches.
|
|
|
|
(and UPAT...) matches if all the patterns match.
|
|
|
|
`QPAT matches if the QPattern QPAT matches.
|
|
|
|
(pred PRED) matches if PRED applied to the object returns non-nil.
|
2010-10-29 01:05:38 +00:00
|
|
|
(guard BOOLEXP) matches if BOOLEXP evaluates to non-nil.
|
2011-02-18 04:58:21 +00:00
|
|
|
If a SYMBOL is used twice in the same pattern (i.e. the pattern is
|
|
|
|
\"non-linear\"), then the second occurrence is turned into an `eq'uality test.
|
2010-08-10 13:18:14 +00:00
|
|
|
|
|
|
|
QPatterns can take the following forms:
|
|
|
|
(QPAT1 . QPAT2) matches if QPAT1 matches the car and QPAT2 the cdr.
|
|
|
|
,UPAT matches if the UPattern UPAT matches.
|
2010-10-29 01:05:38 +00:00
|
|
|
STRING matches if the object is `equal' to STRING.
|
2010-08-10 13:18:14 +00:00
|
|
|
ATOM matches if the object is `eq' to ATOM.
|
|
|
|
QPatterns for vectors are not implemented yet.
|
|
|
|
|
|
|
|
PRED can take the form
|
|
|
|
FUNCTION in which case it gets called with one argument.
|
|
|
|
(FUN ARG1 .. ARGN) in which case it gets called with N+1 arguments.
|
|
|
|
A PRED of the form FUNCTION is equivalent to one of the form (FUNCTION).
|
|
|
|
PRED patterns can refer to variables bound earlier in the pattern.
|
|
|
|
E.g. you can match pairs where the cdr is larger than the car with a pattern
|
|
|
|
like `(,a . ,(pred (< a))) or, with more checks:
|
|
|
|
`(,(and a (pred numberp)) . ,(and (pred numberp) (pred (< a))))"
|
2010-11-12 01:35:06 +00:00
|
|
|
(declare (indent 1) (debug case)) ;FIXME: edebug `guard' and vars.
|
2011-03-06 04:48:17 +00:00
|
|
|
;; We want to use a weak hash table as a cache, but the key will unavoidably
|
|
|
|
;; be based on `exp' and `cases', yet `cases' is a fresh new list each time
|
|
|
|
;; we're called so it'll be immediately GC'd. So we use (car cases) as key
|
|
|
|
;; which does come straight from the source code and should hence not be GC'd
|
|
|
|
;; so easily.
|
|
|
|
(let ((data (gethash (car cases) pcase--memoize)))
|
|
|
|
;; data = (EXP CASES . EXPANSION)
|
|
|
|
(if (and (equal exp (car data)) (equal cases (cadr data)))
|
|
|
|
;; We have the right expansion.
|
|
|
|
(cddr data)
|
|
|
|
(when data
|
|
|
|
(message "pcase-memoize: equal first branch, yet different"))
|
|
|
|
(let ((expansion (pcase--expand exp cases)))
|
|
|
|
(puthash (car cases) (cons exp (cons cases expansion)) pcase--memoize)
|
|
|
|
expansion))))
|
2010-08-10 13:18:14 +00:00
|
|
|
|
|
|
|
;;;###autoload
|
2010-11-24 16:39:51 +00:00
|
|
|
(defmacro pcase-let* (bindings &rest body)
|
2010-08-10 13:18:14 +00:00
|
|
|
"Like `let*' but where you can use `pcase' patterns for bindings.
|
|
|
|
BODY should be an expression, and BINDINGS should be a list of bindings
|
|
|
|
of the form (UPAT EXP)."
|
2010-11-12 01:35:06 +00:00
|
|
|
(declare (indent 1) (debug let))
|
2010-11-24 16:39:51 +00:00
|
|
|
(cond
|
|
|
|
((null bindings) (if (> (length body) 1) `(progn ,@body) (car body)))
|
|
|
|
((pcase--trivial-upat-p (caar bindings))
|
|
|
|
`(let (,(car bindings)) (pcase-let* ,(cdr bindings) ,@body)))
|
|
|
|
(t
|
2010-08-10 13:18:14 +00:00
|
|
|
`(pcase ,(cadr (car bindings))
|
2010-11-24 16:39:51 +00:00
|
|
|
(,(caar bindings) (pcase-let* ,(cdr bindings) ,@body))
|
|
|
|
;; We can either signal an error here, or just use `dontcare' which
|
|
|
|
;; generates more efficient code. In practice, if we use `dontcare' we
|
|
|
|
;; will still often get an error and the few cases where we don't do not
|
|
|
|
;; matter that much, so it's a better choice.
|
|
|
|
(dontcare nil)))))
|
2010-08-10 13:18:14 +00:00
|
|
|
|
|
|
|
;;;###autoload
|
2010-11-24 16:39:51 +00:00
|
|
|
(defmacro pcase-let (bindings &rest body)
|
2010-08-10 13:18:14 +00:00
|
|
|
"Like `let' but where you can use `pcase' patterns for bindings.
|
2010-11-24 16:39:51 +00:00
|
|
|
BODY should be a list of expressions, and BINDINGS should be a list of bindings
|
2010-08-10 13:18:14 +00:00
|
|
|
of the form (UPAT EXP)."
|
2010-11-12 01:35:06 +00:00
|
|
|
(declare (indent 1) (debug let))
|
2010-08-10 13:18:14 +00:00
|
|
|
(if (null (cdr bindings))
|
2010-11-24 16:39:51 +00:00
|
|
|
`(pcase-let* ,bindings ,@body)
|
|
|
|
(let ((matches '()))
|
|
|
|
(dolist (binding (prog1 bindings (setq bindings nil)))
|
|
|
|
(cond
|
|
|
|
((memq (car binding) pcase--dontcare-upats)
|
|
|
|
(push (cons (make-symbol "_") (cdr binding)) bindings))
|
|
|
|
((pcase--trivial-upat-p (car binding)) (push binding bindings))
|
|
|
|
(t
|
|
|
|
(let ((tmpvar (make-symbol (format "x%d" (length bindings)))))
|
|
|
|
(push (cons tmpvar (cdr binding)) bindings)
|
|
|
|
(push (list (car binding) tmpvar) matches)))))
|
|
|
|
`(let ,(nreverse bindings) (pcase-let* ,matches ,@body)))))
|
|
|
|
|
|
|
|
(defmacro pcase-dolist (spec &rest body)
|
|
|
|
(if (pcase--trivial-upat-p (car spec))
|
|
|
|
`(dolist ,spec ,@body)
|
|
|
|
(let ((tmpvar (make-symbol "x")))
|
|
|
|
`(dolist (,tmpvar ,@(cdr spec))
|
|
|
|
(pcase-let* ((,(car spec) ,tmpvar))
|
|
|
|
,@body)))))
|
|
|
|
|
|
|
|
|
|
|
|
(defun pcase--trivial-upat-p (upat)
|
|
|
|
(and (symbolp upat) (not (memq upat pcase--dontcare-upats))))
|
|
|
|
|
|
|
|
(defun pcase--expand (exp cases)
|
2011-03-06 04:48:17 +00:00
|
|
|
;; (message "pid=%S (pcase--expand %S ...hash=%S)"
|
|
|
|
;; (emacs-pid) exp (sxhash cases))
|
2010-08-10 13:18:14 +00:00
|
|
|
(let* ((defs (if (symbolp exp) '()
|
|
|
|
(let ((sym (make-symbol "x")))
|
|
|
|
(prog1 `((,sym ,exp)) (setq exp sym)))))
|
|
|
|
(seen '())
|
|
|
|
(codegen
|
|
|
|
(lambda (code vars)
|
|
|
|
(let ((prev (assq code seen)))
|
|
|
|
(if (not prev)
|
|
|
|
(let ((res (pcase-codegen code vars)))
|
|
|
|
(push (list code vars res) seen)
|
|
|
|
res)
|
|
|
|
;; Since we use a tree-based pattern matching
|
|
|
|
;; technique, the leaves (the places that contain the
|
|
|
|
;; code to run once a pattern is matched) can get
|
|
|
|
;; copied a very large number of times, so to avoid
|
|
|
|
;; code explosion, we need to keep track of how many
|
|
|
|
;; times we've used each leaf and move it
|
|
|
|
;; to a separate function if that number is too high.
|
|
|
|
;;
|
|
|
|
;; We've already used this branch. So it is shared.
|
2011-02-18 13:55:51 +00:00
|
|
|
(let* ((code (car prev)) (cdrprev (cdr prev))
|
|
|
|
(prevvars (car cdrprev)) (cddrprev (cdr cdrprev))
|
|
|
|
(res (car cddrprev)))
|
2010-08-10 13:18:14 +00:00
|
|
|
(unless (symbolp res)
|
|
|
|
;; This is the first repeat, so we have to move
|
|
|
|
;; the branch to a separate function.
|
|
|
|
(let ((bsym
|
|
|
|
(make-symbol (format "pcase-%d" (length defs)))))
|
|
|
|
(push `(,bsym (lambda ,(mapcar #'car prevvars) ,@code)) defs)
|
|
|
|
(setcar res 'funcall)
|
|
|
|
(setcdr res (cons bsym (mapcar #'cdr prevvars)))
|
|
|
|
(setcar (cddr prev) bsym)
|
|
|
|
(setq res bsym)))
|
|
|
|
(setq vars (copy-sequence vars))
|
|
|
|
(let ((args (mapcar (lambda (pa)
|
|
|
|
(let ((v (assq (car pa) vars)))
|
|
|
|
(setq vars (delq v vars))
|
|
|
|
(cdr v)))
|
|
|
|
prevvars)))
|
|
|
|
(when vars ;New additional vars.
|
|
|
|
(error "The vars %s are only bound in some paths"
|
|
|
|
(mapcar #'car vars)))
|
|
|
|
`(funcall ,res ,@args)))))))
|
|
|
|
(main
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--u
|
2010-08-10 13:18:14 +00:00
|
|
|
(mapcar (lambda (case)
|
|
|
|
`((match ,exp . ,(car case))
|
|
|
|
,(apply-partially
|
2010-11-24 16:39:51 +00:00
|
|
|
(if (pcase--small-branch-p (cdr case))
|
2010-08-10 13:18:14 +00:00
|
|
|
;; Don't bother sharing multiple
|
|
|
|
;; occurrences of this leaf since it's small.
|
|
|
|
#'pcase-codegen codegen)
|
|
|
|
(cdr case))))
|
|
|
|
cases))))
|
2010-11-24 16:39:51 +00:00
|
|
|
(if (null defs) main
|
|
|
|
`(let ,defs ,main))))
|
2010-08-10 13:18:14 +00:00
|
|
|
|
|
|
|
(defun pcase-codegen (code vars)
|
|
|
|
`(let ,(mapcar (lambda (b) (list (car b) (cdr b))) vars)
|
|
|
|
,@code))
|
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--small-branch-p (code)
|
2010-08-10 13:18:14 +00:00
|
|
|
(and (= 1 (length code))
|
|
|
|
(or (not (consp (car code)))
|
|
|
|
(let ((small t))
|
|
|
|
(dolist (e (car code))
|
|
|
|
(if (consp e) (setq small nil)))
|
|
|
|
small))))
|
|
|
|
|
|
|
|
;; Try to use `cond' rather than a sequence of `if's, so as to reduce
|
|
|
|
;; the depth of the generated tree.
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--if (test then else)
|
2010-08-10 13:18:14 +00:00
|
|
|
(cond
|
2010-11-24 16:39:51 +00:00
|
|
|
((eq else :pcase--dontcare) then)
|
2010-08-10 13:18:14 +00:00
|
|
|
((eq (car-safe else) 'if)
|
2010-10-29 01:05:38 +00:00
|
|
|
(if (equal test (nth 1 else))
|
|
|
|
;; Doing a test a second time: get rid of the redundancy.
|
2010-11-24 16:39:51 +00:00
|
|
|
;; FIXME: ideally, this should never happen because the pcase--split-*
|
|
|
|
;; funs should have eliminated such things, but pcase--split-member
|
|
|
|
;; is imprecise, so in practice it can happen occasionally.
|
2010-10-29 01:05:38 +00:00
|
|
|
`(if ,test ,then ,@(nthcdr 3 else))
|
|
|
|
`(cond (,test ,then)
|
|
|
|
(,(nth 1 else) ,(nth 2 else))
|
|
|
|
(t ,@(nthcdr 3 else)))))
|
2010-08-10 13:18:14 +00:00
|
|
|
((eq (car-safe else) 'cond)
|
|
|
|
`(cond (,test ,then)
|
2010-10-29 01:05:38 +00:00
|
|
|
;; Doing a test a second time: get rid of the redundancy, as above.
|
|
|
|
,@(remove (assoc test else) (cdr else))))
|
2010-08-10 13:18:14 +00:00
|
|
|
(t `(if ,test ,then ,else))))
|
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--upat (qpattern)
|
2010-08-10 13:18:14 +00:00
|
|
|
(cond
|
|
|
|
((eq (car-safe qpattern) '\,) (cadr qpattern))
|
|
|
|
(t (list '\` qpattern))))
|
|
|
|
|
|
|
|
;; Note about MATCH:
|
|
|
|
;; When we have patterns like `(PAT1 . PAT2), after performing the `consp'
|
|
|
|
;; check, we want to turn all the similar patterns into ones of the form
|
|
|
|
;; (and (match car PAT1) (match cdr PAT2)), so you naturally need conjunction.
|
|
|
|
;; Earlier code hence used branches of the form (MATCHES . CODE) where
|
|
|
|
;; MATCHES was a list (implicitly a conjunction) of (SYM . PAT).
|
|
|
|
;; But if we have a pattern of the form (or `(PAT1 . PAT2) PAT3), there is
|
|
|
|
;; no easy way to eliminate the `consp' check in such a representation.
|
|
|
|
;; So we replaced the MATCHES by the MATCH below which can be made up
|
|
|
|
;; of conjunctions and disjunctions, so if we know `foo' is a cons, we can
|
|
|
|
;; turn (match foo . (or `(PAT1 . PAT2) PAT3)) into
|
|
|
|
;; (or (and (match car . `PAT1) (match cdr . `PAT2)) (match foo . PAT3)).
|
|
|
|
;; The downside is that we now have `or' and `and' both in MATCH and
|
|
|
|
;; in PAT, so there are different equivalent representations and we
|
|
|
|
;; need to handle them all. We do not try to systematically
|
|
|
|
;; canonicalize them to one form over another, but we do occasionally
|
|
|
|
;; turn one into the other.
|
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--u (branches)
|
2010-08-10 13:18:14 +00:00
|
|
|
"Expand matcher for rules BRANCHES.
|
|
|
|
Each BRANCH has the form (MATCH CODE . VARS) where
|
|
|
|
CODE is the code generator for that branch.
|
|
|
|
VARS is the set of vars already bound by earlier matches.
|
|
|
|
MATCH is the pattern that needs to be matched, of the form:
|
|
|
|
(match VAR . UPAT)
|
|
|
|
(and MATCH ...)
|
|
|
|
(or MATCH ...)"
|
|
|
|
(when (setq branches (delq nil branches))
|
2011-02-18 13:55:51 +00:00
|
|
|
(let* ((carbranch (car branches))
|
|
|
|
(match (car carbranch)) (cdarbranch (cdr carbranch))
|
|
|
|
(code (car cdarbranch))
|
|
|
|
(vars (cdr cdarbranch)))
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--u1 (list match) code vars (cdr branches)))))
|
2010-08-10 13:18:14 +00:00
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--and (match matches)
|
2010-08-10 13:18:14 +00:00
|
|
|
(if matches `(and ,match ,@matches) match))
|
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--split-match (sym splitter match)
|
2011-02-18 13:55:51 +00:00
|
|
|
(cond
|
|
|
|
((eq (car match) 'match)
|
2010-08-10 13:18:14 +00:00
|
|
|
(if (not (eq sym (cadr match)))
|
|
|
|
(cons match match)
|
|
|
|
(let ((pat (cddr match)))
|
|
|
|
(cond
|
|
|
|
;; Hoist `or' and `and' patterns to `or' and `and' matches.
|
|
|
|
((memq (car-safe pat) '(or and))
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--split-match sym splitter
|
|
|
|
(cons (car pat)
|
|
|
|
(mapcar (lambda (alt)
|
|
|
|
`(match ,sym . ,alt))
|
|
|
|
(cdr pat)))))
|
2010-08-10 13:18:14 +00:00
|
|
|
(t (let ((res (funcall splitter (cddr match))))
|
|
|
|
(cons (or (car res) match) (or (cdr res) match))))))))
|
2011-02-18 13:55:51 +00:00
|
|
|
((memq (car match) '(or and))
|
2010-08-10 13:18:14 +00:00
|
|
|
(let ((then-alts '())
|
|
|
|
(else-alts '())
|
2010-11-24 16:39:51 +00:00
|
|
|
(neutral-elem (if (eq 'or (car match))
|
|
|
|
:pcase--fail :pcase--succeed))
|
|
|
|
(zero-elem (if (eq 'or (car match)) :pcase--succeed :pcase--fail)))
|
2010-08-10 13:18:14 +00:00
|
|
|
(dolist (alt (cdr match))
|
2010-11-24 16:39:51 +00:00
|
|
|
(let ((split (pcase--split-match sym splitter alt)))
|
2010-08-10 13:18:14 +00:00
|
|
|
(unless (eq (car split) neutral-elem)
|
|
|
|
(push (car split) then-alts))
|
|
|
|
(unless (eq (cdr split) neutral-elem)
|
|
|
|
(push (cdr split) else-alts))))
|
|
|
|
(cons (cond ((memq zero-elem then-alts) zero-elem)
|
|
|
|
((null then-alts) neutral-elem)
|
|
|
|
((null (cdr then-alts)) (car then-alts))
|
|
|
|
(t (cons (car match) (nreverse then-alts))))
|
|
|
|
(cond ((memq zero-elem else-alts) zero-elem)
|
|
|
|
((null else-alts) neutral-elem)
|
|
|
|
((null (cdr else-alts)) (car else-alts))
|
|
|
|
(t (cons (car match) (nreverse else-alts)))))))
|
|
|
|
(t (error "Uknown MATCH %s" match))))
|
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--split-rest (sym splitter rest)
|
2010-08-10 13:18:14 +00:00
|
|
|
(let ((then-rest '())
|
|
|
|
(else-rest '()))
|
|
|
|
(dolist (branch rest)
|
|
|
|
(let* ((match (car branch))
|
|
|
|
(code&vars (cdr branch))
|
|
|
|
(splitted
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--split-match sym splitter match)))
|
|
|
|
(unless (eq (car splitted) :pcase--fail)
|
2010-08-10 13:18:14 +00:00
|
|
|
(push (cons (car splitted) code&vars) then-rest))
|
2010-11-24 16:39:51 +00:00
|
|
|
(unless (eq (cdr splitted) :pcase--fail)
|
2010-08-10 13:18:14 +00:00
|
|
|
(push (cons (cdr splitted) code&vars) else-rest))))
|
|
|
|
(cons (nreverse then-rest) (nreverse else-rest))))
|
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--split-consp (syma symd pat)
|
2010-08-10 13:18:14 +00:00
|
|
|
(cond
|
|
|
|
;; A QPattern for a cons, can only go the `then' side.
|
|
|
|
((and (eq (car-safe pat) '\`) (consp (cadr pat)))
|
|
|
|
(let ((qpat (cadr pat)))
|
2010-11-24 16:39:51 +00:00
|
|
|
(cons `(and (match ,syma . ,(pcase--upat (car qpat)))
|
|
|
|
(match ,symd . ,(pcase--upat (cdr qpat))))
|
|
|
|
:pcase--fail)))
|
2010-08-10 13:18:14 +00:00
|
|
|
;; A QPattern but not for a cons, can only go the `else' side.
|
2010-11-24 16:39:51 +00:00
|
|
|
((eq (car-safe pat) '\`) (cons :pcase--fail nil))))
|
2010-08-10 13:18:14 +00:00
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--split-equal (elem pat)
|
2010-08-10 13:18:14 +00:00
|
|
|
(cond
|
|
|
|
;; The same match will give the same result.
|
|
|
|
((and (eq (car-safe pat) '\`) (equal (cadr pat) elem))
|
2010-11-24 16:39:51 +00:00
|
|
|
(cons :pcase--succeed :pcase--fail))
|
2010-08-10 13:18:14 +00:00
|
|
|
;; A different match will fail if this one succeeds.
|
|
|
|
((and (eq (car-safe pat) '\`)
|
|
|
|
;; (or (integerp (cadr pat)) (symbolp (cadr pat))
|
|
|
|
;; (consp (cadr pat)))
|
|
|
|
)
|
2010-11-24 16:39:51 +00:00
|
|
|
(cons :pcase--fail nil))))
|
2010-08-10 13:18:14 +00:00
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--split-member (elems pat)
|
|
|
|
;; Based on pcase--split-equal.
|
2010-08-10 13:18:14 +00:00
|
|
|
(cond
|
2010-10-29 01:05:38 +00:00
|
|
|
;; The same match (or a match of membership in a superset) will
|
|
|
|
;; give the same result, but we don't know how to check it.
|
2010-09-01 10:03:08 +00:00
|
|
|
;; (???
|
2010-11-24 16:39:51 +00:00
|
|
|
;; (cons :pcase--succeed nil))
|
2010-09-01 10:03:08 +00:00
|
|
|
;; A match for one of the elements may succeed or fail.
|
2010-08-10 13:18:14 +00:00
|
|
|
((and (eq (car-safe pat) '\`) (member (cadr pat) elems))
|
2010-09-01 10:03:08 +00:00
|
|
|
nil)
|
2010-08-10 13:18:14 +00:00
|
|
|
;; A different match will fail if this one succeeds.
|
|
|
|
((and (eq (car-safe pat) '\`)
|
|
|
|
;; (or (integerp (cadr pat)) (symbolp (cadr pat))
|
|
|
|
;; (consp (cadr pat)))
|
|
|
|
)
|
2010-11-24 16:39:51 +00:00
|
|
|
(cons :pcase--fail nil))))
|
2010-08-10 13:18:14 +00:00
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--split-pred (upat pat)
|
2010-08-10 13:18:14 +00:00
|
|
|
;; FIXME: For predicates like (pred (> a)), two such predicates may
|
|
|
|
;; actually refer to different variables `a'.
|
|
|
|
(if (equal upat pat)
|
2010-11-24 16:39:51 +00:00
|
|
|
(cons :pcase--succeed :pcase--fail)))
|
2010-08-10 13:18:14 +00:00
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--fgrep (vars sexp)
|
2010-08-10 13:18:14 +00:00
|
|
|
"Check which of the symbols VARS appear in SEXP."
|
|
|
|
(let ((res '()))
|
|
|
|
(while (consp sexp)
|
2010-11-24 16:39:51 +00:00
|
|
|
(dolist (var (pcase--fgrep vars (pop sexp)))
|
2010-08-10 13:18:14 +00:00
|
|
|
(unless (memq var res) (push var res))))
|
|
|
|
(and (memq sexp vars) (not (memq sexp res)) (push sexp res))
|
|
|
|
res))
|
|
|
|
|
|
|
|
;; It's very tempting to use `pcase' below, tho obviously, it'd create
|
|
|
|
;; bootstrapping problems.
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--u1 (matches code vars rest)
|
2010-08-10 13:18:14 +00:00
|
|
|
"Return code that runs CODE (with VARS) if MATCHES match.
|
|
|
|
and otherwise defers to REST which is a list of branches of the form
|
|
|
|
\(ELSE-MATCH ELSE-CODE . ELSE-VARS)."
|
|
|
|
;; Depending on the order in which we choose to check each of the MATCHES,
|
|
|
|
;; the resulting tree may be smaller or bigger. So in general, we'd want
|
|
|
|
;; to be careful to chose the "optimal" order. But predicate
|
|
|
|
;; patterns make this harder because they create dependencies
|
|
|
|
;; between matches. So we don't bother trying to reorder anything.
|
|
|
|
(cond
|
|
|
|
((null matches) (funcall code vars))
|
2010-11-24 16:39:51 +00:00
|
|
|
((eq :pcase--fail (car matches)) (pcase--u rest))
|
|
|
|
((eq :pcase--succeed (car matches))
|
|
|
|
(pcase--u1 (cdr matches) code vars rest))
|
2010-08-10 13:18:14 +00:00
|
|
|
((eq 'and (caar matches))
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--u1 (append (cdar matches) (cdr matches)) code vars rest))
|
2010-08-10 13:18:14 +00:00
|
|
|
((eq 'or (caar matches))
|
|
|
|
(let* ((alts (cdar matches))
|
|
|
|
(var (if (eq (caar alts) 'match) (cadr (car alts))))
|
|
|
|
(simples '()) (others '()))
|
|
|
|
(when var
|
|
|
|
(dolist (alt alts)
|
|
|
|
(if (and (eq (car alt) 'match) (eq var (cadr alt))
|
|
|
|
(let ((upat (cddr alt)))
|
|
|
|
(and (eq (car-safe upat) '\`)
|
2010-10-29 01:05:38 +00:00
|
|
|
(or (integerp (cadr upat)) (symbolp (cadr upat))
|
|
|
|
(stringp (cadr upat))))))
|
2010-08-10 13:18:14 +00:00
|
|
|
(push (cddr alt) simples)
|
|
|
|
(push alt others))))
|
|
|
|
(cond
|
2010-11-24 16:39:51 +00:00
|
|
|
((null alts) (error "Please avoid it") (pcase--u rest))
|
2010-08-10 13:18:14 +00:00
|
|
|
((> (length simples) 1)
|
|
|
|
;; De-hoist the `or' MATCH into an `or' pattern that will be
|
|
|
|
;; turned into a `memq' below.
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--u1 (cons `(match ,var or . ,(nreverse simples)) (cdr matches))
|
|
|
|
code vars
|
|
|
|
(if (null others) rest
|
2011-02-18 13:55:51 +00:00
|
|
|
(cons (cons
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--and (if (cdr others)
|
|
|
|
(cons 'or (nreverse others))
|
|
|
|
(car others))
|
|
|
|
(cdr matches))
|
2011-02-18 13:55:51 +00:00
|
|
|
(cons code vars))
|
2010-11-24 16:39:51 +00:00
|
|
|
rest))))
|
2010-08-10 13:18:14 +00:00
|
|
|
(t
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--u1 (cons (pop alts) (cdr matches)) code vars
|
|
|
|
(if (null alts) (progn (error "Please avoid it") rest)
|
2011-02-18 13:55:51 +00:00
|
|
|
(cons (cons
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--and (if (cdr alts)
|
|
|
|
(cons 'or alts) (car alts))
|
|
|
|
(cdr matches))
|
2011-02-18 13:55:51 +00:00
|
|
|
(cons code vars))
|
2010-11-24 16:39:51 +00:00
|
|
|
rest)))))))
|
2010-08-10 13:18:14 +00:00
|
|
|
((eq 'match (caar matches))
|
2011-02-18 13:55:51 +00:00
|
|
|
(let* ((popmatches (pop matches))
|
2011-03-01 05:03:24 +00:00
|
|
|
(_op (car popmatches)) (cdrpopmatches (cdr popmatches))
|
2011-02-18 13:55:51 +00:00
|
|
|
(sym (car cdrpopmatches))
|
|
|
|
(upat (cdr cdrpopmatches)))
|
2010-08-10 13:18:14 +00:00
|
|
|
(cond
|
2010-11-24 16:39:51 +00:00
|
|
|
((memq upat '(t _)) (pcase--u1 matches code vars rest))
|
|
|
|
((eq upat 'dontcare) :pcase--dontcare)
|
2010-08-10 13:18:14 +00:00
|
|
|
((functionp upat) (error "Feature removed, use (pred %s)" upat))
|
2010-10-29 01:05:38 +00:00
|
|
|
((memq (car-safe upat) '(guard pred))
|
2011-02-18 13:55:51 +00:00
|
|
|
(let* ((splitrest
|
|
|
|
(pcase--split-rest
|
|
|
|
sym (apply-partially #'pcase--split-pred upat) rest))
|
|
|
|
(then-rest (car splitrest))
|
|
|
|
(else-rest (cdr splitrest)))
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--if (if (and (eq (car upat) 'pred) (symbolp (cadr upat)))
|
|
|
|
`(,(cadr upat) ,sym)
|
|
|
|
(let* ((exp (cadr upat))
|
|
|
|
;; `vs' is an upper bound on the vars we need.
|
|
|
|
(vs (pcase--fgrep (mapcar #'car vars) exp))
|
|
|
|
(call (cond
|
|
|
|
((eq 'guard (car upat)) exp)
|
|
|
|
((functionp exp) `(,exp ,sym))
|
|
|
|
(t `(,@exp ,sym)))))
|
|
|
|
(if (null vs)
|
|
|
|
call
|
|
|
|
;; Let's not replace `vars' in `exp' since it's
|
|
|
|
;; too difficult to do it right, instead just
|
|
|
|
;; let-bind `vars' around `exp'.
|
|
|
|
`(let ,(mapcar (lambda (var)
|
|
|
|
(list var (cdr (assq var vars))))
|
|
|
|
vs)
|
|
|
|
;; FIXME: `vars' can capture `sym'. E.g.
|
|
|
|
;; (pcase x ((and `(,x . ,y) (pred (fun x)))))
|
|
|
|
,call))))
|
|
|
|
(pcase--u1 matches code vars then-rest)
|
|
|
|
(pcase--u else-rest))))
|
2010-08-10 13:18:14 +00:00
|
|
|
((symbolp upat)
|
2011-02-18 04:58:21 +00:00
|
|
|
(if (not (assq upat vars))
|
|
|
|
(pcase--u1 matches code (cons (cons upat sym) vars) rest)
|
|
|
|
;; Non-linear pattern. Turn it into an `eq' test.
|
|
|
|
(pcase--u1 (cons `(match ,sym . (pred (eq ,(cdr (assq upat vars)))))
|
|
|
|
matches)
|
|
|
|
code vars rest)))
|
2010-08-10 13:18:14 +00:00
|
|
|
((eq (car-safe upat) '\`)
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--q1 sym (cadr upat) matches code vars rest))
|
2010-08-10 13:18:14 +00:00
|
|
|
((eq (car-safe upat) 'or)
|
2010-10-29 01:05:38 +00:00
|
|
|
(let ((all (> (length (cdr upat)) 1))
|
|
|
|
(memq-fine t))
|
2010-08-10 13:18:14 +00:00
|
|
|
(when all
|
|
|
|
(dolist (alt (cdr upat))
|
|
|
|
(unless (and (eq (car-safe alt) '\`)
|
2010-10-29 01:05:38 +00:00
|
|
|
(or (symbolp (cadr alt)) (integerp (cadr alt))
|
|
|
|
(setq memq-fine nil)
|
|
|
|
(stringp (cadr alt))))
|
2010-08-10 13:18:14 +00:00
|
|
|
(setq all nil))))
|
|
|
|
(if all
|
|
|
|
;; Use memq for (or `a `b `c `d) rather than a big tree.
|
2011-02-18 13:55:51 +00:00
|
|
|
(let* ((elems (mapcar 'cadr (cdr upat)))
|
|
|
|
(splitrest
|
|
|
|
(pcase--split-rest
|
|
|
|
sym (apply-partially #'pcase--split-member elems) rest))
|
|
|
|
(then-rest (car splitrest))
|
|
|
|
(else-rest (cdr splitrest)))
|
|
|
|
(pcase--if `(,(if memq-fine #'memq #'member) ,sym ',elems)
|
|
|
|
(pcase--u1 matches code vars then-rest)
|
|
|
|
(pcase--u else-rest)))
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--u1 (cons `(match ,sym ,@(cadr upat)) matches) code vars
|
|
|
|
(append (mapcar (lambda (upat)
|
|
|
|
`((and (match ,sym . ,upat) ,@matches)
|
|
|
|
,code ,@vars))
|
|
|
|
(cddr upat))
|
|
|
|
rest)))))
|
2010-08-10 13:18:14 +00:00
|
|
|
((eq (car-safe upat) 'and)
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--u1 (append (mapcar (lambda (upat) `(match ,sym ,@upat))
|
|
|
|
(cdr upat))
|
|
|
|
matches)
|
|
|
|
code vars rest))
|
2010-08-10 13:18:14 +00:00
|
|
|
((eq (car-safe upat) 'not)
|
|
|
|
;; FIXME: The implementation below is naive and results in
|
|
|
|
;; inefficient code.
|
2010-11-24 16:39:51 +00:00
|
|
|
;; To make it work right, we would need to turn pcase--u1's
|
2010-08-10 13:18:14 +00:00
|
|
|
;; `code' and `vars' into a single argument of the same form as
|
|
|
|
;; `rest'. We would also need to split this new `then-rest' argument
|
|
|
|
;; for every test (currently we don't bother to do it since
|
|
|
|
;; it's only useful for odd patterns like (and `(PAT1 . PAT2)
|
|
|
|
;; `(PAT3 . PAT4)) which the programmer can easily rewrite
|
|
|
|
;; to the more efficient `(,(and PAT1 PAT3) . ,(and PAT2 PAT4))).
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--u1 `((match ,sym . ,(cadr upat)))
|
2011-02-10 18:53:49 +00:00
|
|
|
;; FIXME: This codegen is not careful to share its
|
|
|
|
;; code if used several times: code blow up is likely.
|
2011-03-01 05:03:24 +00:00
|
|
|
(lambda (_vars)
|
2011-02-10 18:53:49 +00:00
|
|
|
;; `vars' will likely contain bindings which are
|
|
|
|
;; not always available in other paths to
|
|
|
|
;; `rest', so there' no point trying to pass
|
|
|
|
;; them down.
|
|
|
|
(pcase--u rest))
|
2010-11-24 16:39:51 +00:00
|
|
|
vars
|
|
|
|
(list `((and . ,matches) ,code . ,vars))))
|
2010-08-10 13:18:14 +00:00
|
|
|
(t (error "Unknown upattern `%s'" upat)))))
|
|
|
|
(t (error "Incorrect MATCH %s" (car matches)))))
|
|
|
|
|
2010-11-24 16:39:51 +00:00
|
|
|
(defun pcase--q1 (sym qpat matches code vars rest)
|
2010-08-10 13:18:14 +00:00
|
|
|
"Return code that runs CODE if SYM matches QPAT and if MATCHES match.
|
|
|
|
and if not, defers to REST which is a list of branches of the form
|
|
|
|
\(OTHER_MATCH OTHER-CODE . OTHER-VARS)."
|
|
|
|
(cond
|
|
|
|
((eq (car-safe qpat) '\,) (error "Can't use `,UPATTERN"))
|
|
|
|
((floatp qpat) (error "Floating point patterns not supported"))
|
|
|
|
((vectorp qpat)
|
|
|
|
;; FIXME.
|
|
|
|
(error "Vector QPatterns not implemented yet"))
|
|
|
|
((consp qpat)
|
|
|
|
(let ((syma (make-symbol "xcar"))
|
|
|
|
(symd (make-symbol "xcdr")))
|
2011-02-18 13:55:51 +00:00
|
|
|
(let* ((splitrest (pcase--split-rest
|
|
|
|
sym
|
|
|
|
(apply-partially #'pcase--split-consp syma symd)
|
|
|
|
rest))
|
|
|
|
(then-rest (car splitrest))
|
|
|
|
(else-rest (cdr splitrest)))
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--if `(consp ,sym)
|
|
|
|
`(let ((,syma (car ,sym))
|
|
|
|
(,symd (cdr ,sym)))
|
|
|
|
,(pcase--u1 `((match ,syma . ,(pcase--upat (car qpat)))
|
|
|
|
(match ,symd . ,(pcase--upat (cdr qpat)))
|
|
|
|
,@matches)
|
|
|
|
code vars then-rest))
|
|
|
|
(pcase--u else-rest)))))
|
2010-10-29 01:05:38 +00:00
|
|
|
((or (integerp qpat) (symbolp qpat) (stringp qpat))
|
2011-02-18 13:55:51 +00:00
|
|
|
(let* ((splitrest (pcase--split-rest
|
|
|
|
sym (apply-partially 'pcase--split-equal qpat) rest))
|
|
|
|
(then-rest (car splitrest))
|
|
|
|
(else-rest (cdr splitrest)))
|
2010-11-24 16:39:51 +00:00
|
|
|
(pcase--if `(,(if (stringp qpat) #'equal #'eq) ,sym ',qpat)
|
|
|
|
(pcase--u1 matches code vars then-rest)
|
|
|
|
(pcase--u else-rest))))
|
2010-08-10 13:18:14 +00:00
|
|
|
(t (error "Unkown QPattern %s" qpat))))
|
2010-08-11 02:14:53 +00:00
|
|
|
|
2010-08-10 13:18:14 +00:00
|
|
|
|
|
|
|
(provide 'pcase)
|
|
|
|
;;; pcase.el ends here
|