cleaning under doxygen control: before widgets hierarchy reorganization (if SOS)

This commit is contained in:
Jean Sirmai 2024-10-19 16:05:49 +02:00
parent 4f657162ca
commit 0b09dbcadd
Signed by: jean
GPG Key ID: FB3115C340E057E3
309 changed files with 11673 additions and 917 deletions

View File

@ -19,9 +19,11 @@
<para>Gem-graph-client main file. </para> <para>Gem-graph-client main file. </para>
<para>This file is part of Gem-graph. It contains only the main function.</para> <para>This file is part of Gem-graph. It contains only the main function. The function <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> initialises the log, the finite state machine (fsm), the application and the windows and closes all the elements it opened at the end of program execution. The main window is opened on the &apos;synthetic view&apos; page of the current model by default (<formalpara><title>See also</title>
<para>The function <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> initialises the log, the finite state machine (fsm), the application and the windows. The main window is opened on the &apos;synthetic view&apos; page of the current model by default. The main function closes all the elements it opened at the end of program execution. </para> <para>the <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main</link> window topbar dispatcher). </para>
</formalpara>
</para>
</section> </section>
<section> <section>
<title>Function Documentation</title> <title>Function Documentation</title>

View File

@ -33,5 +33,5 @@
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation used to test the functioning of doxygen </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/util.h</section> include/<link linkend="_util_8h">util.h</link></section>
</section> </section>

View File

@ -29,5 +29,5 @@
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation used to test the functioning of doxygen </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/util.h</section> include/<link linkend="_util_8h">util.h</link></section>
</section> </section>

View File

@ -29,5 +29,5 @@
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation used to test the functioning of doxygen </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/fsm.h</section> include/<link linkend="_fsm_8h">fsm.h</link></section>
</section> </section>

View File

@ -33,5 +33,5 @@
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation used to test the functioning of doxygen </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/widget.h</section> include/<link linkend="_widget_8h">widget.h</link></section>
</section> </section>

View File

@ -0,0 +1,33 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_actions_8c" xml:lang="en-US">
<title>src/actions.c File Reference</title>
<indexterm><primary>src/actions.c</primary></indexterm>
<para>
<para>events management (actions) functions </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;unistd.h&gt;<?linebreak?>#include &lt;gtk-4.0/gtk/gtk.h&gt;<?linebreak?></programlisting><simplesect>
<title>Macros </title>
<itemizedlist>
<listitem><para><anchor xml:id="_actions_8c_1a6601e30a11906888d0db1ec40237b758"/>#define <emphasis role="strong">GEM_GRAPH_CLIENT_TYPE_WINDOW</emphasis>&#160;&#160;&#160;(gem_graph_client_window_get_type())</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_actions_8c_1a2a1b1eeff3f2631d6291e0f9ea909049"/>void <emphasis role="strong">on_preferences_action</emphasis> (GSimpleAction *action, GVariant *parameter, gpointer user_data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>events management (actions) functions </para>
<para>This file is part of Gem-graph. </para>
</section>
</section>

View File

@ -0,0 +1,63 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_grid_8c" xml:lang="en-US">
<title>src/graphics/grid.c File Reference</title>
<indexterm><primary>src/graphics/grid.c</primary></indexterm>
<para>
<para>graphics - grid/empty space drawing functions </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/graphics.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>int <link linkend="_grid_8c_1a89243f218fde8d99432870537d4855f7">graphics_draw_space_ridges_vertex</link> (const int stack_id, long offset_vertex, long x, long y, long z)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_grid_8c_1ab2c36ba517ca17807179c1c0f872184b"/>int <emphasis role="strong">graphics_draw_space_ridges_lines</emphasis> (const int stack_id)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>long <link linkend="_grid_8c_1a736b2ae78fa856d5ea56a5db11b22007">graphics_draw_grids_on_space_faces_vertex</link> (const int stack_id, long x, long y, long z)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_grid_8c_1a4d1ecae814bc87b330e285d9afa2462f"/>long <emphasis role="strong">graphics_draw_grids_on_space_faces_lines</emphasis> (const int stack_id, long offset_vertex, long x, long y, long z)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>graphics - grid/empty space drawing functions </para>
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_grid_8c_1a736b2ae78fa856d5ea56a5db11b22007"/><section>
<title>graphics_draw_grids_on_space_faces_vertex()</title>
<indexterm><primary>graphics_draw_grids_on_space_faces_vertex</primary><secondary>grid.c</secondary></indexterm>
<indexterm><primary>grid.c</primary><secondary>graphics_draw_grids_on_space_faces_vertex</secondary></indexterm>
<para><computeroutput>long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z)</computeroutput></para><para>
<para>phantom documentation used to test the functioning of doxygen </para>
</para>
<para>Writes grid lines on space faces. </para>
</section>
<anchor xml:id="_grid_8c_1a89243f218fde8d99432870537d4855f7"/><section>
<title>graphics_draw_space_ridges_vertex()</title>
<indexterm><primary>graphics_draw_space_ridges_vertex</primary><secondary>grid.c</secondary></indexterm>
<indexterm><primary>grid.c</primary><secondary>graphics_draw_space_ridges_vertex</secondary></indexterm>
<para><computeroutput>int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z)</computeroutput></para><para>
<para>phantom documentation used to test the functioning of doxygen </para>
</para>
<para>Writes grid ridges to vertex and color buffers. </para>
</section>
</section>
</section>

View File

@ -41,5 +41,5 @@
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation used to test the functioning of doxygen </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/base.h</section> include/<link linkend="_base_8h">base.h</link></section>
</section> </section>

View File

@ -0,0 +1,54 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_base_8h" xml:lang="en-US">
<title>include/base.h File Reference</title>
<indexterm><primary>include/base.h</primary></indexterm>
<para>
<para>base header </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;assert.h&gt;<?linebreak?>#include &lt;errno.h&gt;<?linebreak?>#include &lt;fcntl.h&gt;<?linebreak?>#include &lt;math.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &lt;stddef.h&gt;<?linebreak?>#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;sys/types.h&gt;<?linebreak?>#include &lt;sys/stat.h&gt;<?linebreak?>#include &lt;unistd.h&gt;<?linebreak?>#include &lt;time.h&gt;<?linebreak?>#include &lt;string.h&gt;<?linebreak?>#include &lt;glib-2.0/glib.h&gt;<?linebreak?>#include &lt;gtk-4.0/gtk/gtk.h&gt;<?linebreak?></programlisting><simplesect>
<title>Classes </title>
<itemizedlist>
<listitem><para>struct <link linkend="_structarrow__t">arrow_t</link></para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Macros </title>
<itemizedlist>
<listitem><para><anchor xml:id="_base_8h_1a072a1ef1143314441742097b799be322"/>#define <emphasis role="strong">EAST</emphasis>&#160;&#160;&#160;0</para>
</listitem>
<listitem><para><anchor xml:id="_base_8h_1a755da365a2f771fdb9e15af22fee7d74"/>#define <emphasis role="strong">WEST</emphasis>&#160;&#160;&#160;1</para>
</listitem>
<listitem><para><anchor xml:id="_base_8h_1a695b59c40e575e69cc7954a6045e01c7"/>#define <emphasis role="strong">ZENITH</emphasis>&#160;&#160;&#160;2</para>
</listitem>
<listitem><para><anchor xml:id="_base_8h_1a30dddfc4f2f483921921304d1d498674"/>#define <emphasis role="strong">NADIR</emphasis>&#160;&#160;&#160;3</para>
</listitem>
<listitem><para><anchor xml:id="_base_8h_1af3830320fe6287f717dca9669f417950"/>#define <emphasis role="strong">SOUTH</emphasis>&#160;&#160;&#160;4</para>
</listitem>
<listitem><para><anchor xml:id="_base_8h_1a1711232abf72723b5216c206e6bbb175"/>#define <emphasis role="strong">NORTH</emphasis>&#160;&#160;&#160;5</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Enumerations </title>
<itemizedlist>
<listitem><para><anchor xml:id="_base_8h_1a06fc87d81c62e9abb8790b6e5713c55b"/>enum { <emphasis role="strong">X_AXIS</emphasis>
, <emphasis role="strong">Y_AXIS</emphasis>
, <emphasis role="strong">Z_AXIS</emphasis>
, <emphasis role="strong">N_AXIS</emphasis>
}</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>base header </para>
<para>This file is part of Gem-graph. </para>
</section>
</section>

View File

