=================================================================== RCS file: /cvs/mandoc/mandoc_headers.3,v retrieving revision 1.22 retrieving revision 1.25 diff -u -p -r1.22 -r1.25 --- mandoc/mandoc_headers.3 2018/12/13 03:40:13 1.22 +++ mandoc/mandoc_headers.3 2018/12/13 07:30:21 1.25 @@ -97,11 +97,6 @@ Provides .Vt enum mandocerr , .Vt enum mandoclevel , .Vt enum mandoc_os , -.Vt enum eqn_boxt , -.Vt enum eqn_fontt , -.Vt enum eqn_pilet , -.Vt enum eqn_post , -.Vt struct eqn_box , the function prototype typedef .Fn mandocmsg , the function @@ -143,6 +138,22 @@ Provides .Vt struct tbl_dat , and .Vt struct tbl_span . +.It Qq Pa eqn.h +Data structures for the +.Xr eqn 7 +parse tree; can be used everywhere. +.Pp +Requires +.In sys/types.h +for +.Vt size_t . +.Pp +Provides +.Vt enum eqn_boxt , +.Vt enum eqn_fontt , +.Vt enum eqn_post , +and +.Vt struct eqn_box . .It Qq Pa mandoc_xr.h Cross reference validation; intended for use in the main program and in parsers, but not in formatters. @@ -156,11 +167,10 @@ and the functions and .Fn mandoc_xr_free . .It Qq Pa roff.h +Common data types for all syntax trees and related functions; +can be used everywhere. +.Pp Requires -.Qq Pa mandoc_ohash.h -for -.Vt struct ohash -and .Qq Pa mandoc.h for .Vt enum mandoc_os . @@ -178,14 +188,15 @@ Provides the constant array .Va roff_name and the functions -.Fn deroff , -.Fn roffhash_alloc , -.Fn roffhash_find , -.Fn roffhash_free , +.Fn deroff and .Fn roff_validate . .Pp Uses pointers to the types +.Vt struct ohash +from +.Pa mandoc_ohash.h +and .Vt struct mdoc_arg and .Vt union mdoc_data @@ -289,14 +300,24 @@ from .Pa roff.h as an opaque type for function prototypes. .It Qq Pa roff_int.h +Parser internals shared by multiple parsers. +Can be used in all parsers, but not in main programs or formatters. +.Pp Requires .Qq Pa roff.h for -.Vt enum roff_type . +.Vt enum roff_type +and +.Vt enum roff_tok . .Pp Provides functions named .Fn roff_* -to handle roff nodes and the two special functions +to handle roff nodes, +.Fn roffhash_alloc , +.Fn roffhash_find , +and +.Fn roffhash_free , +and the two special functions .Fn man_breakscope and .Fn mdoc_argv_free @@ -320,11 +341,7 @@ Requires for .Vt enum roff_tok and -.Qq Pa mdoc.h -for -.Vt enum mdoc_* -and -.Vt struct mdoc_* . +.Vt enum roff_sec . .Pp Provides .Vt enum margserr , @@ -334,16 +351,16 @@ and many functions internal to the .Xr mdoc 7 parser. .Pp -Uses the opaque type -.Vt struct mparse -from -.Pa read.c . Uses the types .Vt struct roff_man and .Vt struct roff_node from .Pa roff.h +and +.Vt struct mdoc_arg +from +.Pa mdoc.h as opaque types for function prototypes. .Pp When this header is included, the same file should not include @@ -388,6 +405,7 @@ Provides .Vt struct eqn_node and the functions .Fn eqn_alloc , +.Fn eqn_box_new , .Fn eqn_box_free , .Fn eqn_free , .Fn eqn_parse ,