version 1.1, 2014/12/01 08:09:26 |
version 1.4, 2015/04/02 21:36:50 |
|
|
search tools |
search tools |
.El |
.El |
.Pp |
.Pp |
Note that mere usage of an opaque type does |
Note that mere usage of an opaque struct type does |
.Em not |
.Em not |
require inclusion of the header where that type is defined. |
require inclusion of the header where that type is defined. |
.Ss Parser interface |
.Ss Parser interface |
Each of the following headers can be included without including |
Each of the following headers can be included without including |
any other mandoc header. |
any other mandoc header. |
These headers should be included before any other mandoc headers. |
These headers should be included before any other mandoc headers. |
Afterwards, any other mandoc headers can be included as needed. |
|
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Qq Pa mandoc_aux.h |
.It Qq Pa mandoc_aux.h |
Requires |
Requires |
|
|
from |
from |
.Pa libman.h |
.Pa libman.h |
as opaque types for function prototypes. |
as opaque types for function prototypes. |
|
.It Qq Pa roff.h |
|
Provides |
|
.Vt enum roff_type . |
|
.El |
|
.Pp |
|
The following two require |
|
.Qq Pa roff.h |
|
but no other mandoc headers. |
|
Afterwards, any other mandoc headers can be included as needed. |
|
.Bl -tag -width Ds |
.It Qq Pa mdoc.h |
.It Qq Pa mdoc.h |
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 mdoct , |
.Vt enum mdoct , |
.Vt enum mdocargt , |
.Vt enum mdocargt , |
.Vt enum mdoc_type , |
|
.Vt enum mdoc_sec , |
.Vt enum mdoc_sec , |
.Vt enum mdoc_endbody , |
.Vt enum mdoc_endbody , |
.Vt enum mdoc_disp , |
.Vt enum mdoc_disp , |
Line 163 When this header is included, the same file should not |
|
Line 175 When this header is included, the same file should not |
|
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 |
Provides |
.Vt enum mant , |
.Vt enum mant , |
.Vt enum man_type , |
|
.Vt struct man_meta , |
.Vt struct man_meta , |
.Vt struct man_node , |
.Vt struct man_node , |
and the functions |
and the functions |
Line 204 are included, the same file should not include any for |
|
Line 220 are included, the same file should not include any for |
|
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t . |
.Vt size_t |
|
and |
|
.Qq Pa mandoc.h |
|
for |
|
.Vt enum mandocerr . |
.Pp |
.Pp |
Provides |
Provides |
.Vt enum rofferr , |
.Vt enum rofferr , |
|
|
.Pa roff.c |
.Pa roff.c |
for function prototypes. |
for function prototypes. |
Uses the types |
Uses the types |
.Vt enum mandocerr , |
.Vt struct tbl_span |
.Vt struct tbl_span , |
|
and |
and |
.Vt struct eqn |
.Vt struct eqn |
from |
from |
|
|
as an opaque type for function prototypes. |
as an opaque type 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 manpath.h |
|
or |
|
.Pa mansearch.h . |
.Pa mansearch.h . |
.It Qq Pa term.h |
.It Qq Pa term.h |
Requires |
Requires |
|
|
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 |
.Pa html.h , |
.Pa html.h |
.Pa manpath.h |
|
or |
or |
.Pa mansearch.h . |
.Pa mansearch.h . |
.It Qq Pa html.h |
.It Qq Pa html.h |
|
|
.Pa chars.c . |
.Pa chars.c . |
.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 term.h , |
.Pa term.h |
.Pa manpath.h |
|
or |
or |
.Pa mansearch.h . |
.Pa mansearch.h . |
.It Qq Pa main.h |
.It Qq Pa main.h |
|
|
from |
from |
.Pa libman.h |
.Pa libman.h |
as opaque types for function prototypes. |
as opaque types for function prototypes. |
.It Qq Pa manpath.h |
.It Qq Pa manconf.h |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t . |
.Vt size_t . |
.Pp |
.Pp |
Provides |
Provides |
.Vt struct manpaths |
.Vt struct manconf , |
|
.Vt struct manpaths , |
|
.Vt struct manoutput , |
and the functions |
and the functions |
.Fn manpath_manconf , |
.Fn manconf_parse , |
.Fn manpath_parse , |
.Fn manconf_output , |
and |
and |
.Fn manpath_free . |
.Fn manconf_free . |
.Pp |
|
When this header is included, the same file should not include |
|
.Pa out.h , |
|
.Pa term.h , |
|
or |
|
.Pa html.h . |
|
.It Qq Pa mansearch.h |
.It Qq Pa mansearch.h |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
|
|
Uses |
Uses |
.Vt struct manpaths |
.Vt struct manpaths |
from |
from |
.Pa manpath.h |
.Pa manconf.h |
as an opaque type for function prototypes. |
as an opaque type 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 |