cleaning under doxygen control: @see doc/latex/annotated.tex line 15 < why so long ?
This commit is contained in:
parent
862b316526
commit
aad5f5a470
GPG Key ID:
FB3115C340E057E3
|
|
@ -4,6 +4,14 @@ https://thevaluable.dev/sed-cli-practical-guide-examples/#the-basics-of-sed
|
||||||
********************************************************************************
|
********************************************************************************
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Comment gerer l'image du curseur ?
|
||||||
|
* https://docs.gtk.org/gdk4/class.Cursor.html TODO
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
********************************************************************************
|
||||||
|
|
||||||
/*
|
/*
|
||||||
printf("voir à la fin de 'main: étude des limites de la fonction 'snprintf()'\n");
|
printf("voir à la fin de 'main: étude des limites de la fonction 'snprintf()'\n");
|
||||||
|
|
||||||
|
|
|
||||||
50
doc/Doxyfile
50
doc/Doxyfile
|
|
@ -1,5 +1,28 @@
|
||||||
# Doxyfile 1.9.8
|
# Doxyfile 1.9.8
|
||||||
|
|
||||||
|
#---------------------------------------------------------------------------
|
||||||
|
# Configuration options related to:
|
||||||
|
# - 51 - project definition (... PROJECT_NAME = "Gem-graph" ...)
|
||||||
|
# - 534 - doc building (... EXTRACT_ALL = NO ...)
|
||||||
|
# - 855 - warning and progress messages (QUIET = NO)
|
||||||
|
# - 961 - input files (INPUT = ./)
|
||||||
|
# - 1149 - source browsing (To get rid of source code:
|
||||||
|
# SOURCE_BROWSER = NO + VERBATIM_HEADERS = NO)
|
||||||
|
# - 1235 - alphabetical class index (ALPHABETICAL_INDEX = YES)
|
||||||
|
# - 1255 - HTML output (GENERATE_HTML = NO)
|
||||||
|
# - 1901 - LaTeX output (GENERATE_LATEX = YES)
|
||||||
|
# - 2084 - RTF output (GENERATE_RTF = NO)
|
||||||
|
# - 2140 - man page output (GENERATE_MAN = YES)
|
||||||
|
# - 2184 - XML output (GENERATE_XML = NO)
|
||||||
|
# - 2218 - DOCBOOK output (GENERATE_DOCBOOK = YES)
|
||||||
|
# - 2236 - AutoGen Definitions output (experimental)
|
||||||
|
# - 2248 - Sqlite3 output (GENERATE_SQLITE3 = YES)
|
||||||
|
# - 2274 - Perl module output (experimental)
|
||||||
|
# - 2312 - preprocessor (ENABLE_PREPROCESSING = YES)
|
||||||
|
# - 2391 - external references (using TAGFILES)
|
||||||
|
# - 2437 - diagram generator tools (if HAVE_DOT = YES)
|
||||||
|
#---------------------------------------------------------------------------
|
||||||
|
|
||||||
# This file describes the settings to be used by the documentation system
|
# This file describes the settings to be used by the documentation system
|
||||||
# doxygen (www.doxygen.org) for a project.
|
# doxygen (www.doxygen.org) for a project.
|
||||||
#
|
#
|
||||||
|
|
@ -507,7 +530,7 @@ NUM_PROC_THREADS = 1
|
||||||
TIMESTAMP = NO
|
TIMESTAMP = NO
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Build related configuration options
|
# Documentation building related configuration options
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
|
|
||||||
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
|
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
|
||||||
|
|
@ -933,7 +956,7 @@ WARN_LINE_FORMAT = "at line $line of file $file"
|
||||||
|
|
||||||
WARN_LOGFILE =
|
WARN_LOGFILE =
|
||||||
|
|
||||||
#--------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Configuration options related to the input files
|
# Configuration options related to the input files
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
@ -964,6 +987,7 @@ INPUT_ENCODING = UTF-8
|
||||||
# "INPUT_ENCODING" for further information on supported encodings.
|
# "INPUT_ENCODING" for further information on supported encodings.
|
||||||
|
|
||||||
INPUT_FILE_ENCODING =
|
INPUT_FILE_ENCODING =
|
||||||
|
|
||||||
# If the value of the INPUT tag contains directories, you can use the
|
# If the value of the INPUT tag contains directories, you can use the
|
||||||
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
|
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
|
||||||
# *.h) to filter out the source-files in the directories.
|
# *.h) to filter out the source-files in the directories.
|
||||||
|
|
@ -1014,7 +1038,7 @@ EXCLUDE_SYMLINKS = NO
|
||||||
# Note that the wildcards are matched against the file with absolute path, so to
|
# Note that the wildcards are matched against the file with absolute path, so to
|
||||||
# exclude all test directories for example use the pattern */test/*
|
# exclude all test directories for example use the pattern */test/*
|
||||||
|
|
||||||
EXCLUDE_PATTERNS =
|
EXCLUDE_PATTERNS = */latex/* */html/*
|
||||||
|
|
||||||
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
||||||
# (namespaces, classes, functions, etc.) that should be excluded from the
|
# (namespaces, classes, functions, etc.) that should be excluded from the
|
||||||
|
|
@ -1204,7 +1228,7 @@ USE_HTAGS = NO
|
||||||
# See also: Section \class.
|
# See also: Section \class.
|
||||||
# The default value is: YES.
|
# The default value is: YES.
|
||||||
|
|
||||||
VERBATIM_HEADERS = YES
|
VERBATIM_HEADERS = NO
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Configuration options related to the alphabetical class index
|
# Configuration options related to the alphabetical class index
|
||||||
|
|
@ -1233,7 +1257,7 @@ IGNORE_PREFIX =
|
||||||
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
|
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
|
||||||
# The default value is: YES.
|
# The default value is: YES.
|
||||||
|
|
||||||
GENERATE_HTML = YES
|
GENERATE_HTML = NO
|
||||||
|
|
||||||
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
|
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
|
||||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||||
|
|
@ -1241,7 +1265,7 @@ GENERATE_HTML = YES
|
||||||
# The default directory is: html.
|
# The default directory is: html.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
HTML_OUTPUT = html
|
HTML_OUTPUT = doc/html
|
||||||
|
|
||||||
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
|
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
|
||||||
# generated HTML page (for example: .htm, .php, .asp).
|
# generated HTML page (for example: .htm, .php, .asp).
|
||||||
|
|
@ -1887,7 +1911,7 @@ GENERATE_LATEX = YES
|
||||||
# The default directory is: latex.
|
# The default directory is: latex.
|
||||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||||
|
|
||||||
LATEX_OUTPUT = latex
|
LATEX_OUTPUT = doc/latex
|
||||||
|
|
||||||
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
||||||
# invoked.
|
# invoked.
|
||||||
|
|
@ -2119,7 +2143,7 @@ RTF_EXTENSIONS_FILE =
|
||||||
# classes and files.
|
# classes and files.
|
||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
|
|
||||||
GENERATE_MAN = NO
|
GENERATE_MAN = YES
|
||||||
|
|
||||||
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
|
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
|
||||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||||
|
|
@ -2128,7 +2152,7 @@ GENERATE_MAN = NO
|
||||||
# The default directory is: man.
|
# The default directory is: man.
|
||||||
# This tag requires that the tag GENERATE_MAN is set to YES.
|
# This tag requires that the tag GENERATE_MAN is set to YES.
|
||||||
|
|
||||||
MAN_OUTPUT = man
|
MAN_OUTPUT = doc/rtfm
|
||||||
|
|
||||||
# The MAN_EXTENSION tag determines the extension that is added to the generated
|
# The MAN_EXTENSION tag determines the extension that is added to the generated
|
||||||
# man pages. In case the manual section does not start with a number, the number
|
# man pages. In case the manual section does not start with a number, the number
|
||||||
|
|
@ -2153,7 +2177,7 @@ MAN_SUBDIR =
|
||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
# This tag requires that the tag GENERATE_MAN is set to YES.
|
# This tag requires that the tag GENERATE_MAN is set to YES.
|
||||||
|
|
||||||
MAN_LINKS = NO
|
MAN_LINKS = YES
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Configuration options related to the XML output
|
# Configuration options related to the XML output
|
||||||
|
|
@ -2197,7 +2221,7 @@ XML_NS_MEMB_FILE_SCOPE = NO
|
||||||
# that can be used to generate PDF.
|
# that can be used to generate PDF.
|
||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
|
|
||||||
GENERATE_DOCBOOK = NO
|
GENERATE_DOCBOOK = YES
|
||||||
|
|
||||||
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
|
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
|
||||||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
|
||||||
|
|
@ -2205,7 +2229,7 @@ GENERATE_DOCBOOK = NO
|
||||||
# The default directory is: docbook.
|
# The default directory is: docbook.
|
||||||
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
|
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
|
||||||
|
|
||||||
DOCBOOK_OUTPUT = docbook
|
DOCBOOK_OUTPUT = doc/docbook
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Configuration options for the AutoGen Definitions output
|
# Configuration options for the AutoGen Definitions output
|
||||||
|
|
@ -2235,7 +2259,7 @@ GENERATE_SQLITE3 = NO
|
||||||
# The default directory is: sqlite3.
|
# The default directory is: sqlite3.
|
||||||
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
|
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
|
||||||
|
|
||||||
SQLITE3_OUTPUT = sqlite3
|
SQLITE3_OUTPUT = doc/sqlite3
|
||||||
|
|
||||||
# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db
|
# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db
|
||||||
# database file will be recreated with each doxygen run. If set to NO, doxygen
|
# database file will be recreated with each doxygen run. If set to NO, doxygen
|
||||||
|
|
|
||||||
12
doc/Readme
12
doc/Readme
|
|
@ -47,13 +47,12 @@ Attention
|
||||||
* @brief
|
* @brief
|
||||||
* @details
|
* @details
|
||||||
* @date
|
* @date
|
||||||
* @dir
|
* @author
|
||||||
* @file
|
|
||||||
* @callgraph
|
* @callgraph
|
||||||
* @see (liste des fonctions qui dépendent de cette fonction)
|
* @see (liste des fonctions appelées par cette fonction)
|
||||||
* @callergraph
|
* @callergraph
|
||||||
* @see (liste des fonctions dont cette fonction dépend)
|
* @see (liste des fonctions qui appellent cette fonction)
|
||||||
* @param
|
* @param (liste des paramètres)
|
||||||
* @return
|
* @return
|
||||||
|
|
||||||
autres (à envisager) @see https://www.doxygen.nl/manual/commands.html
|
autres (à envisager) @see https://www.doxygen.nl/manual/commands.html
|
||||||
|
|
@ -71,7 +70,6 @@ sed -i 's/phantom documentation used to test the functioning of doxygen/\n
|
||||||
./src/main.c < or any other file...
|
./src/main.c < or any other file...
|
||||||
|
|
||||||
NB signal et journal n'ont pas été 'tagués' <<<<<<<<<<
|
NB signal et journal n'ont pas été 'tagués' <<<<<<<<<<
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -165,7 +163,7 @@ NB signal et journal n'ont pas été 'tagués' <<<<<<<<<<
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
* Le 2024-10-05), seules trois fonctions ne sont pas nommées selon ces règles:
|
* Le 2024-10-05, seules trois fonctions ne sont pas nommées selon ces règles:
|
||||||
* > create_axis_slider, free_stack_slot, free_stack_slot_size <
|
* > create_axis_slider, free_stack_slot, free_stack_slot_size <
|
||||||
*
|
*
|
||||||
* et les noms de cinq autres pourraient être améliorés.
|
* et les noms de cinq autres pourraient être améliorés.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
<?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="_annotated" xml:lang="en-US">
|
||||||
|
<title>Class List</title>
|
||||||
|
Here are the classes, structs, unions and interfaces with brief descriptions:<link linkend="_structarrow__t">arrow_t</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structdblist">dblist</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structelem">elem</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structfsm__struct__journal">fsm_struct_journal</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structfsm__struct__journal__unit">fsm_struct_journal_unit</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structfsm__struct__list__data">fsm_struct_list_data</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structfsm__struct__list__disp">fsm_struct_list_disp</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structfsm__struct__list__tool">fsm_struct_list_tool</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structgraphics__stack__t">graphics_stack_t</link>
|
||||||
|
<para>Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas </para>
|
||||||
|
<link linkend="_structpile">pile</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structpreferences">preferences</link>
|
||||||
|
<para>Use this ? static const char *icon_name [3] = { "document-revert-rtl-symbolic", "edit-undo-symbolic", "view-refresh-symbolic" }; </para>
|
||||||
|
<link linkend="_structslist">slist</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structStack">Stack</link>
|
||||||
|
<para>Struct images_bff {GtkWidget *arr[MAX_SIZE]; int top;}; static struct images_bff *my_list = NULL;//, *babar = NULL; static struct images_bff *alloc_images_bff () { struct images_bff *p; p = malloc (sizeof (struct images_bff)); if (p == NULL) printf ("fatal: ran out of storage"); p->arr[MAX_SIZE] = NULL; p->top = 0; return p; } static void add_to_mylist (int my_int) { struct images_bff *p = alloc_images_bff (); p->arr[MAX_SIZE] = NULL; // TODO p->top = my_int; my_list = p; } static void free_intlist (struct images_bff *p) { TODO } TODO free_intlist (mylist); TODO mylist = NULL; TODO offsetof (type, field) </para>
|
||||||
|
<link linkend="_structstack__index__t">stack_index_t</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<link linkend="_structTreeNode__t">TreeNode_t</link>
|
||||||
|
<para>Phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,145 @@
|
||||||
|
<?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 functions. </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<programlisting linenumbering="unnumbered">#include "../include/widget.h"<?linebreak?>#include "../include/signal.h"<?linebreak?>#include "../include/fsm.h"<?linebreak?></programlisting><simplesect>
|
||||||
|
<title>Functions </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para>int <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main</link> (int argc, char **argv)</para>
|
||||||
|
|
||||||
|
<para>gem-graph-client <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>Gem-graph client Main functions. </para>
|
||||||
|
|
||||||
|
<para>Copyright © 2021 Libre en Communs <link xlink:href="mailto:contact@a-lec.org">contact@a-lec.org</link> Copyright © 2021 Arthur Menges <link xlink:href="mailto:arthur.menges@a-lec.org">arthur.menges@a-lec.org</link> Copyright © 2021-2024 Adrien Bourmault <link xlink:href="mailto:neox@a-lec.org">neox@a-lec.org</link> Copyright © 2021-2024 Jean Sirmai <link xlink:href="mailto:jean@a-lec.org">jean@a-lec.org</link></para>
|
||||||
|
|
||||||
|
<para>This file is part of Gem-graph. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</para>
|
||||||
|
|
||||||
|
<para>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.</para>
|
||||||
|
|
||||||
|
<para>You should have received a copy of the GNU Affero General Public License along with this program. If not, see <link xlink:href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</link>.</para>
|
||||||
|
|
||||||
|
<para>gem-graph-client main file</para>
|
||||||
|
|
||||||
|
<para>Sur quel modèle se guider pour structurer le client gem-graph ?</para>
|
||||||
|
|
||||||
|
<para><link xlink:href="https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93viewmodel">https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93viewmodel</link> <link xlink:href="https://en.wikipedia.org/wiki/Multitier_architecture">https://en.wikipedia.org/wiki/Multitier_architecture</link></para>
|
||||||
|
|
||||||
|
<para>ORGANISATION ACTUELLE (Octobre 2024)</para>
|
||||||
|
<section xml:id="_main_8c_1autotoc_md0">
|
||||||
|
<title>1) Les structures hierarchiques.</title>
|
||||||
|
|
||||||
|
<para>La description du 'design' des fenêtres se trouve dans le dossier 'widget' et s'organise naturellement en arborescence, en se calquant sur l'arborescence des widgets eux-mêmes.</para>
|
||||||
|
|
||||||
|
<para>Il sera donc facile de répartir cette description en dossiers et fichiers au fur à mesure de son développement.</para>
|
||||||
|
|
||||||
|
<para>Actuellement, par exemple, la fenêtre principale comporte : <blockquote>
|
||||||
|
<para>‍une barre de titre (décrite dans 'topbar') et un widget 'child' (la partie sous la barre de titre) qui peut prendre au moins trois apparences différentes :<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>state (montre l'état de l'espace et les commandes associées)</para>
|
||||||
|
</listitem><listitem>
|
||||||
|
<para>rules (les règles et les commandes associées)</para>
|
||||||
|
</listitem><listitem>
|
||||||
|
<para>stock (les données provenant des mesures, les outils d'analyse, etc.) (nom provisoire : mal défini à ce stade; fonctions à répartir...) </para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</blockquote>La fenêtre principale s'ouvre sur la vue de l'état ('state.c') en mode 'EXEC'. Cette vue comporte trois panneaux (widgets) principaux: sup, moyen, inf ou encore: CONTRAST, CAMERA, CONTROL ou EDIT si on veut les nommer d'après leur fonction.</para>
|
||||||
|
|
||||||
|
<para>Lorsque la description de chaque widget s'affinera et demandera plus de place, ces trois widgets principaux deviendront des dossiers et les widgets qu'ils contiennent des fichiers (ou des dossiers si besoin) et ainsi de suite...</para>
|
||||||
|
</section>
|
||||||
|
<section xml:id="_main_8c_1autotoc_md1">
|
||||||
|
<title>2) Les structures transversales.</title>
|
||||||
|
|
||||||
|
<para>Les fonctions 'transversales' comme celles de 'graphics', 'parse', 'fsm', 'prefer', et peut-être des structures communes à tous les arbres, listes, etc. doivent pouvoir être accédées directement sans avoir à passer par la hiérarchie des widgets et/ou callbacks. Elles restent à la racine: 'src/</para>
|
||||||
|
|
||||||
|
<para>'finite state machine' ('fsm') va centraliser l'identification des états (apparences) de la fenêtre et des transitions entre ces apparences; Elle sera probablement décomposée en de nombreux 'sous-automates' tels que chaque état de la fenêtre soit une combinaison unique des états de ces sous-automates.</para>
|
||||||
|
|
||||||
|
<para>Exemple, muni des deux 'sous-automates' : <blockquote>
|
||||||
|
<para>‍ { EXEC, EDIT }; // xor { STATE, RULES, DATA }; // xor </para>
|
||||||
|
</blockquote>la 'finite state machine' peut se trouver dans 2 x 3 = 6 états. (voir fsm.h lignes 40-41)</para>
|
||||||
|
|
||||||
|
<para>Les grandes fonctions du client seront lancées par cette state machine :<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>édition automatique (optimisation) de l'arbre des conditions</para>
|
||||||
|
</listitem><listitem>
|
||||||
|
<para>tests sur un mini-serveur local</para>
|
||||||
|
</listitem><listitem>
|
||||||
|
<para>analyses de données...</para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>Leur recueil et la mémorisation des préférences des utilisateurs sont des fonctions centrales mais leur mise en oeuvre suivra probalement des voies hiérarchiques.</para>
|
||||||
|
|
||||||
|
<para>On peut prévoir des préférences concernant l'apparence des widgets, les traductions, les 'disabilities'; etc. mais aussi concernant les méthodes de travail, l'usage des outils d'analyse, etc. >> des 'scripts' pour des 'méta-fonctions' (des 'macros') ? </para>
|
||||||
|
</section>
|
||||||
|
</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>
|
||||||
|
|
||||||
|
<para>gem-graph-client <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> </para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para><formalpara><title>Date</title>
|
||||||
|
|
||||||
|
<para>2024-04 </para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Author</title>
|
||||||
|
|
||||||
|
<para>Jean</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>src/fsm/dispatch </para>
|
||||||
|
|
||||||
|
<para>src/signal</para>
|
||||||
|
|
||||||
|
<para>(none)</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 </para>
|
||||||
|
</formalpara>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
<?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="_structelem" xml:lang="en-US">
|
||||||
|
<title>elem Struct Reference</title>
|
||||||
|
<indexterm><primary>elem</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <util.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structelem_1a0d014510b9a1170af58e8516fb05b0b4"/>int <emphasis role="strong">value</emphasis></para>
|
||||||
|
|
||||||
|
<para>*value phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structelem_1aed06f2c7ef2050b131c8b72e099a0090"/>struct <link linkend="_structelem">elem</link> * <emphasis role="strong">prev</emphasis></para>
|
||||||
|
|
||||||
|
<para>*prev phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structelem_1ab9cf5c2e1c9a0ec2938275b90d39d5ca"/>struct <link linkend="_structelem">elem</link> * <emphasis role="strong">next</emphasis></para>
|
||||||
|
|
||||||
|
<para>*next phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/util.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -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="_structdblist" xml:lang="en-US">
|
||||||
|
<title>dblist Struct Reference</title>
|
||||||
|
<indexterm><primary>dblist</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <util.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structdblist_1a14615ff4b03d8f42730257cba4c50a1d"/><link linkend="_structelem">elem</link> * <emphasis role="strong">first</emphasis></para>
|
||||||
|
|
||||||
|
<para>*first phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structdblist_1ab5a72762ee26deb694dc0c89fdbda49f"/><link linkend="_structelem">elem</link> * <emphasis role="strong">last</emphasis></para>
|
||||||
|
|
||||||
|
<para>*last phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/util.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -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="_structfsm__struct__list__disp" xml:lang="en-US">
|
||||||
|
<title>fsm_struct_list_disp Struct Reference</title>
|
||||||
|
<indexterm><primary>fsm_struct_list_disp</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <fsm.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structfsm__struct__list__disp_1ae353ad2d0881411adb27e870dcbc45f8"/>int <emphasis role="strong">value</emphasis></para>
|
||||||
|
|
||||||
|
<para>*value phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structfsm__struct__list__disp_1a46c8b210279be9ac51265cbddf4658cb"/>struct <link linkend="_structfsm__struct__list__disp">fsm_struct_list_disp</link> * <emphasis role="strong">suiv</emphasis></para>
|
||||||
|
|
||||||
|
<para>*suiv phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/fsm.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
<?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="_structTreeNode__t" xml:lang="en-US">
|
||||||
|
<title>TreeNode_t Struct Reference</title>
|
||||||
|
<indexterm><primary>TreeNode_t</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <widget.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structTreeNode__t_1a5e4889026cb6802484a6a5dfc87d2543"/>gchar * <emphasis role="strong">text</emphasis></para>
|
||||||
|
|
||||||
|
<para>*text phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structTreeNode__t_1a7b289d9cc907d24c4c61bc7a2e769383"/>struct <link linkend="_structTreeNode__t">TreeNode_t</link> * <emphasis role="strong">child</emphasis></para>
|
||||||
|
|
||||||
|
<para>*child phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structTreeNode__t_1abf009b430b98b8b70739e90bceddb34b"/>struct <link linkend="_structTreeNode__t">TreeNode_t</link> * <emphasis role="strong">next</emphasis></para>
|
||||||
|
|
||||||
|
<para>*next phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/widget.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,45 @@
|
||||||
|
<?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="_structarrow__t" xml:lang="en-US">
|
||||||
|
<title>arrow_t Struct Reference</title>
|
||||||
|
<indexterm><primary>arrow_t</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <base.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structarrow__t_1aab59a759430a26ffb233554f93a1af0a"/>uint <emphasis role="strong">load</emphasis></para>
|
||||||
|
|
||||||
|
<para>load phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structarrow__t_1a786d036972b09f652b6dc73af77aaee0"/>uint <emphasis role="strong">site</emphasis></para>
|
||||||
|
|
||||||
|
<para>site phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structarrow__t_1a848949ce2dea0b41734058d0e9447630"/>uint <emphasis role="strong">x</emphasis></para>
|
||||||
|
|
||||||
|
<para>x phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structarrow__t_1a5afadb806f219b228d198585238ade29"/>uint <emphasis role="strong">y</emphasis></para>
|
||||||
|
|
||||||
|
<para>y phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structarrow__t_1a22f69e050d4fe1ddc0eda9a8024f832f"/>uint <emphasis role="strong">z</emphasis></para>
|
||||||
|
|
||||||
|
<para>z phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/base.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
<?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="_structpreferences" xml:lang="en-US">
|
||||||
|
<title>preferences Struct Reference</title>
|
||||||
|
<indexterm><primary>preferences</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>use this ? static const char *icon_name [3] = { "document-revert-rtl-symbolic", "edit-undo-symbolic", "view-refresh-symbolic" }; </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structpreferences_1afac6511cae5d2491eb12406c2eca230d"/>int <emphasis role="strong">transparency</emphasis> [n_objects]</para>
|
||||||
|
|
||||||
|
<para>transparency [n_objects] phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>use this ? static const char *icon_name [3] = { "document-revert-rtl-symbolic", "edit-undo-symbolic", "view-refresh-symbolic" }; </para>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<para>const char <emphasis>fsm_get_button_icon_name (int n) {return (const char</emphasis>) icon_name [n];} phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
src/fsm/preferences/<link linkend="_preferences_2manager_8c">manager.c</link></section>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,582 @@
|
||||||
|
<?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="_fsm_2dispatch_8c" xml:lang="en-US">
|
||||||
|
<title>src/fsm/dispatch.c File Reference</title>
|
||||||
|
<indexterm><primary>src/fsm/dispatch.c</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>OOOOOOOOOOO OOOOO OOO OOO * OO OO OO OOOO OOOO * OO OO OO OO OO OO * OOOOOO OO OO OO OO OO * OO OO OO OOO OO * OO OO OO OO * OO OO OOO OO OO * OO OOOOOO OO OO *<itemizedlist>
|
||||||
|
<listitem></listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<programlisting linenumbering="unnumbered">#include <stdbool.h><?linebreak?>#include "../../include/fsm.h"<?linebreak?>#include "../../include/util.h"<?linebreak?>#include "../../include/widget.h"<?linebreak?></programlisting><simplesect>
|
||||||
|
<title>Functions </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para>void <link linkend="_fsm_2dispatch_8c_1a435d1a5171a7d69662d701234722fee2">fsm_journal_publication_request</link> ()</para>
|
||||||
|
|
||||||
|
<para>The <link linkend="_fsm_2dispatch_8c_1a435d1a5171a7d69662d701234722fee2">fsm_journal_publication_request()</link> is called only once, by <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link>, just after closing the app and before ending the program. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>void <link linkend="_fsm_2dispatch_8c_1a8c67f42f95d48ee2469c9a27d65db3e6">fsm_journal_event</link> (int severity, int source, const char *file_source, const char *function_source, const char *string_value)</para>
|
||||||
|
|
||||||
|
<para>It is mandatory for any event to call this function to be published in the journal. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>void <link linkend="_fsm_2dispatch_8c_1a8d91f5868f20ad3b72cfa63787d87444">fsm_init</link> (char *initial_message_from_main)</para>
|
||||||
|
|
||||||
|
<para>F S M I N I T *. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>void <link linkend="_fsm_2dispatch_8c_1a770bcaeb0bd6f81cddcc3cd506468fff">fsm_set_preferences_modified</link> (bool value)</para>
|
||||||
|
|
||||||
|
<para>setter for the static boolean: 'preferences_have_been_modified' </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>bool <link linkend="_fsm_2dispatch_8c_1a0b0231a311d0e85723ef9fcf38be88e3">fsm_get_preferences_state</link> ()</para>
|
||||||
|
|
||||||
|
<para>getter for the static boolean: 'preferences_have_been_modified' </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>int <link linkend="_fsm_2dispatch_8c_1a9123915ffd10fe1ae18254898b1c0ebf">fsm_get_exec_edit</link> ()</para>
|
||||||
|
|
||||||
|
<para>Any function that modifies the client window must obtain this boolean. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>int <link linkend="_fsm_2dispatch_8c_1a90ab14081a88752d3721947a4922ee25">fsm_get_state_rules_data</link> ()</para>
|
||||||
|
|
||||||
|
<para>Any function that modifies the client window must obtain this value. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>void <link linkend="_fsm_2dispatch_8c_1ae921ecd39af67bb8dc0deb2cdc86125d">fsm_set_exec_edit</link> (int choice)</para>
|
||||||
|
|
||||||
|
<para>setter for the static value: 'choice_STATE_RULES_DATA' (in this file) </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>void <link linkend="_fsm_2dispatch_8c_1af5a464b19589ba1972c9b3aa3397945a">fsm_set_state_rules_data</link> (int choice)</para>
|
||||||
|
|
||||||
|
<para>setter for the static value: 'choice_STATE_RULES_DATA' (in this file) </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>OOOOOOOOOOO OOOOO OOO OOO * OO OO OO OOOO OOOO * OO OO OO OO OO OO * OOOOOO OO OO OO OO OO * OO OO OO OOO OO * OO OO OO OO * OO OO OOO OO OO * OO OOOOOO OO OO *<itemizedlist>
|
||||||
|
<listitem></listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>This Finite State Machine (fsm) describes all the possible states of the Gem-graph client and all the transitions between these states.</para>
|
||||||
|
|
||||||
|
<para>gem-graph-client fsm (Finite State Machine) manages four topics:<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>engine (window appearance)</para>
|
||||||
|
</listitem><listitem>
|
||||||
|
<para>measures (current measurements)</para>
|
||||||
|
</listitem><listitem>
|
||||||
|
<para>results (current data acquisition and displays)</para>
|
||||||
|
</listitem><listitem>
|
||||||
|
<para>preferences (current user preferences)</para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>Each state of the finite state machine (fsm) is a combination of their states.</para>
|
||||||
|
|
||||||
|
<para>It must be<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>saved at the end of a work session and</para>
|
||||||
|
</listitem><listitem>
|
||||||
|
<para>reread (available) at the start of a new session.</para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>No state of the fsm should be defined in another module. No fsm transition needs to be executed in another module.</para>
|
||||||
|
|
||||||
|
<para>The journal is created, edited and published from here. </para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Function Documentation</title>
|
||||||
|
<anchor xml:id="_fsm_2dispatch_8c_1a9123915ffd10fe1ae18254898b1c0ebf"/><section>
|
||||||
|
<title>fsm_get_exec_edit()</title>
|
||||||
|
<indexterm><primary>fsm_get_exec_edit</primary><secondary>dispatch.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>dispatch.c</primary><secondary>fsm_get_exec_edit</secondary></indexterm>
|
||||||
|
<para><computeroutput>int fsm_get_exec_edit ( )</computeroutput></para><para>
|
||||||
|
|
||||||
|
<para>Any function that modifies the client window must obtain this boolean. </para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>The 'state' and 'rules' pages appearance depends heavily on this.</para>
|
||||||
|
|
||||||
|
<para>see include/fsm enum fsm_enum_exec_edit { EXEC, EDIT } The current int may be replaced by a boolean before publication. TODO</para>
|
||||||
|
|
||||||
|
<para><formalpara><title>Date</title>
|
||||||
|
|
||||||
|
<para>2024-08 </para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Author</title>
|
||||||
|
|
||||||
|
<para>Jean</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>src/widget/one_rule/dispatch </para>
|
||||||
|
|
||||||
|
<para>src/widget/state/dispatch * 2 </para>
|
||||||
|
|
||||||
|
<para>src/signal</para>
|
||||||
|
|
||||||
|
<para>include/fsm enum fsm_enum_exec_edit { EXEC, EDIT } << TODO check this</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Returns</title>
|
||||||
|
|
||||||
|
<para>choice_EXEC_EDIT </para>
|
||||||
|
</formalpara>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_fsm_2dispatch_8c_1a0b0231a311d0e85723ef9fcf38be88e3"/><section>
|
||||||
|
<title>fsm_get_preferences_state()</title>
|
||||||
|
<indexterm><primary>fsm_get_preferences_state</primary><secondary>dispatch.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>dispatch.c</primary><secondary>fsm_get_preferences_state</secondary></indexterm>
|
||||||
|
<para><computeroutput>bool fsm_get_preferences_state ( )</computeroutput></para><para>
|
||||||
|
|
||||||
|
<para>getter for the static boolean: 'preferences_have_been_modified' </para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para><formalpara><title>Date</title>
|
||||||
|
|
||||||
|
<para>2024-08 </para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Author</title>
|
||||||
|
|
||||||
|
<para>Jean</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>TODO A function must obtain this boolean when it stores the current state of the fsm (including <link linkend="_structpreferences">preferences</link>) before closing the current session.</para>
|
||||||
|
|
||||||
|
<para>(none)</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Returns</title>
|
||||||
|
|
||||||
|
<para>preferences_have_been_modified </para>
|
||||||
|
</formalpara>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_fsm_2dispatch_8c_1a90ab14081a88752d3721947a4922ee25"/><section>
|
||||||
|
<title>fsm_get_state_rules_data()</title>
|
||||||
|
<indexterm><primary>fsm_get_state_rules_data</primary><secondary>dispatch.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>dispatch.c</primary><secondary>fsm_get_state_rules_data</secondary></indexterm>
|
||||||
|
<para><computeroutput>int fsm_get_state_rules_data ( )</computeroutput></para><para>
|
||||||
|
|
||||||
|
<para>Any function that modifies the client window must obtain this value. </para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>The pages selection and the window appearance depends heavily on this.</para>
|
||||||
|
|
||||||
|
<para>see include/fsm enum fsm_enum_state_rules_data { SYNTH, STATE, RULES, DATA }</para>
|
||||||
|
|
||||||
|
<para><formalpara><title>Date</title>
|
||||||
|
|
||||||
|
<para>2024-08 </para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Author</title>
|
||||||
|
|
||||||
|
<para>Jean</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>src/widget/topbar/left </para>
|
||||||
|
|
||||||
|
<para>src/signal</para>
|
||||||
|
|
||||||
|
<para>(none)</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Returns</title>
|
||||||
|
|
||||||
|
<para>choice_STATE_RULES_DATA </para>
|
||||||
|
</formalpara>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_fsm_2dispatch_8c_1a8d91f5868f20ad3b72cfa63787d87444"/><section>
|
||||||
|
<title>fsm_init()</title>
|
||||||
|
<indexterm><primary>fsm_init</primary><secondary>dispatch.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>dispatch.c</primary><secondary>fsm_init</secondary></indexterm>
|
||||||
|
<para><computeroutput>void fsm_init (char * initial_message_from_main)</computeroutput></para><para>
|
||||||
|
|
||||||
|
<para>F S M I N I T *. </para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>This is the first function called by '<link linkend="_main_8c">main.c</link>' It initiates the journal and four lists which are: 'measures', 'results', 'displayables results' and 'preferences'. These lists will be used to define the current state of the fsm.</para>
|
||||||
|
|
||||||
|
<para><formalpara><title>Date</title>
|
||||||
|
|
||||||
|
<para>2024-08 </para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Author</title>
|
||||||
|
|
||||||
|
<para>Jean</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>src/main/main()</para>
|
||||||
|
|
||||||
|
<para>src/journal/fsm_journal_init() </para>
|
||||||
|
|
||||||
|
<para>src/fsm/dispatch/fsm_journal_event() </para>
|
||||||
|
|
||||||
|
<para>src/fsm/measures/manager/fsm_list_init_measures() </para>
|
||||||
|
|
||||||
|
<para>src/fsm/results/manager/fsm_list_init_results() </para>
|
||||||
|
|
||||||
|
<para>src/fsm/preferences/manager/fsm_list_init_displayables() </para>
|
||||||
|
|
||||||
|
<para>src/fsm/preferences/manager/fsm_list_init_preferences()</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>*initial_message_from_main</entry><entry>
|
||||||
|
<para></para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
</tbody>
|
||||||
|
</tgroup>
|
||||||
|
</table>
|
||||||
|
</para>
|
||||||
|
</formalpara>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_fsm_2dispatch_8c_1a8c67f42f95d48ee2469c9a27d65db3e6"/><section>
|
||||||
|
<title>fsm_journal_event()</title>
|
||||||
|
<indexterm><primary>fsm_journal_event</primary><secondary>dispatch.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>dispatch.c</primary><secondary>fsm_journal_event</secondary></indexterm>
|
||||||
|
<para><computeroutput>void fsm_journal_event (int severity, int source, const char * file_source, const char * function_source, const char * string_value)</computeroutput></para><para>
|
||||||
|
|
||||||
|
<para>It is mandatory for any event to call this function to be published in the journal. </para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>Before publication, a filter can be applied here (and only here) to select only some events of interest (during debugging, for example).</para>
|
||||||
|
|
||||||
|
<para>If there are too many events, a filter can be applied here to select a few interesting events for publication in the log.</para>
|
||||||
|
|
||||||
|
<para>This filter can operate on any the following five parameters: severity, source, *file_source, *function_source, *string_value. <formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>below (params)</para>
|
||||||
|
</formalpara>
|
||||||
|
Simple filters (on a single parameter) can be combined using the logical operators 'and' and 'or' and parentheses.</para>
|
||||||
|
|
||||||
|
<para>Use: $ grep -r "fsm_journal_event" to confirm the callergraph calls.</para>
|
||||||
|
|
||||||
|
<para><formalpara><title>Date</title>
|
||||||
|
|
||||||
|
<para>2024-08 </para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Author</title>
|
||||||
|
|
||||||
|
<para>Jean</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>src/journal.c/fsm_journal_push_front()</para>
|
||||||
|
|
||||||
|
<para>src/main/main() </para>
|
||||||
|
|
||||||
|
<para>src/widget/topbar/modal.c </para>
|
||||||
|
|
||||||
|
<para>src/widget/topbar/right.c </para>
|
||||||
|
|
||||||
|
<para>src/widget/topbar/dialog.c </para>
|
||||||
|
|
||||||
|
<para>src/widget/topbar/left.c </para>
|
||||||
|
|
||||||
|
<para>src/widget/topbar/dispatch.c * 3 </para>
|
||||||
|
|
||||||
|
<para>src/widget/one_rule/dispatch.c </para>
|
||||||
|
|
||||||
|
<para>src/widget/one_rule/algebra/conditions.c * 2 </para>
|
||||||
|
|
||||||
|
<para>src/widget/measure/dispatch.c </para>
|
||||||
|
|
||||||
|
<para>src/widget/dispatch.c * 3 </para>
|
||||||
|
|
||||||
|
<para>src/widget/all_rules/dispatch.c </para>
|
||||||
|
|
||||||
|
<para><link linkend="_preferences_2manager_8c">src/fsm/preferences/manager.c</link> * 8 </para>
|
||||||
|
|
||||||
|
<para>src/fsm/measures/manager.c * 2 </para>
|
||||||
|
|
||||||
|
<para>src/fsm/measures/tools_list.c * 4 </para>
|
||||||
|
|
||||||
|
<para><link linkend="_fsm_2dispatch_8c">src/fsm/dispatch.c</link> * 10 </para>
|
||||||
|
|
||||||
|
<para>src/fsm/results/manager.c </para>
|
||||||
|
|
||||||
|
<para>src/util/tree.c </para>
|
||||||
|
|
||||||
|
<para>src/signal.c * 38</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>severity</entry><entry>
|
||||||
|
<para><> </para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
</tbody>
|
||||||
|
</tgroup>
|
||||||
|
</table>
|
||||||
|
</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>enum fsm_enum_journal_severity in include/fsm.h '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</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>source</entry><entry>
|
||||||
|
<para><> </para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
</tbody>
|
||||||
|
</tgroup>
|
||||||
|
</table>
|
||||||
|
</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>enum fsm_enum_journal_source in include/fsm.h 'source' is a pre-defined value that can be associated to each event. It is not mandatory. It can be set to 'NULL'.</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>*file_source</entry><entry>
|
||||||
|
<para><> the name of the file that emits the event. </para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
<row>
|
||||||
|
<entry>*function_source</entry><entry>
|
||||||
|
<para><> the function that emits the event. </para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
<row>
|
||||||
|
<entry>*string_value</entry><entry>
|
||||||
|
<para><> any value that can qualify the event and provides useful information when reading the log. </para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
</tbody>
|
||||||
|
</tgroup>
|
||||||
|
</table>
|
||||||
|
</para>
|
||||||
|
</formalpara>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_fsm_2dispatch_8c_1a435d1a5171a7d69662d701234722fee2"/><section>
|
||||||
|
<title>fsm_journal_publication_request()</title>
|
||||||
|
<indexterm><primary>fsm_journal_publication_request</primary><secondary>dispatch.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>dispatch.c</primary><secondary>fsm_journal_publication_request</secondary></indexterm>
|
||||||
|
<para><computeroutput>void fsm_journal_publication_request ( )</computeroutput></para><para>
|
||||||
|
|
||||||
|
<para>The <link linkend="_fsm_2dispatch_8c_1a435d1a5171a7d69662d701234722fee2">fsm_journal_publication_request()</link> is called only once, by <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link>, just after closing the app and before ending the program. </para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>This is to guarantee the chronological order of the events in the journal.</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 "main()", 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>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><formalpara><title>Date</title>
|
||||||
|
|
||||||
|
<para>2024-08 </para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Author</title>
|
||||||
|
|
||||||
|
<para>Jean</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>src/main/main()</para>
|
||||||
|
|
||||||
|
<para>src/journal/fsm_journal_publish() </para>
|
||||||
|
</formalpara>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_fsm_2dispatch_8c_1ae921ecd39af67bb8dc0deb2cdc86125d"/><section>
|
||||||
|
<title>fsm_set_exec_edit()</title>
|
||||||
|
<indexterm><primary>fsm_set_exec_edit</primary><secondary>dispatch.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>dispatch.c</primary><secondary>fsm_set_exec_edit</secondary></indexterm>
|
||||||
|
<para><computeroutput>void fsm_set_exec_edit (int choice)</computeroutput></para><para>
|
||||||
|
|
||||||
|
<para>setter for the static value: 'choice_STATE_RULES_DATA' (in this file) </para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>see include/fsm enum fsm_enum_exec_edit { EXEC, EDIT }</para>
|
||||||
|
|
||||||
|
<para><formalpara><title>Date</title>
|
||||||
|
|
||||||
|
<para>2024-08 </para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Author</title>
|
||||||
|
|
||||||
|
<para>Jean</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>(none)</para>
|
||||||
|
|
||||||
|
<para>src/signal * 2</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>choice</entry><entry>
|
||||||
|
<para>< a boolean value which can be "EXEC" or "EDIT" </para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
</tbody>
|
||||||
|
</tgroup>
|
||||||
|
</table>
|
||||||
|
</para>
|
||||||
|
</formalpara>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_fsm_2dispatch_8c_1a770bcaeb0bd6f81cddcc3cd506468fff"/><section>
|
||||||
|
<title>fsm_set_preferences_modified()</title>
|
||||||
|
<indexterm><primary>fsm_set_preferences_modified</primary><secondary>dispatch.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>dispatch.c</primary><secondary>fsm_set_preferences_modified</secondary></indexterm>
|
||||||
|
<para><computeroutput>void fsm_set_preferences_modified (bool value)</computeroutput></para><para>
|
||||||
|
|
||||||
|
<para>setter for the static boolean: 'preferences_have_been_modified' </para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para><formalpara><title>Date</title>
|
||||||
|
|
||||||
|
<para>2024-08 </para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Author</title>
|
||||||
|
|
||||||
|
<para>Jean</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>TODO To be used by any function that modifies the current user <link linkend="_structpreferences">preferences</link></para>
|
||||||
|
|
||||||
|
<para><link linkend="_fsm_2dispatch_8c_1a8c67f42f95d48ee2469c9a27d65db3e6">fsm_journal_event()</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>value</entry><entry>
|
||||||
|
<para>= TRUE if preferences_have_been_modified. </para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
</tbody>
|
||||||
|
</tgroup>
|
||||||
|
</table>
|
||||||
|
</para>
|
||||||
|
</formalpara>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_fsm_2dispatch_8c_1af5a464b19589ba1972c9b3aa3397945a"/><section>
|
||||||
|
<title>fsm_set_state_rules_data()</title>
|
||||||
|
<indexterm><primary>fsm_set_state_rules_data</primary><secondary>dispatch.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>dispatch.c</primary><secondary>fsm_set_state_rules_data</secondary></indexterm>
|
||||||
|
<para><computeroutput>void fsm_set_state_rules_data (int choice)</computeroutput></para><para>
|
||||||
|
|
||||||
|
<para>setter for the static value: 'choice_STATE_RULES_DATA' (in this file) </para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>see include/fsm enum fsm_enum_state_rules_data { SYNTH, STATE, RULES, DATA } Today (2024-10) the initial page is set to 'SYNTH'. <formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>line 292 choice_STATE_RULES_DATA = SYNTH; NB This choice can be temporarily modified for debugging purpose: </para>
|
||||||
|
|
||||||
|
<para>end of the function: <link linkend="_fsm_2dispatch_8c">fsm/dispatch.c</link> window_design_topbar_left()</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Date</title>
|
||||||
|
|
||||||
|
<para>2024-08 </para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>Author</title>
|
||||||
|
|
||||||
|
<para>Jean</para>
|
||||||
|
</formalpara>
|
||||||
|
<formalpara><title>See also</title>
|
||||||
|
|
||||||
|
<para>src/signal * 4</para>
|
||||||
|
|
||||||
|
<para>(none)</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>choice</entry><entry>
|
||||||
|
<para></para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
</tbody>
|
||||||
|
</tgroup>
|
||||||
|
</table>
|
||||||
|
</para>
|
||||||
|
</formalpara>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
@ -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="_structfsm__struct__list__tool" xml:lang="en-US">
|
||||||
|
<title>fsm_struct_list_tool Struct Reference</title>
|
||||||
|
<indexterm><primary>fsm_struct_list_tool</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <fsm.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structfsm__struct__list__tool_1a5f73a80ddae5f67ef8bbb161ae2c4259"/>int <emphasis role="strong">value</emphasis></para>
|
||||||
|
|
||||||
|
<para>*value phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structfsm__struct__list__tool_1ac6a36e7f389c23eb5404f0c5c3a4005a"/>struct <link linkend="_structfsm__struct__list__tool">fsm_struct_list_tool</link> * <emphasis role="strong">suiv</emphasis></para>
|
||||||
|
|
||||||
|
<para>*suiv phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/fsm.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
<?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="_structstack__index__t" xml:lang="en-US">
|
||||||
|
<title>stack_index_t Struct Reference</title>
|
||||||
|
<indexterm><primary>stack_index_t</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structstack__index__t_1ad0aae1e2bf45eb8855155ad713b4c3d4"/>long <emphasis role="strong">stack_id</emphasis></para>
|
||||||
|
|
||||||
|
<para>stack_id phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structstack__index__t_1a9b5ca3909ae086aa1ecbf4d581c2d596"/>void * <emphasis role="strong">container_widget</emphasis></para>
|
||||||
|
|
||||||
|
<para>container_widget phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structstack__index__t_1af27d972a040feb4ad2c52e7575e85854"/>void * <emphasis role="strong">gl_area</emphasis></para>
|
||||||
|
|
||||||
|
<para>gl_area phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
src/util/draw/<link linkend="_gl_8c">gl.c</link></section>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
<?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="_structStack" xml:lang="en-US">
|
||||||
|
<title>Stack Struct Reference</title>
|
||||||
|
<indexterm><primary>Stack</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>struct images_bff {GtkWidget *arr[MAX_SIZE]; int top;}; static struct images_bff *my_list = NULL;//, *babar = NULL; static struct images_bff *alloc_images_bff () { struct images_bff *p; p = malloc (sizeof (struct images_bff)); if (p == NULL) printf ("fatal: ran out of storage"); p->arr[MAX_SIZE] = NULL; p->top = 0; return p; } static void add_to_mylist (int my_int) { struct images_bff *p = alloc_images_bff (); p->arr[MAX_SIZE] = NULL; // TODO p->top = my_int; my_list = p; } static void free_intlist (struct images_bff *p) { TODO } TODO free_intlist (mylist); TODO mylist = NULL; TODO offsetof (type, field) </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structStack_1a9c232ff5046f7d60a7ec923326775590"/>GtkWidget * <emphasis role="strong">arr</emphasis> [MAX_SIZE]</para>
|
||||||
|
|
||||||
|
<para>*arr[MAX_SIZE] phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structStack_1ad62fb36816185f3eef3a6f735a61f54a"/>int <emphasis role="strong">top</emphasis></para>
|
||||||
|
|
||||||
|
<para>top phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>struct images_bff {GtkWidget *arr[MAX_SIZE]; int top;}; static struct images_bff *my_list = NULL;//, *babar = NULL; static struct images_bff *alloc_images_bff () { struct images_bff *p; p = malloc (sizeof (struct images_bff)); if (p == NULL) printf ("fatal: ran out of storage"); p->arr[MAX_SIZE] = NULL; p->top = 0; return p; } static void add_to_mylist (int my_int) { struct images_bff *p = alloc_images_bff (); p->arr[MAX_SIZE] = NULL; // TODO p->top = my_int; my_list = p; } static void free_intlist (struct images_bff *p) { TODO } TODO free_intlist (mylist); TODO mylist = NULL; TODO offsetof (type, field) </para>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
src/widget/all_rules/compare/interest.c</section>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,119 @@
|
||||||
|
<?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="_structfsm__struct__journal__unit" xml:lang="en-US">
|
||||||
|
<title>fsm_struct_journal_unit Struct Reference</title>
|
||||||
|
<indexterm><primary>fsm_struct_journal_unit</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <fsm.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para>long <link linkend="_structfsm__struct__journal__unit_1a932a3e2c6c87e442213ec109eeaf9e8a">yy_dd_mm</link></para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>long <link linkend="_structfsm__struct__journal__unit_1a15f25f19f95836422b016955e3923f4a">usec</link></para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>const char * <link linkend="_structfsm__struct__journal__unit_1a2354246a3b5139ffb1fc120ed85e5db7">file_source</link></para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>const char * <link linkend="_structfsm__struct__journal__unit_1a6c0be2efbdca90fe39e16066256875cb">function_source</link></para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>const char * <link linkend="_structfsm__struct__journal__unit_1ac9aa94406e089f89af0732db8d94b25f">string_value</link></para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>struct <link linkend="_structfsm__struct__journal__unit">fsm_struct_journal_unit</link> * <link linkend="_structfsm__struct__journal__unit_1a7d5e9e10caadc69643112b5a4eeb2d75">prev</link></para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>struct <link linkend="_structfsm__struct__journal__unit">fsm_struct_journal_unit</link> * <link linkend="_structfsm__struct__journal__unit_1ab37616d51b850373be72bee05eaf73ca">next</link></para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Member Data Documentation</title>
|
||||||
|
<anchor xml:id="_structfsm__struct__journal__unit_1a2354246a3b5139ffb1fc120ed85e5db7"/><section>
|
||||||
|
<title>file_source</title>
|
||||||
|
<indexterm><primary>file_source</primary><secondary>fsm_struct_journal_unit</secondary></indexterm>
|
||||||
|
<indexterm><primary>fsm_struct_journal_unit</primary><secondary>file_source</secondary></indexterm>
|
||||||
|
<para><computeroutput>const char* fsm_struct_journal_unit::file_source</computeroutput></para>
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_structfsm__struct__journal__unit_1a6c0be2efbdca90fe39e16066256875cb"/><section>
|
||||||
|
<title>function_source</title>
|
||||||
|
<indexterm><primary>function_source</primary><secondary>fsm_struct_journal_unit</secondary></indexterm>
|
||||||
|
<indexterm><primary>fsm_struct_journal_unit</primary><secondary>function_source</secondary></indexterm>
|
||||||
|
<para><computeroutput>const char* fsm_struct_journal_unit::function_source</computeroutput></para>
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_structfsm__struct__journal__unit_1ab37616d51b850373be72bee05eaf73ca"/><section>
|
||||||
|
<title>next</title>
|
||||||
|
<indexterm><primary>next</primary><secondary>fsm_struct_journal_unit</secondary></indexterm>
|
||||||
|
<indexterm><primary>fsm_struct_journal_unit</primary><secondary>next</secondary></indexterm>
|
||||||
|
<para><computeroutput>struct <link linkend="_structfsm__struct__journal__unit">fsm_struct_journal_unit</link>* fsm_struct_journal_unit::next</computeroutput></para>
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_structfsm__struct__journal__unit_1a7d5e9e10caadc69643112b5a4eeb2d75"/><section>
|
||||||
|
<title>prev</title>
|
||||||
|
<indexterm><primary>prev</primary><secondary>fsm_struct_journal_unit</secondary></indexterm>
|
||||||
|
<indexterm><primary>fsm_struct_journal_unit</primary><secondary>prev</secondary></indexterm>
|
||||||
|
<para><computeroutput>struct <link linkend="_structfsm__struct__journal__unit">fsm_struct_journal_unit</link>* fsm_struct_journal_unit::prev</computeroutput></para>
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_structfsm__struct__journal__unit_1ac9aa94406e089f89af0732db8d94b25f"/><section>
|
||||||
|
<title>string_value</title>
|
||||||
|
<indexterm><primary>string_value</primary><secondary>fsm_struct_journal_unit</secondary></indexterm>
|
||||||
|
<indexterm><primary>fsm_struct_journal_unit</primary><secondary>string_value</secondary></indexterm>
|
||||||
|
<para><computeroutput>const char* fsm_struct_journal_unit::string_value</computeroutput></para>
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_structfsm__struct__journal__unit_1a15f25f19f95836422b016955e3923f4a"/><section>
|
||||||
|
<title>usec</title>
|
||||||
|
<indexterm><primary>usec</primary><secondary>fsm_struct_journal_unit</secondary></indexterm>
|
||||||
|
<indexterm><primary>fsm_struct_journal_unit</primary><secondary>usec</secondary></indexterm>
|
||||||
|
<para><computeroutput>long fsm_struct_journal_unit::usec</computeroutput></para>
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_structfsm__struct__journal__unit_1a932a3e2c6c87e442213ec109eeaf9e8a"/><section>
|
||||||
|
<title>yy_dd_mm</title>
|
||||||
|
<indexterm><primary>yy_dd_mm</primary><secondary>fsm_struct_journal_unit</secondary></indexterm>
|
||||||
|
<indexterm><primary>fsm_struct_journal_unit</primary><secondary>yy_dd_mm</secondary></indexterm>
|
||||||
|
<para><computeroutput>long fsm_struct_journal_unit::yy_dd_mm</computeroutput></para>
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/fsm.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -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="_structfsm__struct__journal" xml:lang="en-US">
|
||||||
|
<title>fsm_struct_journal Struct Reference</title>
|
||||||
|
<indexterm><primary>fsm_struct_journal</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <fsm.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><link linkend="_structfsm__struct__journal__unit">fsm_struct_journal_unit</link> * <link linkend="_structfsm__struct__journal_1ac4fb89c8fb499c05f57978200d8628d9">first</link></para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><link linkend="_structfsm__struct__journal__unit">fsm_struct_journal_unit</link> * <link linkend="_structfsm__struct__journal_1a3e55d9bb62c322d8e1ae5dc90d7a5f6d">last</link></para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Member Data Documentation</title>
|
||||||
|
<anchor xml:id="_structfsm__struct__journal_1ac4fb89c8fb499c05f57978200d8628d9"/><section>
|
||||||
|
<title>first</title>
|
||||||
|
<indexterm><primary>first</primary><secondary>fsm_struct_journal</secondary></indexterm>
|
||||||
|
<indexterm><primary>fsm_struct_journal</primary><secondary>first</secondary></indexterm>
|
||||||
|
<para><computeroutput><link linkend="_structfsm__struct__journal__unit">fsm_struct_journal_unit</link>* fsm_struct_journal::first</computeroutput></para>
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<anchor xml:id="_structfsm__struct__journal_1a3e55d9bb62c322d8e1ae5dc90d7a5f6d"/><section>
|
||||||
|
<title>last</title>
|
||||||
|
<indexterm><primary>last</primary><secondary>fsm_struct_journal</secondary></indexterm>
|
||||||
|
<indexterm><primary>fsm_struct_journal</primary><secondary>last</secondary></indexterm>
|
||||||
|
<para><computeroutput><link linkend="_structfsm__struct__journal__unit">fsm_struct_journal_unit</link>* fsm_struct_journal::last</computeroutput></para>
|
||||||
|
<para><itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem></itemizedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/fsm.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -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="_structfsm__struct__list__data" xml:lang="en-US">
|
||||||
|
<title>fsm_struct_list_data Struct Reference</title>
|
||||||
|
<indexterm><primary>fsm_struct_list_data</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <fsm.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structfsm__struct__list__data_1a5eb8634842969f2fd4581d364ab28cc1"/>int <emphasis role="strong">value</emphasis></para>
|
||||||
|
|
||||||
|
<para>*value phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structfsm__struct__list__data_1a190465361efd7dafe1ee1f489a272ac0"/>struct <link linkend="_structfsm__struct__list__data">fsm_struct_list_data</link> * <emphasis role="strong">suiv</emphasis></para>
|
||||||
|
|
||||||
|
<para>*suiv phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/fsm.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,48 @@
|
||||||
|
<?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="_preferences_2manager_8c" xml:lang="en-US">
|
||||||
|
<title>src/fsm/preferences/manager.c File Reference</title>
|
||||||
|
<indexterm><primary>src/fsm/preferences/manager.c</primary></indexterm>
|
||||||
|
<programlisting linenumbering="unnumbered">#include "../../../include/fsm.h"<?linebreak?>#include "../../../include/signal.h"<?linebreak?>#include "../../../include/widget.h"<?linebreak?></programlisting><simplesect>
|
||||||
|
<title>Classes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para>struct <link linkend="_structpreferences">preferences</link></para>
|
||||||
|
|
||||||
|
<para>use this ? static const char *icon_name [3] = { "document-revert-rtl-symbolic", "edit-undo-symbolic", "view-refresh-symbolic" }; </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<simplesect>
|
||||||
|
<title>Functions </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_preferences_2manager_8c_1a42a491a3a432cf572b3c2ed84a00d927"/>void <emphasis role="strong">fsm_set_store_restore_reset</emphasis> (int choice, int value)</para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_preferences_2manager_8c_1abb1b857c9ec1ab39d6cb7cdf683a08d1"/>void <emphasis role="strong">fsm_reset_all_situations_values</emphasis> (int value)</para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_preferences_2manager_8c_1aa69a9ce07b26ad1863960c6f0d1303b5"/>void <emphasis role="strong">fsm_add_displayable</emphasis> (char *displayable_name)</para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_preferences_2manager_8c_1aa02db2c62f7507eabfcc9a41f0e660b6"/>void <emphasis role="strong">fsm_list_init_preferences</emphasis> ()</para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_preferences_2manager_8c_1a8eaa768708ebc21d710a8cc6144af1d3"/>void <emphasis role="strong">fsm_list_init_displayables</emphasis> ()</para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<simplesect>
|
||||||
|
<title>Variables </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_preferences_2manager_8c_1aca528e2aeb796176a06819e058557e72"/>struct <link linkend="_structpreferences">preferences</link> * <emphasis role="strong">pref_jean</emphasis> = NULL</para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
</section>
|
||||||
|
|
@ -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="_structpile" xml:lang="en-US">
|
||||||
|
<title>pile Struct Reference</title>
|
||||||
|
<indexterm><primary>pile</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <util.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structpile_1a404c7f7ab8c7abe008de4e28657983c8"/>int <emphasis role="strong">value</emphasis></para>
|
||||||
|
|
||||||
|
<para>value phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structpile_1a34a9ae6f1ef6a39ba2c809da6dd4921d"/>struct <link linkend="_structpile">pile</link> * <emphasis role="strong">prev</emphasis></para>
|
||||||
|
|
||||||
|
<para>*prev phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/util.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -0,0 +1,360 @@
|
||||||
|
<?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="_gl_8c" xml:lang="en-US">
|
||||||
|
<title>src/util/draw/gl.c File Reference</title>
|
||||||
|
<indexterm><primary>src/util/draw/gl.c</primary></indexterm>
|
||||||
|
<programlisting linenumbering="unnumbered">#include "../../../include/graphics.h"<?linebreak?>#include "../../../include/signal.h"<?linebreak?></programlisting><simplesect>
|
||||||
|
<title>Classes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para>struct <link linkend="_structstack__index__t">stack_index_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="_gl_8c_1a2737fdf992bd5a9d008f620ddaf50107"/>#define <emphasis role="strong">GL_AREA_SIZE</emphasis>   400</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="_gl_8c_1a289cfe9a70bcb690eeff2639dd8a98cd"/>int <emphasis role="strong">util_gl_set_arrow</emphasis> (int 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>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>long <link linkend="_gl_8c_1adbe03a3d239b22390e9de809443c8df9">util_gl_get_stack</link> (void *container_widget)</para>
|
||||||
|
|
||||||
|
<para>Look for stack entry and returns stack_id. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>long <link linkend="_gl_8c_1a5a691fdca6e3088ea9c1927096541624">util_gl_is_ready</link> (void *container_widget)</para>
|
||||||
|
|
||||||
|
<para>Look for stack entry and returns stack_id. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para>bool <link linkend="_gl_8c_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="_gl_8c_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="_gl_8c_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="_gl_8c_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="_gl_8c_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="_gl_8c_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="_gl_8c_1a2cb205bd6556250d019b4de59eee3894">create_axis_slider</link> (int axis)</para>
|
||||||
|
|
||||||
|
<para>Creates a slider widget. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_gl_8c_1ac90dc30613c94fdefedb76cf6d2c4ac8"/>bool <emphasis role="strong">util_gl_setup_glarea</emphasis> (int target_mode, GtkWidget *target_widget)</para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<simplesect>
|
||||||
|
<title>Variables </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_gl_8c_1a176a1af12ef0fb33a5de5cd36ef7145a"/>size_t <emphasis role="strong">stack_index_size</emphasis> = 0</para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Function Documentation</title>
|
||||||
|
<anchor xml:id="_gl_8c_1a2cb205bd6556250d019b4de59eee3894"/><section>
|
||||||
|
<title>create_axis_slider()</title>
|
||||||
|
<indexterm><primary>create_axis_slider</primary><secondary>gl.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>gl.c</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'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="_gl_8c_1adbe03a3d239b22390e9de809443c8df9"/><section>
|
||||||
|
<title>util_gl_get_stack()</title>
|
||||||
|
<indexterm><primary>util_gl_get_stack</primary><secondary>gl.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>gl.c</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="_gl_8c_1a28b44187c7ae713705874288323e10a6"/><section>
|
||||||
|
<title>util_gl_init_stack()</title>
|
||||||
|
<indexterm><primary>util_gl_init_stack</primary><secondary>gl.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>gl.c</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="_gl_8c_1a5a691fdca6e3088ea9c1927096541624"/><section>
|
||||||
|
<title>util_gl_is_ready()</title>
|
||||||
|
<indexterm><primary>util_gl_is_ready</primary><secondary>gl.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>gl.c</primary><secondary>util_gl_is_ready</secondary></indexterm>
|
||||||
|
<para><computeroutput>long util_gl_is_ready (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="_gl_8c_1a8132a1a797f4f12eaff04b4c3610f054"/><section>
|
||||||
|
<title>util_gl_render_stack()</title>
|
||||||
|
<indexterm><primary>util_gl_render_stack</primary><secondary>gl.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>gl.c</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="_gl_8c_1ae2198c050662c486c8e66c6e6b5a7e0b"/><section>
|
||||||
|
<title>util_gl_shutdown_all_stacks()</title>
|
||||||
|
<indexterm><primary>util_gl_shutdown_all_stacks</primary><secondary>gl.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>gl.c</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="_gl_8c_1a9d41985e1832e0a798e722d2341752f1"/><section>
|
||||||
|
<title>util_gl_shutdown_stack()</title>
|
||||||
|
<indexterm><primary>util_gl_shutdown_stack</primary><secondary>gl.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>gl.c</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="_gl_8c_1ad830e66002a24806e3617946dc988e95"/><section>
|
||||||
|
<title>util_gl_update_axis()</title>
|
||||||
|
<indexterm><primary>util_gl_update_axis</primary><secondary>gl.c</secondary></indexterm>
|
||||||
|
<indexterm><primary>gl.c</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>
|
||||||
|
|
@ -0,0 +1,121 @@
|
||||||
|
<?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="_structgraphics__stack__t" xml:lang="en-US">
|
||||||
|
<title>graphics_stack_t Struct Reference</title>
|
||||||
|
<indexterm><primary>graphics_stack_t</primary></indexterm>
|
||||||
|
<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>
|
||||||
|
<computeroutput>#include <graphics.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1af8578b691d14c1c0aefe7aab307d35d3"/>int <emphasis role="strong">id</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a6d15e9f6e455a5f6e07efd504092eabd"/>int <emphasis role="strong">mode</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a24345e6e56468c81dbdc8c1b912d2da1"/>float <emphasis role="strong">rotation_angles</emphasis> [N_AXIS]</para>
|
||||||
|
|
||||||
|
<para>Rotation angles on each axis. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1af4b3f1ab3368005446f2e01152e4cbc2"/>GLuint <emphasis role="strong">vao</emphasis></para>
|
||||||
|
|
||||||
|
<para>init_buffers <?linebreak?> </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a8c4a73e3e7c47ebbe286ccd221b36345"/>GLuint <emphasis role="strong">position_buffer</emphasis></para>
|
||||||
|
|
||||||
|
<para>shutdown, draw <?linebreak?> </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a91445f750de8bba35c7899a641517cde"/>GLuint <emphasis role="strong">color_buffer</emphasis></para>
|
||||||
|
|
||||||
|
<para>shutdown, draw <?linebreak?> </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a45249c5bebc08c3e4633b510e60ef519"/>GLuint <emphasis role="strong">program</emphasis></para>
|
||||||
|
|
||||||
|
<para>shutdown, init_shaders, draw <?linebreak?> </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a450d45ed7b90d6755cc4d322b26886b5"/>GLuint <emphasis role="strong">m</emphasis></para>
|
||||||
|
|
||||||
|
<para>init_shaders, draw <?linebreak?> </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a77cd82200c32fdb7a98b2d873bc47101"/>GLuint <emphasis role="strong">v</emphasis></para>
|
||||||
|
|
||||||
|
<para>init_shaders, draw <?linebreak?> </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a2618a771cf69d50f41f73a9e73a954be"/>GLuint <emphasis role="strong">p</emphasis></para>
|
||||||
|
|
||||||
|
<para>init_shaders, draw <?linebreak?> </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a719da937a28bfc859981aa3d5fabfdad"/>struct <link linkend="_structarrow__t">arrow_t</link> * <emphasis role="strong">arrows_ptr</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1ac83224b08bcc3748aa67b801003a941d"/>long <emphasis role="strong">arrows_nb</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a4fc7ff5da6655dc84f75e41aeea34114"/>GLfloat * <emphasis role="strong">buffer_vertex_origin</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1abe0d5ff731ecb1c38580c9458d51da3c"/>GLfloat * <emphasis role="strong">buffer_colors_origin</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1aa968f1b4399daec725f5add393f7c8ce"/>GLuint * <emphasis role="strong">buffer_lines_origin</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1abb3a4f67b598704db32b6c04e264a3bf"/>GLuint * <emphasis role="strong">buffer_plans_origin</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a2901c44699708610ff2854335f6e66d0"/>long <emphasis role="strong">buffer_vertex_size</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a9fc79ebf7f482d032476f8a89eaf857f"/>long <emphasis role="strong">buffer_colors_size</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1ad8fab767b2f3e1f0455e99715ee7e091"/>long <emphasis role="strong">buffer_lines_size</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a4c67dd123492ff9030a45708ee5d20df"/>long <emphasis role="strong">buffer_plans_size</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1af3f70fda4f00a22b6f31e9426fd74efc"/>long <emphasis role="strong">buffer_vertex_0_arrow</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a06c2ac4d28a8b125dd744d9970570f8e"/>long <emphasis role="strong">buffer_colors_0_arrow</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1ad4d641051e231ba5c5f00b7eb427057e"/>long <emphasis role="strong">buffer_lines_0_arrow</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structgraphics__stack__t_1a6d3507a54ebc6304f3e4bf24b7428c05"/>long <emphasis role="strong">buffer_plans_0_arrow</emphasis></para>
|
||||||
|
|
||||||
|
<para>phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas. </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/graphics.h</section>
|
||||||
|
</section>
|
||||||
|
|
@ -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="_structslist" xml:lang="en-US">
|
||||||
|
<title>slist Struct Reference</title>
|
||||||
|
<indexterm><primary>slist</primary></indexterm>
|
||||||
|
<para>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<computeroutput>#include <util.h></computeroutput>
|
||||||
|
</para>
|
||||||
|
<simplesect>
|
||||||
|
<title>Public Attributes </title>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><anchor xml:id="_structslist_1a6c4e65b559a5537f7854b0d828204436"/>int <emphasis role="strong">value</emphasis></para>
|
||||||
|
|
||||||
|
<para>value phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem><para><anchor xml:id="_structslist_1a1dbb9625c8b52c7a6ae2d2e83b37fd43"/>struct <link linkend="_structslist">slist</link> * <emphasis role="strong">suiv</emphasis></para>
|
||||||
|
|
||||||
|
<para>*suiv phantom documentation </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</simplesect>
|
||||||
|
<section>
|
||||||
|
<title>Detailed Description</title>
|
||||||
|
|
||||||
|
<para>phantom documentation used to test the functioning of doxygen </para>
|
||||||
|
<para>
|
||||||
|
The documentation for this struct was generated from the following file:</para>
|
||||||
|
include/util.h</section>
|
||||||
|
</section>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 6.5 KiB |
|
|
@ -0,0 +1,32 @@
|
||||||
|
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
||||||
|
<book xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_index" xml:lang="en-US">
|
||||||
|
<info>
|
||||||
|
<title>Gem-graph</title>
|
||||||
|
</info>
|
||||||
|
<chapter>
|
||||||
|
<title>Class Documentation</title>
|
||||||
|
<xi:include href="d3/d03/structarrow__t.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d1/d04/structdblist.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d0/d0b/structelem.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d9/d03/structfsm__struct__journal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d7/d08/structfsm__struct__journal__unit.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d9/d04/structfsm__struct__list__data.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d1/d07/structfsm__struct__list__disp.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d5/d00/structfsm__struct__list__tool.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="dd/d0e/structgraphics__stack__t.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="da/d03/structpile.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d3/d0f/structpreferences.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="df/d05/structslist.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d7/d07/structStack.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d7/d02/structstack__index__t.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
<xi:include href="d1/d09/structTreeNode__t.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||||
|
</chapter>
|
||||||
|
<chapter>
|
||||||
|
<title>File Documentation</title>
|
||||||
|
<xi:include href="d9/d06/preferences_2manager_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="da/d0c/gl_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"/>
|
||||||
|
</chapter>
|
||||||
|
<index/>
|
||||||
|
</book>
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
LATEX_CMD?=pdflatex
|
||||||
|
MKIDX_CMD?=makeindex
|
||||||
|
BIBTEX_CMD?=bibtex
|
||||||
|
LATEX_COUNT?=8
|
||||||
|
MANUAL_FILE?=refman
|
||||||
|
|
||||||
|
all: $(MANUAL_FILE).pdf
|
||||||
|
|
||||||
|
pdf: $(MANUAL_FILE).pdf
|
||||||
|
|
||||||
|
$(MANUAL_FILE).pdf: clean $(MANUAL_FILE).tex
|
||||||
|
$(LATEX_CMD) $(MANUAL_FILE)
|
||||||
|
$(MKIDX_CMD) $(MANUAL_FILE).idx
|
||||||
|
$(LATEX_CMD) $(MANUAL_FILE)
|
||||||
|
latex_count=$(LATEX_COUNT) ; \
|
||||||
|
while grep -E -s 'Rerun (LaTeX|to get cross-references right|to get bibliographical references right)' $(MANUAL_FILE).log && [ $$latex_count -gt 0 ] ;\
|
||||||
|
do \
|
||||||
|
echo "Rerunning latex...." ;\
|
||||||
|
$(LATEX_CMD) $(MANUAL_FILE) ;\
|
||||||
|
latex_count=`expr $$latex_count - 1` ;\
|
||||||
|
done
|
||||||
|
$(MKIDX_CMD) $(MANUAL_FILE).idx
|
||||||
|
$(LATEX_CMD) $(MANUAL_FILE)
|
||||||
|
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.brf *.blg *.bbl $(MANUAL_FILE).pdf
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
\doxysection{Class List}
|
||||||
|
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structarrow__t}{arrow\+\_\+t}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structarrow__t}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structdblist}{dblist}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structdblist}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structelem}{elem}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structelem}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structfsm__struct__journal}{fsm\+\_\+struct\+\_\+journal}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structfsm__struct__journal}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structfsm__struct__journal__unit}{fsm\+\_\+struct\+\_\+journal\+\_\+unit}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structfsm__struct__journal__unit}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structfsm__struct__list__data}{fsm\+\_\+struct\+\_\+list\+\_\+data}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structfsm__struct__list__data}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structfsm__struct__list__disp}{fsm\+\_\+struct\+\_\+list\+\_\+disp}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structfsm__struct__list__disp}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structfsm__struct__list__tool}{fsm\+\_\+struct\+\_\+list\+\_\+tool}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structfsm__struct__list__tool}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structgraphics__stack__t}{graphics\+\_\+stack\+\_\+t}} \\*Structure describing a gl\+\_\+area and its parameters, used to create a table of Gem-\/graph client current gl\+\_\+areas }{\pageref{structgraphics__stack__t}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structpile}{pile}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structpile}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structpreferences}{preferences}} \\*Use this ? static const char \texorpdfstring{$\ast$}{*}icon\+\_\+name \mbox{[}3\mbox{]} = \{ "{}document-\/revert-\/rtl-\/symbolic"{}, "{}edit-\/undo-\/symbolic"{}, "{}view-\/refresh-\/symbolic"{} \}; }{\pageref{structpreferences}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structslist}{slist}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structslist}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structStack}{Stack}} \\*Struct images\+\_\+bff \{Gtk\+Widget \texorpdfstring{$\ast$}{*}arr\mbox{[}MAX\+\_\+\+SIZE\mbox{]}; int top;\}; static struct images\+\_\+bff \texorpdfstring{$\ast$}{*}my\+\_\+list = NULL;//, \texorpdfstring{$\ast$}{*}babar = NULL; static struct images\+\_\+bff \texorpdfstring{$\ast$}{*}alloc\+\_\+images\+\_\+bff () \{ struct images\+\_\+bff \texorpdfstring{$\ast$}{*}p; p = malloc (sizeof (struct images\+\_\+bff)); if (p == NULL) printf ("{}fatal\+: ran out of storage"{}); p-\/\texorpdfstring{$>$}{>}arr\mbox{[}MAX\+\_\+\+SIZE\mbox{]} = NULL; p-\/\texorpdfstring{$>$}{>}top = 0; return p; \} static void add\+\_\+to\+\_\+mylist (int my\+\_\+int) \{ struct images\+\_\+bff \texorpdfstring{$\ast$}{*}p = alloc\+\_\+images\+\_\+bff (); p-\/\texorpdfstring{$>$}{>}arr\mbox{[}MAX\+\_\+\+SIZE\mbox{]} = NULL; // TODO p-\/\texorpdfstring{$>$}{>}top = my\+\_\+int; my\+\_\+list = p; \} static void free\+\_\+intlist (struct images\+\_\+bff \texorpdfstring{$\ast$}{*}p) \{ TODO \} TODO free\+\_\+intlist (mylist); TODO mylist = NULL; TODO offsetof (type, field) }{\pageref{structStack}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structstack__index__t}{stack\+\_\+index\+\_\+t}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structstack__index__t}}{}
|
||||||
|
\item\contentsline{section}{\mbox{\hyperlink{structTreeNode__t}{Tree\+Node\+\_\+t}} \\*Phantom documentation used to test the functioning of doxygen }{\pageref{structTreeNode__t}}{}
|
||||||
|
\end{DoxyCompactList}
|
||||||
|
|
@ -0,0 +1,102 @@
|
||||||
|
\doxysection{src/main.c File Reference}
|
||||||
|
\hypertarget{main_8c}{}\label{main_8c}\index{src/main.c@{src/main.c}}
|
||||||
|
|
||||||
|
|
||||||
|
Gem-\/graph client Main functions.
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include "{}../include/widget.\+h"{}}\newline
|
||||||
|
{\ttfamily \#include "{}../include/signal.\+h"{}}\newline
|
||||||
|
{\ttfamily \#include "{}../include/fsm.\+h"{}}\newline
|
||||||
|
\doxysubsubsection*{Functions}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
int \mbox{\hyperlink{main_8c_a3c04138a5bfe5d72780bb7e82a18e627}{main}} (int argc, char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}argv)
|
||||||
|
\begin{DoxyCompactList}\small\item\em gem-\/graph-\/client \doxylink{main_8c_a3c04138a5bfe5d72780bb7e82a18e627}{main()} \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
Gem-\/graph client Main functions.
|
||||||
|
|
||||||
|
Copyright © 2021 Libre en Communs \href{mailto:contact@a-lec.org}{\texttt{ contact@a-\/lec.\+org}} Copyright © 2021 Arthur Menges \href{mailto:arthur.menges@a-lec.org}{\texttt{ arthur.\+menges@a-\/lec.\+org}} Copyright © 2021-\/2024 Adrien Bourmault \href{mailto:neox@a-lec.org}{\texttt{ neox@a-\/lec.\+org}} Copyright © 2021-\/2024 Jean Sirmai \href{mailto:jean@a-lec.org}{\texttt{ jean@a-\/lec.\+org}}
|
||||||
|
|
||||||
|
This file is part of Gem-\/graph. This program is free software\+: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License along with this program. If not, see \href{http://www.gnu.org/licenses/}{\texttt{ http\+://www.\+gnu.\+org/licenses/}}.
|
||||||
|
|
||||||
|
gem-\/graph-\/client main file
|
||||||
|
|
||||||
|
Sur quel modèle se guider pour structurer le client gem-\/graph ?
|
||||||
|
|
||||||
|
\href{https://en.wikipedia.org/wiki/Model\%E2\%80\%93view\%E2\%80\%93viewmodel}{\texttt{ https\+://en.\+wikipedia.\+org/wiki/\+Model\%\+E2\%80\%93view\%\+E2\%80\%93viewmodel}} \href{https://en.wikipedia.org/wiki/Multitier_architecture}{\texttt{ https\+://en.\+wikipedia.\+org/wiki/\+Multitier\+\_\+architecture}}
|
||||||
|
|
||||||
|
ORGANISATION ACTUELLE (Octobre 2024)\hypertarget{main_8c_autotoc_md0}{}\doxysubsubsection{\texorpdfstring{1) Les structures hierarchiques.}{1) Les structures hierarchiques.}}\label{main_8c_autotoc_md0}
|
||||||
|
La description du \textquotesingle{}design\textquotesingle{} des fenêtres se trouve dans le dossier \textquotesingle{}widget\textquotesingle{} et s\textquotesingle{}organise naturellement en arborescence, en se calquant sur l\textquotesingle{}arborescence des widgets eux-\/mêmes.
|
||||||
|
|
||||||
|
Il sera donc facile de répartir cette description en dossiers et fichiers au fur à mesure de son développement.
|
||||||
|
|
||||||
|
Actuellement, par exemple, la fenêtre principale comporte \+: \begin{quote}
|
||||||
|
une barre de titre (décrite dans \textquotesingle{}topbar\textquotesingle{}) et un widget \textquotesingle{}child\textquotesingle{} (la partie sous la barre de titre) qui peut prendre au moins trois apparences différentes \+:
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item state (montre l\textquotesingle{}état de l\textquotesingle{}espace et les commandes associées)
|
||||||
|
\item rules (les règles et les commandes associées)
|
||||||
|
\item stock (les données provenant des mesures, les outils d\textquotesingle{}analyse, etc.) (nom provisoire \+: mal défini à ce stade; fonctions à répartir...)
|
||||||
|
\end{DoxyItemize}\end{quote}
|
||||||
|
La fenêtre principale s\textquotesingle{}ouvre sur la vue de l\textquotesingle{}état (\textquotesingle{}state.\+c\textquotesingle{}) en mode \textquotesingle{}EXEC\textquotesingle{}. Cette vue comporte trois panneaux (widgets) principaux\+: sup, moyen, inf ou encore\+: CONTRAST, CAMERA, CONTROL ou EDIT si on veut les nommer d\textquotesingle{}après leur fonction.
|
||||||
|
|
||||||
|
Lorsque la description de chaque widget s\textquotesingle{}affinera et demandera plus de place, ces trois widgets principaux deviendront des dossiers et les widgets qu\textquotesingle{}ils contiennent des fichiers (ou des dossiers si besoin) et ainsi de suite...\hypertarget{main_8c_autotoc_md1}{}\doxysubsubsection{\texorpdfstring{2) Les structures transversales.}{2) Les structures transversales.}}\label{main_8c_autotoc_md1}
|
||||||
|
Les fonctions \textquotesingle{}transversales\textquotesingle{} comme celles de \textquotesingle{}graphics\textquotesingle{}, \textquotesingle{}parse\textquotesingle{}, \textquotesingle{}fsm\textquotesingle{}, \textquotesingle{}prefer\textquotesingle{}, et peut-\/être des structures communes à tous les arbres, listes, etc. doivent pouvoir être accédées directement sans avoir à passer par la hiérarchie des widgets et/ou callbacks. Elles restent à la racine\+: \textquotesingle{}src/
|
||||||
|
|
||||||
|
\textquotesingle{}finite state machine\textquotesingle{} (\textquotesingle{}fsm\textquotesingle{}) va centraliser l\textquotesingle{}identification des états (apparences) de la fenêtre et des transitions entre ces apparences; Elle sera probablement décomposée en de nombreux \textquotesingle{}sous-\/automates\textquotesingle{} tels que chaque état de la fenêtre soit une combinaison unique des états de ces sous-\/automates.
|
||||||
|
|
||||||
|
Exemple, muni des deux \textquotesingle{}sous-\/automates\textquotesingle{} \+: \begin{quote}
|
||||||
|
\{ EXEC, EDIT \}; // xor \{ STATE, RULES, DATA \}; // xor \end{quote}
|
||||||
|
la \textquotesingle{}finite state machine\textquotesingle{} peut se trouver dans 2 x 3 = 6 états. (voir fsm.\+h lignes 40-\/41)
|
||||||
|
|
||||||
|
Les grandes fonctions du client seront lancées par cette state machine \+:
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item édition automatique (optimisation) de l\textquotesingle{}arbre des conditions
|
||||||
|
\item tests sur un mini-\/serveur local
|
||||||
|
\item analyses de données...
|
||||||
|
\end{DoxyItemize}
|
||||||
|
|
||||||
|
Leur recueil et la mémorisation des préférences des utilisateurs sont des fonctions centrales mais leur mise en oeuvre suivra probalement des voies hiérarchiques.
|
||||||
|
|
||||||
|
On peut prévoir des préférences concernant l\textquotesingle{}apparence des widgets, les traductions, les \textquotesingle{}disabilities\textquotesingle{}; etc. mais aussi concernant les méthodes de travail, l\textquotesingle{}usage des outils d\textquotesingle{}analyse, etc. \texorpdfstring{$>$}{>}\texorpdfstring{$>$}{>} des \textquotesingle{}scripts\textquotesingle{} pour des \textquotesingle{}méta-\/fonctions\textquotesingle{} (des \textquotesingle{}macros\textquotesingle{}) ?
|
||||||
|
|
||||||
|
\doxysubsection{Function Documentation}
|
||||||
|
\Hypertarget{main_8c_a3c04138a5bfe5d72780bb7e82a18e627}\label{main_8c_a3c04138a5bfe5d72780bb7e82a18e627}
|
||||||
|
\index{main.c@{main.c}!main@{main}}
|
||||||
|
\index{main@{main}!main.c@{main.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{main()}{main()}}
|
||||||
|
{\footnotesize\ttfamily int main (\begin{DoxyParamCaption}\item[{int}]{argc, }\item[{char \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}}]{argv }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
gem-\/graph-\/client \doxylink{main_8c_a3c04138a5bfe5d72780bb7e82a18e627}{main()}
|
||||||
|
|
||||||
|
\begin{DoxyDate}{Date}
|
||||||
|
2024-\/04
|
||||||
|
\end{DoxyDate}
|
||||||
|
\begin{DoxyAuthor}{Author}
|
||||||
|
Jean
|
||||||
|
\end{DoxyAuthor}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
src/fsm/dispatch
|
||||||
|
|
||||||
|
src/signal
|
||||||
|
|
||||||
|
(none)
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em argc} & \\
|
||||||
|
\hline
|
||||||
|
{\em \texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}argv} & \\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
status
|
||||||
|
\end{DoxyReturn}
|
||||||
|
|
@ -0,0 +1,31 @@
|
||||||
|
\doxysection{elem Struct Reference}
|
||||||
|
\hypertarget{structelem}{}\label{structelem}\index{elem@{elem}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$util.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structelem_a0d014510b9a1170af58e8516fb05b0b4}\label{structelem_a0d014510b9a1170af58e8516fb05b0b4}
|
||||||
|
int {\bfseries value}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}value phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structelem_aed06f2c7ef2050b131c8b72e099a0090}\label{structelem_aed06f2c7ef2050b131c8b72e099a0090}
|
||||||
|
struct \mbox{\hyperlink{structelem}{elem}} \texorpdfstring{$\ast$}{*} {\bfseries prev}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}prev phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structelem_ab9cf5c2e1c9a0ec2938275b90d39d5ca}\label{structelem_ab9cf5c2e1c9a0ec2938275b90d39d5ca}
|
||||||
|
struct \mbox{\hyperlink{structelem}{elem}} \texorpdfstring{$\ast$}{*} {\bfseries next}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}next phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/util.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
\doxysection{dblist Struct Reference}
|
||||||
|
\hypertarget{structdblist}{}\label{structdblist}\index{dblist@{dblist}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$util.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structdblist_a14615ff4b03d8f42730257cba4c50a1d}\label{structdblist_a14615ff4b03d8f42730257cba4c50a1d}
|
||||||
|
\mbox{\hyperlink{structelem}{elem}} \texorpdfstring{$\ast$}{*} {\bfseries first}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}first phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structdblist_ab5a72762ee26deb694dc0c89fdbda49f}\label{structdblist_ab5a72762ee26deb694dc0c89fdbda49f}
|
||||||
|
\mbox{\hyperlink{structelem}{elem}} \texorpdfstring{$\ast$}{*} {\bfseries last}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}last phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/util.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
\doxysection{fsm\+\_\+struct\+\_\+list\+\_\+disp Struct Reference}
|
||||||
|
\hypertarget{structfsm__struct__list__disp}{}\label{structfsm__struct__list__disp}\index{fsm\_struct\_list\_disp@{fsm\_struct\_list\_disp}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$fsm.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structfsm__struct__list__disp_ae353ad2d0881411adb27e870dcbc45f8}\label{structfsm__struct__list__disp_ae353ad2d0881411adb27e870dcbc45f8}
|
||||||
|
int {\bfseries value}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}value phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structfsm__struct__list__disp_a46c8b210279be9ac51265cbddf4658cb}\label{structfsm__struct__list__disp_a46c8b210279be9ac51265cbddf4658cb}
|
||||||
|
struct \mbox{\hyperlink{structfsm__struct__list__disp}{fsm\+\_\+struct\+\_\+list\+\_\+disp}} \texorpdfstring{$\ast$}{*} {\bfseries suiv}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}suiv phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/fsm.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,31 @@
|
||||||
|
\doxysection{Tree\+Node\+\_\+t Struct Reference}
|
||||||
|
\hypertarget{structTreeNode__t}{}\label{structTreeNode__t}\index{TreeNode\_t@{TreeNode\_t}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$widget.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structTreeNode__t_a5e4889026cb6802484a6a5dfc87d2543}\label{structTreeNode__t_a5e4889026cb6802484a6a5dfc87d2543}
|
||||||
|
gchar \texorpdfstring{$\ast$}{*} {\bfseries text}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}text phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structTreeNode__t_a7b289d9cc907d24c4c61bc7a2e769383}\label{structTreeNode__t_a7b289d9cc907d24c4c61bc7a2e769383}
|
||||||
|
struct \mbox{\hyperlink{structTreeNode__t}{Tree\+Node\+\_\+t}} \texorpdfstring{$\ast$}{*} {\bfseries child}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}child phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structTreeNode__t_abf009b430b98b8b70739e90bceddb34b}\label{structTreeNode__t_abf009b430b98b8b70739e90bceddb34b}
|
||||||
|
struct \mbox{\hyperlink{structTreeNode__t}{Tree\+Node\+\_\+t}} \texorpdfstring{$\ast$}{*} {\bfseries next}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}next phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/widget.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
\doxysection{arrow\+\_\+t Struct Reference}
|
||||||
|
\hypertarget{structarrow__t}{}\label{structarrow__t}\index{arrow\_t@{arrow\_t}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$base.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structarrow__t_aab59a759430a26ffb233554f93a1af0a}\label{structarrow__t_aab59a759430a26ffb233554f93a1af0a}
|
||||||
|
uint {\bfseries load}
|
||||||
|
\begin{DoxyCompactList}\small\item\em load phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structarrow__t_a786d036972b09f652b6dc73af77aaee0}\label{structarrow__t_a786d036972b09f652b6dc73af77aaee0}
|
||||||
|
uint {\bfseries site}
|
||||||
|
\begin{DoxyCompactList}\small\item\em site phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structarrow__t_a848949ce2dea0b41734058d0e9447630}\label{structarrow__t_a848949ce2dea0b41734058d0e9447630}
|
||||||
|
uint {\bfseries x}
|
||||||
|
\begin{DoxyCompactList}\small\item\em x phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structarrow__t_a5afadb806f219b228d198585238ade29}\label{structarrow__t_a5afadb806f219b228d198585238ade29}
|
||||||
|
uint {\bfseries y}
|
||||||
|
\begin{DoxyCompactList}\small\item\em y phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structarrow__t_a22f69e050d4fe1ddc0eda9a8024f832f}\label{structarrow__t_a22f69e050d4fe1ddc0eda9a8024f832f}
|
||||||
|
uint {\bfseries z}
|
||||||
|
\begin{DoxyCompactList}\small\item\em z phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/base.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
\doxysection{preferences Struct Reference}
|
||||||
|
\hypertarget{structpreferences}{}\label{structpreferences}\index{preferences@{preferences}}
|
||||||
|
|
||||||
|
|
||||||
|
use this ? static const char \texorpdfstring{$\ast$}{*}icon\+\_\+name \mbox{[}3\mbox{]} = \{ "{}document-\/revert-\/rtl-\/symbolic"{}, "{}edit-\/undo-\/symbolic"{}, "{}view-\/refresh-\/symbolic"{} \};
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structpreferences_afac6511cae5d2491eb12406c2eca230d}\label{structpreferences_afac6511cae5d2491eb12406c2eca230d}
|
||||||
|
int {\bfseries transparency} \mbox{[}n\+\_\+objects\mbox{]}
|
||||||
|
\begin{DoxyCompactList}\small\item\em transparency \mbox{[}n\+\_\+objects\mbox{]} phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
use this ? static const char \texorpdfstring{$\ast$}{*}icon\+\_\+name \mbox{[}3\mbox{]} = \{ "{}document-\/revert-\/rtl-\/symbolic"{}, "{}edit-\/undo-\/symbolic"{}, "{}view-\/refresh-\/symbolic"{} \};
|
||||||
|
|
||||||
|
const char {\itshape fsm\+\_\+get\+\_\+button\+\_\+icon\+\_\+name (int n) \{return (const char}) icon\+\_\+name \mbox{[}n\mbox{]};\} phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
src/fsm/preferences/\mbox{\hyperlink{preferences_2manager_8c}{manager.\+c}}\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,401 @@
|
||||||
|
\doxysection{src/fsm/dispatch.c File Reference}
|
||||||
|
\hypertarget{fsm_2dispatch_8c}{}\label{fsm_2dispatch_8c}\index{src/fsm/dispatch.c@{src/fsm/dispatch.c}}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item OOOOOOOOOOO OOOOO OOO OOO \texorpdfstring{$\ast$}{*} OO OO OO OOOO OOOO \texorpdfstring{$\ast$}{*} OO OO OO OO OO OO \texorpdfstring{$\ast$}{*} OOOOOO OO OO OO OO OO \texorpdfstring{$\ast$}{*} OO OO OO OOO OO \texorpdfstring{$\ast$}{*} OO OO OO OO \texorpdfstring{$\ast$}{*} OO OO OOO OO OO \texorpdfstring{$\ast$}{*} OO OOOOOO OO OO \texorpdfstring{$\ast$}{*}
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item
|
||||||
|
\end{DoxyItemize}
|
||||||
|
\end{DoxyItemize}
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$stdbool.\+h$>$}\newline
|
||||||
|
{\ttfamily \#include "{}../../include/fsm.\+h"{}}\newline
|
||||||
|
{\ttfamily \#include "{}../../include/util.\+h"{}}\newline
|
||||||
|
{\ttfamily \#include "{}../../include/widget.\+h"{}}\newline
|
||||||
|
\doxysubsubsection*{Functions}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
void \mbox{\hyperlink{fsm_2dispatch_8c_a435d1a5171a7d69662d701234722fee2}{fsm\+\_\+journal\+\_\+publication\+\_\+request}} ()
|
||||||
|
\begin{DoxyCompactList}\small\item\em The \doxylink{fsm_2dispatch_8c_a435d1a5171a7d69662d701234722fee2}{fsm\+\_\+journal\+\_\+publication\+\_\+request()} is called only once, by \doxylink{main_8c_a3c04138a5bfe5d72780bb7e82a18e627}{main()}, just after closing the app and before ending the program. \end{DoxyCompactList}\item
|
||||||
|
void \mbox{\hyperlink{fsm_2dispatch_8c_a8c67f42f95d48ee2469c9a27d65db3e6}{fsm\+\_\+journal\+\_\+event}} (int severity, int source, const char \texorpdfstring{$\ast$}{*}file\+\_\+source, const char \texorpdfstring{$\ast$}{*}function\+\_\+source, const char \texorpdfstring{$\ast$}{*}string\+\_\+value)
|
||||||
|
\begin{DoxyCompactList}\small\item\em It is mandatory for any event to call this function to be published in the journal. \end{DoxyCompactList}\item
|
||||||
|
void \mbox{\hyperlink{fsm_2dispatch_8c_a8d91f5868f20ad3b72cfa63787d87444}{fsm\+\_\+init}} (char \texorpdfstring{$\ast$}{*}initial\+\_\+message\+\_\+from\+\_\+main)
|
||||||
|
\begin{DoxyCompactList}\small\item\em F S M I N I T \texorpdfstring{$\ast$}{*}. \end{DoxyCompactList}\item
|
||||||
|
void \mbox{\hyperlink{fsm_2dispatch_8c_a770bcaeb0bd6f81cddcc3cd506468fff}{fsm\+\_\+set\+\_\+preferences\+\_\+modified}} (bool value)
|
||||||
|
\begin{DoxyCompactList}\small\item\em setter for the static boolean\+: \textquotesingle{}preferences\+\_\+have\+\_\+been\+\_\+modified\textquotesingle{} \end{DoxyCompactList}\item
|
||||||
|
bool \mbox{\hyperlink{fsm_2dispatch_8c_a0b0231a311d0e85723ef9fcf38be88e3}{fsm\+\_\+get\+\_\+preferences\+\_\+state}} ()
|
||||||
|
\begin{DoxyCompactList}\small\item\em getter for the static boolean\+: \textquotesingle{}preferences\+\_\+have\+\_\+been\+\_\+modified\textquotesingle{} \end{DoxyCompactList}\item
|
||||||
|
int \mbox{\hyperlink{fsm_2dispatch_8c_a9123915ffd10fe1ae18254898b1c0ebf}{fsm\+\_\+get\+\_\+exec\+\_\+edit}} ()
|
||||||
|
\begin{DoxyCompactList}\small\item\em Any function that modifies the client window must obtain this boolean. \end{DoxyCompactList}\item
|
||||||
|
int \mbox{\hyperlink{fsm_2dispatch_8c_a90ab14081a88752d3721947a4922ee25}{fsm\+\_\+get\+\_\+state\+\_\+rules\+\_\+data}} ()
|
||||||
|
\begin{DoxyCompactList}\small\item\em Any function that modifies the client window must obtain this value. \end{DoxyCompactList}\item
|
||||||
|
void \mbox{\hyperlink{fsm_2dispatch_8c_ae921ecd39af67bb8dc0deb2cdc86125d}{fsm\+\_\+set\+\_\+exec\+\_\+edit}} (int choice)
|
||||||
|
\begin{DoxyCompactList}\small\item\em setter for the static value\+: \textquotesingle{}choice\+\_\+\+STATE\+\_\+\+RULES\+\_\+\+DATA\textquotesingle{} (in this file) \end{DoxyCompactList}\item
|
||||||
|
void \mbox{\hyperlink{fsm_2dispatch_8c_af5a464b19589ba1972c9b3aa3397945a}{fsm\+\_\+set\+\_\+state\+\_\+rules\+\_\+data}} (int choice)
|
||||||
|
\begin{DoxyCompactList}\small\item\em setter for the static value\+: \textquotesingle{}choice\+\_\+\+STATE\+\_\+\+RULES\+\_\+\+DATA\textquotesingle{} (in this file) \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item OOOOOOOOOOO OOOOO OOO OOO \texorpdfstring{$\ast$}{*} OO OO OO OOOO OOOO \texorpdfstring{$\ast$}{*} OO OO OO OO OO OO \texorpdfstring{$\ast$}{*} OOOOOO OO OO OO OO OO \texorpdfstring{$\ast$}{*} OO OO OO OOO OO \texorpdfstring{$\ast$}{*} OO OO OO OO \texorpdfstring{$\ast$}{*} OO OO OOO OO OO \texorpdfstring{$\ast$}{*} OO OOOOOO OO OO \texorpdfstring{$\ast$}{*}
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item
|
||||||
|
\end{DoxyItemize}
|
||||||
|
\end{DoxyItemize}
|
||||||
|
|
||||||
|
This Finite State Machine (fsm) describes all the possible states of the Gem-\/graph client and all the transitions between these states.
|
||||||
|
|
||||||
|
gem-\/graph-\/client fsm (Finite State Machine) manages four topics\+:
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item engine (window appearance)
|
||||||
|
\item measures (current measurements)
|
||||||
|
\item results (current data acquisition and displays)
|
||||||
|
\item preferences (current user preferences)
|
||||||
|
\end{DoxyItemize}
|
||||||
|
|
||||||
|
Each state of the finite state machine (fsm) is a combination of their states.
|
||||||
|
|
||||||
|
It must be
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item saved at the end of a work session and
|
||||||
|
\item reread (available) at the start of a new session.
|
||||||
|
\end{DoxyItemize}
|
||||||
|
|
||||||
|
No state of the fsm should be defined in another module. No fsm transition needs to be executed in another module.
|
||||||
|
|
||||||
|
The journal is created, edited and published from here.
|
||||||
|
|
||||||
|
\doxysubsection{Function Documentation}
|
||||||
|
\Hypertarget{fsm_2dispatch_8c_a9123915ffd10fe1ae18254898b1c0ebf}\label{fsm_2dispatch_8c_a9123915ffd10fe1ae18254898b1c0ebf}
|
||||||
|
\index{dispatch.c@{dispatch.c}!fsm\_get\_exec\_edit@{fsm\_get\_exec\_edit}}
|
||||||
|
\index{fsm\_get\_exec\_edit@{fsm\_get\_exec\_edit}!dispatch.c@{dispatch.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{fsm\_get\_exec\_edit()}{fsm\_get\_exec\_edit()}}
|
||||||
|
{\footnotesize\ttfamily int fsm\+\_\+get\+\_\+exec\+\_\+edit (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Any function that modifies the client window must obtain this boolean.
|
||||||
|
|
||||||
|
The \textquotesingle{}state\textquotesingle{} and \textquotesingle{}rules\textquotesingle{} pages appearance depends heavily on this.
|
||||||
|
|
||||||
|
see include/fsm enum fsm\+\_\+enum\+\_\+exec\+\_\+edit \{ EXEC, EDIT \} The current int may be replaced by a boolean before publication. TODO
|
||||||
|
|
||||||
|
\begin{DoxyDate}{Date}
|
||||||
|
2024-\/08
|
||||||
|
\end{DoxyDate}
|
||||||
|
\begin{DoxyAuthor}{Author}
|
||||||
|
Jean
|
||||||
|
\end{DoxyAuthor}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
src/widget/one\+\_\+rule/dispatch
|
||||||
|
|
||||||
|
src/widget/state/dispatch \texorpdfstring{$\ast$}{*} 2
|
||||||
|
|
||||||
|
src/signal
|
||||||
|
|
||||||
|
include/fsm enum fsm\+\_\+enum\+\_\+exec\+\_\+edit \{ EXEC, EDIT \} \texorpdfstring{$<$}{<}\texorpdfstring{$<$}{<} TODO check this
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
choice\+\_\+\+EXEC\+\_\+\+EDIT
|
||||||
|
\end{DoxyReturn}
|
||||||
|
\Hypertarget{fsm_2dispatch_8c_a0b0231a311d0e85723ef9fcf38be88e3}\label{fsm_2dispatch_8c_a0b0231a311d0e85723ef9fcf38be88e3}
|
||||||
|
\index{dispatch.c@{dispatch.c}!fsm\_get\_preferences\_state@{fsm\_get\_preferences\_state}}
|
||||||
|
\index{fsm\_get\_preferences\_state@{fsm\_get\_preferences\_state}!dispatch.c@{dispatch.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{fsm\_get\_preferences\_state()}{fsm\_get\_preferences\_state()}}
|
||||||
|
{\footnotesize\ttfamily bool fsm\+\_\+get\+\_\+preferences\+\_\+state (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
getter for the static boolean\+: \textquotesingle{}preferences\+\_\+have\+\_\+been\+\_\+modified\textquotesingle{}
|
||||||
|
|
||||||
|
\begin{DoxyDate}{Date}
|
||||||
|
2024-\/08
|
||||||
|
\end{DoxyDate}
|
||||||
|
\begin{DoxyAuthor}{Author}
|
||||||
|
Jean
|
||||||
|
\end{DoxyAuthor}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
TODO A function must obtain this boolean when it stores the current state of the fsm (including \doxylink{structpreferences}{preferences}) before closing the current session.
|
||||||
|
|
||||||
|
(none)
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
preferences\+\_\+have\+\_\+been\+\_\+modified
|
||||||
|
\end{DoxyReturn}
|
||||||
|
\Hypertarget{fsm_2dispatch_8c_a90ab14081a88752d3721947a4922ee25}\label{fsm_2dispatch_8c_a90ab14081a88752d3721947a4922ee25}
|
||||||
|
\index{dispatch.c@{dispatch.c}!fsm\_get\_state\_rules\_data@{fsm\_get\_state\_rules\_data}}
|
||||||
|
\index{fsm\_get\_state\_rules\_data@{fsm\_get\_state\_rules\_data}!dispatch.c@{dispatch.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{fsm\_get\_state\_rules\_data()}{fsm\_get\_state\_rules\_data()}}
|
||||||
|
{\footnotesize\ttfamily int fsm\+\_\+get\+\_\+state\+\_\+rules\+\_\+data (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Any function that modifies the client window must obtain this value.
|
||||||
|
|
||||||
|
The pages selection and the window appearance depends heavily on this.
|
||||||
|
|
||||||
|
see include/fsm enum fsm\+\_\+enum\+\_\+state\+\_\+rules\+\_\+data \{ SYNTH, STATE, RULES, DATA \}
|
||||||
|
|
||||||
|
\begin{DoxyDate}{Date}
|
||||||
|
2024-\/08
|
||||||
|
\end{DoxyDate}
|
||||||
|
\begin{DoxyAuthor}{Author}
|
||||||
|
Jean
|
||||||
|
\end{DoxyAuthor}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
src/widget/topbar/left
|
||||||
|
|
||||||
|
src/signal
|
||||||
|
|
||||||
|
(none)
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
choice\+\_\+\+STATE\+\_\+\+RULES\+\_\+\+DATA
|
||||||
|
\end{DoxyReturn}
|
||||||
|
\Hypertarget{fsm_2dispatch_8c_a8d91f5868f20ad3b72cfa63787d87444}\label{fsm_2dispatch_8c_a8d91f5868f20ad3b72cfa63787d87444}
|
||||||
|
\index{dispatch.c@{dispatch.c}!fsm\_init@{fsm\_init}}
|
||||||
|
\index{fsm\_init@{fsm\_init}!dispatch.c@{dispatch.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{fsm\_init()}{fsm\_init()}}
|
||||||
|
{\footnotesize\ttfamily void fsm\+\_\+init (\begin{DoxyParamCaption}\item[{char \texorpdfstring{$\ast$}{*}}]{initial\+\_\+message\+\_\+from\+\_\+main }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
F S M I N I T \texorpdfstring{$\ast$}{*}.
|
||||||
|
|
||||||
|
This is the first function called by \textquotesingle{}\doxylink{main_8c}{main.\+c}\textquotesingle{} It initiates the journal and four lists which are\+: \textquotesingle{}measures\textquotesingle{}, \textquotesingle{}results\textquotesingle{}, \textquotesingle{}displayables results\textquotesingle{} and \textquotesingle{}preferences\textquotesingle{}. These lists will be used to define the current state of the fsm.
|
||||||
|
|
||||||
|
\begin{DoxyDate}{Date}
|
||||||
|
2024-\/08
|
||||||
|
\end{DoxyDate}
|
||||||
|
\begin{DoxyAuthor}{Author}
|
||||||
|
Jean
|
||||||
|
\end{DoxyAuthor}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
src/main/main()
|
||||||
|
|
||||||
|
src/journal/fsm\+\_\+journal\+\_\+init()
|
||||||
|
|
||||||
|
src/fsm/dispatch/fsm\+\_\+journal\+\_\+event()
|
||||||
|
|
||||||
|
src/fsm/measures/manager/fsm\+\_\+list\+\_\+init\+\_\+measures()
|
||||||
|
|
||||||
|
src/fsm/results/manager/fsm\+\_\+list\+\_\+init\+\_\+results()
|
||||||
|
|
||||||
|
src/fsm/preferences/manager/fsm\+\_\+list\+\_\+init\+\_\+displayables()
|
||||||
|
|
||||||
|
src/fsm/preferences/manager/fsm\+\_\+list\+\_\+init\+\_\+preferences()
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em \texorpdfstring{$\ast$}{*}initial\+\_\+message\+\_\+from\+\_\+main} & \\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\Hypertarget{fsm_2dispatch_8c_a8c67f42f95d48ee2469c9a27d65db3e6}\label{fsm_2dispatch_8c_a8c67f42f95d48ee2469c9a27d65db3e6}
|
||||||
|
\index{dispatch.c@{dispatch.c}!fsm\_journal\_event@{fsm\_journal\_event}}
|
||||||
|
\index{fsm\_journal\_event@{fsm\_journal\_event}!dispatch.c@{dispatch.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{fsm\_journal\_event()}{fsm\_journal\_event()}}
|
||||||
|
{\footnotesize\ttfamily void fsm\+\_\+journal\+\_\+event (\begin{DoxyParamCaption}\item[{int}]{severity, }\item[{int}]{source, }\item[{const char \texorpdfstring{$\ast$}{*}}]{file\+\_\+source, }\item[{const char \texorpdfstring{$\ast$}{*}}]{function\+\_\+source, }\item[{const char \texorpdfstring{$\ast$}{*}}]{string\+\_\+value }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
If there are too many events, a filter can be applied here to select a few interesting events for publication in the log.
|
||||||
|
|
||||||
|
This filter can operate on any the following five parameters\+: severity, source, \texorpdfstring{$\ast$}{*}file\+\_\+source, \texorpdfstring{$\ast$}{*}function\+\_\+source, \texorpdfstring{$\ast$}{*}string\+\_\+value. \begin{DoxySeeAlso}{See also}
|
||||||
|
below (params)
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
Simple filters (on a single parameter) can be combined using the logical operators \textquotesingle{}and\textquotesingle{} and \textquotesingle{}or\textquotesingle{} and parentheses.
|
||||||
|
|
||||||
|
Use\+: \$ grep -\/r "{}fsm\+\_\+journal\+\_\+event"{} to confirm the callergraph calls.
|
||||||
|
|
||||||
|
\begin{DoxyDate}{Date}
|
||||||
|
2024-\/08
|
||||||
|
\end{DoxyDate}
|
||||||
|
\begin{DoxyAuthor}{Author}
|
||||||
|
Jean
|
||||||
|
\end{DoxyAuthor}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
src/journal.\+c/fsm\+\_\+journal\+\_\+push\+\_\+front()
|
||||||
|
|
||||||
|
src/main/main()
|
||||||
|
|
||||||
|
src/widget/topbar/modal.\+c
|
||||||
|
|
||||||
|
src/widget/topbar/right.\+c
|
||||||
|
|
||||||
|
src/widget/topbar/dialog.\+c
|
||||||
|
|
||||||
|
src/widget/topbar/left.\+c
|
||||||
|
|
||||||
|
src/widget/topbar/dispatch.\+c \texorpdfstring{$\ast$}{*} 3
|
||||||
|
|
||||||
|
src/widget/one\+\_\+rule/dispatch.\+c
|
||||||
|
|
||||||
|
src/widget/one\+\_\+rule/algebra/conditions.\+c \texorpdfstring{$\ast$}{*} 2
|
||||||
|
|
||||||
|
src/widget/measure/dispatch.\+c
|
||||||
|
|
||||||
|
src/widget/dispatch.\+c \texorpdfstring{$\ast$}{*} 3
|
||||||
|
|
||||||
|
src/widget/all\+\_\+rules/dispatch.\+c
|
||||||
|
|
||||||
|
\doxylink{preferences_2manager_8c}{src/fsm/preferences/manager.\+c} \texorpdfstring{$\ast$}{*} 8
|
||||||
|
|
||||||
|
src/fsm/measures/manager.\+c \texorpdfstring{$\ast$}{*} 2
|
||||||
|
|
||||||
|
src/fsm/measures/tools\+\_\+list.\+c \texorpdfstring{$\ast$}{*} 4
|
||||||
|
|
||||||
|
\doxylink{fsm_2dispatch_8c}{src/fsm/dispatch.\+c} \texorpdfstring{$\ast$}{*} 10
|
||||||
|
|
||||||
|
src/fsm/results/manager.\+c
|
||||||
|
|
||||||
|
src/util/tree.\+c
|
||||||
|
|
||||||
|
src/signal.\+c \texorpdfstring{$\ast$}{*} 38
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em severity} & \texorpdfstring{$<$}{<}\texorpdfstring{$>$}{>} \\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
enum fsm\+\_\+enum\+\_\+journal\+\_\+severity in include/fsm.\+h \textquotesingle{}severity\textquotesingle{} 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
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em source} & \texorpdfstring{$<$}{<}\texorpdfstring{$>$}{>} \\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
enum fsm\+\_\+enum\+\_\+journal\+\_\+source in include/fsm.\+h \textquotesingle{}source\textquotesingle{} is a pre-\/defined value that can be associated to each event. It is not mandatory. It can be set to \textquotesingle{}NULL\textquotesingle{}.
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em \texorpdfstring{$\ast$}{*}file\+\_\+source} & \texorpdfstring{$<$}{<}\texorpdfstring{$>$}{>} the name of the file that emits the event. \\
|
||||||
|
\hline
|
||||||
|
{\em \texorpdfstring{$\ast$}{*}function\+\_\+source} & \texorpdfstring{$<$}{<}\texorpdfstring{$>$}{>} the function that emits the event. \\
|
||||||
|
\hline
|
||||||
|
{\em \texorpdfstring{$\ast$}{*}string\+\_\+value} & \texorpdfstring{$<$}{<}\texorpdfstring{$>$}{>} any value that can qualify the event and provides useful information when reading the log. \\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\Hypertarget{fsm_2dispatch_8c_a435d1a5171a7d69662d701234722fee2}\label{fsm_2dispatch_8c_a435d1a5171a7d69662d701234722fee2}
|
||||||
|
\index{dispatch.c@{dispatch.c}!fsm\_journal\_publication\_request@{fsm\_journal\_publication\_request}}
|
||||||
|
\index{fsm\_journal\_publication\_request@{fsm\_journal\_publication\_request}!dispatch.c@{dispatch.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{fsm\_journal\_publication\_request()}{fsm\_journal\_publication\_request()}}
|
||||||
|
{\footnotesize\ttfamily void fsm\+\_\+journal\+\_\+publication\+\_\+request (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
The \doxylink{fsm_2dispatch_8c_a435d1a5171a7d69662d701234722fee2}{fsm\+\_\+journal\+\_\+publication\+\_\+request()} is called only once, by \doxylink{main_8c_a3c04138a5bfe5d72780bb7e82a18e627}{main()}, just after closing the app and before ending the program.
|
||||||
|
|
||||||
|
This is to guarantee the chronological order of the events in the journal.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
src/journal.\+c/fsm\+\_\+journal\+\_\+publish() (called here) is the last function of the program to be executed.
|
||||||
|
|
||||||
|
The \doxylink{structfsm__struct__journal}{fsm\+\_\+struct\+\_\+journal} (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.
|
||||||
|
|
||||||
|
\begin{DoxyDate}{Date}
|
||||||
|
2024-\/08
|
||||||
|
\end{DoxyDate}
|
||||||
|
\begin{DoxyAuthor}{Author}
|
||||||
|
Jean
|
||||||
|
\end{DoxyAuthor}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
src/main/main()
|
||||||
|
|
||||||
|
src/journal/fsm\+\_\+journal\+\_\+publish()
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
\Hypertarget{fsm_2dispatch_8c_ae921ecd39af67bb8dc0deb2cdc86125d}\label{fsm_2dispatch_8c_ae921ecd39af67bb8dc0deb2cdc86125d}
|
||||||
|
\index{dispatch.c@{dispatch.c}!fsm\_set\_exec\_edit@{fsm\_set\_exec\_edit}}
|
||||||
|
\index{fsm\_set\_exec\_edit@{fsm\_set\_exec\_edit}!dispatch.c@{dispatch.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{fsm\_set\_exec\_edit()}{fsm\_set\_exec\_edit()}}
|
||||||
|
{\footnotesize\ttfamily void fsm\+\_\+set\+\_\+exec\+\_\+edit (\begin{DoxyParamCaption}\item[{int}]{choice }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
setter for the static value\+: \textquotesingle{}choice\+\_\+\+STATE\+\_\+\+RULES\+\_\+\+DATA\textquotesingle{} (in this file)
|
||||||
|
|
||||||
|
see include/fsm enum fsm\+\_\+enum\+\_\+exec\+\_\+edit \{ EXEC, EDIT \}
|
||||||
|
|
||||||
|
\begin{DoxyDate}{Date}
|
||||||
|
2024-\/08
|
||||||
|
\end{DoxyDate}
|
||||||
|
\begin{DoxyAuthor}{Author}
|
||||||
|
Jean
|
||||||
|
\end{DoxyAuthor}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
(none)
|
||||||
|
|
||||||
|
src/signal \texorpdfstring{$\ast$}{*} 2
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em choice} & \texorpdfstring{$<$}{<} a boolean value which can be "{}\+EXEC"{} or "{}\+EDIT"{} \\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\Hypertarget{fsm_2dispatch_8c_a770bcaeb0bd6f81cddcc3cd506468fff}\label{fsm_2dispatch_8c_a770bcaeb0bd6f81cddcc3cd506468fff}
|
||||||
|
\index{dispatch.c@{dispatch.c}!fsm\_set\_preferences\_modified@{fsm\_set\_preferences\_modified}}
|
||||||
|
\index{fsm\_set\_preferences\_modified@{fsm\_set\_preferences\_modified}!dispatch.c@{dispatch.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{fsm\_set\_preferences\_modified()}{fsm\_set\_preferences\_modified()}}
|
||||||
|
{\footnotesize\ttfamily void fsm\+\_\+set\+\_\+preferences\+\_\+modified (\begin{DoxyParamCaption}\item[{bool}]{value }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
setter for the static boolean\+: \textquotesingle{}preferences\+\_\+have\+\_\+been\+\_\+modified\textquotesingle{}
|
||||||
|
|
||||||
|
\begin{DoxyDate}{Date}
|
||||||
|
2024-\/08
|
||||||
|
\end{DoxyDate}
|
||||||
|
\begin{DoxyAuthor}{Author}
|
||||||
|
Jean
|
||||||
|
\end{DoxyAuthor}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
TODO To be used by any function that modifies the current user \doxylink{structpreferences}{preferences}
|
||||||
|
|
||||||
|
\doxylink{fsm_2dispatch_8c_a8c67f42f95d48ee2469c9a27d65db3e6}{fsm\+\_\+journal\+\_\+event()}
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em value} & = TRUE if preferences\+\_\+have\+\_\+been\+\_\+modified. \\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\Hypertarget{fsm_2dispatch_8c_af5a464b19589ba1972c9b3aa3397945a}\label{fsm_2dispatch_8c_af5a464b19589ba1972c9b3aa3397945a}
|
||||||
|
\index{dispatch.c@{dispatch.c}!fsm\_set\_state\_rules\_data@{fsm\_set\_state\_rules\_data}}
|
||||||
|
\index{fsm\_set\_state\_rules\_data@{fsm\_set\_state\_rules\_data}!dispatch.c@{dispatch.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{fsm\_set\_state\_rules\_data()}{fsm\_set\_state\_rules\_data()}}
|
||||||
|
{\footnotesize\ttfamily void fsm\+\_\+set\+\_\+state\+\_\+rules\+\_\+data (\begin{DoxyParamCaption}\item[{int}]{choice }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
setter for the static value\+: \textquotesingle{}choice\+\_\+\+STATE\+\_\+\+RULES\+\_\+\+DATA\textquotesingle{} (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 \textquotesingle{}SYNTH\textquotesingle{}. \begin{DoxySeeAlso}{See also}
|
||||||
|
line 292 choice\+\_\+\+STATE\+\_\+\+RULES\+\_\+\+DATA = SYNTH; NB This choice can be temporarily modified for debugging purpose\+:
|
||||||
|
|
||||||
|
end of the function\+: \doxylink{fsm_2dispatch_8c}{fsm/dispatch.\+c} window\+\_\+design\+\_\+topbar\+\_\+left()
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
\begin{DoxyDate}{Date}
|
||||||
|
2024-\/08
|
||||||
|
\end{DoxyDate}
|
||||||
|
\begin{DoxyAuthor}{Author}
|
||||||
|
Jean
|
||||||
|
\end{DoxyAuthor}
|
||||||
|
\begin{DoxySeeAlso}{See also}
|
||||||
|
src/signal \texorpdfstring{$\ast$}{*} 4
|
||||||
|
|
||||||
|
(none)
|
||||||
|
\end{DoxySeeAlso}
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em choice} & \\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
\doxysection{fsm\+\_\+struct\+\_\+list\+\_\+tool Struct Reference}
|
||||||
|
\hypertarget{structfsm__struct__list__tool}{}\label{structfsm__struct__list__tool}\index{fsm\_struct\_list\_tool@{fsm\_struct\_list\_tool}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$fsm.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structfsm__struct__list__tool_a5f73a80ddae5f67ef8bbb161ae2c4259}\label{structfsm__struct__list__tool_a5f73a80ddae5f67ef8bbb161ae2c4259}
|
||||||
|
int {\bfseries value}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}value phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structfsm__struct__list__tool_ac6a36e7f389c23eb5404f0c5c3a4005a}\label{structfsm__struct__list__tool_ac6a36e7f389c23eb5404f0c5c3a4005a}
|
||||||
|
struct \mbox{\hyperlink{structfsm__struct__list__tool}{fsm\+\_\+struct\+\_\+list\+\_\+tool}} \texorpdfstring{$\ast$}{*} {\bfseries suiv}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}suiv phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/fsm.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
\doxysection{stack\+\_\+index\+\_\+t Struct Reference}
|
||||||
|
\hypertarget{structstack__index__t}{}\label{structstack__index__t}\index{stack\_index\_t@{stack\_index\_t}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structstack__index__t_ad0aae1e2bf45eb8855155ad713b4c3d4}\label{structstack__index__t_ad0aae1e2bf45eb8855155ad713b4c3d4}
|
||||||
|
long {\bfseries stack\+\_\+id}
|
||||||
|
\begin{DoxyCompactList}\small\item\em stack\+\_\+id phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structstack__index__t_a9b5ca3909ae086aa1ecbf4d581c2d596}\label{structstack__index__t_a9b5ca3909ae086aa1ecbf4d581c2d596}
|
||||||
|
void \texorpdfstring{$\ast$}{*} {\bfseries container\+\_\+widget}
|
||||||
|
\begin{DoxyCompactList}\small\item\em container\+\_\+widget phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structstack__index__t_af27d972a040feb4ad2c52e7575e85854}\label{structstack__index__t_af27d972a040feb4ad2c52e7575e85854}
|
||||||
|
void \texorpdfstring{$\ast$}{*} {\bfseries gl\+\_\+area}
|
||||||
|
\begin{DoxyCompactList}\small\item\em gl\+\_\+area phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
src/util/draw/\mbox{\hyperlink{gl_8c}{gl.\+c}}\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
\doxysection{Stack Struct Reference}
|
||||||
|
\hypertarget{structStack}{}\label{structStack}\index{Stack@{Stack}}
|
||||||
|
|
||||||
|
|
||||||
|
struct images\+\_\+bff \{Gtk\+Widget \texorpdfstring{$\ast$}{*}arr\mbox{[}MAX\+\_\+\+SIZE\mbox{]}; int top;\}; static struct images\+\_\+bff \texorpdfstring{$\ast$}{*}my\+\_\+list = NULL;//, \texorpdfstring{$\ast$}{*}babar = NULL; static struct images\+\_\+bff \texorpdfstring{$\ast$}{*}alloc\+\_\+images\+\_\+bff () \{ struct images\+\_\+bff \texorpdfstring{$\ast$}{*}p; p = malloc (sizeof (struct images\+\_\+bff)); if (p == NULL) printf ("{}fatal\+: ran out of storage"{}); p-\/\texorpdfstring{$>$}{>}arr\mbox{[}MAX\+\_\+\+SIZE\mbox{]} = NULL; p-\/\texorpdfstring{$>$}{>}top = 0; return p; \} static void add\+\_\+to\+\_\+mylist (int my\+\_\+int) \{ struct images\+\_\+bff \texorpdfstring{$\ast$}{*}p = alloc\+\_\+images\+\_\+bff (); p-\/\texorpdfstring{$>$}{>}arr\mbox{[}MAX\+\_\+\+SIZE\mbox{]} = NULL; // TODO p-\/\texorpdfstring{$>$}{>}top = my\+\_\+int; my\+\_\+list = p; \} static void free\+\_\+intlist (struct images\+\_\+bff \texorpdfstring{$\ast$}{*}p) \{ TODO \} TODO free\+\_\+intlist (mylist); TODO mylist = NULL; TODO offsetof (type, field)
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structStack_a9c232ff5046f7d60a7ec923326775590}\label{structStack_a9c232ff5046f7d60a7ec923326775590}
|
||||||
|
Gtk\+Widget \texorpdfstring{$\ast$}{*} {\bfseries arr} \mbox{[}MAX\+\_\+\+SIZE\mbox{]}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}arr\mbox{[}MAX\+\_\+\+SIZE\mbox{]} phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structStack_ad62fb36816185f3eef3a6f735a61f54a}\label{structStack_ad62fb36816185f3eef3a6f735a61f54a}
|
||||||
|
int {\bfseries top}
|
||||||
|
\begin{DoxyCompactList}\small\item\em top phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
struct images\+\_\+bff \{Gtk\+Widget \texorpdfstring{$\ast$}{*}arr\mbox{[}MAX\+\_\+\+SIZE\mbox{]}; int top;\}; static struct images\+\_\+bff \texorpdfstring{$\ast$}{*}my\+\_\+list = NULL;//, \texorpdfstring{$\ast$}{*}babar = NULL; static struct images\+\_\+bff \texorpdfstring{$\ast$}{*}alloc\+\_\+images\+\_\+bff () \{ struct images\+\_\+bff \texorpdfstring{$\ast$}{*}p; p = malloc (sizeof (struct images\+\_\+bff)); if (p == NULL) printf ("{}fatal\+: ran out of storage"{}); p-\/\texorpdfstring{$>$}{>}arr\mbox{[}MAX\+\_\+\+SIZE\mbox{]} = NULL; p-\/\texorpdfstring{$>$}{>}top = 0; return p; \} static void add\+\_\+to\+\_\+mylist (int my\+\_\+int) \{ struct images\+\_\+bff \texorpdfstring{$\ast$}{*}p = alloc\+\_\+images\+\_\+bff (); p-\/\texorpdfstring{$>$}{>}arr\mbox{[}MAX\+\_\+\+SIZE\mbox{]} = NULL; // TODO p-\/\texorpdfstring{$>$}{>}top = my\+\_\+int; my\+\_\+list = p; \} static void free\+\_\+intlist (struct images\+\_\+bff \texorpdfstring{$\ast$}{*}p) \{ TODO \} TODO free\+\_\+intlist (mylist); TODO mylist = NULL; TODO offsetof (type, field)
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
src/widget/all\+\_\+rules/compare/interest.\+c\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,102 @@
|
||||||
|
\doxysection{fsm\+\_\+struct\+\_\+journal\+\_\+unit Struct Reference}
|
||||||
|
\hypertarget{structfsm__struct__journal__unit}{}\label{structfsm__struct__journal__unit}\index{fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$fsm.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
long \mbox{\hyperlink{structfsm__struct__journal__unit_a932a3e2c6c87e442213ec109eeaf9e8a}{yy\+\_\+dd\+\_\+mm}}
|
||||||
|
\item
|
||||||
|
long \mbox{\hyperlink{structfsm__struct__journal__unit_a15f25f19f95836422b016955e3923f4a}{usec}}
|
||||||
|
\item
|
||||||
|
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structfsm__struct__journal__unit_a2354246a3b5139ffb1fc120ed85e5db7}{file\+\_\+source}}
|
||||||
|
\item
|
||||||
|
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structfsm__struct__journal__unit_a6c0be2efbdca90fe39e16066256875cb}{function\+\_\+source}}
|
||||||
|
\item
|
||||||
|
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structfsm__struct__journal__unit_ac9aa94406e089f89af0732db8d94b25f}{string\+\_\+value}}
|
||||||
|
\item
|
||||||
|
struct \mbox{\hyperlink{structfsm__struct__journal__unit}{fsm\+\_\+struct\+\_\+journal\+\_\+unit}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structfsm__struct__journal__unit_a7d5e9e10caadc69643112b5a4eeb2d75}{prev}}
|
||||||
|
\item
|
||||||
|
struct \mbox{\hyperlink{structfsm__struct__journal__unit}{fsm\+\_\+struct\+\_\+journal\+\_\+unit}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structfsm__struct__journal__unit_ab37616d51b850373be72bee05eaf73ca}{next}}
|
||||||
|
\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
\doxysubsection{Member Data Documentation}
|
||||||
|
\Hypertarget{structfsm__struct__journal__unit_a2354246a3b5139ffb1fc120ed85e5db7}\label{structfsm__struct__journal__unit_a2354246a3b5139ffb1fc120ed85e5db7}
|
||||||
|
\index{fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}!file\_source@{file\_source}}
|
||||||
|
\index{file\_source@{file\_source}!fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{file\_source}{file\_source}}
|
||||||
|
{\footnotesize\ttfamily const char\texorpdfstring{$\ast$}{*} fsm\+\_\+struct\+\_\+journal\+\_\+unit\+::file\+\_\+source}
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item phantom documentation
|
||||||
|
\end{DoxyItemize}\Hypertarget{structfsm__struct__journal__unit_a6c0be2efbdca90fe39e16066256875cb}\label{structfsm__struct__journal__unit_a6c0be2efbdca90fe39e16066256875cb}
|
||||||
|
\index{fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}!function\_source@{function\_source}}
|
||||||
|
\index{function\_source@{function\_source}!fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{function\_source}{function\_source}}
|
||||||
|
{\footnotesize\ttfamily const char\texorpdfstring{$\ast$}{*} fsm\+\_\+struct\+\_\+journal\+\_\+unit\+::function\+\_\+source}
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item phantom documentation
|
||||||
|
\end{DoxyItemize}\Hypertarget{structfsm__struct__journal__unit_ab37616d51b850373be72bee05eaf73ca}\label{structfsm__struct__journal__unit_ab37616d51b850373be72bee05eaf73ca}
|
||||||
|
\index{fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}!next@{next}}
|
||||||
|
\index{next@{next}!fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{next}{next}}
|
||||||
|
{\footnotesize\ttfamily struct \mbox{\hyperlink{structfsm__struct__journal__unit}{fsm\+\_\+struct\+\_\+journal\+\_\+unit}}\texorpdfstring{$\ast$}{*} fsm\+\_\+struct\+\_\+journal\+\_\+unit\+::next}
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item phantom documentation
|
||||||
|
\end{DoxyItemize}\Hypertarget{structfsm__struct__journal__unit_a7d5e9e10caadc69643112b5a4eeb2d75}\label{structfsm__struct__journal__unit_a7d5e9e10caadc69643112b5a4eeb2d75}
|
||||||
|
\index{fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}!prev@{prev}}
|
||||||
|
\index{prev@{prev}!fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{prev}{prev}}
|
||||||
|
{\footnotesize\ttfamily struct \mbox{\hyperlink{structfsm__struct__journal__unit}{fsm\+\_\+struct\+\_\+journal\+\_\+unit}}\texorpdfstring{$\ast$}{*} fsm\+\_\+struct\+\_\+journal\+\_\+unit\+::prev}
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item phantom documentation
|
||||||
|
\end{DoxyItemize}\Hypertarget{structfsm__struct__journal__unit_ac9aa94406e089f89af0732db8d94b25f}\label{structfsm__struct__journal__unit_ac9aa94406e089f89af0732db8d94b25f}
|
||||||
|
\index{fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}!string\_value@{string\_value}}
|
||||||
|
\index{string\_value@{string\_value}!fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{string\_value}{string\_value}}
|
||||||
|
{\footnotesize\ttfamily const char\texorpdfstring{$\ast$}{*} fsm\+\_\+struct\+\_\+journal\+\_\+unit\+::string\+\_\+value}
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item phantom documentation
|
||||||
|
\end{DoxyItemize}\Hypertarget{structfsm__struct__journal__unit_a15f25f19f95836422b016955e3923f4a}\label{structfsm__struct__journal__unit_a15f25f19f95836422b016955e3923f4a}
|
||||||
|
\index{fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}!usec@{usec}}
|
||||||
|
\index{usec@{usec}!fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{usec}{usec}}
|
||||||
|
{\footnotesize\ttfamily long fsm\+\_\+struct\+\_\+journal\+\_\+unit\+::usec}
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item phantom documentation
|
||||||
|
\end{DoxyItemize}\Hypertarget{structfsm__struct__journal__unit_a932a3e2c6c87e442213ec109eeaf9e8a}\label{structfsm__struct__journal__unit_a932a3e2c6c87e442213ec109eeaf9e8a}
|
||||||
|
\index{fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}!yy\_dd\_mm@{yy\_dd\_mm}}
|
||||||
|
\index{yy\_dd\_mm@{yy\_dd\_mm}!fsm\_struct\_journal\_unit@{fsm\_struct\_journal\_unit}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{yy\_dd\_mm}{yy\_dd\_mm}}
|
||||||
|
{\footnotesize\ttfamily long fsm\+\_\+struct\+\_\+journal\+\_\+unit\+::yy\+\_\+dd\+\_\+mm}
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item phantom documentation
|
||||||
|
\end{DoxyItemize}
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/fsm.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,47 @@
|
||||||
|
\doxysection{fsm\+\_\+struct\+\_\+journal Struct Reference}
|
||||||
|
\hypertarget{structfsm__struct__journal}{}\label{structfsm__struct__journal}\index{fsm\_struct\_journal@{fsm\_struct\_journal}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$fsm.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\mbox{\hyperlink{structfsm__struct__journal__unit}{fsm\+\_\+struct\+\_\+journal\+\_\+unit}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structfsm__struct__journal_ac4fb89c8fb499c05f57978200d8628d9}{first}}
|
||||||
|
\item
|
||||||
|
\mbox{\hyperlink{structfsm__struct__journal__unit}{fsm\+\_\+struct\+\_\+journal\+\_\+unit}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{structfsm__struct__journal_a3e55d9bb62c322d8e1ae5dc90d7a5f6d}{last}}
|
||||||
|
\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
\doxysubsection{Member Data Documentation}
|
||||||
|
\Hypertarget{structfsm__struct__journal_ac4fb89c8fb499c05f57978200d8628d9}\label{structfsm__struct__journal_ac4fb89c8fb499c05f57978200d8628d9}
|
||||||
|
\index{fsm\_struct\_journal@{fsm\_struct\_journal}!first@{first}}
|
||||||
|
\index{first@{first}!fsm\_struct\_journal@{fsm\_struct\_journal}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{first}{first}}
|
||||||
|
{\footnotesize\ttfamily \mbox{\hyperlink{structfsm__struct__journal__unit}{fsm\+\_\+struct\+\_\+journal\+\_\+unit}}\texorpdfstring{$\ast$}{*} fsm\+\_\+struct\+\_\+journal\+::first}
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item phantom documentation
|
||||||
|
\end{DoxyItemize}\Hypertarget{structfsm__struct__journal_a3e55d9bb62c322d8e1ae5dc90d7a5f6d}\label{structfsm__struct__journal_a3e55d9bb62c322d8e1ae5dc90d7a5f6d}
|
||||||
|
\index{fsm\_struct\_journal@{fsm\_struct\_journal}!last@{last}}
|
||||||
|
\index{last@{last}!fsm\_struct\_journal@{fsm\_struct\_journal}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{last}{last}}
|
||||||
|
{\footnotesize\ttfamily \mbox{\hyperlink{structfsm__struct__journal__unit}{fsm\+\_\+struct\+\_\+journal\+\_\+unit}}\texorpdfstring{$\ast$}{*} fsm\+\_\+struct\+\_\+journal\+::last}
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item phantom documentation
|
||||||
|
\end{DoxyItemize}
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/fsm.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
\doxysection{fsm\+\_\+struct\+\_\+list\+\_\+data Struct Reference}
|
||||||
|
\hypertarget{structfsm__struct__list__data}{}\label{structfsm__struct__list__data}\index{fsm\_struct\_list\_data@{fsm\_struct\_list\_data}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$fsm.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structfsm__struct__list__data_a5eb8634842969f2fd4581d364ab28cc1}\label{structfsm__struct__list__data_a5eb8634842969f2fd4581d364ab28cc1}
|
||||||
|
int {\bfseries value}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}value phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structfsm__struct__list__data_a190465361efd7dafe1ee1f489a272ac0}\label{structfsm__struct__list__data_a190465361efd7dafe1ee1f489a272ac0}
|
||||||
|
struct \mbox{\hyperlink{structfsm__struct__list__data}{fsm\+\_\+struct\+\_\+list\+\_\+data}} \texorpdfstring{$\ast$}{*} {\bfseries suiv}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}suiv phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/fsm.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
\doxysection{src/fsm/preferences/manager.c File Reference}
|
||||||
|
\hypertarget{preferences_2manager_8c}{}\label{preferences_2manager_8c}\index{src/fsm/preferences/manager.c@{src/fsm/preferences/manager.c}}
|
||||||
|
{\ttfamily \#include "{}../../../include/fsm.\+h"{}}\newline
|
||||||
|
{\ttfamily \#include "{}../../../include/signal.\+h"{}}\newline
|
||||||
|
{\ttfamily \#include "{}../../../include/widget.\+h"{}}\newline
|
||||||
|
\doxysubsubsection*{Classes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
struct \mbox{\hyperlink{structpreferences}{preferences}}
|
||||||
|
\begin{DoxyCompactList}\small\item\em use this ? static const char \texorpdfstring{$\ast$}{*}icon\+\_\+name \mbox{[}3\mbox{]} = \{ "{}document-\/revert-\/rtl-\/symbolic"{}, "{}edit-\/undo-\/symbolic"{}, "{}view-\/refresh-\/symbolic"{} \}; \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
\doxysubsubsection*{Functions}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{preferences_2manager_8c_a42a491a3a432cf572b3c2ed84a00d927}\label{preferences_2manager_8c_a42a491a3a432cf572b3c2ed84a00d927}
|
||||||
|
void {\bfseries fsm\+\_\+set\+\_\+store\+\_\+restore\+\_\+reset} (int choice, int value)
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{preferences_2manager_8c_abb1b857c9ec1ab39d6cb7cdf683a08d1}\label{preferences_2manager_8c_abb1b857c9ec1ab39d6cb7cdf683a08d1}
|
||||||
|
void {\bfseries fsm\+\_\+reset\+\_\+all\+\_\+situations\+\_\+values} (int value)
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{preferences_2manager_8c_aa69a9ce07b26ad1863960c6f0d1303b5}\label{preferences_2manager_8c_aa69a9ce07b26ad1863960c6f0d1303b5}
|
||||||
|
void {\bfseries fsm\+\_\+add\+\_\+displayable} (char \texorpdfstring{$\ast$}{*}displayable\+\_\+name)
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{preferences_2manager_8c_aa02db2c62f7507eabfcc9a41f0e660b6}\label{preferences_2manager_8c_aa02db2c62f7507eabfcc9a41f0e660b6}
|
||||||
|
void {\bfseries fsm\+\_\+list\+\_\+init\+\_\+preferences} ()
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{preferences_2manager_8c_a8eaa768708ebc21d710a8cc6144af1d3}\label{preferences_2manager_8c_a8eaa768708ebc21d710a8cc6144af1d3}
|
||||||
|
void {\bfseries fsm\+\_\+list\+\_\+init\+\_\+displayables} ()
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
\doxysubsubsection*{Variables}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{preferences_2manager_8c_aca528e2aeb796176a06819e058557e72}\label{preferences_2manager_8c_aca528e2aeb796176a06819e058557e72}
|
||||||
|
struct \mbox{\hyperlink{structpreferences}{preferences}} \texorpdfstring{$\ast$}{*} {\bfseries pref\+\_\+jean} = NULL
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
\doxysection{pile Struct Reference}
|
||||||
|
\hypertarget{structpile}{}\label{structpile}\index{pile@{pile}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$util.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structpile_a404c7f7ab8c7abe008de4e28657983c8}\label{structpile_a404c7f7ab8c7abe008de4e28657983c8}
|
||||||
|
int {\bfseries value}
|
||||||
|
\begin{DoxyCompactList}\small\item\em value phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structpile_a34a9ae6f1ef6a39ba2c809da6dd4921d}\label{structpile_a34a9ae6f1ef6a39ba2c809da6dd4921d}
|
||||||
|
struct \mbox{\hyperlink{structpile}{pile}} \texorpdfstring{$\ast$}{*} {\bfseries prev}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}prev phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/util.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,196 @@
|
||||||
|
\doxysection{src/util/draw/gl.c File Reference}
|
||||||
|
\hypertarget{gl_8c}{}\label{gl_8c}\index{src/util/draw/gl.c@{src/util/draw/gl.c}}
|
||||||
|
{\ttfamily \#include "{}../../../include/graphics.\+h"{}}\newline
|
||||||
|
{\ttfamily \#include "{}../../../include/signal.\+h"{}}\newline
|
||||||
|
\doxysubsubsection*{Classes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
struct \mbox{\hyperlink{structstack__index__t}{stack\+\_\+index\+\_\+t}}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
\doxysubsubsection*{Macros}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{gl_8c_a2737fdf992bd5a9d008f620ddaf50107}\label{gl_8c_a2737fdf992bd5a9d008f620ddaf50107}
|
||||||
|
\#define {\bfseries GL\+\_\+\+AREA\+\_\+\+SIZE}~400
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
\doxysubsubsection*{Functions}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{gl_8c_a289cfe9a70bcb690eeff2639dd8a98cd}\label{gl_8c_a289cfe9a70bcb690eeff2639dd8a98cd}
|
||||||
|
int {\bfseries util\+\_\+gl\+\_\+set\+\_\+arrow} (int 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)
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\item
|
||||||
|
long \mbox{\hyperlink{gl_8c_adbe03a3d239b22390e9de809443c8df9}{util\+\_\+gl\+\_\+get\+\_\+stack}} (void \texorpdfstring{$\ast$}{*}container\+\_\+widget)
|
||||||
|
\begin{DoxyCompactList}\small\item\em Look for stack entry and returns stack\+\_\+id. \end{DoxyCompactList}\item
|
||||||
|
long \mbox{\hyperlink{gl_8c_a5a691fdca6e3088ea9c1927096541624}{util\+\_\+gl\+\_\+is\+\_\+ready}} (void \texorpdfstring{$\ast$}{*}container\+\_\+widget)
|
||||||
|
\begin{DoxyCompactList}\small\item\em Look for stack entry and returns stack\+\_\+id. \end{DoxyCompactList}\item
|
||||||
|
bool \mbox{\hyperlink{gl_8c_a28b44187c7ae713705874288323e10a6}{util\+\_\+gl\+\_\+init\+\_\+stack}} (void \texorpdfstring{$\ast$}{*}container\+\_\+widget, GError \texorpdfstring{$\ast$}{*}error\+\_\+buffer)
|
||||||
|
\begin{DoxyCompactList}\small\item\em Look for stack entry and initializes Open\+GL for it. \end{DoxyCompactList}\item
|
||||||
|
bool \mbox{\hyperlink{gl_8c_a9d41985e1832e0a798e722d2341752f1}{util\+\_\+gl\+\_\+shutdown\+\_\+stack}} (void \texorpdfstring{$\ast$}{*}container\+\_\+widget, GError \texorpdfstring{$\ast$}{*}error\+\_\+buffer)
|
||||||
|
\begin{DoxyCompactList}\small\item\em Look for stack entry and shutdowns Open\+GL for it. \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{gl_8c_ab0a523986944f809fac9acc1693f3029}\label{gl_8c_ab0a523986944f809fac9acc1693f3029}
|
||||||
|
void {\bfseries util\+\_\+gl\+\_\+clean\+\_\+stack\+\_\+index} (void)
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\item
|
||||||
|
bool \mbox{\hyperlink{gl_8c_a8132a1a797f4f12eaff04b4c3610f054}{util\+\_\+gl\+\_\+render\+\_\+stack}} (Gtk\+Widget \texorpdfstring{$\ast$}{*}container\+\_\+widget)
|
||||||
|
\begin{DoxyCompactList}\small\item\em Look for stack entry and triggers Open\+GL for drawing. \end{DoxyCompactList}\item
|
||||||
|
bool \mbox{\hyperlink{gl_8c_ad830e66002a24806e3617946dc988e95}{util\+\_\+gl\+\_\+update\+\_\+axis}} (Gtk\+Widget \texorpdfstring{$\ast$}{*}container\+\_\+widget, int axis, int value)
|
||||||
|
\begin{DoxyCompactList}\small\item\em Look for stack entry and triggers Open\+GL for drawing. \end{DoxyCompactList}\item
|
||||||
|
void \mbox{\hyperlink{gl_8c_ae2198c050662c486c8e66c6e6b5a7e0b}{util\+\_\+gl\+\_\+shutdown\+\_\+all\+\_\+stacks}} (void)
|
||||||
|
\begin{DoxyCompactList}\small\item\em Look for every stack entry and shutdowns Open\+GL for it. \end{DoxyCompactList}\item
|
||||||
|
Gtk\+Widget \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{gl_8c_a2cb205bd6556250d019b4de59eee3894}{create\+\_\+axis\+\_\+slider}} (int axis)
|
||||||
|
\begin{DoxyCompactList}\small\item\em Creates a slider widget. \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{gl_8c_ac90dc30613c94fdefedb76cf6d2c4ac8}\label{gl_8c_ac90dc30613c94fdefedb76cf6d2c4ac8}
|
||||||
|
bool {\bfseries util\+\_\+gl\+\_\+setup\+\_\+glarea} (int target\+\_\+mode, Gtk\+Widget \texorpdfstring{$\ast$}{*}target\+\_\+widget)
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
\doxysubsubsection*{Variables}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{gl_8c_a176a1af12ef0fb33a5de5cd36ef7145a}\label{gl_8c_a176a1af12ef0fb33a5de5cd36ef7145a}
|
||||||
|
size\+\_\+t {\bfseries stack\+\_\+index\+\_\+size} = 0
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation used to test the functioning of doxygen \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Function Documentation}
|
||||||
|
\Hypertarget{gl_8c_a2cb205bd6556250d019b4de59eee3894}\label{gl_8c_a2cb205bd6556250d019b4de59eee3894}
|
||||||
|
\index{gl.c@{gl.c}!create\_axis\_slider@{create\_axis\_slider}}
|
||||||
|
\index{create\_axis\_slider@{create\_axis\_slider}!gl.c@{gl.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{create\_axis\_slider()}{create\_axis\_slider()}}
|
||||||
|
{\footnotesize\ttfamily Gtk\+Widget \texorpdfstring{$\ast$}{*} create\+\_\+axis\+\_\+slider (\begin{DoxyParamCaption}\item[{int}]{axis }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Creates a slider widget.
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em axis} & the axis we\textquotesingle{}re building a label for\\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
Gtk\+Widget\texorpdfstring{$\ast$}{*}\+: pointer to the new widget
|
||||||
|
\end{DoxyReturn}
|
||||||
|
\Hypertarget{gl_8c_adbe03a3d239b22390e9de809443c8df9}\label{gl_8c_adbe03a3d239b22390e9de809443c8df9}
|
||||||
|
\index{gl.c@{gl.c}!util\_gl\_get\_stack@{util\_gl\_get\_stack}}
|
||||||
|
\index{util\_gl\_get\_stack@{util\_gl\_get\_stack}!gl.c@{gl.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{util\_gl\_get\_stack()}{util\_gl\_get\_stack()}}
|
||||||
|
{\footnotesize\ttfamily long util\+\_\+gl\+\_\+get\+\_\+stack (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{container\+\_\+widget }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Look for stack entry and returns stack\+\_\+id.
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em container\+\_\+widget} & generally the Gtk\+Box that contains the GLArea\\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
stack\+\_\+id
|
||||||
|
\end{DoxyReturn}
|
||||||
|
\Hypertarget{gl_8c_a28b44187c7ae713705874288323e10a6}\label{gl_8c_a28b44187c7ae713705874288323e10a6}
|
||||||
|
\index{gl.c@{gl.c}!util\_gl\_init\_stack@{util\_gl\_init\_stack}}
|
||||||
|
\index{util\_gl\_init\_stack@{util\_gl\_init\_stack}!gl.c@{gl.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{util\_gl\_init\_stack()}{util\_gl\_init\_stack()}}
|
||||||
|
{\footnotesize\ttfamily bool util\+\_\+gl\+\_\+init\+\_\+stack (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{container\+\_\+widget, }\item[{GError \texorpdfstring{$\ast$}{*}}]{error\+\_\+buffer }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Look for stack entry and initializes Open\+GL for it.
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em container\+\_\+widget} & generally the Gtk\+Box that contains the GLArea \\
|
||||||
|
\hline
|
||||||
|
{\em error\+\_\+buffer} & phantom documentation used to test the functioning of doxygen\\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
bool\+: true if success
|
||||||
|
\end{DoxyReturn}
|
||||||
|
\Hypertarget{gl_8c_a5a691fdca6e3088ea9c1927096541624}\label{gl_8c_a5a691fdca6e3088ea9c1927096541624}
|
||||||
|
\index{gl.c@{gl.c}!util\_gl\_is\_ready@{util\_gl\_is\_ready}}
|
||||||
|
\index{util\_gl\_is\_ready@{util\_gl\_is\_ready}!gl.c@{gl.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{util\_gl\_is\_ready()}{util\_gl\_is\_ready()}}
|
||||||
|
{\footnotesize\ttfamily long util\+\_\+gl\+\_\+is\+\_\+ready (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{container\+\_\+widget }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Look for stack entry and returns stack\+\_\+id.
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em container\+\_\+widget} & generally the Gtk\+Box that contains the GLArea\\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
stack\+\_\+id
|
||||||
|
\end{DoxyReturn}
|
||||||
|
\Hypertarget{gl_8c_a8132a1a797f4f12eaff04b4c3610f054}\label{gl_8c_a8132a1a797f4f12eaff04b4c3610f054}
|
||||||
|
\index{gl.c@{gl.c}!util\_gl\_render\_stack@{util\_gl\_render\_stack}}
|
||||||
|
\index{util\_gl\_render\_stack@{util\_gl\_render\_stack}!gl.c@{gl.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{util\_gl\_render\_stack()}{util\_gl\_render\_stack()}}
|
||||||
|
{\footnotesize\ttfamily bool util\+\_\+gl\+\_\+render\+\_\+stack (\begin{DoxyParamCaption}\item[{Gtk\+Widget \texorpdfstring{$\ast$}{*}}]{container\+\_\+widget }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Look for stack entry and triggers Open\+GL for drawing.
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em container\+\_\+widget} & generally the Gtk\+Box that contains the GLArea\\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
bool\+: true if success
|
||||||
|
\end{DoxyReturn}
|
||||||
|
\Hypertarget{gl_8c_ae2198c050662c486c8e66c6e6b5a7e0b}\label{gl_8c_ae2198c050662c486c8e66c6e6b5a7e0b}
|
||||||
|
\index{gl.c@{gl.c}!util\_gl\_shutdown\_all\_stacks@{util\_gl\_shutdown\_all\_stacks}}
|
||||||
|
\index{util\_gl\_shutdown\_all\_stacks@{util\_gl\_shutdown\_all\_stacks}!gl.c@{gl.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{util\_gl\_shutdown\_all\_stacks()}{util\_gl\_shutdown\_all\_stacks()}}
|
||||||
|
{\footnotesize\ttfamily void util\+\_\+gl\+\_\+shutdown\+\_\+all\+\_\+stacks (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Look for every stack entry and shutdowns Open\+GL for it.
|
||||||
|
|
||||||
|
returns true if success ? TODO why not bool ? \Hypertarget{gl_8c_a9d41985e1832e0a798e722d2341752f1}\label{gl_8c_a9d41985e1832e0a798e722d2341752f1}
|
||||||
|
\index{gl.c@{gl.c}!util\_gl\_shutdown\_stack@{util\_gl\_shutdown\_stack}}
|
||||||
|
\index{util\_gl\_shutdown\_stack@{util\_gl\_shutdown\_stack}!gl.c@{gl.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{util\_gl\_shutdown\_stack()}{util\_gl\_shutdown\_stack()}}
|
||||||
|
{\footnotesize\ttfamily bool util\+\_\+gl\+\_\+shutdown\+\_\+stack (\begin{DoxyParamCaption}\item[{void \texorpdfstring{$\ast$}{*}}]{container\+\_\+widget, }\item[{GError \texorpdfstring{$\ast$}{*}}]{error\+\_\+buffer }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Look for stack entry and shutdowns Open\+GL for it.
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em container\+\_\+widget} & generally the Gtk\+Box that contains the GLArea \\
|
||||||
|
\hline
|
||||||
|
{\em error\+\_\+buffer} & phantom documentation used to test the functioning of doxygen\\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
bool\+: true if success
|
||||||
|
\end{DoxyReturn}
|
||||||
|
\Hypertarget{gl_8c_ad830e66002a24806e3617946dc988e95}\label{gl_8c_ad830e66002a24806e3617946dc988e95}
|
||||||
|
\index{gl.c@{gl.c}!util\_gl\_update\_axis@{util\_gl\_update\_axis}}
|
||||||
|
\index{util\_gl\_update\_axis@{util\_gl\_update\_axis}!gl.c@{gl.c}}
|
||||||
|
\doxysubsubsection{\texorpdfstring{util\_gl\_update\_axis()}{util\_gl\_update\_axis()}}
|
||||||
|
{\footnotesize\ttfamily bool util\+\_\+gl\+\_\+update\+\_\+axis (\begin{DoxyParamCaption}\item[{Gtk\+Widget \texorpdfstring{$\ast$}{*}}]{container\+\_\+widget, }\item[{int}]{axis, }\item[{int}]{value }\end{DoxyParamCaption})}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Look for stack entry and triggers Open\+GL for drawing.
|
||||||
|
|
||||||
|
|
||||||
|
\begin{DoxyParams}{Parameters}
|
||||||
|
{\em container\+\_\+widget} & generally the Gtk\+Box that contains the GLArea \\
|
||||||
|
\hline
|
||||||
|
{\em axis} & phantom documentation used to test the functioning of doxygen \\
|
||||||
|
\hline
|
||||||
|
{\em value} & phantom documentation used to test the functioning of doxygen\\
|
||||||
|
\hline
|
||||||
|
\end{DoxyParams}
|
||||||
|
\begin{DoxyReturn}{Returns}
|
||||||
|
bool\+: true if success
|
||||||
|
\end{DoxyReturn}
|
||||||
|
|
@ -0,0 +1,101 @@
|
||||||
|
\doxysection{graphics\+\_\+stack\+\_\+t Struct Reference}
|
||||||
|
\hypertarget{structgraphics__stack__t}{}\label{structgraphics__stack__t}\index{graphics\_stack\_t@{graphics\_stack\_t}}
|
||||||
|
|
||||||
|
|
||||||
|
Structure describing a gl\+\_\+area and its parameters, used to create a table of Gem-\/graph client current gl\+\_\+areas.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$graphics.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_af8578b691d14c1c0aefe7aab307d35d3}\label{structgraphics__stack__t_af8578b691d14c1c0aefe7aab307d35d3}
|
||||||
|
int {\bfseries id}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a6d15e9f6e455a5f6e07efd504092eabd}\label{structgraphics__stack__t_a6d15e9f6e455a5f6e07efd504092eabd}
|
||||||
|
int {\bfseries mode}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a24345e6e56468c81dbdc8c1b912d2da1}\label{structgraphics__stack__t_a24345e6e56468c81dbdc8c1b912d2da1}
|
||||||
|
float {\bfseries rotation\+\_\+angles} \mbox{[}N\+\_\+\+AXIS\mbox{]}
|
||||||
|
\begin{DoxyCompactList}\small\item\em Rotation angles on each axis. \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_af4b3f1ab3368005446f2e01152e4cbc2}\label{structgraphics__stack__t_af4b3f1ab3368005446f2e01152e4cbc2}
|
||||||
|
GLuint {\bfseries vao}
|
||||||
|
\begin{DoxyCompactList}\small\item\em init\+\_\+buffers ~\newline
|
||||||
|
\end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a8c4a73e3e7c47ebbe286ccd221b36345}\label{structgraphics__stack__t_a8c4a73e3e7c47ebbe286ccd221b36345}
|
||||||
|
GLuint {\bfseries position\+\_\+buffer}
|
||||||
|
\begin{DoxyCompactList}\small\item\em shutdown, draw ~\newline
|
||||||
|
\end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a91445f750de8bba35c7899a641517cde}\label{structgraphics__stack__t_a91445f750de8bba35c7899a641517cde}
|
||||||
|
GLuint {\bfseries color\+\_\+buffer}
|
||||||
|
\begin{DoxyCompactList}\small\item\em shutdown, draw ~\newline
|
||||||
|
\end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a45249c5bebc08c3e4633b510e60ef519}\label{structgraphics__stack__t_a45249c5bebc08c3e4633b510e60ef519}
|
||||||
|
GLuint {\bfseries program}
|
||||||
|
\begin{DoxyCompactList}\small\item\em shutdown, init\+\_\+shaders, draw ~\newline
|
||||||
|
\end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a450d45ed7b90d6755cc4d322b26886b5}\label{structgraphics__stack__t_a450d45ed7b90d6755cc4d322b26886b5}
|
||||||
|
GLuint {\bfseries m}
|
||||||
|
\begin{DoxyCompactList}\small\item\em init\+\_\+shaders, draw ~\newline
|
||||||
|
\end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a77cd82200c32fdb7a98b2d873bc47101}\label{structgraphics__stack__t_a77cd82200c32fdb7a98b2d873bc47101}
|
||||||
|
GLuint {\bfseries v}
|
||||||
|
\begin{DoxyCompactList}\small\item\em init\+\_\+shaders, draw ~\newline
|
||||||
|
\end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a2618a771cf69d50f41f73a9e73a954be}\label{structgraphics__stack__t_a2618a771cf69d50f41f73a9e73a954be}
|
||||||
|
GLuint {\bfseries p}
|
||||||
|
\begin{DoxyCompactList}\small\item\em init\+\_\+shaders, draw ~\newline
|
||||||
|
\end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a719da937a28bfc859981aa3d5fabfdad}\label{structgraphics__stack__t_a719da937a28bfc859981aa3d5fabfdad}
|
||||||
|
struct \mbox{\hyperlink{structarrow__t}{arrow\+\_\+t}} \texorpdfstring{$\ast$}{*} {\bfseries arrows\+\_\+ptr}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_ac83224b08bcc3748aa67b801003a941d}\label{structgraphics__stack__t_ac83224b08bcc3748aa67b801003a941d}
|
||||||
|
long {\bfseries arrows\+\_\+nb}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a4fc7ff5da6655dc84f75e41aeea34114}\label{structgraphics__stack__t_a4fc7ff5da6655dc84f75e41aeea34114}
|
||||||
|
GLfloat \texorpdfstring{$\ast$}{*} {\bfseries buffer\+\_\+vertex\+\_\+origin}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_abe0d5ff731ecb1c38580c9458d51da3c}\label{structgraphics__stack__t_abe0d5ff731ecb1c38580c9458d51da3c}
|
||||||
|
GLfloat \texorpdfstring{$\ast$}{*} {\bfseries buffer\+\_\+colors\+\_\+origin}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_aa968f1b4399daec725f5add393f7c8ce}\label{structgraphics__stack__t_aa968f1b4399daec725f5add393f7c8ce}
|
||||||
|
GLuint \texorpdfstring{$\ast$}{*} {\bfseries buffer\+\_\+lines\+\_\+origin}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_abb3a4f67b598704db32b6c04e264a3bf}\label{structgraphics__stack__t_abb3a4f67b598704db32b6c04e264a3bf}
|
||||||
|
GLuint \texorpdfstring{$\ast$}{*} {\bfseries buffer\+\_\+plans\+\_\+origin}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a2901c44699708610ff2854335f6e66d0}\label{structgraphics__stack__t_a2901c44699708610ff2854335f6e66d0}
|
||||||
|
long {\bfseries buffer\+\_\+vertex\+\_\+size}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a9fc79ebf7f482d032476f8a89eaf857f}\label{structgraphics__stack__t_a9fc79ebf7f482d032476f8a89eaf857f}
|
||||||
|
long {\bfseries buffer\+\_\+colors\+\_\+size}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_ad8fab767b2f3e1f0455e99715ee7e091}\label{structgraphics__stack__t_ad8fab767b2f3e1f0455e99715ee7e091}
|
||||||
|
long {\bfseries buffer\+\_\+lines\+\_\+size}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a4c67dd123492ff9030a45708ee5d20df}\label{structgraphics__stack__t_a4c67dd123492ff9030a45708ee5d20df}
|
||||||
|
long {\bfseries buffer\+\_\+plans\+\_\+size}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_af3f70fda4f00a22b6f31e9426fd74efc}\label{structgraphics__stack__t_af3f70fda4f00a22b6f31e9426fd74efc}
|
||||||
|
long {\bfseries buffer\+\_\+vertex\+\_\+0\+\_\+arrow}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a06c2ac4d28a8b125dd744d9970570f8e}\label{structgraphics__stack__t_a06c2ac4d28a8b125dd744d9970570f8e}
|
||||||
|
long {\bfseries buffer\+\_\+colors\+\_\+0\+\_\+arrow}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_ad4d641051e231ba5c5f00b7eb427057e}\label{structgraphics__stack__t_ad4d641051e231ba5c5f00b7eb427057e}
|
||||||
|
long {\bfseries buffer\+\_\+lines\+\_\+0\+\_\+arrow}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structgraphics__stack__t_a6d3507a54ebc6304f3e4bf24b7428c05}\label{structgraphics__stack__t_a6d3507a54ebc6304f3e4bf24b7428c05}
|
||||||
|
long {\bfseries buffer\+\_\+plans\+\_\+0\+\_\+arrow}
|
||||||
|
\begin{DoxyCompactList}\small\item\em phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
Structure describing a gl\+\_\+area and its parameters, used to create a table of Gem-\/graph client current gl\+\_\+areas.
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/graphics.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
\doxysection{slist Struct Reference}
|
||||||
|
\hypertarget{structslist}{}\label{structslist}\index{slist@{slist}}
|
||||||
|
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{\ttfamily \#include $<$util.\+h$>$}
|
||||||
|
|
||||||
|
\doxysubsubsection*{Public Attributes}
|
||||||
|
\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
\Hypertarget{structslist_a6c4e65b559a5537f7854b0d828204436}\label{structslist_a6c4e65b559a5537f7854b0d828204436}
|
||||||
|
int {\bfseries value}
|
||||||
|
\begin{DoxyCompactList}\small\item\em value phantom documentation \end{DoxyCompactList}\item
|
||||||
|
\Hypertarget{structslist_a1dbb9625c8b52c7a6ae2d2e83b37fd43}\label{structslist_a1dbb9625c8b52c7a6ae2d2e83b37fd43}
|
||||||
|
struct \mbox{\hyperlink{structslist}{slist}} \texorpdfstring{$\ast$}{*} {\bfseries suiv}
|
||||||
|
\begin{DoxyCompactList}\small\item\em \texorpdfstring{$\ast$}{*}suiv phantom documentation \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||||
|
|
||||||
|
|
||||||
|
\doxysubsection{Detailed Description}
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
|
||||||
|
\item
|
||||||
|
include/util.\+h\end{DoxyCompactItemize}
|
||||||
|
|
@ -0,0 +1,694 @@
|
||||||
|
\NeedsTeXFormat{LaTeX2e}
|
||||||
|
\ProvidesPackage{doxygen}
|
||||||
|
|
||||||
|
% Packages used by this style file
|
||||||
|
\RequirePackage{alltt}
|
||||||
|
%%\RequirePackage{array} %% moved to refman.tex due to workaround for LaTex 2019 version and unmaintained tabu package
|
||||||
|
\RequirePackage{calc}
|
||||||
|
\RequirePackage{float}
|
||||||
|
%%\RequirePackage{ifthen} %% moved to refman.tex due to workaround for LaTex 2019 version and unmaintained tabu package
|
||||||
|
\RequirePackage{verbatim}
|
||||||
|
\RequirePackage[table]{xcolor}
|
||||||
|
\RequirePackage{longtable_doxygen}
|
||||||
|
\RequirePackage{tabu_doxygen}
|
||||||
|
\RequirePackage{fancyvrb}
|
||||||
|
\RequirePackage{tabularx}
|
||||||
|
\RequirePackage{multicol}
|
||||||
|
\RequirePackage{multirow}
|
||||||
|
\RequirePackage{hanging}
|
||||||
|
\RequirePackage{ifpdf}
|
||||||
|
\RequirePackage{adjustbox}
|
||||||
|
\RequirePackage{amssymb}
|
||||||
|
\RequirePackage{stackengine}
|
||||||
|
\RequirePackage{enumitem}
|
||||||
|
\RequirePackage{alphalph}
|
||||||
|
\RequirePackage[normalem]{ulem} % for strikeout, but don't modify emphasis
|
||||||
|
|
||||||
|
%---------- Internal commands used in this style file ----------------
|
||||||
|
|
||||||
|
\newcommand{\ensurespace}[1]{%
|
||||||
|
\begingroup%
|
||||||
|
\setlength{\dimen@}{#1}%
|
||||||
|
\vskip\z@\@plus\dimen@%
|
||||||
|
\penalty -100\vskip\z@\@plus -\dimen@%
|
||||||
|
\vskip\dimen@%
|
||||||
|
\penalty 9999%
|
||||||
|
\vskip -\dimen@%
|
||||||
|
\vskip\z@skip% hide the previous |\vskip| from |\addvspace|
|
||||||
|
\endgroup%
|
||||||
|
}
|
||||||
|
|
||||||
|
\newcommand{\DoxyHorRuler}[1]{%
|
||||||
|
\setlength{\parskip}{0ex plus 0ex minus 0ex}%
|
||||||
|
\ifthenelse{#1=0}%
|
||||||
|
{%
|
||||||
|
\hrule%
|
||||||
|
}%
|
||||||
|
{%
|
||||||
|
\hrulefilll%
|
||||||
|
}%
|
||||||
|
}
|
||||||
|
\newcommand{\DoxyLabelFont}{}
|
||||||
|
\newcommand{\entrylabel}[1]{%
|
||||||
|
{%
|
||||||
|
\parbox[b]{\labelwidth-4pt}{%
|
||||||
|
\makebox[0pt][l]{\DoxyLabelFont#1}%
|
||||||
|
\vspace{1.5\baselineskip}%
|
||||||
|
}%
|
||||||
|
}%
|
||||||
|
}
|
||||||
|
|
||||||
|
\newenvironment{DoxyDesc}[1]{%
|
||||||
|
\ensurespace{4\baselineskip}%
|
||||||
|
\begin{list}{}{%
|
||||||
|
\settowidth{\labelwidth}{20pt}%
|
||||||
|
%\setlength{\parsep}{0pt}%
|
||||||
|
\setlength{\itemsep}{0pt}%
|
||||||
|
\setlength{\leftmargin}{\labelwidth+\labelsep}%
|
||||||
|
\renewcommand{\makelabel}{\entrylabel}%
|
||||||
|
}%
|
||||||
|
\item[#1]%
|
||||||
|
}{%
|
||||||
|
\end{list}%
|
||||||
|
}
|
||||||
|
|
||||||
|
\newsavebox{\xrefbox}
|
||||||
|
\newlength{\xreflength}
|
||||||
|
\newcommand{\xreflabel}[1]{%
|
||||||
|
\sbox{\xrefbox}{#1}%
|
||||||
|
\setlength{\xreflength}{\wd\xrefbox}%
|
||||||
|
\ifthenelse{\xreflength>\labelwidth}{%
|
||||||
|
\begin{minipage}{\textwidth}%
|
||||||
|
\setlength{\parindent}{0pt}%
|
||||||
|
\hangindent=15pt\bfseries #1\vspace{1.2\itemsep}%
|
||||||
|
\end{minipage}%
|
||||||
|
}{%
|
||||||
|
\parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}%
|
||||||
|
}%
|
||||||
|
}
|
||||||
|
|
||||||
|
%---------- Commands used by doxygen LaTeX output generator ----------
|
||||||
|
|
||||||
|
% Used by <pre> ... </pre>
|
||||||
|
\newenvironment{DoxyPre}{%
|
||||||
|
\small%
|
||||||
|
\begin{alltt}%
|
||||||
|
}{%
|
||||||
|
\end{alltt}%
|
||||||
|
\normalsize%
|
||||||
|
}
|
||||||
|
% Necessary for redefining not defined characters, i.e. "Replacement Character" in tex output.
|
||||||
|
\newlength{\CodeWidthChar}
|
||||||
|
\newlength{\CodeHeightChar}
|
||||||
|
\settowidth{\CodeWidthChar}{?}
|
||||||
|
\settoheight{\CodeHeightChar}{?}
|
||||||
|
% Necessary for hanging indent
|
||||||
|
\newlength{\DoxyCodeWidth}
|
||||||
|
|
||||||
|
\newcommand\DoxyCodeLine[1]{
|
||||||
|
\ifthenelse{\equal{\detokenize{#1}}{}}
|
||||||
|
{
|
||||||
|
\vspace*{\baselineskip}
|
||||||
|
}
|
||||||
|
{
|
||||||
|
\hangpara{\DoxyCodeWidth}{1}{#1}\par
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
\newcommand\NiceSpace{%
|
||||||
|
\discretionary{}{\kern\fontdimen2\font}{\kern\fontdimen2\font}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @code ... @endcode
|
||||||
|
\newenvironment{DoxyCode}[1]{%
|
||||||
|
\par%
|
||||||
|
\scriptsize%
|
||||||
|
\normalfont\ttfamily%
|
||||||
|
\rightskip0pt plus 1fil%
|
||||||
|
\settowidth{\DoxyCodeWidth}{000000}%
|
||||||
|
\settowidth{\CodeWidthChar}{?}%
|
||||||
|
\settoheight{\CodeHeightChar}{?}%
|
||||||
|
\setlength{\parskip}{0ex plus 0ex minus 0ex}%
|
||||||
|
\ifthenelse{\equal{#1}{0}}
|
||||||
|
{
|
||||||
|
{\lccode`~32 \lowercase{\global\let~}\NiceSpace}\obeyspaces%
|
||||||
|
}
|
||||||
|
{
|
||||||
|
{\lccode`~32 \lowercase{\global\let~}}\obeyspaces%
|
||||||
|
}
|
||||||
|
|
||||||
|
}{%
|
||||||
|
\normalfont%
|
||||||
|
\normalsize%
|
||||||
|
\settowidth{\CodeWidthChar}{?}%
|
||||||
|
\settoheight{\CodeHeightChar}{?}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Redefining not defined characters, i.e. "Replacement Character" in tex output.
|
||||||
|
\def\ucr{\adjustbox{width=\CodeWidthChar,height=\CodeHeightChar}{\stackinset{c}{}{c}{-.2pt}{%
|
||||||
|
\textcolor{white}{\sffamily\bfseries\small ?}}{%
|
||||||
|
\rotatebox{45}{$\blacksquare$}}}}
|
||||||
|
|
||||||
|
% Used by @example, @include, @includelineno and @dontinclude
|
||||||
|
\newenvironment{DoxyCodeInclude}[1]{%
|
||||||
|
\DoxyCode{#1}%
|
||||||
|
}{%
|
||||||
|
\endDoxyCode%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @verbatim ... @endverbatim
|
||||||
|
\newenvironment{DoxyVerb}{%
|
||||||
|
\par%
|
||||||
|
\footnotesize%
|
||||||
|
\verbatim%
|
||||||
|
}{%
|
||||||
|
\endverbatim%
|
||||||
|
\normalsize%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @verbinclude
|
||||||
|
\newenvironment{DoxyVerbInclude}{%
|
||||||
|
\DoxyVerb%
|
||||||
|
}{%
|
||||||
|
\endDoxyVerb%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by numbered lists (using '-#' or <ol> ... </ol>)
|
||||||
|
\setlistdepth{12}
|
||||||
|
\newlist{DoxyEnumerate}{enumerate}{12}
|
||||||
|
\setlist[DoxyEnumerate,1]{label=\arabic*.}
|
||||||
|
\setlist[DoxyEnumerate,2]{label=(\enumalphalphcnt*)}
|
||||||
|
\setlist[DoxyEnumerate,3]{label=\roman*.}
|
||||||
|
\setlist[DoxyEnumerate,4]{label=\enumAlphAlphcnt*.}
|
||||||
|
\setlist[DoxyEnumerate,5]{label=\arabic*.}
|
||||||
|
\setlist[DoxyEnumerate,6]{label=(\enumalphalphcnt*)}
|
||||||
|
\setlist[DoxyEnumerate,7]{label=\roman*.}
|
||||||
|
\setlist[DoxyEnumerate,8]{label=\enumAlphAlphcnt*.}
|
||||||
|
\setlist[DoxyEnumerate,9]{label=\arabic*.}
|
||||||
|
\setlist[DoxyEnumerate,10]{label=(\enumalphalphcnt*)}
|
||||||
|
\setlist[DoxyEnumerate,11]{label=\roman*.}
|
||||||
|
\setlist[DoxyEnumerate,12]{label=\enumAlphAlphcnt*.}
|
||||||
|
|
||||||
|
% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
|
||||||
|
\setlistdepth{12}
|
||||||
|
\newlist{DoxyItemize}{itemize}{12}
|
||||||
|
\setlist[DoxyItemize]{label=\textperiodcentered}
|
||||||
|
|
||||||
|
\setlist[DoxyItemize,1]{label=\textbullet}
|
||||||
|
\setlist[DoxyItemize,2]{label=\normalfont\bfseries \textendash}
|
||||||
|
\setlist[DoxyItemize,3]{label=\textasteriskcentered}
|
||||||
|
\setlist[DoxyItemize,4]{label=\textperiodcentered}
|
||||||
|
|
||||||
|
% Used by description lists (using <dl> ... </dl>)
|
||||||
|
\newenvironment{DoxyDescription}{%
|
||||||
|
\description%
|
||||||
|
}{%
|
||||||
|
\enddescription%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
|
||||||
|
% (only if caption is specified)
|
||||||
|
\newenvironment{DoxyImage}{%
|
||||||
|
\begin{figure}[H]%
|
||||||
|
\centering%
|
||||||
|
}{%
|
||||||
|
\end{figure}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
|
||||||
|
% (only if no caption is specified)
|
||||||
|
\newenvironment{DoxyImageNoCaption}{%
|
||||||
|
\begin{center}%
|
||||||
|
}{%
|
||||||
|
\end{center}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @image
|
||||||
|
% (only if inline is specified)
|
||||||
|
\newenvironment{DoxyInlineImage}{%
|
||||||
|
}{%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @attention
|
||||||
|
\newenvironment{DoxyAttention}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @author and @authors
|
||||||
|
\newenvironment{DoxyAuthor}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @date
|
||||||
|
\newenvironment{DoxyDate}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @invariant
|
||||||
|
\newenvironment{DoxyInvariant}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @note
|
||||||
|
\newenvironment{DoxyNote}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @post
|
||||||
|
\newenvironment{DoxyPostcond}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @pre
|
||||||
|
\newenvironment{DoxyPrecond}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @copyright
|
||||||
|
\newenvironment{DoxyCopyright}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @remark
|
||||||
|
\newenvironment{DoxyRemark}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @return and @returns
|
||||||
|
\newenvironment{DoxyReturn}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @since
|
||||||
|
\newenvironment{DoxySince}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @see
|
||||||
|
\newenvironment{DoxySeeAlso}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @version
|
||||||
|
\newenvironment{DoxyVersion}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @warning
|
||||||
|
\newenvironment{DoxyWarning}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @par and @paragraph
|
||||||
|
\newenvironment{DoxyParagraph}[1]{%
|
||||||
|
\begin{DoxyDesc}{#1}%
|
||||||
|
}{%
|
||||||
|
\end{DoxyDesc}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by parameter lists
|
||||||
|
\newenvironment{DoxyParams}[2][]{%
|
||||||
|
\tabulinesep=1mm%
|
||||||
|
\par%
|
||||||
|
\ifthenelse{\equal{#1}{}}%
|
||||||
|
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|}}% name + description
|
||||||
|
{\ifthenelse{\equal{#1}{1}}%
|
||||||
|
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + name + desc
|
||||||
|
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + type + name + desc
|
||||||
|
}
|
||||||
|
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endfirsthead%
|
||||||
|
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endhead%
|
||||||
|
}{%
|
||||||
|
\end{longtabu*}%
|
||||||
|
\vspace{6pt}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used for fields of simple structs
|
||||||
|
\newenvironment{DoxyFields}[1]{%
|
||||||
|
\tabulinesep=1mm%
|
||||||
|
\par%
|
||||||
|
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|X[-1,l]|}%
|
||||||
|
\multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endfirsthead%
|
||||||
|
\multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endhead%
|
||||||
|
}{%
|
||||||
|
\end{longtabu*}%
|
||||||
|
\vspace{6pt}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used for fields simple class style enums
|
||||||
|
\newenvironment{DoxyEnumFields}[1]{%
|
||||||
|
\tabulinesep=1mm%
|
||||||
|
\par%
|
||||||
|
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||||
|
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endfirsthead%
|
||||||
|
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endhead%
|
||||||
|
}{%
|
||||||
|
\end{longtabu*}%
|
||||||
|
\vspace{6pt}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used for parameters within a detailed function description
|
||||||
|
\newenvironment{DoxyParamCaption}{%
|
||||||
|
\renewcommand{\item}[2][]{\\ \hspace*{2.0cm} ##1 {\em ##2}}%
|
||||||
|
}{%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by return value lists
|
||||||
|
\newenvironment{DoxyRetVals}[1]{%
|
||||||
|
\tabulinesep=1mm%
|
||||||
|
\par%
|
||||||
|
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||||
|
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endfirsthead%
|
||||||
|
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endhead%
|
||||||
|
}{%
|
||||||
|
\end{longtabu*}%
|
||||||
|
\vspace{6pt}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by exception lists
|
||||||
|
\newenvironment{DoxyExceptions}[1]{%
|
||||||
|
\tabulinesep=1mm%
|
||||||
|
\par%
|
||||||
|
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||||
|
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endfirsthead%
|
||||||
|
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endhead%
|
||||||
|
}{%
|
||||||
|
\end{longtabu*}%
|
||||||
|
\vspace{6pt}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by template parameter lists
|
||||||
|
\newenvironment{DoxyTemplParams}[1]{%
|
||||||
|
\tabulinesep=1mm%
|
||||||
|
\par%
|
||||||
|
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||||
|
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endfirsthead%
|
||||||
|
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||||
|
\hline%
|
||||||
|
\endhead%
|
||||||
|
}{%
|
||||||
|
\end{longtabu*}%
|
||||||
|
\vspace{6pt}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used for member lists
|
||||||
|
\newenvironment{DoxyCompactItemize}{%
|
||||||
|
\begin{itemize}%
|
||||||
|
\setlength{\itemsep}{-3pt}%
|
||||||
|
\setlength{\parsep}{0pt}%
|
||||||
|
\setlength{\topsep}{0pt}%
|
||||||
|
\setlength{\partopsep}{0pt}%
|
||||||
|
}{%
|
||||||
|
\end{itemize}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used for member descriptions
|
||||||
|
\newenvironment{DoxyCompactList}{%
|
||||||
|
\begin{list}{}{%
|
||||||
|
\setlength{\leftmargin}{0.5cm}%
|
||||||
|
\setlength{\itemsep}{0pt}%
|
||||||
|
\setlength{\parsep}{0pt}%
|
||||||
|
\setlength{\topsep}{0pt}%
|
||||||
|
\renewcommand{\makelabel}{\hfill}%
|
||||||
|
}%
|
||||||
|
}{%
|
||||||
|
\end{list}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used for reference lists (@bug, @deprecated, @todo, etc.)
|
||||||
|
\newenvironment{DoxyRefList}{%
|
||||||
|
\begin{list}{}{%
|
||||||
|
\setlength{\labelwidth}{10pt}%
|
||||||
|
\setlength{\leftmargin}{\labelwidth}%
|
||||||
|
\addtolength{\leftmargin}{\labelsep}%
|
||||||
|
\renewcommand{\makelabel}{\xreflabel}%
|
||||||
|
}%
|
||||||
|
}{%
|
||||||
|
\end{list}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @bug, @deprecated, @todo, etc.
|
||||||
|
\newenvironment{DoxyRefDesc}[1]{%
|
||||||
|
\begin{list}{}{%
|
||||||
|
\renewcommand\makelabel[1]{\textbf{##1}}%
|
||||||
|
\settowidth\labelwidth{\makelabel{#1}}%
|
||||||
|
\setlength\leftmargin{\labelwidth+\labelsep}%
|
||||||
|
}%
|
||||||
|
}{%
|
||||||
|
\end{list}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by parameter lists and simple sections
|
||||||
|
\newenvironment{Desc}
|
||||||
|
{\begin{list}{}{%
|
||||||
|
\settowidth{\labelwidth}{20pt}%
|
||||||
|
\setlength{\parsep}{0pt}%
|
||||||
|
\setlength{\itemsep}{0pt}%
|
||||||
|
\setlength{\leftmargin}{\labelwidth+\labelsep}%
|
||||||
|
\renewcommand{\makelabel}{\entrylabel}%
|
||||||
|
}
|
||||||
|
}{%
|
||||||
|
\end{list}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by tables
|
||||||
|
\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}%
|
||||||
|
\newenvironment{TabularC}[1]%
|
||||||
|
{\tabulinesep=1mm
|
||||||
|
\begin{longtabu*}spread 0pt [c]{*#1{|X[-1]}|}}%
|
||||||
|
{\end{longtabu*}\par}%
|
||||||
|
|
||||||
|
\newenvironment{TabularNC}[1]%
|
||||||
|
{\begin{tabu}spread 0pt [l]{*#1{|X[-1]}|}}%
|
||||||
|
{\end{tabu}\par}%
|
||||||
|
|
||||||
|
% Used for member group headers
|
||||||
|
\newenvironment{Indent}{%
|
||||||
|
\begin{list}{}{%
|
||||||
|
\setlength{\leftmargin}{0.5cm}%
|
||||||
|
}%
|
||||||
|
\item[]\ignorespaces%
|
||||||
|
}{%
|
||||||
|
\unskip%
|
||||||
|
\end{list}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used when hyperlinks are turned on
|
||||||
|
\newcommand{\doxylink}[2]{%
|
||||||
|
\mbox{\hyperlink{#1}{#2}}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used when hyperlinks are turned on
|
||||||
|
% Third argument is the SectionType, see the doxygen internal
|
||||||
|
% documentation for the values (relevant: Page ... Subsubsection).
|
||||||
|
\newcommand{\doxysectlink}[3]{%
|
||||||
|
\mbox{\hyperlink{#1}{#2}}%
|
||||||
|
}
|
||||||
|
% Used when hyperlinks are turned off
|
||||||
|
\newcommand{\doxyref}[3]{%
|
||||||
|
\textbf{#1} (\textnormal{#2}\,\pageref{#3})%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used when hyperlinks are turned off
|
||||||
|
% Fourth argument is the SectionType, see the doxygen internal
|
||||||
|
% documentation for the values (relevant: Page ... Subsubsection).
|
||||||
|
\newcommand{\doxysectref}[4]{%
|
||||||
|
\textbf{#1} (\textnormal{#2}\,\pageref{#3})%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used to link to a table when hyperlinks are turned on
|
||||||
|
\newcommand{\doxytablelink}[2]{%
|
||||||
|
\ref{#1}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used to link to a table when hyperlinks are turned off
|
||||||
|
\newcommand{\doxytableref}[3]{%
|
||||||
|
\ref{#3}%
|
||||||
|
}
|
||||||
|
|
||||||
|
% Used by @addindex
|
||||||
|
\newcommand{\lcurly}{\{}
|
||||||
|
\newcommand{\rcurly}{\}}
|
||||||
|
|
||||||
|
% Colors used for syntax highlighting
|
||||||
|
\definecolor{comment}{rgb}{0.5,0.0,0.0}
|
||||||
|
\definecolor{keyword}{rgb}{0.0,0.5,0.0}
|
||||||
|
\definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
|
||||||
|
\definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
|
||||||
|
\definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
|
||||||
|
\definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
|
||||||
|
\definecolor{charliteral}{rgb}{0.0,0.5,0.5}
|
||||||
|
\definecolor{xmlcdata}{rgb}{0.0,0.0,0.0}
|
||||||
|
\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
|
||||||
|
\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
|
||||||
|
\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
|
||||||
|
\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}
|
||||||
|
|
||||||
|
% Color used for table heading
|
||||||
|
\newcommand{\tableheadbgcolor}{lightgray}%
|
||||||
|
|
||||||
|
% Version of hypertarget with correct landing location
|
||||||
|
\newcommand{\Hypertarget}[1]{\Hy@raisedlink{\hypertarget{#1}{}}}
|
||||||
|
|
||||||
|
% possibility to have sections etc. be within the margins
|
||||||
|
% unfortunately had to copy part of book.cls and add \raggedright
|
||||||
|
\makeatletter
|
||||||
|
\newcounter{subsubsubsection}[subsubsection]
|
||||||
|
\newcounter{subsubsubsubsection}[subsubsubsection]
|
||||||
|
\newcounter{subsubsubsubsubsection}[subsubsubsubsection]
|
||||||
|
\newcounter{subsubsubsubsubsubsection}[subsubsubsubsubsection]
|
||||||
|
\renewcommand{\thesubsubsubsection}{\thesubsubsection.\arabic{subsubsubsection}}
|
||||||
|
\renewcommand{\thesubsubsubsubsection}{\thesubsubsubsection.\arabic{subsubsubsubsection}}
|
||||||
|
\renewcommand{\thesubsubsubsubsubsection}{\thesubsubsubsubsection.\arabic{subsubsubsubsubsection}}
|
||||||
|
\renewcommand{\thesubsubsubsubsubsubsection}{\thesubsubsubsubsubsection.\arabic{subsubsubsubsubsubsection}}
|
||||||
|
\newcommand{\subsubsubsectionmark}[1]{}
|
||||||
|
\newcommand{\subsubsubsubsectionmark}[1]{}
|
||||||
|
\newcommand{\subsubsubsubsubsectionmark}[1]{}
|
||||||
|
\newcommand{\subsubsubsubsubsubsectionmark}[1]{}
|
||||||
|
\def\toclevel@subsubsubsection{4}
|
||||||
|
\def\toclevel@subsubsubsubsection{5}
|
||||||
|
\def\toclevel@subsubsubsubsubsection{6}
|
||||||
|
\def\toclevel@subsubsubsubsubsubsection{7}
|
||||||
|
\def\toclevel@paragraph{8}
|
||||||
|
\def\toclevel@subparagraph{9}
|
||||||
|
|
||||||
|
\newcommand\doxysection{\@startsection {section}{1}{\z@}%
|
||||||
|
{-3.5ex \@plus -1ex \@minus -.2ex}%
|
||||||
|
{2.3ex \@plus.2ex}%
|
||||||
|
{\raggedright\normalfont\Large\bfseries}}
|
||||||
|
\newcommand\doxysubsection{\@startsection{subsection}{2}{\z@}%
|
||||||
|
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||||
|
{1.5ex \@plus .2ex}%
|
||||||
|
{\raggedright\normalfont\large\bfseries}}
|
||||||
|
\newcommand\doxysubsubsection{\@startsection{subsubsection}{3}{\z@}%
|
||||||
|
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||||
|
{1.5ex \@plus .2ex}%
|
||||||
|
{\raggedright\normalfont\normalsize\bfseries}}
|
||||||
|
\newcommand\doxysubsubsubsection{\@startsection{subsubsubsection}{4}{\z@}%
|
||||||
|
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||||
|
{1.5ex \@plus .2ex}%
|
||||||
|
{\raggedright\normalfont\normalsize\bfseries}}
|
||||||
|
\newcommand\doxysubsubsubsubsection{\@startsection{subsubsubsubsection}{5}{\z@}%
|
||||||
|
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||||
|
{1.5ex \@plus .2ex}%
|
||||||
|
{\raggedright\normalfont\normalsize\bfseries}}
|
||||||
|
\newcommand\doxysubsubsubsubsubsection{\@startsection{subsubsubsubsubsection}{6}{\z@}%
|
||||||
|
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||||
|
{1.5ex \@plus .2ex}%
|
||||||
|
{\raggedright\normalfont\normalsize\bfseries}}
|
||||||
|
\newcommand\doxysubsubsubsubsubsubsection{\@startsection{subsubsubsubsubsubsection}{7}{\z@}%
|
||||||
|
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||||
|
{1.5ex \@plus .2ex}%
|
||||||
|
{\raggedright\normalfont\normalsize\bfseries}}
|
||||||
|
\newcommand\doxyparagraph{\@startsection{paragraph}{8}{\z@}%
|
||||||
|
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||||
|
{1.5ex \@plus .2ex}%
|
||||||
|
{\raggedright\normalfont\normalsize\bfseries}}
|
||||||
|
\newcommand\doxysubparagraph{\@startsection{subparagraph}{9}{\parindent}%
|
||||||
|
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||||
|
{1.5ex \@plus .2ex}%
|
||||||
|
{\raggedright\normalfont\normalsize\bfseries}}
|
||||||
|
|
||||||
|
\newcommand\l@subsubsubsection{\@dottedtocline{4}{6.1em}{7.8em}}
|
||||||
|
\newcommand\l@subsubsubsubsection{\@dottedtocline{5}{6.1em}{9.4em}}
|
||||||
|
\newcommand\l@subsubsubsubsubsection{\@dottedtocline{6}{6.1em}{11em}}
|
||||||
|
\newcommand\l@subsubsubsubsubsubsection{\@dottedtocline{7}{6.1em}{12.6em}}
|
||||||
|
\renewcommand\l@paragraph{\@dottedtocline{8}{6.1em}{14.2em}}
|
||||||
|
\renewcommand\l@subparagraph{\@dottedtocline{9}{6.1em}{15.8em}}
|
||||||
|
\makeatother
|
||||||
|
% the sectsty doesn't look to be maintained but gives, in our case, some warning like:
|
||||||
|
% LaTeX Warning: Command \underline has changed.
|
||||||
|
% Check if current package is valid.
|
||||||
|
% unfortunately had to copy the relevant part
|
||||||
|
\newcommand*{\doxypartfont} [1]
|
||||||
|
{\gdef\SS@partnumberfont{\SS@sectid{0}\SS@nopart\SS@makeulinepartchap#1}
|
||||||
|
\gdef\SS@parttitlefont{\SS@sectid{0}\SS@titlepart\SS@makeulinepartchap#1}}
|
||||||
|
\newcommand*{\doxychapterfont} [1]
|
||||||
|
{\gdef\SS@chapnumfont{\SS@sectid{1}\SS@nopart\SS@makeulinepartchap#1}
|
||||||
|
\gdef\SS@chaptitlefont{\SS@sectid{1}\SS@titlepart\SS@makeulinepartchap#1}}
|
||||||
|
\newcommand*{\doxysectionfont} [1]
|
||||||
|
{\gdef\SS@sectfont{\SS@sectid{2}\SS@rr\SS@makeulinesect#1}}
|
||||||
|
\newcommand*{\doxysubsectionfont} [1]
|
||||||
|
{\gdef\SS@subsectfont{\SS@sectid{3}\SS@rr\SS@makeulinesect#1}}
|
||||||
|
\newcommand*{\doxysubsubsectionfont} [1]
|
||||||
|
{\gdef\SS@subsubsectfont{\SS@sectid{4}\SS@rr\SS@makeulinesect#1}}
|
||||||
|
\newcommand*{\doxyparagraphfont} [1]
|
||||||
|
{\gdef\SS@parafont{\SS@sectid{5}\SS@rr\SS@makeulinesect#1}}
|
||||||
|
\newcommand*{\doxysubparagraphfont} [1]
|
||||||
|
{\gdef\SS@subparafont{\SS@sectid{6}\SS@rr\SS@makeulinesect#1}}
|
||||||
|
\newcommand*{\doxyminisecfont} [1]
|
||||||
|
{\gdef\SS@minisecfont{\SS@sectid{7}\SS@rr\SS@makeulinepartchap#1}}
|
||||||
|
\newcommand*{\doxyallsectionsfont} [1] {\doxypartfont{#1}%
|
||||||
|
\doxychapterfont{#1}%
|
||||||
|
\doxysectionfont{#1}%
|
||||||
|
\doxysubsectionfont{#1}%
|
||||||
|
\doxysubsubsectionfont{#1}%
|
||||||
|
\doxyparagraphfont{#1}%
|
||||||
|
\doxysubparagraphfont{#1}%
|
||||||
|
\doxyminisecfont{#1}}%
|
||||||
|
% Define caption that is also suitable in a table
|
||||||
|
\makeatletter
|
||||||
|
\def\doxyfigcaption{%
|
||||||
|
\H@refstepcounter{figure}%
|
||||||
|
\@dblarg{\@caption{figure}}}
|
||||||
|
\makeatother
|
||||||
|
|
||||||
|
% Define alpha enumarative names for counters > 26
|
||||||
|
\makeatletter
|
||||||
|
\def\enumalphalphcnt#1{\expandafter\@enumalphalphcnt\csname c@#1\endcsname}
|
||||||
|
\def\@enumalphalphcnt#1{\alphalph{#1}}
|
||||||
|
\def\enumAlphAlphcnt#1{\expandafter\@enumAlphAlphcnt\csname c@#1\endcsname}
|
||||||
|
\def\@enumAlphAlphcnt#1{\AlphAlph{#1}}
|
||||||
|
\makeatother
|
||||||
|
\AddEnumerateCounter{\enumalphalphcnt}{\@enumalphalphcnt}{aa}
|
||||||
|
\AddEnumerateCounter{\enumAlphAlphcnt}{\@enumAlphAlphcnt}{AA}
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,13 @@
|
||||||
|
\doxysection{File List}
|
||||||
|
Here is a list of all documented files with brief descriptions\+:\begin{DoxyCompactList}
|
||||||
|
\item\contentsline{section}{src/\mbox{\hyperlink{main_8c}{main.\+c}} \\*Gem-\/graph client Main functions }{\pageref{main_8c}}{}
|
||||||
|
\item\contentsline{section}{src/fsm/\mbox{\hyperlink{fsm_2dispatch_8c}{dispatch.\+c}} \\*
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item OOOOOOOOOOO OOOOO OOO OOO \texorpdfstring{$\ast$}{*} OO OO OO OOOO OOOO \texorpdfstring{$\ast$}{*} OO OO OO OO OO OO \texorpdfstring{$\ast$}{*} OOOOOO OO OO OO OO OO \texorpdfstring{$\ast$}{*} OO OO OO OOO OO \texorpdfstring{$\ast$}{*} OO OO OO OO \texorpdfstring{$\ast$}{*} OO OO OOO OO OO \texorpdfstring{$\ast$}{*} OO OOOOOO OO OO \texorpdfstring{$\ast$}{*}
|
||||||
|
\begin{DoxyItemize}
|
||||||
|
\item
|
||||||
|
\end{DoxyItemize}
|
||||||
|
\end{DoxyItemize}}{\pageref{fsm_2dispatch_8c}}{}
|
||||||
|
\item\contentsline{section}{src/fsm/preferences/\mbox{\hyperlink{preferences_2manager_8c}{manager.\+c}} }{\pageref{preferences_2manager_8c}}{}
|
||||||
|
\item\contentsline{section}{src/util/draw/\mbox{\hyperlink{gl_8c}{gl.\+c}} }{\pageref{gl_8c}}{}
|
||||||
|
\end{DoxyCompactList}
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 6.5 KiB |
|
|
@ -0,0 +1,456 @@
|
||||||
|
%%
|
||||||
|
%% This is file `longtable.sty',
|
||||||
|
%% generated with the docstrip utility.
|
||||||
|
%%
|
||||||
|
%% The original source files were:
|
||||||
|
%%
|
||||||
|
%% longtable.dtx (with options: `package')
|
||||||
|
%%
|
||||||
|
%% This is a generated file.
|
||||||
|
%%
|
||||||
|
%% The source is maintained by the LaTeX Project team and bug
|
||||||
|
%% reports for it can be opened at http://latex-project.org/bugs.html
|
||||||
|
%% (but please observe conditions on bug reports sent to that address!)
|
||||||
|
%%
|
||||||
|
%% Copyright 1993-2016
|
||||||
|
%% The LaTeX3 Project and any individual authors listed elsewhere
|
||||||
|
%% in this file.
|
||||||
|
%%
|
||||||
|
%% This file was generated from file(s) of the Standard LaTeX `Tools Bundle'.
|
||||||
|
%% --------------------------------------------------------------------------
|
||||||
|
%%
|
||||||
|
%% It may be distributed and/or modified under the
|
||||||
|
%% conditions of the LaTeX Project Public License, either version 1.3c
|
||||||
|
%% of this license or (at your option) any later version.
|
||||||
|
%% The latest version of this license is in
|
||||||
|
%% http://www.latex-project.org/lppl.txt
|
||||||
|
%% and version 1.3c or later is part of all distributions of LaTeX
|
||||||
|
%% version 2005/12/01 or later.
|
||||||
|
%%
|
||||||
|
%% This file may only be distributed together with a copy of the LaTeX
|
||||||
|
%% `Tools Bundle'. You may however distribute the LaTeX `Tools Bundle'
|
||||||
|
%% without such generated files.
|
||||||
|
%%
|
||||||
|
%% The list of all files belonging to the LaTeX `Tools Bundle' is
|
||||||
|
%% given in the file `manifest.txt'.
|
||||||
|
%%
|
||||||
|
%% File: longtable.dtx Copyright (C) 1990-2001 David Carlisle
|
||||||
|
\NeedsTeXFormat{LaTeX2e}[1995/06/01]
|
||||||
|
\ProvidesPackage{longtable_doxygen}
|
||||||
|
[2014/10/28 v4.11 Multi-page Table package (DPC) - frozen version for doxygen]
|
||||||
|
\def\LT@err{\PackageError{longtable}}
|
||||||
|
\def\LT@warn{\PackageWarning{longtable}}
|
||||||
|
\def\LT@final@warn{%
|
||||||
|
\AtEndDocument{%
|
||||||
|
\LT@warn{Table \@width s have changed. Rerun LaTeX.\@gobbletwo}}%
|
||||||
|
\global\let\LT@final@warn\relax}
|
||||||
|
\DeclareOption{errorshow}{%
|
||||||
|
\def\LT@warn{\PackageInfo{longtable}}}
|
||||||
|
\DeclareOption{pausing}{%
|
||||||
|
\def\LT@warn#1{%
|
||||||
|
\LT@err{#1}{This is not really an error}}}
|
||||||
|
\DeclareOption{set}{}
|
||||||
|
\DeclareOption{final}{}
|
||||||
|
\ProcessOptions
|
||||||
|
\newskip\LTleft \LTleft=\fill
|
||||||
|
\newskip\LTright \LTright=\fill
|
||||||
|
\newskip\LTpre \LTpre=\bigskipamount
|
||||||
|
\newskip\LTpost \LTpost=\bigskipamount
|
||||||
|
\newcount\LTchunksize \LTchunksize=20
|
||||||
|
\let\c@LTchunksize\LTchunksize
|
||||||
|
\newdimen\LTcapwidth \LTcapwidth=4in
|
||||||
|
\newbox\LT@head
|
||||||
|
\newbox\LT@firsthead
|
||||||
|
\newbox\LT@foot
|
||||||
|
\newbox\LT@lastfoot
|
||||||
|
\newcount\LT@cols
|
||||||
|
\newcount\LT@rows
|
||||||
|
\newcounter{LT@tables}
|
||||||
|
\newcounter{LT@chunks}[LT@tables]
|
||||||
|
\ifx\c@table\undefined
|
||||||
|
\newcounter{table}
|
||||||
|
\def\fnum@table{\tablename~\thetable}
|
||||||
|
\fi
|
||||||
|
\ifx\tablename\undefined
|
||||||
|
\def\tablename{Table}
|
||||||
|
\fi
|
||||||
|
\newtoks\LT@p@ftn
|
||||||
|
\mathchardef\LT@end@pen=30000
|
||||||
|
\def\longtable{%
|
||||||
|
\par
|
||||||
|
\ifx\multicols\@undefined
|
||||||
|
\else
|
||||||
|
\ifnum\col@number>\@ne
|
||||||
|
\@twocolumntrue
|
||||||
|
\fi
|
||||||
|
\fi
|
||||||
|
\if@twocolumn
|
||||||
|
\LT@err{longtable not in 1-column mode}\@ehc
|
||||||
|
\fi
|
||||||
|
\begingroup
|
||||||
|
\@ifnextchar[\LT@array{\LT@array[x]}}
|
||||||
|
\def\LT@array[#1]#2{%
|
||||||
|
\refstepcounter{table}\stepcounter{LT@tables}%
|
||||||
|
\if l#1%
|
||||||
|
\LTleft\z@ \LTright\fill
|
||||||
|
\else\if r#1%
|
||||||
|
\LTleft\fill \LTright\z@
|
||||||
|
\else\if c#1%
|
||||||
|
\LTleft\fill \LTright\fill
|
||||||
|
\fi\fi\fi
|
||||||
|
\let\LT@mcol\multicolumn
|
||||||
|
\let\LT@@tabarray\@tabarray
|
||||||
|
\let\LT@@hl\hline
|
||||||
|
\def\@tabarray{%
|
||||||
|
\let\hline\LT@@hl
|
||||||
|
\LT@@tabarray}%
|
||||||
|
\let\\\LT@tabularcr\let\tabularnewline\\%
|
||||||
|
\def\newpage{\noalign{\break}}%
|
||||||
|
\def\pagebreak{\noalign{\ifnum`}=0\fi\@testopt{\LT@no@pgbk-}4}%
|
||||||
|
\def\nopagebreak{\noalign{\ifnum`}=0\fi\@testopt\LT@no@pgbk4}%
|
||||||
|
\let\hline\LT@hline \let\kill\LT@kill\let\caption\LT@caption
|
||||||
|
\@tempdima\ht\strutbox
|
||||||
|
\let\@endpbox\LT@endpbox
|
||||||
|
\ifx\extrarowheight\@undefined
|
||||||
|
\let\@acol\@tabacol
|
||||||
|
\let\@classz\@tabclassz \let\@classiv\@tabclassiv
|
||||||
|
\def\@startpbox{\vtop\LT@startpbox}%
|
||||||
|
\let\@@startpbox\@startpbox
|
||||||
|
\let\@@endpbox\@endpbox
|
||||||
|
\let\LT@LL@FM@cr\@tabularcr
|
||||||
|
\else
|
||||||
|
\advance\@tempdima\extrarowheight
|
||||||
|
\col@sep\tabcolsep
|
||||||
|
\let\@startpbox\LT@startpbox\let\LT@LL@FM@cr\@arraycr
|
||||||
|
\fi
|
||||||
|
\setbox\@arstrutbox\hbox{\vrule
|
||||||
|
\@height \arraystretch \@tempdima
|
||||||
|
\@depth \arraystretch \dp \strutbox
|
||||||
|
\@width \z@}%
|
||||||
|
\let\@sharp##\let\protect\relax
|
||||||
|
\begingroup
|
||||||
|
\@mkpream{#2}%
|
||||||
|
\xdef\LT@bchunk{%
|
||||||
|
\global\advance\c@LT@chunks\@ne
|
||||||
|
\global\LT@rows\z@\setbox\z@\vbox\bgroup
|
||||||
|
\LT@setprevdepth
|
||||||
|
\tabskip\LTleft \noexpand\halign to\hsize\bgroup
|
||||||
|
\tabskip\z@ \@arstrut \@preamble \tabskip\LTright \cr}%
|
||||||
|
\endgroup
|
||||||
|
\expandafter\LT@nofcols\LT@bchunk&\LT@nofcols
|
||||||
|
\LT@make@row
|
||||||
|
\m@th\let\par\@empty
|
||||||
|
\everycr{}\lineskip\z@\baselineskip\z@
|
||||||
|
\LT@bchunk}
|
||||||
|
\def\LT@no@pgbk#1[#2]{\penalty #1\@getpen{#2}\ifnum`{=0\fi}}
|
||||||
|
\def\LT@start{%
|
||||||
|
\let\LT@start\endgraf
|
||||||
|
\endgraf\penalty\z@\vskip\LTpre
|
||||||
|
\dimen@\pagetotal
|
||||||
|
\advance\dimen@ \ht\ifvoid\LT@firsthead\LT@head\else\LT@firsthead\fi
|
||||||
|
\advance\dimen@ \dp\ifvoid\LT@firsthead\LT@head\else\LT@firsthead\fi
|
||||||
|
\advance\dimen@ \ht\LT@foot
|
||||||
|
\dimen@ii\vfuzz
|
||||||
|
\vfuzz\maxdimen
|
||||||
|
\setbox\tw@\copy\z@
|
||||||
|
\setbox\tw@\vsplit\tw@ to \ht\@arstrutbox
|
||||||
|
\setbox\tw@\vbox{\unvbox\tw@}%
|
||||||
|
\vfuzz\dimen@ii
|
||||||
|
\advance\dimen@ \ht
|
||||||
|
\ifdim\ht\@arstrutbox>\ht\tw@\@arstrutbox\else\tw@\fi
|
||||||
|
\advance\dimen@\dp
|
||||||
|
\ifdim\dp\@arstrutbox>\dp\tw@\@arstrutbox\else\tw@\fi
|
||||||
|
\advance\dimen@ -\pagegoal
|
||||||
|
\ifdim \dimen@>\z@\vfil\break\fi
|
||||||
|
\global\@colroom\@colht
|
||||||
|
\ifvoid\LT@foot\else
|
||||||
|
\advance\vsize-\ht\LT@foot
|
||||||
|
\global\advance\@colroom-\ht\LT@foot
|
||||||
|
\dimen@\pagegoal\advance\dimen@-\ht\LT@foot\pagegoal\dimen@
|
||||||
|
\maxdepth\z@
|
||||||
|
\fi
|
||||||
|
\ifvoid\LT@firsthead\copy\LT@head\else\box\LT@firsthead\fi\nobreak
|
||||||
|
\output{\LT@output}}
|
||||||
|
\def\endlongtable{%
|
||||||
|
\crcr
|
||||||
|
\noalign{%
|
||||||
|
\let\LT@entry\LT@entry@chop
|
||||||
|
\xdef\LT@save@row{\LT@save@row}}%
|
||||||
|
\LT@echunk
|
||||||
|
\LT@start
|
||||||
|
\unvbox\z@
|
||||||
|
\LT@get@widths
|
||||||
|
\if@filesw
|
||||||
|
{\let\LT@entry\LT@entry@write\immediate\write\@auxout{%
|
||||||
|
\gdef\expandafter\noexpand
|
||||||
|
\csname LT@\romannumeral\c@LT@tables\endcsname
|
||||||
|
{\LT@save@row}}}%
|
||||||
|
\fi
|
||||||
|
\ifx\LT@save@row\LT@@save@row
|
||||||
|
\else
|
||||||
|
\LT@warn{Column \@width s have changed\MessageBreak
|
||||||
|
in table \thetable}%
|
||||||
|
\LT@final@warn
|
||||||
|
\fi
|
||||||
|
\endgraf\penalty -\LT@end@pen
|
||||||
|
\endgroup
|
||||||
|
\global\@mparbottom\z@
|
||||||
|
\pagegoal\vsize
|
||||||
|
\endgraf\penalty\z@\addvspace\LTpost
|
||||||
|
\ifvoid\footins\else\insert\footins{}\fi}
|
||||||
|
\def\LT@nofcols#1&{%
|
||||||
|
\futurelet\@let@token\LT@n@fcols}
|
||||||
|
\def\LT@n@fcols{%
|
||||||
|
\advance\LT@cols\@ne
|
||||||
|
\ifx\@let@token\LT@nofcols
|
||||||
|
\expandafter\@gobble
|
||||||
|
\else
|
||||||
|
\expandafter\LT@nofcols
|
||||||
|
\fi}
|
||||||
|
\def\LT@tabularcr{%
|
||||||
|
\relax\iffalse{\fi\ifnum0=`}\fi
|
||||||
|
\@ifstar
|
||||||
|
{\def\crcr{\LT@crcr\noalign{\nobreak}}\let\cr\crcr
|
||||||
|
\LT@t@bularcr}%
|
||||||
|
{\LT@t@bularcr}}
|
||||||
|
\let\LT@crcr\crcr
|
||||||
|
\let\LT@setprevdepth\relax
|
||||||
|
\def\LT@t@bularcr{%
|
||||||
|
\global\advance\LT@rows\@ne
|
||||||
|
\ifnum\LT@rows=\LTchunksize
|
||||||
|
\gdef\LT@setprevdepth{%
|
||||||
|
\prevdepth\z@\global
|
||||||
|
\global\let\LT@setprevdepth\relax}%
|
||||||
|
\expandafter\LT@xtabularcr
|
||||||
|
\else
|
||||||
|
\ifnum0=`{}\fi
|
||||||
|
\expandafter\LT@LL@FM@cr
|
||||||
|
\fi}
|
||||||
|
\def\LT@xtabularcr{%
|
||||||
|
\@ifnextchar[\LT@argtabularcr\LT@ntabularcr}
|
||||||
|
\def\LT@ntabularcr{%
|
||||||
|
\ifnum0=`{}\fi
|
||||||
|
\LT@echunk
|
||||||
|
\LT@start
|
||||||
|
\unvbox\z@
|
||||||
|
\LT@get@widths
|
||||||
|
\LT@bchunk}
|
||||||
|
\def\LT@argtabularcr[#1]{%
|
||||||
|
\ifnum0=`{}\fi
|
||||||
|
\ifdim #1>\z@
|
||||||
|
\unskip\@xargarraycr{#1}%
|
||||||
|
\else
|
||||||
|
\@yargarraycr{#1}%
|
||||||
|
\fi
|
||||||
|
\LT@echunk
|
||||||
|
\LT@start
|
||||||
|
\unvbox\z@
|
||||||
|
\LT@get@widths
|
||||||
|
\LT@bchunk}
|
||||||
|
\def\LT@echunk{%
|
||||||
|
\crcr\LT@save@row\cr\egroup
|
||||||
|
\global\setbox\@ne\lastbox
|
||||||
|
\unskip
|
||||||
|
\egroup}
|
||||||
|
\def\LT@entry#1#2{%
|
||||||
|
\ifhmode\@firstofone{&}\fi\omit
|
||||||
|
\ifnum#1=\c@LT@chunks
|
||||||
|
\else
|
||||||
|
\kern#2\relax
|
||||||
|
\fi}
|
||||||
|
\def\LT@entry@chop#1#2{%
|
||||||
|
\noexpand\LT@entry
|
||||||
|
{\ifnum#1>\c@LT@chunks
|
||||||
|
1}{0pt%
|
||||||
|
\else
|
||||||
|
#1}{#2%
|
||||||
|
\fi}}
|
||||||
|
\def\LT@entry@write{%
|
||||||
|
\noexpand\LT@entry^^J%
|
||||||
|
\@spaces}
|
||||||
|
\def\LT@kill{%
|
||||||
|
\LT@echunk
|
||||||
|
\LT@get@widths
|
||||||
|
\expandafter\LT@rebox\LT@bchunk}
|
||||||
|
\def\LT@rebox#1\bgroup{%
|
||||||
|
#1\bgroup
|
||||||
|
\unvbox\z@
|
||||||
|
\unskip
|
||||||
|
\setbox\z@\lastbox}
|
||||||
|
\def\LT@blank@row{%
|
||||||
|
\xdef\LT@save@row{\expandafter\LT@build@blank
|
||||||
|
\romannumeral\number\LT@cols 001 }}
|
||||||
|
\def\LT@build@blank#1{%
|
||||||
|
\if#1m%
|
||||||
|
\noexpand\LT@entry{1}{0pt}%
|
||||||
|
\expandafter\LT@build@blank
|
||||||
|
\fi}
|
||||||
|
\def\LT@make@row{%
|
||||||
|
\global\expandafter\let\expandafter\LT@save@row
|
||||||
|
\csname LT@\romannumeral\c@LT@tables\endcsname
|
||||||
|
\ifx\LT@save@row\relax
|
||||||
|
\LT@blank@row
|
||||||
|
\else
|
||||||
|
{\let\LT@entry\or
|
||||||
|
\if!%
|
||||||
|
\ifcase\expandafter\expandafter\expandafter\LT@cols
|
||||||
|
\expandafter\@gobble\LT@save@row
|
||||||
|
\or
|
||||||
|
\else
|
||||||
|
\relax
|
||||||
|
\fi
|
||||||
|
!%
|
||||||
|
\else
|
||||||
|
\aftergroup\LT@blank@row
|
||||||
|
\fi}%
|
||||||
|
\fi}
|
||||||
|
\let\setlongtables\relax
|
||||||
|
\def\LT@get@widths{%
|
||||||
|
\setbox\tw@\hbox{%
|
||||||
|
\unhbox\@ne
|
||||||
|
\let\LT@old@row\LT@save@row
|
||||||
|
\global\let\LT@save@row\@empty
|
||||||
|
\count@\LT@cols
|
||||||
|
\loop
|
||||||
|
\unskip
|
||||||
|
\setbox\tw@\lastbox
|
||||||
|
\ifhbox\tw@
|
||||||
|
\LT@def@row
|
||||||
|
\advance\count@\m@ne
|
||||||
|
\repeat}%
|
||||||
|
\ifx\LT@@save@row\@undefined
|
||||||
|
\let\LT@@save@row\LT@save@row
|
||||||
|
\fi}
|
||||||
|
\def\LT@def@row{%
|
||||||
|
\let\LT@entry\or
|
||||||
|
\edef\@tempa{%
|
||||||
|
\ifcase\expandafter\count@\LT@old@row
|
||||||
|
\else
|
||||||
|
{1}{0pt}%
|
||||||
|
\fi}%
|
||||||
|
\let\LT@entry\relax
|
||||||
|
\xdef\LT@save@row{%
|
||||||
|
\LT@entry
|
||||||
|
\expandafter\LT@max@sel\@tempa
|
||||||
|
\LT@save@row}}
|
||||||
|
\def\LT@max@sel#1#2{%
|
||||||
|
{\ifdim#2=\wd\tw@
|
||||||
|
#1%
|
||||||
|
\else
|
||||||
|
\number\c@LT@chunks
|
||||||
|
\fi}%
|
||||||
|
{\the\wd\tw@}}
|
||||||
|
\def\LT@hline{%
|
||||||
|
\noalign{\ifnum0=`}\fi
|
||||||
|
\penalty\@M
|
||||||
|
\futurelet\@let@token\LT@@hline}
|
||||||
|
\def\LT@@hline{%
|
||||||
|
\ifx\@let@token\hline
|
||||||
|
\global\let\@gtempa\@gobble
|
||||||
|
\gdef\LT@sep{\penalty-\@medpenalty\vskip\doublerulesep}%
|
||||||
|
\else
|
||||||
|
\global\let\@gtempa\@empty
|
||||||
|
\gdef\LT@sep{\penalty-\@lowpenalty\vskip-\arrayrulewidth}%
|
||||||
|
\fi
|
||||||
|
\ifnum0=`{\fi}%
|
||||||
|
\multispan\LT@cols
|
||||||
|
\unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr
|
||||||
|
\noalign{\LT@sep}%
|
||||||
|
\multispan\LT@cols
|
||||||
|
\unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr
|
||||||
|
\noalign{\penalty\@M}%
|
||||||
|
\@gtempa}
|
||||||
|
\def\LT@caption{%
|
||||||
|
\noalign\bgroup
|
||||||
|
\@ifnextchar[{\egroup\LT@c@ption\@firstofone}\LT@capti@n}
|
||||||
|
\def\LT@c@ption#1[#2]#3{%
|
||||||
|
\LT@makecaption#1\fnum@table{#3}%
|
||||||
|
\def\@tempa{#2}%
|
||||||
|
\ifx\@tempa\@empty\else
|
||||||
|
{\let\\\space
|
||||||
|
\addcontentsline{lot}{table}{\protect\numberline{\thetable}{#2}}}%
|
||||||
|
\fi}
|
||||||
|
\def\LT@capti@n{%
|
||||||
|
\@ifstar
|
||||||
|
{\egroup\LT@c@ption\@gobble[]}%
|
||||||
|
{\egroup\@xdblarg{\LT@c@ption\@firstofone}}}
|
||||||
|
\def\LT@makecaption#1#2#3{%
|
||||||
|
\LT@mcol\LT@cols c{\hbox to\z@{\hss\parbox[t]\LTcapwidth{%
|
||||||
|
\sbox\@tempboxa{#1{#2: }#3}%
|
||||||
|
\ifdim\wd\@tempboxa>\hsize
|
||||||
|
#1{#2: }#3%
|
||||||
|
\else
|
||||||
|
\hbox to\hsize{\hfil\box\@tempboxa\hfil}%
|
||||||
|
\fi
|
||||||
|
\endgraf\vskip\baselineskip}%
|
||||||
|
\hss}}}
|
||||||
|
\def\LT@output{%
|
||||||
|
\ifnum\outputpenalty <-\@Mi
|
||||||
|
\ifnum\outputpenalty > -\LT@end@pen
|
||||||
|
\LT@err{floats and marginpars not allowed in a longtable}\@ehc
|
||||||
|
\else
|
||||||
|
\setbox\z@\vbox{\unvbox\@cclv}%
|
||||||
|
\ifdim \ht\LT@lastfoot>\ht\LT@foot
|
||||||
|
\dimen@\pagegoal
|
||||||
|
\advance\dimen@-\ht\LT@lastfoot
|
||||||
|
\ifdim\dimen@<\ht\z@
|
||||||
|
\setbox\@cclv\vbox{\unvbox\z@\copy\LT@foot\vss}%
|
||||||
|
\@makecol
|
||||||
|
\@outputpage
|
||||||
|
\setbox\z@\vbox{\box\LT@head}%
|
||||||
|
\fi
|
||||||
|
\fi
|
||||||
|
\global\@colroom\@colht
|
||||||
|
\global\vsize\@colht
|
||||||
|
\vbox
|
||||||
|
{\unvbox\z@\box\ifvoid\LT@lastfoot\LT@foot\else\LT@lastfoot\fi}%
|
||||||
|
\fi
|
||||||
|
\else
|
||||||
|
\setbox\@cclv\vbox{\unvbox\@cclv\copy\LT@foot\vss}%
|
||||||
|
\@makecol
|
||||||
|
\@outputpage
|
||||||
|
\global\vsize\@colroom
|
||||||
|
\copy\LT@head\nobreak
|
||||||
|
\fi}
|
||||||
|
\def\LT@end@hd@ft#1{%
|
||||||
|
\LT@echunk
|
||||||
|
\ifx\LT@start\endgraf
|
||||||
|
\LT@err
|
||||||
|
{Longtable head or foot not at start of table}%
|
||||||
|
{Increase LTchunksize}%
|
||||||
|
\fi
|
||||||
|
\setbox#1\box\z@
|
||||||
|
\LT@get@widths
|
||||||
|
\LT@bchunk}
|
||||||
|
\def\endfirsthead{\LT@end@hd@ft\LT@firsthead}
|
||||||
|
\def\endhead{\LT@end@hd@ft\LT@head}
|
||||||
|
\def\endfoot{\LT@end@hd@ft\LT@foot}
|
||||||
|
\def\endlastfoot{\LT@end@hd@ft\LT@lastfoot}
|
||||||
|
\def\LT@startpbox#1{%
|
||||||
|
\bgroup
|
||||||
|
\let\@footnotetext\LT@p@ftntext
|
||||||
|
\setlength\hsize{#1}%
|
||||||
|
\@arrayparboxrestore
|
||||||
|
\vrule \@height \ht\@arstrutbox \@width \z@}
|
||||||
|
\def\LT@endpbox{%
|
||||||
|
\@finalstrut\@arstrutbox
|
||||||
|
\egroup
|
||||||
|
\the\LT@p@ftn
|
||||||
|
\global\LT@p@ftn{}%
|
||||||
|
\hfil}
|
||||||
|
%% added \long to prevent:
|
||||||
|
% LaTeX Warning: Command \LT@p@ftntext has changed.
|
||||||
|
%
|
||||||
|
% from the original repository (https://github.com/latex3/latex2e/blob/develop/required/tools/longtable.dtx):
|
||||||
|
% \changes{v4.15}{2021/03/28}
|
||||||
|
% {make long for gh/364}
|
||||||
|
% Inside the `p' column, just save up the footnote text in a token
|
||||||
|
% register.
|
||||||
|
\long\def\LT@p@ftntext#1{%
|
||||||
|
\edef\@tempa{\the\LT@p@ftn\noexpand\footnotetext[\the\c@footnote]}%
|
||||||
|
\global\LT@p@ftn\expandafter{\@tempa{#1}}}%
|
||||||
|
|
||||||
|
\@namedef{ver@longtable.sty}{2014/10/28 v4.11 Multi-page Table package (DPC) - frozen version for doxygen}
|
||||||
|
\endinput
|
||||||
|
%%
|
||||||
|
%% End of file `longtable.sty'.
|
||||||
|
|
@ -0,0 +1,244 @@
|
||||||
|
% Handle batch mode
|
||||||
|
% to overcome problems with too many open files
|
||||||
|
\let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}
|
||||||
|
\pdfminorversion=7
|
||||||
|
% Set document class depending on configuration
|
||||||
|
\documentclass[twoside]{book}
|
||||||
|
%% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package
|
||||||
|
\usepackage{ifthen}
|
||||||
|
\ifx\requestedLaTeXdate\undefined
|
||||||
|
\usepackage{array}
|
||||||
|
\else
|
||||||
|
\usepackage{array}[=2016-10-06]
|
||||||
|
\fi
|
||||||
|
%%
|
||||||
|
% Packages required by doxygen
|
||||||
|
\makeatletter
|
||||||
|
\providecommand\IfFormatAtLeastTF{\@ifl@t@r\fmtversion}
|
||||||
|
% suppress package identification of infwarerr as it contains the word "warning"
|
||||||
|
\let\@@protected@wlog\protected@wlog
|
||||||
|
\def\protected@wlog#1{\wlog{package info suppressed}}
|
||||||
|
\RequirePackage{infwarerr}
|
||||||
|
\let\protected@wlog\@@protected@wlog
|
||||||
|
\makeatother
|
||||||
|
\IfFormatAtLeastTF{2016/01/01}{}{\usepackage{fixltx2e}} % for \textsubscript
|
||||||
|
\IfFormatAtLeastTF{2015/01/01}{\pdfsuppresswarningpagegroup=1}{}
|
||||||
|
\usepackage{doxygen}
|
||||||
|
\usepackage{graphicx}
|
||||||
|
\usepackage[utf8]{inputenc}
|
||||||
|
\usepackage{makeidx}
|
||||||
|
\PassOptionsToPackage{warn}{textcomp}
|
||||||
|
\usepackage{textcomp}
|
||||||
|
\usepackage[nointegrals]{wasysym}
|
||||||
|
\usepackage{ifxetex}
|
||||||
|
% NLS support packages
|
||||||
|
% Define default fonts
|
||||||
|
% Font selection
|
||||||
|
\usepackage[T1]{fontenc}
|
||||||
|
% set main and monospaced font
|
||||||
|
\usepackage[scaled=.90]{helvet}
|
||||||
|
\usepackage{courier}
|
||||||
|
\renewcommand{\familydefault}{\sfdefault}
|
||||||
|
\doxyallsectionsfont{%
|
||||||
|
\fontseries{bc}\selectfont%
|
||||||
|
\color{darkgray}%
|
||||||
|
}
|
||||||
|
\renewcommand{\DoxyLabelFont}{%
|
||||||
|
\fontseries{bc}\selectfont%
|
||||||
|
\color{darkgray}%
|
||||||
|
}
|
||||||
|
\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
|
||||||
|
% Arguments of doxygenemoji:
|
||||||
|
% 1) ':<text>:' form of the emoji, already LaTeX-escaped
|
||||||
|
% 2) file with the name of the emoji without the .png extension
|
||||||
|
% in case image exist use this otherwise use the ':<text>:' form
|
||||||
|
\newcommand{\doxygenemoji}[2]{%
|
||||||
|
\IfFileExists{./#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{./#2.png}}}{#1}%
|
||||||
|
}
|
||||||
|
% Page & text layout
|
||||||
|
\usepackage{geometry}
|
||||||
|
\geometry{%
|
||||||
|
a4paper,%
|
||||||
|
top=2.5cm,%
|
||||||
|
bottom=2.5cm,%
|
||||||
|
left=2.5cm,%
|
||||||
|
right=2.5cm%
|
||||||
|
}
|
||||||
|
\usepackage{changepage}
|
||||||
|
% Allow a bit of overflow to go unnoticed by other means
|
||||||
|
\tolerance=750
|
||||||
|
\hfuzz=15pt
|
||||||
|
\hbadness=750
|
||||||
|
\setlength{\emergencystretch}{15pt}
|
||||||
|
\setlength{\parindent}{0cm}
|
||||||
|
\newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}
|
||||||
|
\newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}}
|
||||||
|
\doxynormalparskip
|
||||||
|
% Redefine paragraph/subparagraph environments, using sectsty fonts
|
||||||
|
\makeatletter
|
||||||
|
\renewcommand{\paragraph}{%
|
||||||
|
\@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
|
||||||
|
\normalfont\normalsize\bfseries\SS@parafont%
|
||||||
|
}%
|
||||||
|
}
|
||||||
|
\renewcommand{\subparagraph}{%
|
||||||
|
\@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
|
||||||
|
\normalfont\normalsize\bfseries\SS@subparafont%
|
||||||
|
}%
|
||||||
|
}
|
||||||
|
\makeatother
|
||||||
|
\makeatletter
|
||||||
|
\newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@}
|
||||||
|
\makeatother
|
||||||
|
% Headers & footers
|
||||||
|
\usepackage{fancyhdr}
|
||||||
|
\pagestyle{fancyplain}
|
||||||
|
\renewcommand{\footrulewidth}{0.4pt}
|
||||||
|
\fancypagestyle{fancyplain}{
|
||||||
|
\fancyhf{}
|
||||||
|
\fancyhead[LE, RO]{\bfseries\thepage}
|
||||||
|
\fancyhead[LO]{\bfseries\rightmark}
|
||||||
|
\fancyhead[RE]{\bfseries\leftmark}
|
||||||
|
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
|
||||||
|
}
|
||||||
|
\fancypagestyle{plain}{
|
||||||
|
\fancyhf{}
|
||||||
|
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
|
||||||
|
\renewcommand{\headrulewidth}{0pt}
|
||||||
|
}
|
||||||
|
\pagestyle{fancyplain}
|
||||||
|
\renewcommand{\chaptermark}[1]{%
|
||||||
|
\markboth{#1}{}%
|
||||||
|
}
|
||||||
|
\renewcommand{\sectionmark}[1]{%
|
||||||
|
\markright{\thesection\ #1}%
|
||||||
|
}
|
||||||
|
% ToC, LoF, LoT, bibliography, and index
|
||||||
|
% Indices & bibliography
|
||||||
|
\usepackage{natbib}
|
||||||
|
\usepackage[titles]{tocloft}
|
||||||
|
\setcounter{tocdepth}{3}
|
||||||
|
\setcounter{secnumdepth}{5}
|
||||||
|
% creating indexes
|
||||||
|
\makeindex
|
||||||
|
\usepackage{newunicodechar}
|
||||||
|
\makeatletter
|
||||||
|
\def\doxynewunicodechar#1#2{%
|
||||||
|
\@tempswafalse
|
||||||
|
\edef\nuc@tempa{\detokenize{#1}}%
|
||||||
|
\if\relax\nuc@tempa\relax
|
||||||
|
\nuc@emptyargerr
|
||||||
|
\else
|
||||||
|
\edef\@tempb{\expandafter\@car\nuc@tempa\@nil}%
|
||||||
|
\nuc@check
|
||||||
|
\if@tempswa
|
||||||
|
\@namedef{u8:\nuc@tempa}{#2}%
|
||||||
|
\fi
|
||||||
|
\fi
|
||||||
|
}
|
||||||
|
\makeatother
|
||||||
|
\doxynewunicodechar{⁻}{${}^{-}$}% Superscript minus
|
||||||
|
\doxynewunicodechar{²}{${}^{2}$}% Superscript two
|
||||||
|
\doxynewunicodechar{³}{${}^{3}$}% Superscript three
|
||||||
|
% Hyperlinks
|
||||||
|
% Hyperlinks (required, but should be loaded last)
|
||||||
|
\ifpdf
|
||||||
|
\usepackage[pdftex,pagebackref=true]{hyperref}
|
||||||
|
\else
|
||||||
|
\ifxetex
|
||||||
|
\usepackage[pagebackref=true]{hyperref}
|
||||||
|
\else
|
||||||
|
\usepackage[ps2pdf,pagebackref=true]{hyperref}
|
||||||
|
\fi
|
||||||
|
\fi
|
||||||
|
\hypersetup{%
|
||||||
|
colorlinks=true,%
|
||||||
|
linkcolor=blue,%
|
||||||
|
citecolor=blue,%
|
||||||
|
unicode,%
|
||||||
|
pdftitle={Gem-\/graph},%
|
||||||
|
pdfsubject={A modelling tool based on rewriting of geometric graphs.}%
|
||||||
|
}
|
||||||
|
% Custom commands used by the header
|
||||||
|
% Custom commands
|
||||||
|
\newcommand{\clearemptydoublepage}{%
|
||||||
|
\newpage{\pagestyle{empty}\cleardoublepage}%
|
||||||
|
}
|
||||||
|
% caption style definition
|
||||||
|
\usepackage{caption}
|
||||||
|
\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
|
||||||
|
% in page table of contents
|
||||||
|
\IfFormatAtLeastTF{2023/05/01}{\usepackage[deeplevels]{etoc}}{\usepackage[deeplevels]{etoc_doxygen}}
|
||||||
|
\etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
|
||||||
|
\etocsetlevel{subsubsubsection}{4}
|
||||||
|
\etocsetlevel{subsubsubsubsection}{5}
|
||||||
|
\etocsetlevel{subsubsubsubsubsection}{6}
|
||||||
|
\etocsetlevel{subsubsubsubsubsubsection}{7}
|
||||||
|
\etocsetlevel{paragraph}{8}
|
||||||
|
\etocsetlevel{subparagraph}{9}
|
||||||
|
% prevent numbers overlap the titles in toc
|
||||||
|
\renewcommand{\numberline}[1]{#1~}
|
||||||
|
% End of preamble, now comes the document contents
|
||||||
|
%===== C O N T E N T S =====
|
||||||
|
\begin{document}
|
||||||
|
\raggedbottom
|
||||||
|
% Titlepage & ToC
|
||||||
|
% To avoid duplicate page anchors due to reuse of same numbers for
|
||||||
|
% the index (be it as roman numbers)
|
||||||
|
\hypersetup{pageanchor=false,
|
||||||
|
bookmarksnumbered=true,
|
||||||
|
pdfencoding=unicode
|
||||||
|
}
|
||||||
|
\pagenumbering{alph}
|
||||||
|
\begin{titlepage}
|
||||||
|
\vspace*{7cm}
|
||||||
|
\begin{center}%
|
||||||
|
{\Large Gem-\/graph}\\
|
||||||
|
[1ex]\large 0.\+1.\+0 \\
|
||||||
|
\vspace*{1cm}
|
||||||
|
{\large Generated by Doxygen 1.9.8}\\
|
||||||
|
\end{center}
|
||||||
|
\end{titlepage}
|
||||||
|
\clearemptydoublepage
|
||||||
|
\pagenumbering{roman}
|
||||||
|
\tableofcontents
|
||||||
|
\clearemptydoublepage
|
||||||
|
\pagenumbering{arabic}
|
||||||
|
% re-enable anchors again
|
||||||
|
\hypersetup{pageanchor=true}
|
||||||
|
%--- Begin generated contents ---
|
||||||
|
\chapter{Class Index}
|
||||||
|
\input{annotated}
|
||||||
|
\chapter{File Index}
|
||||||
|
\input{files}
|
||||||
|
\chapter{Class Documentation}
|
||||||
|
\input{d3/d03/structarrow__t}
|
||||||
|
\input{d1/d04/structdblist}
|
||||||
|
\input{d0/d0b/structelem}
|
||||||
|
\input{d9/d03/structfsm__struct__journal}
|
||||||
|
\input{d7/d08/structfsm__struct__journal__unit}
|
||||||
|
\input{d9/d04/structfsm__struct__list__data}
|
||||||
|
\input{d1/d07/structfsm__struct__list__disp}
|
||||||
|
\input{d5/d00/structfsm__struct__list__tool}
|
||||||
|
\input{dd/d0e/structgraphics__stack__t}
|
||||||
|
\input{da/d03/structpile}
|
||||||
|
\input{d3/d0f/structpreferences}
|
||||||
|
\input{df/d05/structslist}
|
||||||
|
\input{d7/d07/structStack}
|
||||||
|
\input{d7/d02/structstack__index__t}
|
||||||
|
\input{d1/d09/structTreeNode__t}
|
||||||
|
\chapter{File Documentation}
|
||||||
|
\input{d9/d06/preferences_2manager_8c}
|
||||||
|
\input{d0/d09/main_8c}
|
||||||
|
\input{da/d0c/gl_8c}
|
||||||
|
\input{d4/d07/fsm_2dispatch_8c}
|
||||||
|
%--- End generated contents ---
|
||||||
|
% Index
|
||||||
|
\backmatter
|
||||||
|
\newpage
|
||||||
|
\phantomsection
|
||||||
|
\clearemptydoublepage
|
||||||
|
\addcontentsline{toc}{chapter}{\indexname}
|
||||||
|
\printindex
|
||||||
|
% Required for some languages (in combination with latexdocumentpre from the header)
|
||||||
|
\end{document}
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/gl.c.3
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
.TH "Stack" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
Stack \- struct images_bff {GtkWidget *arr[MAX_SIZE]; int top;}; static struct images_bff *my_list = NULL;//, *babar = NULL; static struct images_bff *alloc_images_bff () { struct images_bff *p; p = malloc (sizeof (struct images_bff)); if (p == NULL) printf ('fatal: ran out of storage'); p->arr[MAX_SIZE] = NULL; p->top = 0; return p; } static void add_to_mylist (int my_int) { struct images_bff *p = alloc_images_bff (); p->arr[MAX_SIZE] = NULL; // TODO p->top = my_int; my_list = p; } static void free_intlist (struct images_bff *p) { TODO } TODO free_intlist (mylist); TODO mylist = NULL; TODO offsetof (type, field)
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
.SS "Public Attributes"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.ti -1c
|
||||||
|
.RI "GtkWidget * \fBarr\fP [MAX_SIZE]"
|
||||||
|
.br
|
||||||
|
.RI "*arr[MAX_SIZE] phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "int \fBtop\fP"
|
||||||
|
.br
|
||||||
|
.RI "top phantom documentation "
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
struct images_bff {GtkWidget *arr[MAX_SIZE]; int top;}; static struct images_bff *my_list = NULL;//, *babar = NULL; static struct images_bff *alloc_images_bff () { struct images_bff *p; p = malloc (sizeof (struct images_bff)); if (p == NULL) printf ('fatal: ran out of storage'); p->arr[MAX_SIZE] = NULL; p->top = 0; return p; } static void add_to_mylist (int my_int) { struct images_bff *p = alloc_images_bff (); p->arr[MAX_SIZE] = NULL; // TODO p->top = my_int; my_list = p; } static void free_intlist (struct images_bff *p) { TODO } TODO free_intlist (mylist); TODO mylist = NULL; TODO offsetof (type, field)
|
||||||
|
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
.TH "TreeNode_t" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
TreeNode_t \- phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
\fC#include <widget\&.h>\fP
|
||||||
|
.SS "Public Attributes"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.ti -1c
|
||||||
|
.RI "gchar * \fBtext\fP"
|
||||||
|
.br
|
||||||
|
.RI "*text phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "struct \fBTreeNode_t\fP * \fBchild\fP"
|
||||||
|
.br
|
||||||
|
.RI "*child phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "struct \fBTreeNode_t\fP * \fBnext\fP"
|
||||||
|
.br
|
||||||
|
.RI "*next phantom documentation "
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/Stack.3
|
||||||
|
|
@ -0,0 +1,42 @@
|
||||||
|
.TH "arrow_t" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
arrow_t \- phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
\fC#include <base\&.h>\fP
|
||||||
|
.SS "Public Attributes"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.ti -1c
|
||||||
|
.RI "uint \fBload\fP"
|
||||||
|
.br
|
||||||
|
.RI "load phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "uint \fBsite\fP"
|
||||||
|
.br
|
||||||
|
.RI "site phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "uint \fBx\fP"
|
||||||
|
.br
|
||||||
|
.RI "x phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "uint \fBy\fP"
|
||||||
|
.br
|
||||||
|
.RI "y phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "uint \fBz\fP"
|
||||||
|
.br
|
||||||
|
.RI "z phantom documentation "
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/TreeNode_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/graphics_stack_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/stack_index_t.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/gl.c.3
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
.TH "dblist" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
dblist \- phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
\fC#include <util\&.h>\fP
|
||||||
|
.SS "Public Attributes"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.ti -1c
|
||||||
|
.RI "\fBelem\fP * \fBfirst\fP"
|
||||||
|
.br
|
||||||
|
.RI "*first phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "\fBelem\fP * \fBlast\fP"
|
||||||
|
.br
|
||||||
|
.RI "*last phantom documentation "
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
|
|
@ -0,0 +1,459 @@
|
||||||
|
.TH "src/fsm/dispatch.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
src/fsm/dispatch.c \-
|
||||||
|
.IP "\(bu" 2
|
||||||
|
OOOOOOOOOOO OOOOO OOO OOO * OO OO OO OOOO OOOO * OO OO OO OO OO OO * OOOOOO OO OO OO OO OO * OO OO OO OOO OO * OO OO OO OO * OO OO OOO OO OO * OO OOOOOO OO OO *
|
||||||
|
.IP " \(bu" 4
|
||||||
|
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.PP
|
||||||
|
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
\fC#include <stdbool\&.h>\fP
|
||||||
|
.br
|
||||||
|
\fC#include '\&.\&./\&.\&./include/fsm\&.h'\fP
|
||||||
|
.br
|
||||||
|
\fC#include '\&.\&./\&.\&./include/util\&.h'\fP
|
||||||
|
.br
|
||||||
|
\fC#include '\&.\&./\&.\&./include/widget\&.h'\fP
|
||||||
|
.br
|
||||||
|
|
||||||
|
.SS "Functions"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.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 *initial_message_from_main)"
|
||||||
|
.br
|
||||||
|
.RI "F S M I N I T *\&. "
|
||||||
|
.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 "bool \fBfsm_get_preferences_state\fP ()"
|
||||||
|
.br
|
||||||
|
.RI "getter for the static boolean: 'preferences_have_been_modified' "
|
||||||
|
.ti -1c
|
||||||
|
.RI "int \fBfsm_get_exec_edit\fP ()"
|
||||||
|
.br
|
||||||
|
.RI "Any function that modifies the client window must obtain this boolean\&. "
|
||||||
|
.ti -1c
|
||||||
|
.RI "int \fBfsm_get_state_rules_data\fP ()"
|
||||||
|
.br
|
||||||
|
.RI "Any function that modifies the client window must obtain this value\&. "
|
||||||
|
.ti -1c
|
||||||
|
.RI "void \fBfsm_set_exec_edit\fP (int choice)"
|
||||||
|
.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 choice)"
|
||||||
|
.br
|
||||||
|
.RI "setter for the static value: 'choice_STATE_RULES_DATA' (in this file) "
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.IP "\(bu" 2
|
||||||
|
OOOOOOOOOOO OOOOO OOO OOO * OO OO OO OOOO OOOO * OO OO OO OO OO OO * OOOOOO OO OO OO OO OO * OO OO OO OOO OO * OO OO OO OO * OO OO OOO OO OO * OO OOOOOO OO OO *
|
||||||
|
.IP " \(bu" 4
|
||||||
|
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.PP
|
||||||
|
|
||||||
|
|
||||||
|
This Finite State Machine (fsm) describes all the possible states of the Gem-graph client and all the transitions between these states\&.
|
||||||
|
.PP
|
||||||
|
gem-graph-client fsm (Finite State Machine) manages four topics:
|
||||||
|
.IP "\(bu" 2
|
||||||
|
engine (window appearance)
|
||||||
|
.IP "\(bu" 2
|
||||||
|
measures (current measurements)
|
||||||
|
.IP "\(bu" 2
|
||||||
|
results (current data acquisition and displays)
|
||||||
|
.IP "\(bu" 2
|
||||||
|
preferences (current user preferences)
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
Each state of the finite state machine (fsm) is a combination of their states\&.
|
||||||
|
.PP
|
||||||
|
It must be
|
||||||
|
.IP "\(bu" 2
|
||||||
|
saved at the end of a work session and
|
||||||
|
.IP "\(bu" 2
|
||||||
|
reread (available) at the start of a new session\&.
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
No state of the fsm should be defined in another module\&. No fsm transition needs to be executed in another module\&.
|
||||||
|
.PP
|
||||||
|
The journal is created, edited and published from here\&.
|
||||||
|
.SH "Function Documentation"
|
||||||
|
.PP
|
||||||
|
.SS "int fsm_get_exec_edit ()"
|
||||||
|
|
||||||
|
.PP
|
||||||
|
Any function that modifies the client window must obtain this boolean\&. The 'state' and 'rules' pages appearance depends heavily on this\&.
|
||||||
|
.PP
|
||||||
|
see include/fsm enum fsm_enum_exec_edit { EXEC, EDIT } The current int may be replaced by a boolean before publication\&. TODO
|
||||||
|
.PP
|
||||||
|
\fBDate\fP
|
||||||
|
.RS 4
|
||||||
|
2024-08
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBAuthor\fP
|
||||||
|
.RS 4
|
||||||
|
Jean
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBSee also\fP
|
||||||
|
.RS 4
|
||||||
|
src/widget/one_rule/dispatch
|
||||||
|
.PP
|
||||||
|
src/widget/state/dispatch * 2
|
||||||
|
.PP
|
||||||
|
src/signal
|
||||||
|
.PP
|
||||||
|
include/fsm enum fsm_enum_exec_edit { EXEC, EDIT } << TODO check this
|
||||||
|
.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
|
||||||
|
\fBDate\fP
|
||||||
|
.RS 4
|
||||||
|
2024-08
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBAuthor\fP
|
||||||
|
.RS 4
|
||||||
|
Jean
|
||||||
|
.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\&.
|
||||||
|
.PP
|
||||||
|
(none)
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBReturns\fP
|
||||||
|
.RS 4
|
||||||
|
preferences_have_been_modified
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.SS "int fsm_get_state_rules_data ()"
|
||||||
|
|
||||||
|
.PP
|
||||||
|
Any function that modifies the client window must obtain this value\&. The pages selection and the window appearance depends heavily on this\&.
|
||||||
|
.PP
|
||||||
|
see include/fsm enum fsm_enum_state_rules_data { SYNTH, STATE, RULES, DATA }
|
||||||
|
.PP
|
||||||
|
\fBDate\fP
|
||||||
|
.RS 4
|
||||||
|
2024-08
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBAuthor\fP
|
||||||
|
.RS 4
|
||||||
|
Jean
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBSee also\fP
|
||||||
|
.RS 4
|
||||||
|
src/widget/topbar/left
|
||||||
|
.PP
|
||||||
|
src/signal
|
||||||
|
.PP
|
||||||
|
(none)
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBReturns\fP
|
||||||
|
.RS 4
|
||||||
|
choice_STATE_RULES_DATA
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.SS "void fsm_init (char * initial_message_from_main)"
|
||||||
|
|
||||||
|
.PP
|
||||||
|
F S M I N I T *\&. This is the first function called by '\fBmain\&.c\fP' It initiates the journal and four lists which are: 'measures', 'results', 'displayables results' and 'preferences'\&. These lists will be used to define the current state of the fsm\&.
|
||||||
|
.PP
|
||||||
|
\fBDate\fP
|
||||||
|
.RS 4
|
||||||
|
2024-08
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBAuthor\fP
|
||||||
|
.RS 4
|
||||||
|
Jean
|
||||||
|
.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_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
|
||||||
|
\fBDate\fP
|
||||||
|
.RS 4
|
||||||
|
2024-08
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBAuthor\fP
|
||||||
|
.RS 4
|
||||||
|
Jean
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBSee also\fP
|
||||||
|
.RS 4
|
||||||
|
src/journal\&.c/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
|
||||||
|
src/widget/topbar/dispatch\&.c * 3
|
||||||
|
.PP
|
||||||
|
src/widget/one_rule/dispatch\&.c
|
||||||
|
.PP
|
||||||
|
src/widget/one_rule/algebra/conditions\&.c * 2
|
||||||
|
.PP
|
||||||
|
src/widget/measure/dispatch\&.c
|
||||||
|
.PP
|
||||||
|
src/widget/dispatch\&.c * 3
|
||||||
|
.PP
|
||||||
|
src/widget/all_rules/dispatch\&.c
|
||||||
|
.PP
|
||||||
|
\fBsrc/fsm/preferences/manager\&.c\fP * 8
|
||||||
|
.PP
|
||||||
|
src/fsm/measures/manager\&.c * 2
|
||||||
|
.PP
|
||||||
|
src/fsm/measures/tools_list\&.c * 4
|
||||||
|
.PP
|
||||||
|
\fBsrc/fsm/dispatch\&.c\fP * 10
|
||||||
|
.PP
|
||||||
|
src/fsm/results/manager\&.c
|
||||||
|
.PP
|
||||||
|
src/util/tree\&.c
|
||||||
|
.PP
|
||||||
|
src/signal\&.c * 38
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBParameters\fP
|
||||||
|
.RS 4
|
||||||
|
\fIseverity\fP <>
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBSee also\fP
|
||||||
|
.RS 4
|
||||||
|
enum fsm_enum_journal_severity in include/fsm\&.h '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 include/fsm\&.h '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_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
|
||||||
|
src/journal\&.c/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
|
||||||
|
\fBDate\fP
|
||||||
|
.RS 4
|
||||||
|
2024-08
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBAuthor\fP
|
||||||
|
.RS 4
|
||||||
|
Jean
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBSee also\fP
|
||||||
|
.RS 4
|
||||||
|
src/main/main()
|
||||||
|
.PP
|
||||||
|
src/journal/fsm_journal_publish()
|
||||||
|
.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
|
||||||
|
\fBDate\fP
|
||||||
|
.RS 4
|
||||||
|
2024-08
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBAuthor\fP
|
||||||
|
.RS 4
|
||||||
|
Jean
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBSee also\fP
|
||||||
|
.RS 4
|
||||||
|
(none)
|
||||||
|
.PP
|
||||||
|
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
|
||||||
|
\fBDate\fP
|
||||||
|
.RS 4
|
||||||
|
2024-08
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBAuthor\fP
|
||||||
|
.RS 4
|
||||||
|
Jean
|
||||||
|
.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
|
||||||
|
\fBDate\fP
|
||||||
|
.RS 4
|
||||||
|
2024-08
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBAuthor\fP
|
||||||
|
.RS 4
|
||||||
|
Jean
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBSee also\fP
|
||||||
|
.RS 4
|
||||||
|
src/signal * 4
|
||||||
|
.PP
|
||||||
|
(none)
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBParameters\fP
|
||||||
|
.RS 4
|
||||||
|
\fIchoice\fP
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
.TH "elem" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
elem \- phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
\fC#include <util\&.h>\fP
|
||||||
|
.SS "Public Attributes"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.ti -1c
|
||||||
|
.RI "int \fBvalue\fP"
|
||||||
|
.br
|
||||||
|
.RI "*value phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "struct \fBelem\fP * \fBprev\fP"
|
||||||
|
.br
|
||||||
|
.RI "*prev phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "struct \fBelem\fP * \fBnext\fP"
|
||||||
|
.br
|
||||||
|
.RI "*next phantom documentation "
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/fsm_struct_journal_unit.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/dblist.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/manager.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/dispatch.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/dispatch.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/dispatch.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/dispatch.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/dispatch.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/dispatch.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/manager.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/manager.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/manager.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/dispatch.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/dispatch.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/dispatch.c.3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.so man3/manager.c.3
|
||||||
|
|
@ -0,0 +1,42 @@
|
||||||
|
.TH "fsm_struct_journal" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
fsm_struct_journal \- phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
\fC#include <fsm\&.h>\fP
|
||||||
|
.SS "Public Attributes"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.ti -1c
|
||||||
|
.RI "\fBfsm_struct_journal_unit\fP * \fBfirst\fP"
|
||||||
|
.br
|
||||||
|
.ti -1c
|
||||||
|
.RI "\fBfsm_struct_journal_unit\fP * \fBlast\fP"
|
||||||
|
.br
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
.SH "Member Data Documentation"
|
||||||
|
.PP
|
||||||
|
.SS "\fBfsm_struct_journal_unit\fP* fsm_struct_journal::first"
|
||||||
|
|
||||||
|
.IP "\(bu" 2
|
||||||
|
phantom documentation
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.SS "\fBfsm_struct_journal_unit\fP* fsm_struct_journal::last"
|
||||||
|
|
||||||
|
.IP "\(bu" 2
|
||||||
|
phantom documentation
|
||||||
|
.PP
|
||||||
|
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
|
|
@ -0,0 +1,87 @@
|
||||||
|
.TH "fsm_struct_journal_unit" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
fsm_struct_journal_unit \- phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
\fC#include <fsm\&.h>\fP
|
||||||
|
.SS "Public Attributes"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.ti -1c
|
||||||
|
.RI "long \fByy_dd_mm\fP"
|
||||||
|
.br
|
||||||
|
.ti -1c
|
||||||
|
.RI "long \fBusec\fP"
|
||||||
|
.br
|
||||||
|
.ti -1c
|
||||||
|
.RI "const char * \fBfile_source\fP"
|
||||||
|
.br
|
||||||
|
.ti -1c
|
||||||
|
.RI "const char * \fBfunction_source\fP"
|
||||||
|
.br
|
||||||
|
.ti -1c
|
||||||
|
.RI "const char * \fBstring_value\fP"
|
||||||
|
.br
|
||||||
|
.ti -1c
|
||||||
|
.RI "struct \fBfsm_struct_journal_unit\fP * \fBprev\fP"
|
||||||
|
.br
|
||||||
|
.ti -1c
|
||||||
|
.RI "struct \fBfsm_struct_journal_unit\fP * \fBnext\fP"
|
||||||
|
.br
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
.SH "Member Data Documentation"
|
||||||
|
.PP
|
||||||
|
.SS "const char* fsm_struct_journal_unit::file_source"
|
||||||
|
|
||||||
|
.IP "\(bu" 2
|
||||||
|
phantom documentation
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.SS "const char* fsm_struct_journal_unit::function_source"
|
||||||
|
|
||||||
|
.IP "\(bu" 2
|
||||||
|
phantom documentation
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.SS "struct \fBfsm_struct_journal_unit\fP* fsm_struct_journal_unit::next"
|
||||||
|
|
||||||
|
.IP "\(bu" 2
|
||||||
|
phantom documentation
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.SS "struct \fBfsm_struct_journal_unit\fP* fsm_struct_journal_unit::prev"
|
||||||
|
|
||||||
|
.IP "\(bu" 2
|
||||||
|
phantom documentation
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.SS "const char* fsm_struct_journal_unit::string_value"
|
||||||
|
|
||||||
|
.IP "\(bu" 2
|
||||||
|
phantom documentation
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.SS "long fsm_struct_journal_unit::usec"
|
||||||
|
|
||||||
|
.IP "\(bu" 2
|
||||||
|
phantom documentation
|
||||||
|
.PP
|
||||||
|
|
||||||
|
.SS "long fsm_struct_journal_unit::yy_dd_mm"
|
||||||
|
|
||||||
|
.IP "\(bu" 2
|
||||||
|
phantom documentation
|
||||||
|
.PP
|
||||||
|
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
.TH "fsm_struct_list_data" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
fsm_struct_list_data \- phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
\fC#include <fsm\&.h>\fP
|
||||||
|
.SS "Public Attributes"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.ti -1c
|
||||||
|
.RI "int \fBvalue\fP"
|
||||||
|
.br
|
||||||
|
.RI "*value phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "struct \fBfsm_struct_list_data\fP * \fBsuiv\fP"
|
||||||
|
.br
|
||||||
|
.RI "*suiv phantom documentation "
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
.TH "fsm_struct_list_disp" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
fsm_struct_list_disp \- phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
\fC#include <fsm\&.h>\fP
|
||||||
|
.SS "Public Attributes"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.ti -1c
|
||||||
|
.RI "int \fBvalue\fP"
|
||||||
|
.br
|
||||||
|
.RI "*value phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "struct \fBfsm_struct_list_disp\fP * \fBsuiv\fP"
|
||||||
|
.br
|
||||||
|
.RI "*suiv phantom documentation "
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
.TH "fsm_struct_list_tool" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||||||
|
.ad l
|
||||||
|
.nh
|
||||||
|
.SH NAME
|
||||||
|
fsm_struct_list_tool \- phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.br
|
||||||
|
.PP
|
||||||
|
.PP
|
||||||
|
\fC#include <fsm\&.h>\fP
|
||||||
|
.SS "Public Attributes"
|
||||||
|
|
||||||
|
.in +1c
|
||||||
|
.ti -1c
|
||||||
|
.RI "int \fBvalue\fP"
|
||||||
|
.br
|
||||||
|
.RI "*value phantom documentation "
|
||||||
|
.ti -1c
|
||||||
|
.RI "struct \fBfsm_struct_list_tool\fP * \fBsuiv\fP"
|
||||||
|
.br
|
||||||
|
.RI "*suiv phantom documentation "
|
||||||
|
.in -1c
|
||||||
|
.SH "Detailed Description"
|
||||||
|
.PP
|
||||||
|
phantom documentation used to test the functioning of doxygen
|
||||||
|
|
||||||
|
.SH "Author"
|
||||||
|
.PP
|
||||||
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue