version 1.15, 2017/07/01 09:47:30 |
version 1.21, 2018/12/13 02:06:07 |
|
|
.Dd December 1, 2014 |
.Dd $Mdocdate$ |
.Dt MANDOC_HEADERS 3 |
.Dt MANDOC_HEADERS 3 |
.Os |
.Os |
.Sh NAME |
.Sh NAME |
Line 25 separate from each other: |
|
Line 25 separate from each other: |
|
.Pp |
.Pp |
.Bl -dash -offset indent -compact |
.Bl -dash -offset indent -compact |
.It |
.It |
|
.Xr roff 7 |
|
parser |
|
.It |
.Xr mdoc 7 |
.Xr mdoc 7 |
parser |
parser |
.It |
.It |
.Xr man 7 |
.Xr man 7 |
parser |
parser |
.It |
.It |
.Xr roff 7 |
|
parser |
|
.It |
|
.Xr tbl 7 |
.Xr tbl 7 |
parser |
parser |
.It |
.It |
Line 45 terminal formatters |
|
Line 45 terminal formatters |
|
HTML formatters |
HTML formatters |
.It |
.It |
search tools |
search tools |
|
.It |
|
main programs |
.El |
.El |
.Pp |
.Pp |
Note that mere usage of an opaque struct type does |
Note that mere usage of an opaque struct type does |
Line 56 any other mandoc header. |
|
Line 58 any other mandoc header. |
|
These headers should be included before any other mandoc headers. |
These headers should be included before any other mandoc headers. |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Qq Pa mandoc_aux.h |
.It Qq Pa mandoc_aux.h |
|
Memory allocation utility functions; can be used everywhere. |
|
.Pp |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t . |
.Vt size_t . |
.Pp |
.Pp |
Provides the utility functions documented in |
Provides the functions documented in |
.Xr mandoc_malloc 3 . |
.Xr mandoc_malloc 3 . |
.It Qq Pa mandoc_ohash.h |
.It Qq Pa mandoc_ohash.h |
|
Hashing utility functions; can be used everywhere. |
|
.Pp |
Requires |
Requires |
.In stddef.h |
.In stddef.h |
for |
for |
|
|
and provides |
and provides |
.Fn mandoc_ohash_init . |
.Fn mandoc_ohash_init . |
.It Qq Pa mandoc.h |
.It Qq Pa mandoc.h |
|
Error handling utilities and top level parser interface; |
|
can be used everywhere. |
|
.Pp |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
|
|
.Vt enum mandocerr , |
.Vt enum mandocerr , |
.Vt enum mandoclevel , |
.Vt enum mandoclevel , |
.Vt enum mandoc_os , |
.Vt enum mandoc_os , |
.Vt enum tbl_cellt , |
|
.Vt enum tbl_datt , |
|
.Vt enum tbl_spant , |
|
.Vt enum eqn_boxt , |
.Vt enum eqn_boxt , |
.Vt enum eqn_fontt , |
.Vt enum eqn_fontt , |
.Vt enum eqn_pilet , |
.Vt enum eqn_pilet , |
.Vt enum eqn_post , |
.Vt enum eqn_post , |
.Vt struct tbl_opts , |
|
.Vt struct tbl_cell , |
|
.Vt struct tbl_row , |
|
.Vt struct tbl_dat , |
|
.Vt struct tbl_span , |
|
.Vt struct eqn_box , |
.Vt struct eqn_box , |
.Vt struct eqn , |
|
the function prototype typedef |
the function prototype typedef |
.Fn mandocmsg , |
.Fn mandocmsg , |
the function |
the function |
|
|
from |
from |
.Pa roff.h |
.Pa roff.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
|
.It Qq Pa tbl.h |
|
Data structures for the |
|
.Xr tbl 7 |
|
parse tree; can be used everywhere. |
|
.Pp |
|
Requires |
|
.In sys/types.h |
|
for |
|
.Vt size_t . |
|
.Pp |
|
Provides |
|
.Vt enum tbl_cellt , |
|
.Vt enum tbl_datt , |
|
.Vt enum tbl_spant , |
|
.Vt struct tbl_opts , |
|
.Vt struct tbl_cell , |
|
.Vt struct tbl_row , |
|
.Vt struct tbl_dat , |
|
and |
|
.Vt struct tbl_span . |
.It Qq Pa mandoc_xr.h |
.It Qq Pa mandoc_xr.h |
|
Cross reference validation; intended for use in the main program |
|
and in parsers, but not in formatters. |
|
.Pp |
Provides |
Provides |
.Vt struct mandoc_xr |
.Vt struct mandoc_xr |
and the functions |
and the functions |
|
|
.Pa libroff.h . |
.Pa libroff.h . |
.El |
.El |
.Ss Parser internals |
.Ss Parser internals |
The following headers require inclusion of a parser interface header |
Most of the following headers require inclusion of a parser interface header |
before they can be included. |
before they can be included. |
All parser interface headers should precede all parser internal headers. |
All parser interface headers should precede all parser internal headers. |
When any parser internal headers are included, the same file should |
When any parser internal headers are included, the same file should |
|
|
.Vt enum mandocerr . |
.Vt enum mandocerr . |
.Pp |
.Pp |
Provides |
Provides |
.Vt enum rofferr , |
|
.Vt struct buf , |
.Vt struct buf , |
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. |
|
|
from |
from |
.Pa roff.c |
.Pa roff.c |
for function prototypes. |
for function prototypes. |
Uses the types |
Uses the type |
.Vt struct tbl_span |
|
and |
|
.Vt struct eqn |
|
from |
|
.Pa mandoc.h |
|
and |
|
.Vt struct roff_man |
.Vt struct roff_man |
from |
from |
.Pa roff.h |
.Pa roff.h |
as opaque types for function prototypes. |
as an opaque type for function prototypes. |
.It Qq Pa roff_int.h |
.It Qq Pa roff_int.h |
Requires |
Requires |
.Qq Pa roff.h |
.Qq Pa roff.h |
Line 292 because the latter two are needed by |
|
Line 308 because the latter two are needed by |
|
.Qq Pa roff.c . |
.Qq Pa roff.c . |
.Pp |
.Pp |
Uses the types |
Uses the types |
.Vt struct eqn |
|
and |
|
.Vt struct tbl_span |
|
from |
|
.Pa mandoc.h , |
|
.Vt struct roff_man |
.Vt struct roff_man |
and |
and |
.Vt struct roff_node |
.Vt struct roff_node |
from |
from |
.Pa roff.h , |
.Pa roff.h |
and |
and |
.Vt struct mdoc_arg |
.Vt struct mdoc_arg |
from |
from |
|
|
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t , |
.Vt size_t |
|
and |
.Qq Pa mandoc.h |
.Qq Pa mandoc.h |
for |
for |
.Vt struct tbl_* |
.Vt struct eqn_box . |
and |
|
.Vt struct eqn , |
|
and |
|
.Qq Pa libmandoc.h |
|
for |
|
.Vt enum rofferr . |
|
.Pp |
.Pp |
Provides |
Provides |
.Vt enum tbl_part , |
|
.Vt struct tbl_node , |
|
.Vt struct eqn_def , |
.Vt struct eqn_def , |
.Vt struct eqn_node , |
.Vt struct eqn_node , |
and many functions internal to the |
and many functions internal to the |
.Xr tbl 7 |
|
and |
|
.Xr eqn 7 |
.Xr eqn 7 |
parsers. |
parser. |
.Pp |
.Pp |
Uses the opaque type |
Uses the opaque type |
.Vt struct mparse |
.Vt struct mparse |
Line 406 When this header is included, the same file should not |
|
Line 408 When this header is included, the same file should not |
|
.Pa libman.h , |
.Pa libman.h , |
or |
or |
.Pa libmdoc.h . |
.Pa libmdoc.h . |
|
.It Qq Pa tbl_parse.h |
|
External interface of the |
|
.Xr tbl 7 |
|
parser, for use in the |
|
.Xr roff 7 |
|
and |
|
.Xr tbl 7 |
|
parsers only. |
|
.Pp |
|
Provides the functions documented in |
|
.Xr tbl 3 . |
|
.Pp |
|
Uses the opaque type |
|
.Vt struct mparse |
|
from |
|
.Pa read.c . |
|
Uses the types |
|
.Vt struct tbl_span |
|
from |
|
.Pa tbl.h |
|
and |
|
.Vt struct tbl_node |
|
from |
|
.Pa tbl_int.h |
|
as opaque types for function prototypes. |
|
.Pp |
|
When this header is included, the same file should not include |
|
internals of a different parser. |
|
.It Qq Pa tbl_int.h |
|
Internal interfaces of the |
|
.Xr tbl 7 |
|
parser, for use inside the |
|
.Xr tbl 7 |
|
parser only. |
|
.Pp |
|
Requires |
|
.Qq Pa tbl.h |
|
for |
|
.Vt struct tbl_opts . |
|
.Pp |
|
Provides |
|
.Vt enum tbl_part , |
|
.Vt struct tbl_node , |
|
and the functions |
|
.Fn tbl_option , |
|
.Fn tbl_layout , |
|
.Fn tbl_data , |
|
.Fn tbl_cdata , |
|
and |
|
.Fn tbl_reset . |
|
.Pp |
|
Uses a pointer to the opaque type |
|
.Vt struct mparse |
|
from |
|
.Pa read.c |
|
as an opaque struct member. |
|
.Pp |
|
When this header is included, the same file should not include |
|
interfaces of different parsers. |
.El |
.El |
.Ss Formatter interface |
.Ss Formatter interface |
These headers should be included after any parser interface headers. |
These headers should be included after any parser interface headers. |
|
|
Uses |
Uses |
.Vt struct tbl_span |
.Vt struct tbl_span |
and |
and |
.Vt struct eqn |
.Vt struct eqn_box |
from |
from |
.Pa mandoc.h |
.Pa mandoc.h |
and |
and |
Line 503 and many HTML formatting functions. |
|
Line 564 and many HTML formatting functions. |
|
Uses |
Uses |
.Vt struct tbl_span |
.Vt struct tbl_span |
and |
and |
.Vt struct eqn |
.Vt struct eqn_box |
from |
from |
.Pa mandoc.h |
.Pa mandoc.h |
and |
and |