version 1.8, 2016/07/07 19:19:01 |
version 1.15, 2017/07/01 09:47:30 |
|
|
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t . |
.Vt size_t . |
|
.Pp |
Provides the utility functions documented in |
Provides the utility functions documented in |
.Xr mandoc_malloc 3 . |
.Xr mandoc_malloc 3 . |
.It Qq Pa mandoc_ohash.h |
.It Qq Pa mandoc_ohash.h |
|
Requires |
|
.In stddef.h |
|
for |
|
.Vt ptrdiff_t |
|
and |
|
.In stdint.h |
|
for |
|
.Vt uint32_t . |
|
.Pp |
Includes |
Includes |
.In ohash.h |
.In ohash.h |
and provides |
and provides |
|
|
.Vt enum mandoc_esc , |
.Vt enum mandoc_esc , |
.Vt enum mandocerr , |
.Vt enum mandocerr , |
.Vt enum mandoclevel , |
.Vt enum mandoclevel , |
|
.Vt enum mandoc_os , |
.Vt enum tbl_cellt , |
.Vt enum tbl_cellt , |
.Vt enum tbl_datt , |
.Vt enum tbl_datt , |
.Vt enum tbl_spant , |
.Vt enum tbl_spant , |
|
|
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 mandoc_xr.h |
|
Provides |
|
.Vt struct mandoc_xr |
|
and the functions |
|
.Fn mandoc_xr_reset , |
|
.Fn mandoc_xr_add , |
|
.Fn mandoc_xr_get , |
|
and |
|
.Fn mandoc_xr_free . |
.It Qq Pa roff.h |
.It Qq Pa roff.h |
|
Requires |
|
.Qq Pa mandoc_ohash.h |
|
for |
|
.Vt struct ohash |
|
and |
|
.Qq Pa mandoc.h |
|
for |
|
.Vt enum mandoc_os . |
|
.Pp |
Provides |
Provides |
.Vt enum mdoc_endbody , |
.Vt enum mdoc_endbody , |
.Vt enum roff_macroset , |
.Vt enum roff_macroset , |
.Vt enum roff_next , |
.Vt enum roff_next , |
.Vt enum roff_sec , |
.Vt enum roff_sec , |
|
.Vt enum roff_tok , |
.Vt enum roff_type , |
.Vt enum roff_type , |
.Vt struct roff_man , |
.Vt struct roff_man , |
.Vt struct roff_meta , |
.Vt struct roff_meta , |
.Vt struct roff_node , |
.Vt struct roff_node , |
and the function |
the constant array |
.Fn deroff . |
.Va roff_name |
|
and the functions |
|
.Fn deroff , |
|
.Fn roffhash_alloc , |
|
.Fn roffhash_find , |
|
.Fn roffhash_free , |
|
and |
|
.Fn roff_validate . |
.Pp |
.Pp |
Uses pointers to the types |
Uses pointers to the types |
.Vt struct mdoc_arg |
.Vt struct mdoc_arg |
|
|
.El |
.El |
.Ss Parser internals |
.Ss Parser internals |
The following headers require inclusion of a parser interface header |
The following headers require inclusion of a parser interface header |
before they can be included. All parser interface headers should |
before they can be included. |
precede all parser internal headers. When any parser internal headers |
All parser interface headers should precede all parser internal headers. |
are included, the same file should not include any formatter headers. |
When any parser internal headers are included, the same file should |
|
not include any formatter headers. |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Qq Pa libmandoc.h |
.It Qq Pa libmandoc.h |
Requires |
Requires |
|
|
as opaque types for function prototypes. |
as opaque types for function prototypes. |
.It Qq Pa libmdoc.h |
.It Qq Pa libmdoc.h |
Requires |
Requires |
|
.Qq Pa roff.h |
|
for |
|
.Vt enum roff_tok |
|
and |
.Qq Pa mdoc.h |
.Qq Pa mdoc.h |
for |
for |
.Vt enum mdoc_* |
.Vt enum mdoc_* |
Line 303 When this header is included, the same file should not |
|
Line 345 When this header is included, the same file should not |
|
or |
or |
.Pa libroff.h . |
.Pa libroff.h . |
.It Qq Pa libman.h |
.It Qq Pa libman.h |
|
Requires |
|
.Qq Pa roff.h |
|
for |
|
.Vt enum roff_tok . |
|
.Pp |
Provides |
Provides |
.Vt struct man_macro |
.Vt struct man_macro |
and some functions internal to the |
and some functions internal to the |
|
|
.Vt enum termtype , |
.Vt enum termtype , |
.Vt struct termp_tbl , |
.Vt struct termp_tbl , |
.Vt struct termp , |
.Vt struct termp , |
|
.Fn roff_term_pre , |
and many terminal formatting functions. |
and many terminal formatting functions. |
.Pp |
.Pp |
Uses the opaque type |
Uses the opaque type |
|
|
.Pa mandoc.h |
.Pa mandoc.h |
and |
and |
.Vt struct roff_meta |
.Vt struct roff_meta |
|
and |
|
.Vt struct roff_node |
from |
from |
.Pa roff.h |
.Pa roff.h |
as opaque types for function prototypes. |
as opaque types for function prototypes. |
|
|
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t , |
.Vt size_t |
.In stdio.h |
|
for |
|
.Dv BUFSIZ , |
|
and |
and |
.Qq Pa out.h |
.Qq Pa out.h |
for |
for |
|
|
.Vt struct tagq , |
.Vt struct tagq , |
.Vt struct htmlpair , |
.Vt struct htmlpair , |
.Vt struct html , |
.Vt struct html , |
|
.Fn roff_html_pre , |
and many HTML formatting functions. |
and many HTML formatting functions. |
.Pp |
.Pp |
|
Uses |
|
.Vt struct tbl_span |
|
and |
|
.Vt struct eqn |
|
from |
|
.Pa mandoc.h |
|
and |
|
.Vt struct roff_node |
|
from |
|
.Pa roff.h |
|
as opaque types for function prototypes. |
|
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa term.h |
.Pa term.h |
or |
or |
|
|
and the functions |
and the functions |
.Fn manconf_parse , |
.Fn manconf_parse , |
.Fn manconf_output , |
.Fn manconf_output , |
|
.Fn manconf_free , |
and |
and |
.Fn manconf_free . |
.Fn manpath_base . |
.It Qq Pa mansearch.h |
.It Qq Pa mansearch.h |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
|
|
.Vt struct manpage , |
.Vt struct manpage , |
.Vt struct mansearch , |
.Vt struct mansearch , |
and the functions |
and the functions |
.Fn mansearch_setup , |
.Fn mansearch |
.Fn mansearch , |
|
and |
and |
.Fn mansearch_free . |
.Fn mansearch_free . |
.Pp |
.Pp |