@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

89 lines • 20.3 kB

HTML

<!DOCTYPE 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>Formatted output — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton">☰</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"><a class="lpdoc-navbutton" href="StdLibs.html">↑</a><a class="lpdoc-navbutton" href="operators.html">←</a><a class="lpdoc-navbutton" href="terms_io.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a><a href="ciaofulltoc.html">TOC</a></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> » </li><li><a href="StdLibs.html">PART VII - Standard libraries</a> » </li><li><a href="">Formatted output</a></li></ul><hr></hr>ON THIS PAGE<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>Formatted output</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#format"></a> Author(s): <a class="lpdoc-idx-anchor" id="The Ciao Development Team" href="ciaosearch.html#The Ciao Development Team">The Ciao Development Team</a>. The <tt>format</tt> family of predicates is due to Quintus Prolog. They act as a Prolog interface to the C <tt>stdio</tt> function <tt>printf()</tt>, allowing formatted output.Output is formatted according to an output pattern which can have either a format control sequence or any other character, which will appear verbatim in the output. Control sequences act as place-holders for the actual terms that will be output. Thus <pre class="lpdoc-codeblock"> ?- format("Hello ~q!",world). </pre> will print <tt>Hello world!</tt>.If there is only one item to print it may be supplied alone. If there are more they have to be given as a list. If there are none then an empty list should be supplied. There has to be as many items as control characters.The character <tt>~</tt> introduces a control sequence. To print a <tt>~</tt> verbatim just repeat it: <pre class="lpdoc-codeblock"> ?- format("Hello ~~world!", []). </pre> will result in <tt>Hello ~world!</tt>.A format may be spread over several lines. The control sequence <tt>\c</tt> followed by a LFD will translate to the empty string: <pre class="lpdoc-codeblock"> ?- format("Hello \c world!", []). </pre> will result in <tt>Hello world!</tt>. <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: <tt>:- use_module(library(format)).</tt><li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="0" href="#format/2"><tt>format/2</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#format/3"><tt>format/3</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#sformat/3"><tt>sformat/3</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#format_to_string/3"><tt>format_to_string/3</tt></a>. <li>Regular Types: <a class="lpdoc-idx-anchor" id="4" href="#format_control/1"><tt>format_control/1</tt></a>. </ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="format/2" href="ciaosearch.html#format/2">format/2</a></div><div class="lpdoc-deftext">Usage:<tt>format(Format,Arguments)</tt> Print Arguments onto current output stream according to format Format.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="5" href="#format_control/1"><tt>format:format_control/1</tt></a>)Format 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>. </ul> Other properties: <tt>format(C,A)</tt> <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="6" href="basic_props.html#native/2"><tt>basic_props:native/2</tt></a>)This predicate is understood natively by CiaoPP as format(C,A). </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="format/3" href="ciaosearch.html#format/3">format/3</a></div><div class="lpdoc-deftext">Usage:<tt>format(Stream,Format,Arguments)</tt> Print Arguments onto Stream according to format Format.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="7" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. (<a class="lpdoc-idx-anchor" id="8" href="#format_control/1"><tt>format:format_control/1</tt></a>)Format 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>. </ul> Other properties: <tt>format(S,C,A)</tt> <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="9" href="basic_props.html#native/2"><tt>basic_props:native/2</tt></a>)This predicate is understood natively by CiaoPP as format(S,C,A). </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="sformat/3" href="ciaosearch.html#sformat/3">sformat/3</a></div><div class="lpdoc-deftext">Usage:<tt>sformat(String,Format,Arguments)</tt> Same as <a class="lpdoc-idx-anchor" id="10" href="ciaosearch.html#format_to_string(Format, Arguments, String)"><tt>format_to_string(Format, Arguments, String)</tt></a> (note the different argument order).<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="11" href="#format_control/1"><tt>format:format_control/1</tt></a>)Format 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>. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="12" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="format_to_string/3" href="ciaosearch.html#format_to_string/3">format_to_string/3</a></div><div class="lpdoc-deftext">Usage:<tt>format_to_string(Format,Arguments,String)</tt> Print Arguments onto current string String according to format Format. This predicate is similar to the format/2, but the result is stored in a string.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="13" href="#format_control/1"><tt>format:format_control/1</tt></a>)Format 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>. (<a class="lpdoc-idx-anchor" id="14" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)Arguments is a list. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="15" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)String is a string (a list of character codes). </ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="format_control/1" href="ciaosearch.html#format_control/1">format_control/1</a></div><div class="lpdoc-deftext"> The general format of a control sequence is <tt>~NC</tt>. The character C determines the type of the control sequence. N is an optional numeric argument. An alternative form of N is <tt>*</tt>. <tt>*</tt> implies that the next argument in Arguments should be used as a numeric argument in the control sequence. Example:<pre class="lpdoc-codeblock">?- format("Hello~4cworld!", [0'x]). </pre> and<pre class="lpdoc-codeblock">?- format("Hello~*cworld!", [4,0'x]). </pre> both produce<pre class="lpdoc-codeblock">Helloxxxxworld! </pre> The following control sequences are available.<ul> <li>~a The argument is an atom. The atom is printed without quoting.<li>~Nc (Print character.) The argument is a number that will be interpreted as an ASCII code. N defaults to one and is interpreted as the number of times to print the character.<li>~Ne <li>~NE <li>~Nf <li>~Ng <li>~NG (Print float). The argument is a float. The float and N will be passed to the C <tt>printf()</tt> function as<pre class="lpdoc-codeblock">printf("%.Ne", Arg) printf("%.NE", Arg) printf("%.Nf", Arg) printf("%.Ng", Arg) printf("%.NG", Arg) </pre> If N is not supplied the action defaults to<pre class="lpdoc-codeblock">printf("%e", Arg) printf("%E", Arg) printf("%f", Arg) printf("%g", Arg) printf("%G", Arg) </pre> <li>~Nd (Print decimal.) The argument is an integer. N is interpreted as the number of digits after the decimal point. If N is 0 or missing, no decimal point will be printed. Example:<pre class="lpdoc-codeblock">?- format("Hello ~1d world!", [42]). ?- format("Hello ~d world!", [42]). </pre> will print as<pre class="lpdoc-codeblock">Hello 4.2 world! Hello 42 world! </pre> respectively.<li>~ND (Print decimal.) The argument is an integer. Identical to <tt>~Nd</tt> except that <tt>,</tt> will separate groups of three digits to the left of the decimal point. Example:<pre class="lpdoc-codeblock">?- format("Hello ~1D world!", [12345]). </pre> will print as<pre class="lpdoc-codeblock">Hello 1,234.5 world! </pre> <li>~Nr (Print radix.) The argument is an integer. N is interpreted as a radix. N should be >= 2 and <= 36. If N is missing the radix defaults to 8. The letters <tt>a-z</tt> will denote digits larger than 9. Example:<pre class="lpdoc-codeblock">?- format("Hello ~2r world!", [15]). ?- format("Hello ~16r world!", [15]). </pre> will print as<pre class="lpdoc-codeblock">Hello 1111 world! Hello f world! </pre> respectively.<li>~NR (Print radix.) The argument is an integer. Identical to <tt>~Nr</tt> except that the letters <tt>A-Z</tt> will denote digits larger than 9. Example:<pre class="lpdoc-codeblock">?- format("Hello ~16R world!", [15]). </pre> will print as<pre class="lpdoc-codeblock">Hello F world! </pre> <li>~Ns (Print string.) The argument is a list of ASCII codes. Exactly N characters will be printed. N defaults to the length of the string. Example:<pre class="lpdoc-codeblock">?- format("Hello ~4s ~4s!", ["new","world"]). ?- format("Hello ~s world!", ["new"]). </pre> will print as<pre class="lpdoc-codeblock">Hello new worl! Hello new world! </pre> respectively.<li>~i (Ignore argument.) The argument may be of any type. The argument will be ignored. Example:<pre class="lpdoc-codeblock">?- format("Hello ~i~s world!", ["old","new"]). </pre> will print as<pre class="lpdoc-codeblock">Hello new world! </pre> <li>~k (Print canonical.) The argument may be of any type. The argument will be passed to <tt>write_canonical/2</tt> (<a href="write.html">Term output</a>). Example:<pre class="lpdoc-codeblock">?- format("Hello ~k world!", [[a,b,c]]). </pre> will print as<pre class="lpdoc-codeblock">Hello .(a,.(b,.(c,[]))) world! </pre> <li>~p (print.) The argument may be of any type. The argument will be passed to <tt>print/2</tt> (<a href="write.html">Term output</a>). Example:suposing the user has defined the predicate<pre class="lpdoc-codeblock">:- multifile portray/1. portray([X|Y]) :- print(cons(X,Y)). </pre> then<pre class="lpdoc-codeblock">?- format("Hello ~p world!", [[a,b,c]]). </pre> will print as<pre class="lpdoc-codeblock">Hello cons(a,cons(b,cons(c,[]))) world! </pre> <li>~q (Print quoted.) The argument may be of any type. The argument will be passed to <tt>writeq/2</tt> (<a href="write.html">Term output</a>). Example:<pre class="lpdoc-codeblock">?- format("Hello ~q world!", [['A','B']]). </pre> will print as<pre class="lpdoc-codeblock">Hello ['A','B'] world! </pre> <li>~w (write.) The argument may be of any type. The argument will be passed to <tt>write/2</tt> (<a href="write.html">Term output</a>). Example:<pre class="lpdoc-codeblock">?- format("Hello ~w world!", [['A','B']]). </pre> will print as<pre class="lpdoc-codeblock">Hello [A,B] world! </pre> <li>~Nn (Print newline.) Print N newlines. N defaults to 1. Example:<pre class="lpdoc-codeblock">?- format("Hello ~n world!", []). </pre> will print as<pre class="lpdoc-codeblock">Hello world! </pre> <li>~N (Fresh line.) Print a newline, if not already at the beginning of a line.<li>~~ (Print tilde.) Prints <tt>~</tt> </ul> The following control sequences are also available for compatibility, but do not perform any useful functions.<ul> <li>~N| (Set tab.) Set a tab stop at position N, where N defaults to the current position, and advance the current position there.<li>~N+ (Advance tab.) Set a tab stop at N positions past the current position, where N defaults to 8, and advance the current position there.<li>~Nt (Set fill character.) Set the fill character to be used in the next position movement to N, where N defaults to SPC. </ul> Usage:<tt>format_control(C)</tt> C 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>.<ul class="lpdoc-itemize-minus"><li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="16" href="ciaosearch.html#doc_incomplete/1"><tt>doc_props:doc_incomplete/1</tt></a>)Documentation is still incomplete: format_control(C) may not conform the functionality documented. </ul></div></div> </div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li>System library modules: <a class="lpdoc-idx-anchor" id="17" href="datafacts_rt.html"><tt>datafacts_rt</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="streams.html"><tt>streams</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="write.html"><tt>write</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="system.html"><tt>system</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="ciaosearch.html#doc_props"><tt>doc_props</tt></a>. <li>Packages: <a class="lpdoc-idx-anchor" id="22" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="25" href="dcg_doc.html"><tt>dcg</tt></a>, <a class="lpdoc-idx-anchor" id="26" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="28" href="isomodes_doc.html"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="29" 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>