2024-10-19 16:05:49 +02:00
<?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 < stdbool.h> <?linebreak?> #include < stddef.h> <?linebreak?> #include < gtk-4.0/gtk/gtk.h> <?linebreak?> #include " ../include/fsm.h" <?linebreak?> </programlisting> <simplesect >
<title > Classes </title>
<itemizedlist >
<listitem > <para > struct <link linkend= "_structpile" > pile</link> </para>
2024-10-22 23:58:04 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > struct <link linkend= "_structelem" > elem</link> </para>
2024-10-22 23:58:04 +02:00
<para > simplest element of a double-chained list </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > struct <link linkend= "_structdblist" > dblist</link> </para>
2024-10-22 23:58:04 +02:00
<para > required to init the empty list </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > struct <link linkend= "_structslist" > slist</link> </para>
2024-10-22 23:58:04 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</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>
2024-10-22 23:58:04 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > <anchor xml:id= "_util_8h_1a03f28ef452dbb87c629a2b39da6fc63c" /> typedef struct <link linkend= "_structelem" > elem</link> <emphasis role= "strong" > elem</emphasis> </para>
2024-10-22 23:58:04 +02:00
<para > simplest element of a double-chained list </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > <anchor xml:id= "_util_8h_1a6f169a5dcb2ec0f7ab8120292cf14d9e" /> typedef struct <link linkend= "_structslist" > slist</link> <emphasis role= "strong" > slist</emphasis> </para>
2024-10-22 23:58:04 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</listitem>
</itemizedlist>
</simplesect>
<simplesect >
<title > Functions </title>
<itemizedlist >
2024-10-20 01:05:12 +02:00
<listitem > <para > char * <link linkend= "_util_8h_1a40bb126a021a338b20022e741bbd4ae1" > util_read_file</link> (char *filename)</para>
<para > reads a file from filename into a provided buffer </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > char * <link linkend= "_util_8h_1a7a9bfe2d249e5da19a1117c7d5636b8a" > util_concat</link> (const char *str,...)</para>
<para > <link xlink:href= "https://sourceware.org/glibc/manual/latest/html_mono/libc.html#Variadic-Prototypes" > https://sourceware.org/glibc/manual/latest/html_mono/libc.html#Variadic-Prototypes</link> </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > void <link linkend= "_util_8h_1a87a9dcc9beba6b65e30ce4294c20713d" > util_pile_clear</link> (<link linkend= "_structpile" > pile</link> **)</para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > void <link linkend= "_util_8h_1afbc42bf42f66e0aa969de04212c4e07a" > util_pile_view</link> (<link linkend= "_structpile" > pile</link> *)</para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > int <link linkend= "_util_8h_1ae6f16aafebd809c62cacd9abc3892925" > util_pile_push</link> (<link linkend= "_structpile" > pile</link> **, int)</para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > int <link linkend= "_util_8h_1a121e2ed13ed9448f33173ebaefba3679" > util_pile_pop</link> (<link linkend= "_structpile" > pile</link> **)</para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > int <link linkend= "_util_8h_1afbb61183d866a834bdf9cae2be6c84f5" > util_pile_length</link> (<link linkend= "_structpile" > pile</link> *p)</para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > void <link linkend= "_util_8h_1a3133311b2fe84f2d9745f67f2cc02bd3" > util_list_2x2_init</link> (<link linkend= "_structdblist" > dblist</link> *l)</para>
<para > Phantom documentation. </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > void <link linkend= "_util_8h_1abfc7d5a8fff1bd14f16a501ee1755349" > util_list_2x2_clear</link> (<link linkend= "_structdblist" > dblist</link> *l)</para>
<para > Phantom documentation. </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > void <link linkend= "_util_8h_1aad019969171d29bf58df2740fe15d738" > util_list_2x2_view</link> (<link linkend= "_structdblist" > dblist</link> l)</para>
<para > Phantom documentation. </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > int <link linkend= "_util_8h_1ae173600429156cca4e5755d5aa628b81" > util_list_2x2_push_back</link> (<link linkend= "_structdblist" > dblist</link> *l, int val)</para>
<para > Phantom documentation. </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > int <link linkend= "_util_8h_1a41d729a609f850d89a40e161c4cf189d" > util_list_2x2_push_front</link> (<link linkend= "_structdblist" > dblist</link> *l, int val)</para>
<para > Phantom documentation. </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > int <link linkend= "_util_8h_1a275a40c54b4c7ec73191a4ed1aba4936" > util_list_2x2_pop_back</link> (<link linkend= "_structdblist" > dblist</link> *l)</para>
<para > Phantom documentation. </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > int <link linkend= "_util_8h_1a838636447589eb073de9b8a0f20346d5" > util_list_2x2_pop_front</link> (<link linkend= "_structdblist" > dblist</link> *l)</para>
<para > Phantom documentation. </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > int <link linkend= "_util_8h_1ae764753e3beb9811561b0ced2a625981" > util_list_2x2_length</link> (<link linkend= "_structdblist" > dblist</link> l)</para>
<para > Phantom documentation. </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > void <link linkend= "_util_8h_1a1133cba5111479ea7d7c4a79778560e1" > util_sorted_list_clear</link> (<link linkend= "_structslist" > slist</link> **sl)</para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > void <link linkend= "_util_8h_1a87a5b344dd2c0ea1af5d36ea67b12517" > util_sorted_list_view</link> (<link linkend= "_structslist" > slist</link> *sl)</para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > int <link linkend= "_util_8h_1ad75bea7d8dfb1dad20cd99a92a045f19" > util_sorted_list_insert</link> (<link linkend= "_structslist" > slist</link> **sl, int val)</para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > int <link linkend= "_util_8h_1aee1f73cdb28ee531042c9f84875d3e5f" > util_sorted_list_pop</link> (<link linkend= "_structslist" > slist</link> **sl)</para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 23:03:17 +02:00
<listitem > <para > int <link linkend= "_util_8h_1a35eb9fbef7ed4d3e9dc93f74d0e9934a" > util_sorted_list_length</link> (<link linkend= "_structslist" > slist</link> *sl)</para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > <anchor xml:id= "_util_8h_1aaa9fc96cf3047e5a323156c7f500d5fb" /> void <emphasis role= "strong" > util_trigger_test</emphasis> ()</para>
2024-10-20 23:03:17 +02:00
<para > simplifying utilities tests </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > <anchor xml:id= "_util_8h_1a05aec803518f49ffdeff1db6045a6652" /> void <emphasis role= "strong" > util_test_pile</emphasis> ()</para>
2024-10-20 23:03:17 +02:00
<para > sample test </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > <anchor xml:id= "_util_8h_1a2237b720be9f32414c3caccc1bec0d97" /> void <emphasis role= "strong" > util_test_double_list</emphasis> ()</para>
2024-10-20 23:03:17 +02:00
<para > sample test </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > <anchor xml:id= "_util_8h_1a94626d7f8c95811287f249c2db85448f" /> void <emphasis role= "strong" > util_test_sorted_list</emphasis> ()</para>
2024-10-20 23:03:17 +02:00
<para > sample test </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > long <link linkend= "_util_8h_1adbe03a3d239b22390e9de809443c8df9" > util_gl_get_stack</link> (void *container_widget)</para>
2024-10-20 23:03:17 +02:00
<para > Look for stack entry and returns stack_id. </para>
2024-10-19 16:05:49 +02:00
</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 >
2024-10-20 23:03:17 +02:00
<para > meaning which axis we' re building (for label)</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-22 23:58:04 +02:00
<para > GtkWidget* pointer to the new widget </para>
2024-10-20 23:03:17 +02:00
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1a7a9bfe2d249e5da19a1117c7d5636b8a" /> <section >
<title > util_concat()</title>
<indexterm > <primary > util_concat</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_concat</secondary> </indexterm>
<para > <computeroutput > char * util_concat (const char * str, ...)</computeroutput> </para> <para >
<para > <link xlink:href= "https://sourceware.org/glibc/manual/latest/html_mono/libc.html#Variadic-Prototypes" > https://sourceware.org/glibc/manual/latest/html_mono/libc.html#Variadic-Prototypes</link> </para>
</para>
<para > <formalpara > <title > See also</title>
<para > (in glibc/manual) > ellipsis (‘…’) A.2.2.2 Receiving the Argument Values</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 > *str</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
2024-10-20 23:03:17 +02:00
<row >
<entry > ...</entry> <entry > </entry>
</row>
2024-10-19 16:05:49 +02:00
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-20 23:03:17 +02:00
<para > * </para>
2024-10-19 16:05:49 +02:00
</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 >
2024-10-20 23:03:17 +02:00
<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 > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-19 16:05:49 +02:00
<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 >
2024-10-20 23:03:17 +02:00
<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 > </entry>
</row>
2024-10-19 16:05:49 +02:00
<row >
2024-10-20 23:03:17 +02:00
<entry > *error_buffer</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > success </para>
</formalpara>
</para>
</section>
2024-10-19 16:05:49 +02:00
<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>
2024-10-22 23:58:04 +02:00
<para > DO NOT DOCUMENT param void < argument ' void' of command @ param is not found</para>
2024-10-20 23:03:17 +02:00
2024-10-22 23:58:04 +02:00
<para > DO NOT DOCUMENT returns bool true if success < does not return anything </para>
2024-10-19 16:05:49 +02:00
</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 >
2024-10-20 23:03:17 +02:00
<entry > *container_widget</entry> <entry >
2024-10-22 23:58:04 +02:00
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
<row >
2024-10-20 23:03:17 +02:00
<entry > *error_buffer</entry> <entry > </entry>
2024-10-19 16:05:49 +02:00
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-22 23:58:04 +02:00
<para > success </para>
2024-10-19 16:05:49 +02:00
</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 >
2024-10-20 23:03:17 +02:00
<entry > *container_widget</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
<row >
<entry > axis</entry> <entry >
2024-10-20 23:03:17 +02:00
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
<row >
2024-10-20 23:03:17 +02:00
<entry > value</entry> <entry > </entry>
2024-10-19 16:05:49 +02:00
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > bool: true if success </para>
</formalpara>
</para>
</section>
2024-10-20 01:05:12 +02:00
<anchor xml:id= "_util_8h_1abfc7d5a8fff1bd14f16a501ee1755349" /> <section >
<title > util_list_2x2_clear()</title>
<indexterm > <primary > util_list_2x2_clear</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_list_2x2_clear</secondary> </indexterm>
<para > <computeroutput > void util_list_2x2_clear (<link linkend= "_structdblist" > dblist</link> * l)</computeroutput> </para> <para >
<para > Phantom documentation. </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 > *l</entry> <entry >
<para > </para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1a3133311b2fe84f2d9745f67f2cc02bd3" /> <section >
<title > util_list_2x2_init()</title>
<indexterm > <primary > util_list_2x2_init</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_list_2x2_init</secondary> </indexterm>
<para > <computeroutput > void util_list_2x2_init (<link linkend= "_structdblist" > dblist</link> * l)</computeroutput> </para> <para >
<para > Phantom documentation. </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 > *l</entry> <entry >
<para > </para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1ae764753e3beb9811561b0ced2a625981" /> <section >
<title > util_list_2x2_length()</title>
<indexterm > <primary > util_list_2x2_length</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_list_2x2_length</secondary> </indexterm>
<para > <computeroutput > int util_list_2x2_length (<link linkend= "_structdblist" > dblist</link> l)</computeroutput> </para> <para >
<para > Phantom documentation. </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 > *l</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > int </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1a275a40c54b4c7ec73191a4ed1aba4936" /> <section >
<title > util_list_2x2_pop_back()</title>
<indexterm > <primary > util_list_2x2_pop_back</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_list_2x2_pop_back</secondary> </indexterm>
<para > <computeroutput > int util_list_2x2_pop_back (<link linkend= "_structdblist" > dblist</link> * l)</computeroutput> </para> <para >
<para > Phantom documentation. </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 > *l</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > int </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1a838636447589eb073de9b8a0f20346d5" /> <section >
<title > util_list_2x2_pop_front()</title>
<indexterm > <primary > util_list_2x2_pop_front</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_list_2x2_pop_front</secondary> </indexterm>
<para > <computeroutput > int util_list_2x2_pop_front (<link linkend= "_structdblist" > dblist</link> * l)</computeroutput> </para> <para >
<para > Phantom documentation. </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 > *l</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > int </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1ae173600429156cca4e5755d5aa628b81" /> <section >
<title > util_list_2x2_push_back()</title>
<indexterm > <primary > util_list_2x2_push_back</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_list_2x2_push_back</secondary> </indexterm>
<para > <computeroutput > int util_list_2x2_push_back (<link linkend= "_structdblist" > dblist</link> * l, int val)</computeroutput> </para> <para >
<para > Phantom documentation. </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 > *l</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > val</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > int </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1a41d729a609f850d89a40e161c4cf189d" /> <section >
<title > util_list_2x2_push_front()</title>
<indexterm > <primary > util_list_2x2_push_front</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_list_2x2_push_front</secondary> </indexterm>
<para > <computeroutput > int util_list_2x2_push_front (<link linkend= "_structdblist" > dblist</link> * l, int val)</computeroutput> </para> <para >
<para > Phantom documentation. </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 > *l</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > val</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > int </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1aad019969171d29bf58df2740fe15d738" /> <section >
<title > util_list_2x2_view()</title>
<indexterm > <primary > util_list_2x2_view</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_list_2x2_view</secondary> </indexterm>
<para > <computeroutput > void util_list_2x2_view (<link linkend= "_structdblist" > dblist</link> l)</computeroutput> </para> <para >
<para > Phantom documentation. </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 > *l</entry> <entry >
<para > </para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
2024-10-20 23:03:17 +02:00
<anchor xml:id= "_util_8h_1a87a9dcc9beba6b65e30ce4294c20713d" /> <section >
<title > util_pile_clear()</title>
<indexterm > <primary > util_pile_clear</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_pile_clear</secondary> </indexterm>
<para > <computeroutput > void util_pile_clear (<link linkend= "_structpile" > pile</link> ** p)</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 > **p</entry> <entry >
<para > </para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1afbb61183d866a834bdf9cae2be6c84f5" /> <section >
<title > util_pile_length()</title>
<indexterm > <primary > util_pile_length</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_pile_length</secondary> </indexterm>
<para > <computeroutput > int util_pile_length (<link linkend= "_structpile" > pile</link> * p)</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 > **p</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > length </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1a121e2ed13ed9448f33173ebaefba3679" /> <section >
<title > util_pile_pop()</title>
<indexterm > <primary > util_pile_pop</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_pile_pop</secondary> </indexterm>
<para > <computeroutput > int util_pile_pop (<link linkend= "_structpile" > pile</link> ** p)</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 > **p</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > value </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1ae6f16aafebd809c62cacd9abc3892925" /> <section >
<title > util_pile_push()</title>
<indexterm > <primary > util_pile_push</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_pile_push</secondary> </indexterm>
<para > <computeroutput > int util_pile_push (<link linkend= "_structpile" > pile</link> ** p, int value)</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 > **p</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > value</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > value </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1afbc42bf42f66e0aa969de04212c4e07a" /> <section >
<title > util_pile_view()</title>
<indexterm > <primary > util_pile_view</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_pile_view</secondary> </indexterm>
<para > <computeroutput > void util_pile_view (<link linkend= "_structpile" > pile</link> * p)</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 > **p</entry> <entry >
<para > </para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
2024-10-20 01:05:12 +02:00
<anchor xml:id= "_util_8h_1a40bb126a021a338b20022e741bbd4ae1" /> <section >
<title > util_read_file()</title>
<indexterm > <primary > util_read_file</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_read_file</secondary> </indexterm>
<para > <computeroutput > char * util_read_file (char * filename)</computeroutput> </para> <para >
<para > reads a file from filename into a provided 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 > *filename</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > char </para>
</formalpara>
</para>
</section>
2024-10-20 23:03:17 +02:00
<anchor xml:id= "_util_8h_1a1133cba5111479ea7d7c4a79778560e1" /> <section >
<title > util_sorted_list_clear()</title>
<indexterm > <primary > util_sorted_list_clear</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_sorted_list_clear</secondary> </indexterm>
<para > <computeroutput > void util_sorted_list_clear (<link linkend= "_structslist" > slist</link> ** sl)</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 > **sl</entry> <entry >
<para > </para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1ad75bea7d8dfb1dad20cd99a92a045f19" /> <section >
<title > util_sorted_list_insert()</title>
<indexterm > <primary > util_sorted_list_insert</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_sorted_list_insert</secondary> </indexterm>
<para > <computeroutput > int util_sorted_list_insert (<link linkend= "_structslist" > slist</link> ** sl, int value)</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 > **sl</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > value</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > value </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1a35eb9fbef7ed4d3e9dc93f74d0e9934a" /> <section >
<title > util_sorted_list_length()</title>
<indexterm > <primary > util_sorted_list_length</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_sorted_list_length</secondary> </indexterm>
<para > <computeroutput > int util_sorted_list_length (<link linkend= "_structslist" > slist</link> * sl)</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 > **sl</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > length </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1aee1f73cdb28ee531042c9f84875d3e5f" /> <section >
<title > util_sorted_list_pop()</title>
<indexterm > <primary > util_sorted_list_pop</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_sorted_list_pop</secondary> </indexterm>
<para > <computeroutput > int util_sorted_list_pop (<link linkend= "_structslist" > slist</link> ** sl)</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 > **sl</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > value </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_util_8h_1a87a5b344dd2c0ea1af5d36ea67b12517" /> <section >
<title > util_sorted_list_view()</title>
<indexterm > <primary > util_sorted_list_view</primary> <secondary > util.h</secondary> </indexterm>
<indexterm > <primary > util.h</primary> <secondary > util_sorted_list_view</secondary> </indexterm>
<para > <computeroutput > void util_sorted_list_view (<link linkend= "_structslist" > slist</link> * sl)</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 > **sl</entry> <entry >
<para > </para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
2024-10-19 16:05:49 +02:00
</section>
</section>
