gem-graph-client/doc/rtfm/man3/util.h.3

.TH "include/util.h" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
include/util.h \- utilities header  

.SH SYNOPSIS
.br
.PP
\fC#include <stdbool\&.h>\fP
.br
\fC#include <stddef\&.h>\fP
.br
\fC#include <gtk\-4\&.0/gtk/gtk\&.h>\fP
.br
\fC#include '\&.\&./include/fsm\&.h'\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBpile\fP"
.br
.RI "phantom documentation "
.ti -1c
.RI "struct \fBelem\fP"
.br
.RI "simplest element of a double-chained list "
.ti -1c
.RI "struct \fBdblist\fP"
.br
.RI "required to init the empty list "
.ti -1c
.RI "struct \fBslist\fP"
.br
.RI "phantom documentation "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef struct \fBpile\fP \fBpile\fP"
.br
.RI "phantom documentation "
.ti -1c
.RI "typedef struct \fBelem\fP \fBelem\fP"
.br
.RI "simplest element of a double-chained list "
.ti -1c
.RI "typedef struct \fBslist\fP \fBslist\fP"
.br
.RI "phantom documentation "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "char * \fButil_read_file\fP (char *filename)"
.br
.RI "reads a file from filename into a provided buffer "
.ti -1c
.RI "char * \fButil_concat\fP (const char *str,\&.\&.\&.)"
.br
.RI "https://sourceware.org/glibc/manual/latest/html_mono/libc.html#Variadic-Prototypes "
.ti -1c
.RI "void \fButil_pile_clear\fP (\fBpile\fP **)"
.br
.ti -1c
.RI "void \fButil_pile_view\fP (\fBpile\fP *)"
.br
.ti -1c
.RI "int \fButil_pile_push\fP (\fBpile\fP **, int)"
.br
.ti -1c
.RI "int \fButil_pile_pop\fP (\fBpile\fP **)"
.br
.ti -1c
.RI "int \fButil_pile_length\fP (\fBpile\fP *p)"
.br
.ti -1c
.RI "void \fButil_list_2x2_init\fP (\fBdblist\fP *l)"
.br
.RI "Phantom documentation\&. "
.ti -1c
.RI "void \fButil_list_2x2_clear\fP (\fBdblist\fP *l)"
.br
.RI "Phantom documentation\&. "
.ti -1c
.RI "void \fButil_list_2x2_view\fP (\fBdblist\fP l)"
.br
.RI "Phantom documentation\&. "
.ti -1c
.RI "int \fButil_list_2x2_push_back\fP (\fBdblist\fP *l, int val)"
.br
.RI "Phantom documentation\&. "
.ti -1c
.RI "int \fButil_list_2x2_push_front\fP (\fBdblist\fP *l, int val)"
.br
.RI "Phantom documentation\&. "
.ti -1c
.RI "int \fButil_list_2x2_pop_back\fP (\fBdblist\fP *l)"
.br
.RI "Phantom documentation\&. "
.ti -1c
.RI "int \fButil_list_2x2_pop_front\fP (\fBdblist\fP *l)"
.br
.RI "Phantom documentation\&. "
.ti -1c
.RI "int \fButil_list_2x2_length\fP (\fBdblist\fP l)"
.br
.RI "Phantom documentation\&. "
.ti -1c
.RI "void \fButil_sorted_list_clear\fP (\fBslist\fP **sl)"
.br
.ti -1c
.RI "void \fButil_sorted_list_view\fP (\fBslist\fP *sl)"
.br
.ti -1c
.RI "int \fButil_sorted_list_insert\fP (\fBslist\fP **sl, int val)"
.br
.ti -1c
.RI "int \fButil_sorted_list_pop\fP (\fBslist\fP **sl)"
.br
.ti -1c
.RI "int \fButil_sorted_list_length\fP (\fBslist\fP *sl)"
.br
.ti -1c
.RI "void \fButil_trigger_test\fP ()"
.br
.RI "simplifying utilities tests "
.ti -1c
.RI "void \fButil_test_pile\fP ()"
.br
.RI "sample test "
.ti -1c
.RI "void \fButil_test_double_list\fP ()"
.br
.RI "sample test "
.ti -1c
.RI "void \fButil_test_sorted_list\fP ()"
.br
.RI "sample test "
.ti -1c
.RI "long \fButil_gl_get_stack\fP (void *container_widget)"
.br
.RI "Look for stack entry and returns stack_id\&. "
.ti -1c
.RI "bool \fButil_gl_init_stack\fP (void *container_widget, GError *error_buffer)"
.br
.RI "Look for stack entry and initializes OpenGL for it\&. "
.ti -1c
.RI "bool \fButil_gl_shutdown_stack\fP (void *container_widget, GError *error_buffer)"
.br
.RI "Look for stack entry and shutdowns OpenGL for it\&. "
.ti -1c
.RI "void \fButil_gl_clean_stack_index\fP (void)"
.br
.RI "phantom documentation "
.ti -1c
.RI "bool \fButil_gl_render_stack\fP (GtkWidget *container_widget)"
.br
.RI "Look for stack entry and triggers OpenGL for drawing\&. "
.ti -1c
.RI "bool \fButil_gl_update_axis\fP (GtkWidget *container_widget, int axis, int value)"
.br
.RI "Look for stack entry and triggers OpenGL for drawing\&. "
.ti -1c
.RI "void \fButil_gl_shutdown_all_stacks\fP (void)"
.br
.RI "Look for every stack entry and shutdowns OpenGL for it\&. "
.ti -1c
.RI "GtkWidget * \fBcreate_axis_slider\fP (int axis)"
.br
.RI "Creates a slider widget\&. "
.in -1c
.SH "Detailed Description"
.PP 
utilities header 

