@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
29 lines • 10.3 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>tasks_db (library) — 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="ciaopp_batch.html">↑</a><a class="lpdoc-navbutton" href="db_analysis.html">←</a><a class="lpdoc-navbutton" href="ciaopp_ref_manrefs.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="ciaopp_batch.html">Batch analysis client</a> »<br/> </li><li><a href=""><strong>tasks_db (library)</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>tasks_db (library)</h1><a class="lpdoc-idx-anchor" href="ciaopp_ref_mansearch.html#tasks_db"></a>
This handles the data base of modules to be analyzed. Currently it is implemented with persistent predicates<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_batch(tasks_db)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#add_task/1"><tt>add_task/1</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#add_tasks/1"><tt>add_tasks/1</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#pop_task/4"><tt>pop_task/4</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#analysis_task/4"><tt>analysis_task/4</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="db_analysis.html#clean_db/0"><tt>clean_db/0</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#init_tasks_db/0"><tt>init_tasks_db/0</tt></a>.
<li><em>Multifiles:</em><br/><a class="lpdoc-idx-anchor" id="6" href="preprocess_flags.html#$is_persistent/2"><tt>$is_persistent/2</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="preprocess_flags.html#persistent_dir/2"><tt>persistent_dir/2</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="preprocess_flags.html#persistent_dir/4"><tt>persistent_dir/4</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="add_task/1" href="ciaopp_ref_mansearch.html#add_task/1">add_task/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>add_task(Mod)</tt>
</span><p>Add a task to analyze with abtract domain <span class="lpdoc-var">AbsInt</span> and CiaoPP configuration <span class="lpdoc-var">Flags</span></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="add_tasks/1" href="ciaopp_ref_mansearch.html#add_tasks/1">add_tasks/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>add_tasks(Tasks)</tt>
</span><p>The same as <a class="lpdoc-idx-anchor" id="9" href="ciaopp_ref_mansearch.html#add_task/3"><tt>add_task/3</tt></a> but for a list of tasks (for efficiency)</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="10" href="basic_props.html#list/1"><tt>list/1</tt></a>)</span><span><span class="lpdoc-var">Tasks</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="pop_task/4" href="ciaopp_ref_mansearch.html#pop_task/4">pop_task/4</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>pop_task(File,Mod,AbsInt,Flags)</tt>
</span><p>Remove a task to analyze</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="analysis_task/4" href="ciaopp_ref_mansearch.html#analysis_task/4">analysis_task/4</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>analysis_task(File,Mod,AbsInt,Flags)</tt>
</span><p>Checks a task to analyze, this predicate does not modify the DB</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="clean_db/0" href="ciaopp_ref_mansearch.html#clean_db/0">clean_db/0</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage 1:</span><p>Empties the database.</p><ul class="lpdoc-itemize-minus"></ul><p><span class="lpdoc-usage-header">Usage 2:</span><p>Initializes the database.</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="init_tasks_db/0" href="ciaopp_ref_mansearch.html#init_tasks_db/0">init_tasks_db/0</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</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="$is_persistent/2" href="ciaopp_ref_mansearch.html#$is_persistent/2">$is_persistent/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.
The predicate is <em>multifile</em>.<br/>
The predicate is of type <em>data</em>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="persistent_dir/2" href="ciaopp_ref_mansearch.html#persistent_dir/2">persistent_dir/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.
The predicate is <em>multifile</em>.<br/>
The predicate is of type <em>data</em>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="persistent_dir/4" href="ciaopp_ref_mansearch.html#persistent_dir/4">persistent_dir/4</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.
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>Application modules:</em><br/><a class="lpdoc-idx-anchor" id="11" href="db_analysis.html"><tt>db_analysis</tt></a>.
<li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="12" href="ciaopp_ref_mansearch.html#datafacts_rt"><tt>datafacts_rt</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="ciaopp_ref_mansearch.html#persdb_rt"><tt>persdb_rt</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="ciaopp_ref_mansearch.html#format"><tt>format</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="ciaopp_ref_mansearch.html#bundle_paths"><tt>bundle_paths</tt></a>.
<li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="16" href="ciaopp_ref_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="ciaopp_ref_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="ciaopp_ref_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="ciaopp_ref_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="ciaopp_ref_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="ciaopp_ref_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="ciaopp_ref_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="ciaopp_ref_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="basic_props.html"><tt>basic_props</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="25" href="ciaopp_ref_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="26" href="ciaopp_ref_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="ciaopp_ref_mansearch.html#condcomp"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="28" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="29" href="ciaopp_ref_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="30" href="ciaopp_ref_mansearch.html#persdb"><tt>persdb</tt></a>, <a class="lpdoc-idx-anchor" id="31" href="ciaopp_ref_mansearch.html#datafacts"><tt>datafacts</tt></a>, <a class="lpdoc-idx-anchor" id="32" href="ciaopp_ref_mansearch.html#persdb/persdb_decl"><tt>persdb/persdb_decl</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>