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

Diff for /mandoc/Attic/mdoc.3 between version 1.37 and 1.38

version 1.37, 2010/02/17 19:22:01 version 1.38, 2010/05/25 21:38:05
Line 17 
Line 17 
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt MDOC 3  .Dt MDOC 3
 .Os  .Os
 .\" SECTION  
 .Sh NAME  .Sh NAME
 .Nm mdoc_alloc ,  .Nm mdoc_alloc ,
 .Nm mdoc_parseln ,  
 .Nm mdoc_endparse ,  .Nm mdoc_endparse ,
 .Nm mdoc_node ,  
 .Nm mdoc_meta ,  
 .Nm mdoc_free ,  .Nm mdoc_free ,
   .Nm mdoc_meta ,
   .Nm mdoc_node ,
   .Nm mdoc_parseln ,
 .Nm mdoc_reset  .Nm mdoc_reset
 .Nd mdoc macro compiler library  .Nd mdoc macro compiler library
 .\" SECTION  
 .Sh SYNOPSIS  .Sh SYNOPSIS
   .In mandoc.h
 .In mdoc.h  .In mdoc.h
 .Vt extern const char * const * mdoc_macronames;  .Vt extern const char * const * mdoc_macronames;
 .Vt extern const char * const * mdoc_argnames;  .Vt extern const char * const * mdoc_argnames;
 .Ft "struct mdoc *"  .Ft "struct mdoc *"
 .Fn mdoc_alloc "void *data" "int pflags" "const struct mdoc_cb *cb"  .Fn mdoc_alloc "void *data" "int pflags" "mandocmsg msgs"
 .Ft int  .Ft int
 .Fn mdoc_reset "struct mdoc *mdoc"  .Fn mdoc_endparse "struct mdoc *mdoc"
 .Ft void  .Ft void
 .Fn mdoc_free "struct mdoc *mdoc"  .Fn mdoc_free "struct mdoc *mdoc"
 .Ft int  
 .Fn mdoc_parseln "struct mdoc *mdoc" "int line" "char *buf"  
 .Ft "const struct mdoc_node *"  
 .Fn mdoc_node "const struct mdoc *mdoc"  
 .Ft "const struct mdoc_meta *"  .Ft "const struct mdoc_meta *"
 .Fn mdoc_meta "const struct mdoc *mdoc"  .Fn mdoc_meta "const struct mdoc *mdoc"
   .Ft "const struct mdoc_node *"
   .Fn mdoc_node "const struct mdoc *mdoc"
 .Ft int  .Ft int
 .Fn mdoc_endparse "struct mdoc *mdoc"  .Fn mdoc_parseln "struct mdoc *mdoc" "int line" "char *buf"
 .\" SECTION  .Ft int
   .Fn mdoc_reset "struct mdoc *mdoc"
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm mdoc  .Nm mdoc
 library parses lines of  library parses lines of
 .Xr mdoc 7  .Xr mdoc 7
 input (and  input
 .Em only  into an abstract syntax tree (AST).
 mdoc) into an abstract syntax tree (AST).  
 .\" PARAGRAPH  
 .Pp  .Pp
 In general, applications initiate a parsing sequence with  In general, applications initiate a parsing sequence with
 .Fn mdoc_alloc ,  .Fn mdoc_alloc ,
Line 72  then free all allocated memory with
Line 68  then free all allocated memory with
 The  The
 .Fn mdoc_reset  .Fn mdoc_reset
 function may be used in order to reset the parser for another input  function may be used in order to reset the parser for another input
 sequence.  See the  sequence.
   See the
 .Sx EXAMPLES  .Sx EXAMPLES
 section for a full example.  section for a simple example.
 .\" PARAGRAPH  
 .Pp  .Pp
 This section further defines the  This section further defines the
 .Sx Types ,  .Sx Types ,
 .Sx Functions  .Sx Functions
 and  and
 .Sx Variables  .Sx Variables
 available to programmers.  Following that, the  available to programmers.
   Following that, the
 .Sx Abstract Syntax Tree  .Sx Abstract Syntax Tree
 section documents the output tree.  section documents the output tree.
 .\" SUBSECTION  
 .Ss Types  .Ss Types
 Both functions (see  Both functions (see
 .Sx Functions )  .Sx Functions )
