lean2/src/library/tactic/tactic.h

/*
Copyright (c) 2013 Microsoft Corporation. All rights reserved.
Released under Apache 2.0 license as described in the file LICENSE.

Author: Leonardo de Moura
*/
#pragma once
#include <algorithm>
#include <utility>
#include <memory>
#include <string>
#include "util/thread.h"
#include "util/lazy_list.h"
#include "library/io_state.h"
#include "library/tactic/proof_state.h"

namespace lean {
typedef lazy_list<proof_state> proof_state_seq;

class tactic_cell {
    void dealloc() { delete this; }
    MK_LEAN_RC();
public:
    tactic_cell():m_rc(0) {}
    virtual ~tactic_cell() {}
    virtual proof_state_seq operator()(ro_environment const & env, io_state const & io, proof_state const & s) const = 0;
};

template<typename F>
class tactic_cell_tpl : public tactic_cell {
    F m_f;
public:
    tactic_cell_tpl(F && f):m_f(f) {}
    virtual proof_state_seq operator()(ro_environment const & env, io_state const & io, proof_state const & s) const {
        return m_f(env, io, s);
    }
};

enum class solve_result_kind { None, Proof, Counterexample, Failure };
/**
   \brief Result for the solve method in the tactic class.
   The result may be a proof, a counterexample, or a list of unsolved proof_states.
*/
class solve_result {
    solve_result_kind m_kind;
    union {
        expr              m_proof;
        counterexample    m_cex;
        list<proof_state> m_failures;
    };
    void init(solve_result const & r);
    void destroy();
public:
    solve_result():m_kind(solve_result_kind::None) {}
    solve_result(expr const & pr);
    solve_result(counterexample const & cex);
    solve_result(list<proof_state> const & fs);
    solve_result(solve_result const & r);
    ~solve_result();
    solve_result & operator=(solve_result & other);
    solve_result & operator=(solve_result && other);
    solve_result_kind kind() const { return m_kind; }
    expr get_proof() const { lean_assert(kind() == solve_result_kind::Proof); return m_proof; }
    counterexample get_cex() const { lean_assert(kind() == solve_result_kind::Counterexample); return m_cex; }
    list<proof_state> get_failures() const { lean_assert(kind() == solve_result_kind::Failure); return m_failures; }
};

class tactic {
protected:
    tactic_cell * m_ptr;
public:
    explicit tactic(tactic_cell * ptr):m_ptr(ptr) { if (m_ptr) m_ptr->inc_ref(); }
    tactic(tactic const & s):m_ptr(s.m_ptr) { if (m_ptr) m_ptr->inc_ref(); }
    tactic(tactic && s):m_ptr(s.m_ptr) { s.m_ptr = nullptr; }
    ~tactic() { if (m_ptr) m_ptr->dec_ref(); }
    friend void swap(tactic & a, tactic & b) { std::swap(a.m_ptr, b.m_ptr); }
    tactic & operator=(tactic const & s);
    tactic & operator=(tactic && s);

    proof_state_seq operator()(ro_environment const & env, io_state const & io, proof_state const & s) const {
        lean_assert(m_ptr);
        return m_ptr->operator()(env, io, s);
    }

