package coq
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=3cbfc1e1a72b16d4744f5b64ede59586071e31d9c11c811a0372060727bfd9c3
doc/coq-core.pretyping/Constr_matching/index.html
Module Constr_matching
Source
This module implements pattern-matching on terms
PatternMatchingFailure
is the exception raised when pattern matching fails
special_meta
is the default name of the meta holding the surrounding context in subterm matching
bound_ident_map
represents the result of matching binding identifiers of the pattern with the binding identifiers of the term matched
val matches :
Environ.env ->
Evd.evar_map ->
Pattern.constr_pattern ->
EConstr.constr ->
Ltac_pretype.patvar_map
matches pat c
matches c
against pat
and returns the resulting assignment of metavariables; it raises PatternMatchingFailure
if not matchable; bindings are given in increasing order based on the numbers given in the pattern
val matches_head :
Environ.env ->
Evd.evar_map ->
Pattern.constr_pattern ->
EConstr.constr ->
Ltac_pretype.patvar_map
matches_head pat c
does the same as matches pat c
but accepts pat
to match an applicative prefix of c
val extended_matches :
Environ.env ->
Evd.evar_map ->
(binding_bound_vars * Pattern.constr_pattern) ->
EConstr.constr ->
bound_ident_map * Ltac_pretype.extended_patvar_map
extended_matches pat c
also returns the names of bound variables in c
that matches the bound variables in pat
; if several bound variables or metavariables have the same name, the metavariable, or else the rightmost bound variable, takes precedence
val is_matching :
Environ.env ->
Evd.evar_map ->
Pattern.constr_pattern ->
EConstr.constr ->
bool
is_matching pat c
just tells if c
matches against pat
val is_matching_head :
Environ.env ->
Evd.evar_map ->
Pattern.constr_pattern ->
EConstr.constr ->
bool
is_matching_head pat c
just tells if c
or an applicative prefix of it matches against pat
type matching_result = {
m_sub : bound_ident_map * Ltac_pretype.patvar_map;
m_ctx : EConstr.t Lazy.t;
}
The type of subterm matching results: a substitution + a context (whose hole is denoted here with special_meta
)
val match_subterm :
Environ.env ->
Evd.evar_map ->
(binding_bound_vars * Pattern.constr_pattern) ->
EConstr.constr ->
matching_result IStream.t
match_subterm pat c
returns the substitution and the context corresponding to each **closed** subterm of c
matching pat
, considering application contexts as well.
val is_matching_appsubterm :
?closed:bool ->
Environ.env ->
Evd.evar_map ->
Pattern.constr_pattern ->
EConstr.constr ->
bool
is_matching_appsubterm pat c
tells if a subterm of c
matches against pat
taking partial subterms into consideration