@ -0,0 +1,328 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_journal_8c" xml:lang="en-US">
<title>src/journal.c File Reference</title>
<indexterm><primary>src/journal.c</primary></indexterm>
<para>
<para>journal / log </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &lt;time.h&gt;<?linebreak?>#include &lt;string.h&gt;<?linebreak?>#include &lt;sys/time.h&gt;<?linebreak?>#include &quot;../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>void <link linkend="_journal_8c_1ae6db4255fc3be03e0df09e7eda86b079">fsm_journal_init</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> *jj)</para>
<para>2024-09-22 What types of events should be reported ? (fsm, widgets, ... ) For what purpose ? What information must be collected and transmitted ? How do you name and classify this information ? How do you present it ? </para>
</listitem>
<listitem><para>void <link linkend="_journal_8c_1af6738f8ff2fb7cb835d3ac62f1428c68">fsm_journal_clear</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> *jj, const char *file_source, const char *function_source, const char *string_value)</para>
</listitem>
<listitem><para>void <link linkend="_journal_8c_1a00a6887e7c3875580234d3a621589b72">fsm_journal_push_front</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> *jj, const char *file_source, const char *function_source, const char *string_value)</para>
</listitem>
<listitem><para>long <link linkend="_journal_8c_1a9e063d297e80c32e2bac1ec04f24ecc2">fsm_journal_pop_back</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> *jj, const char *file_source, const char *function_source, const char *string_value)</para>
</listitem>
<listitem><para>int <link linkend="_journal_8c_1a2bc11a62378ff09ae3cbd8f40fa7fecd">fsm_journal_length</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj)</para>
</listitem>
<listitem><para>void <link linkend="_journal_8c_1aa414af4170798735875067122c33df8f">fsm_journal_seek</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj, long usec, const char *file_source, const char *function_source, const char *string_value)</para>
</listitem>
<listitem><para>void <link linkend="_journal_8c_1a76c4b511ecf3ddbc9e6d110641be665b">fsm_journal_publish</link> (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj)</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>journal / log </para>
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_journal_8c_1af6738f8ff2fb7cb835d3ac62f1428c68"/><section>
<title>fsm_journal_clear()</title>
<indexterm><primary>fsm_journal_clear</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_journal_clear</secondary></indexterm>
<para><computeroutput>void fsm_journal_clear (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> * jj, const char * file_source, const char * function_source, const char * string_value)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_journal_8c_1ae6db4255fc3be03e0df09e7eda86b079"/><section>
<title>fsm_journal_init()</title>
<indexterm><primary>fsm_journal_init</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_journal_init</secondary></indexterm>
<para><computeroutput>void fsm_journal_init (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> * jj)</computeroutput></para><para>
<para>2024-09-22 What types of events should be reported ? (fsm, widgets, ... ) For what purpose ? What information must be collected and transmitted ? How do you name and classify this information ? How do you present it ? </para>
</para>
<para>date clé (rank) fichier source fonction source +/- valeur <?linebreak?> <literallayout><computeroutput>time_t current_time = time(NULL);
</computeroutput></literallayout> Check if the time retrieval was successful if (current_time == ((time_t)-1)) printf(&quot;Error getting current time.\n&quot;); Convert to local time format and print printf(&quot; Current timestamp: %ld %s\n&quot;, current_time, message); printf(&quot; Current time: %s&quot;, ctime(&amp;current_time));</para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_journal_8c_1a2bc11a62378ff09ae3cbd8f40fa7fecd"/><section>
<title>fsm_journal_length()</title>
<indexterm><primary>fsm_journal_length</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_journal_length</secondary></indexterm>
<para><computeroutput>int fsm_journal_length (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_journal_8c_1a9e063d297e80c32e2bac1ec04f24ecc2"/><section>
<title>fsm_journal_pop_back()</title>
<indexterm><primary>fsm_journal_pop_back</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_journal_pop_back</secondary></indexterm>
<para><computeroutput>long fsm_journal_pop_back (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> * jj, const char * file_source, const char * function_source, const char * string_value)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_journal_8c_1a76c4b511ecf3ddbc9e6d110641be665b"/><section>
<title>fsm_journal_publish()</title>
<indexterm><primary>fsm_journal_publish</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_journal_publish</secondary></indexterm>
<para><computeroutput>void fsm_journal_publish (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_journal_8c_1a00a6887e7c3875580234d3a621589b72"/><section>
<title>fsm_journal_push_front()</title>
<indexterm><primary>fsm_journal_push_front</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_journal_push_front</secondary></indexterm>
<para><computeroutput>void fsm_journal_push_front (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> * jj, const char * file_source, const char * function_source, const char * string_value)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_journal_8c_1aa414af4170798735875067122c33df8f"/><section>
<title>fsm_journal_seek()</title>
<indexterm><primary>fsm_journal_seek</primary><secondary>journal.c</secondary></indexterm>
<indexterm><primary>journal.c</primary><secondary>fsm_journal_seek</secondary></indexterm>
<para><computeroutput>void fsm_journal_seek (<link linkend="_structfsm__struct__journal">fsm_struct_journal</link> jj, long usec, const char * file_source, const char * function_source, const char * string_value)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
</section>
</section>

View File

@ -4,7 +4,7 @@
<indexterm><primary>src/fsm/dispatch.c</primary></indexterm> <indexterm><primary>src/fsm/dispatch.c</primary></indexterm>
<para> <para>
<para>This Finite State Machine (fsm) describes all the possible states of the Gem-graph client and all the transitions between them. </para> <para>fsm (Finite State Machine) tasks dispatcher </para>
</para> </para>
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &quot;../../include/fsm.h&quot;<?linebreak?>#include &quot;../../include/util.h&quot;<?linebreak?>#include &quot;../../include/widget.h&quot;<?linebreak?></programlisting><simplesect> <programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &quot;../../include/fsm.h&quot;<?linebreak?>#include &quot;../../include/util.h&quot;<?linebreak?>#include &quot;../../include/widget.h&quot;<?linebreak?></programlisting><simplesect>
@ -51,9 +51,11 @@
<section> <section>
<title>Detailed Description</title> <title>Detailed Description</title>
<para>This Finite State Machine (fsm) describes all the possible states of the Gem-graph client and all the transitions between them. </para> <para>fsm (Finite State Machine) tasks dispatcher </para>
<para>The gem-graph-client fsm manages several kinds of exclusive states:<itemizedlist> <para>This file is part of Gem-graph.</para>
<para>The Finite State Machine (fsm) describes all the possible states of the Gem-graph client and all the transitions between them. It manages several kinds of exclusive states:<itemizedlist>
<listitem> <listitem>
<para>Run the model or edit it.</para> <para>Run the model or edit it.</para>
</listitem><listitem> </listitem><listitem>
@ -81,8 +83,7 @@
<para>No fsm transition should be executed in another module.</para> <para>No fsm transition should be executed in another module.</para>
<para><literallayout><computeroutput> The journal is created, edited and published from here. <para>The journal is created, edited and published from here. </para>
</computeroutput></literallayout> </para>
</section> </section>
<section> <section>
<title>Function Documentation</title> <title>Function Documentation</title>
@ -253,7 +254,7 @@ Simple filters (on a single parameter) can be combined using the logical operato
</formalpara> </formalpara>
<formalpara><title>See also</title> <formalpara><title>See also</title>
<para>src/journal.c/fsm_journal_push_front()</para> <para><link linkend="_journal_8c">src/journal.c</link>/fsm_journal_push_front()</para>
<para>src/main/main() </para> <para>src/main/main() </para>
@ -265,7 +266,7 @@ Simple filters (on a single parameter) can be combined using the logical operato
<para>src/widget/topbar/left.c </para> <para>src/widget/topbar/left.c </para>
<para>src/widget/topbar/dispatch.c * 3 </para> <para><link linkend="_widget_2topbar_2dispatch_8c">src/widget/topbar/dispatch.c</link> * 3 </para>
<para>src/widget/one_rule/dispatch.c </para> <para>src/widget/one_rule/dispatch.c </para>
@ -273,23 +274,23 @@ Simple filters (on a single parameter) can be combined using the logical operato
<para>src/widget/measure/dispatch.c </para> <para>src/widget/measure/dispatch.c </para>
<para>src/widget/dispatch.c * 3 </para> <para><link linkend="_widget_2dispatch_8c">src/widget/dispatch.c</link> * 3 </para>
<para>src/widget/all_rules/dispatch.c </para> <para>src/widget/all_rules/dispatch.c </para>
<para><link linkend="_preferences_2manager_8c">src/fsm/preferences/manager.c</link> * 8 </para> <para><link linkend="_preferences_2manager_8c">src/fsm/preferences/manager.c</link> * 8 </para>
<para>src/fsm/measures/manager.c * 2 </para> <para><link linkend="_measures_2manager_8c">src/fsm/measures/manager.c</link> * 2 </para>
<para>src/fsm/measures/tools_list.c * 4 </para> <para>src/fsm/measures/tools_list.c * 4 </para>
<para><link linkend="_fsm_2dispatch_8c">src/fsm/dispatch.c</link> * 10 </para> <para><link linkend="_fsm_2dispatch_8c">src/fsm/dispatch.c</link> * 10 </para>
<para>src/fsm/results/manager.c </para> <para><link linkend="_results_2manager_8c">src/fsm/results/manager.c</link> </para>
<para>src/util/tree.c </para> <para>src/util/tree.c </para>
<para>src/signal.c * 38</para> <para><link linkend="_signal_8c">src/signal.c</link> * 38</para>
</formalpara> </formalpara>
<formalpara> <formalpara>
@ -313,7 +314,7 @@ Parameters</title>
</formalpara> </formalpara>
<formalpara><title>See also</title> <formalpara><title>See also</title>
<para>enum fsm_enum_journal_severity in include/fsm.h &apos;severity&apos; is a pre-defined value that must be associated to each event. It ranges from zero to six : CRITICAL ERROR WARNING INFO MESSAGE DEBUG SPEW 0 1 2 3 4 5 6</para> <para>enum <link linkend="_fsm_8h_1ab761a6fdf1ac1e26a44f8f9524aa6da7">fsm_enum_journal_severity</link> in <link linkend="_fsm_8h">include/fsm.h</link> &apos;severity&apos; is a pre-defined value that must be associated to each event. It ranges from zero to six : CRITICAL ERROR WARNING INFO MESSAGE DEBUG SPEW 0 1 2 3 4 5 6</para>
</formalpara> </formalpara>
<formalpara> <formalpara>
@ -337,7 +338,7 @@ Parameters</title>
</formalpara> </formalpara>
<formalpara><title>See also</title> <formalpara><title>See also</title>
<para>enum fsm_enum_journal_source in include/fsm.h &apos;source&apos; is a pre-defined value that can be associated to each event. It is not mandatory. It can be set to &apos;NULL&apos;.</para> <para>enum fsm_enum_journal_source in <link linkend="_fsm_8h">include/fsm.h</link> &apos;source&apos; is a pre-defined value that can be associated to each event. It is not mandatory. It can be set to &apos;NULL&apos;.</para>
</formalpara> </formalpara>
<formalpara> <formalpara>
@ -384,7 +385,7 @@ Parameters</title>
<para>The log is modified for each event but events can be send asynchronously. This is why the journal is only published once, before the end of &quot;main()&quot;, Its chronological order is therefore guaranteed.</para> <para>The log is modified for each event but events can be send asynchronously. This is why the journal is only published once, before the end of &quot;main()&quot;, Its chronological order is therefore guaranteed.</para>
<para>src/journal.c/fsm_journal_publish() (called here) is the last function of the program to be executed.</para> <para><link linkend="_journal_8c">src/journal.c</link>/fsm_journal_publish() (called here) is the last function of the program to be executed.</para>
<para>The <link linkend="_structfsm__struct__journal">fsm_struct_journal</link> (gg_logs) is a static instance in this file. Therefore, all the functions that read or write it are in this file. This is to avoid uncontrolled operations on it.</para> <para>The <link linkend="_structfsm__struct__journal">fsm_struct_journal</link> (gg_logs) is a static instance in this file. Therefore, all the functions that read or write it are in this file. This is to avoid uncontrolled operations on it.</para>

View File

@ -0,0 +1,150 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_measures_2manager_8c" xml:lang="en-US">
<title>src/fsm/measures/manager.c File Reference</title>
<indexterm><primary>src/fsm/measures/manager.c</primary></indexterm>
<para>
<para>fsm measures manager </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>void <link linkend="_measures_2manager_8c_1a6c711a88f128da33895ebd6cdf96ed66">fsm_add_measure</link> (char *measure_name)</para>
</listitem>
<listitem><para>void <link linkend="_measures_2manager_8c_1a5da29952715596bf17643f907bd64daf">fsm_list_init_measures</link> ()</para>
</listitem>
<listitem><para>void <link linkend="_measures_2manager_8c_1ae81ba1733710f5b2db1a5b253d7adaf7">fsm_rule_trig_measure</link> (int rule_id, int object_id, int measure_id)</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>fsm measures manager </para>
<para>This file is part of Gem-graph. It inits the three lists used for measurements and results management: tools, data and displayables (disp) and provides access.</para>
<para>F R O M M E A S U R E M E N T S T O P R E S E N T A T I O N S How should the sequence from measurements to results presentation be organized ?</para>
<para>(1) create/edit some mesurement tools and/or activate existing ones (2) apply a mesurement tool to a situation to create a new data list data list = x, f(x), g(x),... these data are collected by the server and send to the client and possibly carry out any operations on these results (3) display (plot) the results and adjust the appearance of the tables <informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
As a consequence, three lists at least must be created and maintained :</para>
<para>(1) a mesurement tools list (see : fsm/measure/tool_list.c) which should mention if the tool is &apos;active&apos; or &apos;inactive NB each rule ou rules-tree edition may change some items of that list</para>
<para>(2) a data flows list (see : fsm/measure/flow_list.c) (it could either be named : fsm/measure/data_list.c) on which some operations could be performed : ex : filter, concat, inverse, scale, correlate, etc. NB each data flow should be available in a &apos;displayable form&apos;</para>
<para>(3) a displayed data list (see : fsm/measure/disp_list.c) NB some data may be displayed simultaneously in different pages ex : SYNTH &amp; RESULTS</para>
<para>NB these three lists should be stored in the XML model and restored at the beginning of a new session <informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
(4) a journal (a pile) stores chronologically the fsm events during a session run (rules exec, mainly) in a journal (.log) one by session <informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
When a rule is adequately tagged, it triggers a measure : fsm_rule_trig_measure (rule_id, object_id, measure_id) {...} The measurement is then taken and the result stored. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_measures_2manager_8c_1a6c711a88f128da33895ebd6cdf96ed66"/><section>
<title>fsm_add_measure()</title>
<indexterm><primary>fsm_add_measure</primary><secondary>manager.c</secondary></indexterm>
<indexterm><primary>manager.c</primary><secondary>fsm_add_measure</secondary></indexterm>
<para><computeroutput>void fsm_add_measure (char * measure_name)</computeroutput></para>
<para><formalpara><title>Since</title>
<para>2024-09</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/widget/measure/dispatch/widget_measure_event_occurences_nb() </para>
<para>src/widget/measure/dispatch/widget_measure_event_occurences_dates() </para>
<para>src/widget/measure/dispatch/widget_measure_event_occurences_situations() </para>
<para>src/widget/measure/dispatch/widget_measure_time_elapsed_between_two_events() </para>
<para>src/widget/measure/dispatch/widget_measure_third_event_occurences_in_between()</para>
<para>src/fsm/dispatch/fsm_journal_event() </para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*measure_name</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
<anchor xml:id="_measures_2manager_8c_1a5da29952715596bf17643f907bd64daf"/><section>
<title>fsm_list_init_measures()</title>
<indexterm><primary>fsm_list_init_measures</primary><secondary>manager.c</secondary></indexterm>
<indexterm><primary>manager.c</primary><secondary>fsm_list_init_measures</secondary></indexterm>
<para><computeroutput>void fsm_list_init_measures ( )</computeroutput></para>
<para><formalpara><title>Since</title>
<para>2024-09</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/fsm/dispatch/fsm_init() </para>
</formalpara>
</para>
</section>
<anchor xml:id="_measures_2manager_8c_1ae81ba1733710f5b2db1a5b253d7adaf7"/><section>
<title>fsm_rule_trig_measure()</title>
<indexterm><primary>fsm_rule_trig_measure</primary><secondary>manager.c</secondary></indexterm>
<indexterm><primary>manager.c</primary><secondary>fsm_rule_trig_measure</secondary></indexterm>
<para><computeroutput>void fsm_rule_trig_measure (int rule_id, int object_id, int measure_id)</computeroutput></para>
<para><formalpara><title>Since</title>
<para>2024-09 </para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>rule_id</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>object_id</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>measure_id</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
</section>
</section>

View File

@ -0,0 +1,38 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_parse_8h" xml:lang="en-US">
<title>include/parse.h File Reference</title>
<indexterm><primary>include/parse.h</primary></indexterm>
<para>
<para>model parsing header </para>
</para>
<simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_parse_8h_1a1d3cbba0db1e6175e60b7df68820fe4e"/>bool <emphasis role="strong">parse_model_init</emphasis> (const char *content, size_t length, const char *basename)</para>
</listitem>
<listitem><para><anchor xml:id="_parse_8h_1ae2e7d278df2f9cd33246b94d3d9774a7"/>bool <emphasis role="strong">parse_model_shutdown</emphasis> (void)</para>
</listitem>
<listitem><para><anchor xml:id="_parse_8h_1a99b1c8dabcf4f7c0e4e7851c89cf31fa"/>char <emphasis role="strong">parse_model_get_dim</emphasis> (void)</para>
</listitem>
<listitem><para><anchor xml:id="_parse_8h_1a53d57da5244be4a906ead03d35cad071"/>long <emphasis role="strong">parse_model_get_dim_value</emphasis> (const char *axis)</para>
</listitem>
<listitem><para><anchor xml:id="_parse_8h_1a65cbc55feddd49729e9cedad453d323f"/>char <emphasis role="strong">parse_model_get_multiplicity</emphasis> (void)</para>
</listitem>
<listitem><para><anchor xml:id="_parse_8h_1a562cd593d672af0d4828ea491b44415f"/>bool <emphasis role="strong">parse_model_get_next_state</emphasis> (char *new_state_id)</para>
</listitem>
<listitem><para><anchor xml:id="_parse_8h_1ad6c895b8ab8296dda321188b930218cc"/>bool <emphasis role="strong">parse_model_get_next_arrow</emphasis> (struct <link linkend="_structarrow__t">arrow_t</link> *new_arrow, const char *state_id, char dimension)</para>
</listitem>
<listitem><para><anchor xml:id="_parse_8h_1ad5a0d65870999086f22a8304535e45b1"/>long <emphasis role="strong">parse_model_get_state_arrows_count</emphasis> (const char *state_id)</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>model parsing header </para>
<para>This file is part of Gem-graph. </para>
</section>
</section>

View File

@ -29,5 +29,5 @@
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation used to test the functioning of doxygen </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/fsm.h</section> include/<link linkend="_fsm_8h">fsm.h</link></section>
</section> </section>

View File

@ -0,0 +1,226 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_draw_8c" xml:lang="en-US">
<title>src/graphics/draw.c File Reference</title>
<indexterm><primary>src/graphics/draw.c</primary></indexterm>
<para>
<para>graphics - general drawing functions </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;cglm/cglm.h&gt;<?linebreak?>#include &quot;../../include/base.h&quot;<?linebreak?>#include &quot;../../include/graphics.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>void <link linkend="_draw_8c_1aa0df09cf556373a65c4e0d9c52ea646b">graphics_draw_vertex</link> (const int stack_id, GLfloat x, GLfloat y, GLfloat z)</para>
<para>Writes values to describe a vertex at (x,y,z) intoq the vertex buffer. </para>
</listitem>
<listitem><para>void <link linkend="_draw_8c_1a3956486509d8f170b54c8d6831bb85af">graphics_draw_color</link> (const int stack_id, GLfloat r, GLfloat g, GLfloat b)</para>
<para>Writes values to describe a color (r,g,b) into the color buffer. </para>
</listitem>
<listitem><para>void <link linkend="_draw_8c_1a658c61849cb025f4482be722c62d66e4">graphics_draw_line</link> (const int stack_id, GLuint a, GLuint b)</para>
<para>Writes values to describe a line from a to b into the line buffer. </para>
</listitem>
<listitem><para>void <link linkend="_draw_8c_1a90e33f30b6c203c51f38279e42f74606">graphics_draw_plan</link> (const int stack_id, GLuint a, GLuint b, GLuint c)</para>
<para>Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. </para>
</listitem>
<listitem><para>void <link linkend="_draw_8c_1a7077e01357e203c1997c806abaee658a">graphics_draw</link> (const int stack_id)</para>
<para>Draws the current buffer to a gl_area. </para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>graphics - general drawing functions </para>
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_draw_8c_1a7077e01357e203c1997c806abaee658a"/><section>
<title>graphics_draw()</title>
<indexterm><primary>graphics_draw</primary><secondary>draw.c</secondary></indexterm>
<indexterm><primary>draw.c</primary><secondary>graphics_draw</secondary></indexterm>
<para><computeroutput>void graphics_draw (const int stack_id)</computeroutput></para><para>
<para>Draws the current buffer to a gl_area. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_draw_8c_1a3956486509d8f170b54c8d6831bb85af"/><section>
<title>graphics_draw_color()</title>
<indexterm><primary>graphics_draw_color</primary><secondary>draw.c</secondary></indexterm>
<indexterm><primary>draw.c</primary><secondary>graphics_draw_color</secondary></indexterm>
<para><computeroutput>void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b)</computeroutput></para><para>
<para>Writes values to describe a color (r,g,b) into the color buffer. </para>
</para>
<para>Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>color</entry><entry>
<para>GLfloat(r,g,b)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_draw_8c_1a658c61849cb025f4482be722c62d66e4"/><section>
<title>graphics_draw_line()</title>
<indexterm><primary>graphics_draw_line</primary><secondary>draw.c</secondary></indexterm>
<indexterm><primary>draw.c</primary><secondary>graphics_draw_line</secondary></indexterm>
<para><computeroutput>void graphics_draw_line (const int stack_id, GLuint a, GLuint b)</computeroutput></para><para>
<para>Writes values to describe a line from a to b into the line buffer. </para>
</para>
<para>Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>GLuint (a,b)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_draw_8c_1a90e33f30b6c203c51f38279e42f74606"/><section>
<title>graphics_draw_plan()</title>
<indexterm><primary>graphics_draw_plan</primary><secondary>draw.c</secondary></indexterm>
<indexterm><primary>draw.c</primary><secondary>graphics_draw_plan</secondary></indexterm>
<para><computeroutput>void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c)</computeroutput></para><para>
<para>Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>GLuint (a,b,c)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_draw_8c_1aa0df09cf556373a65c4e0d9c52ea646b"/><section>
<title>graphics_draw_vertex()</title>
<indexterm><primary>graphics_draw_vertex</primary><secondary>draw.c</secondary></indexterm>
<indexterm><primary>draw.c</primary><secondary>graphics_draw_vertex</secondary></indexterm>
<para><computeroutput>void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z)</computeroutput></para><para>
<para>Writes values to describe a vertex at (x,y,z) intoq the vertex buffer. </para>
</para>
<para>Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>GLfloat(x,y,z)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
</section>
</section>

View File

@ -0,0 +1,19 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_engine_2manager_8c" xml:lang="en-US">
<title>src/fsm/engine/manager.c File Reference</title>
<indexterm><primary>src/fsm/engine/manager.c</primary></indexterm>
<para>
<para>fsm engine manager </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;time.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../include/signal.h&quot;<?linebreak?></programlisting><section>
<title>Detailed Description</title>
<para>fsm engine manager </para>
<para>This file is part of Gem-graph. (is it really ?)</para>
<para>I can&apos;t even remember what I had in mind when writing these notes... learning how to deal with events, perhaps... </para>
</section>
</section>

View File

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_action_8h" xml:lang="en-US">
<title>include/action.h File Reference</title>
<indexterm><primary>include/action.h</primary></indexterm>
<para>
<para>actions header </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;unistd.h&gt;<?linebreak?>#include &lt;gtk-4.0/gtk/gtk.h&gt;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_action_8h_1a2a1b1eeff3f2631d6291e0f9ea909049"/>void <emphasis role="strong">on_preferences_action</emphasis> (GSimpleAction *action, GVariant *parameter, gpointer user_data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>actions header </para>
<para>This file is part of Gem-graph. </para>
</section>
</section>

View File

@ -0,0 +1,69 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_widget_2topbar_2dispatch_8c" xml:lang="en-US">
<title>src/widget/topbar/dispatch.c File Reference</title>
<indexterm><primary>src/widget/topbar/dispatch.c</primary></indexterm>
<para>
<para>Main window widgets dispatcher (topbar and six pages) </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../../include/base.h&quot;<?linebreak?>#include &quot;../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>void <link linkend="_widget_2topbar_2dispatch_8c_1a6458bdae6bcf9131bc7c793810869db7">widget_design_main_window</link> (GtkWindow *main_window, GtkApplication *app)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_2topbar_2dispatch_8c_1aee7518cfd4073577afedafc70705e233"/>char * <emphasis role="strong">widget_get_address_text_theory</emphasis> ()</para>
<para>return &quot;./data/text/théorie.txt&quot; </para>
</listitem>
<listitem><para><anchor xml:id="_widget_2topbar_2dispatch_8c_1acfad36e48f845c075056fb8fbe765c0e"/>char * <emphasis role="strong">widget_get_address_text_practice</emphasis> ()</para>
<para>return &quot;./data/text/pratique.txt&quot; </para>
</listitem>
<listitem><para><anchor xml:id="_widget_2topbar_2dispatch_8c_1a905ee0e77908c113609224ee28aaa0ee"/>char * <emphasis role="strong">widget_get_address_text_alpha_index</emphasis> ()</para>
<para>return &quot;./alphabetic_index.all&quot; </para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>Main window widgets dispatcher (topbar and six pages) </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_widget_2topbar_2dispatch_8c_1a6458bdae6bcf9131bc7c793810869db7"/><section>
<title>widget_design_main_window()</title>
<indexterm><primary>widget_design_main_window</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_design_main_window</secondary></indexterm>
<para><computeroutput>void widget_design_main_window (GtkWindow * main_window, GtkApplication * app)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*main_window</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>*app</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
</section>
</section>

View File

