@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
61 lines • 19.2 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>Database for ciaopp_batch process — 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="ciaopp_batch_aux.html">←</a><a class="lpdoc-navbutton" href="tasks_db.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>Database for ciaopp_batch process</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>Database for ciaopp_batch process</h1><a class="lpdoc-idx-anchor" href="ciaopp_ref_mansearch.html#db_analysis"></a>
<strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="Isabel Garcia-Contreras" href="ciaopp_ref_mansearch.html#Isabel Garcia-Contreras">Isabel Garcia-Contreras</a>.<p>
This module manages the analysis database for ciaopp_batch.<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(db_analysis)).</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_status/5"><tt>add_task_status/5</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#task_status/5"><tt>task_status/5</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#update_task_status/0"><tt>update_task_status/0</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#last_file_log/2"><tt>last_file_log/2</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#init_analysis_db/0"><tt>init_analysis_db/0</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#init_tmp_db/1"><tt>init_tmp_db/1</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#clean_db/0"><tt>clean_db/0</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#clean_tmp_db/0"><tt>clean_tmp_db/0</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#set_current_task/2"><tt>set_current_task/2</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#current_task_proc/2"><tt>current_task_proc/2</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="#set_last_error/3"><tt>set_last_error/3</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="#update_tasks_analysis_status/0"><tt>update_tasks_analysis_status/0</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="#report_mod_info/3"><tt>report_mod_info/3</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="#db_data_dir/1"><tt>db_data_dir/1</tt></a>.
<li><em>Multifiles:</em><br/><a class="lpdoc-idx-anchor" id="14" href="preprocess_flags.html#$is_persistent/2"><tt>$is_persistent/2</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="preprocess_flags.html#persistent_dir/2"><tt>persistent_dir/2</tt></a>, <a class="lpdoc-idx-anchor" id="16" 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_status/5" href="ciaopp_ref_mansearch.html#add_task_status/5">add_task_status/5</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>add_task_status(ModName,ModPath,Action,Flags,Status)</tt>
</span><p>Adds ciaopp action status for <span class="lpdoc-var">ModName</span> located in <span class="lpdoc-var">ModPath</span></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="17" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">ModName</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="18" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">ModPath</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="19" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">Action</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="20" href="basic_props.html#term/1"><tt>term/1</tt></a>)</span><span><span class="lpdoc-var">Flags</span> is any term.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="21" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">Status</span> is an atom.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="task_status/5" href="ciaopp_ref_mansearch.html#task_status/5">task_status/5</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>task_status(ModName,ModPath,Action,Flags,Status)</tt>
</span><p><span class="lpdoc-var">Status</span> is the information of how <span class="lpdoc-var">ModName</span> located in <span class="lpdoc-var">ModPath</span> was analyzed</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="22" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">ModName</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="23" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">ModPath</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="24" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">Action</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="25" href="basic_props.html#term/1"><tt>term/1</tt></a>)</span><span><span class="lpdoc-var">Flags</span> is any term.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="26" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">Status</span> is an atom.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="update_task_status/0" href="ciaopp_ref_mansearch.html#update_task_status/0">update_task_status/0</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Updates the data with the last analysis information</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="last_file_log/2" href="ciaopp_ref_mansearch.html#last_file_log/2">last_file_log/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>last_file_log(ID,F)</tt>
</span><p><span class="lpdoc-var">F</span> is the associated file log to <span class="lpdoc-var">ID</span></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="27" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">ID</span> is an atom.
</span>
<li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="28" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">F</span> is an atom.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="init_analysis_db/0" href="ciaopp_ref_mansearch.html#init_analysis_db/0">init_analysis_db/0</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Initializes analysis 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_tmp_db/1" href="ciaopp_ref_mansearch.html#init_tmp_db/1">init_tmp_db/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>init_tmp_db(ID)</tt>
</span><p>Initializes a temporal DB for <span class="lpdoc-var">ID</span>.</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="29" href="basic_props.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">ID</span> is an atom.
</span>
</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:</span><p>Clears all analysis data.</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_tmp_db/0" href="ciaopp_ref_mansearch.html#clean_tmp_db/0">clean_tmp_db/0</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Removes all temporal databases.</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="set_current_task/2" href="ciaopp_ref_mansearch.html#set_current_task/2">set_current_task/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>set_current_task(ID,Task)</tt>
</span><p>Writes in a file that <span class="lpdoc-var">Module</span> is currently being analyzed.</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="current_task_proc/2" href="ciaopp_ref_mansearch.html#current_task_proc/2">current_task_proc/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>current_task_proc(ID,Task)</tt>
</span><p><span class="lpdoc-var">Module</span> is the module being analyzed by <a class="lpdoc-idx-anchor" id="30" href="ciaopp_ref_mansearch.html#batch_analyze"><tt>batch_analyze</tt></a> currenlty</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="31" href="ciaopp_ref_mansearch.html#var/1"><tt>var/1</tt></a>)</span><span><span class="lpdoc-var">Task</span> is a free variable.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="set_last_error/3" href="ciaopp_ref_mansearch.html#set_last_error/3">set_last_error/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>set_last_error(ModName,FilePath,AbsInt)</tt>
</span><p>Appends to the error file of <span class="lpdoc-var">FilePath</span> that the analysis for domain <span class="lpdoc-var">AbsInt</span> of the last module (<span class="lpdoc-var">Module</span>) had a timeout.</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="update_tasks_analysis_status/0" href="ciaopp_ref_mansearch.html#update_tasks_analysis_status/0">update_tasks_analysis_status/0</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Updates the task_status db to remove modules which are not updated, i.e., their <tt>.dump</tt> file is older than their <tt>.pl</tt> file.<p>For modules which could not be analyze, no information is updated</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="report_mod_info/3" href="ciaopp_ref_mansearch.html#report_mod_info/3">report_mod_info/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>report_mod_info(FilePath,ModName,LDiag)</tt>
</span><p>Stores in a file with extension <tt>.err</tt> <span class="lpdoc-var">Info</span> about <span class="lpdoc-var">ModName</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="db_data_dir/1" href="ciaopp_ref_mansearch.html#db_data_dir/1">db_data_dir/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>db_data_dir(F)</tt>
</span><p><span class="lpdoc-var">F</span> is the location of data in this bundle</p><ul class="lpdoc-itemize-minus"></ul></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="32" href="ciaopp_batch_aux.html"><tt>ciaopp_batch_aux</tt></a>.
<li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="33" href="ciaopp_ref_mansearch.html#datafacts_rt"><tt>datafacts_rt</tt></a>, <a class="lpdoc-idx-anchor" id="34" href="ciaopp_ref_mansearch.html#persdb_rt"><tt>persdb_rt</tt></a>, <a class="lpdoc-idx-anchor" id="35" href="ciaopp_ref_mansearch.html#system"><tt>system</tt></a>, <a class="lpdoc-idx-anchor" id="36" href="ciaopp_ref_mansearch.html#terms_io"><tt>terms_io</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="ciaopp_ref_mansearch.html#system_extra"><tt>system_extra</tt></a>, <a class="lpdoc-idx-anchor" id="38" href="ciaopp_ref_mansearch.html#read"><tt>read</tt></a>, <a class="lpdoc-idx-anchor" id="39" href="ciaopp_ref_mansearch.html#pathnames"><tt>pathnames</tt></a>, <a class="lpdoc-idx-anchor" id="40" href="ciaopp_ref_mansearch.html#write"><tt>write</tt></a>, <a class="lpdoc-idx-anchor" id="41" href="ciaopp_ref_mansearch.html#bundle_paths"><tt>bundle_paths</tt></a>, <a class="lpdoc-idx-anchor" id="42" href="ciaopp_ref_mansearch.html#datadir"><tt>datadir</tt></a>, <a class="lpdoc-idx-anchor" id="43" href="ciaopp_ref_mansearch.html#format"><tt>format</tt></a>.
<li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="44" href="ciaopp_ref_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="45" href="ciaopp_ref_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="46" href="ciaopp_ref_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="47" href="ciaopp_ref_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="48" href="ciaopp_ref_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="49" href="ciaopp_ref_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="50" href="ciaopp_ref_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="51" href="ciaopp_ref_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="52" href="basic_props.html"><tt>basic_props</tt></a>, <a class="lpdoc-idx-anchor" id="53" href="ciaopp_ref_mansearch.html#hiord_rt"><tt>hiord_rt</tt></a>, <a class="lpdoc-idx-anchor" id="54" href="ciaopp_ref_mansearch.html#stream_basic"><tt>stream_basic</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="55" href="ciaopp_ref_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="56" href="ciaopp_ref_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="57" href="ciaopp_ref_mansearch.html#condcomp"><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="ciaopp_ref_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="60" href="ciaopp_ref_mansearch.html#isomodes"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="61" href="ciaopp_ref_mansearch.html#persdb"><tt>persdb</tt></a>, <a class="lpdoc-idx-anchor" id="62" href="ciaopp_ref_mansearch.html#datafacts"><tt>datafacts</tt></a>, <a class="lpdoc-idx-anchor" id="63" 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>