@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
24 lines (23 loc) • 13.6 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>Program Analysis (PLAI) — The CiaoPP Program Processor v1.5</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="Plai1.html">↑</a><a class="lpdoc-navbutton" href="Plai0.html">←</a><a class="lpdoc-navbutton" href="fixpo_plai.html">→</a><a class="lpdoc-navbutton" href="ciaopp_ref_mansearch.html">🔍</a></span><span><a href="ciaopp_ref_manfulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciaopp_ref_man.html">The CiaoPP Program Processor</a> »<br/> </li><li><a href="part_internals.html">PART IV - CiaoPP Internals</a> »<br/> </li><li><a href="Plai1.html">The Abstract Interpretation Component -PLAI</a> »<br/> </li><li><a href=""><strong>Program Analysis (PLAI)</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>Program Analysis (PLAI)</h1><a class="lpdoc-idx-anchor" href="ciaopp_ref_mansearch.html#plai"></a>
<div class="lpdoc-alert"><strong>Stability: [</strong><strong>devel</strong><strong>] </strong>Currently the subject of active
development and/or research. Functionality may be limited and API
and/or functionality may change without warning or deprecation period. Not recommended yet for use in production.</div><p><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(ciaopp(plai)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#plai/5"><tt>plai/5</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#cleanup_plai/1"><tt>cleanup_plai/1</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#mod_plai/5"><tt>mod_plai/5</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#is_checker/1"><tt>is_checker/1</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#analyze/7"><tt>analyze/7</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#init_fixpoint/1"><tt>init_fixpoint/1</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#entry_point/5"><tt>entry_point/5</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#generate_trans_clauses/4"><tt>generate_trans_clauses/4</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#transform_clauses_/5"><tt>transform_clauses_/5</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#topdown_analysis/3"><tt>topdown_analysis/3</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="#mod_topdown_analysis/3"><tt>mod_topdown_analysis/3</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="plai/5" href="ciaopp_ref_mansearch.html#plai/5">plai/5</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>plai(Cls,Ds,Fixp,AbsInt,Info)</tt>
</span><p>Performs the analysis of the clauses in <span class="lpdoc-var">Cls</span> (dictionaries of variables in <span class="lpdoc-var">Ds</span>) with fixpoint algorithm <span class="lpdoc-var">Fixp</span> and analysis domain <span class="lpdoc-var">AbsInt</span>. The analysis results are left in a permanent database (see <a class="lpdoc-idx-anchor" id="11" href="plai_db.html"><tt>plai_db</tt></a>). <span class="lpdoc-var">Info</span> is a list of properties and informations. One possible value is <tt>[time(Total,[(subtask1,T1),...,(subtaskN,TN)])]</tt>.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="cleanup_plai/1" href="ciaopp_ref_mansearch.html#cleanup_plai/1">cleanup_plai/1</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>cleanup_plai(AbsInt)</tt>
</span><p>Cleanups the database of analysis of all permanent information regarding abstract domain <span class="lpdoc-var">AbsInt</span>.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="mod_plai/5" href="ciaopp_ref_mansearch.html#mod_plai/5">mod_plai/5</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>mod_plai(Cls,Ds,Fixp,AbsInt,Time)</tt>
</span><p>Performs the analysis of the clauses in <span class="lpdoc-var">Cls</span> (dictionaries of variables in <span class="lpdoc-var">Ds</span>) with fixpoint algorithm <span class="lpdoc-var">Fixp</span> and analysis domain <span class="lpdoc-var">AbsInt</span>. The analysis results are left in a permanent database (see <a class="lpdoc-idx-anchor" id="12" href="plai_db.html"><tt>plai_db</tt></a>).<p>The analysis uses the entry information provided by the entry policy selected in entry_policy preprocessing flag.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="is_checker/1" href="ciaopp_ref_mansearch.html#is_checker/1">is_checker/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="analyze/7" href="ciaopp_ref_mansearch.html#analyze/7">analyze/7</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="init_fixpoint/1" href="ciaopp_ref_mansearch.html#init_fixpoint/1">init_fixpoint/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="entry_point/5" href="ciaopp_ref_mansearch.html#entry_point/5">entry_point/5</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="generate_trans_clauses/4" href="ciaopp_ref_mansearch.html#generate_trans_clauses/4">generate_trans_clauses/4</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="transform_clauses_/5" href="ciaopp_ref_mansearch.html#transform_clauses_/5">transform_clauses_/5</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="topdown_analysis/3" href="ciaopp_ref_mansearch.html#topdown_analysis/3">topdown_analysis/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="mod_topdown_analysis/3" href="ciaopp_ref_mansearch.html#mod_topdown_analysis/3">mod_topdown_analysis/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</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>Application modules:</em><br/><a class="lpdoc-idx-anchor" id="13" href="ciaopp_ref_mansearch.html#analysis_stats"><tt>analysis_stats</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="ciaopp_ref_mansearch.html#ciaopp_log"><tt>ciaopp_log</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="ciaopp_ref_mansearch.html#sp_clauses"><tt>sp_clauses</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="ciaopp_ref_mansearch.html#unfold_times"><tt>unfold_times</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="frontend_driver.html"><tt>frontend_driver</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="intermod_entry.html"><tt>intermod_entry</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="preprocess_flags.html"><tt>preprocess_flags</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="ciaopp_ref_mansearch.html#mem_usage"><tt>mem_usage</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="domains.html"><tt>domains</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="ciaopp_ref_mansearch.html#normalize_args"><tt>normalize_args</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="ciaopp_ref_mansearch.html#plai_errors"><tt>plai_errors</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="fixpo_plai.html"><tt>fixpo_plai</tt></a>, <a class="lpdoc-idx-anchor" id="25" href="fixpo_dd.html"><tt>fixpo_dd</tt></a>, <a class="lpdoc-idx-anchor" id="26" href="ciaopp_ref_mansearch.html#fixpo_di"><tt>fixpo_di</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="ciaopp_ref_mansearch.html#fixpo_check_di"><tt>fixpo_check_di</tt></a>, <a class="lpdoc-idx-anchor" id="28" href="ciaopp_ref_mansearch.html#fixpo_check_di2"><tt>fixpo_check_di2</tt></a>, <a class="lpdoc-idx-anchor" id="29" href="ciaopp_ref_mansearch.html#fixpo_check_di3"><tt>fixpo_check_di3</tt></a>, <a class="lpdoc-idx-anchor" id="30" href="ciaopp_ref_mansearch.html#fixpo_check_di4"><tt>fixpo_check_di4</tt></a>, <a class="lpdoc-idx-anchor" id="31" href="ciaopp_ref_mansearch.html#fixpo_check_di5"><tt>fixpo_check_di5</tt></a>, <a class="lpdoc-idx-anchor" id="32" href="ciaopp_ref_mansearch.html#fixpo_plai_gfp"><tt>fixpo_plai_gfp</tt></a>, <a class="lpdoc-idx-anchor" id="33" href="ciaopp_ref_mansearch.html#fixpo_check_reduced_di"><tt>fixpo_check_reduced_di</tt></a>, <a class="lpdoc-idx-anchor" id="34" href="ciaopp_ref_mansearch.html#fixpo_bu"><tt>fixpo_bu</tt></a>, <a class="lpdoc-idx-anchor" id="35" href="ciaopp_ref_mansearch.html#tarjan"><tt>tarjan</tt></a>, <a class="lpdoc-idx-anchor" id="36" href="ciaopp_ref_mansearch.html#transform"><tt>transform</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="ciaopp_ref_mansearch.html#fixpo_ops"><tt>fixpo_ops</tt></a>, <a class="lpdoc-idx-anchor" id="38" href="trace_fixp.html"><tt>trace_fixp</tt></a>.
<li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="39" href="ciaopp_ref_mansearch.html#aggregates"><tt>aggregates</tt></a>, <a class="lpdoc-idx-anchor" id="40" href="ciaopp_ref_mansearch.html#counters"><tt>counters</tt></a>, <a class="lpdoc-idx-anchor" id="41" href="ciaopp_ref_mansearch.html#lists"><tt>lists</tt></a>, <a class="lpdoc-idx-anchor" id="42" href="ciaopp_ref_mansearch.html#terms_vars"><tt>terms_vars</tt></a>, <a class="lpdoc-idx-anchor" id="43" href="ciaopp_ref_mansearch.html#vndict"><tt>vndict</tt></a>, <a class="lpdoc-idx-anchor" id="44" href="ciaopp_ref_mansearch.html#port_reify"><tt>port_reify</tt></a>, <a class="lpdoc-idx-anchor" id="45" href="ciaopp_ref_mansearch.html#messages"><tt>messages</tt></a>, <a class="lpdoc-idx-anchor" id="46" href="p_unit.html"><tt>p_unit</tt></a>, <a class="lpdoc-idx-anchor" id="47" href="program_keys.html"><tt>program_keys</tt></a>, <a class="lpdoc-idx-anchor" id="48" href="ciaopp_ref_mansearch.html#p_unit_db"><tt>p_unit_db</tt></a>.
<li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="49" href="ciaopp_ref_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="50" href="ciaopp_ref_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="51" href="ciaopp_ref_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="52" href="ciaopp_ref_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="53" href="ciaopp_ref_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="54" href="ciaopp_ref_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="55" href="ciaopp_ref_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="56" href="ciaopp_ref_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="57" href="basic_props.html"><tt>basic_props</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="58" href="ciaopp_ref_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="59" href="ciaopp_ref_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="60" href="ciaopp_ref_mansearch.html#condcomp"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="61" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="62" href="ciaopp_ref_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>