    solve_result solve(ro_environment const & env, io_state const & io, proof_state const & s);
    solve_result solve(ro_environment const & env, io_state const & io, context const & ctx, expr const & t);
};

inline optional<tactic> none_tactic() { return optional<tactic>(); }
inline optional<tactic> some_tactic(tactic const & o) { return optional<tactic>(o); }
inline optional<tactic> some_tactic(tactic && o) { return optional<tactic>(std::forward<tactic>(o)); }

/**
   \brief Create a tactic using the given functor.
   The functor must contain the operator:

   <code>
   proof_state_seq operator()(ro_environment const & env, io_state const & io, proof_state const & s)
   </code>
*/
template<typename F>
tactic mk_tactic(F && f) { return tactic(new tactic_cell_tpl<F>(std::forward<F>(f))); }

template<typename F>
inline proof_state_seq mk_proof_state_seq(F && f) {
    return mk_lazy_list<proof_state>(std::forward<F>(f));
}

/**
   \brief Create a tactic that produces exactly one output state.

   The functor f must contain the method:
   <code>
   proof_state operator()(ro_environment const & env, io_state const & io, proof_state const & s)
   </code>

   \remark The functor is invoked on demand.
*/
template<typename F>
tactic mk_tactic1(F && f) {
    return
        mk_tactic([=](ro_environment const & env, io_state const & io, proof_state const & s) {
                return mk_proof_state_seq([=]() { return some(mk_pair(f(env, io, s), proof_state_seq())); });
            });
}

/**
   \brief Create a tactic that produces at most one output state.

   The functor f must contain the method:
   <code>
   optional<proof_state> operator()(ro_environment const & env, io_state const & io, proof_state const & s)
   </code>

   \remark The functor is invoked on demand.
*/
template<typename F>
tactic mk_tactic01(F && f) {
    return
        mk_tactic([=](ro_environment const & env, io_state const & io, proof_state const & s) {
                return mk_proof_state_seq([=]() {
                        auto r = f(env, io, s);
                        if (r)
                            return some(mk_pair(*r, proof_state_seq()));
                        else
                            return proof_state_seq::maybe_pair();
                    });
            });
}

/**
   \brief Return a "do nothing" tactic (aka skip).
*/
tactic id_tactic();
/**
   \brief Return a tactic the always fails.
*/
tactic fail_tactic();
/**
   \brief Return a tactic that fails if there are unsolved goals.
*/
tactic now_tactic();
/**
   \brief Return a tactic that solves any goal of the form  <tt>..., H : A, ... |- A</tt>.
*/
tactic assumption_tactic();
/**
   \brief Return a tactic that just returns the input state, and display the given message in the diagnostic channel.
*/
tactic trace_tactic(char const * msg);
class sstream;
tactic trace_tactic(sstream const & msg);
tactic trace_tactic(std::string const & msg);
/**
   \brief Return a tactic that just displays the input state in the diagnostic channel.
*/
tactic trace_state_tactic();
/**
   \brief Create a tactic that applies \c t, but suppressing diagnostic messages.
*/
tactic suppress_trace(tactic const & t);

/**
   \brief Return a tactic that performs \c t1 followed by \c t2.
*/
tactic then(tactic const & t1, tactic const & t2);
inline tactic operator<<(tactic const & t1, tactic const & t2) { return then(t1, t2); }
/**
   \brief Return a tactic that applies \c t1, and if \c t1 returns the empty sequence of states,
   then applies \c t2.
*/
tactic orelse(tactic const & t1, tactic const & t2);
inline tactic operator||(tactic const & t1, tactic const & t2) { return orelse(t1, t2); }
/**
   \brief Return a tactic that appies \c t, but using the additional set of options
   \c opts.
*/
tactic using_params(tactic const & t, options const & opts);
/**
   \brief Return a tactic that tries the tactic \c t for at most \c ms milliseconds.
   If the tactic does not terminate in \c ms milliseconds, then the empty
   sequence is returned.

   \remark the tactic \c t is executed in a separate execution thread.

   \remark \c check_ms is how often the main thread checks whether the child
   thread finished.
*/
tactic try_for(tactic const & t, unsigned ms, unsigned check_ms = 1);
/**
   \brief Execute both tactics and and combines their results.
   The results produced by tactic \c t1 are listed before the ones
   from tactic \c t2.
*/
tactic append(tactic const & t1, tactic const & t2);
inline tactic operator+(tactic const & t1, tactic const & t2) { return append(t1, t2); }
/**
   \brief Execute both tactics and and combines their results.
   The results produced by tactics \c t1 and \c t2 are interleaved
   to guarantee fairness.
*/
tactic interleave(tactic const & t1, tactic const & t2);
/**
   \brief Return a tactic that executes \c t1 and \c t2 in parallel.
   This is similar to \c append and \c interleave. The order of
   the elements in the output sequence is not deterministic.
   It depends on how fast \c t1 and \c t2 produce their output.

   \remark \c check_ms is how often the main thread checks whether the children
   threads finished.
*/
tactic par(tactic const & t1, tactic const & t2, unsigned check_ms);
inline tactic par(tactic const & t1, tactic const & t2) { return par(t1, t2, 1); }

/**
   \brief Return a tactic that keeps applying \c t until it fails.
*/
tactic repeat(tactic const & t);
/**
   \brief Similar to \c repeat, but applies \c t at least once.
*/
inline tactic repeat1(tactic const & t) { return then(t, repeat(t)); }
/**
   \brief Similar to \c repeat, but execute \c t at most \c k times.

   \remark The value \c k is the depth of the recursion.
   For example, if tactic \c t always produce a sequence of size 2,
   then tactic \c t will be applied 2^k times.
*/
tactic repeat_at_most(tactic const & t, unsigned k);
/**
   \brief Return a tactic that applies \c t, but takes at most \c
   k elements from the sequence produced by \c t.
*/
tactic take(tactic const & t, unsigned k);
/**
   \brief Syntax sugar for take(t, 1)
*/
inline tactic determ(tactic const & t) { return take(t, 1); }
/**
   \brief Return a tactic that applies the predicate \c p to the input state.
   If \c p returns true, then applies \c t1. Otherwise, applies \c t2.
*/
template<typename P>
tactic cond(P && p, tactic const & t1, tactic const & t2) {
    return mk_tactic([=](ro_environment const & env, io_state const & io, proof_state const & s) -> proof_state_seq {
            return mk_proof_state_seq([=]() {
                    if (p(env, io, s)) {
                        return t1(env, io, s).pull();
                    } else {
                        return t2(env, io, s).pull();
                    }
                });
        });
}
/**
   \brief Syntax-sugar for cond(p, t, id_tactic())
*/
template<typename P>
tactic when(P && p, tactic const & t) { return cond(std::forward<P>(p), t, id_tactic()); }
/**
   \brief Return a tactic that applies \c t only to the goal named \c gname.
   The tactic fails if the input state does not have a goal named \c gname.
*/
tactic focus(tactic const & t, name const & gname);
/**
   \brief Return a tactic that applies \c t only to the i-th goal.
   The tactic fails if the input state does have at least i goals.
*/
tactic focus(tactic const & t, int i);
inline tactic focus(tactic const & t) { return focus(t, 1); }
/**
   \brief Return a tactic that unfolds the definition named \c n.
*/
tactic unfold_tactic(name const & n);
/**
   \brief Return a tactic that unfolds all (non-hidden and non-opaque) definitions.
*/
tactic unfold_tactic();
/**
   \brief Return a tactic that applies beta-reduction.
*/
tactic beta_tactic();

UDATA_DEFS_CORE(proof_state_seq)
UDATA_DEFS(tactic);
tactic to_tactic_ext(lua_State * L, int i);
void open_tactic(lua_State * L);
}