version 1.6, 2015/04/02 23:48:19 |
version 1.10, 2017/04/24 23:06:18 |
|
|
.Vt size_t . |
.Vt size_t . |
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 |
|
Includes |
|
.In ohash.h |
|
and provides |
|
.Fn mandoc_ohash_init . |
.It Qq Pa mandoc.h |
.It Qq Pa mandoc.h |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
|
|
.Vt enum eqn_pilet , |
.Vt enum eqn_pilet , |
.Vt enum eqn_post , |
.Vt enum eqn_post , |
.Vt struct tbl_opts , |
.Vt struct tbl_opts , |
.Vt struct tbl_head , |
|
.Vt struct tbl_cell , |
.Vt struct tbl_cell , |
.Vt struct tbl_row , |
.Vt struct tbl_row , |
.Vt struct tbl_dat , |
.Vt struct tbl_dat , |
Line 98 and the functions |
|
Line 102 and the functions |
|
described in |
described in |
.Xr mandoc 3 . |
.Xr mandoc 3 . |
.Pp |
.Pp |
Uses the opaque types |
Uses the opaque type |
.Vt struct mparse |
.Vt struct mparse |
from |
from |
.Pa read.c |
.Pa read.c |
and |
|
.Vt struct mchars |
|
from |
|
.Pa chars.c |
|
for function prototypes. |
for function prototypes. |
Uses the types |
Uses the type |
.Vt struct mdoc |
.Vt struct roff_man |
from |
from |
.Pa libmdoc.h |
.Pa roff.h |
and |
as an opaque type for function prototypes. |
.Vt struct man |
|
from |
|
.Pa libman.h |
|
as opaque types for function prototypes. |
|
.It Qq Pa roff.h |
.It Qq Pa roff.h |
Provides |
Provides |
.Vt enum mdoc_endbody , |
.Vt enum mdoc_endbody , |
|
.Vt enum roff_macroset , |
|
.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_meta , |
.Vt struct roff_meta , |
and |
.Vt struct roff_node , |
.Vt struct roff_node . |
the constant array |
|
.Va roff_name |
|
and the function |
|
.Fn deroff . |
.Pp |
.Pp |
Uses pointers to the types |
Uses pointers to the types |
.Vt struct mdoc_arg |
.Vt struct mdoc_arg |
and |
and |
.Vt union mdoc_data |
.Vt union mdoc_data |
from |
from |
.Qq Pa mdoc.h |
.Pa mdoc.h |
as opaque struct members. |
as opaque struct members. |
.El |
.El |
.Pp |
.Pp |
Line 143 Afterwards, any other mandoc headers can be included a |
|
Line 146 Afterwards, any other mandoc headers can be included a |
|
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t |
.Vt size_t . |
and |
|
.Qq Pa roff.h |
|
for |
|
.Vt enum roff_type . |
|
.Pp |
.Pp |
Provides |
Provides |
.Vt enum mdocargt , |
.Vt enum mdocargt , |
.Vt enum mdoc_disp , |
|
.Vt enum mdoc_list , |
|
.Vt enum mdoc_auth , |
.Vt enum mdoc_auth , |
|
.Vt enum mdoc_disp , |
.Vt enum mdoc_font , |
.Vt enum mdoc_font , |
|
.Vt enum mdoc_list , |
.Vt struct mdoc_argv , |
.Vt struct mdoc_argv , |
.Vt struct mdoc_arg , |
.Vt struct mdoc_arg , |
.Vt struct mdoc_bd , |
|
.Vt struct mdoc_bl , |
|
.Vt struct mdoc_an , |
.Vt struct mdoc_an , |
|
.Vt struct mdoc_bd , |
.Vt struct mdoc_bf , |
.Vt struct mdoc_bf , |
|
.Vt struct mdoc_bl , |
.Vt struct mdoc_rs , |
.Vt struct mdoc_rs , |
|
.Vt union mdoc_data , |
and the functions |
and the functions |
.Fn mdoc_* |
.Fn mdoc_* |
described in |
described in |
.Xr mandoc 3 . |
.Xr mandoc 3 . |
.Pp |
.Pp |
Uses the type |
Uses the type |
.Vt struct mdoc |
.Vt struct roff_man |
from |
from |
.Pa libmdoc.h |
.Pa roff.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
Uses pointers to the types |
|
.Vt struct tbl_span |
|
and |
|
.Vt struct eqn |
|
as opaque struct members. |
|
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa libman.h |
.Pa libman.h |
or |
or |
.Pa libroff.h . |
.Pa libroff.h . |
.It Qq Pa man.h |
.It Qq Pa man.h |
Requires |
|
.Qq Pa roff.h |
|
for |
|
.Vt enum roff_type . |
|
.Pp |
|
Provides the functions |
Provides the functions |
.Fn man_* |
.Fn man_* |
described in |
described in |
|
|
.Pa read.c |
.Pa read.c |
for function prototypes. |
for function prototypes. |
Uses the type |
Uses the type |
.Vt struct man |
.Vt struct roff_man |
from |
from |
.Pa libman.h |
.Pa roff.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
Uses pointers to the types |
|
.Vt struct tbl_span |
|
and |
|
.Vt struct eqn |
|
as opaque struct members. |
|
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa libmdoc.h |
.Pa libmdoc.h |
|
|
.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 |
.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 enum mandocerr , |
.Vt enum mandocerr . |
and |
|
.Qq Pa roff.h |
|
for |
|
.Vt struct roff_meta |
|
and |
|
.Vt struct roff_node . |
|
.Pp |
.Pp |
Provides |
Provides |
.Vt enum rofferr , |
.Vt enum rofferr , |
|
|
and |
and |
.Vt struct eqn |
.Vt struct eqn |
from |
from |
|
.Pa mandoc.h |
|
and |
|
.Vt struct roff_man |
|
from |
|
.Pa roff.h |
|
as opaque types for function prototypes. |
|
.It Qq Pa roff_int.h |
|
Requires |
|
.Qq Pa roff.h |
|
for |
|
.Vt enum roff_type . |
|
.Pp |
|
Provides functions named |
|
.Fn roff_* |
|
to handle roff nodes and the two special functions |
|
.Fn man_breakscope |
|
and |
|
.Fn mdoc_argv_free |
|
because the latter two are needed by |
|
.Qq Pa roff.c . |
|
.Pp |
|
Uses the types |
|
.Vt struct eqn |
|
and |
|
.Vt struct tbl_span |
|
from |
.Pa mandoc.h , |
.Pa mandoc.h , |
.Vt struct mdoc |
.Vt struct roff_man |
|
and |
|
.Vt struct roff_node |
from |
from |
.Pa libmdoc.h , |
.Pa roff.h , |
and |
and |
.Vt struct man |
.Vt struct mdoc_arg |
from |
from |
.Pa libman.h |
.Pa mdoc.h |
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_* |
|
|
.Vt struct mdoc_* . |
.Vt struct mdoc_* . |
.Pp |
.Pp |
Provides |
Provides |
.Vt enum mdoc_next , |
|
.Vt enum margserr , |
.Vt enum margserr , |
.Vt enum mdelim , |
.Vt enum mdelim , |
.Vt struct mdoc , |
|
.Vt struct mdoc_macro , |
.Vt struct mdoc_macro , |
and many functions internal to the |
and many functions internal to the |
.Xr mdoc 7 |
.Xr mdoc 7 |
parser. |
parser. |
.Pp |
.Pp |
Uses the opaque types |
Uses the opaque type |
.Vt struct mparse |
.Vt struct mparse |
from |
from |
.Pa read.c |
.Pa read.c . |
|
Uses the types |
|
.Vt struct roff_man |
and |
and |
.Vt struct roff |
.Vt struct roff_node |
from |
from |
.Pa roff.c . |
.Pa roff.h |
|
as opaque types for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa man.h , |
.Pa man.h , |
|
|
Requires |
Requires |
.Qq Pa roff.h |
.Qq Pa roff.h |
for |
for |
.Vt struct roff_meta |
.Vt enum roff_tok . |
and |
|
.Vt struct roff_node . |
|
.Pp |
|
Provides |
Provides |
.Vt enum man_next , |
.Vt struct man_macro |
.Vt struct man , |
and some functions internal to the |
.Vt struct man_macro , |
|
and many functions internal to the |
|
.Xr man 7 |
.Xr man 7 |
parser. |
parser. |
.Pp |
.Pp |
Uses the opaque types |
Uses the types |
.Vt struct mparse |
.Vt struct roff_man |
from |
|
.Pa read.c |
|
and |
and |
.Vt struct roff |
.Vt struct roff_node |
from |
from |
.Pa roff.c . |
.Pa roff.h |
|
as opaque types for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa mdoc.h , |
.Pa mdoc.h , |
|
|
.Vt struct termp , |
.Vt struct termp , |
and many terminal formatting functions. |
and many terminal formatting functions. |
.Pp |
.Pp |
Uses the opaque types |
Uses the opaque type |
.Vt struct mchars |
|
from |
|
.Pa chars.c |
|
and |
|
.Vt struct termp_ps |
.Vt struct termp_ps |
from |
from |
.Pa term_ps.c . |
.Pa term_ps.c . |
|
|
and |
and |
.Vt struct roff_meta |
.Vt struct roff_meta |
from |
from |
.Qq Pa roff.h |
.Pa roff.h |
as opaque types for function prototypes. |
as opaque types for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
|
|
.Vt struct html , |
.Vt struct html , |
and many HTML formatting functions. |
and many HTML formatting functions. |
.Pp |
.Pp |
Uses the opaque type |
|
.Vt struct mchars |
|
from |
|
.Pa chars.c . |
|
.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 |
.Pa mansearch.h . |
.Pa mansearch.h . |
|
.It Qq Pa tag.h |
|
Requires |
|
.In sys/types.h |
|
for |
|
.Vt size_t . |
|
.Pp |
|
Provides an interface to generate |
|
.Xr ctags 1 |
|
files for the |
|
.Ic :t |
|
functionality mentioned in |
|
.Xr man 1 . |
.It Qq Pa main.h |
.It Qq Pa main.h |
Provides the top level steering functions for all formatters. |
Provides the top level steering functions for all formatters. |
.Pp |
.Pp |
Uses the opaque type |
Uses the type |
.Vt struct mchars |
.Vt struct roff_man |
from |
from |
.Pa chars.c . |
.Pa roff.h |
Uses the types |
as an opaque type for function prototypes. |
.Vt struct mdoc |
|
from |
|
.Pa libmdoc.h |
|
and |
|
.Vt struct man |
|
from |
|
.Pa libman.h |
|
as opaque types for function prototypes. |
|
.It Qq Pa manconf.h |
.It Qq Pa manconf.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 |