214 lines
4.1 KiB
Groff
214 lines
4.1 KiB
Groff
|
.TH "src/log.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/log.c \- journal / log
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fC#include <stdio\&.h>\fP
|
||
|
|
.br
|
||
|
|
\fC#include <stdlib\&.h>\fP
|
||
|
|
.br
|
||
|
|
\fC#include <time\&.h>\fP
|
||
|
|
.br
|
||
|
|
\fC#include <string\&.h>\fP
|
||
|
|
.br
|
||
|
|
\fC#include <sys/time\&.h>\fP
|
||
|
|
.br
|
||
|
|
\fC#include '\&.\&./include/fsm\&.h'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fBfsm_init_log\fP (\fBfsm_log_struct\fP *jj)"
|
||
|
|
.br
|
||
|
|
.RI "init the journal "
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fBfsm_clear_log\fP (\fBfsm_log_struct\fP *jj, const char *file_source, const char *function_source, const char *string_value)"
|
||
|
|
.br
|
||
|
|
.RI "usefulness ? (systematic ^c) "
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fBfsm_add_log_event\fP (\fBfsm_log_struct\fP *jj, const char *file_source, const char *function_source, const char *string_value)"
|
||
|
|
.br
|
||
|
|
.RI "add an event "
|
||
|
|
.ti -1c
|
||
|
|
.RI "long \fBfsm_pop_back_log\fP (\fBfsm_log_struct\fP *jj, const char *file_source, const char *function_source, const char *string_value)"
|
||
|
|
.br
|
||
|
|
.RI "remove an event "
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fBfsm_length_log\fP (\fBfsm_log_struct\fP jj)"
|
||
|
|
.br
|
||
|
|
.RI "get journal_length "
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fBfsm_seek_log\fP (\fBfsm_log_struct\fP jj, long usec, const char *file_source, const char *function_source, const char *string_value)"
|
||
|
|
.br
|
||
|
|
.RI "seek for an event "
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fBfsm_publish_log\fP (\fBfsm_log_struct\fP jj)"
|
||
|
|
.br
|
||
|
|
.RI "publish all the logs today just print in the console TODO > in a file "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
journal / log
|
||
|
|
|
||
|
|
This file is part of Gem-graph\&. The journal stores chronologically the events during a session run (rules exec, mainly)
|
||
|
|
.PP
|
||
|
|
What types of events should be reported ? (fsm, widgets, \&.\&.\&. ) For what purpose ? What information must be collected and transmitted ? How to name and classify this information ? How to present it ?
|
||
|
|
.PP
|
||
|
|
date key (rank) source file source function +/- value
|
||
|
|
.PP
|
||
|
|
(notes) time_t current_time = time(NULL); < Check if the time retrieval was successful if (current_time == ((time_t)-1)) printf('Error getting current time\&.\\n'); Convert to local time format and print printf(' Current timestamp: %ld %s\\n', current_time, message); printf(' Current time: %s', ctime(¤t_time));
|
||
|
|
.SH "Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "void fsm_add_log_event (\fBfsm_log_struct\fP * jj, const char * file_source, const char * function_source, const char * string_value)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
add an event
|
||
|
|
.PP
|
||
|
|
\fBSince\fP
|
||
|
|
.RS 4
|
||
|
|
2024-09
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*jj\fP
|
||
|
|
.br
|
||
|
|
\fI*file_source\fP
|
||
|
|
.br
|
||
|
|
\fI*function_source\fP
|
||
|
|
.br
|
||
|
|
\fI*string_value\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "void fsm_clear_log (\fBfsm_log_struct\fP * jj, const char * file_source, const char * function_source, const char * string_value)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
usefulness ? (systematic ^c)
|
||
|
|
.PP
|
||
|
|
\fBSince\fP
|
||
|
|
.RS 4
|
||
|
|
2024-09
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*jj\fP
|
||
|
|
.br
|
||
|
|
\fI*file_source\fP
|
||
|
|
.br
|
||
|
|
\fI*function_source\fP
|
||
|
|
.br
|
||
|
|
\fI*string_value\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "void fsm_init_log (\fBfsm_log_struct\fP * jj)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
init the journal
|
||
|
|
.PP
|
||
|
|
\fBSince\fP
|
||
|
|
.RS 4
|
||
|
|
2024-09
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*jj\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "int fsm_length_log (\fBfsm_log_struct\fP jj)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
get journal_length
|
||
|
|
.PP
|
||
|
|
\fBSince\fP
|
||
|
|
.RS 4
|
||
|
|
2024-09
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*jj\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
journal length
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "long fsm_pop_back_log (\fBfsm_log_struct\fP * jj, const char * file_source, const char * function_source, const char * string_value)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
remove an event
|
||
|
|
.PP
|
||
|
|
\fBSince\fP
|
||
|
|
.RS 4
|
||
|
|
2024-09
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*jj\fP
|
||
|
|
.br
|
||
|
|
\fI*file_source\fP
|
||
|
|
.br
|
||
|
|
\fI*function_source\fP
|
||
|
|
.br
|
||
|
|
\fI*string_value\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "void fsm_publish_log (\fBfsm_log_struct\fP jj)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
publish all the logs today just print in the console TODO > in a file
|
||
|
|
.PP
|
||
|
|
\fBSince\fP
|
||
|
|
.RS 4
|
||
|
|
2024-09
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*jj\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "void fsm_seek_log (\fBfsm_log_struct\fP jj, long usec, const char * file_source, const char * function_source, const char * string_value)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
seek for an event
|
||
|
|
.PP
|
||
|
|
\fBSince\fP
|
||
|
|
.RS 4
|
||
|
|
2024-09
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*jj\fP
|
||
|
|
.br
|
||
|
|
\fIusec\fP
|
||
|
|
.br
|
||
|
|
\fI*file_source\fP
|
||
|
|
.br
|
||
|
|
\fI*function_source\fP
|
||
|
|
.br
|
||
|
|
\fI*string_value\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|