[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.31 and 1.35

version 1.31, 2019/03/17 18:21:45 version 1.35, 2022/04/14 16:43:44
Line 1 
Line 1 
 .\"     $Id$  .\" $Id$
 .\"  .\"
 .\" Copyright (c) 2014-2019 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2014-2022 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 25  To support a cleaner coding style, the mandoc header f
Line 25  To support a cleaner coding style, the mandoc header f
 contain any include directives and do not guard against multiple  contain any include directives and do not guard against multiple
 inclusion.  inclusion.
 The application developer has to make sure that the headers are  The application developer has to make sure that the headers are
 included in a proper order, and that no header is included more  included in the order shown in this manual page,
 than once.  and that no header is included more than once.
 .Pp  .Pp
 The headers and functions form three major groups:  The headers and functions form three major groups:
 .Sx Parser interface ,  .Sx Parser interface ,
Line 83  for
Line 83  for
 .Pp  .Pp
 Provides the functions documented in  Provides the functions documented in
 .Xr mandoc_malloc 3 .  .Xr mandoc_malloc 3 .
   .Pp
   When this header is included, the same file must not include
   .Qq Pa mandoc_dbg.h
   because
   .Qq Pa mandoc_aux.h
   automatically includes
   .Qq Pa mandoc_dbg.h
   if and only if the preprocessor symbol
   .Dv DEBUG_MEMORY
   is defined.
   .It Qq Pa mandoc_dbg.h
   Debugging utility functions and
   debugging wrappers around memory allocation functions.
   .Pp
   Requires
   .In sys/types.h
   for
   .Vt size_t .
   .Pp
   Provides the functions documented in
   .Xr mandoc_dbg_init 3 .
   .Pp
   This header must not be included unless the preprocessor symbol
   .Dv DEBUG_MEMORY
   is defined.
   When this header is included, the same file must not include
   .Qq Pa mandoc_aux.h .
 .It Qq Pa mandoc_ohash.h  .It Qq Pa mandoc_ohash.h
 Hashing utility functions; can be used everywhere.  Hashing utility functions; can be used everywhere.
 .Pp  .Pp
Line 167  parse tree; can be used everywhere.
Line 194  parse tree; can be used everywhere.
 Requires  Requires
 .In sys/types.h  .In sys/types.h
 for  for
 .Vt size_t .  .Vt size_t
   and
   .Qq Pa mandoc.h
   for
   .Vt enum mandoc_esc .
 .Pp  .Pp
 Provides  Provides
 .Vt enum tbl_cellt ,  .Vt enum tbl_cellt ,
Line 232  and the functions
Line 263  and the functions
 .Fn mandoc_xr_get ,  .Fn mandoc_xr_get ,
 and  and
 .Fn mandoc_xr_free .  .Fn mandoc_xr_free .
   .It Qq Pa tag.h
   Internal interfaces to tag syntax tree nodes,
   for use by validation modules only.
   .Pp
   Requires
   .In limits.h
   for
   .Dv INT_MAX .
   .Pp
   Provides the functions
   .Fn tag_alloc ,
   .Fn tag_put ,
   .Fn tag_check ,
   and
   .Fn tag_free
   and some
   .Dv TAG_*
   constants.
   .Pp
   Uses the type
   .Vt struct roff_node
   from
   .Qq Pa roff.h
   as an opaque type for function prototypes.
 .El  .El
 .Pp  .Pp
 The following two require  The following two require
Line 587  When this header is included, the same file should not
Line 642  When this header is included, the same file should not
 .Qq Pa html.h  .Qq Pa html.h
 or  or
 .Qq Pa mansearch.h .  .Qq Pa mansearch.h .
   .It Qq Pa tag_term.h
   Requires
   .In sys/types.h
   for
   .Vt size_t
   and
   .In stdio.h
   for
   .Vt FILE .
   .Pp
   Provides an interface to generate
   .Xr ctags 1
   files for the
   .Ic :t
   functionality mentioned in
   .Xr man 1 .
   .Pp
   Uses the type
   .Vt struct roff_node
   from
   .Qq Pa roff.h
   as an opaque type for function prototypes.
   .Pp
   When this header is included, the same file should not include
   .Qq Pa html.h
   or
   .Qq Pa mansearch.h .
 .It Qq Pa html.h  .It Qq Pa html.h
 Requires  Requires
 .In sys/types.h  .In sys/types.h
Line 629  from
Line 711  from
 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
 .Qq Pa term.h  .Qq Pa term.h ,
   .Qq Pa tab_term.h ,
 or  or
 .Qq Pa mansearch.h .  .Qq Pa mansearch.h .
 .It Qq Pa tag.h  
 Requires  
 .In sys/types.h  
 for  
 .Vt size_t .  
 .Pp  
 Provides an interface to generate  
 .Xr ctags 1  
 files for the  
 .Ic :t  
 functionality mentioned in  
 .Xr man 1 .  
 .It Qq Pa main.h  .It Qq Pa main.h
 Provides the top level steering functions for all formatters.  Provides the top level steering functions for all formatters.
 .Pp  .Pp
Line 696  as an opaque type for function prototypes.
Line 767  as an opaque type for function prototypes.
 When this header is included, the same file should not include  When this header is included, the same file should not include
 .Qq Pa out.h ,  .Qq Pa out.h ,
 .Qq Pa term.h ,  .Qq Pa term.h ,
   .Qq Pa tab_term.h ,
 or  or
 .Qq Pa html.h .  .Qq Pa html.h .
 .El  .El
Legend:
Removed from v.1.31  
changed lines
  Added in v.1.35
CVSweb