[BACK]Return to mandoc_headers.3 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc_headers.3 between version 1.25 and 1.28

version 1.25, 2018/12/13 07:30:21 version 1.28, 2018/12/14 06:33:14
Line 84  Includes
Line 84  Includes
 and provides  and provides
 .Fn mandoc_ohash_init .  .Fn mandoc_ohash_init .
 .It Qq Pa mandoc.h  .It Qq Pa mandoc.h
 Error handling utilities and top level parser interface;  Error handling, escape sequence, and character utilities;
 can be used everywhere.  can be used everywhere.
 .Pp  .Pp
 Requires  Requires
 .In sys/types.h  .In sys/types.h
 for  for
 .Vt size_t .  .Vt size_t
   and
   .In stdio.h
   for
   .Vt FILE .
 .Pp  .Pp
 Provides  Provides
 .Vt enum mandoc_esc ,  .Vt enum mandoc_esc ,
 .Vt enum mandocerr ,  .Vt enum mandocerr ,
 .Vt enum mandoclevel ,  .Vt enum mandoclevel ,
 .Vt enum mandoc_os ,  
 the function prototype typedef  
 .Fn mandocmsg ,  
 the function  the function
 .Xr mandoc_escape 3 ,  .Xr mandoc_escape 3 ,
 the functions described in  the functions described in
 .Xr mchars_alloc 3 ,  .Xr mchars_alloc 3 ,
   and the
   .Fn mandoc_msg*
   functions.
   .It Qq Pa roff.h
   Common data types for all syntax trees and related functions;
   can be used everywhere.
   .Pp
   Provides
   .Vt enum mandoc_os ,
   .Vt enum mdoc_endbody ,
   .Vt enum roff_macroset ,
   .Vt enum roff_next ,
   .Vt enum roff_sec ,
   .Vt enum roff_tok ,
   .Vt enum roff_type ,
   .Vt struct roff_man ,
   .Vt struct roff_meta ,
   .Vt struct roff_node ,
   the constant array
   .Va roff_name
 and the functions  and the functions
 .Fn mparse_*  .Fn deroff
 described in  and
 .Xr mandoc 3 .  .Fn roff_validate .
 .Pp  .Pp
 Uses the opaque type  Uses pointers to the types
 .Vt struct mparse  .Vt struct ohash
 from  from
 .Pa read.c  .Pa mandoc_ohash.h
 for function prototypes.  and
 Uses the type  .Vt struct mdoc_arg
 .Vt struct roff_man  and
   .Vt union mdoc_data
 from  from
 .Pa roff.h  .Pa mdoc.h
 as an opaque type for function prototypes.  as opaque struct members.
 .It Qq Pa tbl.h  .It Qq Pa tbl.h
 Data structures for the  Data structures for the
 .Xr tbl 7  .Xr tbl 7
Line 154  Provides
Line 176  Provides
 .Vt enum eqn_post ,  .Vt enum eqn_post ,
 and  and
 .Vt struct eqn_box .  .Vt struct eqn_box .
   .It Qq Pa mandoc_parse.h
   Top level parser interface, for use in the main program
   and in the main parser, but not in formatters.
   .Pp
   Requires
   .Pa mandoc.h
   for
   .Vt enum mandocerr ,
   .Vt enum mandoclevel ,
   and
   .Fn mandocmsg ,
   and
   .Pa roff.h
   for
   .Vt enum mandoc_os .
   .Pp
   Uses the opaque type
   .Vt struct mparse
   from
   .Pa read.c
   for function prototypes.
   Uses
   .Vt struct roff_man
   from
   .Pa roff.h
   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
 and in parsers, but not in formatters.  and in parsers, but not in formatters.
Line 166  and the functions
Line 214  and the functions
 .Fn mandoc_xr_get ,  .Fn mandoc_xr_get ,
 and  and
 .Fn mandoc_xr_free .  .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.h  
 for  
 .Vt enum mandoc_os .  
 .Pp  
 Provides  
 .Vt enum mdoc_endbody ,  
 .Vt enum roff_macroset ,  
 .Vt enum roff_next ,  
 .Vt enum roff_sec ,  
 .Vt enum roff_tok ,  
 .Vt enum roff_type ,  
 .Vt struct roff_man ,  
 .Vt struct roff_meta ,  
 .Vt struct roff_node ,  
 the constant array  
 .Va roff_name  
 and the functions  
 .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  
 from  
 .Pa mdoc.h  
 as opaque struct members.  
 .El  .El
 .Pp  .Pp
 The following two require  The following two require
Line 249  Provides the functions
Line 260  Provides the functions
 described in  described in
 .Xr mandoc 3 .  .Xr mandoc 3 .
 .Pp  .Pp
 Uses the opaque type  
 .Vt struct mparse  
 from  
 .Pa read.c  
 for function prototypes.  
 Uses the type  Uses the type
 .Vt struct roff_man  .Vt struct roff_man
 from  from
Line 285  Provides
Line 291  Provides
 utility functions needed by multiple parsers,  utility functions needed by multiple parsers,
 and the top-level functions to call the parsers.  and the top-level functions to call the parsers.
 .Pp  .Pp
 Uses the opaque types  Uses the opaque type
 .Vt struct mparse  
 from  
 .Pa read.c  
 and  
 .Vt struct roff  .Vt struct roff
 from  from
 .Pa roff.c  .Pa roff.c
Line 413  and the functions
Line 415  and the functions
 and  and
 .Fn eqn_reset .  .Fn eqn_reset .
 .Pp  .Pp
 Uses the opaque type  
 .Vt struct mparse  
 from  
 .Pa read.c  
 for function prototypes.  
 Uses the type  Uses the type
 .Vt struct eqn_box  .Vt struct eqn_box
 from  from
Line 447  parsers only.
Line 444  parsers only.
 Provides the functions documented in  Provides the functions documented in
 .Xr tbl 3 .  .Xr tbl 3 .
 .Pp  .Pp
 Uses the opaque type  
 .Vt struct mparse  
 from  
 .Pa read.c .  
 Uses the types  Uses the types
 .Vt struct tbl_span  .Vt struct tbl_span
 from  from
Line 485  and the functions
Line 478  and the functions
 .Fn tbl_cdata ,  .Fn tbl_cdata ,
 and  and
 .Fn tbl_reset .  .Fn tbl_reset .
 .Pp  
 Uses a pointer to the opaque type  
 .Vt struct mparse  
 from  
 .Pa read.c  
 as an opaque struct member.  
 .Pp  .Pp
 When this header is included, the same file should not include  When this header is included, the same file should not include
 interfaces of different parsers.  interfaces of different parsers.
Legend:
Removed from v.1.25  
changed lines
  Added in v.1.28
CVSweb