Line 93  and variables (see
Line 89  and variables (see
 .Sx Variables )  .Sx Variables )
 may use the following types:  may use the following types:
 .Bl -ohang  .Bl -ohang
 .\" LIST-ITEM  
 .It Vt struct mdoc  .It Vt struct mdoc
 An opaque type defined in  An opaque type defined in
 .Pa mdoc.c .  .Pa mdoc.c .
 Its values are only used privately within the library.  Its values are only used privately within the library.
 .\" LIST-ITEM  
 .It Vt struct mdoc_cb  
 A set of message callbacks defined in  
 .Pa mdoc.h .  
 .\" LIST-ITEM  
 .It Vt struct mdoc_node  .It Vt struct mdoc_node
 A parsed node.  Defined in  A parsed node.
   Defined in
 .Pa mdoc.h .  .Pa mdoc.h .
 See  See
 .Sx Abstract Syntax Tree  .Sx Abstract Syntax Tree
 for details.  for details.
   .It Vt mandocmsg
   A function callback type defined in
   .Pa mandoc.h .
 .El  .El
 .\" SUBSECTION  
 .Ss Functions  .Ss Functions
 Function descriptions follow:  Function descriptions follow:
 .Bl -ohang  .Bl -ohang
 .\" LIST-ITEM  
 .It Fn mdoc_alloc  .It Fn mdoc_alloc
 Allocates a parsing structure.  The  Allocates a parsing structure.
   The
 .Fa data  .Fa data
 pointer is passed to callbacks in  pointer is passed to callbacks in
 .Fa cb ,  .Fa cb ,
Line 125  The
Line 118  The
 .Fa pflags  .Fa pflags
 arguments are defined in  arguments are defined in
 .Pa mdoc.h .  .Pa mdoc.h .
 Returns NULL on failure.  If non-NULL, the pointer must be freed with  Returns NULL on failure.
   If non-NULL, the pointer must be freed with
 .Fn mdoc_free .  .Fn mdoc_free .
 .\" LIST-ITEM  
 .It Fn mdoc_reset  .It Fn mdoc_reset
 Reset the parser for another parse routine.  After its use,  Reset the parser for another parse routine.
   After its use,
 .Fn mdoc_parseln  .Fn mdoc_parseln
 behaves as if invoked for the first time.  If it returns 0, memory could  behaves as if invoked for the first time.
 not be allocated.  If it returns 0, memory could not be allocated.
 .\" LIST-ITEM  
 .It Fn mdoc_free  .It Fn mdoc_free
 Free all resources of a parser.  The pointer is no longer valid after  Free all resources of a parser.
 invocation.  The pointer is no longer valid after invocation.
 .\" LIST-ITEM  
 .It Fn mdoc_parseln  .It Fn mdoc_parseln
 Parse a nil-terminated line of input.  This line should not contain the  Parse a nil-terminated line of input.
 trailing newline.  Returns 0 on failure, 1 on success.  The input buffer  This line should not contain the trailing newline.
   Returns 0 on failure, 1 on success.
   The input buffer
 .Fa buf  .Fa buf
 is modified by this function.  is modified by this function.
 .\" LIST-ITEM  
 .It Fn mdoc_endparse  .It Fn mdoc_endparse
 Signals that the parse is complete.  Note that if  Signals that the parse is complete.
   Note that if
 .Fn mdoc_endparse  .Fn mdoc_endparse
 is called subsequent to  is called subsequent to
 .Fn mdoc_node ,  .Fn mdoc_node ,
 the resulting tree is incomplete.  Returns 0 on failure, 1 on success.  the resulting tree is incomplete.
 .\" LIST-ITEM  Returns 0 on failure, 1 on success.
 .It Fn mdoc_node  .It Fn mdoc_node
 Returns the first node of the parse.  Note that if  Returns the first node of the parse.
   Note that if
 .Fn mdoc_parseln  .Fn mdoc_parseln
 or  or
 .Fn mdoc_endparse  .Fn mdoc_endparse
 return 0, the tree will be incomplete.  return 0, the tree will be incomplete.
 .It Fn mdoc_meta  .It Fn mdoc_meta
 Returns the document's parsed meta-data.  If this information has not  Returns the document's parsed meta-data.
 yet been supplied or  If this information has not yet been supplied or
 .Fn mdoc_parseln  .Fn mdoc_parseln
 or  or
 .Fn mdoc_endparse  .Fn mdoc_endparse
 return 0, the data will be incomplete.  return 0, the data will be incomplete.
 .El  .El
 .\" SUBSECTION  
 .Ss Variables  .Ss Variables
 The following variables are also defined:  The following variables are also defined:
 .Bl -ohang  .Bl -ohang
 .\" LIST-ITEM  
 .It Va mdoc_macronames  .It Va mdoc_macronames
 An array of string-ified token names.  An array of string-ified token names.
 .\" LIST-ITEM  
 .It Va mdoc_argnames  .It Va mdoc_argnames
 An array of string-ified token argument names.  An array of string-ified token argument names.
 .El  .El
 .\" SUBSECTION  
 .Ss Abstract Syntax Tree  .Ss Abstract Syntax Tree
 The  The
 .Nm  .Nm
 functions produce an abstract syntax tree (AST) describing input in a  functions produce an abstract syntax tree (AST) describing input in a
 regular form.  It may be reviewed at any time with  regular form.
   It may be reviewed at any time with
 .Fn mdoc_nodes ;  .Fn mdoc_nodes ;
 however, if called before  however, if called before
 .Fn mdoc_endparse ,  .Fn mdoc_endparse ,