@ -0,0 +1,752 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_graphics_8h" xml:lang="en-US">
<title>include/graphics.h File Reference</title>
<indexterm><primary>include/graphics.h</primary></indexterm>
<para>
<para>graphics header </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;base.h&quot;<?linebreak?>#include &lt;epoxy/gl.h&gt;<?linebreak?>#include &lt;GL/glu.h&gt;<?linebreak?></programlisting><simplesect>
<title>Classes </title>
<itemizedlist>
<listitem><para>struct <link linkend="_structgraphics__stack__t">graphics_stack_t</link></para>
<para>Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas. </para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Macros </title>
<itemizedlist>
<listitem><para><anchor xml:id="_graphics_8h_1a80757f1a53908b5582a9ba77c133c079"/>#define <emphasis role="strong">VERTEX_SHADER_FILE</emphasis>&#160;&#160;&#160;&quot;src/shader.vert&quot;</para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1ad1be094b2f34d6c013cc36d0c0e9a2bb"/>#define <emphasis role="strong">FRAG_SHADER_FILE</emphasis>&#160;&#160;&#160;&quot;src/shader.frag&quot;</para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1a60413e8e518bdcc170ed34d8cfb6b018"/>#define <emphasis role="strong">GL_TARGET_MAJOR_VERSION</emphasis>&#160;&#160;&#160;0</para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1aacde4e0c52ad0f34009b753d288e385c"/>#define <emphasis role="strong">GL_TARGET_MINOR_VERSION</emphasis>&#160;&#160;&#160;4</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_graphics_8h_1ada591592a6e751eed5810aed710edeb2"/>bool <emphasis role="strong">graphics_render_stack</emphasis> (GtkWidget *container_widget)</para>
<para>Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas. </para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1aa186797d420d2d8b445613407dc33146"/>bool <emphasis role="strong">graphics_setup_glarea</emphasis> (int target_mode, GtkWidget *target_widget)</para>
</listitem>
<listitem><para>int <link linkend="_graphics_8h_1a5a4ed7438a755777b162fc37e84ba93a">graphics_init</link> (void *error_buffer)</para>
<para>Initializes a gl_area. </para>
</listitem>
<listitem><para>void <link linkend="_graphics_8h_1a66c9c80dbf46ac2168827bf8a0dfb7ee">graphics_draw</link> (const int graphics_stack_id)</para>
<para>Draws the current buffer to a gl_area. </para>
</listitem>
<listitem><para>bool <link linkend="_graphics_8h_1ae99e9cf190970a730fdb3d8df8682188">graphics_shutdown</link> (const int graphics_stack_id, void *error_buffer)</para>
<para>Draws the current buffer to a gl_area. </para>
</listitem>
<listitem><para>bool <link linkend="_graphics_8h_1ac5ba153022c8589d2cd83442197e163e">graphics_init_shaders</link> (const int graphics_stack_id)</para>
<para>Initializes the shaders of a gl_area and link them to a program. </para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1ad207a8ab8be624215cdb332438f88dce"/>bool <emphasis role="strong">graphics_init_graphics_stack</emphasis> (void *container_widget, GError *error_buffer)</para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1a8e90af55bafb9b4c934eb7f60d888e73"/>bool <emphasis role="strong">graphics_shutdown_graphics_stack</emphasis> (void *container_widget, GError *error_buffer)</para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1aa149b6ac65d1cdf5880ce6e1da303472"/>bool <emphasis role="strong">graphics_update_axis_stack</emphasis> (GtkWidget *container_widget, int axis, int value)</para>
</listitem>
<listitem><para>void <link linkend="_graphics_8h_1aa86924f99e2a17fcb4e33b22b8987a95">graphics_init_buffers</link> (const int graphics_stack_id)</para>
<para>Initializes the buffer of a gl_area Calls according to the user preferences. </para>
</listitem>
<listitem><para>void <link linkend="_graphics_8h_1aa2c4ec98f5bf9942092ff385e9fac72f">graphics_draw_vertex</link> (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)</para>
<para>Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console. </para>
</listitem>
<listitem><para>void <link linkend="_graphics_8h_1aad0766ae2eda7ded12984d0061f1da89">graphics_draw_line</link> (const int graphics_stack_id, GLuint a, GLuint b)</para>
<para>Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. </para>
</listitem>
<listitem><para>void <link linkend="_graphics_8h_1afb83b572ba51cecca0db17db6d046546">graphics_draw_plan</link> (const int graphics_stack_id, GLuint a, GLuint b, GLuint c)</para>
<para>Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. </para>
</listitem>
<listitem><para>void <link linkend="_graphics_8h_1a2be40f60f1a100f87730178ea20a5b6f">graphics_draw_color</link> (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)</para>
<para>Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. </para>
</listitem>
<listitem><para>void <link linkend="_graphics_8h_1a76f5c593f1d55ebbc838437d9240ad8a">graphics_model_setup</link> (const int graphics_stack_id)</para>
<para>TODO #pragma omp parallel schedule(static, 12) void <emphasis role="bold">attribute</emphasis>((optimize(&quot;no-unroll-loops&quot;))) main_test_graphics (void) {}. </para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1a9f1525659a25e5f22f6f864f77df0394"/>int <emphasis role="strong">graphics_draw_one_arrow_vertex</emphasis> (const int graphics_stack_id, int space_X, int space_Y, int space_Z, int weight, int site, int x, int y, int z)</para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1ac5b64ca813b8230a386db3f197773839"/>int <emphasis role="strong">graphics_draw_one_arrow_line</emphasis> (const int graphics_stack_id, int offset_vertex)</para>
</listitem>
<listitem><para>int <link linkend="_graphics_8h_1a79778df22a59f6bdfb2ef1be40999988">graphics_draw_space_ridges_vertex</link> (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</para>
<para>Writes grid ridges to vertex and color buffers. </para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1ae06bc782cdd144a15166e1a3087ca07c"/>int <emphasis role="strong">graphics_draw_space_ridges_lines</emphasis> (const int graphics_stack_id)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>long <link linkend="_graphics_8h_1aa0e0b868182a402d520d3443909bd40b">graphics_draw_grids_on_space_faces_vertex</link> (const int graphics_stack_id, long x, long y, long z)</para>
<para>Writes grid lines on space faces. </para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1a4b522c9dc5b1ba15444956adb1c08cf5"/>long <emphasis role="strong">graphics_draw_grids_on_space_faces_lines</emphasis> (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1a6a8069bea50642d8e4d582194cf7c014"/>int <emphasis role="strong">graphics_set_arrow</emphasis> (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Variables </title>
<itemizedlist>
<listitem><para>struct <link linkend="_structgraphics__stack__t">graphics_stack_t</link> * <link linkend="_graphics_8h_1ad2cd7fe4849c259e9dedcc6e7e795aaf">graphics_stack</link></para>
<para>Dynamic array of ptrs to dynamically allocated gl_area_entry. </para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>graphics header </para>
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_graphics_8h_1a66c9c80dbf46ac2168827bf8a0dfb7ee"/><section>
<title>graphics_draw()</title>
<indexterm><primary>graphics_draw</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw</secondary></indexterm>
<para><computeroutput>void graphics_draw (const int stack_id)</computeroutput></para><para>
<para>Draws the current buffer to a gl_area. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1a2be40f60f1a100f87730178ea20a5b6f"/><section>
<title>graphics_draw_color()</title>
<indexterm><primary>graphics_draw_color</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_color</secondary></indexterm>
<para><computeroutput>void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b)</computeroutput></para><para>
<para>Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>GLfloat</entry><entry>
<para>r, GLfloat g, GLfloat b</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void</para>
</formalpara>
Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>color</entry><entry>
<para>GLfloat(r,g,b)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1aa0e0b868182a402d520d3443909bd40b"/><section>
<title>graphics_draw_grids_on_space_faces_vertex()</title>
<indexterm><primary>graphics_draw_grids_on_space_faces_vertex</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_grids_on_space_faces_vertex</secondary></indexterm>
<para><computeroutput>long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z)</computeroutput></para><para>
<para>Writes grid lines on space faces. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>long (x,y,z)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void</para>
</formalpara>
Writes grid lines on space faces. </para>
</section>
<anchor xml:id="_graphics_8h_1aad0766ae2eda7ded12984d0061f1da89"/><section>
<title>graphics_draw_line()</title>
<indexterm><primary>graphics_draw_line</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_line</secondary></indexterm>
<para><computeroutput>void graphics_draw_line (const int stack_id, GLuint a, GLuint b)</computeroutput></para><para>
<para>Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. </para>
</para>
<para>Writes values to describe a line from a to b into the line buffer.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>GLfloat</entry><entry>
<para>r, GLfloat g, GLfloat b</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void Writes values to describe a line from a to b into the line buffer</para>
</formalpara>
@use liste de fonctions GTK</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>GLuint (a,b)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void</para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>GLuint (a,b)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void</para>
</formalpara>
Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>GLuint (a,b)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1afb83b572ba51cecca0db17db6d046546"/><section>
<title>graphics_draw_plan()</title>
<indexterm><primary>graphics_draw_plan</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_plan</secondary></indexterm>
<para><computeroutput>void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c)</computeroutput></para><para>
<para>Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>GLuint (a,b,c)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1a79778df22a59f6bdfb2ef1be40999988"/><section>
<title>graphics_draw_space_ridges_vertex()</title>
<indexterm><primary>graphics_draw_space_ridges_vertex</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_space_ridges_vertex</secondary></indexterm>
<para><computeroutput>int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z)</computeroutput></para><para>
<para>Writes grid ridges to vertex and color buffers. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>long (x,y,z), step_x, step_y, step_z</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void</para>
</formalpara>
Writes grid ridges to vertex and color buffers. </para>
</section>
<anchor xml:id="_graphics_8h_1aa2c4ec98f5bf9942092ff385e9fac72f"/><section>
<title>graphics_draw_vertex()</title>
<indexterm><primary>graphics_draw_vertex</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_vertex</secondary></indexterm>
<para><computeroutput>void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z)</computeroutput></para><para>
<para>Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>GLfloat</entry><entry>
<para>x, GLfloat y, GLfloat z</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void</para>
</formalpara>
Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>GLfloat(x,y,z)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1a5a4ed7438a755777b162fc37e84ba93a"/><section>
<title>graphics_init()</title>
<indexterm><primary>graphics_init</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_init</secondary></indexterm>
<para><computeroutput>int graphics_init (void * error_buffer)</computeroutput></para><para>
<para>Initializes a gl_area. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>true if initialized</para>
</formalpara>
Initializes a gl_area.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>id if initialized </para>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1aa86924f99e2a17fcb4e33b22b8987a95"/><section>
<title>graphics_init_buffers()</title>
<indexterm><primary>graphics_init_buffers</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_init_buffers</secondary></indexterm>
<para><computeroutput>void graphics_init_buffers (const int stack_id)</computeroutput></para><para>
<para>Initializes the buffer of a gl_area Calls according to the user preferences. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget </para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1ac5ba153022c8589d2cd83442197e163e"/><section>
<title>graphics_init_shaders()</title>
<indexterm><primary>graphics_init_shaders</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_init_shaders</secondary></indexterm>
<para><computeroutput>bool graphics_init_shaders (const int stack_id)</computeroutput></para><para>
<para>Initializes the shaders of a gl_area and link them to a program. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>true if initialized </para>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1a76f5c593f1d55ebbc838437d9240ad8a"/><section>
<title>graphics_model_setup()</title>
<indexterm><primary>graphics_model_setup</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_model_setup</secondary></indexterm>
<para><computeroutput>void graphics_model_setup (const int stack_id)</computeroutput></para><para>
<para>TODO #pragma omp parallel schedule(static, 12) void <emphasis role="bold">attribute</emphasis>((optimize(&quot;no-unroll-loops&quot;))) main_test_graphics (void) {}. </para>
</para>
<para>assert : space dimensions (x,y,z) &gt; 0 assert : arrows localization within space and sites assert : no more than one arrow per address notify : weights are replaced, NOT added (could be !)</para>
<para>Init space and arrows (= initial state) and allows ulterior creations, suppressions or modifications of the arrows[] array</para>
<para>draws the space() triggers graphics_set_arrows() that modifies the list () and draws arrows</para>
<para>Initialisation du générateur pseudo-aléatoire Attention, les vertex centraux de chaque unité d&apos;espace (cube) peuvent être redondants (max 6) </para>
</section>
<anchor xml:id="_graphics_8h_1ae99e9cf190970a730fdb3d8df8682188"/><section>
<title>graphics_shutdown()</title>
<indexterm><primary>graphics_shutdown</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_shutdown</secondary></indexterm>
<para><computeroutput>bool graphics_shutdown (const int id, void * error_buffer)</computeroutput></para><para>
<para>Draws the current buffer to a gl_area. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void Shutdowns a gl_area</para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>true if success</para>
</formalpara>
Draws the current buffer to a gl_area.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>true if success </para>
</formalpara>
</para>
</section>
</section>
<section>
<title>Variable Documentation</title>
<anchor xml:id="_graphics_8h_1ad2cd7fe4849c259e9dedcc6e7e795aaf"/><section>
<title>graphics_stack</title>
<indexterm><primary>graphics_stack</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_stack</secondary></indexterm>
<para><computeroutput>struct <link linkend="_structgraphics__stack__t">graphics_stack_t</link>* graphics_stack<computeroutput>[extern]</computeroutput></computeroutput></para><para>
<para>Dynamic array of ptrs to dynamically allocated gl_area_entry. </para>
</para>
<para>Dynamic array of ptrs to dynamically allocated gl_area_entry. </para>
</section>
</section>
</section>

View File

@ -115,5 +115,5 @@
</section> </section>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/fsm.h</section> include/<link linkend="_fsm_8h">fsm.h</link></section>
</section> </section>

View File

@ -0,0 +1,242 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_init_8c" xml:lang="en-US">
<title>src/graphics/init.c File Reference</title>
<indexterm><primary>src/graphics/init.c</primary></indexterm>
<para>
<para>graphics - initialization and graphic stack management </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/graphics.h&quot;<?linebreak?>#include &quot;../../include/parse.h&quot;<?linebreak?>#include &quot;../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
<title>Macros </title>
<itemizedlist>
<listitem><para><anchor xml:id="_init_8c_1ab946e2e7f7679350627acfded8e2658b"/>#define <emphasis role="strong">TEST</emphasis>&#160;&#160;&#160;0</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>int <link linkend="_init_8c_1a5a4ed7438a755777b162fc37e84ba93a">graphics_init</link> (void *error_buffer)</para>
<para>Initializes graphical stack. </para>
</listitem>
<listitem><para>bool <link linkend="_init_8c_1aa4d80f7ee104aa414e7ed4b90e0eac88">graphics_shutdown</link> (const int id, void *error_buffer)</para>
<para>Shutdowns a gl_area. </para>
</listitem>
<listitem><para>void <link linkend="_init_8c_1a6b097df849779455e6f57d84a7037919">graphics_model_setup</link> (const int stack_id)</para>
<para>TODO #pragma omp parallel schedule(static, 12) void <emphasis role="bold">attribute</emphasis>((optimize(&quot;no-unroll-loops&quot;))) main_test_graphics (void) {}. </para>
</listitem>
<listitem><para>void <link linkend="_init_8c_1a17560cb73e3b25c1e6fbeae088867d0f">graphics_init_buffers</link> (const int stack_id)</para>
<para>Initializes the buffer of a gl_area Calls according to the user preferences. </para>
</listitem>
<listitem><para>bool <link linkend="_init_8c_1a4ae8809ed73e91b6a20bcfdd94f4c23d">graphics_init_shaders</link> (const int stack_id)</para>
<para>Initializes the shaders of a gl_area and link them to a program. </para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Variables </title>
<itemizedlist>
<listitem><para>struct <link linkend="_structgraphics__stack__t">graphics_stack_t</link> * <link linkend="_init_8c_1ad2cd7fe4849c259e9dedcc6e7e795aaf">graphics_stack</link> = NULL</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_init_8c_1a86ecb95bf1c1a30d42b02f6811b83e4c"/>size_t <emphasis role="strong">graphics_stack_size</emphasis> = 0</para>
</listitem>
<listitem><para><anchor xml:id="_init_8c_1a7e77f440f52c90c921a5bdc003c3b03b"/>int * <emphasis role="strong">free_stack_slot</emphasis> = NULL</para>
</listitem>
<listitem><para><anchor xml:id="_init_8c_1a29d09eb6569a8bfc0439eac245102077"/>size_t <emphasis role="strong">free_stack_slot_size</emphasis> = 0</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>graphics - initialization and graphic stack management </para>
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_init_8c_1a5a4ed7438a755777b162fc37e84ba93a"/><section>
<title>graphics_init()</title>
<indexterm><primary>graphics_init</primary><secondary>init.c</secondary></indexterm>
<indexterm><primary>init.c</primary><secondary>graphics_init</secondary></indexterm>
<para><computeroutput>int graphics_init (void * error_buffer)</computeroutput></para><para>
<para>Initializes graphical stack. </para>
</para>
<para>Initializes a gl_area.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>id if initialized </para>
</formalpara>
</para>
</section>
<anchor xml:id="_init_8c_1a17560cb73e3b25c1e6fbeae088867d0f"/><section>
<title>graphics_init_buffers()</title>
<indexterm><primary>graphics_init_buffers</primary><secondary>init.c</secondary></indexterm>
<indexterm><primary>init.c</primary><secondary>graphics_init_buffers</secondary></indexterm>
<para><computeroutput>void graphics_init_buffers (const int stack_id)</computeroutput></para><para>
<para>Initializes the buffer of a gl_area Calls according to the user preferences. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget </para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>void </para>
</formalpara>
</para>
</section>
<anchor xml:id="_init_8c_1a4ae8809ed73e91b6a20bcfdd94f4c23d"/><section>
<title>graphics_init_shaders()</title>
<indexterm><primary>graphics_init_shaders</primary><secondary>init.c</secondary></indexterm>
<indexterm><primary>init.c</primary><secondary>graphics_init_shaders</secondary></indexterm>
<para><computeroutput>bool graphics_init_shaders (const int stack_id)</computeroutput></para><para>
<para>Initializes the shaders of a gl_area and link them to a program. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>true if initialized </para>
</formalpara>
</para>
</section>
<anchor xml:id="_init_8c_1a6b097df849779455e6f57d84a7037919"/><section>
<title>graphics_model_setup()</title>
<indexterm><primary>graphics_model_setup</primary><secondary>init.c</secondary></indexterm>
<indexterm><primary>init.c</primary><secondary>graphics_model_setup</secondary></indexterm>
<para><computeroutput>void graphics_model_setup (const int stack_id)</computeroutput></para><para>
<para>TODO #pragma omp parallel schedule(static, 12) void <emphasis role="bold">attribute</emphasis>((optimize(&quot;no-unroll-loops&quot;))) main_test_graphics (void) {}. </para>
</para>
<para>assert : space dimensions (x,y,z) &gt; 0 assert : arrows localization within space and sites assert : no more than one arrow per address notify : weights are replaced, NOT added (could be !)</para>
<para>Init space and arrows (= initial state) and allows ulterior creations, suppressions or modifications of the arrows[] array</para>
<para>draws the space() triggers graphics_set_arrows() that modifies the list () and draws arrows</para>
<para>Initialisation du générateur pseudo-aléatoire Attention, les vertex centraux de chaque unité d&apos;espace (cube) peuvent être redondants (max 6) </para>
</section>
<anchor xml:id="_init_8c_1aa4d80f7ee104aa414e7ed4b90e0eac88"/><section>
<title>graphics_shutdown()</title>
<indexterm><primary>graphics_shutdown</primary><secondary>init.c</secondary></indexterm>
<indexterm><primary>init.c</primary><secondary>graphics_shutdown</secondary></indexterm>
<para><computeroutput>bool graphics_shutdown (const int id, void * error_buffer)</computeroutput></para><para>
<para>Shutdowns a gl_area. </para>
</para>
<para>Draws the current buffer to a gl_area.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>true if success </para>
</formalpara>
</para>
</section>
</section>
<section>
<title>Variable Documentation</title>
<anchor xml:id="_init_8c_1ad2cd7fe4849c259e9dedcc6e7e795aaf"/><section>
<title>graphics_stack</title>
<indexterm><primary>graphics_stack</primary><secondary>init.c</secondary></indexterm>
<indexterm><primary>init.c</primary><secondary>graphics_stack</secondary></indexterm>
<para><computeroutput>struct <link linkend="_structgraphics__stack__t">graphics_stack_t</link>* graphics_stack = NULL</computeroutput></para><para>
<para>phantom documentation used to test the functioning of doxygen </para>
</para>
<para>Dynamic array of ptrs to dynamically allocated gl_area_entry. </para>
</section>
</section>
</section>

View File

