version 1.19, 2009/03/16 23:37:28 |
version 1.22, 2009/03/22 08:52:27 |
|
|
.Nm mdoc_endparse , |
.Nm mdoc_endparse , |
.Nm mdoc_node , |
.Nm mdoc_node , |
.Nm mdoc_meta , |
.Nm mdoc_meta , |
.Nm mdoc_free |
.Nm mdoc_free , |
|
.Nm mdoc_reset |
.Nd mdoc macro compiler library |
.Nd mdoc macro compiler library |
.\" SECTION |
.\" SECTION |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
|
|
.Vt extern const char * const * mdoc_macronames; |
.Vt extern const char * const * mdoc_macronames; |
.Vt extern const char * const * mdoc_argnames; |
.Vt extern const char * const * mdoc_argnames; |
.Ft "struct mdoc *" |
.Ft "struct mdoc *" |
.Fn mdoc_alloc "void *data" "const struct mdoc_cb *cb" |
.Fn mdoc_alloc "void *data" "int pflags" "const struct mdoc_cb *cb" |
.Ft void |
.Ft void |
|
.Fn mdoc_reset "struct mdoc *mdoc" |
|
.Ft void |
.Fn mdoc_free "struct mdoc *mdoc" |
.Fn mdoc_free "struct mdoc *mdoc" |
.Ft int |
.Ft int |
.Fn mdoc_parseln "struct mdoc *mdoc" "int line" "char *buf" |
.Fn mdoc_parseln "struct mdoc *mdoc" "int line" "char *buf" |
|
|
.Fn mdoc_meta , |
.Fn mdoc_meta , |
then free all allocated memory with |
then free all allocated memory with |
.Fn mdoc_free . |
.Fn mdoc_free . |
See the |
The |
|
.Fn mdoc_reset |
|
function may be used in order to reset the parser for another input |
|
sequence. See the |
.Sx EXAMPLES |
.Sx EXAMPLES |
section for a full example. |
section for a full example. |
.\" PARAGRAPH |
.\" PARAGRAPH |
Line 123 Allocates a parsing structure. The |
|
Line 129 Allocates a parsing structure. The |
|
.Fa data |
.Fa data |
pointer is passed to callbacks in |
pointer is passed to callbacks in |
.Fa cb , |
.Fa cb , |
which are documented further in the header file. Returns NULL on |
which are documented further in the header file. |
failure. If non-NULL, the pointer must be freed with |
The |
|
.Fa pflags |
|
arguments are defined in |
|
.Pa mdoc.h . |
|
Returns NULL on failure. If non-NULL, the pointer must be freed with |
.Fn mdoc_free . |
.Fn mdoc_free . |
.\" LIST-ITEM |
.\" LIST-ITEM |
|
.It Fn mdoc_reset |
|
Reset the parser for another parse routine. After its use, |
|
.Fn mdoc_parseln |
|
behaves as if invoked for the first time. |
|
.\" LIST-ITEM |
.It Fn mdoc_free |
.It Fn mdoc_free |
Free all resources of a parser. The pointer is no longer valid after |
Free all resources of a parser. The pointer is no longer valid after |
invocation. |
invocation. |
Line 285 mdoc_free(mdoc); |
|
Line 300 mdoc_free(mdoc); |
|
.Ed |
.Ed |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mdocterm 1 , |
.Xr mandoc 1 , |
.Xr mdoclint 1 , |
|
.Xr mdoctree 1 , |
|
.Xr mdoc 7 |
.Xr mdoc 7 |
.\" SECTION |
.\" SECTION |
.Sh AUTHORS |
.Sh AUTHORS |
|
|
The |
The |
.Sq \&Bsx |
.Sq \&Bsx |
macro doesn't yet understand version arguments. |
macro doesn't yet understand version arguments. |
|
.\" LIST-ITEM |
|
.It |
|
If not given a value, the \-offset argument to |
|
.Sq \&Bd |
|
and |
|
.Sq \&Bl |
|
should by the width of |
|
.Qq <string> . |
|
.\" LIST-ITEM |
|
.It |
|
Columns widths in |
|
.Sq \&Bl -column |
|
should default to width |
|
.Qq <stringx> |
|
if not included. |
|
.\" LIST-ITEM |
|
.It |
|
List-width suffix |
|
.Qq m |
|
isn't handled. |
|
.\" LIST-ITEM |
|
.It |
|
Contents of the SYNOPSIS section aren't checked. |
.El |
.El |