mirror of
https://github.com/c-cube/sidekick.git
synced 2026-01-28 20:34:53 -05:00
2 lines
No EOL
3.9 KiB
HTML
2 lines
No EOL
3.9 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"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><header><nav><a href="../index.html">Up</a> – package <a href="../../../index.html">sidekick</a></nav><h1>Module <code>Sidekick_backend.Dot.Default</code></h1></header><div class="doc"><p>Provides a reasonnable default to instantiate the <code>Make</code> functor, assuming the original printing functions are compatible with DOT html labels.</p></div><h3 class="heading">Parameters</h3><dl><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></dl><h3 class="heading">Signature</h3><aside><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></aside><dl><dt id="type-atom"><a href="#type-atom" class="anchor"></a><code><span class="keyword">type </span>atom</code><code></code><code></code></dt><dd><p>The type of atomic formuals</p></dd></dl><dl><dt id="type-hyp"><a href="#type-hyp" class="anchor"></a><code><span class="keyword">type </span>hyp</code><code></code><code></code></dt><dt id="type-lemma"><a href="#type-lemma" class="anchor"></a><code><span class="keyword">type </span>lemma</code><code></code><code></code></dt><dt id="type-assumption"><a href="#type-assumption" class="anchor"></a><code><span class="keyword">type </span>assumption</code><code></code><code></code></dt><dd><p>The type of theory-specifi proofs (also called lemmas).</p></dd></dl><dl><dt id="val-print_atom"><a href="#val-print_atom" class="anchor"></a><code><span class="keyword">val </span>print_atom : Format.formatter <span>‑></span> <a href="index.html#type-atom">atom</a> <span>‑></span> unit</code></dt><dd><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></dd></dl><dl><dt id="val-hyp_info"><a href="#val-hyp_info" class="anchor"></a><code><span class="keyword">val </span>hyp_info : <a href="index.html#type-hyp">hyp</a> <span>‑></span> string<span class="keyword"> * </span>string option<span class="keyword"> * </span>(Format.formatter <span>‑></span> unit <span>‑></span> unit) list</code></dt><dt id="val-lemma_info"><a href="#val-lemma_info" class="anchor"></a><code><span class="keyword">val </span>lemma_info : <a href="index.html#type-lemma">lemma</a> <span>‑></span> string<span class="keyword"> * </span>string option<span class="keyword"> * </span>(Format.formatter <span>‑></span> unit <span>‑></span> unit) list</code></dt><dt id="val-assumption_info"><a href="#val-assumption_info" class="anchor"></a><code><span class="keyword">val </span>assumption_info : <a href="index.html#type-assumption">assumption</a> <span>‑></span> string<span class="keyword"> * </span>string option<span class="keyword"> * </span>(Format.formatter <span>‑></span> unit <span>‑></span> unit) list</code></dt><dd><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>(rule, color, l)</code>, such that:</p><ul><li><code>rule</code> is a name for the proof (arbitrary, does not need to be unique, but should rather be descriptive)</li><li><code>color</code> is a color name (optional) understood by DOT</li><li><code>l</code> is a list of printers that will be called to print some additional information</li></ul></dd></dl></body></html> |