@ -0,0 +1,927 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_signal_8c" xml:lang="en-US">
<title>src/signal.c File Reference</title>
<indexterm><primary>src/signal.c</primary></indexterm>
<para>
<para>events management functions </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../include/fsm.h&quot;<?linebreak?>#include &quot;../include/signal.h&quot;<?linebreak?>#include &quot;../include/widget.h&quot;<?linebreak?>#include &quot;../include/graphics.h&quot;<?linebreak?>#include &quot;../include/util.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_signal_8c_1a4de6cc717f212c44ff4c053fee3071c8"/>void <emphasis role="strong">on_setup_user_tree_factory</emphasis> (GtkSignalListItemFactory *factory, GObject *object, gpointer user_data)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a7713720f05623b42929ad7c43292c559">on_bind_user_tree_factory</link> (GtkSignalListItemFactory *factory, GObject *object, gpointer user_data)</para>
</listitem>
<listitem><para>gboolean <link linkend="_signal_8c_1a9a847597ed5df8246f5cf155f7bdff5d">on_glarea_render</link> (GtkGLArea *area, GdkGLContext *context)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1ad1d3eacfd74456a35e08571269a28606">on_glarea_realize</link> (GtkWidget *widget)</para>
<para>We need to set up our state when we realize the GtkGLArea widget. </para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a7a4f6bb06fcf023d79c10df197916633">on_glarea_unrealize</link> (GtkWidget *widget)</para>
<para>We should tear down the state when unrealizing. </para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a2e600446643f328f22d6f43edb06912e">on_axis_value_change</link> (GtkAdjustment *adjustment, gpointer data)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a907b564037150dae69515b0302c4bbfc">on_save_current_model_before_editing</link> (GtkWidget *btt_save_current_model, gpointer data)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1ad20d43cb23d3f840a1951af4ce8ad342">on_discard_current_model_before_editing</link> (GtkWidget *btt_discard_current_model, gpointer data)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a0d68e19e1a3b8d29e8fe31b0be86cf2c">on_write_current_model</link> (GtkWidget *btt_write_current_model, gpointer data)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1af76dc7bf1ffa831f87eff0793960d343">on_toggle_exec_edit</link> (GtkWidget *toggled_button, gpointer user_data)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1acfb2dd4191445aed65fdcbb5e5c14602">on_toggle_state_rules_data</link> (GtkWidget *toggled_button, gpointer widget_all_vs_selected_one)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a9711ba5647a03f97f5966f3fd4b6b487">on_clicked_topbar_right_search</link> (GtkWidget *btt_menu, gpointer list_box)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1ae9ca59f2c0ec40e1e9df7c11f5f9be2d">on_clicked_topbar_right_home</link> (GtkWidget *btt_reset, gpointer data)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a30c0f130fa49eeb277242432f06d4228">on_updating_objects_transparencies</link> (GtkWidget *btt_source, GtkScrollbar *scrollbar)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1ac6bc723922324fe4a8d9a0018540e0a0">on_resetting_XYZ_in_state_page</link> ()</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1aa3b372e170d71c2e7407fb84582b5c3a">on_situations_box_do_reset</link> (GtkWidget *btt_reset, GtkScrollbar *reset_scrollbar)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1adb54483434a33ae6b3931a46790d8bc5">on_topbar_right_measure_clicked</link> (GtkWidget *btt, gpointer button_icon_name)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a77c7dca1c95d910db8f14da1fb821e55">on_start_new_measure</link> (GtkWidget *btt, gpointer btt_label)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1ab4791f0216de23e786aade3e5fed43bc">on_select_rules_first</link> (GtkWidget *btt, gpointer data)</para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1a07be68251cce7123f61aaa5f27b3fa5b"/>void <emphasis role="strong">on_measure_depends_on_a_single_event</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1afa830d2a82c0eb427f8c733eda6c7b0a"/>void <emphasis role="strong">on_measure_depends_on_two_events</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1a1970833b4a2f7c3b24416ad964c4eb26"/>void <emphasis role="strong">on_select_a_second_rules_set</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1a368e6653e9df774f4872a7f3ab5ab19a"/>void <emphasis role="strong">on_select_a_second_measurement</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1a8e5ca8011055245149af845efdd10976"/>void <emphasis role="strong">on_skip_this_step</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1af808c53ab0121f3c0abae58eaa684192"/>void <emphasis role="strong">on_something_else</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1a9779561942b0f292202136b97db809d7"/>void <emphasis role="strong">on_closing_page</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1adcfb47d20be32465d1d73325e69228c6"/>void <emphasis role="strong">on_measure_single_event_occurences_nb</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1ab8d3ebe620af28672451ae4b2ae8d5c1"/>void <emphasis role="strong">on_measure_single_event_occurences_dates</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1affe188c8a1d4b14305f831347fcae267"/>void <emphasis role="strong">on_measure_single_event_occurences_situations</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1abd567190e74306b4938b62d97bb5b2c6"/>void <emphasis role="strong">on_measure_time_elapsed_between_two_events</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_signal_8c_1a44757f4bc445698156ade5d28a9b097a"/>void <emphasis role="strong">on_measure_third_event_occurences_in_between</emphasis> (GtkWidget *btt, gpointer data)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a21debeec500228e967f05cdfff41f20a">on_entry_name_insert_after</link> (GtkWidget *entry, gpointer data)</para>
</listitem>
<listitem><para>void <link linkend="_signal_8c_1a5a55cab3bb796786ea0d56f1eed579e4">on_entry_name_delete_after</link> (GtkWidget *entry, gpointer data)</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>events management functions </para>
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_signal_8c_1a2e600446643f328f22d6f43edb06912e"/><section>
<title>on_axis_value_change()</title>
<indexterm><primary>on_axis_value_change</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_axis_value_change</secondary></indexterm>
<para><computeroutput>void on_axis_value_change (GtkAdjustment * adjustment, gpointer data)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1a7713720f05623b42929ad7c43292c559"/><section>
<title>on_bind_user_tree_factory()</title>
<indexterm><primary>on_bind_user_tree_factory</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_bind_user_tree_factory</secondary></indexterm>
<para><computeroutput>void on_bind_user_tree_factory (GtkSignalListItemFactory * factory, GObject * object, gpointer user_data)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1ae9ca59f2c0ec40e1e9df7c11f5f9be2d"/><section>
<title>on_clicked_topbar_right_home()</title>
<indexterm><primary>on_clicked_topbar_right_home</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_clicked_topbar_right_home</secondary></indexterm>
<para><computeroutput>void on_clicked_topbar_right_home (GtkWidget * btt_reset, gpointer data)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1a9711ba5647a03f97f5966f3fd4b6b487"/><section>
<title>on_clicked_topbar_right_search()</title>
<indexterm><primary>on_clicked_topbar_right_search</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_clicked_topbar_right_search</secondary></indexterm>
<para><computeroutput>void on_clicked_topbar_right_search (GtkWidget * btt_menu, gpointer list_box)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1ad20d43cb23d3f840a1951af4ce8ad342"/><section>
<title>on_discard_current_model_before_editing()</title>
<indexterm><primary>on_discard_current_model_before_editing</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_discard_current_model_before_editing</secondary></indexterm>
<para><computeroutput>void on_discard_current_model_before_editing (GtkWidget * btt_discard_current_model, gpointer data)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1a5a55cab3bb796786ea0d56f1eed579e4"/><section>
<title>on_entry_name_delete_after()</title>
<indexterm><primary>on_entry_name_delete_after</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_entry_name_delete_after</secondary></indexterm>
<para><computeroutput>void on_entry_name_delete_after (GtkWidget * entry, gpointer data)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1a21debeec500228e967f05cdfff41f20a"/><section>
<title>on_entry_name_insert_after()</title>
<indexterm><primary>on_entry_name_insert_after</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_entry_name_insert_after</secondary></indexterm>
<para><computeroutput>void on_entry_name_insert_after (GtkWidget * entry, gpointer data)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1ad1d3eacfd74456a35e08571269a28606"/><section>
<title>on_glarea_realize()</title>
<indexterm><primary>on_glarea_realize</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_glarea_realize</secondary></indexterm>
<para><computeroutput>void on_glarea_realize (GtkWidget * widget)</computeroutput></para><para>
<para>We need to set up our state when we realize the GtkGLArea widget. </para>
</para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1a9a847597ed5df8246f5cf155f7bdff5d"/><section>
<title>on_glarea_render()</title>
<indexterm><primary>on_glarea_render</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_glarea_render</secondary></indexterm>
<para><computeroutput>gboolean on_glarea_render (GtkGLArea * area, GdkGLContext * context)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1a7a4f6bb06fcf023d79c10df197916633"/><section>
<title>on_glarea_unrealize()</title>
<indexterm><primary>on_glarea_unrealize</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_glarea_unrealize</secondary></indexterm>
<para><computeroutput>void on_glarea_unrealize (GtkWidget * widget)</computeroutput></para><para>
<para>We should tear down the state when unrealizing. </para>
</para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1ac6bc723922324fe4a8d9a0018540e0a0"/><section>
<title>on_resetting_XYZ_in_state_page()</title>
<indexterm><primary>on_resetting_XYZ_in_state_page</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_resetting_XYZ_in_state_page</secondary></indexterm>
<para><computeroutput>void on_resetting_XYZ_in_state_page ( )</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1a907b564037150dae69515b0302c4bbfc"/><section>
<title>on_save_current_model_before_editing()</title>
<indexterm><primary>on_save_current_model_before_editing</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_save_current_model_before_editing</secondary></indexterm>
<para><computeroutput>void on_save_current_model_before_editing (GtkWidget * btt_save_current_model, gpointer data)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1ab4791f0216de23e786aade3e5fed43bc"/><section>
<title>on_select_rules_first()</title>
<indexterm><primary>on_select_rules_first</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_select_rules_first</secondary></indexterm>
<para><computeroutput>void on_select_rules_first (GtkWidget * btt, gpointer data)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1aa3b372e170d71c2e7407fb84582b5c3a"/><section>
<title>on_situations_box_do_reset()</title>
<indexterm><primary>on_situations_box_do_reset</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_situations_box_do_reset</secondary></indexterm>
<para><computeroutput>void on_situations_box_do_reset (GtkWidget * btt_reset, GtkScrollbar * reset_scrollbar)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1a77c7dca1c95d910db8f14da1fb821e55"/><section>
<title>on_start_new_measure()</title>
<indexterm><primary>on_start_new_measure</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_start_new_measure</secondary></indexterm>
<para><computeroutput>void on_start_new_measure (GtkWidget * btt, gpointer btt_label)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1af76dc7bf1ffa831f87eff0793960d343"/><section>
<title>on_toggle_exec_edit()</title>
<indexterm><primary>on_toggle_exec_edit</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_toggle_exec_edit</secondary></indexterm>
<para><computeroutput>void on_toggle_exec_edit (GtkWidget * toggled_button, gpointer user_data)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1acfb2dd4191445aed65fdcbb5e5c14602"/><section>
<title>on_toggle_state_rules_data()</title>
<indexterm><primary>on_toggle_state_rules_data</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_toggle_state_rules_data</secondary></indexterm>
<para><computeroutput>void on_toggle_state_rules_data (GtkWidget * toggled_button, gpointer widget_all_vs_selected_one)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1adb54483434a33ae6b3931a46790d8bc5"/><section>
<title>on_topbar_right_measure_clicked()</title>
<indexterm><primary>on_topbar_right_measure_clicked</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_topbar_right_measure_clicked</secondary></indexterm>
<para><computeroutput>void on_topbar_right_measure_clicked (GtkWidget * btt, gpointer button_icon_name)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1a30c0f130fa49eeb277242432f06d4228"/><section>
<title>on_updating_objects_transparencies()</title>
<indexterm><primary>on_updating_objects_transparencies</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_updating_objects_transparencies</secondary></indexterm>
<para><computeroutput>void on_updating_objects_transparencies (GtkWidget * btt_source, GtkScrollbar * scrollbar)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
<anchor xml:id="_signal_8c_1a0d68e19e1a3b8d29e8fe31b0be86cf2c"/><section>
<title>on_write_current_model()</title>
<indexterm><primary>on_write_current_model</primary><secondary>signal.c</secondary></indexterm>
<indexterm><primary>signal.c</primary><secondary>on_write_current_model</secondary></indexterm>
<para><computeroutput>void on_write_current_model (GtkWidget * btt_write_current_model, gpointer data)</computeroutput></para>
<para><formalpara><title>Date</title>
<para></para>
</formalpara>
<formalpara><title>Author</title>
<para></para>
</formalpara>
<formalpara><title>See also</title>
<para></para>
<para></para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
return </para>
</section>
</section>
</section>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,386 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_util_8h" xml:lang="en-US">
<title>include/util.h File Reference</title>
<indexterm><primary>include/util.h</primary></indexterm>
<para>
<para>utilities header </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stddef.h&gt;<?linebreak?>#include &lt;gtk-4.0/gtk/gtk.h&gt;<?linebreak?>#include &quot;../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
<title>Classes </title>
<itemizedlist>
<listitem><para>struct <link linkend="_structpile">pile</link></para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>struct <link linkend="_structelem">elem</link></para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>struct <link linkend="_structdblist">dblist</link></para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>struct <link linkend="_structslist">slist</link></para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Typedefs </title>
<itemizedlist>
<listitem><para><anchor xml:id="_util_8h_1a8b1be516cd670e3808f29fa7576017db"/>typedef struct <link linkend="_structpile">pile</link> <emphasis role="strong">pile</emphasis></para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a03f28ef452dbb87c629a2b39da6fc63c"/>typedef struct <link linkend="_structelem">elem</link> <emphasis role="strong">elem</emphasis></para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a6f169a5dcb2ec0f7ab8120292cf14d9e"/>typedef struct <link linkend="_structslist">slist</link> <emphasis role="strong">slist</emphasis></para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_util_8h_1a40bb126a021a338b20022e741bbd4ae1"/>char * <emphasis role="strong">util_read_file</emphasis> (char *filename)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a7a9bfe2d249e5da19a1117c7d5636b8a"/>char * <emphasis role="strong">util_concat</emphasis> (const char *str,...)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a87a9dcc9beba6b65e30ce4294c20713d"/>void <emphasis role="strong">util_pile_clear</emphasis> (<link linkend="_structpile">pile</link> **)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1afbc42bf42f66e0aa969de04212c4e07a"/>void <emphasis role="strong">util_pile_view</emphasis> (<link linkend="_structpile">pile</link> *)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1ae6f16aafebd809c62cacd9abc3892925"/>int <emphasis role="strong">util_pile_push</emphasis> (<link linkend="_structpile">pile</link> **, int)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a121e2ed13ed9448f33173ebaefba3679"/>int <emphasis role="strong">util_pile_pop</emphasis> (<link linkend="_structpile">pile</link> **)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1afbb61183d866a834bdf9cae2be6c84f5"/>int <emphasis role="strong">util_pile_length</emphasis> (<link linkend="_structpile">pile</link> *p)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a3133311b2fe84f2d9745f67f2cc02bd3"/>void <emphasis role="strong">util_list_2x2_init</emphasis> (<link linkend="_structdblist">dblist</link> *l)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1abfc7d5a8fff1bd14f16a501ee1755349"/>void <emphasis role="strong">util_list_2x2_clear</emphasis> (<link linkend="_structdblist">dblist</link> *l)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1aad019969171d29bf58df2740fe15d738"/>void <emphasis role="strong">util_list_2x2_view</emphasis> (<link linkend="_structdblist">dblist</link> l)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1ae173600429156cca4e5755d5aa628b81"/>int <emphasis role="strong">util_list_2x2_push_back</emphasis> (<link linkend="_structdblist">dblist</link> *l, int val)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a41d729a609f850d89a40e161c4cf189d"/>int <emphasis role="strong">util_list_2x2_push_front</emphasis> (<link linkend="_structdblist">dblist</link> *l, int val)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a275a40c54b4c7ec73191a4ed1aba4936"/>int <emphasis role="strong">util_list_2x2_pop_back</emphasis> (<link linkend="_structdblist">dblist</link> *l)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a838636447589eb073de9b8a0f20346d5"/>int <emphasis role="strong">util_list_2x2_pop_front</emphasis> (<link linkend="_structdblist">dblist</link> *l)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1ae764753e3beb9811561b0ced2a625981"/>int <emphasis role="strong">util_list_2x2_length</emphasis> (<link linkend="_structdblist">dblist</link> l)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a1133cba5111479ea7d7c4a79778560e1"/>void <emphasis role="strong">util_sorted_list_clear</emphasis> (<link linkend="_structslist">slist</link> **sl)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a87a5b344dd2c0ea1af5d36ea67b12517"/>void <emphasis role="strong">util_sorted_list_view</emphasis> (<link linkend="_structslist">slist</link> *sl)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1ad75bea7d8dfb1dad20cd99a92a045f19"/>int <emphasis role="strong">util_sorted_list_insert</emphasis> (<link linkend="_structslist">slist</link> **sl, int val)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1aee1f73cdb28ee531042c9f84875d3e5f"/>int <emphasis role="strong">util_sorted_list_pop</emphasis> (<link linkend="_structslist">slist</link> **sl)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a35eb9fbef7ed4d3e9dc93f74d0e9934a"/>int <emphasis role="strong">util_sorted_list_length</emphasis> (<link linkend="_structslist">slist</link> *sl)</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1aaa9fc96cf3047e5a323156c7f500d5fb"/>void <emphasis role="strong">util_trigger_test</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a05aec803518f49ffdeff1db6045a6652"/>void <emphasis role="strong">util_test_pile</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a2237b720be9f32414c3caccc1bec0d97"/>void <emphasis role="strong">util_test_double_list</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a94626d7f8c95811287f249c2db85448f"/>void <emphasis role="strong">util_test_sorted_list</emphasis> ()</para>
</listitem>
<listitem><para>long <link linkend="_util_8h_1adbe03a3d239b22390e9de809443c8df9">util_gl_get_stack</link> (void *container_widget)</para>
<para>Look for stack entry and returns stack_id. </para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a133e79c96135a44a4d4df48051aafbef"/>long <emphasis role="strong">util_gl_is_util_ready</emphasis> (void *container_widget)</para>
</listitem>
<listitem><para>bool <link linkend="_util_8h_1a28b44187c7ae713705874288323e10a6">util_gl_init_stack</link> (void *container_widget, GError *error_buffer)</para>
<para>Look for stack entry and initializes OpenGL for it. </para>
</listitem>
<listitem><para>bool <link linkend="_util_8h_1a9d41985e1832e0a798e722d2341752f1">util_gl_shutdown_stack</link> (void *container_widget, GError *error_buffer)</para>
<para>Look for stack entry and shutdowns OpenGL for it. </para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1ab0a523986944f809fac9acc1693f3029"/>void <emphasis role="strong">util_gl_clean_stack_index</emphasis> (void)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>bool <link linkend="_util_8h_1a8132a1a797f4f12eaff04b4c3610f054">util_gl_render_stack</link> (GtkWidget *container_widget)</para>
<para>Look for stack entry and triggers OpenGL for drawing. </para>
</listitem>
<listitem><para>bool <link linkend="_util_8h_1ad830e66002a24806e3617946dc988e95">util_gl_update_axis</link> (GtkWidget *container_widget, int axis, int value)</para>
<para>Look for stack entry and triggers OpenGL for drawing. </para>
</listitem>
<listitem><para>void <link linkend="_util_8h_1ae2198c050662c486c8e66c6e6b5a7e0b">util_gl_shutdown_all_stacks</link> (void)</para>
<para>Look for every stack entry and shutdowns OpenGL for it. </para>
</listitem>
<listitem><para>GtkWidget * <link linkend="_util_8h_1a2cb205bd6556250d019b4de59eee3894">create_axis_slider</link> (int axis)</para>
<para>Creates a slider widget. </para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>utilities header </para>
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_util_8h_1a2cb205bd6556250d019b4de59eee3894"/><section>
<title>create_axis_slider()</title>
<indexterm><primary>create_axis_slider</primary><secondary>util.h</secondary></indexterm>
<indexterm><primary>util.h</primary><secondary>create_axis_slider</secondary></indexterm>
<para><computeroutput>GtkWidget * create_axis_slider (int axis)</computeroutput></para><para>
<para>Creates a slider widget. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>axis</entry><entry>
<para>the axis we&apos;re building a label for</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>GtkWidget*: pointer to the new widget </para>
</formalpara>
</para>
</section>
<anchor xml:id="_util_8h_1adbe03a3d239b22390e9de809443c8df9"/><section>
<title>util_gl_get_stack()</title>
<indexterm><primary>util_gl_get_stack</primary><secondary>util.h</secondary></indexterm>
<indexterm><primary>util.h</primary><secondary>util_gl_get_stack</secondary></indexterm>
<para><computeroutput>long util_gl_get_stack (void * container_widget)</computeroutput></para><para>
<para>Look for stack entry and returns stack_id. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>stack_id </para>
</formalpara>
</para>
</section>
<anchor xml:id="_util_8h_1a28b44187c7ae713705874288323e10a6"/><section>
<title>util_gl_init_stack()</title>
<indexterm><primary>util_gl_init_stack</primary><secondary>util.h</secondary></indexterm>
<indexterm><primary>util.h</primary><secondary>util_gl_init_stack</secondary></indexterm>
<para><computeroutput>bool util_gl_init_stack (void * container_widget, GError * error_buffer)</computeroutput></para><para>
<para>Look for stack entry and initializes OpenGL for it. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea </para>
</entry>
</row>
<row>
<entry>error_buffer</entry><entry>
<para>phantom documentation used to test the functioning of doxygen</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>bool: true if success </para>
</formalpara>
</para>
</section>
<anchor xml:id="_util_8h_1a8132a1a797f4f12eaff04b4c3610f054"/><section>
<title>util_gl_render_stack()</title>
<indexterm><primary>util_gl_render_stack</primary><secondary>util.h</secondary></indexterm>
<indexterm><primary>util.h</primary><secondary>util_gl_render_stack</secondary></indexterm>
<para><computeroutput>bool util_gl_render_stack (GtkWidget * container_widget)</computeroutput></para><para>
<para>Look for stack entry and triggers OpenGL for drawing. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>bool: true if success </para>
</formalpara>
</para>
</section>
<anchor xml:id="_util_8h_1ae2198c050662c486c8e66c6e6b5a7e0b"/><section>
<title>util_gl_shutdown_all_stacks()</title>
<indexterm><primary>util_gl_shutdown_all_stacks</primary><secondary>util.h</secondary></indexterm>
<indexterm><primary>util.h</primary><secondary>util_gl_shutdown_all_stacks</secondary></indexterm>
<para><computeroutput>void util_gl_shutdown_all_stacks (void )</computeroutput></para><para>
<para>Look for every stack entry and shutdowns OpenGL for it. </para>
</para>
<para>returns true if success ? TODO why not bool ? </para>
</section>
<anchor xml:id="_util_8h_1a9d41985e1832e0a798e722d2341752f1"/><section>
<title>util_gl_shutdown_stack()</title>
<indexterm><primary>util_gl_shutdown_stack</primary><secondary>util.h</secondary></indexterm>
<indexterm><primary>util.h</primary><secondary>util_gl_shutdown_stack</secondary></indexterm>
<para><computeroutput>bool util_gl_shutdown_stack (void * container_widget, GError * error_buffer)</computeroutput></para><para>
<para>Look for stack entry and shutdowns OpenGL for it. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea </para>
</entry>
</row>
<row>
<entry>error_buffer</entry><entry>
<para>phantom documentation used to test the functioning of doxygen</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>bool: true if success </para>
</formalpara>
</para>
</section>
<anchor xml:id="_util_8h_1ad830e66002a24806e3617946dc988e95"/><section>
<title>util_gl_update_axis()</title>
<indexterm><primary>util_gl_update_axis</primary><secondary>util.h</secondary></indexterm>
<indexterm><primary>util.h</primary><secondary>util_gl_update_axis</secondary></indexterm>
<para><computeroutput>bool util_gl_update_axis (GtkWidget * container_widget, int axis, int value)</computeroutput></para><para>
<para>Look for stack entry and triggers OpenGL for drawing. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea </para>
</entry>
</row>
<row>
<entry>axis</entry><entry>
<para>phantom documentation used to test the functioning of doxygen </para>
</entry>
</row>
<row>
<entry>value</entry><entry>
<para>phantom documentation used to test the functioning of doxygen</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>bool: true if success </para>
</formalpara>
</para>
</section>
</section>
</section>

