version 1.28, 2018/12/14 06:33:14 |
version 1.32, 2020/01/20 10:37:15 |
|
|
|
.\" $Id$ |
|
.\" |
|
.\" Copyright (c) 2014-2019 Ingo Schwarze <schwarze@openbsd.org> |
|
.\" |
|
.\" Permission to use, copy, modify, and distribute this software for any |
|
.\" purpose with or without fee is hereby granted, provided that the above |
|
.\" copyright notice and this permission notice appear in all copies. |
|
.\" |
|
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
.\" |
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt MANDOC_HEADERS 3 |
.Dt MANDOC_HEADERS 3 |
.Os |
.Os |
|
|
.Vt enum mandoc_os , |
.Vt enum mandoc_os , |
.Vt enum mdoc_endbody , |
.Vt enum mdoc_endbody , |
.Vt enum roff_macroset , |
.Vt enum roff_macroset , |
.Vt enum roff_next , |
|
.Vt enum roff_sec , |
.Vt enum roff_sec , |
.Vt enum roff_tok , |
.Vt enum roff_tok , |
.Vt enum roff_type , |
.Vt enum roff_type , |
|
|
.Vt struct roff_node , |
.Vt struct roff_node , |
the constant array |
the constant array |
.Va roff_name |
.Va roff_name |
and the functions |
and the function |
.Fn deroff |
.Fn deroff . |
and |
|
.Fn roff_validate . |
|
.Pp |
.Pp |
Uses pointers to the types |
Uses pointers to the types |
.Vt struct ohash |
.Vt struct ohash |
from |
from |
.Pa mandoc_ohash.h |
.Qq Pa mandoc_ohash.h , |
and |
|
.Vt struct mdoc_arg |
.Vt struct mdoc_arg |
and |
and |
.Vt union mdoc_data |
.Vt union mdoc_data |
from |
from |
.Pa mdoc.h |
.Qq Pa mdoc.h , |
|
.Vt struct tbl_span |
|
from |
|
.Qq Pa tbl.h , |
|
and |
|
.Vt struct eqn_box |
|
from |
|
.Qq Pa eqn.h |
as opaque struct members. |
as opaque struct members. |
.It Qq Pa tbl.h |
.It Qq Pa tbl.h |
Data structures for the |
Data structures for the |
Line 181 Top level parser interface, for use in the main progra |
|
Line 200 Top level parser interface, for use in the main progra |
|
and in the main parser, but not in formatters. |
and in the main parser, but not in formatters. |
.Pp |
.Pp |
Requires |
Requires |
.Pa mandoc.h |
.Qq Pa mandoc.h |
for |
for |
.Vt enum mandocerr , |
.Vt enum mandocerr |
.Vt enum mandoclevel , |
|
and |
and |
.Fn mandocmsg , |
.Vt enum mandoclevel |
and |
and |
.Pa roff.h |
.Qq Pa roff.h |
for |
for |
.Vt enum mandoc_os . |
.Vt enum mandoc_os . |
.Pp |
.Pp |
|
|
.Pa read.c |
.Pa read.c |
for function prototypes. |
for function prototypes. |
Uses |
Uses |
.Vt struct roff_man |
.Vt struct roff_meta |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
.It Qq Pa mandoc_xr.h |
.It Qq Pa mandoc_xr.h |
Cross reference validation; intended for use in the main program |
Cross reference validation; intended for use in the main program |
Line 246 and the functions |
|
Line 264 and the functions |
|
described in |
described in |
.Xr mandoc 3 . |
.Xr mandoc 3 . |
.Pp |
.Pp |
Uses the type |
Uses the types |
|
.Vt struct roff_node |
|
from |
|
.Qq Pa roff.h |
|
and |
.Vt struct roff_man |
.Vt struct roff_man |
from |
from |
.Pa roff.h |
.Qq Pa roff_int.h |
as an opaque type 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 |
internals of different parsers. |
internals of different parsers. |
|
|
Uses the type |
Uses the type |
.Vt struct roff_man |
.Vt struct roff_man |
from |
from |
.Pa roff.h |
.Qq Pa roff.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 |
Line 299 for function prototypes. |
|
Line 321 for function prototypes. |
|
Uses the type |
Uses the type |
.Vt struct roff_man |
.Vt struct roff_man |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
.It Qq Pa roff_int.h |
.It Qq Pa roff_int.h |
Parser internals shared by multiple parsers. |
Parser internals shared by multiple parsers. |
|
|
and |
and |
.Vt enum roff_tok . |
.Vt enum roff_tok . |
.Pp |
.Pp |
Provides functions named |
Provides |
|
.Vt enum roff_next , |
|
.Vt struct roff_man , |
|
functions named |
.Fn roff_* |
.Fn roff_* |
to handle roff nodes, |
to handle roff nodes, |
.Fn roffhash_alloc , |
.Fn roffhash_alloc , |
.Fn roffhash_find , |
.Fn roffhash_find , |
and |
|
.Fn roffhash_free , |
.Fn roffhash_free , |
|
and |
|
.Fn roff_validate , |
and the two special functions |
and the two special functions |
.Fn man_breakscope |
.Fn man_breakscope |
and |
and |
.Fn mdoc_argv_free |
.Fn mdoc_argv_free |
because the latter two are needed by |
because the latter two are needed by |
.Qq Pa roff.c . |
.Pa roff.c . |
.Pp |
.Pp |
Uses the types |
Uses the types |
.Vt struct roff_man |
.Vt struct ohash |
and |
from |
|
.Qq Pa mandoc_ohash.h , |
.Vt struct roff_node |
.Vt struct roff_node |
|
and |
|
.Vt struct roff_meta |
from |
from |
.Pa roff.h |
.Qq Pa roff.h , |
|
.Vt struct roff |
|
from |
|
.Pa roff.c , |
and |
and |
.Vt struct mdoc_arg |
.Vt struct mdoc_arg |
from |
from |
.Pa mdoc.h |
.Qq 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 |
Line 354 and many functions internal to the |
|
Line 386 and many functions internal to the |
|
parser. |
parser. |
.Pp |
.Pp |
Uses the types |
Uses the types |
.Vt struct roff_man |
|
and |
|
.Vt struct roff_node |
.Vt struct roff_node |
from |
from |
.Pa roff.h |
.Qq Pa roff.h , |
|
.Vt struct roff_man |
|
from |
|
.Qq Pa roff_int.h , |
and |
and |
.Vt struct mdoc_arg |
.Vt struct mdoc_arg |
from |
from |
.Pa mdoc.h |
.Qq Pa mdoc.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 |
Line 380 and some functions internal to the |
|
Line 413 and some functions internal to the |
|
parser. |
parser. |
.Pp |
.Pp |
Uses the types |
Uses the types |
.Vt struct roff_man |
|
and |
|
.Vt struct roff_node |
.Vt struct roff_node |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
|
and |
|
.Vt struct roff_man |
|
from |
|
.Qq Pa roff_int.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 |
|
|
Uses the type |
Uses the type |
.Vt struct eqn_box |
.Vt struct eqn_box |
from |
from |
.Pa mandoc.h |
.Qq Pa mandoc.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
Uses the types |
Uses the types |
.Vt struct roff_node |
.Vt struct roff_node |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
and |
and |
.Vt struct eqn_def |
.Vt struct eqn_def |
from |
from |
Line 447 Provides the functions documented in |
|
Line 482 Provides the functions documented in |
|
Uses the types |
Uses the types |
.Vt struct tbl_span |
.Vt struct tbl_span |
from |
from |
.Pa tbl.h |
.Qq Pa tbl.h |
and |
and |
.Vt struct tbl_node |
.Vt struct tbl_node |
from |
from |
.Pa tbl_int.h |
.Qq Pa tbl_int.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 |
|
|
Uses |
Uses |
.Vt struct tbl_span |
.Vt struct tbl_span |
from |
from |
.Pa mandoc.h |
.Qq Pa mandoc.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 |
.Pa mansearch.h . |
.Qq Pa mansearch.h . |
.It Qq Pa term.h |
.It Qq Pa term.h |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
|
|
and |
and |
.Vt struct eqn_box |
.Vt struct eqn_box |
from |
from |
.Pa mandoc.h |
.Qq Pa mandoc.h |
and |
and |
.Vt struct roff_meta |
.Vt struct roff_meta |
and |
and |
.Vt struct roff_node |
.Vt struct roff_node |
from |
from |
.Pa roff.h |
.Qq 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 |
.Pa html.h |
.Qq Pa html.h |
or |
or |
.Pa mansearch.h . |
.Qq Pa mansearch.h . |
.It Qq Pa html.h |
.It Qq Pa html.h |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t |
.Vt size_t , |
|
.Qq Pa mandoc.h |
|
for |
|
.Vt enum mandoc_esc , |
|
.Qq Pa roff.h |
|
for |
|
.Vt enum roff_tok , |
and |
and |
.Qq Pa out.h |
.Qq Pa out.h |
for |
for |
|
|
and |
and |
.Vt struct eqn_box |
.Vt struct eqn_box |
from |
from |
.Pa mandoc.h |
.Qq Pa mandoc.h |
and |
and |
.Vt struct roff_node |
.Vt struct roff_node |
from |
from |
.Pa roff.h |
.Qq 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 |
.Pa term.h |
.Qq Pa term.h |
or |
or |
.Pa mansearch.h . |
.Qq Pa mansearch.h . |
.It Qq Pa tag.h |
.It Qq Pa tag.h |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t . |
.Vt size_t |
|
and |
|
.In limits.h |
|
for |
|
.Dv INT_MAX . |
.Pp |
.Pp |
Provides an interface to generate |
Provides an interface to generate |
.Xr ctags 1 |
.Xr ctags 1 |
Line 607 functionality mentioned in |
|
Line 652 functionality mentioned in |
|
Provides the top level steering functions for all formatters. |
Provides the top level steering functions for all formatters. |
.Pp |
.Pp |
Uses the type |
Uses the type |
.Vt struct roff_man |
.Vt struct roff_meta |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
.It Qq Pa manconf.h |
.It Qq Pa manconf.h |
Requires |
Requires |
|
|
Uses |
Uses |
.Vt struct manpaths |
.Vt struct manpaths |
from |
from |
.Pa manconf.h |
.Qq 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 |
.Pa out.h , |
.Qq Pa out.h , |
.Pa term.h , |
.Qq Pa term.h , |
or |
or |
.Pa html.h . |
.Qq Pa html.h . |
.El |
.El |