This file is part of Gem-graph\&. 
.SH "Function Documentation"
.PP 
.SS "GtkWidget * create_axis_slider (int axis)"

.PP
Creates a slider widget\&. 
.PP
\fBParameters\fP
.RS 4
\fIaxis\fP meaning which axis we're building (for label)
.RE
.PP
\fBReturns\fP
.RS 4
GtkWidget* pointer to the new widget 
.RE
.PP

.SS "char * util_concat (const char * str,  \&.\&.\&.)"

.PP
https://sourceware.org/glibc/manual/latest/html_mono/libc.html#Variadic-Prototypes 
.PP
\fBSee also\fP
.RS 4
(in glibc/manual) > ellipsis (‘…’) A\&.2\&.2\&.2 Receiving the Argument Values
.RE
.PP
\fBParameters\fP
.RS 4
\fI*str\fP 
.br
\fI\&.\&.\&.\fP 
.RE
.PP
\fBReturns\fP
.RS 4
* 
.RE
.PP

.SS "long util_gl_get_stack (void * container_widget)"

.PP
Look for stack entry and returns stack_id\&. 
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP 
.RE
.PP
\fBReturns\fP
.RS 4
stack_id 
.RE
.PP

.SS "bool util_gl_init_stack (void * container_widget, GError * error_buffer)"

.PP
Look for stack entry and initializes OpenGL for it\&. 
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP 
.br
\fI*error_buffer\fP 
.RE
.PP
\fBReturns\fP
.RS 4
success 
.RE
.PP

.SS "bool util_gl_render_stack (GtkWidget * container_widget)"

.PP
Look for stack entry and triggers OpenGL for drawing\&. 
.PP
\fBParameters\fP
.RS 4
\fIcontainer_widget\fP generally the GtkBox that contains the GLArea
.RE
.PP
\fBReturns\fP
.RS 4
bool: true if success 
.RE
.PP

.SS "void util_gl_shutdown_all_stacks (void)"

.PP
Look for every stack entry and shutdowns OpenGL for it\&. DO NOT DOCUMENT param void < argument 'void' of command @ param is not found
.PP
DO NOT DOCUMENT returns bool true if success < does not return anything 
.SS "bool util_gl_shutdown_stack (void * container_widget, GError * error_buffer)"

.PP
Look for stack entry and shutdowns OpenGL for it\&. 
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP 
.br
\fI*error_buffer\fP 
.RE
.PP
\fBReturns\fP
.RS 4
success 
.RE
.PP

.SS "bool util_gl_update_axis (GtkWidget * container_widget, int axis, int value)"

.PP
Look for stack entry and triggers OpenGL for drawing\&. 
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP 
.br
\fIaxis\fP 
.br
\fIvalue\fP 
.RE
.PP
\fBReturns\fP
.RS 4
bool: true if success 
.RE
.PP

.SS "void util_list_2x2_clear (\fBdblist\fP * l)"

.PP
Phantom documentation\&. 
.PP
\fBParameters\fP
.RS 4
\fI*l\fP 
.RE
.PP

