@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

105 lines • 21.9 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>ISO Chars — 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="CompatProlog.html">↑</a><a class="lpdoc-navbutton" href="iso_strict_doc.html">←</a><a class="lpdoc-navbutton" href="iso_misc.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="CompatProlog.html">PART V - Compatibility</a> » </li><li><a href="">ISO Chars</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>ISO Chars</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#iso_char"></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>, <a class="lpdoc-idx-anchor" id="Daniel Cabeza" href="ciaosearch.html#Daniel Cabeza">Daniel Cabeza</a>, <a class="lpdoc-idx-anchor" id="Edison Mera" href="ciaosearch.html#Edison Mera">Edison Mera (documentation)</a>, <a class="lpdoc-idx-anchor" id="Manuel Hermenegildo" href="ciaosearch.html#Manuel Hermenegildo">Manuel Hermenegildo (minor mods)</a>. This module provides some basic predicates according to the ISO specification of char manipulation. <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: <tt>:- use_module(library(iso_char)).</tt><li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="0" href="#char_code/2"><tt>char_code/2</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#atom_chars/2"><tt>atom_chars/2</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#number_chars/2"><tt>number_chars/2</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#char_codes/2"><tt>char_codes/2</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#get_char/1"><tt>get_char/1</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#get_char/2"><tt>get_char/2</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#peek_char/1"><tt>peek_char/1</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#peek_char/2"><tt>peek_char/2</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#put_char/1"><tt>put_char/1</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#put_char/2"><tt>put_char/2</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="char_code/2" href="ciaosearch.html#char_code/2">char_code/2</a></div><div class="lpdoc-deftext"><tt>char_code(Char,Code)</tt> Succeeds iff the character code of the one char atom Char is Code.Usage 1:ISO <ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="10" href="basic_props.html#character_code/1"><tt>basic_props:character_code/1</tt></a>)Code is an integer which is a character code. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="11" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Char is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="12" href="basic_props.html#character_code/1"><tt>basic_props:character_code/1</tt></a>)Code is an integer which is a character code. </ul>Usage 2:ISO <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="13" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Char is a free variable. (<a class="lpdoc-idx-anchor" id="14" href="basic_props.html#character_code/1"><tt>basic_props:character_code/1</tt></a>)Code is an integer which is a character code. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="15" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Char is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="atom_chars/2" href="ciaosearch.html#atom_chars/2">atom_chars/2</a></div><div class="lpdoc-deftext"><tt>atom_chars(Atom,Chars)</tt> Succeeds iff Chars is a list whose elements are the one-char atoms whose names are the successive characters of the name of atom AtomUsage 1:ISO <ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="16" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Chars is a list of atms. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="17" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="18" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Chars is a list of atms. </ul>Usage 2:ISO <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="19" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Atom is a free variable. (<a class="lpdoc-idx-anchor" id="20" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Chars is a list of atms. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="21" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="number_chars/2" href="ciaosearch.html#number_chars/2">number_chars/2</a></div><div class="lpdoc-deftext"><tt>number_chars(Number,Chars)</tt> Success iff Chars is a list whose elements are the one-char atoms corresponding to a character sequence of Number which could be outputUsage 1:ISO <ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="22" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Chars is a list of atms. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="23" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="24" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Chars is a list of atms. </ul>Usage 2:ISO <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="25" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Number is a free variable. (<a class="lpdoc-idx-anchor" id="26" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Chars is a list of atms. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="27" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)Number is a number. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="char_codes/2" href="ciaosearch.html#char_codes/2">char_codes/2</a></div><div class="lpdoc-deftext">Usage 1:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="28" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Arg2 is a list of character_codes. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="29" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Arg1 is a list of atms. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="30" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Arg2 is a list of character_codes. </ul>Usage 2:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="31" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Arg1 is a free variable. (<a class="lpdoc-idx-anchor" id="32" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Arg2 is a list of character_codes. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="33" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Arg1 is a list of atms. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="get_char/1" href="ciaosearch.html#get_char/1">get_char/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="get_char/2" href="ciaosearch.html#get_char/2">get_char/2</a></div><div class="lpdoc-deftext"><tt>get_char(Stream,Char)</tt> Is true iif Char unifies with the next character to be input from the target Stream.Usage:ISO <ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="34" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Char is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="35" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="36" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. (<a class="lpdoc-idx-anchor" id="37" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Char is an atom. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="38" href="basic_props.html#not_further_inst/2"><tt>basic_props:not_further_inst/2</tt></a>)Stream is not further instantiated. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="peek_char/1" href="ciaosearch.html#peek_char/1">peek_char/1</a></div><div class="lpdoc-deftext">Usage:ISO Similar to <a class="lpdoc-idx-anchor" id="39" href="io_basic.html#peek_code/1"><tt>peek_code/1</tt></a>, but using char instead of code.<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="40" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Arg1 is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="41" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Arg1 is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="peek_char/2" href="ciaosearch.html#peek_char/2">peek_char/2</a></div><div class="lpdoc-deftext">Usage:ISO Similar to <a class="lpdoc-idx-anchor" id="42" href="iso_incomplete.html#peek_code/2"><tt>peek_code/2</tt></a>, but using char instead of code.<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="43" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Arg2 is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="44" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Arg1 is an open stream. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="45" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Arg1 is an open stream. (<a class="lpdoc-idx-anchor" id="46" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Arg2 is an atom. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="47" href="basic_props.html#not_further_inst/2"><tt>basic_props:not_further_inst/2</tt></a>)Arg1 is not further instantiated. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="put_char/1" href="ciaosearch.html#put_char/1">put_char/1</a></div><div class="lpdoc-deftext">Usage:ISO Similar to <a class="lpdoc-idx-anchor" id="48" href="io_basic.html#put_code/1"><tt>put_code/1</tt></a>, but using char instead of code.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="49" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Arg1 is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="put_char/2" href="ciaosearch.html#put_char/2">put_char/2</a></div><div class="lpdoc-deftext">Usage:ISO Similar to <a class="lpdoc-idx-anchor" id="50" href="iso_incomplete.html#put_code/2"><tt>put_code/2</tt></a>, but using char instead of code.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="51" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Arg1 is an open stream. (<a class="lpdoc-idx-anchor" id="52" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Arg2 is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="53" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Arg1 is an open stream. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="54" href="basic_props.html#not_further_inst/2"><tt>basic_props:not_further_inst/2</tt></a>)Arg1 is not further instantiated. </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>Packages: <a class="lpdoc-idx-anchor" id="55" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="56" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="57" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="58" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="59" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="60" href="isomodes_doc.html"><tt>isomodes</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>