version 1.11, 2011/06/22 22:10:02 |
version 1.15, 2011/10/18 13:25:38 |
|
|
.Nm mandoc , |
.Nm mandoc , |
.Nm mandoc_escape , |
.Nm mandoc_escape , |
.Nm man_meta , |
.Nm man_meta , |
|
.Nm man_mparse , |
.Nm man_node , |
.Nm man_node , |
.Nm mchars_alloc , |
.Nm mchars_alloc , |
.Nm mchars_free , |
.Nm mchars_free , |
|
|
.Nm mdoc_node , |
.Nm mdoc_node , |
.Nm mparse_alloc , |
.Nm mparse_alloc , |
.Nm mparse_free , |
.Nm mparse_free , |
|
.Nm mparse_getkeep , |
|
.Nm mparse_keep , |
.Nm mparse_readfd , |
.Nm mparse_readfd , |
.Nm mparse_reset , |
.Nm mparse_reset , |
.Nm mparse_result , |
.Nm mparse_result , |
|
|
.In mandoc.h |
.In mandoc.h |
.Ft "enum mandoc_esc" |
.Ft "enum mandoc_esc" |
.Fo mandoc_escape |
.Fo mandoc_escape |
.Fa "const char **in" |
.Fa "const char **end" |
.Fa "const char **seq" |
.Fa "const char **start" |
.Fa "int *len" |
.Fa "int *sz" |
.Fc |
.Fc |
.Ft "const struct man_meta *" |
.Ft "const struct man_meta *" |
.Fo man_meta |
.Fo man_meta |
.Fa "const struct man *man" |
.Fa "const struct man *man" |
.Fc |
.Fc |
|
.Ft "const struct mparse *" |
|
.Fo man_mparse |
|
.Fa "const struct man *man" |
|
.Fc |
.Ft "const struct man_node *" |
.Ft "const struct man_node *" |
.Fo man_node |
.Fo man_node |
.Fa "const struct man *man" |
.Fa "const struct man *man" |
|
|
.Fo mparse_free |
.Fo mparse_free |
.Fa "struct mparse *parse" |
.Fa "struct mparse *parse" |
.Fc |
.Fc |
|
.Ft void |
|
.Fo mparse_getkeep |
|
.Fa "const struct mparse *parse" |
|
.Fc |
|
.Ft void |
|
.Fo mparse_keep |
|
.Fa "struct mparse *parse" |
|
.Fc |
.Ft "enum mandoclevel" |
.Ft "enum mandoclevel" |
.Fo mparse_readfd |
.Fo mparse_readfd |
.Fa "struct mparse *parse" |
.Fa "struct mparse *parse" |
|
|
.It Vt "enum mparset" |
.It Vt "enum mparset" |
The type of parser when reading input. |
The type of parser when reading input. |
This should usually be |
This should usually be |
.Va MPARSE_AUTO |
.Dv MPARSE_AUTO |
for auto-detection. |
for auto-detection. |
.It Vt "struct mparse" |
.It Vt "struct mparse" |
An opaque pointer to a running parse sequence. |
An opaque pointer to a running parse sequence. |
Line 222 Scan an escape sequence, i.e., a character string begi |
|
Line 237 Scan an escape sequence, i.e., a character string begi |
|
Pass a pointer to this string as |
Pass a pointer to this string as |
.Va end ; |
.Va end ; |
it will be set to the supremum of the parsed escape sequence unless |
it will be set to the supremum of the parsed escape sequence unless |
returning ESCAPE_ERROR, in which case the string is bogus and should be |
returning |
|
.Dv ESCAPE_ERROR , |
|
in which case the string is bogus and should be |
thrown away. |
thrown away. |
If not ESCAPE_ERROR or ESCAPE_IGNORE, |
If not |
|
.Dv ESCAPE_ERROR |
|
or |
|
.Dv ESCAPE_IGNORE , |
.Va start |
.Va start |
is set to the first relevant character of the substring (font, glyph, |
is set to the first relevant character of the substring (font, glyph, |
whatever) of length |
whatever) of length |
|
|
.Va start |
.Va start |
and |
and |
.Va sz |
.Va sz |
may be NULL. |
may be |
|
.Dv NULL . |
.It Fn man_meta |
.It Fn man_meta |
Obtain the meta-data of a successful parse. |
Obtain the meta-data of a successful parse. |
This may only be used on a pointer returned by |
This may only be used on a pointer returned by |
.Fn mparse_result . |
.Fn mparse_result . |
|
.It Fn man_mparse |
|
Get the parser used for the current output. |
.It Fn man_node |
.It Fn man_node |
Obtain the root node of a successful parse. |
Obtain the root node of a successful parse. |
This may only be used on a pointer returned by |
This may only be used on a pointer returned by |
Line 267 Convert a special character into a valid Unicode codep |
|
Line 290 Convert a special character into a valid Unicode codep |
|
Returns \-1 on failure or a non-zero Unicode codepoint on success. |
Returns \-1 on failure or a non-zero Unicode codepoint on success. |
.It Fn mchars_spec2str |
.It Fn mchars_spec2str |
Convert a special character into an ASCII string. |
Convert a special character into an ASCII string. |
Returns NULL on failure. |
Returns |
|
.Dv NULL |
|
on failure. |
.It Fn mdoc_meta |
.It Fn mdoc_meta |
Obtain the meta-data of a successful parse. |
Obtain the meta-data of a successful parse. |
This may only be used on a pointer returned by |
This may only be used on a pointer returned by |
Line 286 must be called to free the memory allocated by this fu |
|
Line 311 must be called to free the memory allocated by this fu |
|
.It Fn mparse_free |
.It Fn mparse_free |
Free all memory allocated by |
Free all memory allocated by |
.Fn mparse_alloc . |
.Fn mparse_alloc . |
|
.It Fn mparse_getkeep |
|
Acquire the keep buffer. |
|
Must follow a call of |
|
.Fn mparse_keep . |
|
.It Fn mparse_keep |
|
Instruct the parser to retain a copy of its parsed input. |
|
This can be acquired with subsequent |
|
.Fn mparse_getkeep |
|
calls. |
.It Fn mparse_readfd |
.It Fn mparse_readfd |
Parse a file or file descriptor. |
Parse a file or file descriptor. |
If |
If |
Line 560 levels of badly-nested blocks. |
|
Line 594 levels of badly-nested blocks. |
|
The |
The |
.Nm |
.Nm |
library was written by |
library was written by |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
.An Kristaps Dzonsons , |
|
.Mt kristaps@bsd.lv . |