View File

@ -50,5 +50,5 @@
</section> </section>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/fsm.h</section> include/<link linkend="_fsm_8h">fsm.h</link></section>
</section> </section>

View File

@ -29,5 +29,5 @@
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation used to test the functioning of doxygen </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/fsm.h</section> include/<link linkend="_fsm_8h">fsm.h</link></section>
</section> </section>

View File

@ -2,6 +2,11 @@
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_preferences_2manager_8c" xml:lang="en-US"> <section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_preferences_2manager_8c" xml:lang="en-US">
<title>src/fsm/preferences/manager.c File Reference</title> <title>src/fsm/preferences/manager.c File Reference</title>
<indexterm><primary>src/fsm/preferences/manager.c</primary></indexterm> <indexterm><primary>src/fsm/preferences/manager.c</primary></indexterm>
<para>
<para>fsm preferences manager </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../include/widget.h&quot;<?linebreak?></programlisting><simplesect> <programlisting linenumbering="unnumbered">#include &quot;../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../include/widget.h&quot;<?linebreak?></programlisting><simplesect>
<title>Classes </title> <title>Classes </title>
<itemizedlist> <itemizedlist>
@ -32,6 +37,13 @@
</itemizedlist> </itemizedlist>
</simplesect> </simplesect>
<section> <section>
<title>Detailed Description</title>
<para>fsm preferences manager </para>
<para>This file is part of Gem-graph. It manages the preferences (maintain a list, provides access). </para>
</section>
<section>
<title>Function Documentation</title> <title>Function Documentation</title>
<anchor xml:id="_preferences_2manager_8c_1aa69a9ce07b26ad1863960c6f0d1303b5"/><section> <anchor xml:id="_preferences_2manager_8c_1aa69a9ce07b26ad1863960c6f0d1303b5"/><section>
<title>fsm_add_displayable()</title> <title>fsm_add_displayable()</title>

View File

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_results_2manager_8c" xml:lang="en-US">
<title>src/fsm/results/manager.c File Reference</title>
<indexterm><primary>src/fsm/results/manager.c</primary></indexterm>
<para>
<para>fsm results manager </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../include/widget.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_results_2manager_8c_1ac59294a7ff6934d0704c85aaf08dc268"/>void <emphasis role="strong">fsm_add_result</emphasis> (char *result_name)</para>
</listitem>
<listitem><para><anchor xml:id="_results_2manager_8c_1ae228c78b1697ffd299d415ce2bdce515"/>void <emphasis role="strong">fsm_list_init_results</emphasis> ()</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>fsm results manager </para>
<para>This file is part of Gem-graph. It manages the results (maintain a list, provides access). </para>
</section>
</section>

View File

@ -0,0 +1,190 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_widget_2dispatch_8c" xml:lang="en-US">
<title>src/widget/dispatch.c File Reference</title>
<indexterm><primary>src/widget/dispatch.c</primary></indexterm>
<para>
<para>Windows (main, dialog, modal) creation and access (get, set) </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/widget.h&quot;<?linebreak?>#include &quot;../../include/fsm.h&quot;<?linebreak?>#include &quot;../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>GtkWindow * <link linkend="_widget_2dispatch_8c_1aa79c2ff4883932d6f9b7184d1d05dd5d">widget_get_main_window</link> ()</para>
<para>getter </para>
</listitem>
<listitem><para>GtkWindow * <link linkend="_widget_2dispatch_8c_1a8a3fc181cce5aa9cfb0623abf0315f5d">widget_get_dialog_window</link> ()</para>
<para>getter </para>
</listitem>
<listitem><para>GtkWindow * <link linkend="_widget_2dispatch_8c_1a84dce957680294b8b928c5bc9b2c1dfb">widget_get_text_window</link> ()</para>
<para>getter </para>
</listitem>
<listitem><para>void <link linkend="_widget_2dispatch_8c_1a9fa76559222320b25d10f05eeb9b5869">on_windows_startup</link> (GtkApplication *app)</para>
</listitem>
<listitem><para>void <link linkend="_widget_2dispatch_8c_1af2c6e56cf463999c342009ea6e3e5346">on_windows_activation</link> (GtkApplication *app)</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>Windows (main, dialog, modal) creation and access (get, set) </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_widget_2dispatch_8c_1af2c6e56cf463999c342009ea6e3e5346"/><section>
<title>on_windows_activation()</title>
<indexterm><primary>on_windows_activation</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>on_windows_activation</secondary></indexterm>
<para><computeroutput>void on_windows_activation (GtkApplication * app)</computeroutput></para>
<para><formalpara><title>Since</title>
<para>2024-06</para>
</formalpara>
<formalpara><title>See also</title>
<para><link linkend="_widget_8h_1a6458bdae6bcf9131bc7c793810869db7">widget_design_main_window()</link> </para>
<para>widget_design_dialog_window() </para>
<para>widget_design_text_window() </para>
<para>util_trigger_test() </para>
<para><link linkend="_fsm_2dispatch_8c_1a8c67f42f95d48ee2469c9a27d65db3e6">fsm_journal_event()</link></para>
<para><link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> </para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*app</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2dispatch_8c_1a9fa76559222320b25d10f05eeb9b5869"/><section>
<title>on_windows_startup()</title>
<indexterm><primary>on_windows_startup</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>on_windows_startup</secondary></indexterm>
<para><computeroutput>void on_windows_startup (GtkApplication * app)</computeroutput></para>
<para><formalpara><title>Since</title>
<para>2024-08</para>
</formalpara>
<formalpara><title>See also</title>
<para><link linkend="_fsm_2dispatch_8c_1a8c67f42f95d48ee2469c9a27d65db3e6">fsm_journal_event()</link></para>
<para><link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> </para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*app</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2dispatch_8c_1a8a3fc181cce5aa9cfb0623abf0315f5d"/><section>
<title>widget_get_dialog_window()</title>
<indexterm><primary>widget_get_dialog_window</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_dialog_window</secondary></indexterm>
<para><computeroutput>GtkWindow * widget_get_dialog_window ( )</computeroutput></para><para>
<para>getter </para>
</para>
<para><formalpara><title>Since</title>
<para>2024-07</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/signal </para>
</formalpara>
<formalpara><title>Returns</title>
<para>dialog_window </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2dispatch_8c_1aa79c2ff4883932d6f9b7184d1d05dd5d"/><section>
<title>widget_get_main_window()</title>
<indexterm><primary>widget_get_main_window</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_main_window</secondary></indexterm>
<para><computeroutput>GtkWindow * widget_get_main_window ( )</computeroutput></para><para>
<para>getter </para>
</para>
<para><formalpara><title>Since</title>
<para>2024-07</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/signal </para>
</formalpara>
<formalpara><title>Returns</title>
<para>main_window </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_2dispatch_8c_1a84dce957680294b8b928c5bc9b2c1dfb"/><section>
<title>widget_get_text_window()</title>
<indexterm><primary>widget_get_text_window</primary><secondary>dispatch.c</secondary></indexterm>
<indexterm><primary>dispatch.c</primary><secondary>widget_get_text_window</secondary></indexterm>
<para><computeroutput>GtkWindow * widget_get_text_window ( )</computeroutput></para><para>
<para>getter </para>
</para>
<para><formalpara><title>Since</title>
<para>2024-07</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/signal </para>
</formalpara>
<formalpara><title>Returns</title>
<para>text_window </para>
</formalpara>
</para>
</section>
</section>
</section>

View File

@ -29,5 +29,5 @@
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation used to test the functioning of doxygen </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/util.h</section> include/<link linkend="_util_8h">util.h</link></section>
</section> </section>

File diff suppressed because it is too large Load Diff

View File

@ -117,5 +117,5 @@
<para>Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas. </para> <para>Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas. </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/graphics.h</section> include/<link linkend="_graphics_8h">graphics.h</link></section>
</section> </section>

View File

@ -29,5 +29,5 @@
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation used to test the functioning of doxygen </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
include/util.h</section> include/<link linkend="_util_8h">util.h</link></section>
</section> </section>

View File

@ -0,0 +1,567 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_widget_8h" xml:lang="en-US">
<title>include/widget.h File Reference</title>
<indexterm><primary>include/widget.h</primary></indexterm>
<para>
<para>widgets management header </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;gtk-4.0/gtk/gtk.h&gt;<?linebreak?></programlisting><simplesect>
<title>Classes </title>
<itemizedlist>
<listitem><para>struct <link linkend="_structTreeNode__t">TreeNode_t</link></para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Macros </title>
<itemizedlist>
<listitem><para><anchor xml:id="_widget_8h_1a0817a25a70e19c1d1aaaa97ee4c88d0c"/>#define <emphasis role="strong">W_MY_SCREEN</emphasis>&#160;&#160;&#160;1920</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1ac12c2e57b99c1d88005b4bc9142d123f"/>#define <emphasis role="strong">H_MY_SCREEN</emphasis>&#160;&#160;&#160;1000</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aac1fd67e09f1d17b32f87924e66681e5"/>#define <emphasis role="strong">W_TEXT_WINDOW</emphasis>&#160;&#160;&#160;550</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a1ec985cbecdb9a4ecfe426fd69261afc"/>#define <emphasis role="strong">H_TEXT_WINDOW</emphasis>&#160;&#160;&#160;H_MY_SCREEN</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a0cf886c72c500353c5428b167b6cfd33"/>#define <emphasis role="strong">W_TREE</emphasis>&#160;&#160;&#160;160</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a077f1f93ecea419f349b573f8a845af1"/>#define <emphasis role="strong">W_DO_UNDO_REDO_BOX</emphasis>&#160;&#160;&#160;1300</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a526b392f8da7015c7bae203e86562241"/>#define <emphasis role="strong">W_XYZ_BOX</emphasis>&#160;&#160;&#160;62</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a8387ddddc78874c390241019cfbaa28a"/>#define <emphasis role="strong">H_XYZ_BOX</emphasis>&#160;&#160;&#160;200</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1ae91d0e051eb50649ae3c849632dbc258"/>#define <emphasis role="strong">H_E_COLI</emphasis>&#160;&#160;&#160;760</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a084cf746d1dd8b0d987828574671a20d"/>#define <emphasis role="strong">H_OBJECTS_SITUATIONS</emphasis>&#160;&#160;&#160;130</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a335ac975697e8a28f32a0563bad79324"/>#define <emphasis role="strong">W_COMPARATOR</emphasis>&#160;&#160;&#160;64</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a3b010ae47c116cd97010bf2d13725fbd"/>#define <emphasis role="strong">W_RULES_USE</emphasis>&#160;&#160;&#160;90</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aa5ed481c549efbbf9839860010aed08d"/>#define <emphasis role="strong">W_IMAGE_800</emphasis>&#160;&#160;&#160;800</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a080ac7f1ee88912c97e282e4d1456645"/>#define <emphasis role="strong">W_IMAGE_100</emphasis>&#160;&#160;&#160;100</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a377686eeea60d44a455d2e9e65dc6885"/>#define <emphasis role="strong">ALL_VS_SELECTED</emphasis>&#160;&#160;&#160;340</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1af33e64cc89411c86e53ae5077e0778d7"/>#define <emphasis role="strong">H_PARTITION_SYNTH</emphasis>&#160;&#160;&#160;1600</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1ae075d12023480ed8aa2e87e3618823ec"/>#define <emphasis role="strong">W_PARTITION_SYNTH</emphasis>&#160;&#160;&#160;400</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1acdc80ea2d22b230743a04959ddaec5a1"/>#define <emphasis role="strong">PARTITION_STATE_TOP</emphasis>&#160;&#160;&#160;600</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a9c680cde49123bd06aff94a246dfdd77"/>#define <emphasis role="strong">PARTITION_SPACE_VS_CONTROLS_1</emphasis>&#160;&#160;&#160;920</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1ac4959aea231be3980763d41e10e4b04a"/>#define <emphasis role="strong">PARTITION_SPACE_VS_CONTROLS_2</emphasis>&#160;&#160;&#160;800</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aeee38e575fcf6ddcee8b1cc597ff555c"/>#define <emphasis role="strong">PARTITION_SPACE_VS_CAMERA_IN_STATE</emphasis>&#160;&#160;&#160;1850</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a6efea6accef9965b198cb46ca7bad3a9"/>#define <emphasis role="strong">PARTITION_SPACE_VS_CAMERA_IN_SYNTH</emphasis>&#160;&#160;&#160;1560</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aa2b371a8e41e74cbecb17b8ee36bd9a0"/>#define <emphasis role="strong">LIST_W</emphasis>&#160;&#160;&#160;190</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1af6381825ddcaef499d49dc4bd06aa4d3"/>#define <emphasis role="strong">LIST_H</emphasis>&#160;&#160;&#160;114</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1adc9e877ab16c1477603950032e4f99c7"/>#define <emphasis role="strong">H_PARTITION_RESULTS</emphasis>&#160;&#160;&#160;140</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>GtkWindow * <link linkend="_widget_8h_1aa79c2ff4883932d6f9b7184d1d05dd5d">widget_get_main_window</link> ()</para>
<para>getter </para>
</listitem>
<listitem><para>GtkWindow * <link linkend="_widget_8h_1a8a3fc181cce5aa9cfb0623abf0315f5d">widget_get_dialog_window</link> ()</para>
<para>getter </para>
</listitem>
<listitem><para>GtkWindow * <link linkend="_widget_8h_1a84dce957680294b8b928c5bc9b2c1dfb">widget_get_text_window</link> ()</para>
<para>getter </para>
</listitem>
<listitem><para>void <link linkend="_widget_8h_1a6458bdae6bcf9131bc7c793810869db7">widget_design_main_window</link> (GtkWindow *main_window, GtkApplication *app)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a1591b0ceef41a3926eee69905735b3ec"/>void <emphasis role="strong">widget_design_dialog_window</emphasis> (GtkWindow *main_window, GtkWindow *dialog_window)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a2de49d7ea886ac83d68af532046c0868"/>void <emphasis role="strong">widget_design_text_window</emphasis> (GtkWindow *main_window, GtkWindow *text_window)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a3d0f8c7b9545a6da3464060dad7990db"/>const char * <emphasis role="strong">widget_get_btt_label_synth</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a22ed4aed09c29d9f8c72dbe7ced53e2c"/>const char * <emphasis role="strong">widget_get_btt_label_state</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1adea9b5591d51aab274d8c275045d778c"/>const char * <emphasis role="strong">widget_get_btt_label_rules</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a136322baea0729a8dfbc5c9b1bc0667e"/>const char * <emphasis role="strong">widget_get_btt_label_data</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a45d8a02844578e1c13d8b86b74e3c8b0"/>void <emphasis role="strong">window_design_topbar_left</emphasis> (GtkWidget *header_bar)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a4a9ccdb6dc6dbc18f1e2d2235fbb26c3"/>void <emphasis role="strong">window_design_topbar_right</emphasis> (GtkWidget *header_bar, GtkApplication *app)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a990f88f46feba957a864d7bf203f42e7"/>void * <emphasis role="strong">widget_get_page_synth</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a9689934ad6d7c98379f35d49adf11878"/>void * <emphasis role="strong">widget_get_page_state</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a56cdc1609820a67a52fb095ba0128d3f"/>void * <emphasis role="strong">widget_get_page_data</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1afabb3345620886cdee4f2b76c9d84a51"/>void * <emphasis role="strong">widget_get_page_measure</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a98c6bdbcca9daeb835abddec13fd3d14"/>void * <emphasis role="strong">widget_get_page_engine</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aff18a7cea4191d9ae0480f2eaca06a5f"/>void * <emphasis role="strong">widget_get_time_dependent</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aed9b242acda234a0ca5cd359cb6d29e2"/>void * <emphasis role="strong">widget_get_space_vs_non_time_dependent</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1abc35a23e7853e1e3628b389291f29cba"/>void * <emphasis role="strong">widget_get_non_time_dependent</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1ab37220d257ccf0ac8a2f4b0f41b83ab9"/>void * <emphasis role="strong">widget_get_space_view</emphasis> (int partition_space_vs_camera)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a86794ff6578c24e8b16b94bf853dd2b3"/>void * <emphasis role="strong">widget_get_graph_view_control</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1affbfa87fb5a08853b9a4d92de8877ff7"/>void * <emphasis role="strong">widget_get_space_edit_control</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a593c9c15eb7c193c589dac7c28c36560"/>void * <emphasis role="strong">widget_get_sequence_control</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a4081353ac1420fa15533a11bcbff3238"/>void <emphasis role="strong">widget_set_situations_value</emphasis> (int value)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1affefa1ca48e64b5b440729fecbe0e4ee"/>void <emphasis role="strong">widget_set_objects_value</emphasis> (int rank, int value)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a1b7d49db6b4e22a55da588d1137b6e2c"/>int <emphasis role="strong">widget_get_object_transparency</emphasis> (int i)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a8019caa45a82a3d92061d49818d0f617"/>void <emphasis role="strong">widget_reset_XYZ_in_state_pane</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a86b0d48a06d2e3f14779aa3cab57c320"/>void <emphasis role="strong">widget_reset_XYZ_scrollbars_rule</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a77e563a82a7be7dd38c117102555c2d7"/>void <emphasis role="strong">widget_reset_XYZ_scrollbars_state</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aa149189ba910f88f07c3c93514ccffc2"/>void <emphasis role="strong">widget_reset_XYZ_scrollbars_synth</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a1c074a5748ee5c7e9974bb75539adb34"/>void * <emphasis role="strong">widget_get_pane_all_rules_left</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1ab9db55b708939397362a8a11489c64c5"/>void * <emphasis role="strong">widget_get_pane_selected_rule_right</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a192412673ea82a53a66fd809a5b1fd55"/>void * <emphasis role="strong">widget_get_rules_pilot_box</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a3cecbcc7340289ed318347f1bf86308c"/>void * <emphasis role="strong">widget_get_rules_tree_tools</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a1f62040452052165b13a8e9bf23ab368"/>void * <emphasis role="strong">widget_get_rules_use</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1ab6a3b9836a4c333b59b34cb97d00df3a"/>void * <emphasis role="strong">widget_get_selected_rule</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a8b314bd2dcf59006649ff86ae04e9eaf"/>void * <emphasis role="strong">widget_get_rule_edition_tools</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a4d4d650591869cebc663884c29c6bb7c"/>void * <emphasis role="strong">widget_get_rule_investigation_tools</emphasis> ()</para>
</listitem>
<listitem><para>void * <link linkend="_widget_8h_1a15cbd8402e76ff0dd5e6b39e17a9dc49">widget_get_selected_rule_algebra</link> ()</para>
<para>Provides the three lists needed to describe a rule algebraically. </para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a303a3e0838137d31f4e04a416ebf6310"/>void * <emphasis role="strong">widget_get_selected_rule_geometry</emphasis> ()</para>
</listitem>
<listitem><para>void * <link linkend="_widget_8h_1a8d42128cf54da36d55112fa5f5634f96">widget_get_selected_rule_conditions_list_btt</link> ()</para>
<para>Builds and presents the conditions list of a rule. </para>
</listitem>
<listitem><para>void * <link linkend="_widget_8h_1a118c74f398c9e46f2a2252deaf88337e">widget_get_selected_rule_assignations_list_btt</link> ()</para>
<para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para>
</listitem>
<listitem><para>void * <link linkend="_widget_8h_1afcfab13d3504a69ec5f4ae6ad6974e29">widget_get_selected_rule_identity_btt</link> ()</para>
<para>Hosts a list of character strings that can be combined to provide a &quot;human readable&quot; rule identifier. </para>
</listitem>
<listitem><para>GtkEntry <link linkend="_widget_8h_1a1c4f1ce489cdc3b4e5a1e86d3438e846">widget_set_item_text</link> (GtkWidget *list_box, const char *text, bool editable)</para>
<para>Format an entry (a text item) in a list. </para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a1b97f8be0394a44033a491d7bb44dce2"/>void * <emphasis role="strong">widget_get_selected_rule_camera</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a075009e3b1816abfd76bd3d4fcdda890"/>void * <emphasis role="strong">widget_get_selected_rule_before_after</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aba1af8256174f6a4661675d2b3c6c34d"/>void * <emphasis role="strong">widget_get_results_box_organize</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aeca06e5a8c669b8d8f9dd82289f4e1e1"/>void * <emphasis role="strong">widget_get_results_box_display</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a1cc6f65cd162b7c49e760ab29e8b7919"/>void * <emphasis role="strong">widget_get_results_box_time</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a82852f17d5f914c6cfb35b892766ab1e"/>struct <link linkend="_structTreeNode__t">TreeNode_t</link> * <emphasis role="strong">widget_create_user_rules_tree_node</emphasis> (const gchar *text)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a95c04d702f36a7422a9e14eaf456ed3e"/>void <emphasis role="strong">widget_add_tree_child_node</emphasis> (struct <link linkend="_structTreeNode__t">TreeNode_t</link> *parent, struct <link linkend="_structTreeNode__t">TreeNode_t</link> *child)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1af968daedf9ce1bd06c674c69ef793201"/>void * <emphasis role="strong">widget_get_user_rules_tree</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a5592a550ad1f66ae7092b580318878f8"/>void * <emphasis role="strong">widget_get_text_from_address</emphasis> (gchar *text_name)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aee7518cfd4073577afedafc70705e233"/>char * <emphasis role="strong">widget_get_address_text_theory</emphasis> ()</para>
<para>return &quot;./data/text/théorie.txt&quot; </para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1acfad36e48f845c075056fb8fbe765c0e"/>char * <emphasis role="strong">widget_get_address_text_practice</emphasis> ()</para>
<para>return &quot;./data/text/pratique.txt&quot; </para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a905ee0e77908c113609224ee28aaa0ee"/>char * <emphasis role="strong">widget_get_address_text_alpha_index</emphasis> ()</para>
<para>return &quot;./alphabetic_index.all&quot; </para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a60d9aed440437cd898f609784c32b2f5"/>void * <emphasis role="strong">widget_get_an_impression_of_what_a_rules_comparator_could_be</emphasis> ()</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a479a32aff9b3fa44b34508e2c41b12d3"/>void <emphasis role="strong">widget_let_us_create_a_complex_useless_and_expensive_tree</emphasis> (struct <link linkend="_structTreeNode__t">TreeNode_t</link> *tree_root)</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a27574b02d486a2e93ed1a3e0f6461798"/>void * <emphasis role="strong">widget_measure_new</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a88886ed08e68539a9c5280fc40c2c2a0"/>void * <emphasis role="strong">widget_measure_do_select_rules_first</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aea7a46578d6e1f0a2ee58b0f6eb16028"/>void * <emphasis role="strong">widget_measure_do_depends_on_one_or_two_events</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a5b3aeea035afbf3cb35744687f091b1b"/>void * <emphasis role="strong">widget_measure_do_depends_on_a_single_event</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a7c86507328bb9c31a0dcc0c97cf66c25"/>void * <emphasis role="strong">widget_measure_do_depends_on_two_events</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a444bf6c3230e0f97827eda74818ba258"/>void * <emphasis role="strong">widget_measure_do_select_a_second_rules_set</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a37872533aa0116818c810d9cdad7f4ed"/>void * <emphasis role="strong">widget_measure_do_choose_an_event_type</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1aaab2ef1ae64c85052ab65ed684f3a132"/>void * <emphasis role="strong">widget_measure_do_correlate</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a3d1ceccb1f00d0a2f3329af8b499844b"/>void * <emphasis role="strong">widget_measure_do_insert_in_measurements_list</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a5f9f287e97e9bdad13662a864a1d5273"/>void * <emphasis role="strong">widget_measure_do_end_creation_of_measurement_process</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a0cef6d510a6777d25e26ec5900c38239"/>void * <emphasis role="strong">widget_measure_event_occurences_nb</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a3fae10bb44f33d896f72352df671be61"/>void * <emphasis role="strong">widget_measure_event_occurences_dates</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a58049a1f53bb6e189b5a60004fd716b5"/>void * <emphasis role="strong">widget_measure_event_occurences_situations</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a42113abbf8118a8362314d2427f540dc"/>void * <emphasis role="strong">widget_measure_time_elapsed_between_two_events</emphasis> ()</para>
</listitem>
<listitem><para><anchor xml:id="_widget_8h_1a05bd4127a0e218921c87eb499595f860"/>void * <emphasis role="strong">widget_measure_third_event_occurences_in_between</emphasis> ()</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>widgets management header </para>
<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_widget_8h_1a6458bdae6bcf9131bc7c793810869db7"/><section>
<title>widget_design_main_window()</title>
<indexterm><primary>widget_design_main_window</primary><secondary>widget.h</secondary></indexterm>
<indexterm><primary>widget.h</primary><secondary>widget_design_main_window</secondary></indexterm>
<para><computeroutput>void widget_design_main_window (GtkWindow * main_window, GtkApplication * app)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*main_window</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>*app</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_8h_1a8a3fc181cce5aa9cfb0623abf0315f5d"/><section>
<title>widget_get_dialog_window()</title>
<indexterm><primary>widget_get_dialog_window</primary><secondary>widget.h</secondary></indexterm>
<indexterm><primary>widget.h</primary><secondary>widget_get_dialog_window</secondary></indexterm>
<para><computeroutput>GtkWindow * widget_get_dialog_window ( )</computeroutput></para><para>
<para>getter </para>
</para>
<para><formalpara><title>Since</title>
<para>2024-07</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/signal </para>
</formalpara>
<formalpara><title>Returns</title>
<para>dialog_window </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_8h_1aa79c2ff4883932d6f9b7184d1d05dd5d"/><section>
<title>widget_get_main_window()</title>
<indexterm><primary>widget_get_main_window</primary><secondary>widget.h</secondary></indexterm>
<indexterm><primary>widget.h</primary><secondary>widget_get_main_window</secondary></indexterm>
<para><computeroutput>GtkWindow * widget_get_main_window ( )</computeroutput></para><para>
<para>getter </para>
</para>
<para><formalpara><title>Since</title>
<para>2024-07</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/signal </para>
</formalpara>
<formalpara><title>Returns</title>
<para>main_window </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_8h_1a15cbd8402e76ff0dd5e6b39e17a9dc49"/><section>
<title>widget_get_selected_rule_algebra()</title>
<indexterm><primary>widget_get_selected_rule_algebra</primary><secondary>widget.h</secondary></indexterm>
<indexterm><primary>widget.h</primary><secondary>widget_get_selected_rule_algebra</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_algebra ( )</computeroutput></para><para>
<para>Provides the three lists needed to describe a rule algebraically. </para>
</para>
<para>The algebraic definition of a rule comprises three types of character strings organised into three lists:<itemizedlist>
<listitem>
<para>conditions</para>
</listitem><listitem>
<para>assignations</para>
</listitem><listitem>
<para>name (a set of identity elements)</para>
</listitem></itemizedlist>
</para>
<para><formalpara><title>Since</title>
<para>2024-08</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/widget/one_rule/algebra/conditions() </para>
<para>src/widget/one_rule/algebra/assignations() </para>
<para>src/widget/one_rule/algebra/identity()</para>
<para>src/widget/one_rule/dispatch() </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_8h_1a118c74f398c9e46f2a2252deaf88337e"/><section>
<title>widget_get_selected_rule_assignations_list_btt()</title>
<indexterm><primary>widget_get_selected_rule_assignations_list_btt</primary><secondary>widget.h</secondary></indexterm>
<indexterm><primary>widget.h</primary><secondary>widget_get_selected_rule_assignations_list_btt</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_assignations_list_btt ( )</computeroutput></para><para>
<para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para>
</para>
<para>Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules. (see below) TODO</para>
<para>|- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - &gt;</para>
<para>This list groups all the elementary assignments of the rule. No assignment should be repeated or modified by other assignments. (== a unique assignment per address in rule workspace) Completeness is not required. (== there does not need to be one assignment per address in the rule workspace)</para>
<para>&lt; - - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - -|</para>
<para><formalpara><title>Since</title>
<para>2024-08</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/widget/one_rule/algebra/utilities/widget_set_item_text() </para>
<para>src/fsm/dispatch/fsm_journal_event() &lt; TODO (for each item ?)</para>
<para>src/widget/one_rule/algebra/dispatch()</para>
</formalpara>
<formalpara><title>Returns</title>
<para>the assignations list </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_8h_1a8d42128cf54da36d55112fa5f5634f96"/><section>
<title>widget_get_selected_rule_conditions_list_btt()</title>
<indexterm><primary>widget_get_selected_rule_conditions_list_btt</primary><secondary>widget.h</secondary></indexterm>
<indexterm><primary>widget.h</primary><secondary>widget_get_selected_rule_conditions_list_btt</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_conditions_list_btt ( )</computeroutput></para><para>
<para>Builds and presents the conditions list of a rule. </para>
</para>
<para>This list sets out all the conditions that the rule must meet in order to be applied.</para>
<para>Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules. (see below) TODO</para>
<para>|- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - &gt;</para>
<para>No conditions should be repeated. No condition may contradict another (== a unique condition per address in rule workspace) Completeness is not required (== there does not need to be one condition per address in the rule workspace)</para>
<para>(NB The following applies to server workers) Two rules cannot share the same set of conditions. If several rules apply to the same set of local conditions - which can happen if several different actions are possible from the same situation - they must each include an additional condition determining their probability of execution in the event of a conflict. If two rules share the same local set of conditions, they must both be evaluated. If all the conditions of one rule are included in the conditions of another rule, then the other rule must be evaluated first.</para>
<para>&lt; - - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - -|</para>
<para><formalpara><title>Since</title>
<para>2024-08</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/widget/one_rule/algebra/utilities/widget_set_item_text() </para>
<para>src/fsm/dispatch/fsm_journal_event() &lt; TODO (for each item ?)</para>
<para>src/widget/one_rule/algebra/dispatch()</para>
</formalpara>
<formalpara><title>Returns</title>
<para>the conditions list </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_8h_1afcfab13d3504a69ec5f4ae6ad6974e29"/><section>
<title>widget_get_selected_rule_identity_btt()</title>
<indexterm><primary>widget_get_selected_rule_identity_btt</primary><secondary>widget.h</secondary></indexterm>
<indexterm><primary>widget.h</primary><secondary>widget_get_selected_rule_identity_btt</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_identity_btt ( )</computeroutput></para><para>
<para>Hosts a list of character strings that can be combined to provide a &quot;human readable&quot; rule identifier. </para>
</para>
<para>This list can also contain non-mandatory elements.</para>
<para>Each rule can have a specific &quot;human readable&quot; name chosen by its designer. This name can be used to identify the rule. It is desirable for a unique name to be accepted and shared by as many users as possible.</para>
<para>On the contrary, for the automaton, the identity of each rule is given exclusively by its set of conditions.</para>
<para>Today, this function provides only an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules. (see below) TODO</para>
<para>|- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - &gt;</para>
<para>No item of the list should be repeated. No element describing the function of the rule can contradict another. All the elements required for identification by name must be present. Uniqueness is required (This name must be usable as a key). Non-mandatory elements can be added (comments, etc.).</para>
<para>&lt; - - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - -|</para>
<para><formalpara><title>Since</title>
<para>2024-08</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/widget/one_rule/algebra/utilities/widget_set_item_text() </para>
<para>src/fsm/dispatch/fsm_journal_event() &lt; TODO (for each item ?)</para>
<para>src/widget/one_rule/algebra/dispatch/gtk_box_append()</para>
</formalpara>
<formalpara><title>Returns</title>
<para>rule identity </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_8h_1a84dce957680294b8b928c5bc9b2c1dfb"/><section>
<title>widget_get_text_window()</title>
<indexterm><primary>widget_get_text_window</primary><secondary>widget.h</secondary></indexterm>
<indexterm><primary>widget.h</primary><secondary>widget_get_text_window</secondary></indexterm>
<para><computeroutput>GtkWindow * widget_get_text_window ( )</computeroutput></para><para>
<para>getter </para>
</para>
<para><formalpara><title>Since</title>
<para>2024-07</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/signal </para>
</formalpara>
<formalpara><title>Returns</title>
<para>text_window </para>
</formalpara>
</para>
</section>
<anchor xml:id="_widget_8h_1a1c4f1ce489cdc3b4e5a1e86d3438e846"/><section>
<title>widget_set_item_text()</title>
<indexterm><primary>widget_set_item_text</primary><secondary>widget.h</secondary></indexterm>
<indexterm><primary>widget.h</primary><secondary>widget_set_item_text</secondary></indexterm>
<para><computeroutput>GtkEntry widget_set_item_text (GtkWidget * list_box, const char * text, bool editable)</computeroutput></para><para>
<para>Format an entry (a text item) in a list. </para>
</para>
<para><formalpara><title>Since</title>
<para>2024-08</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/widget/one_rule/algebra/conditions() </para>
<para>src/widget/one_rule/algebra/assign() </para>
<para>src/widget/one_rule/algebra/identity()</para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*list_box</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>*text</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>editable</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>*entry &lt; a text item </para>
</formalpara>
</para>
</section>
</section>
</section>

