version 1.2, 2010/06/26 15:22:19 |
version 1.10, 2011/01/01 16:18:39 |
|
|
.Nm roff_endparse , |
.Nm roff_endparse , |
.Nm roff_free , |
.Nm roff_free , |
.Nm roff_parseln , |
.Nm roff_parseln , |
.Nm roff_reset |
.Nm roff_reset , |
|
.Nm roff_span |
.Nd roff macro compiler library |
.Nd roff macro compiler library |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.In mandoc.h |
.In mandoc.h |
.In regs.h |
|
.In roff.h |
.In roff.h |
.Ft "struct roff *" |
.Ft "struct roff *" |
.Fn roff_alloc "mandocmsg msgs" "void *data" |
.Fo roff_alloc |
.Ft int |
.Fa "struct regset *regs" |
|
.Fa "void *data" |
|
.Fa "mandocmsg msgs" |
|
.Fc |
|
.Ft void |
.Fn roff_endparse "struct roff *roff" |
.Fn roff_endparse "struct roff *roff" |
.Ft void |
.Ft void |
.Fn roff_free "struct roff *roff" |
.Fn roff_free "struct roff *roff" |
|
|
.Fc |
.Fc |
.Ft void |
.Ft void |
.Fn roff_reset "struct roff *roff" |
.Fn roff_reset "struct roff *roff" |
|
.Ft "const struct tbl_span *" |
|
.Fn roff_span "const struct roff *roff" |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
|
|
.Fa data |
.Fa data |
pointer is passed to |
pointer is passed to |
.Fa msgs . |
.Fa msgs . |
The |
|
.Fa pflags |
|
arguments are defined in |
|
.Pa roff.h . |
|
Returns NULL on failure. |
Returns NULL on failure. |
If non-NULL, the pointer must be freed with |
If non-NULL, the pointer must be freed with |
.Fn roff_free . |
.Fn roff_free . |
Line 139 This line should not contain the trailing newline. |
|
Line 141 This line should not contain the trailing newline. |
|
Returns 0 on failure, 1 on success. |
Returns 0 on failure, 1 on success. |
.It Fn roff_endparse |
.It Fn roff_endparse |
Signals that the parse is complete. |
Signals that the parse is complete. |
Returns 0 on failure, 1 on success. |
.It Fn roff_span |
|
If |
|
.Fn roff_parseln |
|
returned |
|
.Va ROFF_TBL , |
|
return the last parsed table row. |
|
Returns NULL otherwise. |
.El |
.El |
.Sh EXAMPLES |
.Sh EXAMPLES |
See |
See |
|
|
.Nm |
.Nm |
library was written by |
library was written by |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
|
.Sh BUGS |
|
The implementation of user-defined strings needs improvement: |
|
.Bl -dash |
|
.It |
|
String values are taken literally and are not interpreted. |
|
.It |
|
Parsing of quoted strings is incomplete. |
|
.It |
|
The stings are stored internally using a singly linked list, |
|
which is fine for small numbers of strings, |
|
but ineffient when handling many strings. |
|
.El |