.SS "void util_list_2x2_init (\fBdblist\fP * l)"

.PP
Phantom documentation\&. 
.PP
\fBParameters\fP
.RS 4
\fI*l\fP 
.RE
.PP

.SS "int util_list_2x2_length (\fBdblist\fP l)"

.PP
Phantom documentation\&. 
.PP
\fBParameters\fP
.RS 4
\fI*l\fP 
.RE
.PP
\fBReturns\fP
.RS 4
int 
.RE
.PP

.SS "int util_list_2x2_pop_back (\fBdblist\fP * l)"

.PP
Phantom documentation\&. 
.PP
\fBParameters\fP
.RS 4
\fI*l\fP 
.RE
.PP
\fBReturns\fP
.RS 4
int 
.RE
.PP

.SS "int util_list_2x2_pop_front (\fBdblist\fP * l)"

.PP
Phantom documentation\&. 
.PP
\fBParameters\fP
.RS 4
\fI*l\fP 
.RE
.PP
\fBReturns\fP
.RS 4
int 
.RE
.PP

.SS "int util_list_2x2_push_back (\fBdblist\fP * l, int val)"

.PP
Phantom documentation\&. 
.PP
\fBParameters\fP
.RS 4
\fI*l\fP 
.br
\fIval\fP 
.RE
.PP
\fBReturns\fP
.RS 4
int 
.RE
.PP

.SS "int util_list_2x2_push_front (\fBdblist\fP * l, int val)"

.PP
Phantom documentation\&. 
.PP
\fBParameters\fP
.RS 4
\fI*l\fP 
.br
\fIval\fP 
.RE
.PP
\fBReturns\fP
.RS 4
int 
.RE
.PP

.SS "void util_list_2x2_view (\fBdblist\fP l)"

.PP
Phantom documentation\&. 
.PP
\fBParameters\fP
.RS 4
\fI*l\fP 
.RE
.PP

.SS "void util_pile_clear (\fBpile\fP ** p)"

.PP
\fBParameters\fP
.RS 4
\fI**p\fP 
.RE
.PP

.SS "int util_pile_length (\fBpile\fP * p)"

.PP
\fBParameters\fP
.RS 4
\fI**p\fP 
.RE
.PP
\fBReturns\fP
.RS 4
length 
.RE
.PP

.SS "int util_pile_pop (\fBpile\fP ** p)"

.PP
\fBParameters\fP
.RS 4
\fI**p\fP 
.RE
.PP
\fBReturns\fP
.RS 4
value 
.RE
.PP

.SS "int util_pile_push (\fBpile\fP ** p, int value)"

.PP
\fBParameters\fP
.RS 4
\fI**p\fP 
.br
\fIvalue\fP 
.RE
.PP
\fBReturns\fP
.RS 4
value 
.RE
.PP

.SS "void util_pile_view (\fBpile\fP * p)"

.PP
\fBParameters\fP
.RS 4
\fI**p\fP 
.RE
.PP

.SS "char * util_read_file (char * filename)"

.PP
reads a file from filename into a provided buffer 
.PP
\fBParameters\fP
.RS 4
\fI*filename\fP 
.RE
.PP
\fBReturns\fP
.RS 4
char 
.RE
.PP

.SS "void util_sorted_list_clear (\fBslist\fP ** sl)"

.PP
\fBParameters\fP
.RS 4
\fI**sl\fP 
.RE
.PP

.SS "int util_sorted_list_insert (\fBslist\fP ** sl, int value)"

.PP
\fBParameters\fP
.RS 4
\fI**sl\fP 
.br
\fIvalue\fP 
.RE
.PP
\fBReturns\fP
.RS 4
value 
.RE
.PP

.SS "int util_sorted_list_length (\fBslist\fP * sl)"

.PP
\fBParameters\fP
.RS 4
\fI**sl\fP 
.RE
.PP
\fBReturns\fP
.RS 4
length 
.RE
.PP

.SS "int util_sorted_list_pop (\fBslist\fP ** sl)"

.PP
\fBParameters\fP
.RS 4
\fI**sl\fP 
.RE
.PP
\fBReturns\fP
.RS 4
value 
.RE
.PP

.SS "void util_sorted_list_view (\fBslist\fP * sl)"

.PP
\fBParameters\fP
.RS 4
\fI**sl\fP 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for Gem-graph from the source code\&.