<HTML> <HEAD> <!-- Created by texi2html 1.56k + clip patches and <A href="http://www.clip.dia.fi.upm.es/Software">lpdoc</A> from ciao.texi on 28 January 2007 --> <LINK rel="stylesheet" href="ciao.css" type="text/css"> <TITLE>The Ciao Prolog System - generator_util (library)</TITLE> </HEAD> <BODY> Go to the <A HREF="ciao_1.html">first</A>, <A HREF="ciao_216.html">previous</A>, <A HREF="ciao_218.html">next</A>, <A HREF="ciao_241.html">last</A> section, <A HREF="ciao_toc.html">table of contents</A>. <P><HR><P> <H1><A NAME="SEC850" HREF="ciao_toc.html#TOC850">generator_util (library)</A></H1> <P> <A NAME="IDX9178"></A> <P> <STRONG>Author(s):</STRONG> Göran Smedbäck. <UL> <LI><A HREF="ciao_217.html#SEC851">Usage and interface (generator_util)</A> <LI><A HREF="ciao_217.html#SEC852">Documentation on exports (generator_util)</A> </UL> <H2><A NAME="SEC851" HREF="ciao_toc.html#TOC851">Usage and interface (<CODE>generator_util</CODE>)</A></H2> <div class="cartouche"> <UL> <LI><STRONG>Library usage:</STRONG> <CODE>:- use_module(library(generator_util)).</CODE> <LI><STRONG>Exports:</STRONG> <UL> <LI><EM>Predicates:</EM> <A NAME="IDX9179"></A> <CODE>reading/4</CODE>, <A NAME="IDX9180"></A> <CODE>reading/5</CODE>, <A NAME="IDX9181"></A> <CODE>reading/6</CODE>, <A NAME="IDX9182"></A> <CODE>open_node/6</CODE>, <A NAME="IDX9183"></A> <CODE>close_node/5</CODE>, <A NAME="IDX9184"></A> <CODE>close_nodeGut/4</CODE>, <A NAME="IDX9185"></A> <CODE>open_PROTO/4</CODE>, <A NAME="IDX9186"></A> <CODE>close_PROTO/6</CODE>, <A NAME="IDX9187"></A> <CODE>open_EXTERNPROTO/5</CODE>, <A NAME="IDX9188"></A> <CODE>close_EXTERNPROTO/6</CODE>, <A NAME="IDX9189"></A> <CODE>open_DEF/5</CODE>, <A NAME="IDX9190"></A> <CODE>close_DEF/5</CODE>, <A NAME="IDX9191"></A> <CODE>open_Script/5</CODE>, <A NAME="IDX9192"></A> <CODE>close_Script/5</CODE>, <A NAME="IDX9193"></A> <CODE>decompose_field/3</CODE>, <A NAME="IDX9194"></A> <CODE>indentation_list/2</CODE>, <A NAME="IDX9195"></A> <CODE>start_vrmlScene/4</CODE>, <A NAME="IDX9196"></A> <CODE>remove_comments/4</CODE>. </UL> <LI><STRONG>Other modules used:</STRONG> <UL> <LI><EM>System library modules:</EM> <A NAME="IDX9197"></A> <CODE>provrml/error</CODE>, <A NAME="IDX9198"></A> <CODE>lists</CODE>, <A NAME="IDX9199"></A> <CODE>provrml/io</CODE>, <A NAME="IDX9200"></A> <CODE>provrml/field_value</CODE>, <A NAME="IDX9201"></A> <CODE>provrml/field_value_check</CODE>, <A NAME="IDX9202"></A> <CODE>provrml/lookup</CODE>, <A NAME="IDX9203"></A> <CODE>provrml/parser_util</CODE>. </UL> </UL> </div class="cartouche"> <H2><A NAME="SEC852" HREF="ciao_toc.html#TOC852">Documentation on exports (<CODE>generator_util</CODE>)</A></H2> <P> <A NAME="IDX9204"></A> <A NAME="IDX9205"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>reading/4:</B> <DD><A NAME="IDX9206"></A> <P> <STRONG>Usage 1:</STRONG> <CODE>reading(+IS, +NodeTypeId, +ParseIn, -ParseOut)</CODE> <UL> <LI><EM>Description:</EM> This predicate will refer to a formerly introduced interface. We do a checkup of the access type and output the values. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>+IS</CODE> is an atom. (<CODE>basic_props:atm/1</CODE>) <CODE>+NodeTypeId</CODE> is an atom. (<CODE>basic_props:atm/1</CODE>) <CODE>+ParseIn</CODE> is a parse structure. (<CODE>internal_types:parse/1</CODE>) <CODE>-ParseOut</CODE> is a parse structure. (<CODE>internal_types:parse/1</CODE>) </UL> <P> <STRONG>Usage 2:</STRONG> <CODE>reading(+NodeGut, +NodeName, +ParseIn, -ParseOut)</CODE> <UL> <LI><EM>Description:</EM> This predicate will read a node gut and will check the field according to the name. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>+NodeGut</CODE> is an atom. (<CODE>basic_props:atm/1</CODE>) <CODE>+NodeName</CODE> is an atom. (<CODE>basic_props:atm/1</CODE>) <CODE>+ParseIn</CODE> is a parse structure. (<CODE>internal_types:parse/1</CODE>) <CODE>-ParseOut</CODE> is a parse structure. (<CODE>internal_types:parse/1</CODE>) </UL> </DL> <P> <A NAME="IDX9207"></A> <A NAME="IDX9208"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>reading/5:</B> <DD><A NAME="IDX9209"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9210"></A> <A NAME="IDX9211"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>reading/6:</B> <DD><A NAME="IDX9212"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9213"></A> <A NAME="IDX9214"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>open_node/6:</B> <DD><A NAME="IDX9215"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9216"></A> <A NAME="IDX9217"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>close_node/5:</B> <DD><A NAME="IDX9218"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9219"></A> <A NAME="IDX9220"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>close_nodeGut/4:</B> <DD><A NAME="IDX9221"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9222"></A> <A NAME="IDX9223"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>open_PROTO/4:</B> <DD><A NAME="IDX9224"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9225"></A> <A NAME="IDX9226"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>close_PROTO/6:</B> <DD><A NAME="IDX9227"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9228"></A> <A NAME="IDX9229"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>open_EXTERNPROTO/5:</B> <DD><A NAME="IDX9230"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9231"></A> <A NAME="IDX9232"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>close_EXTERNPROTO/6:</B> <DD><A NAME="IDX9233"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9234"></A> <A NAME="IDX9235"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>open_DEF/5:</B> <DD><A NAME="IDX9236"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9237"></A> <A NAME="IDX9238"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>close_DEF/5:</B> <DD><A NAME="IDX9239"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9240"></A> <A NAME="IDX9241"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>open_Script/5:</B> <DD><A NAME="IDX9242"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9243"></A> <A NAME="IDX9244"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>close_Script/5:</B> <DD><A NAME="IDX9245"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9246"></A> <A NAME="IDX9247"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>decompose_field/3:</B> <DD><A NAME="IDX9248"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9249"></A> <A NAME="IDX9250"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>indentation_list/2:</B> <DD><A NAME="IDX9251"></A> <P> <STRONG>Usage:</STRONG> <CODE>indentation_list(+Parse, -IndList)</CODE> <UL> <LI><EM>Description:</EM> This predcate will construct a list with indentations to be output before text. The information of the indentations is inside the parse structure. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>+Parse</CODE> is a parse structure. (<CODE>internal_types:parse/1</CODE>) <CODE>-IndList</CODE> is a list of <CODE>atm</CODE>s. (<CODE>basic_props:list/2</CODE>) </UL> </DL> <P> <A NAME="IDX9252"></A> <A NAME="IDX9253"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>start_vrmlScene/4:</B> <DD><A NAME="IDX9254"></A> <P> No further documentation available for this predicate. </DL> <P> <A NAME="IDX9255"></A> <A NAME="IDX9256"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>remove_comments/4:</B> <DD><A NAME="IDX9257"></A> <P> <STRONG>Usage:</STRONG> <CODE>remove_comments(+Value, -CommentsBefore, -ValueClean, -CommentsAfter)</CODE> <UL> <LI><EM>Description:</EM> The predicate will remove comments and return the comments before and after the pure value. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>+Value</CODE> is a list of <CODE>atm</CODE>s. (<CODE>basic_props:list/2</CODE>) <CODE>-CommentsBefore</CODE> is a list of <CODE>atm</CODE>s. (<CODE>basic_props:list/2</CODE>) <CODE>-ValueClean</CODE> is an atom. (<CODE>basic_props:atm/1</CODE>) <CODE>-CommentsAfter</CODE> is a list of <CODE>atm</CODE>s. (<CODE>basic_props:list/2</CODE>) </UL> </DL> <P><HR><P> Go to the <A HREF="ciao_1.html">first</A>, <A HREF="ciao_216.html">previous</A>, <A HREF="ciao_218.html">next</A>, <A HREF="ciao_241.html">last</A> section, <A HREF="ciao_toc.html">table of contents</A>. </BODY> </HTML>