View File

@ -23,15 +23,34 @@
</chapter> </chapter>
<chapter> <chapter>
<title>File Documentation</title> <title>File Documentation</title>
<xi:include href="d7/d01/action_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d3/d0a/base_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="dd/d01/fsm_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d7/d04/graphics_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d4/d0b/parse_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d8/d09/signal_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d8/d0c/util_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="df/d05/widget_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d1/d0c/actions_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d6/d0f/engine_2manager_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d4/d08/measures_2manager_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d9/d06/preferences_2manager_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="d9/d06/preferences_2manager_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d9/d06/results_2manager_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d6/d09/draw_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d2/d02/grid_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d8/d00/init_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d3/d0c/journal_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d0/d09/main_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="d0/d09/main_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d8/d06/signal_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="da/d0c/gl_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="da/d0c/gl_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="db/d07/assign_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="db/d07/assign_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="de/d0e/conditions_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="de/d0e/conditions_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d4/d01/identity_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="d4/d01/identity_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d7/d06/utilities_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="d7/d06/utilities_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d4/d07/fsm_2dispatch_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="d4/d07/fsm_2dispatch_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d9/d0a/widget_2dispatch_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="db/d00/widget_2one__rule_2algebra_2dispatch_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="db/d00/widget_2one__rule_2algebra_2dispatch_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d7/d02/widget_2topbar_2dispatch_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter> </chapter>
<index/> <index/>
</book> </book>

View File

@ -1008,6 +1008,8 @@ INPUT_FILE_ENCODING =
FILE_PATTERNS = *.c \ FILE_PATTERNS = *.c \
*.h \ *.h \
*.frag \
*.vert \
# The RECURSIVE tag can be used to specify whether or not subdirectories should # The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well. # be searched for input files as well.

1
doc/rtfm/man3/@0.3 Normal file
View File

@ -0,0 +1 @@
.so man3/noname

View File

@ -0,0 +1 @@
.so man3/widget.h.3

1
doc/rtfm/man3/EAST.3 Normal file
View File

@ -0,0 +1 @@
.so man3/base.h.3

View File

@ -0,0 +1 @@
.so man3/graphics.h.3

View File

@ -0,0 +1 @@
.so man3/actions.c.3

View File

@ -0,0 +1 @@
.so man3/graphics.h.3

View File

@ -0,0 +1 @@
.so man3/graphics.h.3

1
doc/rtfm/man3/H_E_COLI.3 Normal file
View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

1
doc/rtfm/man3/NADIR.3 Normal file
View File

@ -0,0 +1 @@
.so man3/base.h.3

1
doc/rtfm/man3/NORTH.3 Normal file
View File

@ -0,0 +1 @@
.so man3/base.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

1
doc/rtfm/man3/SOUTH.3 Normal file
View File

@ -0,0 +1 @@
.so man3/base.h.3

1
doc/rtfm/man3/TEST.3 Normal file
View File

@ -0,0 +1 @@
.so man3/init.c.3

View File

@ -0,0 +1 @@
.so man3/graphics.h.3

1
doc/rtfm/man3/WEST.3 Normal file
View File

@ -0,0 +1 @@
.so man3/base.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

1
doc/rtfm/man3/W_TREE.3 Normal file
View File

@ -0,0 +1 @@
.so man3/widget.h.3

View File

@ -0,0 +1 @@
.so man3/widget.h.3

1
doc/rtfm/man3/ZENITH.3 Normal file
View File

@ -0,0 +1 @@
.so man3/base.h.3

30
doc/rtfm/man3/action.h.3 Normal file
View File

@ -0,0 +1,30 @@
.TH "include/action.h" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
include/action.h \- actions header
.SH SYNOPSIS
.br
.PP
\fC#include <unistd\&.h>\fP
.br
\fC#include <gtk\-4\&.0/gtk/gtk\&.h>\fP
.br
.SS "Functions"
.in +1c
.ti -1c
.RI "void \fBon_preferences_action\fP (GSimpleAction *action, GVariant *parameter, gpointer user_data)"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.in -1c
.SH "Detailed Description"
.PP
actions header
This file is part of Gem-graph\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.

37
doc/rtfm/man3/actions.c.3 Normal file
View File

@ -0,0 +1,37 @@
.TH "src/actions.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/actions.c \- events management (actions) functions
.SH SYNOPSIS
.br
.PP
\fC#include <unistd\&.h>\fP
.br
\fC#include <gtk\-4\&.0/gtk/gtk\&.h>\fP
.br
.SS "Macros"
.in +1c
.ti -1c
.RI "#define \fBGEM_GRAPH_CLIENT_TYPE_WINDOW\fP (gem_graph_client_window_get_type())"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "void \fBon_preferences_action\fP (GSimpleAction *action, GVariant *parameter, gpointer user_data)"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.in -1c
.SH "Detailed Description"
.PP
events management (actions) functions
This file is part of Gem-graph\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.

85
doc/rtfm/man3/base.h.3 Normal file
View File

@ -0,0 +1,85 @@
.TH "include/base.h" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
include/base.h \- base header
.SH SYNOPSIS
.br
.PP
\fC#include <assert\&.h>\fP
.br
\fC#include <errno\&.h>\fP
.br
\fC#include <fcntl\&.h>\fP
.br
\fC#include <math\&.h>\fP
.br
\fC#include <stdio\&.h>\fP
.br
\fC#include <stdlib\&.h>\fP
.br
\fC#include <stddef\&.h>\fP
.br
\fC#include <stdbool\&.h>\fP
.br
\fC#include <sys/types\&.h>\fP
.br
\fC#include <sys/stat\&.h>\fP
.br
\fC#include <unistd\&.h>\fP
.br
\fC#include <time\&.h>\fP
.br
\fC#include <string\&.h>\fP
.br
\fC#include <glib\-2\&.0/glib\&.h>\fP
.br
\fC#include <gtk\-4\&.0/gtk/gtk\&.h>\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBarrow_t\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.in -1c
.SS "Macros"
.in +1c
.ti -1c
.RI "#define \fBEAST\fP 0"
.br
.ti -1c
.RI "#define \fBWEST\fP 1"
.br
.ti -1c
.RI "#define \fBZENITH\fP 2"
.br
.ti -1c
.RI "#define \fBNADIR\fP 3"
.br
.ti -1c
.RI "#define \fBSOUTH\fP 4"
.br
.ti -1c
.RI "#define \fBNORTH\fP 5"
.br
.in -1c
.SS "Enumerations"
.in +1c
.ti -1c
.RI "enum { \fBX_AXIS\fP, \fBY_AXIS\fP, \fBZ_AXIS\fP, \fBN_AXIS\fP }"
.br
.in -1c
.SH "Detailed Description"
.PP
base header
This file is part of Gem-graph\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.

View File

@ -1,62 +1,55 @@
.TH "src/widget/one_rule/algebra/dispatch.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*- .TH "src/widget/topbar/dispatch.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME
src/widget/one_rule/algebra/dispatch.c \- Gem-graph-client Algebra rules dispatcher\&. src/widget/topbar/dispatch.c \- Main window widgets dispatcher (topbar and six pages)
.SH SYNOPSIS .SH SYNOPSIS
.br .br
.PP .PP
\fC#include '\&.\&./\&.\&./\&.\&./\&.\&./include/fsm\&.h'\fP \fC#include '\&.\&./\&.\&./\&.\&./include/base\&.h'\fP
.br .br
\fC#include '\&.\&./\&.\&./\&.\&./\&.\&./include/widget\&.h'\fP \fC#include '\&.\&./\&.\&./\&.\&./include/signal\&.h'\fP
.br .br
\fC#include '\&.\&./\&.\&./\&.\&./\&.\&./include/signal\&.h'\fP \fC#include '\&.\&./\&.\&./\&.\&./include/widget\&.h'\fP
.br
\fC#include '\&.\&./\&.\&./\&.\&./include/fsm\&.h'\fP
.br .br
.SS "Functions" .SS "Functions"
.in +1c .in +1c
.ti -1c .ti -1c
.RI "void * \fBwidget_get_selected_rule_algebra\fP ()" .RI "void \fBwidget_design_main_window\fP (GtkWindow *main_window, GtkApplication *app)"
.br .br
.RI "Provides the three lists needed to describe a rule algebraically\&. " .ti -1c
.RI "char * \fBwidget_get_address_text_theory\fP ()"
.br
.RI "return '\&./data/text/théorie\&.txt' "
.ti -1c
.RI "char * \fBwidget_get_address_text_practice\fP ()"
.br
.RI "return '\&./data/text/pratique\&.txt' "
.ti -1c
.RI "char * \fBwidget_get_address_text_alpha_index\fP ()"
.br
.RI "return '\&./alphabetic_index\&.all' "
.in -1c .in -1c
.SH "Detailed Description" .SH "Detailed Description"
.PP .PP
Gem-graph-client Algebra rules dispatcher\&. Main window widgets dispatcher (topbar and six pages)
This file is part of Gem-graph\&.
.PP
It organizes the algebraic description of a rule\&.
.SH "Function Documentation" .SH "Function Documentation"
.PP .PP
.SS "void * widget_get_selected_rule_algebra ()" .SS "void widget_design_main_window (GtkWindow * main_window, GtkApplication * app)"
.PP .PP
Provides the three lists needed to describe a rule algebraically\&. The algebraic definition of a rule comprises three types of character strings organised into three lists: \fBParameters\fP
.IP "\(bu" 2
conditions
.IP "\(bu" 2
assignations
.IP "\(bu" 2
name (a set of identity elements)
.PP
.PP
\fBSince\fP
.RS 4 .RS 4
2024-08 \fI*main_window\fP
.RE .br
.PP \fI*app\fP
\fBSee also\fP
.RS 4
src/widget/one_rule/algebra/conditions()
.PP
src/widget/one_rule/algebra/assignations()
.PP
src/widget/one_rule/algebra/identity()
.PP
src/widget/one_rule/dispatch()
.RE .RE
.PP .PP

130
doc/rtfm/man3/draw.c.3 Normal file
View File

@ -0,0 +1,130 @@
.TH "src/graphics/draw.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/graphics/draw.c \- graphics - general drawing functions
.SH SYNOPSIS
.br
.PP
\fC#include <cglm/cglm\&.h>\fP
.br
\fC#include '\&.\&./\&.\&./include/base\&.h'\fP
.br
\fC#include '\&.\&./\&.\&./include/graphics\&.h'\fP
.br
.SS "Functions"
.in +1c
.ti -1c
.RI "void \fBgraphics_draw_vertex\fP (const int stack_id, GLfloat x, GLfloat y, GLfloat z)"
.br
.RI "Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw_color\fP (const int stack_id, GLfloat r, GLfloat g, GLfloat b)"
.br
.RI "Writes values to describe a color (r,g,b) into the color buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw_line\fP (const int stack_id, GLuint a, GLuint b)"
.br
.RI "Writes values to describe a line from a to b into the line buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw_plan\fP (const int stack_id, GLuint a, GLuint b, GLuint c)"
.br
.RI "Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw\fP (const int stack_id)"
.br
.RI "Draws the current buffer to a gl_area\&. "
.in -1c
.SH "Detailed Description"
.PP
graphics - general drawing functions
This file is part of Gem-graph\&.
.SH "Function Documentation"
.PP
.SS "void graphics_draw (const int stack_id)"
.PP
Draws the current buffer to a gl_area\&.
.PP
\fBParameters\fP
.RS 4
\fIgl_area,ptr\fP to the gl_area widget
.RE
.PP
\fBReturns\fP
.RS 4
void
.RE
.PP
.SS "void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b)"
.PP
Writes values to describe a color (r,g,b) into the color buffer\&. Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&.
.PP
\fBParameters\fP
.RS 4
\fIcolor\fP GLfloat(r,g,b)
.RE
.PP
\fBReturns\fP
.RS 4
void
.RE
.PP
.SS "void graphics_draw_line (const int stack_id, GLuint a, GLuint b)"
.PP
Writes values to describe a line from a to b into the line buffer\&. Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&.
.PP
\fBParameters\fP
.RS 4
\fIcoords\fP GLuint (a,b)
.RE
.PP
\fBReturns\fP
.RS 4
void
.RE
.PP
.SS "void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c)"
.PP
Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&.
.PP
\fBParameters\fP
.RS 4
\fIcoords\fP GLuint (a,b,c)
.RE
.PP
\fBReturns\fP
.RS 4
void
.RE
.PP
.SS "void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z)"
.PP
Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&.
.PP
\fBParameters\fP
.RS 4
\fIcoords\fP GLfloat(x,y,z)
.RE
.PP
\fBReturns\fP
.RS 4
void
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.

View File

@ -0,0 +1 @@
.so man3/init.c.3

View File

@ -0,0 +1 @@
.so man3/init.c.3

894
doc/rtfm/man3/fsm.h.3 Normal file
View File

@ -0,0 +1,894 @@
.TH "include/fsm.h" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
include/fsm.h \- fsm (Finite State Machine) management header
.SH SYNOPSIS
.br
.PP
\fC#include <stdbool\&.h>\fP
.br
\fC#include <stddef\&.h>\fP
.br
\fC#include <string\&.h>\fP
.br
\fC#include <gtk\-4\&.0/gtk/gtk\&.h>\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBfsm_struct_journal_unit\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "struct \fBfsm_struct_journal\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "struct \fBfsm_struct_list_tool\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "struct \fBfsm_struct_list_data\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "struct \fBfsm_struct_list_disp\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.in -1c
.SS "Macros"
.in +1c
.ti -1c
.RI "#define \fBJOURNAL_LOG_MAX_LENGTH\fP 255"
.br
.ti -1c
.RI "#define \fBn_rules\fP 128"
.br
.ti -1c
.RI "#define \fBn_objects\fP 32"
.br
.ti -1c
.RI "#define \fBn_situations\fP 128"
.br
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "typedef struct \fBfsm_struct_journal_unit\fP \fBfsm_struct_journal_unit\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "typedef struct \fBfsm_struct_list_tool\fP \fBfsm_struct_list_tool\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "typedef struct \fBfsm_struct_list_data\fP \fBfsm_struct_list_data\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "typedef struct \fBfsm_struct_list_disp\fP \fBfsm_struct_list_disp\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.in -1c
.SS "Enumerations"
.in +1c
.ti -1c
.RI "enum \fBfsm_enum_journal_severity\fP { \fBCRITICAL\fP, \fBERROR\fP, \fBWARNING\fP, \fBINFO\fP, \fBMESSAGE\fP, \fBDEBUG\fP, \fBSPEW\fP }"
.br
.ti -1c
.RI "enum \fBfsm_enum_journal_source\fP { \fBSOURCE\fP, \fBTARGET\fP, \fBJOURNAL\fP, \fBFSM\fP, \fBPREFER\fP, \fBMAIN\fP, \fBAPP\fP, \fBWIDGETS\fP, \fBSIGNAL\fP, \fBMAIN_WINDOW\fP, \fBDIALOG_WINDOW\fP, \fBMODAL_WINDOW\fP, \fBTEXT_WINDOW\fP, \fBAUTO_NOTIFICATION\fP, \fBTOPBAR\fP, \fBTOPBAR_LEFT\fP, \fBTOPBAR_RIGHT\fP, \fBTOPBAR_CENTER\fP, \fBSYNTH_PAGE\fP, \fBSTATE_PAGE\fP, \fBRULES_PAGE\fP, \fBMEASURES_PAGE\fP, \fBRESULTS_PAGE\fP, \fBSenumYNTH_GLAREA\fP, \fBSYNTH_ALL_RESULTS\fP, \fBSYNTH_TIME_DEP_RESULTS\fP, \fBSYNTH_TIME_INDEP_RESULTS\fP, \fBSTATE_TOP\fP, \fBSTATE_BOTTOM\fP, \fBSTATE_GLAREA\fP, \fBSTATE_CAMERA\fP, \fBRULE_GEOMETRY\fP, \fBRULE_GLAREA\fP, \fBRULE_CAMERA\fP, \fBRULE_ALGEBRA\fP, \fBRULE_CONDITION\fP, \fBRULE_ASSIGN\fP, \fBRULE_ID\fP, \fBRULES_TREE\fP, \fBRULES_COMPARE\fP, \fBRULES_USE\fP, \fBMEASURES_TOOLS\fP, \fBMEASURES__ACTIVITY\fP, \fBMEASURES__DISPLAY\fP, \fBRESULTS\fP, \fBTIME_DEP_RESULTS\fP, \fBTIME_INDEP_RESULTS\fP, \fBWIDGET\fP, \fBBUTTON\fP, \fBSCROLL\fP, \fBGLAREA\fP, \fBTEXT\fP, \fBLABEL\fP, \fBTREE\fP, \fBSLIDER\fP, \fBEXPANDER\fP, \fBENTRY\fP, \fBSWITCH_STATE_RULES_DATA\fP, \fBSLIDER_X\fP, \fBSLIDER_Y\fP, \fBSLIDER_Z\fP, \fBSLIDER_A\fP, \fBSLIDER_B\fP, \fBSLIDER_C\fP }"
.br
.ti -1c
.RI "enum \fBfsm_enum_exec_edit\fP { \fBEXEC\fP, \fBEDIT\fP }"
.br
.ti -1c
.RI "enum \fBfsm_enum_state_rules_data\fP { \fBSYNTH\fP, \fBSTATE\fP, \fBRULES\fP, \fBDATA\fP }"
.br
.ti -1c
.RI "enum \fBfsm_enum_store_restore_reset\fP { \fBSTORE\fP, \fBRESTORE\fP, \fBRESET\fP }"
.br
.ti -1c
.RI "enum \fBfsm_enum_measure_type\fP { \fBDATE_RULE_EXEC\fP, \fBRULE_EXEC_NB\fP, \fBOBJECT_NB\fP, \fBELAPSED_TIME\fP }"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "void \fBfsm_journal_publish\fP (\fBfsm_struct_journal\fP jj)"
.br
.ti -1c
.RI "void \fBfsm_journal_init\fP (\fBfsm_struct_journal\fP *jj)"
.br
.RI "2024-09-22 What types of events should be reported ? (fsm, widgets, \&.\&.\&. ) For what purpose ? What information must be collected and transmitted ? How do you name and classify this information ? How do you present it ? "
.ti -1c
.RI "void \fBfsm_journal_push_front\fP (\fBfsm_struct_journal\fP *jj, const char *file_source, const char *function_source, const char *string_value)"
.br
.ti -1c
.RI "void \fBfsm_journal_clear\fP (\fBfsm_struct_journal\fP *jj, const char *file_source, const char *function_source, const char *string_value)"
.br
.ti -1c
.RI "long \fBfsm_journal_pop_back\fP (\fBfsm_struct_journal\fP *jj, const char *file_source, const char *function_source, const char *string_value)"
.br
.ti -1c
.RI "int \fBfsm_journal_length\fP (\fBfsm_struct_journal\fP jj)"
.br
.ti -1c
.RI "void \fBfsm_journal_seek\fP (\fBfsm_struct_journal\fP jj, long usec, const char *file_source, const char *function_source, const char *string_value)"
.br
.ti -1c
.RI "void \fBfsm_journal_publication_request\fP ()"
.br
.RI "The \fBfsm_journal_publication_request()\fP is called only once, by \fBmain()\fP, just after closing the app and before ending the program\&. "
.ti -1c
.RI "void \fBfsm_journal_event\fP (int severity, int source, const char *file_source, const char *function_source, const char *string_value)"
.br
.RI "It is mandatory for any event to call this function to be published in the journal\&. "
.ti -1c
.RI "void \fBfsm_init\fP (char *message)"
.br
.RI "fsm init is the first function called by \fBmain\&.c\fP It initiates the journal and the four lists: 'measures', 'results', 'displayables results' and 'preferences'\&. "
.ti -1c
.RI "void \fBfsm_list_init_preferences\fP ()"
.br
.ti -1c
.RI "void \fBfsm_list_init_measures\fP ()"
.br
.ti -1c
.RI "void \fBfsm_list_init_results\fP ()"
.br
.ti -1c
.RI "void \fBfsm_list_init_displayables\fP ()"
.br
.ti -1c
.RI "int \fBfsm_get_exec_edit\fP ()"
.br
.RI "some client pages (in particular 'state' and 'rules') will be displayed and behave differently depending on whether the fsm is in edit or run state\&. "
.ti -1c
.RI "int \fBfsm_get_state_rules_data\fP ()"
.br
.RI "The value of the static int choice_STATE_RULES_DATA can be one of the enum include/fsm enum fsm_enum_state_rules_data\&. "
.ti -1c
.RI "void \fBfsm_set_exec_edit\fP (int value)"
.br
.RI "setter for the static value: 'choice_STATE_RULES_DATA' (in this file) "
.ti -1c
.RI "void \fBfsm_set_state_rules_data\fP (int value)"
.br
.RI "setter for the static value: 'choice_STATE_RULES_DATA' (in this file) "
.ti -1c
.RI "void \fBfsm_set_store_restore_reset\fP (int choice, int value)"
.br
.ti -1c
.RI "bool \fBfsm_get_preferences_state\fP ()"
.br
.RI "getter for the static boolean: 'preferences_have_been_modified' "
.ti -1c
.RI "void \fBfsm_set_preferences_modified\fP (bool value)"
.br
.RI "setter for the static boolean: 'preferences_have_been_modified' "
.ti -1c
.RI "void \fBfsm_add_measure\fP (char *measure_name)"
.br
.ti -1c
.RI "void \fBfsm_add_result\fP (char *result_name)"
.br
.ti -1c
.RI "void \fBfsm_add_displayable\fP (char *displayable_name)"
.br
.ti -1c
.RI "void \fBfsm_reset_all_situations_values\fP (int value)"
.br
.ti -1c
.RI "void \fBfsm_list_tools_insert\fP (\fBfsm_struct_list_tool\fP **tl, int value)"
.br
.ti -1c
.RI "int \fBfsm_list_tools_pop\fP (\fBfsm_struct_list_tool\fP **tl)"
.br
.ti -1c
.RI "int \fBfsm_list_tools_length\fP (\fBfsm_struct_list_tool\fP *tl)"
.br
.ti -1c
.RI "void \fBfsm_list_tools_clear\fP (\fBfsm_struct_list_tool\fP **tl)"
.br
.ti -1c
.RI "void \fBfsm_list_tools_view\fP (\fBfsm_struct_list_tool\fP *tl)"
.br
.ti -1c
.RI "void \fBfsm_list_tools_test\fP ()"
.br
.ti -1c
.RI "void \fBfsm_rule_trig_measure\fP (int rule_id, int object_id, int measure_id)"
.br
.ti -1c
.RI "void \fBfsm_add_data\fP (\fBfsm_struct_list_data\fP d, int *p_data, int *p_target)"
.br
.ti -1c
.RI "int \fBfsm_get_data\fP (\fBfsm_struct_list_data\fP d, int from, int to)"
.br
.ti -1c
.RI "void \fBfsm_remove_data\fP (\fBfsm_struct_list_data\fP d, int *p_data)"
.br
.in -1c
.SH "Detailed Description"
.PP
fsm (Finite State Machine) management header
This file is part of Gem-graph\&.
.SH "Enumeration Type Documentation"
.PP
.SS "enum \fBfsm_enum_journal_severity\fP"
.IP "\(bu" 2
* * * - J O U R N A L M E T A R U L E S - * * * *
.PP
ref: sudo cat /var/log/messages
.PP
structure d'un log:
.IP "\(bu" 2
date
.IP "\(bu" 2
rang (n° d'ordre)
.IP "\(bu" 2
fichier
.IP "\(bu" 2
fonction
.IP "\(bu" 2
valeur, paramètre, descriptif, contexte,\&.\&.\&. (tout ce qui peut contribuer à améliorer la compréhension du journal) any value that can qualify the event and provides useful information when reading the log\&.
.PP
.PP
.PP
.PP
Un seul \fBfsm_journal_event()\fP par fonction ? sauf si cette fonction génère plusieurs autres fonctions d'intérêt ?
.PP
S'il y a deux \fBfsm_journal_event()\fP (begin / end) dans une fonction, ils doivent avoir la même étiquette (les mêmes valeurs) : SEVERITY & SOURCE
.PP
.IP "\(bu" 2
* * * - J O U R N A L M E T A R U L E S - * * *
.br
.PP
.SH "Function Documentation"
.PP
.SS "void fsm_add_displayable (char * displayable_name)"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
\fBParameters\fP
.RS 4
\fIdisplayable_name\fP
.RE
.PP
.SS "void fsm_add_measure (char * measure_name)"
.PP
\fBSince\fP
.RS 4
2024-09
.RE
.PP
\fBSee also\fP
.RS 4
src/widget/measure/dispatch/widget_measure_event_occurences_nb()
.PP
src/widget/measure/dispatch/widget_measure_event_occurences_dates()
.PP
src/widget/measure/dispatch/widget_measure_event_occurences_situations()
.PP
src/widget/measure/dispatch/widget_measure_time_elapsed_between_two_events()
.PP
src/widget/measure/dispatch/widget_measure_third_event_occurences_in_between()
.PP
src/fsm/dispatch/fsm_journal_event()
.RE
.PP
\fBParameters\fP
.RS 4
\fI*measure_name\fP
.RE
.PP
.SS "int fsm_get_exec_edit ()"
.PP
some client pages (in particular 'state' and 'rules') will be displayed and behave differently depending on whether the fsm is in edit or run state\&. Any function which modifies the appearance or behavior of these pages must use this getter to access the choice_EXEC_EDIT value\&.
.PP
see include/fsm enum fsm_enum_exec_edit { EXEC, EDIT } The current int may be replaced by a boolean \&. TODO
.PP
\fBSince\fP
.RS 4
2024-06
.RE
.PP
\fBSee also\fP
.RS 4
src/widget/one_rule/dispatch
.PP
src/widget/state/dispatch * 2
.PP
src/signal
.PP
choice_EXEC_EDIT and
.PP
include/fsm/enum fsm_enum_exec_edit {}
.RE
.PP
\fBReturns\fP
.RS 4
choice_EXEC_EDIT
.RE
.PP
.SS "bool fsm_get_preferences_state ()"
.PP
getter for the static boolean: 'preferences_have_been_modified'
.PP
\fBSince\fP
.RS 4
2024-08
.RE
.PP
\fBSee also\fP
.RS 4
TODO A function must obtain this boolean when it stores the current state of the fsm (including \fBpreferences\fP) before closing the current session\&.
.RE
.PP
\fBReturns\fP
.RS 4
preferences_have_been_modified
.RE
.PP
.SS "int fsm_get_state_rules_data ()"
.PP
The value of the static int choice_STATE_RULES_DATA can be one of the enum include/fsm enum fsm_enum_state_rules_data\&. To each value is associated a different page and different possible behaviors\&. Any function that modifies the client window must get this value\&.
.PP
see include/fsm enum fsm_enum_state_rules_data { SYNTH, STATE, RULES, DATA }
.PP
\fBSince\fP
.RS 4
2024-06
.RE
.PP
\fBSee also\fP
.RS 4
src/widget/topbar/left
.PP
src/signal
.RE
.PP
\fBReturns\fP
.RS 4
choice_STATE_RULES_DATA
.RE
.PP
.SS "void fsm_init (char * initial_message_from_main)"
.PP
fsm init is the first function called by \fBmain\&.c\fP It initiates the journal and the four lists: 'measures', 'results', 'displayables results' and 'preferences'\&. The items selected in these lists define the current state of the fsm\&.
.PP
\fBSince\fP
.RS 4
2024-08
.RE
.PP
\fBSee also\fP
.RS 4
src/main/main()
.PP
src/journal/fsm_journal_init()
.PP
src/fsm/dispatch/fsm_journal_event()
.PP
src/fsm/measures/manager/fsm_list_init_measures()
.PP
src/fsm/results/manager/fsm_list_init_results()
.PP
src/fsm/preferences/manager/fsm_list_init_displayables()
.PP
src/fsm/preferences/manager/fsm_list_init_preferences()
.RE
.PP
\fBParameters\fP
.RS 4
\fI*initial_message_from_main\fP
.RE
.PP
.SS "void fsm_journal_clear (\fBfsm_struct_journal\fP * jj, const char * file_source, const char * function_source, const char * string_value)"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
\fBParameters\fP
.RS 4
\fI\fP .RE
.PP
return
.SS "void fsm_journal_event (int severity, int source, const char * file_source, const char * function_source, const char * string_value)"
.PP
It is mandatory for any event to call this function to be published in the journal\&. Before publication, a filter can be applied here (and only here) to select only some events of interest (during debugging, for example)\&.
.PP
If there are too many events, a filter can be applied here to select a few interesting events for publication in the log\&.
.PP
This filter can operate on any the following five parameters: severity, source, *file_source, *function_source, *string_value\&.
.PP
\fBSee also\fP
.RS 4
below (params)
.RE
.PP
Simple filters (on a single parameter) can be combined using the logical operators 'and' and 'or' and parentheses\&.
.PP
Use: $ grep -r 'fsm_journal_event' to confirm the callergraph calls\&.
.PP
\fBSince\fP
.RS 4
2024-08
.RE
.PP
\fBSee also\fP
.RS 4
\fBsrc/journal\&.c\fP/fsm_journal_push_front()
.PP
src/main/main()
.PP
src/widget/topbar/modal\&.c
.PP
src/widget/topbar/right\&.c
.PP
src/widget/topbar/dialog\&.c
.PP
src/widget/topbar/left\&.c
.PP
\fBsrc/widget/topbar/dispatch\&.c\fP * 3
.PP
src/widget/one_rule/dispatch\&.c
.PP
\fBsrc/widget/one_rule/algebra/conditions\&.c\fP * 2
.PP
src/widget/measure/dispatch\&.c
.PP
\fBsrc/widget/dispatch\&.c\fP * 3
.PP
src/widget/all_rules/dispatch\&.c
.PP
\fBsrc/fsm/preferences/manager\&.c\fP * 8
.PP
\fBsrc/fsm/measures/manager\&.c\fP * 2
.PP
src/fsm/measures/tools_list\&.c * 4
.PP
\fBsrc/fsm/dispatch\&.c\fP * 10
.PP
\fBsrc/fsm/results/manager\&.c\fP
.PP
src/util/tree\&.c
.PP
\fBsrc/signal\&.c\fP * 38
.RE
.PP
\fBParameters\fP
.RS 4
\fIseverity\fP <>
.RE
.PP
\fBSee also\fP
.RS 4
enum \fBfsm_enum_journal_severity\fP in \fBinclude/fsm\&.h\fP 'severity' is a pre-defined value that must be associated to each event\&. It ranges from zero to six : CRITICAL ERROR WARNING INFO MESSAGE DEBUG SPEW 0 1 2 3 4 5 6
.RE
.PP
\fBParameters\fP
.RS 4
\fIsource\fP <>
.RE
.PP
\fBSee also\fP
.RS 4
enum fsm_enum_journal_source in \fBinclude/fsm\&.h\fP 'source' is a pre-defined value that can be associated to each event\&. It is not mandatory\&. It can be set to 'NULL'\&.
.RE
.PP
\fBParameters\fP
.RS 4
\fI*file_source\fP <> the name of the file that emits the event\&.
.br
\fI*function_source\fP <> the function that emits the event\&.
.br
\fI*string_value\fP <> any value that can qualify the event and provides useful information when reading the log\&.
.RE
.PP
.SS "void fsm_journal_init (\fBfsm_struct_journal\fP * jj)"
.PP
2024-09-22 What types of events should be reported ? (fsm, widgets, \&.\&.\&. ) For what purpose ? What information must be collected and transmitted ? How do you name and classify this information ? How do you present it ? date clé (rank) fichier source fonction source +/- valeur
.br
.PP
.nf
time_t current_time = time(NULL);
.fi
.PP
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(&current_time));
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
\fBParameters\fP
.RS 4
\fI\fP .RE
.PP
return
.SS "int fsm_journal_length (\fBfsm_struct_journal\fP jj)"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
\fBParameters\fP
.RS 4
\fI\fP .RE
.PP
return
.SS "long fsm_journal_pop_back (\fBfsm_struct_journal\fP * jj, const char * file_source, const char * function_source, const char * string_value)"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
\fBParameters\fP
.RS 4
\fI\fP .RE
.PP
return
.SS "void fsm_journal_publication_request ()"
.PP
The \fBfsm_journal_publication_request()\fP is called only once, by \fBmain()\fP, just after closing the app and before ending the program\&. This is to guarantee the chronological order of the events in the journal\&.
.PP
The log is modified for each event but events can be send asynchronously\&. This is why the journal is only published once, before the end of 'main()', Its chronological order is therefore guaranteed\&.
.PP
\fBsrc/journal\&.c\fP/fsm_journal_publish() (called here) is the last function of the program to be executed\&.
.PP
The \fBfsm_struct_journal\fP (gg_logs) is a static instance in this file\&. Therefore, all the functions that read or write it are in this file\&. This is to avoid uncontrolled operations on it\&.
.PP
\fBSince\fP
.RS 4
2024-08
.RE
.PP
\fBSee also\fP
.RS 4
src/main/main()
.PP
src/journal/fsm_journal_publish()
.RE
.PP
.SS "void fsm_journal_publish (\fBfsm_struct_journal\fP jj)"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
\fBParameters\fP
.RS 4
\fI\fP .RE
.PP
return
.SS "void fsm_journal_push_front (\fBfsm_struct_journal\fP * jj, const char * file_source, const char * function_source, const char * string_value)"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
\fBParameters\fP
.RS 4
\fI\fP .RE
.PP
return
.SS "void fsm_journal_seek (\fBfsm_struct_journal\fP jj, long usec, const char * file_source, const char * function_source, const char * string_value)"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
\fBParameters\fP
.RS 4
\fI\fP .RE
.PP
return
.SS "void fsm_list_init_displayables ()"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.RE
.PP
.SS "void fsm_list_init_measures ()"
.PP
\fBSince\fP
.RS 4
2024-09
.RE
.PP
\fBSee also\fP
.RS 4
src/fsm/dispatch/fsm_init()
.RE
.PP
.SS "void fsm_list_init_preferences ()"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
.SS "void fsm_reset_all_situations_values (int value)"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
\fBParameters\fP
.RS 4
\fIvalue\fP
.RE
.PP
.SS "void fsm_rule_trig_measure (int rule_id, int object_id, int measure_id)"
.PP
\fBSince\fP
.RS 4
2024-09
.RE
.PP
\fBParameters\fP
.RS 4
\fIrule_id\fP
.br
\fIobject_id\fP
.br
\fImeasure_id\fP
.RE
.PP
.SS "void fsm_set_exec_edit (int choice)"
.PP
setter for the static value: 'choice_STATE_RULES_DATA' (in this file) see include/fsm enum fsm_enum_exec_edit { EXEC, EDIT }
.PP
\fBSince\fP
.RS 4
2024-08
.RE
.PP
\fBSee also\fP
.RS 4
src/signal * 2
.RE
.PP
\fBParameters\fP
.RS 4
\fIchoice\fP < a boolean value which can be 'EXEC' or 'EDIT'
.RE
.PP
.SS "void fsm_set_preferences_modified (bool value)"
.PP
setter for the static boolean: 'preferences_have_been_modified'
.PP
\fBSince\fP
.RS 4
2024-08
.RE
.PP
\fBSee also\fP
.RS 4
TODO To be used by any function that modifies the current user \fBpreferences\fP
.PP
\fBfsm_journal_event()\fP
.RE
.PP
\fBParameters\fP
.RS 4
\fIvalue\fP = TRUE if preferences_have_been_modified\&.
.RE
.PP
.SS "void fsm_set_state_rules_data (int choice)"
.PP
setter for the static value: 'choice_STATE_RULES_DATA' (in this file) see include/fsm enum fsm_enum_state_rules_data { SYNTH, STATE, RULES, DATA } Today (2024-10) the initial page is set to 'SYNTH'\&.
.PP
\fBSee also\fP
.RS 4
line 292 choice_STATE_RULES_DATA = SYNTH; NB This choice can be temporarily modified for debugging purpose:
.PP
end of the function: \fBfsm/dispatch\&.c\fP window_design_topbar_left()
.RE
.PP
\fBSince\fP
.RS 4
2024-08
.RE
.PP
\fBSee also\fP
.RS 4
src/signal * 4
.RE
.PP
\fBParameters\fP
.RS 4
\fIchoice\fP
.RE
.PP
.SS "void fsm_set_store_restore_reset (int choice, int value)"
.PP
\fBDate\fP
.RS 4
.RE
.PP
\fBAuthor\fP
.RS 4
.RE
.PP
\fBSee also\fP
.RS 4
.PP
.RE
.PP
\fBParameters\fP
.RS 4
\fIchoice\fP
.br
\fIvalue\fP
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

View File

@ -0,0 +1 @@
.so man3/manager.c.3

View File

@ -0,0 +1 @@
.so man3/manager.c.3

View File

@ -0,0 +1 @@
.so man3/noname

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

View File

@ -0,0 +1 @@
.so man3/noname

View File

@ -0,0 +1 @@
.so man3/noname

View File

@ -0,0 +1 @@
.so man3/noname

View File

@ -0,0 +1 @@
.so man3/noname

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

View File

@ -0,0 +1 @@
.so man3/fsm.h.3

View File

@ -0,0 +1 @@
.so man3/manager.c.3

View File

@ -0,0 +1 @@
.so man3/manager.c.3

Some files were not shown because too many files have changed in this diff Show More