[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.8 and 1.19

version 1.8, 2016/07/07 19:19:01 version 1.19, 2018/08/24 23:12:33
Line 1 
Line 1 
 .Dd December 1, 2014  .Dd $Mdocdate$
 .Dt MANDOC_HEADERS 3  .Dt MANDOC_HEADERS 3
 .Os  .Os
 .Sh NAME  .Sh NAME
Line 60  Requires
Line 60  Requires
 .In sys/types.h  .In sys/types.h
 for  for
 .Vt size_t .  .Vt size_t .
   .Pp
 Provides the utility functions documented in  Provides the utility functions documented in
 .Xr mandoc_malloc 3 .  .Xr mandoc_malloc 3 .
 .It Qq Pa mandoc_ohash.h  .It Qq Pa mandoc_ohash.h
   Requires
   .In stddef.h
   for
   .Vt ptrdiff_t
   and
   .In stdint.h
   for
   .Vt uint32_t .
   .Pp
 Includes  Includes
 .In ohash.h  .In ohash.h
 and provides  and provides
Line 77  Provides
Line 87  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 ,
 .Vt enum tbl_cellt ,  .Vt enum tbl_cellt ,
 .Vt enum tbl_datt ,  .Vt enum tbl_datt ,
 .Vt enum tbl_spant ,  .Vt enum tbl_spant ,
Line 90  Provides
Line 101  Provides
 .Vt struct tbl_dat ,  .Vt struct tbl_dat ,
 .Vt struct tbl_span ,  .Vt struct tbl_span ,
 .Vt struct eqn_box ,  .Vt struct eqn_box ,
 .Vt struct eqn ,  
 the function prototype typedef  the function prototype typedef
 .Fn mandocmsg ,  .Fn mandocmsg ,
 the function  the function
Line 112  Uses the type
Line 122  Uses the type
 from  from
 .Pa roff.h  .Pa roff.h
 as an opaque type for function prototypes.  as an opaque type for function prototypes.
   .It Qq Pa mandoc_xr.h
   Provides
   .Vt struct mandoc_xr
   and the functions
   .Fn mandoc_xr_reset ,
   .Fn mandoc_xr_add ,
   .Fn mandoc_xr_get ,
   and
   .Fn mandoc_xr_free .
 .It Qq Pa roff.h  .It Qq Pa roff.h
   Requires
   .Qq Pa mandoc_ohash.h
   for
   .Vt struct ohash
   and
   .Qq Pa mandoc.h
   for
   .Vt enum mandoc_os .
   .Pp
 Provides  Provides
 .Vt enum mdoc_endbody ,  .Vt enum mdoc_endbody ,
 .Vt enum roff_macroset ,  .Vt enum roff_macroset ,
 .Vt enum roff_next ,  .Vt enum roff_next ,
 .Vt enum roff_sec ,  .Vt enum roff_sec ,
   .Vt enum roff_tok ,
 .Vt enum roff_type ,  .Vt enum roff_type ,
 .Vt struct roff_man ,  .Vt struct roff_man ,
 .Vt struct roff_meta ,  .Vt struct roff_meta ,
 .Vt struct roff_node ,  .Vt struct roff_node ,
 and the function  the constant array
 .Fn deroff .  .Va roff_name
   and the functions
   .Fn deroff ,
   .Fn roffhash_alloc ,
   .Fn roffhash_find ,
   .Fn roffhash_free ,
   and
   .Fn roff_validate .
 .Pp  .Pp
 Uses pointers to the types  Uses pointers to the types
 .Vt struct mdoc_arg  .Vt struct mdoc_arg
Line 198  or
Line 234  or
 .El  .El
 .Ss Parser internals  .Ss Parser internals
 The following headers require inclusion of a parser interface header  The following headers require inclusion of a parser interface header
 before they can be included.  All parser interface headers should  before they can be included.
 precede all parser internal headers.  When any parser internal headers  All parser interface headers should precede all parser internal headers.
 are included, the same file should not include any formatter headers.  When any parser internal headers are included, the same file should
   not include any formatter headers.
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Qq Pa libmandoc.h  .It Qq Pa libmandoc.h
 Requires  Requires
Line 213  for
Line 250  for
 .Vt enum mandocerr .  .Vt enum mandocerr .
 .Pp  .Pp
 Provides  Provides
 .Vt enum rofferr ,  
 .Vt struct buf ,  .Vt struct buf ,
 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.
Line 227  and
Line 263  and
 from  from
 .Pa roff.c  .Pa roff.c
 for function prototypes.  for function prototypes.
 Uses the types  Uses the type
 .Vt struct tbl_span  
 and  
 .Vt struct eqn  
 from  
 .Pa mandoc.h  
 and  
 .Vt struct roff_man  .Vt struct roff_man
 from  from
 .Pa roff.h  .Pa roff.h
 as opaque types for function prototypes.  as an opaque type for function prototypes.
 .It Qq Pa roff_int.h  .It Qq Pa roff_int.h
 Requires  Requires
 .Qq Pa roff.h  .Qq Pa roff.h
Line 254  because the latter two are needed by
Line 284  because the latter two are needed by
 .Qq Pa roff.c .  .Qq Pa roff.c .
 .Pp  .Pp
 Uses the types  Uses the types
 .Vt struct eqn  
 and  
 .Vt struct tbl_span  
 from  
 .Pa mandoc.h ,  
 .Vt struct roff_man  .Vt struct roff_man
 and  and
 .Vt struct roff_node  .Vt struct roff_node
 from  from
 .Pa roff.h ,  .Pa roff.h
 and  and
 .Vt struct mdoc_arg  .Vt struct mdoc_arg
 from  from
Line 271  from
Line 296  from
 as opaque types for function prototypes.  as opaque types for function prototypes.
 .It Qq Pa libmdoc.h  .It Qq Pa libmdoc.h
 Requires  Requires
   .Qq Pa roff.h
   for
   .Vt enum roff_tok
   and
 .Qq Pa mdoc.h  .Qq Pa mdoc.h
 for  for
 .Vt enum mdoc_*  .Vt enum mdoc_*
Line 303  When this header is included, the same file should not
Line 332  When this header is included, the same file should not
 or  or
 .Pa libroff.h .  .Pa libroff.h .
 .It Qq Pa libman.h  .It Qq Pa libman.h
   Requires
   .Qq Pa roff.h
   for
   .Vt enum roff_tok .
   .Pp
 Provides  Provides
 .Vt struct man_macro  .Vt struct man_macro
 and some functions internal to the  and some functions internal to the
Line 326  or
Line 360  or
 Requires  Requires
 .In sys/types.h  .In sys/types.h
 for  for
 .Vt size_t ,  .Vt size_t
   and
 .Qq Pa mandoc.h  .Qq Pa mandoc.h
 for  for
 .Vt struct tbl_*  .Vt struct tbl_*
 and  and
 .Vt struct eqn ,  .Vt struct eqn_box .
 and  
 .Qq Pa libmandoc.h  
 for  
 .Vt enum rofferr .  
 .Pp  .Pp
 Provides  Provides
 .Vt enum tbl_part ,  .Vt enum tbl_part ,
Line 405  Provides
Line 436  Provides
 .Vt enum termtype ,  .Vt enum termtype ,
 .Vt struct termp_tbl ,  .Vt struct termp_tbl ,
 .Vt struct termp ,  .Vt struct termp ,
   .Fn roff_term_pre ,
 and many terminal formatting functions.  and many terminal formatting functions.
 .Pp  .Pp
 Uses the opaque type  Uses the opaque type
Line 414  from
Line 446  from
 Uses  Uses
 .Vt struct tbl_span  .Vt struct tbl_span
 and  and
 .Vt struct eqn  .Vt struct eqn_box
 from  from
 .Pa mandoc.h  .Pa mandoc.h
 and  and
 .Vt struct roff_meta  .Vt struct roff_meta
   and
   .Vt struct roff_node
 from  from
 .Pa roff.h  .Pa roff.h
 as opaque types for function prototypes.  as opaque types for function prototypes.
Line 431  or
Line 465  or
 Requires  Requires
 .In sys/types.h  .In sys/types.h
 for  for
 .Vt size_t ,  .Vt size_t
 .In stdio.h  
 for  
 .Dv BUFSIZ ,  
 and  and
 .Qq Pa out.h  .Qq Pa out.h
 for  for
Line 450  Provides
Line 481  Provides
 .Vt struct tagq ,  .Vt struct tagq ,
 .Vt struct htmlpair ,  .Vt struct htmlpair ,
 .Vt struct html ,  .Vt struct html ,
   .Fn roff_html_pre ,
 and many HTML formatting functions.  and many HTML formatting functions.
 .Pp  .Pp
   Uses
   .Vt struct tbl_span
   and
   .Vt struct eqn_box
   from
   .Pa mandoc.h
   and
   .Vt struct roff_node
   from
   .Pa roff.h
   as opaque types for function prototypes.
   .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
 or  or
Line 489  Provides
Line 533  Provides
 and the functions  and the functions
 .Fn manconf_parse ,  .Fn manconf_parse ,
 .Fn manconf_output ,  .Fn manconf_output ,
   .Fn manconf_free ,
 and  and
 .Fn manconf_free .  .Fn manpath_base .
 .It Qq Pa mansearch.h  .It Qq Pa mansearch.h
 Requires  Requires
 .In sys/types.h  .In sys/types.h
Line 506  Provides
Line 551  Provides
 .Vt struct manpage ,  .Vt struct manpage ,
 .Vt struct mansearch ,  .Vt struct mansearch ,
 and the functions  and the functions
 .Fn mansearch_setup ,  .Fn mansearch
 .Fn mansearch ,  
 and  and
 .Fn mansearch_free .  .Fn mansearch_free .
 .Pp  .Pp
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.19
CVSweb