@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
54 lines • 15.4 kB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>Pretty-printing assertions — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton"><span id="sidebar-button-arrow">☰</span></a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="ciao-logo_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><span class="lpdoc-on-right"><a class="lpdoc-navbutton" href="ExtraLibs.html">↑</a><a class="lpdoc-navbutton" href="pretty_print.html">←</a><a class="lpdoc-navbutton" href="syntax_highlight.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a></span><span><a href="ciaofulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> »<br/> </li><li><a href="ExtraLibs.html">PART VIII - Additional libraries</a> »<br/> </li><li><a href=""><strong>Pretty-printing assertions</strong></a></li></ul><hr></hr><em>ON THIS PAGE</em><ul><li><a href="#Usage and interface">Usage and interface</a></li><li><a href="#Documentation on exports">Documentation on exports</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Pretty-printing assertions</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#assrt_write"></a>
<strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="Francisco Bueno" href="ciaosearch.html#Francisco Bueno">Francisco Bueno</a>.<p>
This module defines some predicates which are useful for writing assertions in a readable form.<br/><div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li><strong>Library usage:</strong><br/><tt>:- use_module(library(assertions/assrt_write)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#write_assertion/6"><tt>write_assertion/6</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#write_assertion/7"><tt>write_assertion/7</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#write_assertion_as_comment/6"><tt>write_assertion_as_comment/6</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#write_assertion_as_comment/7"><tt>write_assertion_as_comment/7</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#write_assertion_as_double_comment/6"><tt>write_assertion_as_double_comment/6</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#write_assertion_as_double_comment/7"><tt>write_assertion_as_double_comment/7</tt></a>.
</ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="write_assertion/6" href="ciaosearch.html#write_assertion/6">write_assertion/6</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>write_assertion(Goal,Status,Type,Body,Dict,Flag)</tt>
</span><p>Writes the (normalized) assertion to current output.</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="6" href="assertions_props.html#assrt_status/1"><tt>assertions_props:assrt_status/1</tt></a>)</span><span><span class="lpdoc-var">Status</span> is an acceptable status for an assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="7" href="assertions_props.html#assrt_type/1"><tt>assertions_props:assrt_type/1</tt></a>)</span><span><span class="lpdoc-var">Type</span> is an admissible kind of assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="8" href="assertions_props.html#nabody/1"><tt>assertions_props:nabody/1</tt></a>)</span><span><span class="lpdoc-var">Body</span> is a normalized assertion body.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="9" href="assertions_props.html#dictionary/1"><tt>assertions_props:dictionary/1</tt></a>)</span><span><span class="lpdoc-var">Dict</span> is a dictionary of variable names.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="10" href="ciaosearch.html#status_flag/1"><tt>assrt_write:status_flag/1</tt></a>)</span><span><span class="lpdoc-var">Flag</span> is <tt>status</tt> or <tt>nostatus</tt>.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="write_assertion/7" href="ciaosearch.html#write_assertion/7">write_assertion/7</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>write_assertion(Stream,Goal,Status,Type,Body,Dict,Flag)</tt>
</span><p>Writes the (normalized) assertion to stream <span class="lpdoc-var">Stream</span>.</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="11" href="assertions_props.html#assrt_status/1"><tt>assertions_props:assrt_status/1</tt></a>)</span><span><span class="lpdoc-var">Status</span> is an acceptable status for an assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="12" href="assertions_props.html#assrt_type/1"><tt>assertions_props:assrt_type/1</tt></a>)</span><span><span class="lpdoc-var">Type</span> is an admissible kind of assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="13" href="assertions_props.html#nabody/1"><tt>assertions_props:nabody/1</tt></a>)</span><span><span class="lpdoc-var">Body</span> is a normalized assertion body.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="14" href="assertions_props.html#dictionary/1"><tt>assertions_props:dictionary/1</tt></a>)</span><span><span class="lpdoc-var">Dict</span> is a dictionary of variable names.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="15" href="ciaosearch.html#status_flag/1"><tt>assrt_write:status_flag/1</tt></a>)</span><span><span class="lpdoc-var">Flag</span> is <tt>status</tt> or <tt>nostatus</tt>.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="write_assertion_as_comment/6" href="ciaosearch.html#write_assertion_as_comment/6">write_assertion_as_comment/6</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>write_assertion_as_comment(Goal,Status,Type,Body,Dict,Flag)</tt>
</span><p>Writes the (normalized) assertion to current output as a Prolog comment.</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="16" href="assertions_props.html#assrt_status/1"><tt>assertions_props:assrt_status/1</tt></a>)</span><span><span class="lpdoc-var">Status</span> is an acceptable status for an assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="17" href="assertions_props.html#assrt_type/1"><tt>assertions_props:assrt_type/1</tt></a>)</span><span><span class="lpdoc-var">Type</span> is an admissible kind of assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="18" href="assertions_props.html#nabody/1"><tt>assertions_props:nabody/1</tt></a>)</span><span><span class="lpdoc-var">Body</span> is a normalized assertion body.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="19" href="assertions_props.html#dictionary/1"><tt>assertions_props:dictionary/1</tt></a>)</span><span><span class="lpdoc-var">Dict</span> is a dictionary of variable names.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="20" href="ciaosearch.html#status_flag/1"><tt>assrt_write:status_flag/1</tt></a>)</span><span><span class="lpdoc-var">Flag</span> is <tt>status</tt> or <tt>nostatus</tt>.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="write_assertion_as_comment/7" href="ciaosearch.html#write_assertion_as_comment/7">write_assertion_as_comment/7</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>write_assertion_as_comment(Stream,Goal,Status,Type,Body,Dict,Flag)</tt>
</span><p>Writes the (normalized) assertion to stream <span class="lpdoc-var">Stream</span> as a Prolog comment.</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="21" href="assertions_props.html#assrt_status/1"><tt>assertions_props:assrt_status/1</tt></a>)</span><span><span class="lpdoc-var">Status</span> is an acceptable status for an assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="22" href="assertions_props.html#assrt_type/1"><tt>assertions_props:assrt_type/1</tt></a>)</span><span><span class="lpdoc-var">Type</span> is an admissible kind of assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="23" href="assertions_props.html#nabody/1"><tt>assertions_props:nabody/1</tt></a>)</span><span><span class="lpdoc-var">Body</span> is a normalized assertion body.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="24" href="assertions_props.html#dictionary/1"><tt>assertions_props:dictionary/1</tt></a>)</span><span><span class="lpdoc-var">Dict</span> is a dictionary of variable names.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="25" href="ciaosearch.html#status_flag/1"><tt>assrt_write:status_flag/1</tt></a>)</span><span><span class="lpdoc-var">Flag</span> is <tt>status</tt> or <tt>nostatus</tt>.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="write_assertion_as_double_comment/6" href="ciaosearch.html#write_assertion_as_double_comment/6">write_assertion_as_double_comment/6</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>write_assertion_as_double_comment(Goal,Status,Type,Body,Dict,Flag)</tt>
</span><p>Writes the (normalized) assertion to current output as a Prolog double comment.</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="26" href="assertions_props.html#assrt_status/1"><tt>assertions_props:assrt_status/1</tt></a>)</span><span><span class="lpdoc-var">Status</span> is an acceptable status for an assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="27" href="assertions_props.html#assrt_type/1"><tt>assertions_props:assrt_type/1</tt></a>)</span><span><span class="lpdoc-var">Type</span> is an admissible kind of assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="28" href="assertions_props.html#nabody/1"><tt>assertions_props:nabody/1</tt></a>)</span><span><span class="lpdoc-var">Body</span> is a normalized assertion body.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="29" href="assertions_props.html#dictionary/1"><tt>assertions_props:dictionary/1</tt></a>)</span><span><span class="lpdoc-var">Dict</span> is a dictionary of variable names.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="30" href="ciaosearch.html#status_flag/1"><tt>assrt_write:status_flag/1</tt></a>)</span><span><span class="lpdoc-var">Flag</span> is <tt>status</tt> or <tt>nostatus</tt>.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="write_assertion_as_double_comment/7" href="ciaosearch.html#write_assertion_as_double_comment/7">write_assertion_as_double_comment/7</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>write_assertion_as_double_comment(Stream,Goal,Status,Type,Body,Dict,Flag)</tt>
</span><p>Writes the (normalized) assertion to stream <span class="lpdoc-var">Stream</span> as a Prolog double comment.</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="31" href="assertions_props.html#assrt_status/1"><tt>assertions_props:assrt_status/1</tt></a>)</span><span><span class="lpdoc-var">Status</span> is an acceptable status for an assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="32" href="assertions_props.html#assrt_type/1"><tt>assertions_props:assrt_type/1</tt></a>)</span><span><span class="lpdoc-var">Type</span> is an admissible kind of assertion.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="33" href="assertions_props.html#nabody/1"><tt>assertions_props:nabody/1</tt></a>)</span><span><span class="lpdoc-var">Body</span> is a normalized assertion body.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="34" href="assertions_props.html#dictionary/1"><tt>assertions_props:dictionary/1</tt></a>)</span><span><span class="lpdoc-var">Dict</span> is a dictionary of variable names.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="35" href="ciaosearch.html#status_flag/1"><tt>assrt_write:status_flag/1</tt></a>)</span><span><span class="lpdoc-var">Flag</span> is <tt>status</tt> or <tt>nostatus</tt>.
</span>
</ul></div></div><p>
</div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="36" href="format.html"><tt>format</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="assrt_lib.html"><tt>assrt_lib</tt></a>, <a class="lpdoc-idx-anchor" id="38" href="messages.html"><tt>messages</tt></a>, <a class="lpdoc-idx-anchor" id="39" href="assertions_props.html"><tt>assertions_props</tt></a>, <a class="lpdoc-idx-anchor" id="40" href="vndict.html"><tt>vndict</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="41" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="42" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="43" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="44" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="45" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="46" href="regtypes_doc.html"><tt>regtypes</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>