213 lines
3.7 KiB
Groff
213 lines
3.7 KiB
Groff
|
.TH "src/util/parse.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/util/parse.c \- Gem-graph-client arsing functions\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fC#include <libxml/parser\&.h>\fP
|
||
|
|
.br
|
||
|
|
\fC#include <libxml/xmlreader\&.h>\fP
|
||
|
|
.br
|
||
|
|
\fC#include '\&.\&./\&.\&./include/base\&.h'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Macros"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "#define \fBREAD_SITE\fP 1 << 0"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "#define \fBREAD_WEIGHT\fP 1 << 1"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "#define \fBREAD_X\fP 1 << 2"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "#define \fBREAD_Y\fP 1 << 3"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "#define \fBREAD_Z\fP 1 << 4"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "#define \fBSUCCESSFUL_READ_ARROW_X\fP (\fBREAD_SITE\fP | \fBREAD_WEIGHT\fP | \fBREAD_X\fP)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "#define \fBSUCCESSFUL_READ_ARROW_XY\fP (\fBREAD_SITE\fP | \fBREAD_WEIGHT\fP | \fBREAD_X\fP | \fBREAD_Y\fP)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "#define \fBSUCCESSFUL_READ_ARROW_XYZ\fP (\fBREAD_SITE\fP | \fBREAD_WEIGHT\fP | \fBREAD_X\fP | \fBREAD_Y\fP | \fBREAD_Z\fP)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "bool \fBparse_parse_model_init\fP (const char *content, size_t length, const char *basename)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "bool \fBparse_model_shutdown\fP (void)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "char \fBparse_model_get_dim\fP (void)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "long \fBparse_model_get_dim_value\fP (const char *axis)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "char \fBparse_model_get_multiplicity\fP (void)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "bool \fBparse_model_get_next_state\fP (char *new_state_id)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "long \fBparse_model_get_state_arrows_count\fP (const char *state_id)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "bool \fBparse_model_get_next_arrow\fP (struct \fBarrow_t\fP *new_arrow, const char *state_id, char dimension)"
|
||
|
|
.br
|
||
|
|
.RI "Phantom documentation\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
Gem-graph-client arsing functions\&.
|
||
|
|
|
||
|
|
This file is part of Gem-graph\&.
|
||
|
|
.SH "Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "char parse_model_get_dim (void)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Phantom documentation\&.
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
char
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "long parse_model_get_dim_value (const char * axis)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Phantom documentation\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*axis\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
long
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "char parse_model_get_multiplicity (void)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Phantom documentation\&.
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
char
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "bool parse_model_get_next_arrow (struct \fBarrow_t\fP * new_arrow, const char * state_id, char dimension)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Phantom documentation\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*new_arrow\fP
|
||
|
|
.br
|
||
|
|
\fI*state_id\fP
|
||
|
|
.br
|
||
|
|
\fIdimension\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
bool
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "bool parse_model_get_next_state (char * new_state_id)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Phantom documentation\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*new_state_id\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
bool
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "long parse_model_get_state_arrows_count (const char * state_id)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Phantom documentation\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*state_id\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
long
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "bool parse_model_shutdown (void)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Phantom documentation\&. returns bool
|
||
|
|
.SS "bool parse_parse_model_init (const char * content, size_t length, const char * basename)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Phantom documentation\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fI*content\fP
|
||
|
|
.br
|
||
|
|
\fIlength\fP
|
||
|
|
.br
|
||
|
|
\fI*basename\fP
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
bool
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|