mirror of
https://github.com/c-cube/sidekick.git
synced 2026-01-27 11:54:49 -05:00
10 lines
No EOL
4.8 KiB
HTML
10 lines
No EOL
4.8 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Default (sidekick.Sidekick_backend.Dot.Default)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../../index.html">sidekick</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">Sidekick_backend.Dot.Default</span></h1></header><div class="doc"><p>Provides a reasonnable default to instantiate the <code class="code">Make</code> functor, assuming
|
|
the original printing functions are compatible with DOT html labels.</p></div><h3 class="heading">Parameters</h3><div><div class="spec argument" id="argument-1-S"><a href="#argument-1-S" class="anchor"></a><div class="def argument"><code><a href="argument-1-S/index.html">S</a> : <a href="../../../Sidekick_sat/Res/index.html#module-type-S">Sidekick_sat.Res.S</a></code></div><div class="doc"></div></div></div><h3 class="heading">Signature</h3><p>Term printing for DOT</p><p>This module defines what functions are required in order to export
|
|
a proof to the DOT format.</p><div class="spec type" id="type-atom"><a href="#type-atom" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>atom</code><code></code><code></code></div><div class="doc"><p>The type of atomic formuals</p></div></div><div class="spec type" id="type-hyp"><a href="#type-hyp" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>hyp</code><code></code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-lemma"><a href="#type-lemma" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>lemma</code><code></code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-assumption"><a href="#type-assumption" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>assumption</code><code></code><code></code></div><div class="doc"><p>The type of theory-specifi proofs (also called lemmas).</p></div></div><div class="spec val" id="val-print_atom"><a href="#val-print_atom" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>print_atom : Format.formatter <span class="keyword">‑></span> <a href="index.html#type-atom">atom</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Print the contents of the given atomic formulas.
|
|
WARNING: this function should take care to escape and/or not output special
|
|
reserved characters for the dot format (such as quotes and so on).</p></div></div><div class="spec val" id="val-hyp_info"><a href="#val-hyp_info" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>hyp_info : <a href="index.html#type-hyp">hyp</a> <span class="keyword">‑></span> string<span class="keyword"> * </span>string option<span class="keyword"> * </span>(Format.formatter <span class="keyword">‑></span> unit <span class="keyword">‑></span> unit) list</code></div><div class="doc"></div></div><div class="spec val" id="val-lemma_info"><a href="#val-lemma_info" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>lemma_info : <a href="index.html#type-lemma">lemma</a> <span class="keyword">‑></span> string<span class="keyword"> * </span>string option<span class="keyword"> * </span>(Format.formatter <span class="keyword">‑></span> unit <span class="keyword">‑></span> unit) list</code></div><div class="doc"></div></div><div class="spec val" id="val-assumption_info"><a href="#val-assumption_info" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>assumption_info : <a href="index.html#type-assumption">assumption</a> <span class="keyword">‑></span> string<span class="keyword"> * </span>string option<span class="keyword"> * </span>(Format.formatter <span class="keyword">‑></span> unit <span class="keyword">‑></span> unit) list</code></div><div class="doc"><p>Generate some information about the leafs of the proof tree. Currently this backend
|
|
print each lemma/assumption/hypothesis as a single leaf of the proof tree.
|
|
These function should return a triplet <code class="code">(rule, color, l)</code>, such that:
|
|
</p><ul><li><code class="code">rule</code> is a name for the proof (arbitrary, does not need to be unique, but
|
|
should rather be descriptive)</li><li><code class="code">color</code> is a color name (optional) understood by DOT</li><li><code class="code">l</code> is a list of printers that will be called to print some additional information</li></ul></div></div></body></html> |