Return to mandoc_headers.3 CVS log | Up to [cvsweb.bsd.lv] / mandoc |
version 1.26, 2018/12/13 11:55:46 | version 1.28, 2018/12/14 06:33:14 | ||
---|---|---|---|
|
|
||
Requires | Requires | ||
.In sys/types.h | .In sys/types.h | ||
for | for | ||
.Vt size_t . | .Vt size_t | ||
and | |||
.In stdio.h | |||
for | |||
.Vt FILE . | |||
.Pp | .Pp | ||
Provides | Provides | ||
.Vt enum mandoc_esc , | .Vt enum mandoc_esc , | ||
.Vt enum mandocerr , | .Vt enum mandocerr , | ||
.Vt enum mandoclevel , | .Vt enum mandoclevel , | ||
the function prototype typedef | |||
.Fn mandocmsg , | |||
the function | the function | ||
.Xr mandoc_escape 3 , | .Xr mandoc_escape 3 , | ||
and the functions described in | the functions described in | ||
.Xr mchars_alloc 3 . | .Xr mchars_alloc 3 , | ||
and the | |||
.Fn mandoc_msg* | |||
functions. | |||
.It Qq Pa roff.h | .It Qq Pa roff.h | ||
Common data types for all syntax trees and related functions; | Common data types for all syntax trees and related functions; | ||
can be used everywhere. | can be used everywhere. | ||
|
|
||
for | for | ||
.Vt enum mandoc_os . | .Vt enum mandoc_os . | ||
.Pp | .Pp | ||
Uses to opaque type | Uses the opaque type | ||
.Vt struct mparse | .Vt struct mparse | ||
from | from | ||
.Pa read.c | .Pa read.c | ||
|
|
||
described in | described in | ||
.Xr mandoc 3 . | .Xr mandoc 3 . | ||
.Pp | .Pp | ||
Uses the opaque type | |||
.Vt struct mparse | |||
from | |||
.Pa read.c | |||
for function prototypes. | |||
Uses the type | Uses the type | ||
.Vt struct roff_man | .Vt struct roff_man | ||
from | from | ||
|
|
||
utility functions needed by multiple parsers, | utility functions needed by multiple parsers, | ||
and the top-level functions to call the parsers. | and the top-level functions to call the parsers. | ||
.Pp | .Pp | ||
Uses the opaque types | Uses the opaque type | ||
.Vt struct mparse | |||
from | |||
.Pa read.c | |||
and | |||
.Vt struct roff | .Vt struct roff | ||
from | from | ||
.Pa roff.c | .Pa roff.c | ||
|
|
||
and | and | ||
.Fn eqn_reset . | .Fn eqn_reset . | ||
.Pp | .Pp | ||
Uses the opaque type | |||
.Vt struct mparse | |||
from | |||
.Pa read.c | |||
for function prototypes. | |||
Uses the type | Uses the type | ||
.Vt struct eqn_box | .Vt struct eqn_box | ||
from | from | ||
|
|
||
Provides the functions documented in | Provides the functions documented in | ||
.Xr tbl 3 . | .Xr tbl 3 . | ||
.Pp | .Pp | ||
Uses the opaque type | |||
.Vt struct mparse | |||
from | |||
.Pa read.c . | |||
Uses the types | Uses the types | ||
.Vt struct tbl_span | .Vt struct tbl_span | ||
from | from | ||
|
|
||
.Fn tbl_cdata , | .Fn tbl_cdata , | ||
and | and | ||
.Fn tbl_reset . | .Fn tbl_reset . | ||
.Pp | |||
Uses a pointer to the opaque type | |||
.Vt struct mparse | |||
from | |||
.Pa read.c | |||
as an opaque struct member. | |||
.Pp | .Pp | ||
When this header is included, the same file should not include | When this header is included, the same file should not include | ||
interfaces of different parsers. | interfaces of different parsers. |