gem-graph/gem-graph-client
gem-graph
/
gem-graph-client
3
0
Fork 0
Code Issues 14 Pull Requests Projects Releases Activity
gem-graph-client/doc/html/d3/d0c/journal_8c.html

428 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gem-graph: src/journal.c File Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../logo icon mini.png"/></td>
<td id="projectalign">
<div id="projectname">Gem-graph<span id="projectnumber">&#160;0.1.0</span>
</div>
<div id="projectbrief">A modelling tool based on rewriting of geometric graphs.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">journal.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>journal / log
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;time.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;sys/time.h&gt;</code><br />
<code>#include &quot;<a class="el" href="../../dd/d01/fsm_8h.html">../include/fsm.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae6db4255fc3be03e0df09e7eda86b079" id="r_ae6db4255fc3be03e0df09e7eda86b079"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0c/journal_8c.html#ae6db4255fc3be03e0df09e7eda86b079">fsm_journal_init</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *jj)</td></tr>
<tr class="memdesc:ae6db4255fc3be03e0df09e7eda86b079"><td class="mdescLeft">&#160;</td><td class="mdescRight">init the journal <br /></td></tr>
<tr class="separator:ae6db4255fc3be03e0df09e7eda86b079"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6738f8ff2fb7cb835d3ac62f1428c68" id="r_af6738f8ff2fb7cb835d3ac62f1428c68"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0c/journal_8c.html#af6738f8ff2fb7cb835d3ac62f1428c68">fsm_journal_clear</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *jj, const char *file_source, const char *function_source, const char *string_value)</td></tr>
<tr class="memdesc:af6738f8ff2fb7cb835d3ac62f1428c68"><td class="mdescLeft">&#160;</td><td class="mdescRight">usefulness ? (systematic ^c) <br /></td></tr>
<tr class="separator:af6738f8ff2fb7cb835d3ac62f1428c68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00a6887e7c3875580234d3a621589b72" id="r_a00a6887e7c3875580234d3a621589b72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0c/journal_8c.html#a00a6887e7c3875580234d3a621589b72">fsm_journal_push_front</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *jj, const char *file_source, const char *function_source, const char *string_value)</td></tr>
<tr class="memdesc:a00a6887e7c3875580234d3a621589b72"><td class="mdescLeft">&#160;</td><td class="mdescRight">add an event <br /></td></tr>
<tr class="separator:a00a6887e7c3875580234d3a621589b72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e063d297e80c32e2bac1ec04f24ecc2" id="r_a9e063d297e80c32e2bac1ec04f24ecc2"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0c/journal_8c.html#a9e063d297e80c32e2bac1ec04f24ecc2">fsm_journal_pop_back</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *jj, const char *file_source, const char *function_source, const char *string_value)</td></tr>
<tr class="memdesc:a9e063d297e80c32e2bac1ec04f24ecc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">remove an event <br /></td></tr>
<tr class="separator:a9e063d297e80c32e2bac1ec04f24ecc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bc11a62378ff09ae3cbd8f40fa7fecd" id="r_a2bc11a62378ff09ae3cbd8f40fa7fecd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0c/journal_8c.html#a2bc11a62378ff09ae3cbd8f40fa7fecd">fsm_journal_length</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> jj)</td></tr>
<tr class="memdesc:a2bc11a62378ff09ae3cbd8f40fa7fecd"><td class="mdescLeft">&#160;</td><td class="mdescRight">get journal_length <br /></td></tr>
<tr class="separator:a2bc11a62378ff09ae3cbd8f40fa7fecd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa414af4170798735875067122c33df8f" id="r_aa414af4170798735875067122c33df8f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0c/journal_8c.html#aa414af4170798735875067122c33df8f">fsm_journal_seek</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> jj, long usec, const char *file_source, const char *function_source, const char *string_value)</td></tr>
<tr class="memdesc:aa414af4170798735875067122c33df8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">seek for an event <br /></td></tr>
<tr class="separator:aa414af4170798735875067122c33df8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76c4b511ecf3ddbc9e6d110641be665b" id="r_a76c4b511ecf3ddbc9e6d110641be665b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0c/journal_8c.html#a76c4b511ecf3ddbc9e6d110641be665b">fsm_journal_publish</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> jj)</td></tr>
<tr class="memdesc:a76c4b511ecf3ddbc9e6d110641be665b"><td class="mdescLeft">&#160;</td><td class="mdescRight">publish all the logs today just print in the console TODO &gt; in a file <br /></td></tr>
<tr class="separator:a76c4b511ecf3ddbc9e6d110641be665b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>journal / log </p>
<p>This file is part of Gem-graph. The journal stores chronologically the events during a session run (rules exec, mainly)</p>
<p>What types of events should be reported ? (fsm, widgets, ... ) For what purpose ? What information must be collected and transmitted ? How to name and classify this information ? How to present it ?</p>
<p>date key (rank) source file source function +/- value</p>
<p>(notes) time_t current_time = time(NULL); &lt; Check if the time retrieval was successful if (current_time == ((time_t)-1)) printf("Error getting current time.\n"); Convert to local time format and print printf(" Current timestamp: %ld %s\n", current_time, message); printf(" Current time: %s", ctime(&amp;current_time)); </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="af6738f8ff2fb7cb835d3ac62f1428c68" name="af6738f8ff2fb7cb835d3ac62f1428c68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6738f8ff2fb7cb835d3ac62f1428c68">&#9670;&#160;</a></span>fsm_journal_clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_journal_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *&#160;</td>
<td class="paramname"><em>jj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>function_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>string_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>usefulness ? (systematic ^c) </p>
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*jj</td><td></td></tr>
<tr><td class="paramname">*file_source</td><td></td></tr>
<tr><td class="paramname">*function_source</td><td></td></tr>
<tr><td class="paramname">*string_value</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae6db4255fc3be03e0df09e7eda86b079" name="ae6db4255fc3be03e0df09e7eda86b079"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6db4255fc3be03e0df09e7eda86b079">&#9670;&#160;</a></span>fsm_journal_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_journal_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *&#160;</td>
<td class="paramname"><em>jj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>init the journal </p>
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*jj</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2bc11a62378ff09ae3cbd8f40fa7fecd" name="a2bc11a62378ff09ae3cbd8f40fa7fecd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bc11a62378ff09ae3cbd8f40fa7fecd">&#9670;&#160;</a></span>fsm_journal_length()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fsm_journal_length </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a>&#160;</td>
<td class="paramname"><em>jj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get journal_length </p>
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*jj</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>journal length </dd></dl>
</div>
</div>
<a id="a9e063d297e80c32e2bac1ec04f24ecc2" name="a9e063d297e80c32e2bac1ec04f24ecc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e063d297e80c32e2bac1ec04f24ecc2">&#9670;&#160;</a></span>fsm_journal_pop_back()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long fsm_journal_pop_back </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *&#160;</td>
<td class="paramname"><em>jj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>function_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>string_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>remove an event </p>
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*jj</td><td></td></tr>
<tr><td class="paramname">*file_source</td><td></td></tr>
<tr><td class="paramname">*function_source</td><td></td></tr>
<tr><td class="paramname">*string_value</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a76c4b511ecf3ddbc9e6d110641be665b" name="a76c4b511ecf3ddbc9e6d110641be665b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76c4b511ecf3ddbc9e6d110641be665b">&#9670;&#160;</a></span>fsm_journal_publish()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_journal_publish </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a>&#160;</td>
<td class="paramname"><em>jj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>publish all the logs today just print in the console TODO &gt; in a file </p>
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*jj</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a00a6887e7c3875580234d3a621589b72" name="a00a6887e7c3875580234d3a621589b72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00a6887e7c3875580234d3a621589b72">&#9670;&#160;</a></span>fsm_journal_push_front()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_journal_push_front </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *&#160;</td>
<td class="paramname"><em>jj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>function_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>string_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>add an event </p>
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*jj</td><td></td></tr>
<tr><td class="paramname">*file_source</td><td></td></tr>
<tr><td class="paramname">*function_source</td><td></td></tr>
<tr><td class="paramname">*string_value</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa414af4170798735875067122c33df8f" name="aa414af4170798735875067122c33df8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa414af4170798735875067122c33df8f">&#9670;&#160;</a></span>fsm_journal_seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_journal_seek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a>&#160;</td>
<td class="paramname"><em>jj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>usec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>function_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>string_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>seek for an event </p>
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*jj</td><td></td></tr>
<tr><td class="paramname">usec</td><td></td></tr>
<tr><td class="paramname">*file_source</td><td></td></tr>
<tr><td class="paramname">*function_source</td><td></td></tr>
<tr><td class="paramname">*string_value</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink