104 lines
4.3 KiB
XML
104 lines
4.3 KiB
XML
<?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="_main_8c" xml:lang="en-US">
|
|
<title>src/main.c File Reference</title>
|
|
<indexterm><primary>src/main.c</primary></indexterm>
|
|
<para>
|
|
|
|
<para>Gem-graph-client main file. </para>
|
|
|
|
</para>
|
|
<programlisting linenumbering="unnumbered">#include "../include/fsm.h"<?linebreak?>#include "../include/signal.h"<?linebreak?>#include "../include/widget.h"<?linebreak?></programlisting>Include dependency graph for main.c:<para>
|
|
<informalfigure>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d4/d00/main_8c__incl.png"></imagedata>
|
|
</imageobject>
|
|
</mediaobject>
|
|
</informalfigure>
|
|
</para>
|
|
<simplesect>
|
|
<title>Functions </title>
|
|
<itemizedlist>
|
|
<listitem><para>int <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main</link> (int argc, char **argv)</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</simplesect>
|
|
<section>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>Gem-graph-client main file. </para>
|
|
|
|
<para>This file is part of Gem-graph. It contains only the <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> function.</para>
|
|
|
|
<para>The <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> function initialises the log, the finite state machine (fsm), the application and the windows and closes all the elements it opened before the end of program execution. By default, the main window opens on the overview page of the current model. <formalpara><title>See also</title>
|
|
|
|
<para>src/widget/main_window/topbar/dispatch/widget_design_main_window() </para>
|
|
|
|
<para>src/widget/main_window/topbar/left/WANT_TO_START_ON_ANOTHER_PAGE</para>
|
|
</formalpara>
|
|
There are several types of organisation in src (sources).</para>
|
|
|
|
<para>The widgets that give the windows their appearance are organised in a tree-like hierarchy. The fsm (finite state machine), which controls the program's actions and indicates its state at all times, contains the following main sections: execution/editing, main view, measurements/results, preferences.</para>
|
|
|
|
<para>The other functions are those that manage graphics and utilities. They are called "transversal" because they must be easily accessed by all the preceding functions. They therefore remain at the root (src). </para>
|
|
</section>
|
|
<section>
|
|
<title>Function Documentation</title>
|
|
<anchor xml:id="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627"/><section>
|
|
<title>main()</title>
|
|
<indexterm><primary>main</primary><secondary>main.c</secondary></indexterm>
|
|
<indexterm><primary>main.c</primary><secondary>main</secondary></indexterm>
|
|
<para><computeroutput>int main (int argc, char ** argv)</computeroutput></para>
|
|
<para><formalpara><title>Since</title>
|
|
|
|
<para>2024-04</para>
|
|
</formalpara>
|
|
<formalpara><title>See also</title>
|
|
|
|
<para>src/fsm/dispatch/fsm_init() </para>
|
|
|
|
<para>src/widget/dispatch/on_windows_activation(app)</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>argc</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>**argv</entry><entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara><title>Returns</title>
|
|
|
|
<para>status, the program errorlevel </para>
|
|
</formalpara>
|
|
</para>
|
|
Here is the call graph for this function:<para>
|
|
<informalfigure>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d0/d09/main_8c_a3c04138a5bfe5d72780bb7e82a18e627_cgraph.png"></imagedata>
|
|
</imageobject>
|
|
</mediaobject>
|
|
</informalfigure>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</section>
|