@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
139 lines • 30 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>Printing status and error messages — 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="text_template.html">←</a><a class="lpdoc-navbutton" href="menu_doc.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>Printing status and error messages</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 multifiles">Documentation on multifiles</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Printing status and error messages</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#messages"></a>
<strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="The Ciao Development Team" href="ciaosearch.html#The Ciao Development Team">The Ciao Development Team</a>.<p>
This is a very simple library for printing status and error messages to the console.<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(messages)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#show_message/2"><tt>show_message/2</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#show_message/3"><tt>show_message/3</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#show_message/4"><tt>show_message/4</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#error_message/1"><tt>error_message/1</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#error_message/2"><tt>error_message/2</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#error_message/3"><tt>error_message/3</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#warning_message/1"><tt>warning_message/1</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#warning_message/2"><tt>warning_message/2</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#warning_message/3"><tt>warning_message/3</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#note_message/1"><tt>note_message/1</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="#note_message/2"><tt>note_message/2</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="#note_message/3"><tt>note_message/3</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="#simple_message/1"><tt>simple_message/1</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="#simple_message/2"><tt>simple_message/2</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="#optional_message/2"><tt>optional_message/2</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="#optional_message/3"><tt>optional_message/3</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="#debug_message/1"><tt>debug_message/1</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="#debug_message/2"><tt>debug_message/2</tt></a>.
<li><em>Regular Types:</em><br/><a class="lpdoc-idx-anchor" id="18" href="#message_t/1"><tt>message_t/1</tt></a>.
<li><em>Multifiles:</em><br/><a class="lpdoc-idx-anchor" id="19" href="#issue_debug_messages/1"><tt>issue_debug_messages/1</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="show_message/2" href="ciaosearch.html#show_message/2">show_message/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>show_message(Type,Text)</tt>
</span><p>The text provided in <span class="lpdoc-var">Text</span> is printed as a message of type <span class="lpdoc-var">Type</span>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="20" href="#message_t/1"><tt>messages:message_t/1</tt></a>)</span><span>The types of messages supported by the message predicate.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="21" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is a string (a list of character codes).
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="show_message/3" href="ciaosearch.html#show_message/3">show_message/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>show_message(Type,Text,ArgList)</tt>
</span><p>The text provided in <span class="lpdoc-var">Text</span> is printed as a message of type <span class="lpdoc-var">Type</span>, using the arguments in <span class="lpdoc-var">ArgList</span> to interpret any variable-related formatting commands embedded in <span class="lpdoc-var">Text</span>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="22" href="#message_t/1"><tt>messages:message_t/1</tt></a>)</span><span>The types of messages supported by the message predicate.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="23" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="24" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span>
</ul>
<em>Meta-predicate</em> with arguments: <tt>show_message(?,?,addmodule(?))</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="show_message/4" href="ciaosearch.html#show_message/4">show_message/4</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>show_message(Type,Lc,Text,ArgList)</tt>
</span><p>The text provided in <span class="lpdoc-var">Text</span> is printed as a message of type <span class="lpdoc-var">Type</span>, using the arguments in <span class="lpdoc-var">ArgList</span> to interpret any variable-related formatting commands embedded in <span class="lpdoc-var">Text</span>, and reporting error location <span class="lpdoc-var">Lc</span> (file and line numbers).</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="25" href="#message_t/1"><tt>messages:message_t/1</tt></a>)</span><span>The types of messages supported by the message predicate.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="26" href="ciaosearch.html#location_t/1"><tt>c_itf:location_t/1</tt></a>)</span><span>Identifies a source line range in a file. <pre class="lpdoc-codeblock">location_t(loc(File,L1,L2)) :-
atm(File),
int(L1),
int(L2).
</pre>
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="27" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="28" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span>
</ul>
<em>Meta-predicate</em> with arguments: <tt>show_message(?,?,?,addmodule(?))</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="message_t/1" href="ciaosearch.html#message_t/1">message_t/1</a></div><div class="lpdoc-deftext">This type defines the types of messages supported by the message priting predicates. <pre class="lpdoc-codeblock">message_t(error).
message_t(warning).
message_t(note).
message_t(simple).
message_t(debug).
</pre><p><span class="lpdoc-usage-header">Usage:</span><p>The types of messages supported by the message predicate.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="error_message/1" href="ciaosearch.html#error_message/1">error_message/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>error_message(Text)</tt>
</span><p>Same as <tt>message(error,Text)</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="29" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is a string (a list of character codes).
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="error_message/2" href="ciaosearch.html#error_message/2">error_message/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>error_message(Text,ArgList)</tt>
</span><p>Same as <tt>message(error,Text,ArgList)</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="30" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="31" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span>
</ul>
<em>Meta-predicate</em> with arguments: <tt>error_message(?,addmodule(?))</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="error_message/3" href="ciaosearch.html#error_message/3">error_message/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>error_message(Lc,Text,ArgList)</tt>
</span><p>Same as <tt>message(error,Lc,Text,ArgList)</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="32" href="ciaosearch.html#location_t/1"><tt>c_itf:location_t/1</tt></a>)</span><span>Identifies a source line range in a file. <pre class="lpdoc-codeblock">location_t(loc(File,L1,L2)) :-
atm(File),
int(L1),
int(L2).
</pre>
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="33" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="34" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span>
</ul>
<em>Meta-predicate</em> with arguments: <tt>error_message(?,?,addmodule(?))</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="warning_message/1" href="ciaosearch.html#warning_message/1">warning_message/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>warning_message(Text)</tt>
</span><p>Same as <tt>message(warning,Text)</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="35" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is a string (a list of character codes).
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="warning_message/2" href="ciaosearch.html#warning_message/2">warning_message/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>warning_message(Text,ArgList)</tt>
</span><p>Same as <tt>message(warning,Text,ArgList)</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="36" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="37" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span>
</ul>
<em>Meta-predicate</em> with arguments: <tt>warning_message(?,addmodule(?))</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="warning_message/3" href="ciaosearch.html#warning_message/3">warning_message/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>warning_message(Lc,Text,ArgList)</tt>
</span><p>Same as <tt>message(warning,Lc,Text,ArgList)</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="38" href="ciaosearch.html#location_t/1"><tt>c_itf:location_t/1</tt></a>)</span><span>Identifies a source line range in a file. <pre class="lpdoc-codeblock">location_t(loc(File,L1,L2)) :-
atm(File),
int(L1),
int(L2).
</pre>
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="39" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="40" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span>
</ul>
<em>Meta-predicate</em> with arguments: <tt>warning_message(?,?,addmodule(?))</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="note_message/1" href="ciaosearch.html#note_message/1">note_message/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>note_message(Text)</tt>
</span><p>Same as <tt>message(note,Text)</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="41" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is a string (a list of character codes).
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="note_message/2" href="ciaosearch.html#note_message/2">note_message/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>note_message(Text,ArgList)</tt>
</span><p>Same as <tt>message(note,Text,ArgList)</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="42" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="43" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span>
</ul>
<em>Meta-predicate</em> with arguments: <tt>note_message(?,addmodule(?))</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="note_message/3" href="ciaosearch.html#note_message/3">note_message/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>note_message(Lc,Text,ArgList)</tt>
</span><p>Same as <tt>message(note,Lc,Text,ArgList)</tt>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="44" href="ciaosearch.html#location_t/1"><tt>c_itf:location_t/1</tt></a>)</span><span>Identifies a source line range in a file. <pre class="lpdoc-codeblock">location_t(loc(File,L1,L2)) :-
atm(File),
int(L1),
int(L2).
</pre>
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="45" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="46" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span>
</ul>
<em>Meta-predicate</em> with arguments: <tt>note_message(?,?,addmodule(?))</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="simple_message/1" href="ciaosearch.html#simple_message/1">simple_message/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>simple_message(Text)</tt>
</span><p>The text provided in <span class="lpdoc-var">Text</span> is printed.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="47" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is a string (a list of character codes).
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="simple_message/2" href="ciaosearch.html#simple_message/2">simple_message/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>simple_message(Text,ArgList)</tt>
</span><p>The text provided in <span class="lpdoc-var">Text</span> is printed as a message, using the arguments in <span class="lpdoc-var">ArgList</span>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="48" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="49" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="optional_message/2" href="ciaosearch.html#optional_message/2">optional_message/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>optional_message(Text,Opts)</tt>
</span><p>The text provided in <span class="lpdoc-var">Text</span> is printed as a message, but only if the atom <tt>-v</tt> is a member of <span class="lpdoc-var">Opts</span>. These predicates are meant to be used for optional messages, which are only to be printed when <em>verbose</em> output is requested explicitly.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="50" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is a string (a list of character codes).
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="51" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)</span><span><span class="lpdoc-var">Opts</span> is a list of <span class="lpdoc-var">atm</span>s.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="optional_message/3" href="ciaosearch.html#optional_message/3">optional_message/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>optional_message(Text,ArgList,Opts)</tt>
</span><p>The text provided in <span class="lpdoc-var">Text</span> is printed as a message, using the arguments in <span class="lpdoc-var">ArgList</span>, but only if the atom <tt>-v</tt> is a member of <span class="lpdoc-var">Opts</span>. These predicates are meant to be used for optional messages, which are only to be printed when <em>verbose</em> output is requested explicitly.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="52" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="53" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="54" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)</span><span><span class="lpdoc-var">Opts</span> is a list of <span class="lpdoc-var">atm</span>s.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="debug_message/1" href="ciaosearch.html#debug_message/1">debug_message/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>debug_message(Text)</tt>
</span><p>The text provided in <span class="lpdoc-var">Text</span> is printed as a debugging message. These messages are turned <tt>on</tt> by defining a fact of <a class="lpdoc-idx-anchor" id="55" href="#issue_debug_messages/1"><tt>issue_debug_messages/1</tt></a> with the module name as argument.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="56" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="debug_message/2" href="ciaosearch.html#debug_message/2">debug_message/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>debug_message(Text,ArgList)</tt>
</span><p>The text provided in <span class="lpdoc-var">Text</span> is printed as a debugging message, using the arguments in <span class="lpdoc-var">ArgList</span> to interpret any variable-related formatting commands embedded in <span class="lpdoc-var">Text</span>. These messages are turned <tt>on</tt> by defining a fact of <a class="lpdoc-idx-anchor" id="57" href="#issue_debug_messages/1"><tt>issue_debug_messages/1</tt></a> which the module name as argument.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="58" href="format.html#format_control/1"><tt>format:format_control/1</tt></a>)</span><span><span class="lpdoc-var">Text</span> is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with <tt>name/2</tt>.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="59" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)</span><span><span class="lpdoc-var">ArgList</span> is a list.
</span>
</ul>
<em>Meta-predicate</em> with arguments: <tt>debug_message(?,addmodule(?))</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="location_t/1" href="ciaosearch.html#location_t/1">location_t/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="60" href="ciaosearch.html#c_itf"><tt>c_itf</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
</div><div id="Documentation on multifiles"><h2>Documentation on multifiles</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="issue_debug_messages/1" href="ciaosearch.html#issue_debug_messages/1">issue_debug_messages/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>issue_debug_messages(Module)</tt>
</span><p>Printing of debugging messages is enabled for module <span class="lpdoc-var">Module</span>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="61" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)</span><span><span class="lpdoc-var">Module</span> is an atom.
</span>
</ul>
The predicate is <em>multifile</em>.<br/>
The predicate is of type <em>data</em>.<br/></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="62" href="datafacts_rt.html"><tt>datafacts_rt</tt></a>, <a class="lpdoc-idx-anchor" id="63" href="lists.html"><tt>lists</tt></a>, <a class="lpdoc-idx-anchor" id="64" href="streams.html"><tt>streams</tt></a>, <a class="lpdoc-idx-anchor" id="65" href="write.html"><tt>write</tt></a>, <a class="lpdoc-idx-anchor" id="66" href="format.html"><tt>format</tt></a>, <a class="lpdoc-idx-anchor" id="67" href="pathnames.html"><tt>pathnames</tt></a>, <a class="lpdoc-idx-anchor" id="68" href="ciaosearch.html#c_itf"><tt>c_itf</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="69" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="70" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="71" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="72" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="73" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="74" href="regtypes_doc.html"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="75" href="isomodes_doc.html"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="76" href="datafacts_doc.html"><tt>datafacts</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>