Line 190  or after
Line 182  or after
 or  or
 .Fn mdoc_parseln  .Fn mdoc_parseln
 fail, it may be incomplete.  fail, it may be incomplete.
 .\" PARAGRAPH  
 .Pp  .Pp
 This AST is governed by the ontological  This AST is governed by the ontological
 rules dictated in  rules dictated in
Line 201  elements described in
Line 192  elements described in
 .Xr mdoc 7  .Xr mdoc 7
 are described simply as  are described simply as
 .Qq elements .  .Qq elements .
 .\" PARAGRAPH  
 .Pp  .Pp
 The AST is composed of  The AST is composed of
 .Vt struct mdoc_node  .Vt struct mdoc_node
 nodes with block, head, body, element, root and text types as declared  nodes with block, head, body, element, root and text types as declared
 by the  by the
 .Va type  .Va type
 field.  Each node also provides its parse point (the  field.
   Each node also provides its parse point (the
 .Va line ,  .Va line ,
 .Va sec ,  .Va sec ,
 and  and
Line 220  fields), its position in the tree (the
Line 211  fields), its position in the tree (the
 and  and
 .Va prev  .Va prev
 fields) and some type-specific data.  fields) and some type-specific data.
 .\" PARAGRAPH  
 .Pp  .Pp
 The tree itself is arranged according to the following normal form,  The tree itself is arranged according to the following normal form,
 where capitalised non-terminals represent nodes.  where capitalised non-terminals represent nodes.
 .Pp  .Pp
 .Bl -tag -width "ELEMENTXX" -compact  .Bl -tag -width "ELEMENTXX" -compact
 .\" LIST-ITEM  
 .It ROOT  .It ROOT
 \(<- mnode+  \(<- mnode+
 .It mnode  .It mnode
Line 244  where capitalised non-terminals represent nodes.
Line 233  where capitalised non-terminals represent nodes.
 .It TAIL  .It TAIL
 \(<- mnode+  \(<- mnode+
 .It TEXT  .It TEXT
 \(<- [[:alpha:]]*  \(<- [[:printable:],0x1e]*
 .El  .El
 .\" PARAGRAPH  
 .Pp  .Pp
 Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of  Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of
 the BLOCK production.  These refer to punctuation marks.  Furthermore,  the BLOCK production.
 although a TEXT node will generally have a non-zero-length string, in  These refer to punctuation marks.
 the specific case of  Furthermore, although a TEXT node will generally have a non-zero-length
   string, in the specific case of
 .Sq \&.Bd \-literal ,  .Sq \&.Bd \-literal ,
 an empty line will produce a zero-length string.  an empty line will produce a zero-length string.
 .\" SECTION  
 .Sh EXAMPLES  .Sh EXAMPLES
 The following example reads lines from stdin and parses them, operating  The following example reads lines from stdin and parses them, operating
 on the finished parse tree with  on the finished parse tree with
Line 288  if (NULL == (node = mdoc_node(mdoc)))
Line 276  if (NULL == (node = mdoc_node(mdoc)))
 parsed(mdoc, node);  parsed(mdoc, node);
 mdoc_free(mdoc);  mdoc_free(mdoc);
 .Ed  .Ed
 .\" SECTION  .Pp
   Please see
   .Pa main.c
   in the source archive for a rigorous reference.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr mdoc 7  .Xr mdoc 7
 .\" SECTION  
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  library was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .  .An Kristaps Dzonsons Aq kristaps@bsd.lv .
 .\" SECTION  
 .Sh CAVEATS  
 .Bl -dash -compact  
 .\" LIST-ITEM  
 .It  
 The  
 .Sq \&.Xc  
 and  
 .Sq \&.Xo  
 macros aren't handled when used to span lines for the  
 .Sq \&.It  
 macro.  
 .\" LIST-ITEM  
 .It  
 The  
 .Sq \&.Bsx  
 macro family doesn't yet understand version arguments.  
 .\" LIST-ITEM  
 .It  
 If not given a value, the \-offset argument to  
 .Sq \&.Bd  
 and  
 .Sq \&.Bl  
 should be the width of  
 .Qq <string> ;  
 instead, a value of  
 .Li 10n  
 is provided.  
 .\" LIST-ITEM  
 .It  
 Columns widths in  
 .Sq \&.Bl \-column  
 should default to width  
 .Qq <stringx>  
 if not included.  
 .El  
Legend:
Removed from v.1.37  
changed lines
  Added in v.1.38
CVSweb