diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2018-12-13 03:40:13 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2018-12-13 03:40:13 +0000 |
commit | 41c83570cd0b176c663b583e5990f9869f214754 (patch) | |
tree | 95da442ae18416eff5593d4cdb041f4ad5bc78c7 /mandoc_headers.3 | |
parent | 8778c0e49080778fd04dc5a3c1aac38addbfa5a4 (diff) | |
download | mandoc-41c83570cd0b176c663b583e5990f9869f214754.tar.gz mandoc-41c83570cd0b176c663b583e5990f9869f214754.tar.zst mandoc-41c83570cd0b176c663b583e5990f9869f214754.zip |
Cleanup, no functional change:
In libroff.h, nothing was left except the eqn(7) parser interface, which
isn't really part of the roff(7) parser, so rename it to eqn_parse.h.
While here, move struct eqn_def to eqn.c because that's the only
file using it, and let eqn_box_free() and eqn_free() handle NULL.
Diffstat (limited to 'mandoc_headers.3')
-rw-r--r-- | mandoc_headers.3 | 73 |
1 files changed, 41 insertions, 32 deletions
diff --git a/mandoc_headers.3 b/mandoc_headers.3 index 03b9d55d..199f6dfc 100644 --- a/mandoc_headers.3 +++ b/mandoc_headers.3 @@ -231,9 +231,7 @@ from as an opaque type for function prototypes. .Pp When this header is included, the same file should not include -.Pa libman.h -or -.Pa libroff.h . +internals of different parsers. .It Qq Pa man.h Provides the functions .Fn man_* @@ -252,9 +250,7 @@ from as an opaque type for function prototypes. .Pp When this header is included, the same file should not include -.Pa libmdoc.h -or -.Pa libroff.h . +internals of different parsers. .El .Ss Parser internals Most of the following headers require inclusion of a parser interface header @@ -351,10 +347,7 @@ from as opaque types for function prototypes. .Pp When this header is included, the same file should not include -.Pa man.h , -.Pa libman.h , -or -.Pa libroff.h . +interfaces of different parsers. .It Qq Pa libman.h Requires .Qq Pa roff.h @@ -376,38 +369,54 @@ from as opaque types for function prototypes. .Pp When this header is included, the same file should not include -.Pa mdoc.h , -.Pa libmdoc.h , -or -.Pa libroff.h . -.It Qq Pa libroff.h +interfaces of different parsers. +.It Qq Pa eqn_parse.h +External interface of the +.Xr eqn 7 +parser, for use in the +.Xr roff 7 +and +.Xr eqn 7 +parsers only. +.Pp Requires .In sys/types.h for -.Vt size_t -and -.Qq Pa mandoc.h -for -.Vt struct eqn_box . +.Vt size_t . .Pp Provides -.Vt struct eqn_def , -.Vt struct eqn_node , -and many functions internal to the -.Xr eqn 7 -parser. +.Vt struct eqn_node +and the functions +.Fn eqn_alloc , +.Fn eqn_box_free , +.Fn eqn_free , +.Fn eqn_parse , +.Fn eqn_read , +and +.Fn eqn_reset . .Pp Uses the opaque type .Vt struct mparse from -.Pa read.c . +.Pa read.c +for function prototypes. +Uses the type +.Vt struct eqn_box +from +.Pa mandoc.h +as an opaque type for function prototypes. +Uses the types +.Vt struct roff_node +from +.Pa roff.h +and +.Vt struct eqn_def +from +.Pa eqn.c +as opaque struct members. .Pp When this header is included, the same file should not include -.Pa man.h , -.Pa mdoc.h , -.Pa libman.h , -or -.Pa libmdoc.h . +internals of different parsers. .It Qq Pa tbl_parse.h External interface of the .Xr tbl 7 @@ -435,7 +444,7 @@ from as opaque types for function prototypes. .Pp When this header is included, the same file should not include -internals of a different parser. +internals of different parsers. .It Qq Pa tbl_int.h Internal interfaces of the .Xr tbl 7 |