kolan
/
dev
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added structures descriptions to tex_parser.h

This commit is contained in:
Kolan Sh 2011-07-06 16:24:24 +04:00
parent 555a361cd0
commit 7f83d32500
1 changed files with 36 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
c/tex_parser/tex_parser.h
View File

@ -8,15 +8,15 @@
#define TEX_PARSER_DOMAIN 0 #define TEX_PARSER_DOMAIN 0
/** /**
* enum tex_parser_error - the LaTeX parser error code * enum tex_parser_error - the LaTeX parser error codes
* *
* @TEX_PARSER_NOERROR: Default state indicates no error. * @TEX_PARSER_NOERROR: Default state indicates no error.
* @TEX_PARSER_ERROR_UNKNOWN: * @TEX_PARSER_ERROR_UNKNOWN: Uncontrolled error happen
* @TEX_PARSER_ERROR_STACK: * @TEX_PARSER_ERROR_STACK: Stack overflow
* @TEX_PARSER_ERROR_PLACE_UNKNOWN: * @TEX_PARSER_ERROR_PLACE_UNKNOWN: Unknown place (internal error)
* @TEX_PARSER_ERROR_UNEXPECTED_SYMBOL: * @TEX_PARSER_ERROR_UNEXPECTED_SYMBOL: Unexpected symbol for current place
* *
* Need some description here... * Defines parser error codes, @TEX_PARSER_NOERROR = %0 is equivalent to no errors.
*/ */
enum tex_parser_error { enum tex_parser_error {
TEX_PARSER_NOERROR = 0, TEX_PARSER_NOERROR = 0,
@ -29,9 +29,12 @@ enum tex_parser_error {
/** /**
* struct tex_table_row_s - LaTeX table row * struct tex_table_row_s - LaTeX table row
* *
* @cells: * @over_line: Text over row (\hline for ex.)
* @row_line: * @cells: Row cells
* @under_line: Text under row (\cline{2-4} for ex.)
* *
* @over_line, @cells, @under_line uses zalloc*() functions which stores
* array dimensions.
*/ */
struct tex_table_row_s { struct tex_table_row_s {
char *over_line; // \hline, \cline{4-5} etc. char *over_line; // \hline, \cline{4-5} etc.
@ -42,31 +45,40 @@ struct tex_table_row_s {
/** /**
* struct tex_table_s - LaTeX table * struct tex_table_s - LaTeX table
* *
* @document_offset: * @document_offset: Table offset (in symbols) in the LaTeX document
* @document_size: * @document_size: Table size (in symbols) in the LaTeX document
* @id: * @id: Id in report generator context (Request.Drossel1.Table1 for ex.)
* @col_props: * @col_props: Column properties devided by '>' symbol
* @head_table: * @head_table: Top rows devided by & and automaticaly added on page break
* @foot_table: * @foot_table: Bottom rows devided by & and automaticaly added on page break
* @main_table: * @main_table: Central rows which can be devided horizontally and vertically
*
* @col_props, @head_table, @foot_table, @main_table uses zalloc*() functions to
* determine array dimensions.
*/ */
struct tex_table_s { struct tex_table_s {
size_t document_offset; // offset (in sybmols) in the LaTeX document size_t document_offset;
size_t document_size; // size (in symbols) in the LaTeX document size_t document_size;
char *id; // "Drossel1.Table1" char *id;
char **col_props; // divided by > char **col_props;
struct tex_table_row_s *head_table; // divided by & struct tex_table_row_s *head_table;
struct tex_table_row_s *foot_table; // divided by & and \tabularnewline struct tex_table_row_s *foot_table;
struct tex_table_row_s *main_table; // divided by & and \tabularnewline struct tex_table_row_s *main_table;
}; };
/** /**
* struct tex_graphics - LaTeX graphics * struct tex_graphics - LaTeX graphics
* *
* @something: * @prestr: Preceding string
* @path: Path to image file
* @poststr: Descendant string
*
* Need some description here...
*/ */
struct tex_graphics { struct tex_graphics {
void *something; char *prestr;
char *path;
char *poststr;
}; };
/** /**