lean4-htt/src/library/unification_hint.cpp
Leonardo de Moura a31de3b7bc feat(library/unification_hint): improve unification_hint matcher
Improvements:
- Use heuristic match explicit arguments first and then match implicit.
- Skip annotations.
- Follow metavariable assigments.
- Use is_def_eq when pattern doest not contain matching variables.
2017-03-21 10:19:34 -07:00

380 lines
15 KiB
C++

/*
Copyright (c) 2015 Daniel Selsam. All rights reserved.
Released under Apache 2.0 license as described in the file LICENSE.
Authors: Daniel Selsam, Leonardo de Moura
*/
#include <string>
#include "util/sexpr/format.h"
#include "kernel/expr.h"
#include "kernel/instantiate.h"
#include "kernel/replace_fn.h"
#include "kernel/error_msgs.h"
#include "library/attribute_manager.h"
#include "library/constants.h"
#include "library/unification_hint.h"
#include "library/util.h"
#include "library/trace.h"
#include "library/expr_lt.h"
#include "library/scoped_ext.h"
#include "library/fun_info.h"
#include "library/annotation.h"
#include "library/type_context.h"
namespace lean {
unification_hint::unification_hint(expr const & lhs, expr const & rhs, list<expr_pair> const & constraints, unsigned num_vars):
m_lhs(lhs), m_rhs(rhs), m_constraints(constraints), m_num_vars(num_vars) {}
int unification_hint_cmp::operator()(unification_hint const & uh1, unification_hint const & uh2) const {
if (uh1.get_lhs() != uh2.get_lhs()) {
return expr_quick_cmp()(uh1.get_lhs(), uh2.get_lhs());
} else if (uh1.get_rhs() != uh2.get_rhs()) {
return expr_quick_cmp()(uh1.get_rhs(), uh2.get_rhs());
} else {
auto it1 = uh1.get_constraints().begin();
auto it2 = uh2.get_constraints().begin();
auto end1 = uh1.get_constraints().end();
auto end2 = uh2.get_constraints().end();
for (; it1 != end1 && it2 != end2; ++it1, ++it2) {
if (unsigned cmp = expr_pair_quick_cmp()(*it1, *it2)) return cmp;
}
return 0;
}
}
struct unification_hint_state {
unification_hints m_hints;
name_map<unsigned> m_decl_names_to_prio; // Note: redundant but convenient
void validate_type(expr const & decl_type) {
expr type = decl_type;
while (is_pi(type)) type = binding_body(type);
if (!is_app_of(type, get_unification_hint_name(), 0)) {
throw exception("invalid unification hint, must return element of type `unification hint`");
}
}
void register_hint(environment const & env, name const & decl_name, expr const & value, unsigned priority) {
m_decl_names_to_prio.insert(decl_name, priority);
type_context _ctx(env, options(), transparency_mode::All);
tmp_type_context ctx(_ctx);
expr e_hint = value;
unsigned num_vars = 0;
buffer<expr> tmp_mvars;
while (is_lambda(e_hint)) {
expr d = instantiate_rev(binding_domain(e_hint), tmp_mvars.size(), tmp_mvars.data());
tmp_mvars.push_back(ctx.mk_tmp_mvar(d));
e_hint = binding_body(e_hint);
num_vars++;
}
if (!is_app_of(e_hint, get_unification_hint_mk_name(), 2)) {
throw exception("invalid unification hint, body must be application of 'unification_hint.mk' to two arguments");
}
// e_hint := unification_hint.mk pattern constraints
expr e_pattern = app_arg(app_fn(e_hint));
expr e_constraints = app_arg(e_hint);
// pattern := unification_constraint.mk _ lhs rhs
expr e_pattern_lhs = app_arg(app_fn(e_pattern));
expr e_pattern_rhs = app_arg(e_pattern);
expr e_pattern_lhs_fn = get_app_fn(e_pattern_lhs);
expr e_pattern_rhs_fn = get_app_fn(e_pattern_rhs);
if (!is_constant(e_pattern_lhs_fn) || !is_constant(e_pattern_rhs_fn)) {
throw exception("invalid unification hint, the heads of both sides of pattern must be constants");
}
if (quick_cmp(const_name(e_pattern_lhs_fn), const_name(e_pattern_rhs_fn)) > 0) {
swap(e_pattern_lhs_fn, e_pattern_rhs_fn);
swap(e_pattern_lhs, e_pattern_rhs);
}
name_pair key = mk_pair(const_name(e_pattern_lhs_fn), const_name(e_pattern_rhs_fn));
buffer<expr_pair> constraints;
unsigned eqidx = 1;
while (is_app_of(e_constraints, get_list_cons_name(), 3)) {
// e_constraints := cons _ constraint rest
expr e_constraint = app_arg(app_fn(e_constraints));
expr e_constraint_lhs = app_arg(app_fn(e_constraint));
expr e_constraint_rhs = app_arg(e_constraint);
constraints.push_back(mk_pair(e_constraint_lhs, e_constraint_rhs));
e_constraints = app_arg(e_constraints);
if (!ctx.is_def_eq(instantiate_rev(e_constraint_lhs, tmp_mvars.size(), tmp_mvars.data()),
instantiate_rev(e_constraint_rhs, tmp_mvars.size(), tmp_mvars.data()))) {
throw exception(sstream() << "invalid unification hint, failed to unify constraint #" << eqidx);
}
eqidx++;
}
if (!is_app_of(e_constraints, get_list_nil_name(), 1)) {
throw exception("invalid unification hint, must provide list of constraints explicitly");
}
if (!ctx.is_def_eq(instantiate_rev(e_pattern_lhs, tmp_mvars.size(), tmp_mvars.data()),
instantiate_rev(e_pattern_rhs, tmp_mvars.size(), tmp_mvars.data()))) {
throw exception("invalid unification hint, failed to unify pattern after unifying constraints");
}
unification_hint hint(e_pattern_lhs, e_pattern_rhs, to_list(constraints), num_vars);
unification_hint_queue q;
if (auto const & q_ptr = m_hints.find(key)) q = *q_ptr;
q.insert(hint, priority);
m_hints.insert(key, q);
}
};
struct unification_hint_entry {
name m_decl_name;
unsigned m_priority;
unification_hint_entry(name const & decl_name, unsigned priority):
m_decl_name(decl_name), m_priority(priority) {}
};
struct unification_hint_config {
typedef unification_hint_entry entry;
typedef unification_hint_state state;
static void add_entry(environment const & env, io_state const &, state & s, entry const & e) {
declaration decl = env.get(e.m_decl_name);
s.validate_type(decl.get_type());
s.register_hint(env, e.m_decl_name, decl.get_value(), e.m_priority);
}
static const char * get_serialization_key() { return "UNIFICATION_HINT"; }
static void write_entry(serializer & s, entry const & e) {
s << e.m_decl_name << e.m_priority;
}
static entry read_entry(deserializer & d) {
name decl_name; unsigned prio;
d >> decl_name >> prio;
return entry(decl_name, prio);
}
static optional<unsigned> get_fingerprint(entry const & e) {
return some(hash(e.m_decl_name.hash(), e.m_priority));
}
};
typedef scoped_ext<unification_hint_config> unification_hint_ext;
environment add_unification_hint(environment const & env, io_state const & ios, name const & decl_name, unsigned prio,
bool persistent) {
if (!env.get(decl_name).is_definition())
throw exception(sstream() << "invalid unification hint, '" << decl_name << "' must be a definition");
return unification_hint_ext::add_entry(env, ios, unification_hint_entry(decl_name, prio), persistent);
}
unification_hints get_unification_hints(environment const & env) {
return unification_hint_ext::get_state(env).m_hints;
}
void get_unification_hints(unification_hints const & hints, name const & n1, name const & n2, buffer<unification_hint> & uhints) {
if (quick_cmp(n1, n2) > 0) {
if (auto const * q_ptr = hints.find(mk_pair(n2, n1)))
q_ptr->to_buffer(uhints);
} else {
if (auto const * q_ptr = hints.find(mk_pair(n1, n2)))
q_ptr->to_buffer(uhints);
}
}
void get_unification_hints(environment const & env, name const & n1, name const & n2, buffer<unification_hint> & uhints) {
unification_hints hints = unification_hint_ext::get_state(env).m_hints;
get_unification_hints(hints, n1, n2, uhints);
}
/* Pretty-printing */
// TODO(dhs): I may not be using all the formatting functions correctly.
format unification_hint::pp(unsigned prio, formatter const & fmt) const {
format r;
if (prio != LEAN_DEFAULT_PRIORITY)
r += paren(format(prio)) + space();
format r1 = fmt(get_lhs()) + space() + format("=?=") + pp_indent_expr(fmt, get_rhs());
r1 += space() + lcurly();
r += group(r1);
bool first = true;
for (expr_pair const & p : m_constraints) {
if (first) {
first = false;
} else {
r += comma() + space();
}
r += fmt(p.first) + space() + format("=?=") + space() + fmt(p.second);
}
r += rcurly();
return r;
}
format pp_unification_hints(unification_hints const & hints, formatter const & fmt) {
format r;
r += format("unification hints") + colon() + line();
hints.for_each([&](name_pair const & names, unification_hint_queue const & q) {
q.for_each([&](unification_hint const & hint) {
r += lp() + format(names.first) + comma() + space() + format(names.second) + rp() + space();
r += hint.pp(*q.get_prio(hint), fmt) + line();
});
});
return r;
}
class unification_hint_fn {
type_context & m_owner;
unification_hint const & m_hint;
buffer<optional<expr>> m_assignment;
expr apply_assignment(expr const & e) {
return replace(e, [=](expr const & m, unsigned offset) -> optional<expr> {
if (offset >= get_free_var_range(m))
return some_expr(m); // expression m does not contain free variables with idx >= s1
if (is_var(m)) {
unsigned vidx = var_idx(m);
if (vidx >= offset) {
unsigned h = offset + m_assignment.size();
if (h < offset /* overflow, h is bigger than any vidx */ || vidx < h) {
if (auto v = m_assignment[vidx - offset])
return some_expr(*v);
}
return some_expr(m);
}
}
return none_expr();
});
}
bool match_app(expr const & p, expr const & e) {
buffer<expr> p_args, e_args;
expr const & p_fn = get_app_args(p, p_args);
expr const & e_fn = get_app_args(e, e_args);
if (p_args.size() != e_args.size())
return false;
fun_info finfo = get_fun_info(m_owner, e_fn, e_args.size());
unsigned i = 0;
buffer<unsigned> postponed;
for (param_info const & pinfo : finfo.get_params_info()) {
if (!pinfo.is_implicit() && !pinfo.is_inst_implicit()) {
if (!match(p_args[i], e_args[i])) {
return false;
}
} else {
postponed.push_back(i);
}
i++;
}
for (; i < p_args.size(); i++) {
if (!match(p_args[i], e_args[i])) {
return false;
}
}
if (!match(p_fn, e_fn))
return false;
for (unsigned i : postponed) {
expr new_p_arg = apply_assignment(p_args[i]);
if (closed(new_p_arg)) {
if (!m_owner.is_def_eq(new_p_arg, e_args[i])) {
return false;
}
} else {
if (!match(new_p_arg, e_args[i]))
return false;
}
}
return true;
}
bool match(expr const & pattern, expr const & e) {
if (m_owner.is_mvar(e) && m_owner.is_assigned(e)) {
return match(pattern, m_owner.instantiate_mvars(e));
}
if (is_annotation(e)) {
return match(pattern, get_annotation_arg(e));
}
unsigned idx;
switch (pattern.kind()) {
case expr_kind::Var:
idx = var_idx(pattern);
if (!m_assignment[idx]) {
m_assignment[idx] = some_expr(e);
return true;
} else {
return m_owner.is_def_eq(*m_assignment[idx], e);
}
case expr_kind::Constant:
return
is_constant(e) &&
const_name(pattern) == const_name(e) &&
m_owner.is_def_eq(const_levels(pattern), const_levels(e));
case expr_kind::Sort:
return is_sort(e) && m_owner.is_def_eq(sort_level(pattern), sort_level(e));
case expr_kind::Pi: case expr_kind::Lambda:
case expr_kind::Macro: case expr_kind::Let:
// Remark: we do not traverse inside of binders.
return pattern == e;
case expr_kind::App:
return
is_app(e) &&
match(app_fn(pattern), app_fn(e)) &&
match(app_arg(pattern), app_arg(e));
case expr_kind::Local: case expr_kind::Meta:
lean_unreachable();
}
lean_unreachable();
}
public:
unification_hint_fn(type_context & o, unification_hint const & hint):
m_owner(o), m_hint(hint) {
m_assignment.resize(m_hint.get_num_vars());
}
bool operator()(expr const & lhs, expr const & rhs) {
if (!match(m_hint.get_lhs(), lhs)) {
lean_trace(name({"type_context", "unification_hint"}), tout() << "LHS does not match\n";);
return false;
} else if (!match(m_hint.get_rhs(), rhs)) {
lean_trace(name({"type_context", "unification_hint"}), tout() << "RHS does not match\n";);
return false;
} else {
auto instantiate_assignment_fn = [&](expr const & e, unsigned offset) {
if (is_var(e)) {
unsigned idx = var_idx(e) + offset;
if (idx < m_assignment.size() && m_assignment[idx])
return m_assignment[idx];
}
return none_expr();
};
buffer<expr_pair> constraints;
to_buffer(m_hint.get_constraints(), constraints);
for (expr_pair const & p : constraints) {
expr new_lhs = replace(p.first, instantiate_assignment_fn);
expr new_rhs = replace(p.second, instantiate_assignment_fn);
bool success = m_owner.is_def_eq(new_lhs, new_rhs);
lean_trace(name({"type_context", "unification_hint"}),
scope_trace_env scope(m_owner.env(), m_owner);
tout() << new_lhs << " =?= " << new_rhs << "..."
<< (success ? "success" : "failed") << "\n";);
if (!success) return false;
}
lean_trace(name({"type_context", "unification_hint"}),
tout() << "hint successfully applied\n";);
return true;
}
}
};
bool try_unification_hint(type_context & o, unification_hint const & hint, expr const & lhs, expr const & rhs) {
return unification_hint_fn(o, hint)(lhs, rhs);
}
void initialize_unification_hint() {
unification_hint_ext::initialize();
register_system_attribute(basic_attribute("unify", "unification hint", add_unification_hint));
}
void finalize_unification_hint() {
unification_hint_ext::finalize();
}
}